Skip to content

Commit

Permalink
feat: ticket fields types
Browse files Browse the repository at this point in the history
  • Loading branch information
onhate committed Jan 18, 2024
1 parent ac07d2c commit 584f175
Showing 1 changed file with 38 additions and 4 deletions.
42 changes: 38 additions & 4 deletions src/clients/core/ticketfields.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,40 @@
// Ticketfields.js: Client for the zendesk API.
const {Client} = require('../client');

/**
* @typedef {Object} TicketField
* @property {boolean} active - Whether this field is available
* @property {string} agent_description - A description of the ticket field that only agents can see
* @property {boolean} collapsed_for_agents - If true, the field is shown to agents by default. If false, the field is hidden alongside infrequently used fields. Classic interface only
* @property {string} created_at - The time the custom ticket field was created
* @property {string} creator_app_name - Name of the app that created the ticket field, or a null value if no app created the ticket field
* @property {number} creator_user_id - The id of the user that created the ticket field, or a value of "-1" if an app created the ticket field
* @property {Array} custom_field_options - Required and presented for a custom ticket field of type "multiselect" or "tagger"
* @property {Array} custom_statuses - List of customized ticket statuses. Only presented for a system ticket field of type "custom_status"
* @property {string} description - Describes the purpose of the ticket field to users
* @property {boolean} editable_in_portal - Whether this field is editable by end users in Help Center
* @property {number} id - Automatically assigned when created
* @property {number} position - The relative position of the ticket field on a ticket. Note that for accounts with ticket forms, positions are controlled by the different forms
* @property {string} raw_description - The dynamic content placeholder if present, or the description value if not. See Dynamic Content
* @property {string} raw_title - The dynamic content placeholder if present, or the title value if not. See Dynamic Content
* @property {string} raw_title_in_portal - The dynamic content placeholder if present, or the "title_in_portal" value if not. See Dynamic Content
* @property {string} regexp_for_validation - For "regexp" fields only. The validation pattern for a field value to be deemed valid
* @property {Object} relationship_filter - A filter definition that allows your autocomplete to filter down results
* @property {string} relationship_target_type - A representation of what type of object the field references. Options are "zen:user", "zen:organization", "zen:ticket", or "zen:custom_object:{key}" where key is a custom object key. For example "zen:custom_object:apartment".
* @property {boolean} removable - If false, this field is a system field that must be present on all tickets
* @property {boolean} required - If true, agents must enter a value in the field to change the ticket status to solved
* @property {boolean} required_in_portal - If true, end users must enter a value in the field to create the request
* @property {number} sub_type_id - For system ticket fields of type "priority" and "status". Defaults to 0. A "priority" sub type of 1 removes the "Low" and "Urgent" options. A "status" sub type of 1 adds the "On-Hold" option
* @property {Array} system_field_options - Presented for a system ticket field of type "tickettype", "priority" or "status"
* @property {string} tag - For "checkbox" fields only. A tag added to tickets when the checkbox field is selected
* @property {string} title - The title of the ticket field
* @property {string} title_in_portal - The title of the ticket field for end users in Help Center
* @property {string} type - System or custom field type. Editable for custom field types and only on creation. See Create Ticket Field
* @property {string} updated_at - The time the custom ticket field was last updated
* @property {string} url - The URL for this resource
* @property {boolean} visible_in_portal - Whether this field is visible to end users in Help Center
*/

/**
* Client for the Zendesk Ticket Fields API.
* @see {@link https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_fields/}
Expand All @@ -13,7 +47,7 @@ class TicketFields extends Client {

/**
* Lists all ticket fields.
* @returns {Promise<Array>} Returns an array of ticket fields.
* @returns {Promise<Array<TicketField>>}>} Returns an array of ticket fields.
* @async
* @throws {Error} Throws an error if the request fails.
* @see {@link https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_fields/#list-ticket-fields}
Expand All @@ -28,7 +62,7 @@ class TicketFields extends Client {
/**
* Retrieves a specific ticket field by ID.
* @param {number} ticketFieldId - The ID of the ticket field to retrieve.
* @returns {Promise<object>} Returns the details of the ticket field.
* @returns {Promise<TicketField>} Returns the details of the ticket field.
* @async
* @throws {Error} Throws an error if the request fails.
* @see {@link https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_fields/#show-ticket-field}
Expand Down Expand Up @@ -57,7 +91,7 @@ class TicketFields extends Client {
/**
* Creates a new ticket field.
* @param {object} ticketField - The properties of the ticket field to create.
* @returns {Promise<object>} Returns the created ticket field.
* @returns {Promise<TicketField>} Returns the created ticket field.
* @async
* @throws {Error} Throws an error if the request fails.
* @see {@link https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_fields/#create-ticket-field}
Expand All @@ -76,7 +110,7 @@ class TicketFields extends Client {
* Updates a specific ticket field by ID.
* @param {number} ticketFieldId - The ID of the ticket field to update.
* @param {object} ticketField - The updated properties of the ticket field.
* @returns {Promise<object>} Returns the updated ticket field.
* @returns {Promise<TicketField>} Returns the updated ticket field.
* @async
* @throws {Error} Throws an error if the request fails.
* @see {@link https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_fields/#update-ticket-field}
Expand Down

0 comments on commit 584f175

Please sign in to comment.