package
0.0.0-20230413094122-3c7ba50e4db9
Repository: https://github.com/vendasta/go-zendesk.git
Documentation: pkg.go.dev
# Functions
Bool is a helper function that returns a pointer to the bool value b.
IncludeCommentCount will include a top level array of groups.
IncludeGroups will include a top level array of groups.
IncludeUsers will include a top level array of users.
Int is a helper function that returns a pointer to the int value i.
NewClient creates a new Client.
NewEnvClient creates a new Client configured via environment variables.
NewMockClient creates a new instance of MockClient.
NewURLClient is like NewClient but accepts an explicit end point instead of a Zendesk domain.
OrganizationFilter filters tickets for the matching organization.
StatusFilter filters tickets by their status.
String is a helper function that returns a pointer to the string value s.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
APIError represents an error response returnted by the API.
APIErrorDetail represents a detail about an APIError.
APIPayload represents the payload of an API call.
Article represents a Zendesk Article
Zendesk Help Center API docs: https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/#json-format.
Attachment represents a Zendesk attachment for tickets and forum posts.
Category represents a Zendesk Category
Zendesk Help Center API docs: https://developer.zendesk.com/api-reference/help_center/help-center-api/categories/#json-format.
ComplianceDeletionStatus represents a GDPR status
Zendesk Core API docs: https://developer.zendesk.com/rest_api/docs/core/users#show-compliance-deletion-statuses.
No description provided by the author
Group represents a Zendesk group.
JobStatus represents a Zendesk JobStatus.
ListOptions specifies the optional parameters for the list methods that support pagination.
ListResponse is a holder for the various returns from the list apis.
ListUsersOptions specifies the optional parameters for the list users methods.
Locale represents an Zendesk translation locale.
MockClient is an autogenerated mock type for the Client type.
Organization represents a Zendesk organization.
OrganizationMembership represents a Zendesk association between an org and a user.
PermissionGroup represents a Zendesk Permission Group
Zendesk Help Center API docs: https://developer.zendesk.com/api-reference/help_center/help-center-api/permission_groups/#json-format.
QueryOptions to narrow search results.
No description provided by the author
Result represents the data from processed tasks within the Job Status.
Section represents a Zendesk Section
Zendesk Help Center API docs: https://developer.zendesk.com/api-reference/help_center/help-center-api/sections/#json-format.
Side-Loading
Zendesk Core API doscs: https://developer.zendesk.com/rest_api/docs/core/side_loading#side-loading.
Ticket represents a Zendesk Ticket.
TicketComment represents a comment on a Ticket.
No description provided by the author
TicketSearchResults represents returned results from the unified search api for type:ticket.
Upload represents a Zendesk file upload.
User represents a Zendesk user.
UserIdentity represents a Zendesk user identity.
No description provided by the author
# Interfaces
Client describes a client for the Zendesk Core API.
# Type aliases
SearchString to pass to zendesk.
No description provided by the author
No description provided by the author
ResultType returns records of the specified resource type Possible values include ticket, user, organization, or group.
SearchOperator represents supported search operators for zendesk searches.
Allows for side loads to be specified on api requests that support it.
Status returns tickets set to the specified status.