iris.helpdesk
Module iris.helpdesk
API
Definitions
ballerinax/iris.helpdesk Ballerina library
Overview
This is a generated connector for IRIS Helpdesk API v1.6.4 OpenAPI specification.
Connect with the Helpdesk API to work with your ticket data.
Helpdesk tickets are organized by ticket types.
Ticket types have properties such as assigned users, expected time to completion (SLA), and visibility to help you segment tickets based on job descriptions.
Get detailed helpdesk ticket information, perform updates, and manage attached files with ease by using the Helpdesk API.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a IRIS CRM account
- Obtain tokens by following this guide
Quickstart
To use the IRIS Helpdesk connector in your Ballerina application, update the .bal file as follows:
Step 1: Import connector
First, import the ballerinax/iris.helpdesk
module into the Ballerina project.
import ballerinax/iris.helpdesk;
Step 2: Create a new connector instance
Create a helpdesk:ApiKeysConfig
with the API key obtained, and initialize the connector with it.
helpdesk:ApiKeysConfig config = { xApiKey: "<API_KEY>" } helpdesk:Client baseClient = check new Client(config);
Step 3: Invoke connector operation
-
Now you can use the operations available within the connector. Note that they are in the form of remote operations.
Following is an example on how to get a list of helpdesk tickets using the connector.
Get a list of helpdesk tickets
public function main() returns error? { helpdesk:InlineResponse20058 response = check baseClient->getHelpdeskTickets(); log:printInfo(response.toString()); }
-
Use
bal run
command to compile and run the Ballerina program.
Clients
iris.helpdesk: Client
This is a generated connector for IRIS Helpdesk API v1.6.4 OpenAPI specification.
Connect with the Helpdesk API to work with your ticket data.
Helpdesk tickets are organized by ticket types.
Ticket types have properties such as assigned users, expected time to completion (SLA), and visibility to help you segment tickets based on job descriptions.
Get detailed helpdesk ticket information, perform updates, and manage attached files with ease by using the Helpdesk API.
Constructor
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Create a IRIS account and obtain tokens by following this guide.
init (ApiKeysConfig apiKeyConfig, string serviceUrl, ClientConfiguration clientConfig)
- apiKeyConfig ApiKeysConfig - API keys for authorization
- serviceUrl string - URL of the target service
- clientConfig ClientConfiguration {} - The configurations to be used when initializing the
connector
getHelpdeskTickets
function getHelpdeskTickets(int? page, int? perPage, string? sortBy, string sortDir, string? dateFilter, string? startDate, string? endDate, string? 'group, string? 'type, decimal? creator, decimal? modifier, string? search, string? searchBy, decimal? resolver, decimal? lid, string? mid, boolean? hideResolved, string? assignedTo, boolean? unassigned) returns InlineResponse20058|error
Get a list of helpdesk tickets
Parameters
- page int? (default ()) - Page number
- perPage int? (default ()) - Count of records per page
- sortBy string? (default ()) - Sorting of helpdesk tickets by the field value
- sortDir string (default "asc") - Direction of sorting
- dateFilter string? (default ()) - Filter tickets by the specific date field
- startDate string? (default ()) - Start date for date_filter filter in format ISO 8601 (Please note that
+
sign should be encoded to%2B
)
- endDate string? (default ()) - End date for date_filter filter in format ISO 8601 (Please note that
+
sign should be encoded to%2B
)
- 'group string? (default ()) - Filter tickets by the specific ticket groups
- 'type string? (default ()) - Filter tickets by the specific ticket types
- creator decimal? (default ()) - Filter tickets by the ticket creator
- modifier decimal? (default ()) - Filter tickets by the ticket modifier
- search string? (default ()) - Search tickets by some criteria
- searchBy string? (default ()) - Search tickets by some specific field
- resolver decimal? (default ()) - Filter tickets by the ticket resolver
- lid decimal? (default ()) - Filter tickets by the Lead ID
- mid string? (default ()) - Filter tickets by the Merchant ID
- hideResolved boolean? (default ()) - Hide resolved ticket
- assignedTo string? (default ()) - Filter tickets by the assigned users. For sending multiple users please send them in comma seperated format. Please use an empty string to select all assigned tickets.
- unassigned boolean? (default ()) - Set this parameter to 1 if you need unassigned tickets also. For select only unassigned tickets exclude
assigned_to
from the request
Return Type
- InlineResponse20058|error - A JSON array of tickets
createNewTicket
function createNewTicket(V1HelpdeskBody payload) returns TicketDetail|error
Create a new ticket
Parameters
- payload V1HelpdeskBody - Ticket details
Return Type
- TicketDetail|error - Ticket has been created successfully
addTicketComment
function addTicketComment(int ticketId, TicketidCommentBody payload) returns BriefTicketComments|error
Add a ticket comment
Return Type
- BriefTicketComments|error - Comment was added successfully
getDetailedTicketInformation
function getDetailedTicketInformation(int ticketId) returns TicketDetail|error
Get detailed ticked information
Parameters
- ticketId int - Ticket Id
Return Type
- TicketDetail|error - A JSON array of tickets
deleteTicket
function deleteTicket(int ticketId) returns InlineResponse20059|error
Delete a ticket
Parameters
- ticketId int - Ticket Id
Return Type
- InlineResponse20059|error - Ticket has been deleted successfully
updateTicket
function updateTicket(int ticketId, HelpdeskTicketidBody payload) returns TicketDetail|error
Update a ticket
Return Type
- TicketDetail|error - Ticket has been updated successfully
getTicketAssignmentLogs
function getTicketAssignmentLogs(int ticketId) returns InlineResponse20060[]|error
Get ticked assignment logs
Parameters
- ticketId int - Ticket Id
Return Type
- InlineResponse20060[]|error - A JSON array of assignments
getHelpdeskTicketTypes
function getHelpdeskTicketTypes(int? page, int? perPage, string? sortBy, string sortDir, string? dateFilter, string? startDate, string? endDate, string? status, int? priority, decimal? daysToResolve, decimal? creator, decimal? modifier) returns InlineResponse20061|error
Get a list of helpdesk ticket types
Parameters
- page int? (default ()) - Page number
- perPage int? (default ()) - Count of records per page
- sortBy string? (default ()) - Sorting of helpdesk ticket types by the field value
- sortDir string (default "asc") - Direction of sorting
- dateFilter string? (default ()) - Filter ticket types by the specific date field
- startDate string? (default ()) - Start date for date_filter filter in format ISO 8601 (Please note that
+
sign should be encoded to%2B
)
- endDate string? (default ()) - End date for date_filter filter in format ISO 8601 (Please note that
+
sign should be encoded to%2B
)
- status string? (default ()) - Status
- priority int? (default ()) - 0 - Normal, 1 - Medium, 2 - Rush
- daysToResolve decimal? (default ()) - Days to resolve
- creator decimal? (default ()) - Creator
- modifier decimal? (default ()) - Filter ticket types by the ticket modifier
Return Type
- InlineResponse20061|error - A JSON array of ticket types
createHelpdeskTicketType
function createHelpdeskTicketType(HelpdeskTypesBody payload) returns TypeDetail|error
Create a new helpdesk ticket type
Parameters
- payload HelpdeskTypesBody - Comment details
Return Type
- TypeDetail|error - A JSON array of ticket types
getHelpdeskTicketType
function getHelpdeskTicketType(int typeId) returns TypeDetail|error
Get details for a helpdesk ticket type
Parameters
- typeId int - Ticket Type Id
Return Type
- TypeDetail|error - A JSON array of ticket types
deleteTicketType
function deleteTicketType(int typeId) returns InlineResponse20062|error
Delete a ticket type
Parameters
- typeId int - Ticket Type Id
Return Type
- InlineResponse20062|error - Result message
updateHelpdeskTicketType
function updateHelpdeskTicketType(int typeId, TypesTypeidBody payload) returns TypeDetail|error
Update a helpdesk ticket type
Return Type
- TypeDetail|error - A JSON array of ticket types
getAvailableUsersToNotify
function getAvailableUsersToNotify(int? page, int? perPage, string? role) returns InlineResponse20032|error
Get a list of available users to notify and assign
Parameters
- page int? (default ()) - Page number
- perPage int? (default ()) - Count of records per page
- role string? (default ()) - ID of user class
Return Type
- InlineResponse20032|error - A JSON array of users
Records
iris.helpdesk: ApiKeysConfig
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- xApiKey string - Authentication token
iris.helpdesk: BriefTicketChecklistInfo
Fields
- id int? - Checklist item Id
- template_id int? - Checklist template Id
- name string? - Checklist item name
- index int? - Index in list
- required boolean? - Flag is checklist are required
- fileRequired boolean? - Flag is checklist file are required
- commentRequiredToDoneTicket boolean? - Flag is comment are required to resolve ticket
- commentRequiredToDoneItem boolean? - Flag is checklist are required to resolve checklist item
- commentedAt anydata? - Datetime when user have commented checklist item
- commentedBy int? - User Id of user who have commented checklist item
iris.helpdesk: BriefTicketComments
Fields
- id int? - Comment id
- ticketId int? - Ticket id
- comment string? - Comment text
- created string? - Comment created date
- createdBy int? - Comment creator id
- modified string? - Comment modified date
- modifiedBy int? - Id of user who left comment
- files File[]? -
- preview_images File[]? -
- merchantVisible boolean? - Indicates if the comment is visible to Merchant users
iris.helpdesk: BriefTicketInfo
Fields
- Fields Included from *Ticket
- id int
- subject string
- description string
- status TicketStatus
- type TicketType
- group TicketGroup
- priority TicketPriority
- lead_id int
- mid int
- merchantVisible boolean
- anydata...
- Fields Included from *TicketCreatedBlock
- modified string? - Ticket modified date
- modified_by int? - Id of user who made last change
- resolved string? - Ticket resolved date
- resolved_by int? - Id of user who made last change
- due_date string? - Ticket due date
- due string? - Ticket SLA
- only_business_days boolean? - Calculate only business days
- last_comment string? - Ticket last comment date
- files_count int? - Count of ticket files
iris.helpdesk: BriefTicketTypeInfo
Fields
- id int? - Ticket type id
- name string? - Ticket type name
- description string? - Ticket type description
- daysToResolve int? - Days to Resolve
- only_business_days boolean? - Calculate only business days
- status TicketStatus? -
- priority TicketPriority? -
- created string? - Ticket type created date
- createdBy int? - Ticket type creator id
- modified string? - Ticket type modified date
- modifiedBy int? - Id of user who made last change
- 'order int? - Ticket type order
- permissions int[]? -
- due_date string? - Ticket due date
- assignees BrieftickettypeinfoAssignees? -
iris.helpdesk: BrieftickettypeinfoAssignees
Fields
- everyTime int[]? -
- roundRobin int[]? -
iris.helpdesk: BriefUserInfoWithClass
Fields
- id int? - User Id
- username string? - User username
- full_name string? - User name
- email string? - User email
- status string? - User status
- 'class string? - User class
iris.helpdesk: ChecklistFullInfo
Fields
- Fields Included from *BriefTicketChecklistInfo
- completed boolean? - Flag is checklist are done
- completed_by int? - User ID who compleated the checklist
- completed_at anydata? - Datetime when user have completed the checklist item
- files File[]? -
iris.helpdesk: CheckListRequest
Fields
- index int? - Checklist item index
- files string[]? -
- attached_files int[]? -
- completed boolean? - Flag checklist are item completed
- comment string? - Comment for checklist item
iris.helpdesk: File
Fields
- id int? -
- name string? -
- size int? -
- created string? - File creation date (Y-m-d\TH:i:sP)
- created_by int? -
iris.helpdesk: HelpdeskTicketidBody
Fields
- 'type int? - Type id
- subject string? - Ticket subject
- description string? - Ticket description
- status string? - Ticket status
- priority int? - Priority (0 - Normal, 1 - Medium, 2 - Rush)
- assignedUsers int[]? -
- due_date string? - Ticket due datetime
- only_business_days boolean? - Calculate only business days
- assignType string? -
- assignTo int? -
- files string[]? -
- attached_files int[]? -
- preview_images string[]? -
- group_id int? -
- merchantVisible boolean? - Indicates if the ticket is visible to Merchant users
iris.helpdesk: HelpdeskTypesBody
Fields
- Fields Included from *TicketTypeRequest
- checklist record { files string[] }[]? -
iris.helpdesk: InlineResponse20032
Fields
- data BriefUserInfoWithClass[]? -
- links Links? -
- meta Meta? -
iris.helpdesk: InlineResponse20058
Fields
- links Links? -
- meta Meta? -
iris.helpdesk: InlineResponse20059
Fields
- status string? -
iris.helpdesk: InlineResponse20060
Fields
- active boolean? -
- 'source string? -
- date string? -
- user decimal? -
- assigned_by decimal? -
iris.helpdesk: InlineResponse20061
Fields
- data BriefTicketTypeInfo[]? -
- links Links? -
- meta Meta? -
iris.helpdesk: InlineResponse20062
Fields
- message string? -
- movedTickets string? -
iris.helpdesk: Links
Fields
- first string? - An URL to the first page of the data set
- last string? - An URL to the last page of the data set
- prev string? - An URL to the previous page of the data set
- next string? - An URL to the next page of the data set
iris.helpdesk: Meta
Fields
- current_page int? - The current page number of a data set
- 'from int? - The current position of a data set
- last_page string? - The last page of a data set
- path string? - API path
- per_page int? - A number of records per page
- to int? - The last position in a data set
- total int? - Total number of records in a data set
iris.helpdesk: Ticket
Fields
- id int? - Ticket id
- subject string? - Ticket subject
- description string? - Ticket description
- status TicketStatus? -
- 'type TicketType? -
- 'group TicketGroup? -
- priority TicketPriority? -
- lead_id int? - Assigned Lead ID
- mid int? - Assigned Merchant ID
- merchantVisible boolean? - Indicates if the ticket is visible to Merchant users
iris.helpdesk: TicketCreatedBlock
Fields
- created string? - Ticket created date
- created_by int? - Ticket creator id
iris.helpdesk: TicketDetail
Fields
- general File[]? -
- checklist ChecklistFullInfo[]? -
iris.helpdesk: TicketGroup
Fields
- id int? - Group id
- name string? - Group name
iris.helpdesk: TicketidCommentBody
Fields
- comment string? - Comment text
- notify int[]? -
- files string[]? -
- attached_files int[]? -
- preview_images string[]? -
- merchantVisible boolean? - Indicates if the comment is visible to Merchant users
iris.helpdesk: TicketPriority
Fields
- id int? - Priority id
- name string? - Priority name
iris.helpdesk: TicketStatus
Fields
- id int? - Status id
- name string? - Status name
iris.helpdesk: TicketType
Fields
- id int? - Type id
- name string? - Ticket type
iris.helpdesk: TicketTypeRequest
Fields
- name string? - Ticket type name
- description string? - Ticket type description
- daysToResolve int? - Days to Resolve
- only_business_days boolean? - Calculate only business days
- status string? - Status
- priority int? - Priority (0 - Normal, 1 - Medium, 2 - Rush)
- permissions int[]? -
- assignees BrieftickettypeinfoAssignees? -
iris.helpdesk: TypeDetail
Fields
- general BriefTicketTypeInfo? -
- checklist ChecklistFullInfo[]? -
iris.helpdesk: TypesTypeidBody
Fields
- Fields Included from *TicketTypeRequest
iris.helpdesk: V1HelpdeskBody
Fields
- 'type int - Type id
- subject string - Ticket subject
- description string? - Ticket description
- priority int - Priority (0 - Normal, 1 - Medium, 2 - Rush)
- assignedUsers int[]? -
- files string[]? -
- attached_files int[]? -
- preview_images string[]? -
- assignType string -
- assignTo int -
- group_id int? -
- due_date string? - Ticket due datetime
- only_business_days boolean? - Calculate only business days
- notify_assigned_users boolean? - Notify assigned users
- merchantVisible boolean? - Indicates if the ticket is visible to Merchant users
- checklist CheckListRequest[]? -
Import
import ballerinax/iris.helpdesk;
Metadata
Released date: over 2 years ago
Version: 1.1.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: slbeta6
GraalVM compatible: Yes
Pull count
Total: 1
Current verison: 0
Weekly downloads
Keywords
Sales & CRM/Customer Relationship Management
Cost/Paid
Contributors
Dependencies