maranqz/uvdesk-client

Maintainers

Details

github.com/maranqz/uvdesk-client

Homepage

Source

Issues

Installs: 2

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

dev-master 2019-08-18 11:16 UTC

Requires

Requires (Dev)

proprietary b607b6c53c4da02d6ee208c6274bb8a0f1298d35

phpapisdkswagger

This package is auto-updated.

Last update: 2025-06-18 23:58:49 UTC

README

The UVdesk API correlates with the Representational State Transfer category (REST) that allows to perform several actions like reading, editing, deleting, adding data of the helpdesk system. Here, we are using subdomain in base path and Token Url. user must modify subdomain to his/her uvdesk subdomain for api access. If you want to download and use api client from top right section. Also then, you must replace subdomain with your subdomain name at uvdesk in downloaded client's baseUrl.

This PHP package is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com//uvdesk-client.git"
    }
  ],
  "require": {
    "/uvdesk-client": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/GeneratedUvdeskClient/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: password
$config = UvdeskApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new UvdeskApi\Api\AgentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = "id_example"; // string | 

try {
    $apiInstance->deleteApiMember($id);
} catch (Exception $e) {
    echo 'Exception when calling AgentApi->deleteApiMember: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://subdomain.uvdesk.com/en/api

Class Method HTTP request Description
AgentApi deleteApiMember DELETE /member/{id}.json Delete a given member
AgentApi getApiMember GET /member/{id}.json View a member
AgentApi getApiMembers GET /members.json Return a collection of members
AgentApi postApiMembers POST /members.json Add new Member
AgentApi putApiMember PUT /member/{id}.json edit existing member
AgentPrivilegeApi deleteApiAgentPrivilege DELETE /agent-privilege/{id}.json Delete existing privilege
AgentPrivilegeApi getApiAgentPrivileges GET /agent-privileges.json View all privilege
AgentPrivilegeApi postApiAgentPrivileges POST /agent-privileges.json Add privilege
AgentPrivilegeApi putApiAgentPrivilege PUT /agent-privilege/{id}.json Add privilege
CompanyApi getApiCompanySpam GET /company/spam.json View company spam setting
CompanyApi putApiCompany PUT /company.json edit company details
CompanyApi putApiCompanySpam PUT /company/spam.json edit Spam setting of company
CompanyApi putApiCompanyTheme PUT /company/theme.json edit theme of company
CustomFieldApi deleteApiCustomField DELETE /custom-field/{field}.json delete existing custom-field
CustomFieldApi getApiCustomFields GET /custom-fields.json Returns a collection of custom-fields
CustomFieldApi postApiCustomFields POST /custom-fields.json Add custom-field
CustomFieldApi putApiCustomField PUT /custom-field/{field}.json Edit custom-field
CustomFieldApi putApiCustomFieldOrder PUT /custom-field/order.json Reorder CustomFields
CustomerApi deleteApiCustomer DELETE /customer/{id}.json delete a given customer
CustomerApi getApiCustomer GET /customer/{id}.json View a customer
CustomerApi getApiCustomers GET /customers.json Returns a collection of customers
CustomerApi patchApiCustomer PATCH /customer/{id}.json add/remove star to customer
CustomerApi postApiCustomers POST /customers.json Add new Customer
CustomerApi putApiCustomer PUT /customer/{id}.json edit existing customer
EmailTemplateApi deleteApiEmailTemplate DELETE /email-template/{template}.json Delete email-Template
EmailTemplateApi getApiEmailTemplates GET /email-templates.json Returns a collection of Email-Templates
EmailTemplateApi postApiEmailTemplates POST /email-templates.json Add email-template
EmailTemplateApi putApiEmailTemplate PUT /email-template/{template}.json Edit email-template
FilterApi getApiFilters GET /filters.json Get filter data
GroupApi deleteApiGroup DELETE /group/{id}.json Delete Group
GroupApi getApiGroups GET /groups.json View Groups
GroupApi postApiGroups POST /groups.json Add Group
GroupApi putApiGroup PUT /group/{id}.json Modify Group
LabelApi deleteApiLabel DELETE /label/{id}.json remove label
LabelApi postApiLabels POST /labels.json add new label
LabelApi putApiLabel PUT /label/{id}.json edit existing label
MailboxApi deleteApiMailbox DELETE /mailbox/{id}.json Delete Mailbox
MailboxApi getApiMailboxes GET /mailboxes.json Returns a collection of Mailboxes
MailboxApi postApiMailboxes POST /mailboxes.json Add Mailbox
MailboxApi putApiMailbox PUT /mailbox/{id}.json Edit Mailbox
SavedReplyApi deleteApiSavedReply DELETE /saved-reply/{template}.json Delete existing savedReply
SavedReplyApi getApiSavedReplys GET /saved-replys.json Returns a collection of SavedReply
SavedReplyApi postApiSavedReplys POST /saved-replys.json Add reply
SavedReplyApi putApiSavedReply PUT /saved-reply/{template}.json edit reply
TagApi deleteApiArticleTags DELETE /article/{article}/tags.json delete tag from article
TagApi deleteApiTag DELETE /tag/{id}.json delete a given Tag
TagApi postApiArticleTags POST /article/{article}/tags.json Add tag from article
TagApi putApiTag PUT /tag/{id}.json edit existing Tag
TaskApi deleteApiTask DELETE /task/{id}.json Delete existing task
TaskApi deleteApiTaskFollower DELETE /task/{id}/follower.json Remove Follower
TaskApi deleteApiTaskThread DELETE /task/{id}/thread.json remove thread
TaskApi getApiTask GET /task/{id}.json View a Task
TaskApi getApiTasks GET /tasks.json Returns a collection of Tasks
TaskApi postApiTaskFollower POST /task/{id}/follower.json add Follower
TaskApi postApiTaskThread POST /task/{id}/thread.json add thread
TaskApi postApiTasks POST /tasks.json Add new Task
TaskApi putApiTask PUT /task/{id}.json update existing task
TeamsubgroupApi deleteApiSubGroup DELETE /sub-group/{id}.json Delete existing Subgroup
TeamsubgroupApi getApiSubGroups GET /sub-groups.json View Subgroups
TeamsubgroupApi postApiSubGroups POST /sub-groups.json Add Subgroup
TeamsubgroupApi putApiSubGroup PUT /sub-group/{id}.json modify Subgroup
ThreadApi deleteApiTicketThread DELETE /ticket/{ticketId}/thread/{id}.json DELETE thread
ThreadApi getApiTicketThreads GET /ticket/{id}/threads.json Returns a collection of threads
ThreadApi patchApiTicketThread PATCH /ticket/{ticketId}/thread/{id}.json lock/unlock thread
ThreadApi postApiTicketThreads POST /ticket/{id}/threads.json Add new Thread
ThreadApi putApiTicketThread PUT /ticket/{ticketId}/thread/{id}.json Edit existing thread
TicketApi deleteApiTicket DELETE /ticket/{id}.json Delete a given ticket
TicketApi deleteApiTicketCollaborator DELETE /ticket/{id}/collaborator.json Remove collaborator from Ticket
TicketApi getApiTicket GET /ticket/{id}.json View a ticket
TicketApi getApiTicketAttachment GET /ticket/attachment/{id}.json download attachment
TicketApi patchApiTicket PATCH /ticket/{id}.json Edit given ticket's properties
TicketApi postApiTicketCollaborator POST /ticket/{id}/collaborator.json Add collaborator for Ticket
TicketApi putApiTicket PUT /ticket/{id}.json Edit given ticket
TicketTypeApi deleteApiTicketType DELETE /ticket-type/{id}.json Delete existing TicketType
TicketTypeApi getApiTicketTypes GET /ticket-types.json Return a collection of TicketTypes
TicketTypeApi postApiTicketTypes POST /ticket-types.json Add new TicketType
TicketTypeApi putApiTicketType PUT /ticket-type/{id}.json Edit existing TicketType
TicketsApi deleteApiTicketTags DELETE /ticket/{id}/tags.json delete Tag from Ticket
TicketsApi deleteApiTickets DELETE /tickets.json Delete multiple Tickets
TicketsApi getApiTickets GET /tickets.json Return a Collection of Tickets
TicketsApi postApiTicketTags POST /ticket/{id}/tags.json Add Tag from Ticket
TicketsApi postApiTickets POST /tickets.json Add ticket
TicketsApi putApiTicketsAgent PUT /tickets/agent.json Assign Agent to multiple Tickets
TicketsApi putApiTicketsGroup PUT /tickets/group.json change Group of multiple Tickets
TicketsApi putApiTicketsLabel PUT /tickets/label.json add label to multiple Tickets
TicketsApi putApiTicketsPriority PUT /tickets/priority.json change Priority of multiple Tickets
TicketsApi putApiTicketsRestore PUT /tickets/restore.json Restore multiple Tickets
TicketsApi putApiTicketsStatus PUT /tickets/status.json change Status of multiple Tickets
TicketsApi putApiTicketsTrash PUT /tickets/trash.json Trash multiple Tickets
TodoApi deleteApiTodo DELETE /todo/{id}.json Delete Todo
TodoApi postApiTodo POST /todo.json Add Todo
TodoApi putApiTodo PUT /todo/{id}.json Edit Todo
WorkflowApi deleteApiWorkflow DELETE /workflow/{type}/{id}.json delete a given Workflow
WorkflowApi getApiWorkflows GET /workflows.json View workflow details
WorkflowApi postApiWorkflows POST /workflows.json Add Workflow
WorkflowApi putApiWorkflow PUT /workflow/{type}/{id}.json Edit Workflow
WorkflowApi putApiWorkflowsOrder PUT /workflows/order.json Reorder workflows

Documentation For Models

Documentation For Authorization

password

  • Type: OAuth
  • Flow: password
  • Authorization URL:
  • Scopes:
  • api: api access based on user role

Author

support@uvdesk.com