Package mock is a generated GoMock package.

LocaleTypeText returns locale type text.

NewAPITokenCredential creates APITokenCredential and returns its pointer.

NewBasicAuthCredential creates BasicAuthCredential and returns its pointer.

NewBearerTokenCredential returns a pointer to a new BearerTokenCredential.

NewClient creates new Zendesk API client.

NewError is a function to initialize the Error type.

NewPaginationOptions() returns a pointer to a new PaginationOptions struct with default values (PageSize is 100, IsCBP is true).

NewPrivateTicketComment generates and returns a new private TicketComment.

NewPublicTicketComment generates and returns a new TicketComment.

UserRoleText takes role type and returns role name string.

ViaTypeText takes via_id and returns via_type.

ActionFieldAddSkills add_skills.

ActionFieldAssigneeID assignee_id.

ActionFieldBrandId brand_id.

ActionFieldCC cc.

ActionFieldCommentModeIsPublic comment_mode_is_public.

ActionFieldCommentValue comment_value.

ActionFieldCommentValueHTML comment_value_html.

ActionFieldCurrentTags current_tags.

ActionFieldCustomField custom_field_ prefix.

ActionFieldCustomStatusId custom_status_id.

ActionFieldFollower follower.

ActionFieldGroupID group_id.

ActionFieldLocaleID locale_id.

ActionFieldNotificationGroup notification_group.

ActionFieldNotificationTarget notification_target.

ActionFieldNotificationUser notification_user.

ActionFieldNotificationWebhook notification_webhook.

ActionFieldPriority priority.

ActionFieldRemoveSkills remove_skills.

ActionFieldRemoveTags remove_tags.

ActionFieldSatisfactionScore satisfaction_score.

ActionFieldSetSkills set_skills.

ActionFieldSetTags set_tags.

ActionFieldStatus status.

ActionFieldSubject subject.

ActionFieldTicketFormID ticket_form_id.

ActionFieldTweetRequester tweet_requester.

ActionFieldType type.

SLA Policy metric values ref: https://developer.zendesk.com/rest_api/docs/support/sla_policies#metrics.

ConditionFieldAgentStations is alias for agent_stations.

ConditionFieldAssignedAt is alias for assigned_at.

ConditionFieldAssigneeID is alias for assignee_id.

ConditionFieldAssigneeUpdatedAt is alias for assignee_updated_at.

ConditionFieldAttachment is alias for attachment.

ConditionFieldBrandId is alias for brand_id.

ConditionFieldCC is an alias for cc.

ConditionFieldClosed is alias for CLOSED.

ConditionFieldCommentIncludesWord is alias for comment_includes_word.

ConditionFieldCommentIsPublic is alias for comment_is_public.

ConditionFieldCurrentTags is alias for current_tags.

ConditionFieldCurrentViaID is alias for current_via_id.

ConditionFieldCustomField is alias for custom_fields_ prefix.

ConditionFieldCustomFieldAlt is alias for ticket_fields_ prefix.

ConditionFieldCustomStatusId is an alias for custom_status_id.

ConditionFieldDescriptionIncludesWord is alias for description_includes_word.

ConditionFieldDueDate is alias for due_date.

ConditionFieldExactCreatedAt is alias for exact_created_at.

ConditionFieldGroupID is alias for group_id.

ConditionFieldGroupStations is alias for group_stations.

ConditionFieldHold is alias for HOLD.

ConditionFieldInBusinessHours is alias for in_business_hours.

ConditionFieldIsBusinessHours is an alias for is_business_hours.

ConditionFieldLocaleID is alias for locale_id.

ConditionFieldNew is alias for NEW.

ConditionFieldOpen is alias for OPEN.

ConditionFieldOrganizationCustomKey is a prefix alias for organization.custom_fields.{key} where key is replaced with a key value.

ConditionFieldOrganizationID is alias for organization_id.

ConditionFieldPending is alias for PENDING.

ConditionFieldPriority is alias for priority.

ConditionFieldRecipient is alias for recipient.

ConditionFieldReopens is alias for reopens.

ConditionFieldReplies is alias for reopens.

condition field types which are defined by system https://developer.zendesk.com/rest_api/docs/core/triggers#conditions-reference.

ConditionFieldRequesterID is alias for requester_id.

ConditionFieldRequesterRole is alias for requester_role.

ConditionFieldRequesterTwitterFollowersCount is alias for requester_twitter_followers_count.

ConditionFieldRequesterTwitterStatusesCount is alias for requester_twitter_statuses_count.

ConditionFieldRequesterTwitterVerified is alias for requester_twitter_verified.

ConditionFieldRequesterUpdatedAt is alias for requester_updated_at.

condition field types which are defined by system https://developer.zendesk.com/rest_api/docs/core/triggers#conditions-reference.

ConditionFieldSatisfactionScore is alias for satisfaction_score.

ConditionFieldSlaNextBreachAt is an alias for sla_next_breach_at.

ConditionFieldSolved is alias for SOLVED.

ConditionFieldStatus is alias for status.

ConditionFieldSubjectIncludesWord is alias for subject_includes_word.

ConditionFieldTicketFormId is alias for ticket_form_id.

ConditionFieldTicketIsPublic is alias for ticket_is_public.

ConditionFieldTicketTypeId is an alias for ticket_type_id.

ConditionFieldType is alias for type.

ConditionFieldUntilDueDate is alias for until_due_date.

ConditionFieldUpdatedAt is alias for updated_at.

ConditionFieldUpdateType is alias for update_type.

ConditionFieldUserCustomKey is a prefix alias for user.custom_fields.{key} where key is replaced with a key value.

ConditionFieldViaID is alias for via_id.

condition field types which are defined by system https://developer.zendesk.com/rest_api/docs/core/triggers#conditions-reference.

SLA Policy metric values ref: https://developer.zendesk.com/rest_api/docs/support/sla_policies#metrics.

ListTicketCommentsMaxPageSize contains the max page size.

LocaleAR Arabic - العربية.

LocaleBG Bulgarian - български.

LocaleCA Catalan - català.

LocaleCS Czech - čeština.

LocaleDA Danish - dansk.

LocaleDE German - Deutsch.

LocaleDEAT German (Austria) - Deutsch (Österreich).

LocaleDECH German (Switzerland) - Deutsch (Schweiz).

LocaleEL Greek - Ελληνικά.

LocaleENAU English (Australia).

LocaleENBE English (Belgium).

LocaleENCA English (Canada).

LocaleENGB English (United Kingdom).

LocaleENIE English (Ireland).

LocaleENIN English (India).

LocaleENNZ English (New Zealand).

LocaleENPH English (Philippines).

LocaleENSG English (Singapore).

LocaleENUS English (United States).

LocaleENZA English (South Africa).

LocaleES Spanish - español.

LocaleES419 Spanish (Latin America) - español (Latinoamérica).

LocaleESES Spanish (Spain) - español (España).

LocaleESMX Spanish (Mexico) - español (México).

LocaleET Estonian - eesti.

LocaleFA Persian - فارسی.

LocaleFI Finnish - suomi.

LocaleFIL Filipino.

LocaleFR French - français.

LocaleFRBE French (Belgium) - français (Belgique).

LocaleFRCA French (Canada) - français (Canada).

LocaleFRCH French (Switzerland) - français (Suisse).

LocaleFRFR French (France) - français (France).

LocaleHE Hebrew - עברית.

LocaleHI Hindi - हिन्दी.

LocaleHR Croatian - hrvatski.

LocaleHU Hungarian - magyar.

LocaleID Indonesian - Indonesia.

LocaleIS Icelandic - íslenska.

LocaleIT Italian - italiano.

LocaleJA Japanese - 日本語.

LocaleKO Korean - 한국어.

LocaleLT Lithuanian - lietuvių.

LocaleLV Latvian - latviešu.

LocaleMS Malay - Melayu.

LocaleNL Dutch - Nederlands.

LocaleNLBE Dutch (Belgium) - Nederlands (België).

LocaleNO Norwegian - norsk.

LocalePL Polish - polski.

LocalePT Portuguese - português.

LocalePTBR Portuguese (Brazil) - português (Brasil).

LocaleRO Romanian - română.

LocaleRU Russian - русский.

LocaleSK Slovak - slovenčina.

LocaleSL Slovenian - slovenščina.

LocaleSR Serbian - српски.

LocaleSV Swedish - svenska.

LocaleTH Thai - ไทย.

LocaleTR Turkish - Türkçe.

LocaleUK Ukrainian - українська.

LocaleVI Vietnamese - Tiếng Việt.

LocaleZHCN Chinese (Simplified) - 中文（简体）.

LocaleZHTW Chinese (Traditional) - 中文（繁體）.

SLA Policy metric values ref: https://developer.zendesk.com/rest_api/docs/support/sla_policies#metrics.

SLA Policy metric values ref: https://developer.zendesk.com/rest_api/docs/support/sla_policies#metrics.

SLA Policy metric values ref: https://developer.zendesk.com/rest_api/docs/support/sla_policies#metrics.

SLA Policy metric values ref: https://developer.zendesk.com/rest_api/docs/support/sla_policies#metrics.

TicketCommentCreatedAtAsc defines ASC sort val.

TicketCommentCreatedAtDesc defines DESC sort val.

UserRoleAdmin admin.

UserRoleAgent agent.

UserRoleEndUser end-user.

ViaAnyChannel : Channel framework.

ViaAPIPhoneCallInbound : CTI phone call (inbound).

ViaAPIPhoneCallOutbound : CTI phone call (outbound).

ViaAPIVoicemail : CTI voicemail.

ViaChat : Chat.

ViaClosedTicket : Closed ticket.

ViaFacebookMessage : Facebook private message.

ViaFacebookPost : Facebook post.

ViaGetSatisfaction : Get Satisfaction.

ViaHelpCenter : Help Center post.

ViaMail : Email.

ViaMobile : Mobile.

ViaMobileSDK : Mobile SDK.

ViaPhoneCallInbound : Phone call (incoming).

ViaPhoneCallOutbound : Phone call (outbound).

ViaRule : Trigger, automation.

ViaSatisfactionPrediction : Satisfaction prediction.

ViaSMS : SMS.

ViaTicketSharing : Ticket Sharing.

ViaTwitter : Twitter.

ViaTwitterDM : Twitter DM.

ViaTwitterFavorite : Twitter like.

ViaVoicemail : Voicemail.

ViaWebForm : Web form.

ViaWebService : Web service (API).

ViaWebWidget : Web Widget.

ValidActionValuesMap Map of action fields to possible values, based on valid values from [Actions Reference] [Actions Reference]: https://developer.zendesk.com/documentation/ticketing/reference-guides/actions-reference/.

ValidRequirementStatuses is an array of strings denoting which statuses are available to be used in RequiredOnStatuses struct.

ValidRequirementTypes denotes which status requirement types are valid.

Action is definition of what the resource does to the ticket.

APITokenCredential is type of credential for API token authentication.

AppInstallation is a struct representing an app that has been installed from the Zendesk Marketplace.

Attachment is struct for attachment payload https://developer.zendesk.com/rest_api/docs/support/attachments.html.

Automation is zendesk automation JSON payload format ref: https://developer.zendesk.com/rest_api/docs/core/automations#json-format.

AutomationListOptions is options for GetAutomations ref: https://developer.zendesk.com/rest_api/docs/support/automations#list-automations.

BasicAuthCredential is type of credential for Basic authentication.

BearerTokenCredential can be used to authenticate OAuth tokens issued by Zendesk.

Brand is struct for brand payload https://developer.zendesk.com/rest_api/docs/support/brands.

CBPOptions struct is used to specify options for listing objects in CBP (Cursor Based Pagination).

ChildField is used to define when to show a field based on a condition from a parent field in a form.

Collaborator is user information for collaborator field value.

Collaborators hold array of interface which can take Collaborator ref: https://developer.zendesk.com/rest_api/docs/support/tickets#setting-collaborators.

Condition zendesk condition, see [Zendesk Conditions Reference] [Zendesk Conditions Reference]: https://developer.zendesk.com/documentation/ticketing/reference-guides/conditions-Reference/.

ConditionalTicketField condition which to display fields ParentFieldId is the ticket field the condition is for, where the condition is matching the value in Value.

Configuration is a dictionary of custom configuration fields.

CountOptions are the options that can be provided to the search results count API ref: https://developer.zendesk.com/rest_api/docs/support/search#show-results-count.

Cursor is struct for cursor-based pagination.

CursorOption is options for list methods for cursor-based pagination resources It's used to create query string.

CustomFieldOption is struct for value of `custom_field_options`.

CustomObjectAutocompleteOptions custom object search options.

CustomObjectListOptions custom object list options.

CustomRole is zendesk CustomRole JSON payload format https://developer.zendesk.com/api-reference/ticketing/account-configuration/custom_roles/.

DynamicContentItem is zendesk dynamic content item JSON payload format https://developer.zendesk.com/rest_api/docs/support/users.

DynamicContentVariant is zendesk dynamic content variant JSON payload format https://developer.zendesk.com/rest_api/docs/support/dynamic_content#json-format-for-variants.

Error an error type containing the http response from zendesk.

GetManyUsersOptions is options for GetManyUsers ref: https://developer.zendesk.com/api-reference/ticketing/users/users/#show-many-users.

Group is struct for group payload https://developer.zendesk.com/rest_api/docs/support/groups.

GroupListOptions is options for GetGroups ref: https://developer.zendesk.com/rest_api/docs/support/groups#list-groups.

terator struct provides a convenient and genric way to iterate over pages of objects in either OBP or CBP.

ListTicketCommentOptions contains all the options supported by ListTicketComments endpoint.

ListTicketCommentsResult contains the resulting ticket comments and cursor pagination metadata.

Locale is zendesk locale JSON payload format https://developer.zendesk.com/rest_api/docs/support/locales.

Macro is information about zendesk macro.

MacroListOptions is parameters used of GetMacros.

OBPOptions struct is used to specify options for listing objects in OBP (Offset Based Pagination).

OptionsError is an error type for invalid option argument.

Organization is struct for organization payload https://developer.zendesk.com/rest_api/docs/support/organizations.

OrganizationField represents the Organization Custom field structure.

OrganizationListOptions is options for GetOrganizations ref: https://developer.zendesk.com/rest_api/docs/support/organizations#list-organizations.

Page is base struct for resource pagination.

PageOptions is options for list method of paginatable resources.

PaginationOptions struct represents general pagination options.

Photo is thumbnail which is included in attachment.

RedactTicketCommentRequest contains the body of the RedactTicketComment PUT request.

RelationshipFilter is struct for value of `relationship_filter`.

Requester is the struct that can be passed to create a new requester on ticket creation https://develop.zendesk.com/hc/en-us/articles/360059146153#creating-a-ticket-with-a-new-requester.

RequiredOnStatuses is an object that defines how status requires a child field on a form.

SearchOptions are the options that can be provided to the search API ref: https://developer.zendesk.com/rest_api/docs/support/search#available-parameters.

SearchUsersOptions is options for SearchUsers ref: https://developer.zendesk.com/api-reference/ticketing/users/users/#search-users.

SLAPolicy is zendesk slaPolicy JSON payload format ref: https://developer.zendesk.com/rest_api/docs/core/slas/policies#json-format.

SLAPolicyListOptions is options for GetSLAPolicies ref: https://developer.zendesk.com/rest_api/docs/support/slas/policies#list-slas/policies.

Target is struct for target payload.

TicketAudit is struct for ticket_audit payload.

TicketAuditVia is struct for via payload.

TicketComment is a struct for ticket comment payload Via and Metadata are currently unused https://developer.zendesk.com/rest_api/docs/support/ticket_comments.

TicketField is struct for ticket_field payload.

TicketFieldSystemFieldOption is struct for value of `system_field_options`.

TicketForm ticket forms allow an admin to define a subset of ticket fields for display to both agents and end users.

TicketFormListOptions is options for GetTicketForms ref: https://developer.zendesk.com/rest_api/docs/support/ticket_forms#available-parameters.

TicketListCBPResult struct represents the result of a ticket list operation in CBP.

TicketListOptions struct is used to specify options for listing tickets in OBP (Offset Based Pagination).

TimeDuration represents a time in business or calendar days.

Trigger is zendesk trigger JSON payload format ref: https://developer.zendesk.com/rest_api/docs/core/triggers#json-format.

TriggerListOptions is options for GetTriggers ref: https://developer.zendesk.com/rest_api/docs/support/triggers#list-triggers.

TriggerListOptions is options for GetTriggers ref: https://developer.zendesk.com/rest_api/docs/support/triggers#list-triggers.

Upload is the API response received from zendesk whenc creating attachments.

User is zendesk user JSON payload format https://developer.zendesk.com/rest_api/docs/support/users.

UserField is struct for user_field payload.

UserListOptions is options for GetUsers ref: https://developer.zendesk.com/rest_api/docs/support/users#list-users.

UserRelated contains user related data ref: https://developer.zendesk.com/api-reference/ticketing/users/users/#show-user-related-information.

Via is information about source of Ticket or TicketComment.

Webhook is struct for webhook payload.

API an interface containing all the zendesk client methods.

AppAPI is an interface containing all methods associated with zendesk apps.

AttachmentAPI an interface containing all of the attachment related zendesk methods.

AutomationAPI an interface containing all automation related methods.

BrandAPI an interface containing all methods associated with zendesk brands.

Credential is interface of API credential.

CustomObjectAPI an interface containing all custom object related methods.

CustomRoleAPI an interface containing all CustomRole related methods.

DynamicContentAPI an interface containing all methods associated with zendesk dynamic content.

GroupAPI an interface containing all methods associated with zendesk groups.

LocaleAPI an interface containing all of the local related zendesk methods.

MacroAPI an interface containing all macro related methods.

OrganizationAPI an interface containing all methods associated with zendesk organizations.

OrganizationFieldAPI an interface containing all the organization field related zendesk methods.

SLAPolicyAPI an interface containing all slaPolicy related methods.

TagAPI an interface containing all tag related methods.

TargetAPI an interface containing all of the target related zendesk methods.

TicketAPI an interface containing all ticket related methods.

TicketAuditAPI an interface containing all of the ticket audit related zendesk methods.

TicketCommentAPI is an interface containing all ticket comment related API methods.

TicketFieldAPI an interface containing all the ticket field related zendesk methods.

TicketFormAPI an interface containing all ticket form related methods.

TicketMetricsAPI is an interface containing all methods for the ticket metrics API.

TriggerAPI an interface containing all trigger related methods.

TriggerAPI an interface containing all trigger related methods.

UploadWriter is used to write a zendesk attachment.

UserAPI an interface containing all user related methods.

ActionField action field types which defined by system, see [Zendesk Actions Reference] [Zendesk Actions Reference]: https://developer.zendesk.com/documentation/ticketing/reference-guides/actions-Reference/.

ActionResourceType String type of resource the action belongs to.

CbpFunc defines the signature of the function used to list objects in CBP.

ObpFunc defines the signature of the function used to list objects in OBP.

Tag is an alias for string.

TicketFieldsTypes is a slice containing all valid ticket field names.

UserFields is a dictionary of custom user related fields.