# Packages
Package mock is a generated GoMock package.
# Functions
ActionFieldText takes field type and returns field name string.
ConditionFieldText takes field type and returns field name string.
LocaleTypeText returns locale type text.
NewAPITokenCredential creates APITokenCredential and returns its pointer.
NewBasicAuthCredential creates BasicAuthCredential and returns its pointer.
NewClient creates new Zendesk API client.
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.
# Constants
ActionFieldAssigneeID assignee_id.
ActionFieldCC cc.
ActionFieldCommentModeIsPublic comment_mode_is_public.
ActionFieldCommentValue comment_value.
ActionFieldCommentValueHTML comment_value_html.
ActionFieldCurrentTags current_tags.
ActionFieldGroupID group_id.
ActionFieldLocaleID locale_id.
ActionFieldNotificationGroup notification_group.
ActionFieldNotificationTarget notification_target.
ActionFieldNotificationUser notification_user.
ActionFieldPriority priority.
ActionFieldRemoveTags remove_tags.
ActionFieldSatisfactionScore satisfaction_score.
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 agent_stations.
ConditionFieldAssignedAt assigned_at.
ConditionFieldAssigneeID assignee_id.
ConditionFieldAssigneeUpdatedAt.
ConditionFieldClosed CLOSED.
ConditionFieldCommentIncludesWord comment_includes_word.
ConditionFieldCommentIsPublic comment_is_public.
ConditionFieldCurrentTags current_tags.
ConditionFieldCurrentViaID current_via_id.
ConditionFieldDescriptionIncludesWord description_includes_word.
ConditionFieldDueDate due_date.
ConditionFieldExactCreatedAt exact_created_at.
ConditionFieldGroupID group_id.
ConditionFieldGroupStations group_stations.
ConditionFieldInBusinessHours in_business_hours.
ConditionFieldLocaleID locale_id.
ConditionFieldNew NEW.
ConditionFieldOpen OPEN.
ConditionFieldOrganizationID organization_id.
ConditionFieldPending PENDING.
ConditionFieldPriority priority.
ConditionFieldRecipient recipient.
ConditionFieldReopens reopens.
ConditionFieldReplies.
ConditionFieldRequesterID requester_id.
ConditionFieldRequesterTwitterFollowersCount requester_twitter_followers_count.
ConditionFieldRequesterTwitterStatusesCount requester_twitter_statuses_count.
ConditionFieldRequesterTwitterVerified requester_twitter_verified.
ConditionFieldRequesterUpdatedAt requester_updated_at.
ConditionFieldSatisfactionScore satisfaction_score.
ConditionFieldSolved SOLVED.
ConditionFieldStatus status.
ConditionFieldSubjectIncludesWord subject_includes_word.
ConditionFieldTicketIsPublic ticket_is_public.
ConditionFieldTicketTypeID ticket_type_id.
ConditionFieldType type.
ConditionFieldUntilDueDate until_due_date.
ConditionFieldUpdatedAt updated_at.
ConditionFieldUpdateType update_type.
ConditionFieldViaID via_id.
SLA Policy metric values
ref: https://developer.zendesk.com/rest_api/docs/support/sla_policies#metrics.
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.
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.
TwitterFavorite : Twitter like.
ViaVoicemail : Voicemail.
ViaWebForm : Web form.
ViaWebService : Web service (API).
ViaWebWidget : Web Widget.
# Structs
APITokenCredential is type of credential for API token authentication.
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.
AutomationAction is zendesk automation action
ref: https://developer.zendesk.com/rest_api/docs/core/automations#actions.
AutomationCondition zendesk automation condition
ref: https://developer.zendesk.com/rest_api/docs/core/automations#conditions-reference.
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.
Brand is struct for brand payload https://developer.zendesk.com/rest_api/docs/support/brands.
No description provided by the author
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.
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.
No description provided by the author
CustomFieldOption is struct for value of `custom_field_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.
No description provided by the author
No description provided by the author
Locale is zendesk locale JSON payload format https://developer.zendesk.com/rest_api/docs/support/locales.
Macro is information about zendesk macro.
MacroAction is definition of what the macro does to the ticket
ref: https://develop.zendesk.com/hc/en-us/articles/360056760874-Support-API-Actions-reference.
MacroListOptions is parameters used of GetMacros.
OptionsError is an error type for invalid option argument.
Organization is struct for organization payload https://developer.zendesk.com/rest_api/docs/support/organizations.
OrganizationListOptions is options for GetOrganizations
ref: https://developer.zendesk.com/rest_api/docs/support/organizations#list-organizations.
No description provided by the author
No description provided by the author
Page is base struct for resource pagination.
PageOptions is options for list method of paginatable resources.
Photo is thumbnail which is included in attachment.
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.
SearchOptions are the options that can be provided to the search API
ref: https://developer.zendesk.com/rest_api/docs/support/search#available-parameters.
No description provided by the author
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.
SLAPolicyFilter zendesk slaPolicy condition
ref: https://developer.zendesk.com/rest_api/docs/core/slas/policies#conditions-reference.
SLAPolicyListOptions is options for GetSLAPolicies
ref: https://developer.zendesk.com/rest_api/docs/support/slas/policies#list-slas/policies.
No description provided by the author
Target is struct for target payload.
No description provided by the author
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 is JSON payload struct.
TicketFormListOptions is options for GetTicketForms
ref: https://developer.zendesk.com/rest_api/docs/support/ticket_forms#available-parameters.
No description provided by the author
No description provided by the author
Trigger is zendesk trigger JSON payload format
ref: https://developer.zendesk.com/rest_api/docs/core/triggers#json-format.
TriggerAction is zendesk trigger action
ref: https://developer.zendesk.com/rest_api/docs/core/triggers#actions.
TriggerCondition zendesk trigger condition
ref: https://developer.zendesk.com/rest_api/docs/core/triggers#conditions-reference.
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.
No description provided by the author
UserIdentity is struct for user_field payload.
No description provided by the author
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.
No description provided by the author
Webhook is struct for webhook payload.
No description provided by the author
No description provided by the author
# Interfaces
API an interface containing all of the zendesk client methods.
AttachmentAPI an interface containing all of the attachment related zendesk methods.
AutomationAPI an interface containing all automation related methods.
No description provided by the author
BrandAPI an interface containing all methods associated with zendesk brands.
Credential is interface of API credential.
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.
No description provided by the author
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.
No description provided by the author
No description provided by the author
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 of the ticket field related zendesk methods.
TicketFormAPI an interface containing all ticket form 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.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Type aliases
Configuration is a dictionary of custom configuration fields.
Tag is an alias for string.
UserFields is a dictionary of custom user related fields.