intercom

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 3, 2026 License: MIT Imports: 11 Imported by: 0

Documentation

Overview

Package intercom provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.6.0 DO NOT EDIT.

Index

Constants

View Source
const (
	BearerAuthScopes = "bearerAuth.Scopes"
)

Variables

This section is empty.

Functions

func NewArchiveContactRequest

func NewArchiveContactRequest(server string, contactId string, params *ArchiveContactParams) (*http.Request, error)

NewArchiveContactRequest generates requests for ArchiveContact

func NewAttachContactToACompanyRequest

func NewAttachContactToACompanyRequest(server string, contactId string, params *AttachContactToACompanyParams, body AttachContactToACompanyJSONRequestBody) (*http.Request, error)

NewAttachContactToACompanyRequest calls the generic AttachContactToACompany builder with application/json body

func NewAttachContactToACompanyRequestWithBody

func NewAttachContactToACompanyRequestWithBody(server string, contactId string, params *AttachContactToACompanyParams, contentType string, body io.Reader) (*http.Request, error)

NewAttachContactToACompanyRequestWithBody generates requests for AttachContactToACompany with any type of body

func NewAttachContactToConversationRequest

func NewAttachContactToConversationRequest(server string, conversationId string, params *AttachContactToConversationParams, body AttachContactToConversationJSONRequestBody) (*http.Request, error)

NewAttachContactToConversationRequest calls the generic AttachContactToConversation builder with application/json body

func NewAttachContactToConversationRequestWithBody

func NewAttachContactToConversationRequestWithBody(server string, conversationId string, params *AttachContactToConversationParams, contentType string, body io.Reader) (*http.Request, error)

NewAttachContactToConversationRequestWithBody generates requests for AttachContactToConversation with any type of body

func NewAttachSubscriptionTypeToContactRequest

func NewAttachSubscriptionTypeToContactRequest(server string, contactId string, params *AttachSubscriptionTypeToContactParams, body AttachSubscriptionTypeToContactJSONRequestBody) (*http.Request, error)

NewAttachSubscriptionTypeToContactRequest calls the generic AttachSubscriptionTypeToContact builder with application/json body

func NewAttachSubscriptionTypeToContactRequestWithBody

func NewAttachSubscriptionTypeToContactRequestWithBody(server string, contactId string, params *AttachSubscriptionTypeToContactParams, contentType string, body io.Reader) (*http.Request, error)

NewAttachSubscriptionTypeToContactRequestWithBody generates requests for AttachSubscriptionTypeToContact with any type of body

func NewAttachTagToContactRequest

func NewAttachTagToContactRequest(server string, contactId string, params *AttachTagToContactParams, body AttachTagToContactJSONRequestBody) (*http.Request, error)

NewAttachTagToContactRequest calls the generic AttachTagToContact builder with application/json body

func NewAttachTagToContactRequestWithBody

func NewAttachTagToContactRequestWithBody(server string, contactId string, params *AttachTagToContactParams, contentType string, body io.Reader) (*http.Request, error)

NewAttachTagToContactRequestWithBody generates requests for AttachTagToContact with any type of body

func NewAttachTagToConversationRequest

func NewAttachTagToConversationRequest(server string, conversationId string, params *AttachTagToConversationParams, body AttachTagToConversationJSONRequestBody) (*http.Request, error)

NewAttachTagToConversationRequest calls the generic AttachTagToConversation builder with application/json body

func NewAttachTagToConversationRequestWithBody

func NewAttachTagToConversationRequestWithBody(server string, conversationId string, params *AttachTagToConversationParams, contentType string, body io.Reader) (*http.Request, error)

NewAttachTagToConversationRequestWithBody generates requests for AttachTagToConversation with any type of body

func NewAttachTagToTicketRequest

func NewAttachTagToTicketRequest(server string, ticketId string, params *AttachTagToTicketParams, body AttachTagToTicketJSONRequestBody) (*http.Request, error)

NewAttachTagToTicketRequest calls the generic AttachTagToTicket builder with application/json body

func NewAttachTagToTicketRequestWithBody

func NewAttachTagToTicketRequestWithBody(server string, ticketId string, params *AttachTagToTicketParams, contentType string, body io.Reader) (*http.Request, error)

NewAttachTagToTicketRequestWithBody generates requests for AttachTagToTicket with any type of body

func NewBlockContactRequest

func NewBlockContactRequest(server string, contactId string, params *BlockContactParams) (*http.Request, error)

NewBlockContactRequest generates requests for BlockContact

func NewCancelDataExportRequest

func NewCancelDataExportRequest(server string, jobIdentifier string, params *CancelDataExportParams) (*http.Request, error)

NewCancelDataExportRequest generates requests for CancelDataExport

func NewCollectFinVoiceCallByExternalIdRequest

func NewCollectFinVoiceCallByExternalIdRequest(server string, externalId string) (*http.Request, error)

NewCollectFinVoiceCallByExternalIdRequest generates requests for CollectFinVoiceCallByExternalId

func NewCollectFinVoiceCallByIdRequest

func NewCollectFinVoiceCallByIdRequest(server string, id int) (*http.Request, error)

NewCollectFinVoiceCallByIdRequest generates requests for CollectFinVoiceCallById

func NewCollectFinVoiceCallByPhoneNumberRequest

func NewCollectFinVoiceCallByPhoneNumberRequest(server string, phoneNumber string) (*http.Request, error)

NewCollectFinVoiceCallByPhoneNumberRequest generates requests for CollectFinVoiceCallByPhoneNumber

func NewCollectFinVoiceCallsByConversationIdRequest

func NewCollectFinVoiceCallsByConversationIdRequest(server string, conversationId string) (*http.Request, error)

NewCollectFinVoiceCallsByConversationIdRequest generates requests for CollectFinVoiceCallsByConversationId

func NewConvertConversationToTicketRequest

func NewConvertConversationToTicketRequest(server string, conversationId int, params *ConvertConversationToTicketParams, body ConvertConversationToTicketJSONRequestBody) (*http.Request, error)

NewConvertConversationToTicketRequest calls the generic ConvertConversationToTicket builder with application/json body

func NewConvertConversationToTicketRequestWithBody

func NewConvertConversationToTicketRequestWithBody(server string, conversationId int, params *ConvertConversationToTicketParams, contentType string, body io.Reader) (*http.Request, error)

NewConvertConversationToTicketRequestWithBody generates requests for ConvertConversationToTicket with any type of body

func NewConvertVisitorRequest

func NewConvertVisitorRequest(server string, params *ConvertVisitorParams, body ConvertVisitorJSONRequestBody) (*http.Request, error)

NewConvertVisitorRequest calls the generic ConvertVisitor builder with application/json body

func NewConvertVisitorRequestWithBody

func NewConvertVisitorRequestWithBody(server string, params *ConvertVisitorParams, contentType string, body io.Reader) (*http.Request, error)

NewConvertVisitorRequestWithBody generates requests for ConvertVisitor with any type of body

func NewCreateArticleRequest

func NewCreateArticleRequest(server string, params *CreateArticleParams, body CreateArticleJSONRequestBody) (*http.Request, error)

NewCreateArticleRequest calls the generic CreateArticle builder with application/json body

func NewCreateArticleRequestWithBody

func NewCreateArticleRequestWithBody(server string, params *CreateArticleParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateArticleRequestWithBody generates requests for CreateArticle with any type of body

func NewCreateCollectionRequest

func NewCreateCollectionRequest(server string, params *CreateCollectionParams, body CreateCollectionJSONRequestBody) (*http.Request, error)

NewCreateCollectionRequest calls the generic CreateCollection builder with application/json body

func NewCreateCollectionRequestWithBody

func NewCreateCollectionRequestWithBody(server string, params *CreateCollectionParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateCollectionRequestWithBody generates requests for CreateCollection with any type of body

func NewCreateContactRequest

func NewCreateContactRequest(server string, params *CreateContactParams, body CreateContactJSONRequestBody) (*http.Request, error)

NewCreateContactRequest calls the generic CreateContact builder with application/json body

func NewCreateContactRequestWithBody

func NewCreateContactRequestWithBody(server string, params *CreateContactParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateContactRequestWithBody generates requests for CreateContact with any type of body

func NewCreateContentImportSourceRequest

func NewCreateContentImportSourceRequest(server string, params *CreateContentImportSourceParams, body CreateContentImportSourceJSONRequestBody) (*http.Request, error)

NewCreateContentImportSourceRequest calls the generic CreateContentImportSource builder with application/json body

func NewCreateContentImportSourceRequestWithBody

func NewCreateContentImportSourceRequestWithBody(server string, params *CreateContentImportSourceParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateContentImportSourceRequestWithBody generates requests for CreateContentImportSource with any type of body

func NewCreateConversationRequest

func NewCreateConversationRequest(server string, params *CreateConversationParams, body CreateConversationJSONRequestBody) (*http.Request, error)

NewCreateConversationRequest calls the generic CreateConversation builder with application/json body

func NewCreateConversationRequestWithBody

func NewCreateConversationRequestWithBody(server string, params *CreateConversationParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateConversationRequestWithBody generates requests for CreateConversation with any type of body

func NewCreateCustomObjectInstancesRequest

func NewCreateCustomObjectInstancesRequest(server string, customObjectTypeIdentifier string, params *CreateCustomObjectInstancesParams, body CreateCustomObjectInstancesJSONRequestBody) (*http.Request, error)

NewCreateCustomObjectInstancesRequest calls the generic CreateCustomObjectInstances builder with application/json body

func NewCreateCustomObjectInstancesRequestWithBody

func NewCreateCustomObjectInstancesRequestWithBody(server string, customObjectTypeIdentifier string, params *CreateCustomObjectInstancesParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateCustomObjectInstancesRequestWithBody generates requests for CreateCustomObjectInstances with any type of body

func NewCreateDataAttributeRequest

func NewCreateDataAttributeRequest(server string, params *CreateDataAttributeParams, body CreateDataAttributeJSONRequestBody) (*http.Request, error)

NewCreateDataAttributeRequest calls the generic CreateDataAttribute builder with application/json body

func NewCreateDataAttributeRequestWithBody

func NewCreateDataAttributeRequestWithBody(server string, params *CreateDataAttributeParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateDataAttributeRequestWithBody generates requests for CreateDataAttribute with any type of body

func NewCreateDataEventRequest

func NewCreateDataEventRequest(server string, params *CreateDataEventParams, body CreateDataEventJSONRequestBody) (*http.Request, error)

NewCreateDataEventRequest calls the generic CreateDataEvent builder with application/json body

func NewCreateDataEventRequestWithBody

func NewCreateDataEventRequestWithBody(server string, params *CreateDataEventParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateDataEventRequestWithBody generates requests for CreateDataEvent with any type of body

func NewCreateDataExportRequest

func NewCreateDataExportRequest(server string, params *CreateDataExportParams, body CreateDataExportJSONRequestBody) (*http.Request, error)

NewCreateDataExportRequest calls the generic CreateDataExport builder with application/json body

func NewCreateDataExportRequestWithBody

func NewCreateDataExportRequestWithBody(server string, params *CreateDataExportParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateDataExportRequestWithBody generates requests for CreateDataExport with any type of body

func NewCreateExternalPageRequest

func NewCreateExternalPageRequest(server string, params *CreateExternalPageParams, body CreateExternalPageJSONRequestBody) (*http.Request, error)

NewCreateExternalPageRequest calls the generic CreateExternalPage builder with application/json body

func NewCreateExternalPageRequestWithBody

func NewCreateExternalPageRequestWithBody(server string, params *CreateExternalPageParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateExternalPageRequestWithBody generates requests for CreateExternalPage with any type of body

func NewCreateInternalArticleRequest

func NewCreateInternalArticleRequest(server string, params *CreateInternalArticleParams, body CreateInternalArticleJSONRequestBody) (*http.Request, error)

NewCreateInternalArticleRequest calls the generic CreateInternalArticle builder with application/json body

func NewCreateInternalArticleRequestWithBody

func NewCreateInternalArticleRequestWithBody(server string, params *CreateInternalArticleParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateInternalArticleRequestWithBody generates requests for CreateInternalArticle with any type of body

func NewCreateMessageRequest

func NewCreateMessageRequest(server string, params *CreateMessageParams, body CreateMessageJSONRequestBody) (*http.Request, error)

NewCreateMessageRequest calls the generic CreateMessage builder with application/json body

func NewCreateMessageRequestWithBody

func NewCreateMessageRequestWithBody(server string, params *CreateMessageParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateMessageRequestWithBody generates requests for CreateMessage with any type of body

func NewCreateNewsItemRequest

func NewCreateNewsItemRequest(server string, params *CreateNewsItemParams, body CreateNewsItemJSONRequestBody) (*http.Request, error)

NewCreateNewsItemRequest calls the generic CreateNewsItem builder with application/json body

func NewCreateNewsItemRequestWithBody

func NewCreateNewsItemRequestWithBody(server string, params *CreateNewsItemParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateNewsItemRequestWithBody generates requests for CreateNewsItem with any type of body

func NewCreateNoteRequest

func NewCreateNoteRequest(server string, contactId int, params *CreateNoteParams, body CreateNoteJSONRequestBody) (*http.Request, error)

NewCreateNoteRequest calls the generic CreateNote builder with application/json body

func NewCreateNoteRequestWithBody

func NewCreateNoteRequestWithBody(server string, contactId int, params *CreateNoteParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateNoteRequestWithBody generates requests for CreateNote with any type of body

func NewCreateOrUpdateCompanyRequest

func NewCreateOrUpdateCompanyRequest(server string, params *CreateOrUpdateCompanyParams, body CreateOrUpdateCompanyJSONRequestBody) (*http.Request, error)

NewCreateOrUpdateCompanyRequest calls the generic CreateOrUpdateCompany builder with application/json body

func NewCreateOrUpdateCompanyRequestWithBody

func NewCreateOrUpdateCompanyRequestWithBody(server string, params *CreateOrUpdateCompanyParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateOrUpdateCompanyRequestWithBody generates requests for CreateOrUpdateCompany with any type of body

func NewCreatePhoneSwitchRequest

func NewCreatePhoneSwitchRequest(server string, params *CreatePhoneSwitchParams, body CreatePhoneSwitchJSONRequestBody) (*http.Request, error)

NewCreatePhoneSwitchRequest calls the generic CreatePhoneSwitch builder with application/json body

func NewCreatePhoneSwitchRequestWithBody

func NewCreatePhoneSwitchRequestWithBody(server string, params *CreatePhoneSwitchParams, contentType string, body io.Reader) (*http.Request, error)

NewCreatePhoneSwitchRequestWithBody generates requests for CreatePhoneSwitch with any type of body

func NewCreateTagRequest

func NewCreateTagRequest(server string, params *CreateTagParams, body CreateTagJSONRequestBody) (*http.Request, error)

NewCreateTagRequest calls the generic CreateTag builder with application/json body

func NewCreateTagRequestWithBody

func NewCreateTagRequestWithBody(server string, params *CreateTagParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateTagRequestWithBody generates requests for CreateTag with any type of body

func NewCreateTicketRequest

func NewCreateTicketRequest(server string, params *CreateTicketParams, body CreateTicketJSONRequestBody) (*http.Request, error)

NewCreateTicketRequest calls the generic CreateTicket builder with application/json body

func NewCreateTicketRequestWithBody

func NewCreateTicketRequestWithBody(server string, params *CreateTicketParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateTicketRequestWithBody generates requests for CreateTicket with any type of body

func NewCreateTicketTypeAttributeRequest

func NewCreateTicketTypeAttributeRequest(server string, ticketTypeId string, params *CreateTicketTypeAttributeParams, body CreateTicketTypeAttributeJSONRequestBody) (*http.Request, error)

NewCreateTicketTypeAttributeRequest calls the generic CreateTicketTypeAttribute builder with application/json body

func NewCreateTicketTypeAttributeRequestWithBody

func NewCreateTicketTypeAttributeRequestWithBody(server string, ticketTypeId string, params *CreateTicketTypeAttributeParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateTicketTypeAttributeRequestWithBody generates requests for CreateTicketTypeAttribute with any type of body

func NewCreateTicketTypeRequest

func NewCreateTicketTypeRequest(server string, params *CreateTicketTypeParams, body CreateTicketTypeJSONRequestBody) (*http.Request, error)

NewCreateTicketTypeRequest calls the generic CreateTicketType builder with application/json body

func NewCreateTicketTypeRequestWithBody

func NewCreateTicketTypeRequestWithBody(server string, params *CreateTicketTypeParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateTicketTypeRequestWithBody generates requests for CreateTicketType with any type of body

func NewDataEventSummariesRequest

func NewDataEventSummariesRequest(server string, params *DataEventSummariesParams, body DataEventSummariesJSONRequestBody) (*http.Request, error)

NewDataEventSummariesRequest calls the generic DataEventSummaries builder with application/json body

func NewDataEventSummariesRequestWithBody

func NewDataEventSummariesRequestWithBody(server string, params *DataEventSummariesParams, contentType string, body io.Reader) (*http.Request, error)

NewDataEventSummariesRequestWithBody generates requests for DataEventSummaries with any type of body

func NewDeleteArticleRequest

func NewDeleteArticleRequest(server string, articleId int, params *DeleteArticleParams) (*http.Request, error)

NewDeleteArticleRequest generates requests for DeleteArticle

func NewDeleteCollectionRequest

func NewDeleteCollectionRequest(server string, collectionId int, params *DeleteCollectionParams) (*http.Request, error)

NewDeleteCollectionRequest generates requests for DeleteCollection

func NewDeleteCompanyRequest

func NewDeleteCompanyRequest(server string, companyId string, params *DeleteCompanyParams) (*http.Request, error)

NewDeleteCompanyRequest generates requests for DeleteCompany

func NewDeleteContactRequest

func NewDeleteContactRequest(server string, contactId string, params *DeleteContactParams) (*http.Request, error)

NewDeleteContactRequest generates requests for DeleteContact

func NewDeleteContentImportSourceRequest

func NewDeleteContentImportSourceRequest(server string, sourceId string, params *DeleteContentImportSourceParams) (*http.Request, error)

NewDeleteContentImportSourceRequest generates requests for DeleteContentImportSource

func NewDeleteConversationRequest

func NewDeleteConversationRequest(server string, conversationId int, params *DeleteConversationParams) (*http.Request, error)

NewDeleteConversationRequest generates requests for DeleteConversation

func NewDeleteCustomObjectInstancesByExternalIdRequest

func NewDeleteCustomObjectInstancesByExternalIdRequest(server string, customObjectTypeIdentifier string, customObjectInstanceId string, params *DeleteCustomObjectInstancesByExternalIdParams) (*http.Request, error)

NewDeleteCustomObjectInstancesByExternalIdRequest generates requests for DeleteCustomObjectInstancesByExternalId

func NewDeleteCustomObjectInstancesByIdRequest

func NewDeleteCustomObjectInstancesByIdRequest(server string, customObjectTypeIdentifier string, params *DeleteCustomObjectInstancesByIdParams) (*http.Request, error)

NewDeleteCustomObjectInstancesByIdRequest generates requests for DeleteCustomObjectInstancesById

func NewDeleteExternalPageRequest

func NewDeleteExternalPageRequest(server string, pageId string, params *DeleteExternalPageParams) (*http.Request, error)

NewDeleteExternalPageRequest generates requests for DeleteExternalPage

func NewDeleteInternalArticleRequest

func NewDeleteInternalArticleRequest(server string, internalArticleId int, params *DeleteInternalArticleParams) (*http.Request, error)

NewDeleteInternalArticleRequest generates requests for DeleteInternalArticle

func NewDeleteNewsItemRequest

func NewDeleteNewsItemRequest(server string, newsItemId int, params *DeleteNewsItemParams) (*http.Request, error)

NewDeleteNewsItemRequest generates requests for DeleteNewsItem

func NewDeleteTagRequest

func NewDeleteTagRequest(server string, tagId string, params *DeleteTagParams) (*http.Request, error)

NewDeleteTagRequest generates requests for DeleteTag

func NewDeleteTicketRequest

func NewDeleteTicketRequest(server string, ticketId string, params *DeleteTicketParams) (*http.Request, error)

NewDeleteTicketRequest generates requests for DeleteTicket

func NewDetachContactFromACompanyRequest

func NewDetachContactFromACompanyRequest(server string, contactId string, companyId string, params *DetachContactFromACompanyParams) (*http.Request, error)

NewDetachContactFromACompanyRequest generates requests for DetachContactFromACompany

func NewDetachContactFromConversationRequest

func NewDetachContactFromConversationRequest(server string, conversationId string, contactId string, params *DetachContactFromConversationParams, body DetachContactFromConversationJSONRequestBody) (*http.Request, error)

NewDetachContactFromConversationRequest calls the generic DetachContactFromConversation builder with application/json body

func NewDetachContactFromConversationRequestWithBody

func NewDetachContactFromConversationRequestWithBody(server string, conversationId string, contactId string, params *DetachContactFromConversationParams, contentType string, body io.Reader) (*http.Request, error)

NewDetachContactFromConversationRequestWithBody generates requests for DetachContactFromConversation with any type of body

func NewDetachSubscriptionTypeToContactRequest

func NewDetachSubscriptionTypeToContactRequest(server string, contactId string, subscriptionId string, params *DetachSubscriptionTypeToContactParams) (*http.Request, error)

NewDetachSubscriptionTypeToContactRequest generates requests for DetachSubscriptionTypeToContact

func NewDetachTagFromContactRequest

func NewDetachTagFromContactRequest(server string, contactId string, tagId string, params *DetachTagFromContactParams) (*http.Request, error)

NewDetachTagFromContactRequest generates requests for DetachTagFromContact

func NewDetachTagFromConversationRequest

func NewDetachTagFromConversationRequest(server string, conversationId string, tagId string, params *DetachTagFromConversationParams, body DetachTagFromConversationJSONRequestBody) (*http.Request, error)

NewDetachTagFromConversationRequest calls the generic DetachTagFromConversation builder with application/json body

func NewDetachTagFromConversationRequestWithBody

func NewDetachTagFromConversationRequestWithBody(server string, conversationId string, tagId string, params *DetachTagFromConversationParams, contentType string, body io.Reader) (*http.Request, error)

NewDetachTagFromConversationRequestWithBody generates requests for DetachTagFromConversation with any type of body

func NewDetachTagFromTicketRequest

func NewDetachTagFromTicketRequest(server string, ticketId string, tagId string, params *DetachTagFromTicketParams, body DetachTagFromTicketJSONRequestBody) (*http.Request, error)

NewDetachTagFromTicketRequest calls the generic DetachTagFromTicket builder with application/json body

func NewDetachTagFromTicketRequestWithBody

func NewDetachTagFromTicketRequestWithBody(server string, ticketId string, tagId string, params *DetachTagFromTicketParams, contentType string, body io.Reader) (*http.Request, error)

NewDetachTagFromTicketRequestWithBody generates requests for DetachTagFromTicket with any type of body

func NewDownloadDataExportRequest

func NewDownloadDataExportRequest(server string, jobIdentifier string, params *DownloadDataExportParams) (*http.Request, error)

NewDownloadDataExportRequest generates requests for DownloadDataExport

func NewEnqueueCreateTicketRequest

func NewEnqueueCreateTicketRequest(server string, params *EnqueueCreateTicketParams, body EnqueueCreateTicketJSONRequestBody) (*http.Request, error)

NewEnqueueCreateTicketRequest calls the generic EnqueueCreateTicket builder with application/json body

func NewEnqueueCreateTicketRequestWithBody

func NewEnqueueCreateTicketRequestWithBody(server string, params *EnqueueCreateTicketParams, contentType string, body io.Reader) (*http.Request, error)

NewEnqueueCreateTicketRequestWithBody generates requests for EnqueueCreateTicket with any type of body

func NewExportWorkflowRequest

func NewExportWorkflowRequest(server string, id string, params *ExportWorkflowParams) (*http.Request, error)

NewExportWorkflowRequest generates requests for ExportWorkflow

func NewFindTagRequest

func NewFindTagRequest(server string, tagId string, params *FindTagParams) (*http.Request, error)

NewFindTagRequest generates requests for FindTag

func NewGetContentImportSourceRequest

func NewGetContentImportSourceRequest(server string, sourceId string, params *GetContentImportSourceParams) (*http.Request, error)

NewGetContentImportSourceRequest generates requests for GetContentImportSource

func NewGetCustomObjectInstancesByExternalIdRequest

func NewGetCustomObjectInstancesByExternalIdRequest(server string, customObjectTypeIdentifier string, params *GetCustomObjectInstancesByExternalIdParams) (*http.Request, error)

NewGetCustomObjectInstancesByExternalIdRequest generates requests for GetCustomObjectInstancesByExternalId

func NewGetCustomObjectInstancesByIdRequest

func NewGetCustomObjectInstancesByIdRequest(server string, customObjectTypeIdentifier string, customObjectInstanceId string, params *GetCustomObjectInstancesByIdParams) (*http.Request, error)

NewGetCustomObjectInstancesByIdRequest generates requests for GetCustomObjectInstancesById

func NewGetDataExportRequest

func NewGetDataExportRequest(server string, jobIdentifier string, params *GetDataExportParams) (*http.Request, error)

NewGetDataExportRequest generates requests for GetDataExport

func NewGetDownloadReportingDataJobIdentifierRequest

func NewGetDownloadReportingDataJobIdentifierRequest(server string, jobIdentifier string, params *GetDownloadReportingDataJobIdentifierParams) (*http.Request, error)

NewGetDownloadReportingDataJobIdentifierRequest generates requests for GetDownloadReportingDataJobIdentifier

func NewGetExportReportingDataGetDatasetsRequest

func NewGetExportReportingDataGetDatasetsRequest(server string, params *GetExportReportingDataGetDatasetsParams) (*http.Request, error)

NewGetExportReportingDataGetDatasetsRequest generates requests for GetExportReportingDataGetDatasets

func NewGetExportReportingDataJobIdentifierRequest

func NewGetExportReportingDataJobIdentifierRequest(server string, jobIdentifier string, params *GetExportReportingDataJobIdentifierParams) (*http.Request, error)

NewGetExportReportingDataJobIdentifierRequest generates requests for GetExportReportingDataJobIdentifier

func NewGetExternalPageRequest

func NewGetExternalPageRequest(server string, pageId string, params *GetExternalPageParams) (*http.Request, error)

NewGetExternalPageRequest generates requests for GetExternalPage

func NewGetIpAllowlistRequest

func NewGetIpAllowlistRequest(server string, params *GetIpAllowlistParams) (*http.Request, error)

NewGetIpAllowlistRequest generates requests for GetIpAllowlist

func NewGetTicketRequest

func NewGetTicketRequest(server string, ticketId string, params *GetTicketParams) (*http.Request, error)

NewGetTicketRequest generates requests for GetTicket

func NewGetTicketTypeRequest

func NewGetTicketTypeRequest(server string, ticketTypeId string, params *GetTicketTypeParams) (*http.Request, error)

NewGetTicketTypeRequest generates requests for GetTicketType

func NewIdentifyAdminRequest

func NewIdentifyAdminRequest(server string, params *IdentifyAdminParams) (*http.Request, error)

NewIdentifyAdminRequest generates requests for IdentifyAdmin

func NewJobsStatusRequest

func NewJobsStatusRequest(server string, jobId string, params *JobsStatusParams) (*http.Request, error)

NewJobsStatusRequest generates requests for JobsStatus

func NewLisDataAttributesRequest

func NewLisDataAttributesRequest(server string, params *LisDataAttributesParams) (*http.Request, error)

NewLisDataAttributesRequest generates requests for LisDataAttributes

func NewLisDataEventsRequest

func NewLisDataEventsRequest(server string, params *LisDataEventsParams) (*http.Request, error)

NewLisDataEventsRequest generates requests for LisDataEvents

func NewListActivityLogsRequest

func NewListActivityLogsRequest(server string, params *ListActivityLogsParams) (*http.Request, error)

NewListActivityLogsRequest generates requests for ListActivityLogs

func NewListAdminsRequest

func NewListAdminsRequest(server string, params *ListAdminsParams) (*http.Request, error)

NewListAdminsRequest generates requests for ListAdmins

func NewListAllCollectionsRequest

func NewListAllCollectionsRequest(server string, params *ListAllCollectionsParams) (*http.Request, error)

NewListAllCollectionsRequest generates requests for ListAllCollections

func NewListAllCompaniesRequest

func NewListAllCompaniesRequest(server string, params *ListAllCompaniesParams) (*http.Request, error)

NewListAllCompaniesRequest generates requests for ListAllCompanies

func NewListArticlesRequest

func NewListArticlesRequest(server string, params *ListArticlesParams) (*http.Request, error)

NewListArticlesRequest generates requests for ListArticles

func NewListAttachedContactsRequest

func NewListAttachedContactsRequest(server string, companyId string, params *ListAttachedContactsParams) (*http.Request, error)

NewListAttachedContactsRequest generates requests for ListAttachedContacts

func NewListAttachedSegmentsForCompaniesRequest

func NewListAttachedSegmentsForCompaniesRequest(server string, companyId string, params *ListAttachedSegmentsForCompaniesParams) (*http.Request, error)

NewListAttachedSegmentsForCompaniesRequest generates requests for ListAttachedSegmentsForCompanies

func NewListAwayStatusReasonsRequest

func NewListAwayStatusReasonsRequest(server string, params *ListAwayStatusReasonsParams) (*http.Request, error)

NewListAwayStatusReasonsRequest generates requests for ListAwayStatusReasons

func NewListBrandsRequest

func NewListBrandsRequest(server string, params *ListBrandsParams) (*http.Request, error)

NewListBrandsRequest generates requests for ListBrands

func NewListCallsRequest

func NewListCallsRequest(server string, params *ListCallsParams) (*http.Request, error)

NewListCallsRequest generates requests for ListCalls

func NewListCallsWithTranscriptsRequest

func NewListCallsWithTranscriptsRequest(server string, params *ListCallsWithTranscriptsParams, body ListCallsWithTranscriptsJSONRequestBody) (*http.Request, error)

NewListCallsWithTranscriptsRequest calls the generic ListCallsWithTranscripts builder with application/json body

func NewListCallsWithTranscriptsRequestWithBody

func NewListCallsWithTranscriptsRequestWithBody(server string, params *ListCallsWithTranscriptsParams, contentType string, body io.Reader) (*http.Request, error)

NewListCallsWithTranscriptsRequestWithBody generates requests for ListCallsWithTranscripts with any type of body

func NewListCompaniesForAContactRequest

func NewListCompaniesForAContactRequest(server string, contactId string, params *ListCompaniesForAContactParams) (*http.Request, error)

NewListCompaniesForAContactRequest generates requests for ListCompaniesForAContact

func NewListCompanyNotesRequest

func NewListCompanyNotesRequest(server string, companyId string, params *ListCompanyNotesParams) (*http.Request, error)

NewListCompanyNotesRequest generates requests for ListCompanyNotes

func NewListContactsRequest

func NewListContactsRequest(server string, params *ListContactsParams) (*http.Request, error)

NewListContactsRequest generates requests for ListContacts

func NewListContentImportSourcesRequest

func NewListContentImportSourcesRequest(server string, params *ListContentImportSourcesParams) (*http.Request, error)

NewListContentImportSourcesRequest generates requests for ListContentImportSources

func NewListConversationsRequest

func NewListConversationsRequest(server string, params *ListConversationsParams) (*http.Request, error)

NewListConversationsRequest generates requests for ListConversations

func NewListEmailsRequest

func NewListEmailsRequest(server string, params *ListEmailsParams) (*http.Request, error)

NewListEmailsRequest generates requests for ListEmails

func NewListExternalPagesRequest

func NewListExternalPagesRequest(server string, params *ListExternalPagesParams) (*http.Request, error)

NewListExternalPagesRequest generates requests for ListExternalPages

func NewListHandlingEventsRequest

func NewListHandlingEventsRequest(server string, id string, params *ListHandlingEventsParams) (*http.Request, error)

NewListHandlingEventsRequest generates requests for ListHandlingEvents

func NewListHelpCentersRequest

func NewListHelpCentersRequest(server string, params *ListHelpCentersParams) (*http.Request, error)

NewListHelpCentersRequest generates requests for ListHelpCenters

func NewListInternalArticlesRequest

func NewListInternalArticlesRequest(server string, params *ListInternalArticlesParams) (*http.Request, error)

NewListInternalArticlesRequest generates requests for ListInternalArticles

func NewListLiveNewsfeedItemsRequest

func NewListLiveNewsfeedItemsRequest(server string, newsfeedId string, params *ListLiveNewsfeedItemsParams) (*http.Request, error)

NewListLiveNewsfeedItemsRequest generates requests for ListLiveNewsfeedItems

func NewListNewsItemsRequest

func NewListNewsItemsRequest(server string, params *ListNewsItemsParams) (*http.Request, error)

NewListNewsItemsRequest generates requests for ListNewsItems

func NewListNewsfeedsRequest

func NewListNewsfeedsRequest(server string, params *ListNewsfeedsParams) (*http.Request, error)

NewListNewsfeedsRequest generates requests for ListNewsfeeds

func NewListNotesRequest

func NewListNotesRequest(server string, contactId string, params *ListNotesParams) (*http.Request, error)

NewListNotesRequest generates requests for ListNotes

func NewListSegmentsForAContactRequest

func NewListSegmentsForAContactRequest(server string, contactId string, params *ListSegmentsForAContactParams) (*http.Request, error)

NewListSegmentsForAContactRequest generates requests for ListSegmentsForAContact

func NewListSegmentsRequest

func NewListSegmentsRequest(server string, params *ListSegmentsParams) (*http.Request, error)

NewListSegmentsRequest generates requests for ListSegments

func NewListSubscriptionTypesRequest

func NewListSubscriptionTypesRequest(server string, params *ListSubscriptionTypesParams) (*http.Request, error)

NewListSubscriptionTypesRequest generates requests for ListSubscriptionTypes

func NewListSubscriptionsForAContactRequest

func NewListSubscriptionsForAContactRequest(server string, contactId string, params *ListSubscriptionsForAContactParams) (*http.Request, error)

NewListSubscriptionsForAContactRequest generates requests for ListSubscriptionsForAContact

func NewListTagsForAContactRequest

func NewListTagsForAContactRequest(server string, contactId string, params *ListTagsForAContactParams) (*http.Request, error)

NewListTagsForAContactRequest generates requests for ListTagsForAContact

func NewListTagsRequest

func NewListTagsRequest(server string, params *ListTagsParams) (*http.Request, error)

NewListTagsRequest generates requests for ListTags

func NewListTeamsRequest

func NewListTeamsRequest(server string, params *ListTeamsParams) (*http.Request, error)

NewListTeamsRequest generates requests for ListTeams

func NewListTicketStatesRequest

func NewListTicketStatesRequest(server string, params *ListTicketStatesParams) (*http.Request, error)

NewListTicketStatesRequest generates requests for ListTicketStates

func NewListTicketTypesRequest

func NewListTicketTypesRequest(server string, params *ListTicketTypesParams) (*http.Request, error)

NewListTicketTypesRequest generates requests for ListTicketTypes

func NewManageConversationRequest

func NewManageConversationRequest(server string, conversationId string, params *ManageConversationParams, body ManageConversationJSONRequestBody) (*http.Request, error)

NewManageConversationRequest calls the generic ManageConversation builder with application/json body

func NewManageConversationRequestWithBody

func NewManageConversationRequestWithBody(server string, conversationId string, params *ManageConversationParams, contentType string, body io.Reader) (*http.Request, error)

NewManageConversationRequestWithBody generates requests for ManageConversation with any type of body

func NewMergeContactRequest

func NewMergeContactRequest(server string, params *MergeContactParams, body MergeContactJSONRequestBody) (*http.Request, error)

NewMergeContactRequest calls the generic MergeContact builder with application/json body

func NewMergeContactRequestWithBody

func NewMergeContactRequestWithBody(server string, params *MergeContactParams, contentType string, body io.Reader) (*http.Request, error)

NewMergeContactRequestWithBody generates requests for MergeContact with any type of body

func NewPostExportReportingDataEnqueueRequest

func NewPostExportReportingDataEnqueueRequest(server string, params *PostExportReportingDataEnqueueParams, body PostExportReportingDataEnqueueJSONRequestBody) (*http.Request, error)

NewPostExportReportingDataEnqueueRequest calls the generic PostExportReportingDataEnqueue builder with application/json body

func NewPostExportReportingDataEnqueueRequestWithBody

func NewPostExportReportingDataEnqueueRequestWithBody(server string, params *PostExportReportingDataEnqueueParams, contentType string, body io.Reader) (*http.Request, error)

NewPostExportReportingDataEnqueueRequestWithBody generates requests for PostExportReportingDataEnqueue with any type of body

func NewRedactConversationRequest

func NewRedactConversationRequest(server string, params *RedactConversationParams, body RedactConversationJSONRequestBody) (*http.Request, error)

NewRedactConversationRequest calls the generic RedactConversation builder with application/json body

func NewRedactConversationRequestWithBody

func NewRedactConversationRequestWithBody(server string, params *RedactConversationParams, contentType string, body io.Reader) (*http.Request, error)

NewRedactConversationRequestWithBody generates requests for RedactConversation with any type of body

func NewRegisterFinVoiceCallRequest

func NewRegisterFinVoiceCallRequest(server string, body RegisterFinVoiceCallJSONRequestBody) (*http.Request, error)

NewRegisterFinVoiceCallRequest calls the generic RegisterFinVoiceCall builder with application/json body

func NewRegisterFinVoiceCallRequestWithBody

func NewRegisterFinVoiceCallRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewRegisterFinVoiceCallRequestWithBody generates requests for RegisterFinVoiceCall with any type of body

func NewReplyConversationRequest

func NewReplyConversationRequest(server string, conversationId string, params *ReplyConversationParams, body ReplyConversationJSONRequestBody) (*http.Request, error)

NewReplyConversationRequest calls the generic ReplyConversation builder with application/json body

func NewReplyConversationRequestWithBody

func NewReplyConversationRequestWithBody(server string, conversationId string, params *ReplyConversationParams, contentType string, body io.Reader) (*http.Request, error)

NewReplyConversationRequestWithBody generates requests for ReplyConversation with any type of body

func NewReplyTicketRequest

func NewReplyTicketRequest(server string, ticketId string, params *ReplyTicketParams, body ReplyTicketJSONRequestBody) (*http.Request, error)

NewReplyTicketRequest calls the generic ReplyTicket builder with application/json body

func NewReplyTicketRequestWithBody

func NewReplyTicketRequestWithBody(server string, ticketId string, params *ReplyTicketParams, contentType string, body io.Reader) (*http.Request, error)

NewReplyTicketRequestWithBody generates requests for ReplyTicket with any type of body

func NewReplyToFinRequest

func NewReplyToFinRequest(server string, params *ReplyToFinParams, body ReplyToFinJSONRequestBody) (*http.Request, error)

NewReplyToFinRequest calls the generic ReplyToFin builder with application/json body

func NewReplyToFinRequestWithBody

func NewReplyToFinRequestWithBody(server string, params *ReplyToFinParams, contentType string, body io.Reader) (*http.Request, error)

NewReplyToFinRequestWithBody generates requests for ReplyToFin with any type of body

func NewRetrieveACompanyByIdRequest

func NewRetrieveACompanyByIdRequest(server string, companyId string, params *RetrieveACompanyByIdParams) (*http.Request, error)

NewRetrieveACompanyByIdRequest generates requests for RetrieveACompanyById

func NewRetrieveAdminRequest

func NewRetrieveAdminRequest(server string, adminId int, params *RetrieveAdminParams) (*http.Request, error)

NewRetrieveAdminRequest generates requests for RetrieveAdmin

func NewRetrieveArticleRequest

func NewRetrieveArticleRequest(server string, articleId int, params *RetrieveArticleParams) (*http.Request, error)

NewRetrieveArticleRequest generates requests for RetrieveArticle

func NewRetrieveBrandRequest

func NewRetrieveBrandRequest(server string, id string, params *RetrieveBrandParams) (*http.Request, error)

NewRetrieveBrandRequest generates requests for RetrieveBrand

func NewRetrieveCollectionRequest

func NewRetrieveCollectionRequest(server string, collectionId int, params *RetrieveCollectionParams) (*http.Request, error)

NewRetrieveCollectionRequest generates requests for RetrieveCollection

func NewRetrieveCompanyRequest

func NewRetrieveCompanyRequest(server string, params *RetrieveCompanyParams) (*http.Request, error)

NewRetrieveCompanyRequest generates requests for RetrieveCompany

func NewRetrieveConversationRequest

func NewRetrieveConversationRequest(server string, conversationId int, params *RetrieveConversationParams) (*http.Request, error)

NewRetrieveConversationRequest generates requests for RetrieveConversation

func NewRetrieveEmailRequest

func NewRetrieveEmailRequest(server string, id string, params *RetrieveEmailParams) (*http.Request, error)

NewRetrieveEmailRequest generates requests for RetrieveEmail

func NewRetrieveHelpCenterRequest

func NewRetrieveHelpCenterRequest(server string, helpCenterId int, params *RetrieveHelpCenterParams) (*http.Request, error)

NewRetrieveHelpCenterRequest generates requests for RetrieveHelpCenter

func NewRetrieveInternalArticleRequest

func NewRetrieveInternalArticleRequest(server string, internalArticleId int, params *RetrieveInternalArticleParams) (*http.Request, error)

NewRetrieveInternalArticleRequest generates requests for RetrieveInternalArticle

func NewRetrieveNewsItemRequest

func NewRetrieveNewsItemRequest(server string, newsItemId int, params *RetrieveNewsItemParams) (*http.Request, error)

NewRetrieveNewsItemRequest generates requests for RetrieveNewsItem

func NewRetrieveNewsfeedRequest

func NewRetrieveNewsfeedRequest(server string, newsfeedId string, params *RetrieveNewsfeedParams) (*http.Request, error)

NewRetrieveNewsfeedRequest generates requests for RetrieveNewsfeed

func NewRetrieveNoteRequest

func NewRetrieveNoteRequest(server string, noteId int, params *RetrieveNoteParams) (*http.Request, error)

NewRetrieveNoteRequest generates requests for RetrieveNote

func NewRetrieveSegmentRequest

func NewRetrieveSegmentRequest(server string, segmentId string, params *RetrieveSegmentParams) (*http.Request, error)

NewRetrieveSegmentRequest generates requests for RetrieveSegment

func NewRetrieveTeamRequest

func NewRetrieveTeamRequest(server string, teamId string, params *RetrieveTeamParams) (*http.Request, error)

NewRetrieveTeamRequest generates requests for RetrieveTeam

func NewRetrieveVisitorWithUserIdRequest

func NewRetrieveVisitorWithUserIdRequest(server string, params *RetrieveVisitorWithUserIdParams) (*http.Request, error)

NewRetrieveVisitorWithUserIdRequest generates requests for RetrieveVisitorWithUserId

func NewScrollOverAllCompaniesRequest

func NewScrollOverAllCompaniesRequest(server string, params *ScrollOverAllCompaniesParams) (*http.Request, error)

NewScrollOverAllCompaniesRequest generates requests for ScrollOverAllCompanies

func NewSearchArticlesRequest

func NewSearchArticlesRequest(server string, params *SearchArticlesParams) (*http.Request, error)

NewSearchArticlesRequest generates requests for SearchArticles

func NewSearchContactsRequest

func NewSearchContactsRequest(server string, params *SearchContactsParams, body SearchContactsJSONRequestBody) (*http.Request, error)

NewSearchContactsRequest calls the generic SearchContacts builder with application/json body

func NewSearchContactsRequestWithBody

func NewSearchContactsRequestWithBody(server string, params *SearchContactsParams, contentType string, body io.Reader) (*http.Request, error)

NewSearchContactsRequestWithBody generates requests for SearchContacts with any type of body

func NewSearchConversationsRequest

func NewSearchConversationsRequest(server string, params *SearchConversationsParams, body SearchConversationsJSONRequestBody) (*http.Request, error)

NewSearchConversationsRequest calls the generic SearchConversations builder with application/json body

func NewSearchConversationsRequestWithBody

func NewSearchConversationsRequestWithBody(server string, params *SearchConversationsParams, contentType string, body io.Reader) (*http.Request, error)

NewSearchConversationsRequestWithBody generates requests for SearchConversations with any type of body

func NewSearchInternalArticlesRequest

func NewSearchInternalArticlesRequest(server string, params *SearchInternalArticlesParams) (*http.Request, error)

NewSearchInternalArticlesRequest generates requests for SearchInternalArticles

func NewSearchTicketsRequest

func NewSearchTicketsRequest(server string, params *SearchTicketsParams, body SearchTicketsJSONRequestBody) (*http.Request, error)

NewSearchTicketsRequest calls the generic SearchTickets builder with application/json body

func NewSearchTicketsRequestWithBody

func NewSearchTicketsRequestWithBody(server string, params *SearchTicketsParams, contentType string, body io.Reader) (*http.Request, error)

NewSearchTicketsRequestWithBody generates requests for SearchTickets with any type of body

func NewSetAwayAdminRequest

func NewSetAwayAdminRequest(server string, adminId int, params *SetAwayAdminParams, body SetAwayAdminJSONRequestBody) (*http.Request, error)

NewSetAwayAdminRequest calls the generic SetAwayAdmin builder with application/json body

func NewSetAwayAdminRequestWithBody

func NewSetAwayAdminRequestWithBody(server string, adminId int, params *SetAwayAdminParams, contentType string, body io.Reader) (*http.Request, error)

NewSetAwayAdminRequestWithBody generates requests for SetAwayAdmin with any type of body

func NewShowCallRecordingRequest

func NewShowCallRecordingRequest(server string, callId string, params *ShowCallRecordingParams) (*http.Request, error)

NewShowCallRecordingRequest generates requests for ShowCallRecording

func NewShowCallRequest

func NewShowCallRequest(server string, callId string, params *ShowCallParams) (*http.Request, error)

NewShowCallRequest generates requests for ShowCall

func NewShowCallTranscriptRequest

func NewShowCallTranscriptRequest(server string, callId string, params *ShowCallTranscriptParams) (*http.Request, error)

NewShowCallTranscriptRequest generates requests for ShowCallTranscript

func NewShowContactByExternalIdRequest

func NewShowContactByExternalIdRequest(server string, externalId string, params *ShowContactByExternalIdParams) (*http.Request, error)

NewShowContactByExternalIdRequest generates requests for ShowContactByExternalId

func NewShowContactRequest

func NewShowContactRequest(server string, contactId string, params *ShowContactParams) (*http.Request, error)

NewShowContactRequest generates requests for ShowContact

func NewStartFinConversationRequest

func NewStartFinConversationRequest(server string, params *StartFinConversationParams, body StartFinConversationJSONRequestBody) (*http.Request, error)

NewStartFinConversationRequest calls the generic StartFinConversation builder with application/json body

func NewStartFinConversationRequestWithBody

func NewStartFinConversationRequestWithBody(server string, params *StartFinConversationParams, contentType string, body io.Reader) (*http.Request, error)

NewStartFinConversationRequestWithBody generates requests for StartFinConversation with any type of body

func NewUnarchiveContactRequest

func NewUnarchiveContactRequest(server string, contactId string, params *UnarchiveContactParams) (*http.Request, error)

NewUnarchiveContactRequest generates requests for UnarchiveContact

func NewUpdateArticleRequest

func NewUpdateArticleRequest(server string, articleId int, params *UpdateArticleParams, body UpdateArticleJSONRequestBody) (*http.Request, error)

NewUpdateArticleRequest calls the generic UpdateArticle builder with application/json body

func NewUpdateArticleRequestWithBody

func NewUpdateArticleRequestWithBody(server string, articleId int, params *UpdateArticleParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateArticleRequestWithBody generates requests for UpdateArticle with any type of body

func NewUpdateCollectionRequest

func NewUpdateCollectionRequest(server string, collectionId int, params *UpdateCollectionParams, body UpdateCollectionJSONRequestBody) (*http.Request, error)

NewUpdateCollectionRequest calls the generic UpdateCollection builder with application/json body

func NewUpdateCollectionRequestWithBody

func NewUpdateCollectionRequestWithBody(server string, collectionId int, params *UpdateCollectionParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateCollectionRequestWithBody generates requests for UpdateCollection with any type of body

func NewUpdateCompanyRequest

func NewUpdateCompanyRequest(server string, companyId string, params *UpdateCompanyParams, body UpdateCompanyJSONRequestBody) (*http.Request, error)

NewUpdateCompanyRequest calls the generic UpdateCompany builder with application/json body

func NewUpdateCompanyRequestWithBody

func NewUpdateCompanyRequestWithBody(server string, companyId string, params *UpdateCompanyParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateCompanyRequestWithBody generates requests for UpdateCompany with any type of body

func NewUpdateContactRequest

func NewUpdateContactRequest(server string, contactId string, params *UpdateContactParams, body UpdateContactJSONRequestBody) (*http.Request, error)

NewUpdateContactRequest calls the generic UpdateContact builder with application/json body

func NewUpdateContactRequestWithBody

func NewUpdateContactRequestWithBody(server string, contactId string, params *UpdateContactParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateContactRequestWithBody generates requests for UpdateContact with any type of body

func NewUpdateContentImportSourceRequest

func NewUpdateContentImportSourceRequest(server string, sourceId string, params *UpdateContentImportSourceParams, body UpdateContentImportSourceJSONRequestBody) (*http.Request, error)

NewUpdateContentImportSourceRequest calls the generic UpdateContentImportSource builder with application/json body

func NewUpdateContentImportSourceRequestWithBody

func NewUpdateContentImportSourceRequestWithBody(server string, sourceId string, params *UpdateContentImportSourceParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateContentImportSourceRequestWithBody generates requests for UpdateContentImportSource with any type of body

func NewUpdateConversationRequest

func NewUpdateConversationRequest(server string, conversationId int, params *UpdateConversationParams, body UpdateConversationJSONRequestBody) (*http.Request, error)

NewUpdateConversationRequest calls the generic UpdateConversation builder with application/json body

func NewUpdateConversationRequestWithBody

func NewUpdateConversationRequestWithBody(server string, conversationId int, params *UpdateConversationParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateConversationRequestWithBody generates requests for UpdateConversation with any type of body

func NewUpdateDataAttributeRequest

func NewUpdateDataAttributeRequest(server string, dataAttributeId int, params *UpdateDataAttributeParams, body UpdateDataAttributeJSONRequestBody) (*http.Request, error)

NewUpdateDataAttributeRequest calls the generic UpdateDataAttribute builder with application/json body

func NewUpdateDataAttributeRequestWithBody

func NewUpdateDataAttributeRequestWithBody(server string, dataAttributeId int, params *UpdateDataAttributeParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateDataAttributeRequestWithBody generates requests for UpdateDataAttribute with any type of body

func NewUpdateExternalPageRequest

func NewUpdateExternalPageRequest(server string, pageId string, params *UpdateExternalPageParams, body UpdateExternalPageJSONRequestBody) (*http.Request, error)

NewUpdateExternalPageRequest calls the generic UpdateExternalPage builder with application/json body

func NewUpdateExternalPageRequestWithBody

func NewUpdateExternalPageRequestWithBody(server string, pageId string, params *UpdateExternalPageParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateExternalPageRequestWithBody generates requests for UpdateExternalPage with any type of body

func NewUpdateInternalArticleRequest

func NewUpdateInternalArticleRequest(server string, internalArticleId int, params *UpdateInternalArticleParams, body UpdateInternalArticleJSONRequestBody) (*http.Request, error)

NewUpdateInternalArticleRequest calls the generic UpdateInternalArticle builder with application/json body

func NewUpdateInternalArticleRequestWithBody

func NewUpdateInternalArticleRequestWithBody(server string, internalArticleId int, params *UpdateInternalArticleParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateInternalArticleRequestWithBody generates requests for UpdateInternalArticle with any type of body

func NewUpdateIpAllowlistRequest

func NewUpdateIpAllowlistRequest(server string, params *UpdateIpAllowlistParams, body UpdateIpAllowlistJSONRequestBody) (*http.Request, error)

NewUpdateIpAllowlistRequest calls the generic UpdateIpAllowlist builder with application/json body

func NewUpdateIpAllowlistRequestWithBody

func NewUpdateIpAllowlistRequestWithBody(server string, params *UpdateIpAllowlistParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateIpAllowlistRequestWithBody generates requests for UpdateIpAllowlist with any type of body

func NewUpdateNewsItemRequest

func NewUpdateNewsItemRequest(server string, newsItemId int, params *UpdateNewsItemParams, body UpdateNewsItemJSONRequestBody) (*http.Request, error)

NewUpdateNewsItemRequest calls the generic UpdateNewsItem builder with application/json body

func NewUpdateNewsItemRequestWithBody

func NewUpdateNewsItemRequestWithBody(server string, newsItemId int, params *UpdateNewsItemParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateNewsItemRequestWithBody generates requests for UpdateNewsItem with any type of body

func NewUpdateTicketRequest

func NewUpdateTicketRequest(server string, ticketId string, params *UpdateTicketParams, body UpdateTicketJSONRequestBody) (*http.Request, error)

NewUpdateTicketRequest calls the generic UpdateTicket builder with application/json body

func NewUpdateTicketRequestWithBody

func NewUpdateTicketRequestWithBody(server string, ticketId string, params *UpdateTicketParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateTicketRequestWithBody generates requests for UpdateTicket with any type of body

func NewUpdateTicketTypeAttributeRequest

func NewUpdateTicketTypeAttributeRequest(server string, ticketTypeId string, attributeId string, params *UpdateTicketTypeAttributeParams, body UpdateTicketTypeAttributeJSONRequestBody) (*http.Request, error)

NewUpdateTicketTypeAttributeRequest calls the generic UpdateTicketTypeAttribute builder with application/json body

func NewUpdateTicketTypeAttributeRequestWithBody

func NewUpdateTicketTypeAttributeRequestWithBody(server string, ticketTypeId string, attributeId string, params *UpdateTicketTypeAttributeParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateTicketTypeAttributeRequestWithBody generates requests for UpdateTicketTypeAttribute with any type of body

func NewUpdateTicketTypeRequest

func NewUpdateTicketTypeRequest(server string, ticketTypeId string, params *UpdateTicketTypeParams, body UpdateTicketTypeJSONRequestBody) (*http.Request, error)

NewUpdateTicketTypeRequest calls the generic UpdateTicketType builder with application/json body

func NewUpdateTicketTypeRequestWithBody

func NewUpdateTicketTypeRequestWithBody(server string, ticketTypeId string, params *UpdateTicketTypeParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateTicketTypeRequestWithBody generates requests for UpdateTicketType with any type of body

func NewUpdateVisitorRequest

func NewUpdateVisitorRequest(server string, params *UpdateVisitorParams, body UpdateVisitorJSONRequestBody) (*http.Request, error)

NewUpdateVisitorRequest calls the generic UpdateVisitor builder with application/json body

func NewUpdateVisitorRequestWithBody

func NewUpdateVisitorRequestWithBody(server string, params *UpdateVisitorParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateVisitorRequestWithBody generates requests for UpdateVisitor with any type of body

Types

type ActivityLogActivityType

type ActivityLogActivityType string

ActivityLogActivityType defines model for ActivityLog.ActivityType.

const (
	AdminAwayModeChange                      ActivityLogActivityType = "admin_away_mode_change"
	AdminConversationAssignmentLimitChange   ActivityLogActivityType = "admin_conversation_assignment_limit_change"
	AdminDeletion                            ActivityLogActivityType = "admin_deletion"
	AdminDeprovisioned                       ActivityLogActivityType = "admin_deprovisioned"
	AdminImpersonationConsentApproved        ActivityLogActivityType = "admin_impersonation_consent_approved"
	AdminImpersonationConsentRevoked         ActivityLogActivityType = "admin_impersonation_consent_revoked"
	AdminImpersonationEnd                    ActivityLogActivityType = "admin_impersonation_end"
	AdminImpersonationStart                  ActivityLogActivityType = "admin_impersonation_start"
	AdminInviteChange                        ActivityLogActivityType = "admin_invite_change"
	AdminInviteCreation                      ActivityLogActivityType = "admin_invite_creation"
	AdminInviteDeletion                      ActivityLogActivityType = "admin_invite_deletion"
	AdminLoginFailure                        ActivityLogActivityType = "admin_login_failure"
	AdminLoginSuccess                        ActivityLogActivityType = "admin_login_success"
	AdminLogout                              ActivityLogActivityType = "admin_logout"
	AdminPasswordResetRequest                ActivityLogActivityType = "admin_password_reset_request"
	AdminPasswordResetSuccess                ActivityLogActivityType = "admin_password_reset_success"
	AdminPermissionChange                    ActivityLogActivityType = "admin_permission_change"
	AdminProvisioned                         ActivityLogActivityType = "admin_provisioned"
	AdminTicketAssignmentLimitChange         ActivityLogActivityType = "admin_ticket_assignment_limit_change"
	AdminTwoFactorAuthChange                 ActivityLogActivityType = "admin_two_factor_auth_change"
	AdminUnauthorizedSignInMethod            ActivityLogActivityType = "admin_unauthorized_sign_in_method"
	AllowedAttachmentFiletypesSettingChange  ActivityLogActivityType = "allowed_attachment_filetypes_setting_change"
	AppAdminJoin                             ActivityLogActivityType = "app_admin_join"
	AppAuthenticationMethodChange            ActivityLogActivityType = "app_authentication_method_change"
	AppDataDeletion                          ActivityLogActivityType = "app_data_deletion"
	AppDataExport                            ActivityLogActivityType = "app_data_export"
	AppGoogleSsoDomainChange                 ActivityLogActivityType = "app_google_sso_domain_change"
	AppIdentityVerificationChange            ActivityLogActivityType = "app_identity_verification_change"
	AppNameChange                            ActivityLogActivityType = "app_name_change"
	AppOutboundAddressChange                 ActivityLogActivityType = "app_outbound_address_change"
	AppPackageInstallation                   ActivityLogActivityType = "app_package_installation"
	AppPackageTokenRegeneration              ActivityLogActivityType = "app_package_token_regeneration"
	AppPackageUninstallation                 ActivityLogActivityType = "app_package_uninstallation"
	AppTeamCreation                          ActivityLogActivityType = "app_team_creation"
	AppTeamDeletion                          ActivityLogActivityType = "app_team_deletion"
	AppTeamMembershipModification            ActivityLogActivityType = "app_team_membership_modification"
	AppTimezoneChange                        ActivityLogActivityType = "app_timezone_change"
	AppWebhookCreation                       ActivityLogActivityType = "app_webhook_creation"
	AppWebhookDeletion                       ActivityLogActivityType = "app_webhook_deletion"
	ArticlesInMessengerEnabledChange         ActivityLogActivityType = "articles_in_messenger_enabled_change"
	AttachUploadsInlineSettingChange         ActivityLogActivityType = "attach_uploads_inline_setting_change"
	AutomaticAwayModeSettingChange           ActivityLogActivityType = "automatic_away_mode_setting_change"
	BulkDelete                               ActivityLogActivityType = "bulk_delete"
	BulkExport                               ActivityLogActivityType = "bulk_export"
	CampaignDeletion                         ActivityLogActivityType = "campaign_deletion"
	CampaignStateChange                      ActivityLogActivityType = "campaign_state_change"
	ContentRedactionRuleCreation             ActivityLogActivityType = "content_redaction_rule_creation"
	ContentRedactionRuleDeletion             ActivityLogActivityType = "content_redaction_rule_deletion"
	ContentRedactionRuleUpdate               ActivityLogActivityType = "content_redaction_rule_update"
	ConversationDeletionScheduleCreation     ActivityLogActivityType = "conversation_deletion_schedule_creation"
	ConversationDeletionScheduleDeletion     ActivityLogActivityType = "conversation_deletion_schedule_deletion"
	ConversationDeletionScheduleStateChange  ActivityLogActivityType = "conversation_deletion_schedule_state_change"
	ConversationDeletionScheduleUpdate       ActivityLogActivityType = "conversation_deletion_schedule_update"
	ConversationPartDeletion                 ActivityLogActivityType = "conversation_part_deletion"
	ConversationTopicChange                  ActivityLogActivityType = "conversation_topic_change"
	ConversationTopicCreation                ActivityLogActivityType = "conversation_topic_creation"
	ConversationTopicDeletion                ActivityLogActivityType = "conversation_topic_deletion"
	CsvImportCompletion                      ActivityLogActivityType = "csv_import_completion"
	CsvImportCreation                        ActivityLogActivityType = "csv_import_creation"
	CustomAuthenticationTokenCreation        ActivityLogActivityType = "custom_authentication_token_creation"
	HelpCenterSettingsChange                 ActivityLogActivityType = "help_center_settings_change"
	HideCsatFromAgentsSettingChange          ActivityLogActivityType = "hide_csat_from_agents_setting_change"
	InboundConversationsChange               ActivityLogActivityType = "inbound_conversations_change"
	InboxAccessChange                        ActivityLogActivityType = "inbox_access_change"
	MacroCreation                            ActivityLogActivityType = "macro_creation"
	MacroDeletion                            ActivityLogActivityType = "macro_deletion"
	MacroUpdate                              ActivityLogActivityType = "macro_update"
	MaliciousDomainsSettingChange            ActivityLogActivityType = "malicious_domains_setting_change"
	MessageDeletion                          ActivityLogActivityType = "message_deletion"
	MessageStateChange                       ActivityLogActivityType = "message_state_change"
	MessengerApiSecretCreation               ActivityLogActivityType = "messenger_api_secret_creation"
	MessengerApiSecretDeletion               ActivityLogActivityType = "messenger_api_secret_deletion"
	MessengerLookAndFeelChange               ActivityLogActivityType = "messenger_look_and_feel_change"
	MessengerSearchRequiredChange            ActivityLogActivityType = "messenger_search_required_change"
	MessengerSpacesChange                    ActivityLogActivityType = "messenger_spaces_change"
	OauthTokenRevocation                     ActivityLogActivityType = "oauth_token_revocation"
	OfficeHoursChange                        ActivityLogActivityType = "office_hours_change"
	RoleChange                               ActivityLogActivityType = "role_change"
	RoleCreation                             ActivityLogActivityType = "role_creation"
	RoleDeletion                             ActivityLogActivityType = "role_deletion"
	RulesetActivationTitlePreview            ActivityLogActivityType = "ruleset_activation_title_preview"
	RulesetCreation                          ActivityLogActivityType = "ruleset_creation"
	RulesetDeletion                          ActivityLogActivityType = "ruleset_deletion"
	SearchBrowseEnabledChange                ActivityLogActivityType = "search_browse_enabled_change"
	SearchBrowseRequiredChange               ActivityLogActivityType = "search_browse_required_change"
	SeatChange                               ActivityLogActivityType = "seat_change"
	SeatRevoke                               ActivityLogActivityType = "seat_revoke"
	SecuritySettingsChange                   ActivityLogActivityType = "security_settings_change"
	SeriesCreation                           ActivityLogActivityType = "series_creation"
	SeriesDeletion                           ActivityLogActivityType = "series_deletion"
	SeriesSettingsUpdate                     ActivityLogActivityType = "series_settings_update"
	SeriesStatusChange                       ActivityLogActivityType = "series_status_change"
	SeriesUpdate                             ActivityLogActivityType = "series_update"
	StripInboundEmailLinksChange             ActivityLogActivityType = "strip_inbound_email_links_change"
	TeamAssignmentLimitChange                ActivityLogActivityType = "team_assignment_limit_change"
	TeammateGifsSettingChange                ActivityLogActivityType = "teammate_gifs_setting_change"
	TemporaryExpectationChange               ActivityLogActivityType = "temporary_expectation_change"
	TrustedDomainsSettingChange              ActivityLogActivityType = "trusted_domains_setting_change"
	UnassignUnsnoozedAtCapacitySettingChange ActivityLogActivityType = "unassign_unsnoozed_at_capacity_setting_change"
	UnassignUnsnoozedWhenAwaySettingChange   ActivityLogActivityType = "unassign_unsnoozed_when_away_setting_change"
	UpfrontEmailCollectionChange             ActivityLogActivityType = "upfront_email_collection_change"
	UserCameraAttachmentsSettingChange       ActivityLogActivityType = "user_camera_attachments_setting_change"
	UserConversationAttachmentsSettingChange ActivityLogActivityType = "user_conversation_attachments_setting_change"
	UserFileAttachmentsSettingChange         ActivityLogActivityType = "user_file_attachments_setting_change"
	UserGifsSettingChange                    ActivityLogActivityType = "user_gifs_setting_change"
	UserMediaAttachmentsSettingChange        ActivityLogActivityType = "user_media_attachments_setting_change"
	UserVoiceNotesSettingChange              ActivityLogActivityType = "user_voice_notes_setting_change"
	WelcomeMessageChange                     ActivityLogActivityType = "welcome_message_change"
	WorkspaceDeletionRequest                 ActivityLogActivityType = "workspace_deletion_request"
)

Defines values for ActivityLogActivityType.

func (ActivityLogActivityType) Valid

func (e ActivityLogActivityType) Valid() bool

Valid indicates whether the value is a known member of the ActivityLogActivityType enum.

type ActivityLogListSchema

type ActivityLogListSchema struct {
	// ActivityLogs An array of activity logs
	ActivityLogs *[]*ActivityLogSchema `json:"activity_logs,omitempty"`
	Pages        *CursorPagesSchema    `json:"pages,omitempty"`

	// Type String representing the object's type. Always has the value `activity_log.list`.
	Type *string `json:"type,omitempty"`
}

ActivityLogListSchema A paginated list of activity logs.

type ActivityLogMetadataSchema

type ActivityLogMetadataSchema struct {
	// After The state of settings or values after the change. Structure varies by activity type.
	After *map[string]interface{} `json:"after,omitempty"`

	// AutoChanged Indicates if the status was changed automatically or manually.
	AutoChanged *string `json:"auto_changed,omitempty"`

	// AwayMode The away mode status which is set to true when away and false when returned.
	AwayMode *bool `json:"away_mode,omitempty"`

	// AwayStatusReason The reason the Admin is away.
	AwayStatusReason *string `json:"away_status_reason,omitempty"`

	// Before The state of settings or values before the change. Structure varies by activity type.
	Before *map[string]interface{} `json:"before,omitempty"`

	// ConsentId The ID of the impersonation consent.
	ConsentId *int `json:"consent_id,omitempty"`

	// ConversationAssignmentLimit The conversation assignment limit value for an admin.
	ConversationAssignmentLimit *int `json:"conversation_assignment_limit,omitempty"`

	// Enabled Indicates if the setting is enabled or disabled.
	Enabled *bool `json:"enabled,omitempty"`

	// ExpiredAt The timestamp when the impersonation consent expires.
	ExpiredAt *time.Time `json:"expired_at,omitempty"`

	// ExternalId The unique identifier for the contact which is provided by the Client.
	ExternalId *string `json:"external_id,omitempty"`

	// Mode The mode of the setting (e.g., when_away_only, when_away_and_reassign).
	Mode *string `json:"mode,omitempty"`

	// ReassignConversations Indicates if conversations should be reassigned while an Admin is away.
	ReassignConversations *bool `json:"reassign_conversations,omitempty"`

	// SignInMethod The way the admin signed in.
	SignInMethod *string `json:"sign_in_method,omitempty"`

	// Source The action that initiated the status change.
	Source *string `json:"source,omitempty"`

	// Team Details about the team whose assignment limit was changed.
	Team *struct {
		// Id The ID of the team.
		Id *int `json:"id,omitempty"`

		// Name The name of the team.
		Name *string `json:"name,omitempty"`
	} `json:"team,omitempty"`

	// TeamAssignmentLimit The team assignment limit value (null if limit was removed).
	TeamAssignmentLimit *int `json:"team_assignment_limit,omitempty"`

	// TicketAssignmentLimit The ticket assignment limit value for an admin.
	TicketAssignmentLimit *int `json:"ticket_assignment_limit,omitempty"`

	// UpdateBy The ID of the Admin who initiated the activity.
	UpdateBy *int `json:"update_by,omitempty"`

	// UpdateByName The name of the Admin who initiated the activity.
	UpdateByName *string `json:"update_by_name,omitempty"`
}

ActivityLogMetadataSchema Additional data provided about Admin activity.

type ActivityLogSchema

type ActivityLogSchema struct {
	// ActivityDescription A sentence or two describing the activity.
	ActivityDescription *string                  `json:"activity_description,omitempty"`
	ActivityType        *ActivityLogActivityType `json:"activity_type,omitempty"`

	// CreatedAt The time the activity was created.
	CreatedAt *int `json:"created_at,omitempty"`

	// Id The id representing the activity.
	Id       *string                    `json:"id,omitempty"`
	Metadata *ActivityLogMetadataSchema `json:"metadata,omitempty"`

	// PerformedBy Details about the Admin involved in the activity.
	PerformedBy *struct {
		// Email The email of the admin.
		Email *string `json:"email,omitempty"`

		// Id The id representing the admin.
		Id *string `json:"id,omitempty"`

		// Ip The IP address of the admin.
		Ip *string `json:"ip,omitempty"`

		// Type String representing the object's type. Always has the value `admin`.
		Type *string `json:"type,omitempty"`
	} `json:"performed_by,omitempty"`
}

ActivityLogSchema Activities performed by Admins.

type AddressableListSchema

type AddressableListSchema struct {
	// Id The id of the addressable object
	Id *string `json:"id,omitempty"`

	// Type The addressable object type
	Type *string `json:"type,omitempty"`

	// Url Url to get more company resources for this contact
	Url *string `json:"url,omitempty"`
}

AddressableListSchema A list used to access other resources from a parent model.

type AdminListSchema

type AdminListSchema struct {
	// Admins A list of admins associated with a given workspace.
	Admins *[]*AdminSchema `json:"admins,omitempty"`

	// Type String representing the object's type. Always has the value `admin.list`.
	Type *string `json:"type,omitempty"`
}

AdminListSchema A list of admins associated with a given workspace.

type AdminPriorityLevelSchema

type AdminPriorityLevelSchema struct {
	// PrimaryAdminIds The primary admin ids for the team
	PrimaryAdminIds *[]int `json:"primary_admin_ids,omitempty"`

	// SecondaryAdminIds The secondary admin ids for the team
	SecondaryAdminIds *[]int `json:"secondary_admin_ids,omitempty"`
}

AdminPriorityLevelSchema Admin priority levels for the team

type AdminReplyConversationRequestMessageType

type AdminReplyConversationRequestMessageType string

AdminReplyConversationRequestMessageType defines model for AdminReplyConversationRequest.MessageType.

const (
	AdminReplyConversationRequestMessageTypeComment    AdminReplyConversationRequestMessageType = "comment"
	AdminReplyConversationRequestMessageTypeNote       AdminReplyConversationRequestMessageType = "note"
	AdminReplyConversationRequestMessageTypeQuickReply AdminReplyConversationRequestMessageType = "quick_reply"
)

Defines values for AdminReplyConversationRequestMessageType.

func (AdminReplyConversationRequestMessageType) Valid

Valid indicates whether the value is a known member of the AdminReplyConversationRequestMessageType enum.

type AdminReplyConversationRequestSchema

type AdminReplyConversationRequestSchema struct {
	// AdminId The id of the admin who is authoring the comment.
	AdminId string `json:"admin_id"`

	// AttachmentFiles A list of files that will be added as attachments. You can include up to 10 files
	AttachmentFiles *[]ConversationAttachmentFilesSchema `json:"attachment_files,omitempty"`

	// AttachmentUrls A list of image URLs that will be added as attachments. You can include up to 10 URLs.
	AttachmentUrls *[]string `json:"attachment_urls,omitempty"`

	// Body The text body of the reply. Notes accept some HTML formatting. Must be present for comment and note message types.
	Body *string `json:"body,omitempty"`

	// CreatedAt The time the reply was created. If not provided, the current time will be used.
	CreatedAt   *int                                     `json:"created_at,omitempty"`
	MessageType AdminReplyConversationRequestMessageType `json:"message_type"`

	// ReplyOptions The quick reply options to display to the end user. Must be present for quick_reply message types.
	ReplyOptions *[]QuickReplyOptionSchema `json:"reply_options,omitempty"`

	// SkipNotifications Option to disable notifications when replying to a conversation.
	SkipNotifications *bool                             `json:"skip_notifications,omitempty"`
	Type              AdminReplyConversationRequestType `json:"type"`
}

AdminReplyConversationRequestSchema Payload of the request to reply on behalf of an admin

type AdminReplyConversationRequestType

type AdminReplyConversationRequestType string

AdminReplyConversationRequestType defines model for AdminReplyConversationRequest.Type.

const (
	AdminReplyConversationRequestTypeAdmin AdminReplyConversationRequestType = "admin"
)

Defines values for AdminReplyConversationRequestType.

func (AdminReplyConversationRequestType) Valid

Valid indicates whether the value is a known member of the AdminReplyConversationRequestType enum.

type AdminReplyTicketRequestMessageType

type AdminReplyTicketRequestMessageType string

AdminReplyTicketRequestMessageType defines model for AdminReplyTicketRequest.MessageType.

const (
	AdminReplyTicketRequestMessageTypeComment    AdminReplyTicketRequestMessageType = "comment"
	AdminReplyTicketRequestMessageTypeNote       AdminReplyTicketRequestMessageType = "note"
	AdminReplyTicketRequestMessageTypeQuickReply AdminReplyTicketRequestMessageType = "quick_reply"
)

Defines values for AdminReplyTicketRequestMessageType.

func (AdminReplyTicketRequestMessageType) Valid

Valid indicates whether the value is a known member of the AdminReplyTicketRequestMessageType enum.

type AdminReplyTicketRequestSchema

type AdminReplyTicketRequestSchema struct {
	// AdminId The id of the admin who is authoring the comment.
	AdminId string `json:"admin_id"`

	// AttachmentUrls A list of image URLs that will be added as attachments. You can include up to 10 URLs.
	AttachmentUrls *[]string `json:"attachment_urls,omitempty"`

	// Body The text body of the reply. Notes accept some HTML formatting. Must be present for comment and note message types.
	Body *string `json:"body,omitempty"`

	// CreatedAt The time the reply was created. If not provided, the current time will be used.
	CreatedAt *int `json:"created_at,omitempty"`

	// CrossPost If set to true, the note will be cross-posted to all linked conversations. Only applicable to note message types on back-office tickets.
	CrossPost   *bool                              `json:"cross_post,omitempty"`
	MessageType AdminReplyTicketRequestMessageType `json:"message_type"`

	// ReplyOptions The quick reply options to display. Must be present for quick_reply message types.
	ReplyOptions *[]struct {
		// Text The text to display in this quick reply option.
		Text string `json:"text"`

		// Uuid A unique identifier for this quick reply option. This value will be available within the metadata of the comment ticket part that is created when a user clicks on this reply option.
		Uuid openapi_types.UUID `json:"uuid"`
	} `json:"reply_options,omitempty"`
	Type AdminReplyTicketRequestType `json:"type"`
}

AdminReplyTicketRequestSchema Payload of the request to reply on behalf of an admin

type AdminReplyTicketRequestType

type AdminReplyTicketRequestType string

AdminReplyTicketRequestType defines model for AdminReplyTicketRequest.Type.

const (
	AdminReplyTicketRequestTypeAdmin AdminReplyTicketRequestType = "admin"
)

Defines values for AdminReplyTicketRequestType.

func (AdminReplyTicketRequestType) Valid

Valid indicates whether the value is a known member of the AdminReplyTicketRequestType enum.

type AdminSchema

type AdminSchema struct {
	// Avatar Image for the associated team or teammate
	Avatar *string `json:"avatar,omitempty"`

	// AwayModeEnabled Identifies if this admin is currently set in away mode.
	AwayModeEnabled *bool `json:"away_mode_enabled,omitempty"`

	// AwayModeReassign Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.
	AwayModeReassign *bool `json:"away_mode_reassign,omitempty"`

	// AwayStatusReasonId The unique identifier of the away status reason
	AwayStatusReasonId *int `json:"away_status_reason_id,omitempty"`

	// Email The email of the admin.
	Email *string `json:"email,omitempty"`

	// HasInboxSeat Identifies if this admin has a paid inbox seat to restrict/allow features that require them.
	HasInboxSeat *bool `json:"has_inbox_seat,omitempty"`

	// Id The id representing the admin.
	Id *string `json:"id,omitempty"`

	// JobTitle The job title of the admin.
	JobTitle *string `json:"job_title,omitempty"`

	// Name The name of the admin.
	Name *string `json:"name,omitempty"`

	// TeamIds This object represents the avatar associated with the admin.
	TeamIds           *[]int                   `json:"team_ids,omitempty"`
	TeamPriorityLevel *TeamPriorityLevelSchema `json:"team_priority_level,omitempty"`

	// Type String representing the object's type. Always has the value `admin`.
	Type *string `json:"type,omitempty"`
}

AdminSchema Admins are teammate accounts that have access to a workspace.

type AdminWithAppSchema

type AdminWithAppSchema struct {
	// App App that the admin belongs to.
	App *AppSchema `json:"app,omitempty"`

	// Avatar This object represents the avatar associated with the admin.
	Avatar *struct {
		// ImageUrl This object represents the avatar associated with the admin.
		ImageUrl *string `json:"image_url,omitempty"`

		// Type This is a string that identifies the type of the object. It will always have the value `avatar`.
		Type *string `json:"type,omitempty"`
	} `json:"avatar,omitempty"`

	// AwayModeEnabled Identifies if this admin is currently set in away mode.
	AwayModeEnabled *bool `json:"away_mode_enabled,omitempty"`

	// AwayModeReassign Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.
	AwayModeReassign *bool `json:"away_mode_reassign,omitempty"`

	// Email The email of the admin.
	Email *string `json:"email,omitempty"`

	// EmailVerified Identifies if this admin's email is verified.
	EmailVerified *bool `json:"email_verified,omitempty"`

	// HasInboxSeat Identifies if this admin has a paid inbox seat to restrict/allow features that require them.
	HasInboxSeat *bool `json:"has_inbox_seat,omitempty"`

	// Id The id representing the admin.
	Id *string `json:"id,omitempty"`

	// JobTitle The job title of the admin.
	JobTitle *string `json:"job_title,omitempty"`

	// Name The name of the admin.
	Name *string `json:"name,omitempty"`

	// TeamIds This is a list of ids of the teams that this admin is part of.
	TeamIds *[]int `json:"team_ids,omitempty"`

	// Type String representing the object's type. Always has the value `admin`.
	Type *string `json:"type,omitempty"`
}

AdminWithAppSchema Admins are the teammate accounts that have access to a workspace

type AiAgentLastAnswerType

type AiAgentLastAnswerType string

AiAgentLastAnswerType The type of the last answer delivered by AI Agent. If no answer was delivered then this will return `null`

const (
	AiAgentLastAnswerTypeAiAnswer     AiAgentLastAnswerType = "ai_answer"
	AiAgentLastAnswerTypeCustomAnswer AiAgentLastAnswerType = "custom_answer"
	AiAgentLastAnswerTypeLessThannil  AiAgentLastAnswerType = "<nil>"
)

Defines values for AiAgentLastAnswerType.

func (AiAgentLastAnswerType) Valid

func (e AiAgentLastAnswerType) Valid() bool

Valid indicates whether the value is a known member of the AiAgentLastAnswerType enum.

type AiAgentResolutionState

type AiAgentResolutionState string

AiAgentResolutionState The resolution state of AI Agent. If no AI or custom answer has been delivered then this will return `null`.

const (
	AiAgentResolutionStateAssumedResolution   AiAgentResolutionState = "assumed_resolution"
	AiAgentResolutionStateConfirmedResolution AiAgentResolutionState = "confirmed_resolution"
	AiAgentResolutionStateEscalated           AiAgentResolutionState = "escalated"
	AiAgentResolutionStateLessThannil         AiAgentResolutionState = "<nil>"
	AiAgentResolutionStateNegativeFeedback    AiAgentResolutionState = "negative_feedback"
	AiAgentResolutionStateProcedureHandoff    AiAgentResolutionState = "procedure_handoff"
)

Defines values for AiAgentResolutionState.

func (AiAgentResolutionState) Valid

func (e AiAgentResolutionState) Valid() bool

Valid indicates whether the value is a known member of the AiAgentResolutionState enum.

type AiAgentSchema

type AiAgentSchema struct {
	ContentSources *ContentSourcesList `json:"content_sources,omitempty"`

	// CreatedAt The time when the AI agent rating was created.
	CreatedAt *int `json:"created_at,omitempty"`

	// LastAnswerType The type of the last answer delivered by AI Agent. If no answer was delivered then this will return `null`
	LastAnswerType *AiAgentLastAnswerType `json:"last_answer_type,omitempty"`

	// Rating The customer satisfaction rating given to AI Agent, from 1-5.
	Rating *int `json:"rating,omitempty"`

	// RatingRemark The customer satisfaction rating remark given to AI Agent.
	RatingRemark *string `json:"rating_remark,omitempty"`

	// ResolutionState The resolution state of AI Agent. If no AI or custom answer has been delivered then this will return `null`.
	ResolutionState *AiAgentResolutionState `json:"resolution_state,omitempty"`

	// SourceTitle The title of the source that triggered AI Agent involvement in the conversation. If this is `essentials_plan_setup` then it will return `null`.
	SourceTitle *string `json:"source_title,omitempty"`

	// SourceType The type of the source that triggered AI Agent involvement in the conversation.
	SourceType *AiAgentSourceType `json:"source_type,omitempty"`

	// UpdatedAt The time when the AI agent rating was last updated.
	UpdatedAt *int `json:"updated_at,omitempty"`
}

AiAgentSchema Data related to AI Agent involvement in the conversation.

type AiAgentSourceType

type AiAgentSourceType string

AiAgentSourceType The type of the source that triggered AI Agent involvement in the conversation.

const (
	EssentialsPlanSetup AiAgentSourceType = "essentials_plan_setup"
	FinPreview          AiAgentSourceType = "fin_preview"
	Profile             AiAgentSourceType = "profile"
	Workflow            AiAgentSourceType = "workflow"
	WorkflowPreview     AiAgentSourceType = "workflow_preview"
)

Defines values for AiAgentSourceType.

func (AiAgentSourceType) Valid

func (e AiAgentSourceType) Valid() bool

Valid indicates whether the value is a known member of the AiAgentSourceType enum.

type AiCallResponseSchema

type AiCallResponseSchema struct {
	// AppId The workspace identifier
	AppId *int `json:"app_id,omitempty"`

	// CallSummary Summary of the call conversation, truncated to 256 characters. Empty string if no summary available.
	CallSummary *string `json:"call_summary,omitempty"`

	// CallTranscript Array of transcript entries for the call
	CallTranscript *[]map[string]interface{} `json:"call_transcript,omitempty"`

	// ExternalCallId The external call identifier from the call provider
	ExternalCallId *string `json:"external_call_id,omitempty"`

	// Id The unique identifier for the external reference
	Id *int `json:"id,omitempty"`

	// Intent Array of intent classifications for the call
	Intent *[]map[string]interface{} `json:"intent,omitempty"`

	// IntercomCallId The Intercom call identifier, if the call has been matched
	IntercomCallId *string `json:"intercom_call_id,omitempty"`

	// IntercomConversationId The Intercom conversation identifier, if a conversation has been created
	IntercomConversationId *string `json:"intercom_conversation_id,omitempty"`

	// Status Status of the call. Can be "registered", "in-progress", or a resolution state
	Status *string `json:"status,omitempty"`

	// UserPhoneNumber Phone number in E.164 format for the call
	UserPhoneNumber *string `json:"user_phone_number,omitempty"`
}

AiCallResponseSchema Response containing information about a Fin Voice call

type AppSchema

type AppSchema struct {
	// CreatedAt When the app was created.
	CreatedAt *int `json:"created_at,omitempty"`

	// IdCode The id of the app.
	IdCode *string `json:"id_code,omitempty"`

	// IdentityVerification Whether or not the app uses identity verification.
	IdentityVerification *bool `json:"identity_verification,omitempty"`

	// Name The name of the app.
	Name *string `json:"name,omitempty"`

	// Region The Intercom region the app is located in.
	Region *string `json:"region,omitempty"`

	// Timezone The timezone of the region where the app is located.
	Timezone *string `json:"timezone,omitempty"`
	Type     *string `json:"type,omitempty"`
}

AppSchema App is a workspace on Intercom

type ArchiveContactParams

type ArchiveContactParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ArchiveContactParams defines parameters for ArchiveContact.

type ArchiveContactResponse

type ArchiveContactResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ContactArchived
}

func ParseArchiveContactResponse

func ParseArchiveContactResponse(rsp *http.Response) (*ArchiveContactResponse, error)

ParseArchiveContactResponse parses an HTTP response from a ArchiveContactWithResponse call

func (ArchiveContactResponse) Status

func (r ArchiveContactResponse) Status() string

Status returns HTTPResponse.Status

func (ArchiveContactResponse) StatusCode

func (r ArchiveContactResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ArticleContentSchema

type ArticleContentSchema struct {
	// AuthorId The ID of the author of the article.
	AuthorId *int `json:"author_id,omitempty"`

	// Body The body of the article.
	Body *string `json:"body,omitempty"`

	// CreatedAt The time when the article was created (seconds).
	CreatedAt *int `json:"created_at,omitempty"`

	// Description The description of the article.
	Description *string `json:"description,omitempty"`

	// State Whether the article is `published` or is a `draft` .
	State *ArticleContentState `json:"state,omitempty"`

	// Title The title of the article.
	Title *string `json:"title,omitempty"`

	// Type The type of object - `article_content` .
	Type *ArticleContentType `json:"type,omitempty"`

	// UpdatedAt The time when the article was last updated (seconds).
	UpdatedAt *int `json:"updated_at,omitempty"`

	// Url The URL of the article.
	Url *string `json:"url,omitempty"`
}

ArticleContentSchema The Content of an Article.

type ArticleContentState

type ArticleContentState string

ArticleContentState Whether the article is `published` or is a `draft` .

const (
	ArticleContentStateDraft     ArticleContentState = "draft"
	ArticleContentStatePublished ArticleContentState = "published"
)

Defines values for ArticleContentState.

func (ArticleContentState) Valid

func (e ArticleContentState) Valid() bool

Valid indicates whether the value is a known member of the ArticleContentState enum.

type ArticleContentType

type ArticleContentType string

ArticleContentType The type of object - `article_content` .

const (
	ArticleContentTypeArticleContent ArticleContentType = "article_content"
	ArticleContentTypeLessThannil    ArticleContentType = "<nil>"
)

Defines values for ArticleContentType.

func (ArticleContentType) Valid

func (e ArticleContentType) Valid() bool

Valid indicates whether the value is a known member of the ArticleContentType enum.

type ArticleListItemSchema

type ArticleListItemSchema struct {
	// AuthorId The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.
	AuthorId *int `json:"author_id,omitempty"`

	// Body The body of the article in HTML. For multilingual articles, this will be the body of the default language's content.
	Body *string `json:"body,omitempty"`

	// CreatedAt The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content in seconds.
	CreatedAt *int `json:"created_at,omitempty"`

	// DefaultLocale The default locale of the help center. This field is only returned for multilingual help centers.
	DefaultLocale *string `json:"default_locale,omitempty"`

	// Description The description of the article. For multilingual articles, this will be the description of the default language's content.
	Description *string `json:"description,omitempty"`

	// Id The unique identifier for the article which is given by Intercom.
	Id *string `json:"id,omitempty"`

	// ParentId The id of the article's parent collection or section. An article without this field stands alone.
	ParentId *int `json:"parent_id,omitempty"`

	// ParentIds The ids of the article's parent collections or sections. An article without this field stands alone.
	ParentIds *[]int `json:"parent_ids,omitempty"`

	// ParentType The type of parent, which can either be a `collection` or `section`.
	ParentType *string `json:"parent_type,omitempty"`

	// State Whether the article is `published` or is a `draft`. For multilingual articles, this will be the state of the default language's content.
	State *ArticleListItemState `json:"state,omitempty"`
	Tags  *TagsSchema           `json:"tags,omitempty"`

	// Title The title of the article. For multilingual articles, this will be the title of the default language's content.
	Title             *string                         `json:"title,omitempty"`
	TranslatedContent *ArticleTranslatedContentSchema `json:"translated_content,omitempty"`

	// Type The type of object - `article`.
	Type *ArticleListItemType `json:"type,omitempty"`

	// UpdatedAt The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content in seconds.
	UpdatedAt *int `json:"updated_at,omitempty"`

	// Url The URL of the article. For multilingual articles, this will be the URL of the default language's content.
	Url *string `json:"url,omitempty"`

	// WorkspaceId The id of the workspace which the article belongs to.
	WorkspaceId *string `json:"workspace_id,omitempty"`
}

ArticleListItemSchema The data returned about your articles when you list them.

type ArticleListItemState

type ArticleListItemState string

ArticleListItemState Whether the article is `published` or is a `draft`. For multilingual articles, this will be the state of the default language's content.

const (
	ArticleListItemStateDraft     ArticleListItemState = "draft"
	ArticleListItemStatePublished ArticleListItemState = "published"
)

Defines values for ArticleListItemState.

func (ArticleListItemState) Valid

func (e ArticleListItemState) Valid() bool

Valid indicates whether the value is a known member of the ArticleListItemState enum.

type ArticleListItemType

type ArticleListItemType string

ArticleListItemType The type of object - `article`.

const (
	ArticleListItemTypeArticle ArticleListItemType = "article"
)

Defines values for ArticleListItemType.

func (ArticleListItemType) Valid

func (e ArticleListItemType) Valid() bool

Valid indicates whether the value is a known member of the ArticleListItemType enum.

type ArticleListSchema

type ArticleListSchema struct {
	// Data An array of Article objects
	Data  *[]ArticleListItemSchema `json:"data,omitempty"`
	Pages *CursorPagesSchema       `json:"pages,omitempty"`

	// TotalCount A count of the total number of articles.
	TotalCount *int `json:"total_count,omitempty"`

	// Type The type of the object - `list`.
	Type *ArticleListType `json:"type,omitempty"`
}

ArticleListSchema This will return a list of articles for the App.

type ArticleListType

type ArticleListType string

ArticleListType The type of the object - `list`.

const (
	ArticleListTypeList ArticleListType = "list"
)

Defines values for ArticleListType.

func (ArticleListType) Valid

func (e ArticleListType) Valid() bool

Valid indicates whether the value is a known member of the ArticleListType enum.

type ArticleSchema

type ArticleSchema = ArticleListItemSchema

ArticleSchema The data returned about your articles when you list them.

type ArticleSearchHighlightsHighlightedSummaryType

type ArticleSearchHighlightsHighlightedSummaryType string

ArticleSearchHighlightsHighlightedSummaryType The type of text - `highlight` or `plain`.

const (
	ArticleSearchHighlightsHighlightedSummaryTypeHighlight ArticleSearchHighlightsHighlightedSummaryType = "highlight"
	ArticleSearchHighlightsHighlightedSummaryTypePlain     ArticleSearchHighlightsHighlightedSummaryType = "plain"
)

Defines values for ArticleSearchHighlightsHighlightedSummaryType.

func (ArticleSearchHighlightsHighlightedSummaryType) Valid

Valid indicates whether the value is a known member of the ArticleSearchHighlightsHighlightedSummaryType enum.

type ArticleSearchHighlightsHighlightedTitleType

type ArticleSearchHighlightsHighlightedTitleType string

ArticleSearchHighlightsHighlightedTitleType The type of text - `highlight` or `plain`.

const (
	ArticleSearchHighlightsHighlightedTitleTypeHighlight ArticleSearchHighlightsHighlightedTitleType = "highlight"
	ArticleSearchHighlightsHighlightedTitleTypePlain     ArticleSearchHighlightsHighlightedTitleType = "plain"
)

Defines values for ArticleSearchHighlightsHighlightedTitleType.

func (ArticleSearchHighlightsHighlightedTitleType) Valid

Valid indicates whether the value is a known member of the ArticleSearchHighlightsHighlightedTitleType enum.

type ArticleSearchHighlightsSchema

type ArticleSearchHighlightsSchema struct {
	// ArticleId The ID of the corresponding article.
	ArticleId *string `json:"article_id,omitempty"`

	// HighlightedSummary An Article description and body text highlighted.
	HighlightedSummary *[][]struct {
		// Text The text of the title.
		Text *string `json:"text,omitempty"`

		// Type The type of text - `highlight` or `plain`.
		Type *ArticleSearchHighlightsHighlightedSummaryType `json:"type,omitempty"`
	} `json:"highlighted_summary,omitempty"`

	// HighlightedTitle An Article title highlighted.
	HighlightedTitle *[]struct {
		// Text The text of the title.
		Text *string `json:"text,omitempty"`

		// Type The type of text - `highlight` or `plain`.
		Type *ArticleSearchHighlightsHighlightedTitleType `json:"type,omitempty"`
	} `json:"highlighted_title,omitempty"`
}

ArticleSearchHighlightsSchema The highlighted results of an Article search. In the examples provided my search query is always "my query".

type ArticleSearchResponseSchema

type ArticleSearchResponseSchema struct {
	// Data An object containing the results of the search.
	Data *struct {
		// Articles An array of Article objects
		Articles *[]ArticleSchema `json:"articles,omitempty"`

		// Highlights A corresponding array of highlighted Article content
		Highlights *[]ArticleSearchHighlightsSchema `json:"highlights,omitempty"`
	} `json:"data,omitempty"`
	Pages *CursorPagesSchema `json:"pages,omitempty"`

	// TotalCount The total number of Articles matching the search query
	TotalCount *int `json:"total_count,omitempty"`

	// Type The type of the object - `list`.
	Type *ArticleSearchResponseType `json:"type,omitempty"`
}

ArticleSearchResponseSchema The results of an Article search

type ArticleSearchResponseType

type ArticleSearchResponseType string

ArticleSearchResponseType The type of the object - `list`.

const (
	ArticleSearchResponseTypeList ArticleSearchResponseType = "list"
)

Defines values for ArticleSearchResponseType.

func (ArticleSearchResponseType) Valid

func (e ArticleSearchResponseType) Valid() bool

Valid indicates whether the value is a known member of the ArticleSearchResponseType enum.

type ArticleStatisticsSchema

type ArticleStatisticsSchema struct {
	// Conversions The number of conversations started from the article.
	Conversions *int `json:"conversions,omitempty"`

	// HappyReactionPercentage The percentage of happy reactions the article has received against other types of reaction.
	HappyReactionPercentage *float32 `json:"happy_reaction_percentage,omitempty"`

	// NeutralReactionPercentage The percentage of neutral reactions the article has received against other types of reaction.
	NeutralReactionPercentage *float32 `json:"neutral_reaction_percentage,omitempty"`

	// Reactions The number of total reactions the article has received.
	Reactions *int `json:"reactions,omitempty"`

	// SadReactionPercentage The percentage of sad reactions the article has received against other types of reaction.
	SadReactionPercentage *float32 `json:"sad_reaction_percentage,omitempty"`

	// Type The type of object - `article_statistics`.
	Type *ArticleStatisticsType `json:"type,omitempty"`

	// Views The number of total views the article has received.
	Views *int `json:"views,omitempty"`
}

ArticleStatisticsSchema The statistics of an article.

type ArticleStatisticsType

type ArticleStatisticsType string

ArticleStatisticsType The type of object - `article_statistics`.

const (
	ArticleStatistics ArticleStatisticsType = "article_statistics"
)

Defines values for ArticleStatisticsType.

func (ArticleStatisticsType) Valid

func (e ArticleStatisticsType) Valid() bool

Valid indicates whether the value is a known member of the ArticleStatisticsType enum.

type ArticleTranslatedContentSchema

type ArticleTranslatedContentSchema struct {
	// Ar The content of the article in Arabic
	Ar *ArticleContentSchema `json:"ar,omitempty"`

	// Bg The content of the article in Bulgarian
	Bg *ArticleContentSchema `json:"bg,omitempty"`

	// Bs The content of the article in Bosnian
	Bs *ArticleContentSchema `json:"bs,omitempty"`

	// Ca The content of the article in Catalan
	Ca *ArticleContentSchema `json:"ca,omitempty"`

	// Cs The content of the article in Czech
	Cs *ArticleContentSchema `json:"cs,omitempty"`

	// Da The content of the article in Danish
	Da *ArticleContentSchema `json:"da,omitempty"`

	// De The content of the article in German
	De *ArticleContentSchema `json:"de,omitempty"`

	// El The content of the article in Greek
	El *ArticleContentSchema `json:"el,omitempty"`

	// En The content of the article in English
	En *ArticleContentSchema `json:"en,omitempty"`

	// Es The content of the article in Spanish
	Es *ArticleContentSchema `json:"es,omitempty"`

	// Et The content of the article in Estonian
	Et *ArticleContentSchema `json:"et,omitempty"`

	// Fi The content of the article in Finnish
	Fi *ArticleContentSchema `json:"fi,omitempty"`

	// Fr The content of the article in French
	Fr *ArticleContentSchema `json:"fr,omitempty"`

	// He The content of the article in Hebrew
	He *ArticleContentSchema `json:"he,omitempty"`

	// Hr The content of the article in Croatian
	Hr *ArticleContentSchema `json:"hr,omitempty"`

	// Hu The content of the article in Hungarian
	Hu *ArticleContentSchema `json:"hu,omitempty"`

	// Id The content of the article in Indonesian
	Id *ArticleContentSchema `json:"id,omitempty"`

	// It The content of the article in Italian
	It *ArticleContentSchema `json:"it,omitempty"`

	// Ja The content of the article in Japanese
	Ja *ArticleContentSchema `json:"ja,omitempty"`

	// Ko The content of the article in Korean
	Ko *ArticleContentSchema `json:"ko,omitempty"`

	// Lt The content of the article in Lithuanian
	Lt *ArticleContentSchema `json:"lt,omitempty"`

	// Lv The content of the article in Latvian
	Lv *ArticleContentSchema `json:"lv,omitempty"`

	// Mn The content of the article in Mongolian
	Mn *ArticleContentSchema `json:"mn,omitempty"`

	// Nb The content of the article in Norwegian
	Nb *ArticleContentSchema `json:"nb,omitempty"`

	// Nl The content of the article in Dutch
	Nl *ArticleContentSchema `json:"nl,omitempty"`

	// Pl The content of the article in Polish
	Pl *ArticleContentSchema `json:"pl,omitempty"`

	// Pt The content of the article in Portuguese (Portugal)
	Pt *ArticleContentSchema `json:"pt,omitempty"`

	// PtBR The content of the article in Portuguese (Brazil)
	PtBR *ArticleContentSchema `json:"pt-BR,omitempty"`

	// Ro The content of the article in Romanian
	Ro *ArticleContentSchema `json:"ro,omitempty"`

	// Ru The content of the article in Russian
	Ru *ArticleContentSchema `json:"ru,omitempty"`

	// Sl The content of the article in Slovenian
	Sl *ArticleContentSchema `json:"sl,omitempty"`

	// Sr The content of the article in Serbian
	Sr *ArticleContentSchema `json:"sr,omitempty"`

	// Sv The content of the article in Swedish
	Sv *ArticleContentSchema `json:"sv,omitempty"`

	// Tr The content of the article in Turkish
	Tr *ArticleContentSchema `json:"tr,omitempty"`

	// Type The type of object - article_translated_content.
	Type *ArticleTranslatedContentType `json:"type,omitempty"`

	// Vi The content of the article in Vietnamese
	Vi *ArticleContentSchema `json:"vi,omitempty"`

	// ZhCN The content of the article in Chinese (China)
	ZhCN *ArticleContentSchema `json:"zh-CN,omitempty"`

	// ZhTW The content of the article in Chinese (Taiwan)
	ZhTW *ArticleContentSchema `json:"zh-TW,omitempty"`
}

ArticleTranslatedContentSchema The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article.

type ArticleTranslatedContentType

type ArticleTranslatedContentType string

ArticleTranslatedContentType The type of object - article_translated_content.

const (
	ArticleTranslatedContentTypeArticleTranslatedContent ArticleTranslatedContentType = "article_translated_content"
	ArticleTranslatedContentTypeLessThannil              ArticleTranslatedContentType = "<nil>"
)

Defines values for ArticleTranslatedContentType.

func (ArticleTranslatedContentType) Valid

Valid indicates whether the value is a known member of the ArticleTranslatedContentType enum.

type AssignConversationRequestMessageType

type AssignConversationRequestMessageType string

AssignConversationRequestMessageType defines model for AssignConversationRequest.MessageType.

const (
	Assignment AssignConversationRequestMessageType = "assignment"
)

Defines values for AssignConversationRequestMessageType.

func (AssignConversationRequestMessageType) Valid

Valid indicates whether the value is a known member of the AssignConversationRequestMessageType enum.

type AssignConversationRequestSchema

type AssignConversationRequestSchema struct {
	// AdminId The id of the admin who is performing the action.
	AdminId string `json:"admin_id"`

	// AssigneeId The `id` of the `admin` or `team` which will be assigned the conversation. A conversation can be assigned both an admin and a team.\nSet `0` if you want this assign to no admin or team (ie. Unassigned).
	AssigneeId string `json:"assignee_id"`

	// Body Optionally you can send a response in the conversation when it is assigned.
	Body        *string                              `json:"body,omitempty"`
	MessageType AssignConversationRequestMessageType `json:"message_type"`
	Type        AssignConversationRequestType        `json:"type"`
}

AssignConversationRequestSchema Payload of the request to assign a conversation

type AssignConversationRequestType

type AssignConversationRequestType string

AssignConversationRequestType defines model for AssignConversationRequest.Type.

const (
	AssignConversationRequestTypeAdmin AssignConversationRequestType = "admin"
	AssignConversationRequestTypeTeam  AssignConversationRequestType = "team"
)

Defines values for AssignConversationRequestType.

func (AssignConversationRequestType) Valid

Valid indicates whether the value is a known member of the AssignConversationRequestType enum.

type AttachContactToACompanyJSONBody

type AttachContactToACompanyJSONBody struct {
	// Id The unique identifier for the company which is given by Intercom
	Id string `json:"id"`
}

AttachContactToACompanyJSONBody defines parameters for AttachContactToACompany.

type AttachContactToACompanyJSONRequestBody

type AttachContactToACompanyJSONRequestBody AttachContactToACompanyJSONBody

AttachContactToACompanyJSONRequestBody defines body for AttachContactToACompany for application/json ContentType.

type AttachContactToACompanyParams

type AttachContactToACompanyParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

AttachContactToACompanyParams defines parameters for AttachContactToACompany.

type AttachContactToACompanyResponse

type AttachContactToACompanyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CompanySchema
	JSON400      *ErrorSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseAttachContactToACompanyResponse

func ParseAttachContactToACompanyResponse(rsp *http.Response) (*AttachContactToACompanyResponse, error)

ParseAttachContactToACompanyResponse parses an HTTP response from a AttachContactToACompanyWithResponse call

func (AttachContactToACompanyResponse) Status

Status returns HTTPResponse.Status

func (AttachContactToACompanyResponse) StatusCode

func (r AttachContactToACompanyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type AttachContactToConversationJSONRequestBody

type AttachContactToConversationJSONRequestBody = AttachContactToConversationRequestSchema

AttachContactToConversationJSONRequestBody defines body for AttachContactToConversation for application/json ContentType.

type AttachContactToConversationParams

type AttachContactToConversationParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

AttachContactToConversationParams defines parameters for AttachContactToConversation.

type AttachContactToConversationRequestCustomer0

type AttachContactToConversationRequestCustomer0 struct {
	Customer *CustomerRequestSchema `json:"customer,omitempty"`

	// IntercomUserId The identifier for the contact as given by Intercom.
	IntercomUserId string `json:"intercom_user_id"`
}

AttachContactToConversationRequestCustomer0 defines model for .

type AttachContactToConversationRequestCustomer1

type AttachContactToConversationRequestCustomer1 struct {
	Customer *CustomerRequestSchema `json:"customer,omitempty"`

	// UserId The external_id you have defined for the contact who is being added as a participant.
	UserId string `json:"user_id"`
}

AttachContactToConversationRequestCustomer1 defines model for .

type AttachContactToConversationRequestCustomer2

type AttachContactToConversationRequestCustomer2 struct {
	Customer *CustomerRequestSchema `json:"customer,omitempty"`

	// Email The email you have defined for the contact who is being added as a participant.
	Email string `json:"email"`
}

AttachContactToConversationRequestCustomer2 defines model for .

type AttachContactToConversationRequestSchema

type AttachContactToConversationRequestSchema struct {
	// AdminId The `id` of the admin who is adding the new participant.
	AdminId  *string                                      `json:"admin_id,omitempty"`
	Customer *AttachContactToConversationRequest_Customer `json:"customer,omitempty"`
}

AttachContactToConversationRequestSchema Payload of the request to assign a conversation

type AttachContactToConversationRequest_Customer

type AttachContactToConversationRequest_Customer struct {
	// contains filtered or unexported fields
}

AttachContactToConversationRequest_Customer defines model for AttachContactToConversationRequest.Customer.

func (AttachContactToConversationRequest_Customer) AsAttachContactToConversationRequestCustomer0

func (t AttachContactToConversationRequest_Customer) AsAttachContactToConversationRequestCustomer0() (AttachContactToConversationRequestCustomer0, error)

AsAttachContactToConversationRequestCustomer0 returns the union data inside the AttachContactToConversationRequest_Customer as a AttachContactToConversationRequestCustomer0

func (AttachContactToConversationRequest_Customer) AsAttachContactToConversationRequestCustomer1

func (t AttachContactToConversationRequest_Customer) AsAttachContactToConversationRequestCustomer1() (AttachContactToConversationRequestCustomer1, error)

AsAttachContactToConversationRequestCustomer1 returns the union data inside the AttachContactToConversationRequest_Customer as a AttachContactToConversationRequestCustomer1

func (AttachContactToConversationRequest_Customer) AsAttachContactToConversationRequestCustomer2

func (t AttachContactToConversationRequest_Customer) AsAttachContactToConversationRequestCustomer2() (AttachContactToConversationRequestCustomer2, error)

AsAttachContactToConversationRequestCustomer2 returns the union data inside the AttachContactToConversationRequest_Customer as a AttachContactToConversationRequestCustomer2

func (*AttachContactToConversationRequest_Customer) FromAttachContactToConversationRequestCustomer0

func (t *AttachContactToConversationRequest_Customer) FromAttachContactToConversationRequestCustomer0(v AttachContactToConversationRequestCustomer0) error

FromAttachContactToConversationRequestCustomer0 overwrites any union data inside the AttachContactToConversationRequest_Customer as the provided AttachContactToConversationRequestCustomer0

func (*AttachContactToConversationRequest_Customer) FromAttachContactToConversationRequestCustomer1

func (t *AttachContactToConversationRequest_Customer) FromAttachContactToConversationRequestCustomer1(v AttachContactToConversationRequestCustomer1) error

FromAttachContactToConversationRequestCustomer1 overwrites any union data inside the AttachContactToConversationRequest_Customer as the provided AttachContactToConversationRequestCustomer1

func (*AttachContactToConversationRequest_Customer) FromAttachContactToConversationRequestCustomer2

func (t *AttachContactToConversationRequest_Customer) FromAttachContactToConversationRequestCustomer2(v AttachContactToConversationRequestCustomer2) error

FromAttachContactToConversationRequestCustomer2 overwrites any union data inside the AttachContactToConversationRequest_Customer as the provided AttachContactToConversationRequestCustomer2

func (AttachContactToConversationRequest_Customer) MarshalJSON

func (*AttachContactToConversationRequest_Customer) MergeAttachContactToConversationRequestCustomer0

func (t *AttachContactToConversationRequest_Customer) MergeAttachContactToConversationRequestCustomer0(v AttachContactToConversationRequestCustomer0) error

MergeAttachContactToConversationRequestCustomer0 performs a merge with any union data inside the AttachContactToConversationRequest_Customer, using the provided AttachContactToConversationRequestCustomer0

func (*AttachContactToConversationRequest_Customer) MergeAttachContactToConversationRequestCustomer1

func (t *AttachContactToConversationRequest_Customer) MergeAttachContactToConversationRequestCustomer1(v AttachContactToConversationRequestCustomer1) error

MergeAttachContactToConversationRequestCustomer1 performs a merge with any union data inside the AttachContactToConversationRequest_Customer, using the provided AttachContactToConversationRequestCustomer1

func (*AttachContactToConversationRequest_Customer) MergeAttachContactToConversationRequestCustomer2

func (t *AttachContactToConversationRequest_Customer) MergeAttachContactToConversationRequestCustomer2(v AttachContactToConversationRequestCustomer2) error

MergeAttachContactToConversationRequestCustomer2 performs a merge with any union data inside the AttachContactToConversationRequest_Customer, using the provided AttachContactToConversationRequestCustomer2

func (*AttachContactToConversationRequest_Customer) UnmarshalJSON

type AttachContactToConversationResponse

type AttachContactToConversationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ConversationSchema
	JSON401      *ErrorSchema
	JSON403      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseAttachContactToConversationResponse

func ParseAttachContactToConversationResponse(rsp *http.Response) (*AttachContactToConversationResponse, error)

ParseAttachContactToConversationResponse parses an HTTP response from a AttachContactToConversationWithResponse call

func (AttachContactToConversationResponse) Status

Status returns HTTPResponse.Status

func (AttachContactToConversationResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type AttachSubscriptionTypeToContactJSONBody

type AttachSubscriptionTypeToContactJSONBody struct {
	// ConsentType The consent_type of a subscription, opt_out or opt_in.
	ConsentType string `json:"consent_type"`

	// Id The unique identifier for the subscription which is given by Intercom
	Id string `json:"id"`
}

AttachSubscriptionTypeToContactJSONBody defines parameters for AttachSubscriptionTypeToContact.

type AttachSubscriptionTypeToContactJSONRequestBody

type AttachSubscriptionTypeToContactJSONRequestBody AttachSubscriptionTypeToContactJSONBody

AttachSubscriptionTypeToContactJSONRequestBody defines body for AttachSubscriptionTypeToContact for application/json ContentType.

type AttachSubscriptionTypeToContactParams

type AttachSubscriptionTypeToContactParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

AttachSubscriptionTypeToContactParams defines parameters for AttachSubscriptionTypeToContact.

type AttachSubscriptionTypeToContactResponse

type AttachSubscriptionTypeToContactResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SubscriptionTypeSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseAttachSubscriptionTypeToContactResponse

func ParseAttachSubscriptionTypeToContactResponse(rsp *http.Response) (*AttachSubscriptionTypeToContactResponse, error)

ParseAttachSubscriptionTypeToContactResponse parses an HTTP response from a AttachSubscriptionTypeToContactWithResponse call

func (AttachSubscriptionTypeToContactResponse) Status

Status returns HTTPResponse.Status

func (AttachSubscriptionTypeToContactResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type AttachTagToContactJSONBody

type AttachTagToContactJSONBody struct {
	// Id The unique identifier for the tag which is given by Intercom
	Id string `json:"id"`
}

AttachTagToContactJSONBody defines parameters for AttachTagToContact.

type AttachTagToContactJSONRequestBody

type AttachTagToContactJSONRequestBody AttachTagToContactJSONBody

AttachTagToContactJSONRequestBody defines body for AttachTagToContact for application/json ContentType.

type AttachTagToContactParams

type AttachTagToContactParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

AttachTagToContactParams defines parameters for AttachTagToContact.

type AttachTagToContactResponse

type AttachTagToContactResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TagSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseAttachTagToContactResponse

func ParseAttachTagToContactResponse(rsp *http.Response) (*AttachTagToContactResponse, error)

ParseAttachTagToContactResponse parses an HTTP response from a AttachTagToContactWithResponse call

func (AttachTagToContactResponse) Status

Status returns HTTPResponse.Status

func (AttachTagToContactResponse) StatusCode

func (r AttachTagToContactResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type AttachTagToConversationJSONBody

type AttachTagToConversationJSONBody struct {
	// AdminId The unique identifier for the admin which is given by Intercom.
	AdminId string `json:"admin_id"`

	// Id The unique identifier for the tag which is given by Intercom
	Id string `json:"id"`
}

AttachTagToConversationJSONBody defines parameters for AttachTagToConversation.

type AttachTagToConversationJSONRequestBody

type AttachTagToConversationJSONRequestBody AttachTagToConversationJSONBody

AttachTagToConversationJSONRequestBody defines body for AttachTagToConversation for application/json ContentType.

type AttachTagToConversationParams

type AttachTagToConversationParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

AttachTagToConversationParams defines parameters for AttachTagToConversation.

type AttachTagToConversationResponse

type AttachTagToConversationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TagSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseAttachTagToConversationResponse

func ParseAttachTagToConversationResponse(rsp *http.Response) (*AttachTagToConversationResponse, error)

ParseAttachTagToConversationResponse parses an HTTP response from a AttachTagToConversationWithResponse call

func (AttachTagToConversationResponse) Status

Status returns HTTPResponse.Status

func (AttachTagToConversationResponse) StatusCode

func (r AttachTagToConversationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type AttachTagToTicketJSONBody

type AttachTagToTicketJSONBody struct {
	// AdminId The unique identifier for the admin which is given by Intercom.
	AdminId string `json:"admin_id"`

	// Id The unique identifier for the tag which is given by Intercom
	Id string `json:"id"`
}

AttachTagToTicketJSONBody defines parameters for AttachTagToTicket.

type AttachTagToTicketJSONRequestBody

type AttachTagToTicketJSONRequestBody AttachTagToTicketJSONBody

AttachTagToTicketJSONRequestBody defines body for AttachTagToTicket for application/json ContentType.

type AttachTagToTicketParams

type AttachTagToTicketParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

AttachTagToTicketParams defines parameters for AttachTagToTicket.

type AttachTagToTicketResponse

type AttachTagToTicketResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TagSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseAttachTagToTicketResponse

func ParseAttachTagToTicketResponse(rsp *http.Response) (*AttachTagToTicketResponse, error)

ParseAttachTagToTicketResponse parses an HTTP response from a AttachTagToTicketWithResponse call

func (AttachTagToTicketResponse) Status

func (r AttachTagToTicketResponse) Status() string

Status returns HTTPResponse.Status

func (AttachTagToTicketResponse) StatusCode

func (r AttachTagToTicketResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type AwayStatusReasonSchema

type AwayStatusReasonSchema struct {
	// CreatedAt The Unix timestamp when the status reason was created
	CreatedAt *int `json:"created_at,omitempty"`

	// Deleted Whether the status reason has been soft deleted
	Deleted *bool `json:"deleted,omitempty"`

	// Emoji The emoji associated with the status reason
	Emoji *string `json:"emoji,omitempty"`

	// Id The unique identifier for the away status reason
	Id *string `json:"id,omitempty"`

	// Label The display text for the away status reason
	Label *string `json:"label,omitempty"`

	// Order The display order of the status reason
	Order *int    `json:"order,omitempty"`
	Type  *string `json:"type,omitempty"`

	// UpdatedAt The Unix timestamp when the status reason was last updated
	UpdatedAt *int `json:"updated_at,omitempty"`
}

AwayStatusReasonSchema defines model for away_status_reason.

type BadRequest

type BadRequest = ErrorSchema

BadRequest The API will return an Error List for a failed request, which will contain one or more Error objects.

type BlockContactParams

type BlockContactParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

BlockContactParams defines parameters for BlockContact.

type BlockContactResponse

type BlockContactResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ContactBlockedSchema
}

func ParseBlockContactResponse

func ParseBlockContactResponse(rsp *http.Response) (*BlockContactResponse, error)

ParseBlockContactResponse parses an HTTP response from a BlockContactWithResponse call

func (BlockContactResponse) Status

func (r BlockContactResponse) Status() string

Status returns HTTPResponse.Status

func (BlockContactResponse) StatusCode

func (r BlockContactResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BrandListSchema

type BrandListSchema struct {
	Data *[]BrandSchema `json:"data,omitempty"`

	// Type The type of object
	Type *string `json:"type,omitempty"`
}

BrandListSchema A list of brands

type BrandSchema

type BrandSchema struct {
	// CreatedAt Unix timestamp of brand creation
	CreatedAt *int `json:"created_at,omitempty"`

	// DefaultAddressSettingsId Default email settings ID for this brand
	DefaultAddressSettingsId *string `json:"default_address_settings_id,omitempty"`

	// HelpCenterId Associated help center identifier
	HelpCenterId *string `json:"help_center_id,omitempty"`

	// Id Unique brand identifier. For default brand, matches the workspace ID
	Id *string `json:"id,omitempty"`

	// IsDefault Whether this is the workspace's default brand
	IsDefault *bool `json:"is_default,omitempty"`

	// Name Display name of the brand
	Name *string `json:"name,omitempty"`

	// Type The type of object
	Type *string `json:"type,omitempty"`

	// UpdatedAt Unix timestamp of last modification
	UpdatedAt *int `json:"updated_at,omitempty"`
}

BrandSchema Represents a branding configuration for the workspace

type CallListSchema

type CallListSchema struct {
	// Data A list of calls.
	Data  *[]CallSchema      `json:"data,omitempty"`
	Pages *CursorPagesSchema `json:"pages,omitempty"`

	// TotalCount Total number of items available.
	TotalCount *int `json:"total_count,omitempty"`

	// Type String representing the object's type. Always has the value `list`.
	Type *string `json:"type,omitempty"`
}

CallListSchema A paginated list of calls.

type CallSchema

type CallSchema struct {
	// AdminId The id of the admin associated with the call, if any.
	AdminId    *string   `json:"admin_id,omitempty"`
	AnsweredAt *Datetime `json:"answered_at,omitempty"`

	// CallType The type of call.
	CallType *string `json:"call_type,omitempty"`

	// ContactId The id of the contact associated with the call, if any.
	ContactId *string `json:"contact_id,omitempty"`

	// ConversationId The id of the conversation associated with the call, if any.
	ConversationId *string   `json:"conversation_id,omitempty"`
	CreatedAt      *Datetime `json:"created_at,omitempty"`

	// Direction The direction of the call.
	Direction *string   `json:"direction,omitempty"`
	EndedAt   *Datetime `json:"ended_at,omitempty"`

	// EndedReason The reason for the call end, if applicable.
	EndedReason *string `json:"ended_reason,omitempty"`

	// FinRecordingUrl API URL to the AI Agent (Fin) call recording if available.
	FinRecordingUrl *string `json:"fin_recording_url,omitempty"`

	// FinTranscriptionUrl API URL to the AI Agent (Fin) call transcript if available.
	FinTranscriptionUrl *string `json:"fin_transcription_url,omitempty"`

	// Id The id of the call.
	Id          *string   `json:"id,omitempty"`
	InitiatedAt *Datetime `json:"initiated_at,omitempty"`

	// Phone The phone number involved in the call, in E.164 format.
	Phone *string `json:"phone,omitempty"`

	// RecordingUrl API URL to download or redirect to the call recording if available.
	RecordingUrl *string `json:"recording_url,omitempty"`

	// State The current state of the call.
	State *string `json:"state,omitempty"`

	// TranscriptionUrl API URL to download or redirect to the call transcript if available.
	TranscriptionUrl *string `json:"transcription_url,omitempty"`

	// Type String representing the object's type. Always has the value `call`.
	Type      *string   `json:"type,omitempty"`
	UpdatedAt *Datetime `json:"updated_at,omitempty"`
}

CallSchema Represents a phone call in Intercom

type CancelDataExportParams

type CancelDataExportParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

CancelDataExportParams defines parameters for CancelDataExport.

type CancelDataExportResponse

type CancelDataExportResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DataExportSchema
}

func ParseCancelDataExportResponse

func ParseCancelDataExportResponse(rsp *http.Response) (*CancelDataExportResponse, error)

ParseCancelDataExportResponse parses an HTTP response from a CancelDataExportWithResponse call

func (CancelDataExportResponse) Status

func (r CancelDataExportResponse) Status() string

Status returns HTTPResponse.Status

func (CancelDataExportResponse) StatusCode

func (r CancelDataExportResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) ArchiveContact

func (c *Client) ArchiveContact(ctx context.Context, contactId string, params *ArchiveContactParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) AttachContactToACompany

func (c *Client) AttachContactToACompany(ctx context.Context, contactId string, params *AttachContactToACompanyParams, body AttachContactToACompanyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) AttachContactToACompanyWithBody

func (c *Client) AttachContactToACompanyWithBody(ctx context.Context, contactId string, params *AttachContactToACompanyParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) AttachContactToConversation

func (c *Client) AttachContactToConversation(ctx context.Context, conversationId string, params *AttachContactToConversationParams, body AttachContactToConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) AttachContactToConversationWithBody

func (c *Client) AttachContactToConversationWithBody(ctx context.Context, conversationId string, params *AttachContactToConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) AttachSubscriptionTypeToContact

func (c *Client) AttachSubscriptionTypeToContact(ctx context.Context, contactId string, params *AttachSubscriptionTypeToContactParams, body AttachSubscriptionTypeToContactJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) AttachSubscriptionTypeToContactWithBody

func (c *Client) AttachSubscriptionTypeToContactWithBody(ctx context.Context, contactId string, params *AttachSubscriptionTypeToContactParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) AttachTagToContact

func (c *Client) AttachTagToContact(ctx context.Context, contactId string, params *AttachTagToContactParams, body AttachTagToContactJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) AttachTagToContactWithBody

func (c *Client) AttachTagToContactWithBody(ctx context.Context, contactId string, params *AttachTagToContactParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) AttachTagToConversation

func (c *Client) AttachTagToConversation(ctx context.Context, conversationId string, params *AttachTagToConversationParams, body AttachTagToConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) AttachTagToConversationWithBody

func (c *Client) AttachTagToConversationWithBody(ctx context.Context, conversationId string, params *AttachTagToConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) AttachTagToTicket

func (c *Client) AttachTagToTicket(ctx context.Context, ticketId string, params *AttachTagToTicketParams, body AttachTagToTicketJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) AttachTagToTicketWithBody

func (c *Client) AttachTagToTicketWithBody(ctx context.Context, ticketId string, params *AttachTagToTicketParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) BlockContact

func (c *Client) BlockContact(ctx context.Context, contactId string, params *BlockContactParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CancelDataExport

func (c *Client) CancelDataExport(ctx context.Context, jobIdentifier string, params *CancelDataExportParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CollectFinVoiceCallByExternalId

func (c *Client) CollectFinVoiceCallByExternalId(ctx context.Context, externalId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CollectFinVoiceCallById

func (c *Client) CollectFinVoiceCallById(ctx context.Context, id int, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CollectFinVoiceCallByPhoneNumber

func (c *Client) CollectFinVoiceCallByPhoneNumber(ctx context.Context, phoneNumber string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CollectFinVoiceCallsByConversationId

func (c *Client) CollectFinVoiceCallsByConversationId(ctx context.Context, conversationId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ConvertConversationToTicket

func (c *Client) ConvertConversationToTicket(ctx context.Context, conversationId int, params *ConvertConversationToTicketParams, body ConvertConversationToTicketJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ConvertConversationToTicketWithBody

func (c *Client) ConvertConversationToTicketWithBody(ctx context.Context, conversationId int, params *ConvertConversationToTicketParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ConvertVisitor

func (c *Client) ConvertVisitor(ctx context.Context, params *ConvertVisitorParams, body ConvertVisitorJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ConvertVisitorWithBody

func (c *Client) ConvertVisitorWithBody(ctx context.Context, params *ConvertVisitorParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateArticle

func (c *Client) CreateArticle(ctx context.Context, params *CreateArticleParams, body CreateArticleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateArticleWithBody

func (c *Client) CreateArticleWithBody(ctx context.Context, params *CreateArticleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateCollection

func (c *Client) CreateCollection(ctx context.Context, params *CreateCollectionParams, body CreateCollectionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateCollectionWithBody

func (c *Client) CreateCollectionWithBody(ctx context.Context, params *CreateCollectionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateContact

func (c *Client) CreateContact(ctx context.Context, params *CreateContactParams, body CreateContactJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateContactWithBody

func (c *Client) CreateContactWithBody(ctx context.Context, params *CreateContactParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateContentImportSource

func (c *Client) CreateContentImportSource(ctx context.Context, params *CreateContentImportSourceParams, body CreateContentImportSourceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateContentImportSourceWithBody

func (c *Client) CreateContentImportSourceWithBody(ctx context.Context, params *CreateContentImportSourceParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateConversation

func (c *Client) CreateConversation(ctx context.Context, params *CreateConversationParams, body CreateConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateConversationWithBody

func (c *Client) CreateConversationWithBody(ctx context.Context, params *CreateConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateCustomObjectInstances

func (c *Client) CreateCustomObjectInstances(ctx context.Context, customObjectTypeIdentifier string, params *CreateCustomObjectInstancesParams, body CreateCustomObjectInstancesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateCustomObjectInstancesWithBody

func (c *Client) CreateCustomObjectInstancesWithBody(ctx context.Context, customObjectTypeIdentifier string, params *CreateCustomObjectInstancesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateDataAttribute

func (c *Client) CreateDataAttribute(ctx context.Context, params *CreateDataAttributeParams, body CreateDataAttributeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateDataAttributeWithBody

func (c *Client) CreateDataAttributeWithBody(ctx context.Context, params *CreateDataAttributeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateDataEvent

func (c *Client) CreateDataEvent(ctx context.Context, params *CreateDataEventParams, body CreateDataEventJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateDataEventWithBody

func (c *Client) CreateDataEventWithBody(ctx context.Context, params *CreateDataEventParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateDataExport

func (c *Client) CreateDataExport(ctx context.Context, params *CreateDataExportParams, body CreateDataExportJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateDataExportWithBody

func (c *Client) CreateDataExportWithBody(ctx context.Context, params *CreateDataExportParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateExternalPage

func (c *Client) CreateExternalPage(ctx context.Context, params *CreateExternalPageParams, body CreateExternalPageJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateExternalPageWithBody

func (c *Client) CreateExternalPageWithBody(ctx context.Context, params *CreateExternalPageParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateInternalArticle

func (c *Client) CreateInternalArticle(ctx context.Context, params *CreateInternalArticleParams, body CreateInternalArticleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateInternalArticleWithBody

func (c *Client) CreateInternalArticleWithBody(ctx context.Context, params *CreateInternalArticleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateMessage

func (c *Client) CreateMessage(ctx context.Context, params *CreateMessageParams, body CreateMessageJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateMessageWithBody

func (c *Client) CreateMessageWithBody(ctx context.Context, params *CreateMessageParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateNewsItem

func (c *Client) CreateNewsItem(ctx context.Context, params *CreateNewsItemParams, body CreateNewsItemJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateNewsItemWithBody

func (c *Client) CreateNewsItemWithBody(ctx context.Context, params *CreateNewsItemParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateNote

func (c *Client) CreateNote(ctx context.Context, contactId int, params *CreateNoteParams, body CreateNoteJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateNoteWithBody

func (c *Client) CreateNoteWithBody(ctx context.Context, contactId int, params *CreateNoteParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateOrUpdateCompany

func (c *Client) CreateOrUpdateCompany(ctx context.Context, params *CreateOrUpdateCompanyParams, body CreateOrUpdateCompanyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateOrUpdateCompanyWithBody

func (c *Client) CreateOrUpdateCompanyWithBody(ctx context.Context, params *CreateOrUpdateCompanyParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreatePhoneSwitch

func (c *Client) CreatePhoneSwitch(ctx context.Context, params *CreatePhoneSwitchParams, body CreatePhoneSwitchJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreatePhoneSwitchWithBody

func (c *Client) CreatePhoneSwitchWithBody(ctx context.Context, params *CreatePhoneSwitchParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateTag

func (c *Client) CreateTag(ctx context.Context, params *CreateTagParams, body CreateTagJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateTagWithBody

func (c *Client) CreateTagWithBody(ctx context.Context, params *CreateTagParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateTicket

func (c *Client) CreateTicket(ctx context.Context, params *CreateTicketParams, body CreateTicketJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateTicketType

func (c *Client) CreateTicketType(ctx context.Context, params *CreateTicketTypeParams, body CreateTicketTypeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateTicketTypeAttribute

func (c *Client) CreateTicketTypeAttribute(ctx context.Context, ticketTypeId string, params *CreateTicketTypeAttributeParams, body CreateTicketTypeAttributeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateTicketTypeAttributeWithBody

func (c *Client) CreateTicketTypeAttributeWithBody(ctx context.Context, ticketTypeId string, params *CreateTicketTypeAttributeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateTicketTypeWithBody

func (c *Client) CreateTicketTypeWithBody(ctx context.Context, params *CreateTicketTypeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateTicketWithBody

func (c *Client) CreateTicketWithBody(ctx context.Context, params *CreateTicketParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DataEventSummaries

func (c *Client) DataEventSummaries(ctx context.Context, params *DataEventSummariesParams, body DataEventSummariesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DataEventSummariesWithBody

func (c *Client) DataEventSummariesWithBody(ctx context.Context, params *DataEventSummariesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteArticle

func (c *Client) DeleteArticle(ctx context.Context, articleId int, params *DeleteArticleParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteCollection

func (c *Client) DeleteCollection(ctx context.Context, collectionId int, params *DeleteCollectionParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteCompany

func (c *Client) DeleteCompany(ctx context.Context, companyId string, params *DeleteCompanyParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteContact

func (c *Client) DeleteContact(ctx context.Context, contactId string, params *DeleteContactParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteContentImportSource

func (c *Client) DeleteContentImportSource(ctx context.Context, sourceId string, params *DeleteContentImportSourceParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteConversation

func (c *Client) DeleteConversation(ctx context.Context, conversationId int, params *DeleteConversationParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteCustomObjectInstancesByExternalId

func (c *Client) DeleteCustomObjectInstancesByExternalId(ctx context.Context, customObjectTypeIdentifier string, customObjectInstanceId string, params *DeleteCustomObjectInstancesByExternalIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteCustomObjectInstancesById

func (c *Client) DeleteCustomObjectInstancesById(ctx context.Context, customObjectTypeIdentifier string, params *DeleteCustomObjectInstancesByIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteExternalPage

func (c *Client) DeleteExternalPage(ctx context.Context, pageId string, params *DeleteExternalPageParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteInternalArticle

func (c *Client) DeleteInternalArticle(ctx context.Context, internalArticleId int, params *DeleteInternalArticleParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteNewsItem

func (c *Client) DeleteNewsItem(ctx context.Context, newsItemId int, params *DeleteNewsItemParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteTag

func (c *Client) DeleteTag(ctx context.Context, tagId string, params *DeleteTagParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteTicket

func (c *Client) DeleteTicket(ctx context.Context, ticketId string, params *DeleteTicketParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DetachContactFromACompany

func (c *Client) DetachContactFromACompany(ctx context.Context, contactId string, companyId string, params *DetachContactFromACompanyParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DetachContactFromConversation

func (c *Client) DetachContactFromConversation(ctx context.Context, conversationId string, contactId string, params *DetachContactFromConversationParams, body DetachContactFromConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DetachContactFromConversationWithBody

func (c *Client) DetachContactFromConversationWithBody(ctx context.Context, conversationId string, contactId string, params *DetachContactFromConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DetachSubscriptionTypeToContact

func (c *Client) DetachSubscriptionTypeToContact(ctx context.Context, contactId string, subscriptionId string, params *DetachSubscriptionTypeToContactParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DetachTagFromContact

func (c *Client) DetachTagFromContact(ctx context.Context, contactId string, tagId string, params *DetachTagFromContactParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DetachTagFromConversation

func (c *Client) DetachTagFromConversation(ctx context.Context, conversationId string, tagId string, params *DetachTagFromConversationParams, body DetachTagFromConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DetachTagFromConversationWithBody

func (c *Client) DetachTagFromConversationWithBody(ctx context.Context, conversationId string, tagId string, params *DetachTagFromConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DetachTagFromTicket

func (c *Client) DetachTagFromTicket(ctx context.Context, ticketId string, tagId string, params *DetachTagFromTicketParams, body DetachTagFromTicketJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DetachTagFromTicketWithBody

func (c *Client) DetachTagFromTicketWithBody(ctx context.Context, ticketId string, tagId string, params *DetachTagFromTicketParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DownloadDataExport

func (c *Client) DownloadDataExport(ctx context.Context, jobIdentifier string, params *DownloadDataExportParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) EnqueueCreateTicket

func (c *Client) EnqueueCreateTicket(ctx context.Context, params *EnqueueCreateTicketParams, body EnqueueCreateTicketJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) EnqueueCreateTicketWithBody

func (c *Client) EnqueueCreateTicketWithBody(ctx context.Context, params *EnqueueCreateTicketParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ExportWorkflow

func (c *Client) ExportWorkflow(ctx context.Context, id string, params *ExportWorkflowParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) FindTag

func (c *Client) FindTag(ctx context.Context, tagId string, params *FindTagParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetContentImportSource

func (c *Client) GetContentImportSource(ctx context.Context, sourceId string, params *GetContentImportSourceParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetCustomObjectInstancesByExternalId

func (c *Client) GetCustomObjectInstancesByExternalId(ctx context.Context, customObjectTypeIdentifier string, params *GetCustomObjectInstancesByExternalIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetCustomObjectInstancesById

func (c *Client) GetCustomObjectInstancesById(ctx context.Context, customObjectTypeIdentifier string, customObjectInstanceId string, params *GetCustomObjectInstancesByIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetDataExport

func (c *Client) GetDataExport(ctx context.Context, jobIdentifier string, params *GetDataExportParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetDownloadReportingDataJobIdentifier

func (c *Client) GetDownloadReportingDataJobIdentifier(ctx context.Context, jobIdentifier string, params *GetDownloadReportingDataJobIdentifierParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetExportReportingDataGetDatasets

func (c *Client) GetExportReportingDataGetDatasets(ctx context.Context, params *GetExportReportingDataGetDatasetsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetExportReportingDataJobIdentifier

func (c *Client) GetExportReportingDataJobIdentifier(ctx context.Context, jobIdentifier string, params *GetExportReportingDataJobIdentifierParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetExternalPage

func (c *Client) GetExternalPage(ctx context.Context, pageId string, params *GetExternalPageParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetIpAllowlist

func (c *Client) GetIpAllowlist(ctx context.Context, params *GetIpAllowlistParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetTicket

func (c *Client) GetTicket(ctx context.Context, ticketId string, params *GetTicketParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetTicketType

func (c *Client) GetTicketType(ctx context.Context, ticketTypeId string, params *GetTicketTypeParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) IdentifyAdmin

func (c *Client) IdentifyAdmin(ctx context.Context, params *IdentifyAdminParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) JobsStatus

func (c *Client) JobsStatus(ctx context.Context, jobId string, params *JobsStatusParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) LisDataAttributes

func (c *Client) LisDataAttributes(ctx context.Context, params *LisDataAttributesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) LisDataEvents

func (c *Client) LisDataEvents(ctx context.Context, params *LisDataEventsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListActivityLogs

func (c *Client) ListActivityLogs(ctx context.Context, params *ListActivityLogsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListAdmins

func (c *Client) ListAdmins(ctx context.Context, params *ListAdminsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListAllCollections

func (c *Client) ListAllCollections(ctx context.Context, params *ListAllCollectionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListAllCompanies

func (c *Client) ListAllCompanies(ctx context.Context, params *ListAllCompaniesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListArticles

func (c *Client) ListArticles(ctx context.Context, params *ListArticlesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListAttachedContacts

func (c *Client) ListAttachedContacts(ctx context.Context, companyId string, params *ListAttachedContactsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListAttachedSegmentsForCompanies

func (c *Client) ListAttachedSegmentsForCompanies(ctx context.Context, companyId string, params *ListAttachedSegmentsForCompaniesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListAwayStatusReasons

func (c *Client) ListAwayStatusReasons(ctx context.Context, params *ListAwayStatusReasonsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListBrands

func (c *Client) ListBrands(ctx context.Context, params *ListBrandsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListCalls

func (c *Client) ListCalls(ctx context.Context, params *ListCallsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListCallsWithTranscripts

func (c *Client) ListCallsWithTranscripts(ctx context.Context, params *ListCallsWithTranscriptsParams, body ListCallsWithTranscriptsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListCallsWithTranscriptsWithBody

func (c *Client) ListCallsWithTranscriptsWithBody(ctx context.Context, params *ListCallsWithTranscriptsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListCompaniesForAContact

func (c *Client) ListCompaniesForAContact(ctx context.Context, contactId string, params *ListCompaniesForAContactParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListCompanyNotes

func (c *Client) ListCompanyNotes(ctx context.Context, companyId string, params *ListCompanyNotesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListContacts

func (c *Client) ListContacts(ctx context.Context, params *ListContactsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListContentImportSources

func (c *Client) ListContentImportSources(ctx context.Context, params *ListContentImportSourcesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListConversations

func (c *Client) ListConversations(ctx context.Context, params *ListConversationsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListEmails

func (c *Client) ListEmails(ctx context.Context, params *ListEmailsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListExternalPages

func (c *Client) ListExternalPages(ctx context.Context, params *ListExternalPagesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListHandlingEvents

func (c *Client) ListHandlingEvents(ctx context.Context, id string, params *ListHandlingEventsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListHelpCenters

func (c *Client) ListHelpCenters(ctx context.Context, params *ListHelpCentersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListInternalArticles

func (c *Client) ListInternalArticles(ctx context.Context, params *ListInternalArticlesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListLiveNewsfeedItems

func (c *Client) ListLiveNewsfeedItems(ctx context.Context, newsfeedId string, params *ListLiveNewsfeedItemsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListNewsItems

func (c *Client) ListNewsItems(ctx context.Context, params *ListNewsItemsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListNewsfeeds

func (c *Client) ListNewsfeeds(ctx context.Context, params *ListNewsfeedsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListNotes

func (c *Client) ListNotes(ctx context.Context, contactId string, params *ListNotesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListSegments

func (c *Client) ListSegments(ctx context.Context, params *ListSegmentsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListSegmentsForAContact

func (c *Client) ListSegmentsForAContact(ctx context.Context, contactId string, params *ListSegmentsForAContactParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListSubscriptionTypes

func (c *Client) ListSubscriptionTypes(ctx context.Context, params *ListSubscriptionTypesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListSubscriptionsForAContact

func (c *Client) ListSubscriptionsForAContact(ctx context.Context, contactId string, params *ListSubscriptionsForAContactParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListTags

func (c *Client) ListTags(ctx context.Context, params *ListTagsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListTagsForAContact

func (c *Client) ListTagsForAContact(ctx context.Context, contactId string, params *ListTagsForAContactParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListTeams

func (c *Client) ListTeams(ctx context.Context, params *ListTeamsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListTicketStates

func (c *Client) ListTicketStates(ctx context.Context, params *ListTicketStatesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListTicketTypes

func (c *Client) ListTicketTypes(ctx context.Context, params *ListTicketTypesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ManageConversation

func (c *Client) ManageConversation(ctx context.Context, conversationId string, params *ManageConversationParams, body ManageConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ManageConversationWithBody

func (c *Client) ManageConversationWithBody(ctx context.Context, conversationId string, params *ManageConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) MergeContact

func (c *Client) MergeContact(ctx context.Context, params *MergeContactParams, body MergeContactJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) MergeContactWithBody

func (c *Client) MergeContactWithBody(ctx context.Context, params *MergeContactParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PostExportReportingDataEnqueueWithBody

func (c *Client) PostExportReportingDataEnqueueWithBody(ctx context.Context, params *PostExportReportingDataEnqueueParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RedactConversation

func (c *Client) RedactConversation(ctx context.Context, params *RedactConversationParams, body RedactConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RedactConversationWithBody

func (c *Client) RedactConversationWithBody(ctx context.Context, params *RedactConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RegisterFinVoiceCall

func (c *Client) RegisterFinVoiceCall(ctx context.Context, body RegisterFinVoiceCallJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RegisterFinVoiceCallWithBody

func (c *Client) RegisterFinVoiceCallWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ReplyConversation

func (c *Client) ReplyConversation(ctx context.Context, conversationId string, params *ReplyConversationParams, body ReplyConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ReplyConversationWithBody

func (c *Client) ReplyConversationWithBody(ctx context.Context, conversationId string, params *ReplyConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ReplyTicket

func (c *Client) ReplyTicket(ctx context.Context, ticketId string, params *ReplyTicketParams, body ReplyTicketJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ReplyTicketWithBody

func (c *Client) ReplyTicketWithBody(ctx context.Context, ticketId string, params *ReplyTicketParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ReplyToFin

func (c *Client) ReplyToFin(ctx context.Context, params *ReplyToFinParams, body ReplyToFinJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ReplyToFinWithBody

func (c *Client) ReplyToFinWithBody(ctx context.Context, params *ReplyToFinParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RetrieveACompanyById

func (c *Client) RetrieveACompanyById(ctx context.Context, companyId string, params *RetrieveACompanyByIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RetrieveAdmin

func (c *Client) RetrieveAdmin(ctx context.Context, adminId int, params *RetrieveAdminParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RetrieveArticle

func (c *Client) RetrieveArticle(ctx context.Context, articleId int, params *RetrieveArticleParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RetrieveBrand

func (c *Client) RetrieveBrand(ctx context.Context, id string, params *RetrieveBrandParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RetrieveCollection

func (c *Client) RetrieveCollection(ctx context.Context, collectionId int, params *RetrieveCollectionParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RetrieveCompany

func (c *Client) RetrieveCompany(ctx context.Context, params *RetrieveCompanyParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RetrieveConversation

func (c *Client) RetrieveConversation(ctx context.Context, conversationId int, params *RetrieveConversationParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RetrieveEmail

func (c *Client) RetrieveEmail(ctx context.Context, id string, params *RetrieveEmailParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RetrieveHelpCenter

func (c *Client) RetrieveHelpCenter(ctx context.Context, helpCenterId int, params *RetrieveHelpCenterParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RetrieveInternalArticle

func (c *Client) RetrieveInternalArticle(ctx context.Context, internalArticleId int, params *RetrieveInternalArticleParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RetrieveNewsItem

func (c *Client) RetrieveNewsItem(ctx context.Context, newsItemId int, params *RetrieveNewsItemParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RetrieveNewsfeed

func (c *Client) RetrieveNewsfeed(ctx context.Context, newsfeedId string, params *RetrieveNewsfeedParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RetrieveNote

func (c *Client) RetrieveNote(ctx context.Context, noteId int, params *RetrieveNoteParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RetrieveSegment

func (c *Client) RetrieveSegment(ctx context.Context, segmentId string, params *RetrieveSegmentParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RetrieveTeam

func (c *Client) RetrieveTeam(ctx context.Context, teamId string, params *RetrieveTeamParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RetrieveVisitorWithUserId

func (c *Client) RetrieveVisitorWithUserId(ctx context.Context, params *RetrieveVisitorWithUserIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ScrollOverAllCompanies

func (c *Client) ScrollOverAllCompanies(ctx context.Context, params *ScrollOverAllCompaniesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SearchArticles

func (c *Client) SearchArticles(ctx context.Context, params *SearchArticlesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SearchContacts

func (c *Client) SearchContacts(ctx context.Context, params *SearchContactsParams, body SearchContactsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SearchContactsWithBody

func (c *Client) SearchContactsWithBody(ctx context.Context, params *SearchContactsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SearchConversations

func (c *Client) SearchConversations(ctx context.Context, params *SearchConversationsParams, body SearchConversationsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SearchConversationsWithBody

func (c *Client) SearchConversationsWithBody(ctx context.Context, params *SearchConversationsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SearchInternalArticles

func (c *Client) SearchInternalArticles(ctx context.Context, params *SearchInternalArticlesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SearchTickets

func (c *Client) SearchTickets(ctx context.Context, params *SearchTicketsParams, body SearchTicketsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SearchTicketsWithBody

func (c *Client) SearchTicketsWithBody(ctx context.Context, params *SearchTicketsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SetAwayAdmin

func (c *Client) SetAwayAdmin(ctx context.Context, adminId int, params *SetAwayAdminParams, body SetAwayAdminJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SetAwayAdminWithBody

func (c *Client) SetAwayAdminWithBody(ctx context.Context, adminId int, params *SetAwayAdminParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ShowCall

func (c *Client) ShowCall(ctx context.Context, callId string, params *ShowCallParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ShowCallRecording

func (c *Client) ShowCallRecording(ctx context.Context, callId string, params *ShowCallRecordingParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ShowCallTranscript

func (c *Client) ShowCallTranscript(ctx context.Context, callId string, params *ShowCallTranscriptParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ShowContact

func (c *Client) ShowContact(ctx context.Context, contactId string, params *ShowContactParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ShowContactByExternalId

func (c *Client) ShowContactByExternalId(ctx context.Context, externalId string, params *ShowContactByExternalIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) StartFinConversation

func (c *Client) StartFinConversation(ctx context.Context, params *StartFinConversationParams, body StartFinConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) StartFinConversationWithBody

func (c *Client) StartFinConversationWithBody(ctx context.Context, params *StartFinConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UnarchiveContact

func (c *Client) UnarchiveContact(ctx context.Context, contactId string, params *UnarchiveContactParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateArticle

func (c *Client) UpdateArticle(ctx context.Context, articleId int, params *UpdateArticleParams, body UpdateArticleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateArticleWithBody

func (c *Client) UpdateArticleWithBody(ctx context.Context, articleId int, params *UpdateArticleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateCollection

func (c *Client) UpdateCollection(ctx context.Context, collectionId int, params *UpdateCollectionParams, body UpdateCollectionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateCollectionWithBody

func (c *Client) UpdateCollectionWithBody(ctx context.Context, collectionId int, params *UpdateCollectionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateCompany

func (c *Client) UpdateCompany(ctx context.Context, companyId string, params *UpdateCompanyParams, body UpdateCompanyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateCompanyWithBody

func (c *Client) UpdateCompanyWithBody(ctx context.Context, companyId string, params *UpdateCompanyParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateContact

func (c *Client) UpdateContact(ctx context.Context, contactId string, params *UpdateContactParams, body UpdateContactJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateContactWithBody

func (c *Client) UpdateContactWithBody(ctx context.Context, contactId string, params *UpdateContactParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateContentImportSource

func (c *Client) UpdateContentImportSource(ctx context.Context, sourceId string, params *UpdateContentImportSourceParams, body UpdateContentImportSourceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateContentImportSourceWithBody

func (c *Client) UpdateContentImportSourceWithBody(ctx context.Context, sourceId string, params *UpdateContentImportSourceParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateConversation

func (c *Client) UpdateConversation(ctx context.Context, conversationId int, params *UpdateConversationParams, body UpdateConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateConversationWithBody

func (c *Client) UpdateConversationWithBody(ctx context.Context, conversationId int, params *UpdateConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateDataAttribute

func (c *Client) UpdateDataAttribute(ctx context.Context, dataAttributeId int, params *UpdateDataAttributeParams, body UpdateDataAttributeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateDataAttributeWithBody

func (c *Client) UpdateDataAttributeWithBody(ctx context.Context, dataAttributeId int, params *UpdateDataAttributeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateExternalPage

func (c *Client) UpdateExternalPage(ctx context.Context, pageId string, params *UpdateExternalPageParams, body UpdateExternalPageJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateExternalPageWithBody

func (c *Client) UpdateExternalPageWithBody(ctx context.Context, pageId string, params *UpdateExternalPageParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateInternalArticle

func (c *Client) UpdateInternalArticle(ctx context.Context, internalArticleId int, params *UpdateInternalArticleParams, body UpdateInternalArticleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateInternalArticleWithBody

func (c *Client) UpdateInternalArticleWithBody(ctx context.Context, internalArticleId int, params *UpdateInternalArticleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateIpAllowlist

func (c *Client) UpdateIpAllowlist(ctx context.Context, params *UpdateIpAllowlistParams, body UpdateIpAllowlistJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateIpAllowlistWithBody

func (c *Client) UpdateIpAllowlistWithBody(ctx context.Context, params *UpdateIpAllowlistParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateNewsItem

func (c *Client) UpdateNewsItem(ctx context.Context, newsItemId int, params *UpdateNewsItemParams, body UpdateNewsItemJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateNewsItemWithBody

func (c *Client) UpdateNewsItemWithBody(ctx context.Context, newsItemId int, params *UpdateNewsItemParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateTicket

func (c *Client) UpdateTicket(ctx context.Context, ticketId string, params *UpdateTicketParams, body UpdateTicketJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateTicketType

func (c *Client) UpdateTicketType(ctx context.Context, ticketTypeId string, params *UpdateTicketTypeParams, body UpdateTicketTypeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateTicketTypeAttribute

func (c *Client) UpdateTicketTypeAttribute(ctx context.Context, ticketTypeId string, attributeId string, params *UpdateTicketTypeAttributeParams, body UpdateTicketTypeAttributeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateTicketTypeAttributeWithBody

func (c *Client) UpdateTicketTypeAttributeWithBody(ctx context.Context, ticketTypeId string, attributeId string, params *UpdateTicketTypeAttributeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateTicketTypeWithBody

func (c *Client) UpdateTicketTypeWithBody(ctx context.Context, ticketTypeId string, params *UpdateTicketTypeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateTicketWithBody

func (c *Client) UpdateTicketWithBody(ctx context.Context, ticketId string, params *UpdateTicketParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateVisitor

func (c *Client) UpdateVisitor(ctx context.Context, params *UpdateVisitorParams, body UpdateVisitorJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateVisitorWithBody

func (c *Client) UpdateVisitorWithBody(ctx context.Context, params *UpdateVisitorParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface

type ClientInterface interface {
	// ListAdmins request
	ListAdmins(ctx context.Context, params *ListAdminsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListActivityLogs request
	ListActivityLogs(ctx context.Context, params *ListActivityLogsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RetrieveAdmin request
	RetrieveAdmin(ctx context.Context, adminId int, params *RetrieveAdminParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SetAwayAdminWithBody request with any body
	SetAwayAdminWithBody(ctx context.Context, adminId int, params *SetAwayAdminParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	SetAwayAdmin(ctx context.Context, adminId int, params *SetAwayAdminParams, body SetAwayAdminJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListContentImportSources request
	ListContentImportSources(ctx context.Context, params *ListContentImportSourcesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateContentImportSourceWithBody request with any body
	CreateContentImportSourceWithBody(ctx context.Context, params *CreateContentImportSourceParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateContentImportSource(ctx context.Context, params *CreateContentImportSourceParams, body CreateContentImportSourceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteContentImportSource request
	DeleteContentImportSource(ctx context.Context, sourceId string, params *DeleteContentImportSourceParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetContentImportSource request
	GetContentImportSource(ctx context.Context, sourceId string, params *GetContentImportSourceParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateContentImportSourceWithBody request with any body
	UpdateContentImportSourceWithBody(ctx context.Context, sourceId string, params *UpdateContentImportSourceParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateContentImportSource(ctx context.Context, sourceId string, params *UpdateContentImportSourceParams, body UpdateContentImportSourceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListExternalPages request
	ListExternalPages(ctx context.Context, params *ListExternalPagesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateExternalPageWithBody request with any body
	CreateExternalPageWithBody(ctx context.Context, params *CreateExternalPageParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateExternalPage(ctx context.Context, params *CreateExternalPageParams, body CreateExternalPageJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteExternalPage request
	DeleteExternalPage(ctx context.Context, pageId string, params *DeleteExternalPageParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetExternalPage request
	GetExternalPage(ctx context.Context, pageId string, params *GetExternalPageParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateExternalPageWithBody request with any body
	UpdateExternalPageWithBody(ctx context.Context, pageId string, params *UpdateExternalPageParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateExternalPage(ctx context.Context, pageId string, params *UpdateExternalPageParams, body UpdateExternalPageJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListArticles request
	ListArticles(ctx context.Context, params *ListArticlesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateArticleWithBody request with any body
	CreateArticleWithBody(ctx context.Context, params *CreateArticleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateArticle(ctx context.Context, params *CreateArticleParams, body CreateArticleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchArticles request
	SearchArticles(ctx context.Context, params *SearchArticlesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteArticle request
	DeleteArticle(ctx context.Context, articleId int, params *DeleteArticleParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RetrieveArticle request
	RetrieveArticle(ctx context.Context, articleId int, params *RetrieveArticleParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateArticleWithBody request with any body
	UpdateArticleWithBody(ctx context.Context, articleId int, params *UpdateArticleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateArticle(ctx context.Context, articleId int, params *UpdateArticleParams, body UpdateArticleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListAwayStatusReasons request
	ListAwayStatusReasons(ctx context.Context, params *ListAwayStatusReasonsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListBrands request
	ListBrands(ctx context.Context, params *ListBrandsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RetrieveBrand request
	RetrieveBrand(ctx context.Context, id string, params *RetrieveBrandParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListCalls request
	ListCalls(ctx context.Context, params *ListCallsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListCallsWithTranscriptsWithBody request with any body
	ListCallsWithTranscriptsWithBody(ctx context.Context, params *ListCallsWithTranscriptsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	ListCallsWithTranscripts(ctx context.Context, params *ListCallsWithTranscriptsParams, body ListCallsWithTranscriptsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ShowCall request
	ShowCall(ctx context.Context, callId string, params *ShowCallParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ShowCallRecording request
	ShowCallRecording(ctx context.Context, callId string, params *ShowCallRecordingParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ShowCallTranscript request
	ShowCallTranscript(ctx context.Context, callId string, params *ShowCallTranscriptParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RetrieveCompany request
	RetrieveCompany(ctx context.Context, params *RetrieveCompanyParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateOrUpdateCompanyWithBody request with any body
	CreateOrUpdateCompanyWithBody(ctx context.Context, params *CreateOrUpdateCompanyParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateOrUpdateCompany(ctx context.Context, params *CreateOrUpdateCompanyParams, body CreateOrUpdateCompanyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListAllCompanies request
	ListAllCompanies(ctx context.Context, params *ListAllCompaniesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ScrollOverAllCompanies request
	ScrollOverAllCompanies(ctx context.Context, params *ScrollOverAllCompaniesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteCompany request
	DeleteCompany(ctx context.Context, companyId string, params *DeleteCompanyParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RetrieveACompanyById request
	RetrieveACompanyById(ctx context.Context, companyId string, params *RetrieveACompanyByIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateCompanyWithBody request with any body
	UpdateCompanyWithBody(ctx context.Context, companyId string, params *UpdateCompanyParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateCompany(ctx context.Context, companyId string, params *UpdateCompanyParams, body UpdateCompanyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListAttachedContacts request
	ListAttachedContacts(ctx context.Context, companyId string, params *ListAttachedContactsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListCompanyNotes request
	ListCompanyNotes(ctx context.Context, companyId string, params *ListCompanyNotesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListAttachedSegmentsForCompanies request
	ListAttachedSegmentsForCompanies(ctx context.Context, companyId string, params *ListAttachedSegmentsForCompaniesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListContacts request
	ListContacts(ctx context.Context, params *ListContactsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateContactWithBody request with any body
	CreateContactWithBody(ctx context.Context, params *CreateContactParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateContact(ctx context.Context, params *CreateContactParams, body CreateContactJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ShowContactByExternalId request
	ShowContactByExternalId(ctx context.Context, externalId string, params *ShowContactByExternalIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// MergeContactWithBody request with any body
	MergeContactWithBody(ctx context.Context, params *MergeContactParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	MergeContact(ctx context.Context, params *MergeContactParams, body MergeContactJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchContactsWithBody request with any body
	SearchContactsWithBody(ctx context.Context, params *SearchContactsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	SearchContacts(ctx context.Context, params *SearchContactsParams, body SearchContactsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteContact request
	DeleteContact(ctx context.Context, contactId string, params *DeleteContactParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ShowContact request
	ShowContact(ctx context.Context, contactId string, params *ShowContactParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateContactWithBody request with any body
	UpdateContactWithBody(ctx context.Context, contactId string, params *UpdateContactParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateContact(ctx context.Context, contactId string, params *UpdateContactParams, body UpdateContactJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ArchiveContact request
	ArchiveContact(ctx context.Context, contactId string, params *ArchiveContactParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BlockContact request
	BlockContact(ctx context.Context, contactId string, params *BlockContactParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListCompaniesForAContact request
	ListCompaniesForAContact(ctx context.Context, contactId string, params *ListCompaniesForAContactParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AttachContactToACompanyWithBody request with any body
	AttachContactToACompanyWithBody(ctx context.Context, contactId string, params *AttachContactToACompanyParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	AttachContactToACompany(ctx context.Context, contactId string, params *AttachContactToACompanyParams, body AttachContactToACompanyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DetachContactFromACompany request
	DetachContactFromACompany(ctx context.Context, contactId string, companyId string, params *DetachContactFromACompanyParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListNotes request
	ListNotes(ctx context.Context, contactId string, params *ListNotesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateNoteWithBody request with any body
	CreateNoteWithBody(ctx context.Context, contactId int, params *CreateNoteParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateNote(ctx context.Context, contactId int, params *CreateNoteParams, body CreateNoteJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListSegmentsForAContact request
	ListSegmentsForAContact(ctx context.Context, contactId string, params *ListSegmentsForAContactParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListSubscriptionsForAContact request
	ListSubscriptionsForAContact(ctx context.Context, contactId string, params *ListSubscriptionsForAContactParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AttachSubscriptionTypeToContactWithBody request with any body
	AttachSubscriptionTypeToContactWithBody(ctx context.Context, contactId string, params *AttachSubscriptionTypeToContactParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	AttachSubscriptionTypeToContact(ctx context.Context, contactId string, params *AttachSubscriptionTypeToContactParams, body AttachSubscriptionTypeToContactJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DetachSubscriptionTypeToContact request
	DetachSubscriptionTypeToContact(ctx context.Context, contactId string, subscriptionId string, params *DetachSubscriptionTypeToContactParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListTagsForAContact request
	ListTagsForAContact(ctx context.Context, contactId string, params *ListTagsForAContactParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AttachTagToContactWithBody request with any body
	AttachTagToContactWithBody(ctx context.Context, contactId string, params *AttachTagToContactParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	AttachTagToContact(ctx context.Context, contactId string, params *AttachTagToContactParams, body AttachTagToContactJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DetachTagFromContact request
	DetachTagFromContact(ctx context.Context, contactId string, tagId string, params *DetachTagFromContactParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UnarchiveContact request
	UnarchiveContact(ctx context.Context, contactId string, params *UnarchiveContactParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListConversations request
	ListConversations(ctx context.Context, params *ListConversationsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateConversationWithBody request with any body
	CreateConversationWithBody(ctx context.Context, params *CreateConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateConversation(ctx context.Context, params *CreateConversationParams, body CreateConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RedactConversationWithBody request with any body
	RedactConversationWithBody(ctx context.Context, params *RedactConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	RedactConversation(ctx context.Context, params *RedactConversationParams, body RedactConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchConversationsWithBody request with any body
	SearchConversationsWithBody(ctx context.Context, params *SearchConversationsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	SearchConversations(ctx context.Context, params *SearchConversationsParams, body SearchConversationsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteConversation request
	DeleteConversation(ctx context.Context, conversationId int, params *DeleteConversationParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RetrieveConversation request
	RetrieveConversation(ctx context.Context, conversationId int, params *RetrieveConversationParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateConversationWithBody request with any body
	UpdateConversationWithBody(ctx context.Context, conversationId int, params *UpdateConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateConversation(ctx context.Context, conversationId int, params *UpdateConversationParams, body UpdateConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ConvertConversationToTicketWithBody request with any body
	ConvertConversationToTicketWithBody(ctx context.Context, conversationId int, params *ConvertConversationToTicketParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	ConvertConversationToTicket(ctx context.Context, conversationId int, params *ConvertConversationToTicketParams, body ConvertConversationToTicketJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AttachContactToConversationWithBody request with any body
	AttachContactToConversationWithBody(ctx context.Context, conversationId string, params *AttachContactToConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	AttachContactToConversation(ctx context.Context, conversationId string, params *AttachContactToConversationParams, body AttachContactToConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DetachContactFromConversationWithBody request with any body
	DetachContactFromConversationWithBody(ctx context.Context, conversationId string, contactId string, params *DetachContactFromConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	DetachContactFromConversation(ctx context.Context, conversationId string, contactId string, params *DetachContactFromConversationParams, body DetachContactFromConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ManageConversationWithBody request with any body
	ManageConversationWithBody(ctx context.Context, conversationId string, params *ManageConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	ManageConversation(ctx context.Context, conversationId string, params *ManageConversationParams, body ManageConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ReplyConversationWithBody request with any body
	ReplyConversationWithBody(ctx context.Context, conversationId string, params *ReplyConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	ReplyConversation(ctx context.Context, conversationId string, params *ReplyConversationParams, body ReplyConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AttachTagToConversationWithBody request with any body
	AttachTagToConversationWithBody(ctx context.Context, conversationId string, params *AttachTagToConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	AttachTagToConversation(ctx context.Context, conversationId string, params *AttachTagToConversationParams, body AttachTagToConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DetachTagFromConversationWithBody request with any body
	DetachTagFromConversationWithBody(ctx context.Context, conversationId string, tagId string, params *DetachTagFromConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	DetachTagFromConversation(ctx context.Context, conversationId string, tagId string, params *DetachTagFromConversationParams, body DetachTagFromConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListHandlingEvents request
	ListHandlingEvents(ctx context.Context, id string, params *ListHandlingEventsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteCustomObjectInstancesById request
	DeleteCustomObjectInstancesById(ctx context.Context, customObjectTypeIdentifier string, params *DeleteCustomObjectInstancesByIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetCustomObjectInstancesByExternalId request
	GetCustomObjectInstancesByExternalId(ctx context.Context, customObjectTypeIdentifier string, params *GetCustomObjectInstancesByExternalIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateCustomObjectInstancesWithBody request with any body
	CreateCustomObjectInstancesWithBody(ctx context.Context, customObjectTypeIdentifier string, params *CreateCustomObjectInstancesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateCustomObjectInstances(ctx context.Context, customObjectTypeIdentifier string, params *CreateCustomObjectInstancesParams, body CreateCustomObjectInstancesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteCustomObjectInstancesByExternalId request
	DeleteCustomObjectInstancesByExternalId(ctx context.Context, customObjectTypeIdentifier string, customObjectInstanceId string, params *DeleteCustomObjectInstancesByExternalIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetCustomObjectInstancesById request
	GetCustomObjectInstancesById(ctx context.Context, customObjectTypeIdentifier string, customObjectInstanceId string, params *GetCustomObjectInstancesByIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// LisDataAttributes request
	LisDataAttributes(ctx context.Context, params *LisDataAttributesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateDataAttributeWithBody request with any body
	CreateDataAttributeWithBody(ctx context.Context, params *CreateDataAttributeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateDataAttribute(ctx context.Context, params *CreateDataAttributeParams, body CreateDataAttributeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateDataAttributeWithBody request with any body
	UpdateDataAttributeWithBody(ctx context.Context, dataAttributeId int, params *UpdateDataAttributeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateDataAttribute(ctx context.Context, dataAttributeId int, params *UpdateDataAttributeParams, body UpdateDataAttributeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DownloadDataExport request
	DownloadDataExport(ctx context.Context, jobIdentifier string, params *DownloadDataExportParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetDownloadReportingDataJobIdentifier request
	GetDownloadReportingDataJobIdentifier(ctx context.Context, jobIdentifier string, params *GetDownloadReportingDataJobIdentifierParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListEmails request
	ListEmails(ctx context.Context, params *ListEmailsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RetrieveEmail request
	RetrieveEmail(ctx context.Context, id string, params *RetrieveEmailParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// LisDataEvents request
	LisDataEvents(ctx context.Context, params *LisDataEventsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateDataEventWithBody request with any body
	CreateDataEventWithBody(ctx context.Context, params *CreateDataEventParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateDataEvent(ctx context.Context, params *CreateDataEventParams, body CreateDataEventJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DataEventSummariesWithBody request with any body
	DataEventSummariesWithBody(ctx context.Context, params *DataEventSummariesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	DataEventSummaries(ctx context.Context, params *DataEventSummariesParams, body DataEventSummariesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CancelDataExport request
	CancelDataExport(ctx context.Context, jobIdentifier string, params *CancelDataExportParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateDataExportWithBody request with any body
	CreateDataExportWithBody(ctx context.Context, params *CreateDataExportParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateDataExport(ctx context.Context, params *CreateDataExportParams, body CreateDataExportJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetDataExport request
	GetDataExport(ctx context.Context, jobIdentifier string, params *GetDataExportParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostExportReportingDataEnqueueWithBody request with any body
	PostExportReportingDataEnqueueWithBody(ctx context.Context, params *PostExportReportingDataEnqueueParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostExportReportingDataEnqueue(ctx context.Context, params *PostExportReportingDataEnqueueParams, body PostExportReportingDataEnqueueJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetExportReportingDataGetDatasets request
	GetExportReportingDataGetDatasets(ctx context.Context, params *GetExportReportingDataGetDatasetsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetExportReportingDataJobIdentifier request
	GetExportReportingDataJobIdentifier(ctx context.Context, jobIdentifier string, params *GetExportReportingDataJobIdentifierParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ExportWorkflow request
	ExportWorkflow(ctx context.Context, id string, params *ExportWorkflowParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ReplyToFinWithBody request with any body
	ReplyToFinWithBody(ctx context.Context, params *ReplyToFinParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	ReplyToFin(ctx context.Context, params *ReplyToFinParams, body ReplyToFinJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// StartFinConversationWithBody request with any body
	StartFinConversationWithBody(ctx context.Context, params *StartFinConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	StartFinConversation(ctx context.Context, params *StartFinConversationParams, body StartFinConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CollectFinVoiceCallById request
	CollectFinVoiceCallById(ctx context.Context, id int, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CollectFinVoiceCallsByConversationId request
	CollectFinVoiceCallsByConversationId(ctx context.Context, conversationId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CollectFinVoiceCallByExternalId request
	CollectFinVoiceCallByExternalId(ctx context.Context, externalId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CollectFinVoiceCallByPhoneNumber request
	CollectFinVoiceCallByPhoneNumber(ctx context.Context, phoneNumber string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RegisterFinVoiceCallWithBody request with any body
	RegisterFinVoiceCallWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	RegisterFinVoiceCall(ctx context.Context, body RegisterFinVoiceCallJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListAllCollections request
	ListAllCollections(ctx context.Context, params *ListAllCollectionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateCollectionWithBody request with any body
	CreateCollectionWithBody(ctx context.Context, params *CreateCollectionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateCollection(ctx context.Context, params *CreateCollectionParams, body CreateCollectionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteCollection request
	DeleteCollection(ctx context.Context, collectionId int, params *DeleteCollectionParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RetrieveCollection request
	RetrieveCollection(ctx context.Context, collectionId int, params *RetrieveCollectionParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateCollectionWithBody request with any body
	UpdateCollectionWithBody(ctx context.Context, collectionId int, params *UpdateCollectionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateCollection(ctx context.Context, collectionId int, params *UpdateCollectionParams, body UpdateCollectionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListHelpCenters request
	ListHelpCenters(ctx context.Context, params *ListHelpCentersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RetrieveHelpCenter request
	RetrieveHelpCenter(ctx context.Context, helpCenterId int, params *RetrieveHelpCenterParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListInternalArticles request
	ListInternalArticles(ctx context.Context, params *ListInternalArticlesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateInternalArticleWithBody request with any body
	CreateInternalArticleWithBody(ctx context.Context, params *CreateInternalArticleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateInternalArticle(ctx context.Context, params *CreateInternalArticleParams, body CreateInternalArticleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchInternalArticles request
	SearchInternalArticles(ctx context.Context, params *SearchInternalArticlesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteInternalArticle request
	DeleteInternalArticle(ctx context.Context, internalArticleId int, params *DeleteInternalArticleParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RetrieveInternalArticle request
	RetrieveInternalArticle(ctx context.Context, internalArticleId int, params *RetrieveInternalArticleParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateInternalArticleWithBody request with any body
	UpdateInternalArticleWithBody(ctx context.Context, internalArticleId int, params *UpdateInternalArticleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateInternalArticle(ctx context.Context, internalArticleId int, params *UpdateInternalArticleParams, body UpdateInternalArticleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetIpAllowlist request
	GetIpAllowlist(ctx context.Context, params *GetIpAllowlistParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateIpAllowlistWithBody request with any body
	UpdateIpAllowlistWithBody(ctx context.Context, params *UpdateIpAllowlistParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateIpAllowlist(ctx context.Context, params *UpdateIpAllowlistParams, body UpdateIpAllowlistJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// JobsStatus request
	JobsStatus(ctx context.Context, jobId string, params *JobsStatusParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// IdentifyAdmin request
	IdentifyAdmin(ctx context.Context, params *IdentifyAdminParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateMessageWithBody request with any body
	CreateMessageWithBody(ctx context.Context, params *CreateMessageParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateMessage(ctx context.Context, params *CreateMessageParams, body CreateMessageJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListNewsItems request
	ListNewsItems(ctx context.Context, params *ListNewsItemsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateNewsItemWithBody request with any body
	CreateNewsItemWithBody(ctx context.Context, params *CreateNewsItemParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateNewsItem(ctx context.Context, params *CreateNewsItemParams, body CreateNewsItemJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteNewsItem request
	DeleteNewsItem(ctx context.Context, newsItemId int, params *DeleteNewsItemParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RetrieveNewsItem request
	RetrieveNewsItem(ctx context.Context, newsItemId int, params *RetrieveNewsItemParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateNewsItemWithBody request with any body
	UpdateNewsItemWithBody(ctx context.Context, newsItemId int, params *UpdateNewsItemParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateNewsItem(ctx context.Context, newsItemId int, params *UpdateNewsItemParams, body UpdateNewsItemJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListNewsfeeds request
	ListNewsfeeds(ctx context.Context, params *ListNewsfeedsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RetrieveNewsfeed request
	RetrieveNewsfeed(ctx context.Context, newsfeedId string, params *RetrieveNewsfeedParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListLiveNewsfeedItems request
	ListLiveNewsfeedItems(ctx context.Context, newsfeedId string, params *ListLiveNewsfeedItemsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RetrieveNote request
	RetrieveNote(ctx context.Context, noteId int, params *RetrieveNoteParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreatePhoneSwitchWithBody request with any body
	CreatePhoneSwitchWithBody(ctx context.Context, params *CreatePhoneSwitchParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreatePhoneSwitch(ctx context.Context, params *CreatePhoneSwitchParams, body CreatePhoneSwitchJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListSegments request
	ListSegments(ctx context.Context, params *ListSegmentsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RetrieveSegment request
	RetrieveSegment(ctx context.Context, segmentId string, params *RetrieveSegmentParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListSubscriptionTypes request
	ListSubscriptionTypes(ctx context.Context, params *ListSubscriptionTypesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListTags request
	ListTags(ctx context.Context, params *ListTagsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateTagWithBody request with any body
	CreateTagWithBody(ctx context.Context, params *CreateTagParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateTag(ctx context.Context, params *CreateTagParams, body CreateTagJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteTag request
	DeleteTag(ctx context.Context, tagId string, params *DeleteTagParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// FindTag request
	FindTag(ctx context.Context, tagId string, params *FindTagParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListTeams request
	ListTeams(ctx context.Context, params *ListTeamsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RetrieveTeam request
	RetrieveTeam(ctx context.Context, teamId string, params *RetrieveTeamParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListTicketStates request
	ListTicketStates(ctx context.Context, params *ListTicketStatesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListTicketTypes request
	ListTicketTypes(ctx context.Context, params *ListTicketTypesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateTicketTypeWithBody request with any body
	CreateTicketTypeWithBody(ctx context.Context, params *CreateTicketTypeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateTicketType(ctx context.Context, params *CreateTicketTypeParams, body CreateTicketTypeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetTicketType request
	GetTicketType(ctx context.Context, ticketTypeId string, params *GetTicketTypeParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateTicketTypeWithBody request with any body
	UpdateTicketTypeWithBody(ctx context.Context, ticketTypeId string, params *UpdateTicketTypeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateTicketType(ctx context.Context, ticketTypeId string, params *UpdateTicketTypeParams, body UpdateTicketTypeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateTicketTypeAttributeWithBody request with any body
	CreateTicketTypeAttributeWithBody(ctx context.Context, ticketTypeId string, params *CreateTicketTypeAttributeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateTicketTypeAttribute(ctx context.Context, ticketTypeId string, params *CreateTicketTypeAttributeParams, body CreateTicketTypeAttributeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateTicketTypeAttributeWithBody request with any body
	UpdateTicketTypeAttributeWithBody(ctx context.Context, ticketTypeId string, attributeId string, params *UpdateTicketTypeAttributeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateTicketTypeAttribute(ctx context.Context, ticketTypeId string, attributeId string, params *UpdateTicketTypeAttributeParams, body UpdateTicketTypeAttributeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateTicketWithBody request with any body
	CreateTicketWithBody(ctx context.Context, params *CreateTicketParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateTicket(ctx context.Context, params *CreateTicketParams, body CreateTicketJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// EnqueueCreateTicketWithBody request with any body
	EnqueueCreateTicketWithBody(ctx context.Context, params *EnqueueCreateTicketParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	EnqueueCreateTicket(ctx context.Context, params *EnqueueCreateTicketParams, body EnqueueCreateTicketJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchTicketsWithBody request with any body
	SearchTicketsWithBody(ctx context.Context, params *SearchTicketsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	SearchTickets(ctx context.Context, params *SearchTicketsParams, body SearchTicketsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteTicket request
	DeleteTicket(ctx context.Context, ticketId string, params *DeleteTicketParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetTicket request
	GetTicket(ctx context.Context, ticketId string, params *GetTicketParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateTicketWithBody request with any body
	UpdateTicketWithBody(ctx context.Context, ticketId string, params *UpdateTicketParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateTicket(ctx context.Context, ticketId string, params *UpdateTicketParams, body UpdateTicketJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ReplyTicketWithBody request with any body
	ReplyTicketWithBody(ctx context.Context, ticketId string, params *ReplyTicketParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	ReplyTicket(ctx context.Context, ticketId string, params *ReplyTicketParams, body ReplyTicketJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AttachTagToTicketWithBody request with any body
	AttachTagToTicketWithBody(ctx context.Context, ticketId string, params *AttachTagToTicketParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	AttachTagToTicket(ctx context.Context, ticketId string, params *AttachTagToTicketParams, body AttachTagToTicketJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DetachTagFromTicketWithBody request with any body
	DetachTagFromTicketWithBody(ctx context.Context, ticketId string, tagId string, params *DetachTagFromTicketParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	DetachTagFromTicket(ctx context.Context, ticketId string, tagId string, params *DetachTagFromTicketParams, body DetachTagFromTicketJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RetrieveVisitorWithUserId request
	RetrieveVisitorWithUserId(ctx context.Context, params *RetrieveVisitorWithUserIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateVisitorWithBody request with any body
	UpdateVisitorWithBody(ctx context.Context, params *UpdateVisitorParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateVisitor(ctx context.Context, params *UpdateVisitorParams, body UpdateVisitorJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ConvertVisitorWithBody request with any body
	ConvertVisitorWithBody(ctx context.Context, params *ConvertVisitorParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	ConvertVisitor(ctx context.Context, params *ConvertVisitorParams, body ConvertVisitorJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) ArchiveContactWithResponse

func (c *ClientWithResponses) ArchiveContactWithResponse(ctx context.Context, contactId string, params *ArchiveContactParams, reqEditors ...RequestEditorFn) (*ArchiveContactResponse, error)

ArchiveContactWithResponse request returning *ArchiveContactResponse

func (*ClientWithResponses) AttachContactToACompanyWithBodyWithResponse

func (c *ClientWithResponses) AttachContactToACompanyWithBodyWithResponse(ctx context.Context, contactId string, params *AttachContactToACompanyParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AttachContactToACompanyResponse, error)

AttachContactToACompanyWithBodyWithResponse request with arbitrary body returning *AttachContactToACompanyResponse

func (*ClientWithResponses) AttachContactToACompanyWithResponse

func (c *ClientWithResponses) AttachContactToACompanyWithResponse(ctx context.Context, contactId string, params *AttachContactToACompanyParams, body AttachContactToACompanyJSONRequestBody, reqEditors ...RequestEditorFn) (*AttachContactToACompanyResponse, error)

func (*ClientWithResponses) AttachContactToConversationWithBodyWithResponse

func (c *ClientWithResponses) AttachContactToConversationWithBodyWithResponse(ctx context.Context, conversationId string, params *AttachContactToConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AttachContactToConversationResponse, error)

AttachContactToConversationWithBodyWithResponse request with arbitrary body returning *AttachContactToConversationResponse

func (*ClientWithResponses) AttachContactToConversationWithResponse

func (c *ClientWithResponses) AttachContactToConversationWithResponse(ctx context.Context, conversationId string, params *AttachContactToConversationParams, body AttachContactToConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*AttachContactToConversationResponse, error)

func (*ClientWithResponses) AttachSubscriptionTypeToContactWithBodyWithResponse

func (c *ClientWithResponses) AttachSubscriptionTypeToContactWithBodyWithResponse(ctx context.Context, contactId string, params *AttachSubscriptionTypeToContactParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AttachSubscriptionTypeToContactResponse, error)

AttachSubscriptionTypeToContactWithBodyWithResponse request with arbitrary body returning *AttachSubscriptionTypeToContactResponse

func (*ClientWithResponses) AttachTagToContactWithBodyWithResponse

func (c *ClientWithResponses) AttachTagToContactWithBodyWithResponse(ctx context.Context, contactId string, params *AttachTagToContactParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AttachTagToContactResponse, error)

AttachTagToContactWithBodyWithResponse request with arbitrary body returning *AttachTagToContactResponse

func (*ClientWithResponses) AttachTagToContactWithResponse

func (c *ClientWithResponses) AttachTagToContactWithResponse(ctx context.Context, contactId string, params *AttachTagToContactParams, body AttachTagToContactJSONRequestBody, reqEditors ...RequestEditorFn) (*AttachTagToContactResponse, error)

func (*ClientWithResponses) AttachTagToConversationWithBodyWithResponse

func (c *ClientWithResponses) AttachTagToConversationWithBodyWithResponse(ctx context.Context, conversationId string, params *AttachTagToConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AttachTagToConversationResponse, error)

AttachTagToConversationWithBodyWithResponse request with arbitrary body returning *AttachTagToConversationResponse

func (*ClientWithResponses) AttachTagToConversationWithResponse

func (c *ClientWithResponses) AttachTagToConversationWithResponse(ctx context.Context, conversationId string, params *AttachTagToConversationParams, body AttachTagToConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*AttachTagToConversationResponse, error)

func (*ClientWithResponses) AttachTagToTicketWithBodyWithResponse

func (c *ClientWithResponses) AttachTagToTicketWithBodyWithResponse(ctx context.Context, ticketId string, params *AttachTagToTicketParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AttachTagToTicketResponse, error)

AttachTagToTicketWithBodyWithResponse request with arbitrary body returning *AttachTagToTicketResponse

func (*ClientWithResponses) AttachTagToTicketWithResponse

func (c *ClientWithResponses) AttachTagToTicketWithResponse(ctx context.Context, ticketId string, params *AttachTagToTicketParams, body AttachTagToTicketJSONRequestBody, reqEditors ...RequestEditorFn) (*AttachTagToTicketResponse, error)

func (*ClientWithResponses) BlockContactWithResponse

func (c *ClientWithResponses) BlockContactWithResponse(ctx context.Context, contactId string, params *BlockContactParams, reqEditors ...RequestEditorFn) (*BlockContactResponse, error)

BlockContactWithResponse request returning *BlockContactResponse

func (*ClientWithResponses) CancelDataExportWithResponse

func (c *ClientWithResponses) CancelDataExportWithResponse(ctx context.Context, jobIdentifier string, params *CancelDataExportParams, reqEditors ...RequestEditorFn) (*CancelDataExportResponse, error)

CancelDataExportWithResponse request returning *CancelDataExportResponse

func (*ClientWithResponses) CollectFinVoiceCallByExternalIdWithResponse

func (c *ClientWithResponses) CollectFinVoiceCallByExternalIdWithResponse(ctx context.Context, externalId string, reqEditors ...RequestEditorFn) (*CollectFinVoiceCallByExternalIdResponse, error)

CollectFinVoiceCallByExternalIdWithResponse request returning *CollectFinVoiceCallByExternalIdResponse

func (*ClientWithResponses) CollectFinVoiceCallByIdWithResponse

func (c *ClientWithResponses) CollectFinVoiceCallByIdWithResponse(ctx context.Context, id int, reqEditors ...RequestEditorFn) (*CollectFinVoiceCallByIdResponse, error)

CollectFinVoiceCallByIdWithResponse request returning *CollectFinVoiceCallByIdResponse

func (*ClientWithResponses) CollectFinVoiceCallByPhoneNumberWithResponse

func (c *ClientWithResponses) CollectFinVoiceCallByPhoneNumberWithResponse(ctx context.Context, phoneNumber string, reqEditors ...RequestEditorFn) (*CollectFinVoiceCallByPhoneNumberResponse, error)

CollectFinVoiceCallByPhoneNumberWithResponse request returning *CollectFinVoiceCallByPhoneNumberResponse

func (*ClientWithResponses) CollectFinVoiceCallsByConversationIdWithResponse

func (c *ClientWithResponses) CollectFinVoiceCallsByConversationIdWithResponse(ctx context.Context, conversationId string, reqEditors ...RequestEditorFn) (*CollectFinVoiceCallsByConversationIdResponse, error)

CollectFinVoiceCallsByConversationIdWithResponse request returning *CollectFinVoiceCallsByConversationIdResponse

func (*ClientWithResponses) ConvertConversationToTicketWithBodyWithResponse

func (c *ClientWithResponses) ConvertConversationToTicketWithBodyWithResponse(ctx context.Context, conversationId int, params *ConvertConversationToTicketParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ConvertConversationToTicketResponse, error)

ConvertConversationToTicketWithBodyWithResponse request with arbitrary body returning *ConvertConversationToTicketResponse

func (*ClientWithResponses) ConvertConversationToTicketWithResponse

func (c *ClientWithResponses) ConvertConversationToTicketWithResponse(ctx context.Context, conversationId int, params *ConvertConversationToTicketParams, body ConvertConversationToTicketJSONRequestBody, reqEditors ...RequestEditorFn) (*ConvertConversationToTicketResponse, error)

func (*ClientWithResponses) ConvertVisitorWithBodyWithResponse

func (c *ClientWithResponses) ConvertVisitorWithBodyWithResponse(ctx context.Context, params *ConvertVisitorParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ConvertVisitorResponse, error)

ConvertVisitorWithBodyWithResponse request with arbitrary body returning *ConvertVisitorResponse

func (*ClientWithResponses) ConvertVisitorWithResponse

func (c *ClientWithResponses) ConvertVisitorWithResponse(ctx context.Context, params *ConvertVisitorParams, body ConvertVisitorJSONRequestBody, reqEditors ...RequestEditorFn) (*ConvertVisitorResponse, error)

func (*ClientWithResponses) CreateArticleWithBodyWithResponse

func (c *ClientWithResponses) CreateArticleWithBodyWithResponse(ctx context.Context, params *CreateArticleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateArticleResponse, error)

CreateArticleWithBodyWithResponse request with arbitrary body returning *CreateArticleResponse

func (*ClientWithResponses) CreateArticleWithResponse

func (c *ClientWithResponses) CreateArticleWithResponse(ctx context.Context, params *CreateArticleParams, body CreateArticleJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateArticleResponse, error)

func (*ClientWithResponses) CreateCollectionWithBodyWithResponse

func (c *ClientWithResponses) CreateCollectionWithBodyWithResponse(ctx context.Context, params *CreateCollectionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateCollectionResponse, error)

CreateCollectionWithBodyWithResponse request with arbitrary body returning *CreateCollectionResponse

func (*ClientWithResponses) CreateCollectionWithResponse

func (c *ClientWithResponses) CreateCollectionWithResponse(ctx context.Context, params *CreateCollectionParams, body CreateCollectionJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateCollectionResponse, error)

func (*ClientWithResponses) CreateContactWithBodyWithResponse

func (c *ClientWithResponses) CreateContactWithBodyWithResponse(ctx context.Context, params *CreateContactParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateContactResponse, error)

CreateContactWithBodyWithResponse request with arbitrary body returning *CreateContactResponse

func (*ClientWithResponses) CreateContactWithResponse

func (c *ClientWithResponses) CreateContactWithResponse(ctx context.Context, params *CreateContactParams, body CreateContactJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateContactResponse, error)

func (*ClientWithResponses) CreateContentImportSourceWithBodyWithResponse

func (c *ClientWithResponses) CreateContentImportSourceWithBodyWithResponse(ctx context.Context, params *CreateContentImportSourceParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateContentImportSourceResponse, error)

CreateContentImportSourceWithBodyWithResponse request with arbitrary body returning *CreateContentImportSourceResponse

func (*ClientWithResponses) CreateConversationWithBodyWithResponse

func (c *ClientWithResponses) CreateConversationWithBodyWithResponse(ctx context.Context, params *CreateConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateConversationResponse, error)

CreateConversationWithBodyWithResponse request with arbitrary body returning *CreateConversationResponse

func (*ClientWithResponses) CreateConversationWithResponse

func (*ClientWithResponses) CreateCustomObjectInstancesWithBodyWithResponse

func (c *ClientWithResponses) CreateCustomObjectInstancesWithBodyWithResponse(ctx context.Context, customObjectTypeIdentifier string, params *CreateCustomObjectInstancesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateCustomObjectInstancesResponse, error)

CreateCustomObjectInstancesWithBodyWithResponse request with arbitrary body returning *CreateCustomObjectInstancesResponse

func (*ClientWithResponses) CreateCustomObjectInstancesWithResponse

func (c *ClientWithResponses) CreateCustomObjectInstancesWithResponse(ctx context.Context, customObjectTypeIdentifier string, params *CreateCustomObjectInstancesParams, body CreateCustomObjectInstancesJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateCustomObjectInstancesResponse, error)

func (*ClientWithResponses) CreateDataAttributeWithBodyWithResponse

func (c *ClientWithResponses) CreateDataAttributeWithBodyWithResponse(ctx context.Context, params *CreateDataAttributeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDataAttributeResponse, error)

CreateDataAttributeWithBodyWithResponse request with arbitrary body returning *CreateDataAttributeResponse

func (*ClientWithResponses) CreateDataAttributeWithResponse

func (*ClientWithResponses) CreateDataEventWithBodyWithResponse

func (c *ClientWithResponses) CreateDataEventWithBodyWithResponse(ctx context.Context, params *CreateDataEventParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDataEventResponse, error)

CreateDataEventWithBodyWithResponse request with arbitrary body returning *CreateDataEventResponse

func (*ClientWithResponses) CreateDataEventWithResponse

func (c *ClientWithResponses) CreateDataEventWithResponse(ctx context.Context, params *CreateDataEventParams, body CreateDataEventJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateDataEventResponse, error)

func (*ClientWithResponses) CreateDataExportWithBodyWithResponse

func (c *ClientWithResponses) CreateDataExportWithBodyWithResponse(ctx context.Context, params *CreateDataExportParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDataExportResponse, error)

CreateDataExportWithBodyWithResponse request with arbitrary body returning *CreateDataExportResponse

func (*ClientWithResponses) CreateDataExportWithResponse

func (c *ClientWithResponses) CreateDataExportWithResponse(ctx context.Context, params *CreateDataExportParams, body CreateDataExportJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateDataExportResponse, error)

func (*ClientWithResponses) CreateExternalPageWithBodyWithResponse

func (c *ClientWithResponses) CreateExternalPageWithBodyWithResponse(ctx context.Context, params *CreateExternalPageParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateExternalPageResponse, error)

CreateExternalPageWithBodyWithResponse request with arbitrary body returning *CreateExternalPageResponse

func (*ClientWithResponses) CreateExternalPageWithResponse

func (*ClientWithResponses) CreateInternalArticleWithBodyWithResponse

func (c *ClientWithResponses) CreateInternalArticleWithBodyWithResponse(ctx context.Context, params *CreateInternalArticleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateInternalArticleResponse, error)

CreateInternalArticleWithBodyWithResponse request with arbitrary body returning *CreateInternalArticleResponse

func (*ClientWithResponses) CreateInternalArticleWithResponse

func (*ClientWithResponses) CreateMessageWithBodyWithResponse

func (c *ClientWithResponses) CreateMessageWithBodyWithResponse(ctx context.Context, params *CreateMessageParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateMessageResponse, error)

CreateMessageWithBodyWithResponse request with arbitrary body returning *CreateMessageResponse

func (*ClientWithResponses) CreateMessageWithResponse

func (c *ClientWithResponses) CreateMessageWithResponse(ctx context.Context, params *CreateMessageParams, body CreateMessageJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateMessageResponse, error)

func (*ClientWithResponses) CreateNewsItemWithBodyWithResponse

func (c *ClientWithResponses) CreateNewsItemWithBodyWithResponse(ctx context.Context, params *CreateNewsItemParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateNewsItemResponse, error)

CreateNewsItemWithBodyWithResponse request with arbitrary body returning *CreateNewsItemResponse

func (*ClientWithResponses) CreateNewsItemWithResponse

func (c *ClientWithResponses) CreateNewsItemWithResponse(ctx context.Context, params *CreateNewsItemParams, body CreateNewsItemJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateNewsItemResponse, error)

func (*ClientWithResponses) CreateNoteWithBodyWithResponse

func (c *ClientWithResponses) CreateNoteWithBodyWithResponse(ctx context.Context, contactId int, params *CreateNoteParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateNoteResponse, error)

CreateNoteWithBodyWithResponse request with arbitrary body returning *CreateNoteResponse

func (*ClientWithResponses) CreateNoteWithResponse

func (c *ClientWithResponses) CreateNoteWithResponse(ctx context.Context, contactId int, params *CreateNoteParams, body CreateNoteJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateNoteResponse, error)

func (*ClientWithResponses) CreateOrUpdateCompanyWithBodyWithResponse

func (c *ClientWithResponses) CreateOrUpdateCompanyWithBodyWithResponse(ctx context.Context, params *CreateOrUpdateCompanyParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateOrUpdateCompanyResponse, error)

CreateOrUpdateCompanyWithBodyWithResponse request with arbitrary body returning *CreateOrUpdateCompanyResponse

func (*ClientWithResponses) CreateOrUpdateCompanyWithResponse

func (*ClientWithResponses) CreatePhoneSwitchWithBodyWithResponse

func (c *ClientWithResponses) CreatePhoneSwitchWithBodyWithResponse(ctx context.Context, params *CreatePhoneSwitchParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreatePhoneSwitchResponse, error)

CreatePhoneSwitchWithBodyWithResponse request with arbitrary body returning *CreatePhoneSwitchResponse

func (*ClientWithResponses) CreatePhoneSwitchWithResponse

func (*ClientWithResponses) CreateTagWithBodyWithResponse

func (c *ClientWithResponses) CreateTagWithBodyWithResponse(ctx context.Context, params *CreateTagParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateTagResponse, error)

CreateTagWithBodyWithResponse request with arbitrary body returning *CreateTagResponse

func (*ClientWithResponses) CreateTagWithResponse

func (c *ClientWithResponses) CreateTagWithResponse(ctx context.Context, params *CreateTagParams, body CreateTagJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateTagResponse, error)

func (*ClientWithResponses) CreateTicketTypeAttributeWithBodyWithResponse

func (c *ClientWithResponses) CreateTicketTypeAttributeWithBodyWithResponse(ctx context.Context, ticketTypeId string, params *CreateTicketTypeAttributeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateTicketTypeAttributeResponse, error)

CreateTicketTypeAttributeWithBodyWithResponse request with arbitrary body returning *CreateTicketTypeAttributeResponse

func (*ClientWithResponses) CreateTicketTypeAttributeWithResponse

func (c *ClientWithResponses) CreateTicketTypeAttributeWithResponse(ctx context.Context, ticketTypeId string, params *CreateTicketTypeAttributeParams, body CreateTicketTypeAttributeJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateTicketTypeAttributeResponse, error)

func (*ClientWithResponses) CreateTicketTypeWithBodyWithResponse

func (c *ClientWithResponses) CreateTicketTypeWithBodyWithResponse(ctx context.Context, params *CreateTicketTypeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateTicketTypeResponse, error)

CreateTicketTypeWithBodyWithResponse request with arbitrary body returning *CreateTicketTypeResponse

func (*ClientWithResponses) CreateTicketTypeWithResponse

func (c *ClientWithResponses) CreateTicketTypeWithResponse(ctx context.Context, params *CreateTicketTypeParams, body CreateTicketTypeJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateTicketTypeResponse, error)

func (*ClientWithResponses) CreateTicketWithBodyWithResponse

func (c *ClientWithResponses) CreateTicketWithBodyWithResponse(ctx context.Context, params *CreateTicketParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateTicketResponse, error)

CreateTicketWithBodyWithResponse request with arbitrary body returning *CreateTicketResponse

func (*ClientWithResponses) CreateTicketWithResponse

func (c *ClientWithResponses) CreateTicketWithResponse(ctx context.Context, params *CreateTicketParams, body CreateTicketJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateTicketResponse, error)

func (*ClientWithResponses) DataEventSummariesWithBodyWithResponse

func (c *ClientWithResponses) DataEventSummariesWithBodyWithResponse(ctx context.Context, params *DataEventSummariesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DataEventSummariesResponse, error)

DataEventSummariesWithBodyWithResponse request with arbitrary body returning *DataEventSummariesResponse

func (*ClientWithResponses) DataEventSummariesWithResponse

func (*ClientWithResponses) DeleteArticleWithResponse

func (c *ClientWithResponses) DeleteArticleWithResponse(ctx context.Context, articleId int, params *DeleteArticleParams, reqEditors ...RequestEditorFn) (*DeleteArticleResponse, error)

DeleteArticleWithResponse request returning *DeleteArticleResponse

func (*ClientWithResponses) DeleteCollectionWithResponse

func (c *ClientWithResponses) DeleteCollectionWithResponse(ctx context.Context, collectionId int, params *DeleteCollectionParams, reqEditors ...RequestEditorFn) (*DeleteCollectionResponse, error)

DeleteCollectionWithResponse request returning *DeleteCollectionResponse

func (*ClientWithResponses) DeleteCompanyWithResponse

func (c *ClientWithResponses) DeleteCompanyWithResponse(ctx context.Context, companyId string, params *DeleteCompanyParams, reqEditors ...RequestEditorFn) (*DeleteCompanyResponse, error)

DeleteCompanyWithResponse request returning *DeleteCompanyResponse

func (*ClientWithResponses) DeleteContactWithResponse

func (c *ClientWithResponses) DeleteContactWithResponse(ctx context.Context, contactId string, params *DeleteContactParams, reqEditors ...RequestEditorFn) (*DeleteContactResponse, error)

DeleteContactWithResponse request returning *DeleteContactResponse

func (*ClientWithResponses) DeleteContentImportSourceWithResponse

func (c *ClientWithResponses) DeleteContentImportSourceWithResponse(ctx context.Context, sourceId string, params *DeleteContentImportSourceParams, reqEditors ...RequestEditorFn) (*DeleteContentImportSourceResponse, error)

DeleteContentImportSourceWithResponse request returning *DeleteContentImportSourceResponse

func (*ClientWithResponses) DeleteConversationWithResponse

func (c *ClientWithResponses) DeleteConversationWithResponse(ctx context.Context, conversationId int, params *DeleteConversationParams, reqEditors ...RequestEditorFn) (*DeleteConversationResponse, error)

DeleteConversationWithResponse request returning *DeleteConversationResponse

func (*ClientWithResponses) DeleteCustomObjectInstancesByExternalIdWithResponse

func (c *ClientWithResponses) DeleteCustomObjectInstancesByExternalIdWithResponse(ctx context.Context, customObjectTypeIdentifier string, customObjectInstanceId string, params *DeleteCustomObjectInstancesByExternalIdParams, reqEditors ...RequestEditorFn) (*DeleteCustomObjectInstancesByExternalIdResponse, error)

DeleteCustomObjectInstancesByExternalIdWithResponse request returning *DeleteCustomObjectInstancesByExternalIdResponse

func (*ClientWithResponses) DeleteCustomObjectInstancesByIdWithResponse

func (c *ClientWithResponses) DeleteCustomObjectInstancesByIdWithResponse(ctx context.Context, customObjectTypeIdentifier string, params *DeleteCustomObjectInstancesByIdParams, reqEditors ...RequestEditorFn) (*DeleteCustomObjectInstancesByIdResponse, error)

DeleteCustomObjectInstancesByIdWithResponse request returning *DeleteCustomObjectInstancesByIdResponse

func (*ClientWithResponses) DeleteExternalPageWithResponse

func (c *ClientWithResponses) DeleteExternalPageWithResponse(ctx context.Context, pageId string, params *DeleteExternalPageParams, reqEditors ...RequestEditorFn) (*DeleteExternalPageResponse, error)

DeleteExternalPageWithResponse request returning *DeleteExternalPageResponse

func (*ClientWithResponses) DeleteInternalArticleWithResponse

func (c *ClientWithResponses) DeleteInternalArticleWithResponse(ctx context.Context, internalArticleId int, params *DeleteInternalArticleParams, reqEditors ...RequestEditorFn) (*DeleteInternalArticleResponse, error)

DeleteInternalArticleWithResponse request returning *DeleteInternalArticleResponse

func (*ClientWithResponses) DeleteNewsItemWithResponse

func (c *ClientWithResponses) DeleteNewsItemWithResponse(ctx context.Context, newsItemId int, params *DeleteNewsItemParams, reqEditors ...RequestEditorFn) (*DeleteNewsItemResponse, error)

DeleteNewsItemWithResponse request returning *DeleteNewsItemResponse

func (*ClientWithResponses) DeleteTagWithResponse

func (c *ClientWithResponses) DeleteTagWithResponse(ctx context.Context, tagId string, params *DeleteTagParams, reqEditors ...RequestEditorFn) (*DeleteTagResponse, error)

DeleteTagWithResponse request returning *DeleteTagResponse

func (*ClientWithResponses) DeleteTicketWithResponse

func (c *ClientWithResponses) DeleteTicketWithResponse(ctx context.Context, ticketId string, params *DeleteTicketParams, reqEditors ...RequestEditorFn) (*DeleteTicketResponse, error)

DeleteTicketWithResponse request returning *DeleteTicketResponse

func (*ClientWithResponses) DetachContactFromACompanyWithResponse

func (c *ClientWithResponses) DetachContactFromACompanyWithResponse(ctx context.Context, contactId string, companyId string, params *DetachContactFromACompanyParams, reqEditors ...RequestEditorFn) (*DetachContactFromACompanyResponse, error)

DetachContactFromACompanyWithResponse request returning *DetachContactFromACompanyResponse

func (*ClientWithResponses) DetachContactFromConversationWithBodyWithResponse

func (c *ClientWithResponses) DetachContactFromConversationWithBodyWithResponse(ctx context.Context, conversationId string, contactId string, params *DetachContactFromConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DetachContactFromConversationResponse, error)

DetachContactFromConversationWithBodyWithResponse request with arbitrary body returning *DetachContactFromConversationResponse

func (*ClientWithResponses) DetachContactFromConversationWithResponse

func (c *ClientWithResponses) DetachContactFromConversationWithResponse(ctx context.Context, conversationId string, contactId string, params *DetachContactFromConversationParams, body DetachContactFromConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*DetachContactFromConversationResponse, error)

func (*ClientWithResponses) DetachSubscriptionTypeToContactWithResponse

func (c *ClientWithResponses) DetachSubscriptionTypeToContactWithResponse(ctx context.Context, contactId string, subscriptionId string, params *DetachSubscriptionTypeToContactParams, reqEditors ...RequestEditorFn) (*DetachSubscriptionTypeToContactResponse, error)

DetachSubscriptionTypeToContactWithResponse request returning *DetachSubscriptionTypeToContactResponse

func (*ClientWithResponses) DetachTagFromContactWithResponse

func (c *ClientWithResponses) DetachTagFromContactWithResponse(ctx context.Context, contactId string, tagId string, params *DetachTagFromContactParams, reqEditors ...RequestEditorFn) (*DetachTagFromContactResponse, error)

DetachTagFromContactWithResponse request returning *DetachTagFromContactResponse

func (*ClientWithResponses) DetachTagFromConversationWithBodyWithResponse

func (c *ClientWithResponses) DetachTagFromConversationWithBodyWithResponse(ctx context.Context, conversationId string, tagId string, params *DetachTagFromConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DetachTagFromConversationResponse, error)

DetachTagFromConversationWithBodyWithResponse request with arbitrary body returning *DetachTagFromConversationResponse

func (*ClientWithResponses) DetachTagFromConversationWithResponse

func (c *ClientWithResponses) DetachTagFromConversationWithResponse(ctx context.Context, conversationId string, tagId string, params *DetachTagFromConversationParams, body DetachTagFromConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*DetachTagFromConversationResponse, error)

func (*ClientWithResponses) DetachTagFromTicketWithBodyWithResponse

func (c *ClientWithResponses) DetachTagFromTicketWithBodyWithResponse(ctx context.Context, ticketId string, tagId string, params *DetachTagFromTicketParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DetachTagFromTicketResponse, error)

DetachTagFromTicketWithBodyWithResponse request with arbitrary body returning *DetachTagFromTicketResponse

func (*ClientWithResponses) DetachTagFromTicketWithResponse

func (c *ClientWithResponses) DetachTagFromTicketWithResponse(ctx context.Context, ticketId string, tagId string, params *DetachTagFromTicketParams, body DetachTagFromTicketJSONRequestBody, reqEditors ...RequestEditorFn) (*DetachTagFromTicketResponse, error)

func (*ClientWithResponses) DownloadDataExportWithResponse

func (c *ClientWithResponses) DownloadDataExportWithResponse(ctx context.Context, jobIdentifier string, params *DownloadDataExportParams, reqEditors ...RequestEditorFn) (*DownloadDataExportResponse, error)

DownloadDataExportWithResponse request returning *DownloadDataExportResponse

func (*ClientWithResponses) EnqueueCreateTicketWithBodyWithResponse

func (c *ClientWithResponses) EnqueueCreateTicketWithBodyWithResponse(ctx context.Context, params *EnqueueCreateTicketParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*EnqueueCreateTicketResponse, error)

EnqueueCreateTicketWithBodyWithResponse request with arbitrary body returning *EnqueueCreateTicketResponse

func (*ClientWithResponses) EnqueueCreateTicketWithResponse

func (*ClientWithResponses) ExportWorkflowWithResponse

func (c *ClientWithResponses) ExportWorkflowWithResponse(ctx context.Context, id string, params *ExportWorkflowParams, reqEditors ...RequestEditorFn) (*ExportWorkflowResponse, error)

ExportWorkflowWithResponse request returning *ExportWorkflowResponse

func (*ClientWithResponses) FindTagWithResponse

func (c *ClientWithResponses) FindTagWithResponse(ctx context.Context, tagId string, params *FindTagParams, reqEditors ...RequestEditorFn) (*FindTagResponse, error)

FindTagWithResponse request returning *FindTagResponse

func (*ClientWithResponses) GetContentImportSourceWithResponse

func (c *ClientWithResponses) GetContentImportSourceWithResponse(ctx context.Context, sourceId string, params *GetContentImportSourceParams, reqEditors ...RequestEditorFn) (*GetContentImportSourceResponse, error)

GetContentImportSourceWithResponse request returning *GetContentImportSourceResponse

func (*ClientWithResponses) GetCustomObjectInstancesByExternalIdWithResponse

func (c *ClientWithResponses) GetCustomObjectInstancesByExternalIdWithResponse(ctx context.Context, customObjectTypeIdentifier string, params *GetCustomObjectInstancesByExternalIdParams, reqEditors ...RequestEditorFn) (*GetCustomObjectInstancesByExternalIdResponse, error)

GetCustomObjectInstancesByExternalIdWithResponse request returning *GetCustomObjectInstancesByExternalIdResponse

func (*ClientWithResponses) GetCustomObjectInstancesByIdWithResponse

func (c *ClientWithResponses) GetCustomObjectInstancesByIdWithResponse(ctx context.Context, customObjectTypeIdentifier string, customObjectInstanceId string, params *GetCustomObjectInstancesByIdParams, reqEditors ...RequestEditorFn) (*GetCustomObjectInstancesByIdResponse, error)

GetCustomObjectInstancesByIdWithResponse request returning *GetCustomObjectInstancesByIdResponse

func (*ClientWithResponses) GetDataExportWithResponse

func (c *ClientWithResponses) GetDataExportWithResponse(ctx context.Context, jobIdentifier string, params *GetDataExportParams, reqEditors ...RequestEditorFn) (*GetDataExportResponse, error)

GetDataExportWithResponse request returning *GetDataExportResponse

func (*ClientWithResponses) GetDownloadReportingDataJobIdentifierWithResponse

func (c *ClientWithResponses) GetDownloadReportingDataJobIdentifierWithResponse(ctx context.Context, jobIdentifier string, params *GetDownloadReportingDataJobIdentifierParams, reqEditors ...RequestEditorFn) (*GetDownloadReportingDataJobIdentifierResponse, error)

GetDownloadReportingDataJobIdentifierWithResponse request returning *GetDownloadReportingDataJobIdentifierResponse

func (*ClientWithResponses) GetExportReportingDataGetDatasetsWithResponse

func (c *ClientWithResponses) GetExportReportingDataGetDatasetsWithResponse(ctx context.Context, params *GetExportReportingDataGetDatasetsParams, reqEditors ...RequestEditorFn) (*GetExportReportingDataGetDatasetsResponse, error)

GetExportReportingDataGetDatasetsWithResponse request returning *GetExportReportingDataGetDatasetsResponse

func (*ClientWithResponses) GetExportReportingDataJobIdentifierWithResponse

func (c *ClientWithResponses) GetExportReportingDataJobIdentifierWithResponse(ctx context.Context, jobIdentifier string, params *GetExportReportingDataJobIdentifierParams, reqEditors ...RequestEditorFn) (*GetExportReportingDataJobIdentifierResponse, error)

GetExportReportingDataJobIdentifierWithResponse request returning *GetExportReportingDataJobIdentifierResponse

func (*ClientWithResponses) GetExternalPageWithResponse

func (c *ClientWithResponses) GetExternalPageWithResponse(ctx context.Context, pageId string, params *GetExternalPageParams, reqEditors ...RequestEditorFn) (*GetExternalPageResponse, error)

GetExternalPageWithResponse request returning *GetExternalPageResponse

func (*ClientWithResponses) GetIpAllowlistWithResponse

func (c *ClientWithResponses) GetIpAllowlistWithResponse(ctx context.Context, params *GetIpAllowlistParams, reqEditors ...RequestEditorFn) (*GetIpAllowlistResponse, error)

GetIpAllowlistWithResponse request returning *GetIpAllowlistResponse

func (*ClientWithResponses) GetTicketTypeWithResponse

func (c *ClientWithResponses) GetTicketTypeWithResponse(ctx context.Context, ticketTypeId string, params *GetTicketTypeParams, reqEditors ...RequestEditorFn) (*GetTicketTypeResponse, error)

GetTicketTypeWithResponse request returning *GetTicketTypeResponse

func (*ClientWithResponses) GetTicketWithResponse

func (c *ClientWithResponses) GetTicketWithResponse(ctx context.Context, ticketId string, params *GetTicketParams, reqEditors ...RequestEditorFn) (*GetTicketResponse, error)

GetTicketWithResponse request returning *GetTicketResponse

func (*ClientWithResponses) IdentifyAdminWithResponse

func (c *ClientWithResponses) IdentifyAdminWithResponse(ctx context.Context, params *IdentifyAdminParams, reqEditors ...RequestEditorFn) (*IdentifyAdminResponse, error)

IdentifyAdminWithResponse request returning *IdentifyAdminResponse

func (*ClientWithResponses) JobsStatusWithResponse

func (c *ClientWithResponses) JobsStatusWithResponse(ctx context.Context, jobId string, params *JobsStatusParams, reqEditors ...RequestEditorFn) (*JobsStatusResponse, error)

JobsStatusWithResponse request returning *JobsStatusResponse

func (*ClientWithResponses) LisDataAttributesWithResponse

func (c *ClientWithResponses) LisDataAttributesWithResponse(ctx context.Context, params *LisDataAttributesParams, reqEditors ...RequestEditorFn) (*LisDataAttributesResponse, error)

LisDataAttributesWithResponse request returning *LisDataAttributesResponse

func (*ClientWithResponses) LisDataEventsWithResponse

func (c *ClientWithResponses) LisDataEventsWithResponse(ctx context.Context, params *LisDataEventsParams, reqEditors ...RequestEditorFn) (*LisDataEventsResponse, error)

LisDataEventsWithResponse request returning *LisDataEventsResponse

func (*ClientWithResponses) ListActivityLogsWithResponse

func (c *ClientWithResponses) ListActivityLogsWithResponse(ctx context.Context, params *ListActivityLogsParams, reqEditors ...RequestEditorFn) (*ListActivityLogsResponse, error)

ListActivityLogsWithResponse request returning *ListActivityLogsResponse

func (*ClientWithResponses) ListAdminsWithResponse

func (c *ClientWithResponses) ListAdminsWithResponse(ctx context.Context, params *ListAdminsParams, reqEditors ...RequestEditorFn) (*ListAdminsResponse, error)

ListAdminsWithResponse request returning *ListAdminsResponse

func (*ClientWithResponses) ListAllCollectionsWithResponse

func (c *ClientWithResponses) ListAllCollectionsWithResponse(ctx context.Context, params *ListAllCollectionsParams, reqEditors ...RequestEditorFn) (*ListAllCollectionsResponse, error)

ListAllCollectionsWithResponse request returning *ListAllCollectionsResponse

func (*ClientWithResponses) ListAllCompaniesWithResponse

func (c *ClientWithResponses) ListAllCompaniesWithResponse(ctx context.Context, params *ListAllCompaniesParams, reqEditors ...RequestEditorFn) (*ListAllCompaniesResponse, error)

ListAllCompaniesWithResponse request returning *ListAllCompaniesResponse

func (*ClientWithResponses) ListArticlesWithResponse

func (c *ClientWithResponses) ListArticlesWithResponse(ctx context.Context, params *ListArticlesParams, reqEditors ...RequestEditorFn) (*ListArticlesResponse, error)

ListArticlesWithResponse request returning *ListArticlesResponse

func (*ClientWithResponses) ListAttachedContactsWithResponse

func (c *ClientWithResponses) ListAttachedContactsWithResponse(ctx context.Context, companyId string, params *ListAttachedContactsParams, reqEditors ...RequestEditorFn) (*ListAttachedContactsResponse, error)

ListAttachedContactsWithResponse request returning *ListAttachedContactsResponse

func (*ClientWithResponses) ListAttachedSegmentsForCompaniesWithResponse

func (c *ClientWithResponses) ListAttachedSegmentsForCompaniesWithResponse(ctx context.Context, companyId string, params *ListAttachedSegmentsForCompaniesParams, reqEditors ...RequestEditorFn) (*ListAttachedSegmentsForCompaniesResponse, error)

ListAttachedSegmentsForCompaniesWithResponse request returning *ListAttachedSegmentsForCompaniesResponse

func (*ClientWithResponses) ListAwayStatusReasonsWithResponse

func (c *ClientWithResponses) ListAwayStatusReasonsWithResponse(ctx context.Context, params *ListAwayStatusReasonsParams, reqEditors ...RequestEditorFn) (*ListAwayStatusReasonsResponse, error)

ListAwayStatusReasonsWithResponse request returning *ListAwayStatusReasonsResponse

func (*ClientWithResponses) ListBrandsWithResponse

func (c *ClientWithResponses) ListBrandsWithResponse(ctx context.Context, params *ListBrandsParams, reqEditors ...RequestEditorFn) (*ListBrandsResponse, error)

ListBrandsWithResponse request returning *ListBrandsResponse

func (*ClientWithResponses) ListCallsWithResponse

func (c *ClientWithResponses) ListCallsWithResponse(ctx context.Context, params *ListCallsParams, reqEditors ...RequestEditorFn) (*ListCallsResponse, error)

ListCallsWithResponse request returning *ListCallsResponse

func (*ClientWithResponses) ListCallsWithTranscriptsWithBodyWithResponse

func (c *ClientWithResponses) ListCallsWithTranscriptsWithBodyWithResponse(ctx context.Context, params *ListCallsWithTranscriptsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ListCallsWithTranscriptsResponse, error)

ListCallsWithTranscriptsWithBodyWithResponse request with arbitrary body returning *ListCallsWithTranscriptsResponse

func (*ClientWithResponses) ListCompaniesForAContactWithResponse

func (c *ClientWithResponses) ListCompaniesForAContactWithResponse(ctx context.Context, contactId string, params *ListCompaniesForAContactParams, reqEditors ...RequestEditorFn) (*ListCompaniesForAContactResponse, error)

ListCompaniesForAContactWithResponse request returning *ListCompaniesForAContactResponse

func (*ClientWithResponses) ListCompanyNotesWithResponse

func (c *ClientWithResponses) ListCompanyNotesWithResponse(ctx context.Context, companyId string, params *ListCompanyNotesParams, reqEditors ...RequestEditorFn) (*ListCompanyNotesResponse, error)

ListCompanyNotesWithResponse request returning *ListCompanyNotesResponse

func (*ClientWithResponses) ListContactsWithResponse

func (c *ClientWithResponses) ListContactsWithResponse(ctx context.Context, params *ListContactsParams, reqEditors ...RequestEditorFn) (*ListContactsResponse, error)

ListContactsWithResponse request returning *ListContactsResponse

func (*ClientWithResponses) ListContentImportSourcesWithResponse

func (c *ClientWithResponses) ListContentImportSourcesWithResponse(ctx context.Context, params *ListContentImportSourcesParams, reqEditors ...RequestEditorFn) (*ListContentImportSourcesResponse, error)

ListContentImportSourcesWithResponse request returning *ListContentImportSourcesResponse

func (*ClientWithResponses) ListConversationsWithResponse

func (c *ClientWithResponses) ListConversationsWithResponse(ctx context.Context, params *ListConversationsParams, reqEditors ...RequestEditorFn) (*ListConversationsResponse, error)

ListConversationsWithResponse request returning *ListConversationsResponse

func (*ClientWithResponses) ListEmailsWithResponse

func (c *ClientWithResponses) ListEmailsWithResponse(ctx context.Context, params *ListEmailsParams, reqEditors ...RequestEditorFn) (*ListEmailsResponse, error)

ListEmailsWithResponse request returning *ListEmailsResponse

func (*ClientWithResponses) ListExternalPagesWithResponse

func (c *ClientWithResponses) ListExternalPagesWithResponse(ctx context.Context, params *ListExternalPagesParams, reqEditors ...RequestEditorFn) (*ListExternalPagesResponse, error)

ListExternalPagesWithResponse request returning *ListExternalPagesResponse

func (*ClientWithResponses) ListHandlingEventsWithResponse

func (c *ClientWithResponses) ListHandlingEventsWithResponse(ctx context.Context, id string, params *ListHandlingEventsParams, reqEditors ...RequestEditorFn) (*ListHandlingEventsResponse, error)

ListHandlingEventsWithResponse request returning *ListHandlingEventsResponse

func (*ClientWithResponses) ListHelpCentersWithResponse

func (c *ClientWithResponses) ListHelpCentersWithResponse(ctx context.Context, params *ListHelpCentersParams, reqEditors ...RequestEditorFn) (*ListHelpCentersResponse, error)

ListHelpCentersWithResponse request returning *ListHelpCentersResponse

func (*ClientWithResponses) ListInternalArticlesWithResponse

func (c *ClientWithResponses) ListInternalArticlesWithResponse(ctx context.Context, params *ListInternalArticlesParams, reqEditors ...RequestEditorFn) (*ListInternalArticlesResponse, error)

ListInternalArticlesWithResponse request returning *ListInternalArticlesResponse

func (*ClientWithResponses) ListLiveNewsfeedItemsWithResponse

func (c *ClientWithResponses) ListLiveNewsfeedItemsWithResponse(ctx context.Context, newsfeedId string, params *ListLiveNewsfeedItemsParams, reqEditors ...RequestEditorFn) (*ListLiveNewsfeedItemsResponse, error)

ListLiveNewsfeedItemsWithResponse request returning *ListLiveNewsfeedItemsResponse

func (*ClientWithResponses) ListNewsItemsWithResponse

func (c *ClientWithResponses) ListNewsItemsWithResponse(ctx context.Context, params *ListNewsItemsParams, reqEditors ...RequestEditorFn) (*ListNewsItemsResponse, error)

ListNewsItemsWithResponse request returning *ListNewsItemsResponse

func (*ClientWithResponses) ListNewsfeedsWithResponse

func (c *ClientWithResponses) ListNewsfeedsWithResponse(ctx context.Context, params *ListNewsfeedsParams, reqEditors ...RequestEditorFn) (*ListNewsfeedsResponse, error)

ListNewsfeedsWithResponse request returning *ListNewsfeedsResponse

func (*ClientWithResponses) ListNotesWithResponse

func (c *ClientWithResponses) ListNotesWithResponse(ctx context.Context, contactId string, params *ListNotesParams, reqEditors ...RequestEditorFn) (*ListNotesResponse, error)

ListNotesWithResponse request returning *ListNotesResponse

func (*ClientWithResponses) ListSegmentsForAContactWithResponse

func (c *ClientWithResponses) ListSegmentsForAContactWithResponse(ctx context.Context, contactId string, params *ListSegmentsForAContactParams, reqEditors ...RequestEditorFn) (*ListSegmentsForAContactResponse, error)

ListSegmentsForAContactWithResponse request returning *ListSegmentsForAContactResponse

func (*ClientWithResponses) ListSegmentsWithResponse

func (c *ClientWithResponses) ListSegmentsWithResponse(ctx context.Context, params *ListSegmentsParams, reqEditors ...RequestEditorFn) (*ListSegmentsResponse, error)

ListSegmentsWithResponse request returning *ListSegmentsResponse

func (*ClientWithResponses) ListSubscriptionTypesWithResponse

func (c *ClientWithResponses) ListSubscriptionTypesWithResponse(ctx context.Context, params *ListSubscriptionTypesParams, reqEditors ...RequestEditorFn) (*ListSubscriptionTypesResponse, error)

ListSubscriptionTypesWithResponse request returning *ListSubscriptionTypesResponse

func (*ClientWithResponses) ListSubscriptionsForAContactWithResponse

func (c *ClientWithResponses) ListSubscriptionsForAContactWithResponse(ctx context.Context, contactId string, params *ListSubscriptionsForAContactParams, reqEditors ...RequestEditorFn) (*ListSubscriptionsForAContactResponse, error)

ListSubscriptionsForAContactWithResponse request returning *ListSubscriptionsForAContactResponse

func (*ClientWithResponses) ListTagsForAContactWithResponse

func (c *ClientWithResponses) ListTagsForAContactWithResponse(ctx context.Context, contactId string, params *ListTagsForAContactParams, reqEditors ...RequestEditorFn) (*ListTagsForAContactResponse, error)

ListTagsForAContactWithResponse request returning *ListTagsForAContactResponse

func (*ClientWithResponses) ListTagsWithResponse

func (c *ClientWithResponses) ListTagsWithResponse(ctx context.Context, params *ListTagsParams, reqEditors ...RequestEditorFn) (*ListTagsResponse, error)

ListTagsWithResponse request returning *ListTagsResponse

func (*ClientWithResponses) ListTeamsWithResponse

func (c *ClientWithResponses) ListTeamsWithResponse(ctx context.Context, params *ListTeamsParams, reqEditors ...RequestEditorFn) (*ListTeamsResponse, error)

ListTeamsWithResponse request returning *ListTeamsResponse

func (*ClientWithResponses) ListTicketStatesWithResponse

func (c *ClientWithResponses) ListTicketStatesWithResponse(ctx context.Context, params *ListTicketStatesParams, reqEditors ...RequestEditorFn) (*ListTicketStatesResponse, error)

ListTicketStatesWithResponse request returning *ListTicketStatesResponse

func (*ClientWithResponses) ListTicketTypesWithResponse

func (c *ClientWithResponses) ListTicketTypesWithResponse(ctx context.Context, params *ListTicketTypesParams, reqEditors ...RequestEditorFn) (*ListTicketTypesResponse, error)

ListTicketTypesWithResponse request returning *ListTicketTypesResponse

func (*ClientWithResponses) ManageConversationWithBodyWithResponse

func (c *ClientWithResponses) ManageConversationWithBodyWithResponse(ctx context.Context, conversationId string, params *ManageConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ManageConversationResponse, error)

ManageConversationWithBodyWithResponse request with arbitrary body returning *ManageConversationResponse

func (*ClientWithResponses) ManageConversationWithResponse

func (c *ClientWithResponses) ManageConversationWithResponse(ctx context.Context, conversationId string, params *ManageConversationParams, body ManageConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*ManageConversationResponse, error)

func (*ClientWithResponses) MergeContactWithBodyWithResponse

func (c *ClientWithResponses) MergeContactWithBodyWithResponse(ctx context.Context, params *MergeContactParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*MergeContactResponse, error)

MergeContactWithBodyWithResponse request with arbitrary body returning *MergeContactResponse

func (*ClientWithResponses) MergeContactWithResponse

func (c *ClientWithResponses) MergeContactWithResponse(ctx context.Context, params *MergeContactParams, body MergeContactJSONRequestBody, reqEditors ...RequestEditorFn) (*MergeContactResponse, error)

func (*ClientWithResponses) PostExportReportingDataEnqueueWithBodyWithResponse

func (c *ClientWithResponses) PostExportReportingDataEnqueueWithBodyWithResponse(ctx context.Context, params *PostExportReportingDataEnqueueParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostExportReportingDataEnqueueResponse, error)

PostExportReportingDataEnqueueWithBodyWithResponse request with arbitrary body returning *PostExportReportingDataEnqueueResponse

func (*ClientWithResponses) RedactConversationWithBodyWithResponse

func (c *ClientWithResponses) RedactConversationWithBodyWithResponse(ctx context.Context, params *RedactConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RedactConversationResponse, error)

RedactConversationWithBodyWithResponse request with arbitrary body returning *RedactConversationResponse

func (*ClientWithResponses) RedactConversationWithResponse

func (*ClientWithResponses) RegisterFinVoiceCallWithBodyWithResponse

func (c *ClientWithResponses) RegisterFinVoiceCallWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RegisterFinVoiceCallResponse, error)

RegisterFinVoiceCallWithBodyWithResponse request with arbitrary body returning *RegisterFinVoiceCallResponse

func (*ClientWithResponses) RegisterFinVoiceCallWithResponse

func (c *ClientWithResponses) RegisterFinVoiceCallWithResponse(ctx context.Context, body RegisterFinVoiceCallJSONRequestBody, reqEditors ...RequestEditorFn) (*RegisterFinVoiceCallResponse, error)

func (*ClientWithResponses) ReplyConversationWithBodyWithResponse

func (c *ClientWithResponses) ReplyConversationWithBodyWithResponse(ctx context.Context, conversationId string, params *ReplyConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ReplyConversationResponse, error)

ReplyConversationWithBodyWithResponse request with arbitrary body returning *ReplyConversationResponse

func (*ClientWithResponses) ReplyConversationWithResponse

func (c *ClientWithResponses) ReplyConversationWithResponse(ctx context.Context, conversationId string, params *ReplyConversationParams, body ReplyConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*ReplyConversationResponse, error)

func (*ClientWithResponses) ReplyTicketWithBodyWithResponse

func (c *ClientWithResponses) ReplyTicketWithBodyWithResponse(ctx context.Context, ticketId string, params *ReplyTicketParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ReplyTicketResponse, error)

ReplyTicketWithBodyWithResponse request with arbitrary body returning *ReplyTicketResponse

func (*ClientWithResponses) ReplyTicketWithResponse

func (c *ClientWithResponses) ReplyTicketWithResponse(ctx context.Context, ticketId string, params *ReplyTicketParams, body ReplyTicketJSONRequestBody, reqEditors ...RequestEditorFn) (*ReplyTicketResponse, error)

func (*ClientWithResponses) ReplyToFinWithBodyWithResponse

func (c *ClientWithResponses) ReplyToFinWithBodyWithResponse(ctx context.Context, params *ReplyToFinParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ReplyToFinResponse, error)

ReplyToFinWithBodyWithResponse request with arbitrary body returning *ReplyToFinResponse

func (*ClientWithResponses) ReplyToFinWithResponse

func (c *ClientWithResponses) ReplyToFinWithResponse(ctx context.Context, params *ReplyToFinParams, body ReplyToFinJSONRequestBody, reqEditors ...RequestEditorFn) (*ReplyToFinResponse, error)

func (*ClientWithResponses) RetrieveACompanyByIdWithResponse

func (c *ClientWithResponses) RetrieveACompanyByIdWithResponse(ctx context.Context, companyId string, params *RetrieveACompanyByIdParams, reqEditors ...RequestEditorFn) (*RetrieveACompanyByIdResponse, error)

RetrieveACompanyByIdWithResponse request returning *RetrieveACompanyByIdResponse

func (*ClientWithResponses) RetrieveAdminWithResponse

func (c *ClientWithResponses) RetrieveAdminWithResponse(ctx context.Context, adminId int, params *RetrieveAdminParams, reqEditors ...RequestEditorFn) (*RetrieveAdminResponse, error)

RetrieveAdminWithResponse request returning *RetrieveAdminResponse

func (*ClientWithResponses) RetrieveArticleWithResponse

func (c *ClientWithResponses) RetrieveArticleWithResponse(ctx context.Context, articleId int, params *RetrieveArticleParams, reqEditors ...RequestEditorFn) (*RetrieveArticleResponse, error)

RetrieveArticleWithResponse request returning *RetrieveArticleResponse

func (*ClientWithResponses) RetrieveBrandWithResponse

func (c *ClientWithResponses) RetrieveBrandWithResponse(ctx context.Context, id string, params *RetrieveBrandParams, reqEditors ...RequestEditorFn) (*RetrieveBrandResponse, error)

RetrieveBrandWithResponse request returning *RetrieveBrandResponse

func (*ClientWithResponses) RetrieveCollectionWithResponse

func (c *ClientWithResponses) RetrieveCollectionWithResponse(ctx context.Context, collectionId int, params *RetrieveCollectionParams, reqEditors ...RequestEditorFn) (*RetrieveCollectionResponse, error)

RetrieveCollectionWithResponse request returning *RetrieveCollectionResponse

func (*ClientWithResponses) RetrieveCompanyWithResponse

func (c *ClientWithResponses) RetrieveCompanyWithResponse(ctx context.Context, params *RetrieveCompanyParams, reqEditors ...RequestEditorFn) (*RetrieveCompanyResponse, error)

RetrieveCompanyWithResponse request returning *RetrieveCompanyResponse

func (*ClientWithResponses) RetrieveConversationWithResponse

func (c *ClientWithResponses) RetrieveConversationWithResponse(ctx context.Context, conversationId int, params *RetrieveConversationParams, reqEditors ...RequestEditorFn) (*RetrieveConversationResponse, error)

RetrieveConversationWithResponse request returning *RetrieveConversationResponse

func (*ClientWithResponses) RetrieveEmailWithResponse

func (c *ClientWithResponses) RetrieveEmailWithResponse(ctx context.Context, id string, params *RetrieveEmailParams, reqEditors ...RequestEditorFn) (*RetrieveEmailResponse, error)

RetrieveEmailWithResponse request returning *RetrieveEmailResponse

func (*ClientWithResponses) RetrieveHelpCenterWithResponse

func (c *ClientWithResponses) RetrieveHelpCenterWithResponse(ctx context.Context, helpCenterId int, params *RetrieveHelpCenterParams, reqEditors ...RequestEditorFn) (*RetrieveHelpCenterResponse, error)

RetrieveHelpCenterWithResponse request returning *RetrieveHelpCenterResponse

func (*ClientWithResponses) RetrieveInternalArticleWithResponse

func (c *ClientWithResponses) RetrieveInternalArticleWithResponse(ctx context.Context, internalArticleId int, params *RetrieveInternalArticleParams, reqEditors ...RequestEditorFn) (*RetrieveInternalArticleResponse, error)

RetrieveInternalArticleWithResponse request returning *RetrieveInternalArticleResponse

func (*ClientWithResponses) RetrieveNewsItemWithResponse

func (c *ClientWithResponses) RetrieveNewsItemWithResponse(ctx context.Context, newsItemId int, params *RetrieveNewsItemParams, reqEditors ...RequestEditorFn) (*RetrieveNewsItemResponse, error)

RetrieveNewsItemWithResponse request returning *RetrieveNewsItemResponse

func (*ClientWithResponses) RetrieveNewsfeedWithResponse

func (c *ClientWithResponses) RetrieveNewsfeedWithResponse(ctx context.Context, newsfeedId string, params *RetrieveNewsfeedParams, reqEditors ...RequestEditorFn) (*RetrieveNewsfeedResponse, error)

RetrieveNewsfeedWithResponse request returning *RetrieveNewsfeedResponse

func (*ClientWithResponses) RetrieveNoteWithResponse

func (c *ClientWithResponses) RetrieveNoteWithResponse(ctx context.Context, noteId int, params *RetrieveNoteParams, reqEditors ...RequestEditorFn) (*RetrieveNoteResponse, error)

RetrieveNoteWithResponse request returning *RetrieveNoteResponse

func (*ClientWithResponses) RetrieveSegmentWithResponse

func (c *ClientWithResponses) RetrieveSegmentWithResponse(ctx context.Context, segmentId string, params *RetrieveSegmentParams, reqEditors ...RequestEditorFn) (*RetrieveSegmentResponse, error)

RetrieveSegmentWithResponse request returning *RetrieveSegmentResponse

func (*ClientWithResponses) RetrieveTeamWithResponse

func (c *ClientWithResponses) RetrieveTeamWithResponse(ctx context.Context, teamId string, params *RetrieveTeamParams, reqEditors ...RequestEditorFn) (*RetrieveTeamResponse, error)

RetrieveTeamWithResponse request returning *RetrieveTeamResponse

func (*ClientWithResponses) RetrieveVisitorWithUserIdWithResponse

func (c *ClientWithResponses) RetrieveVisitorWithUserIdWithResponse(ctx context.Context, params *RetrieveVisitorWithUserIdParams, reqEditors ...RequestEditorFn) (*RetrieveVisitorWithUserIdResponse, error)

RetrieveVisitorWithUserIdWithResponse request returning *RetrieveVisitorWithUserIdResponse

func (*ClientWithResponses) ScrollOverAllCompaniesWithResponse

func (c *ClientWithResponses) ScrollOverAllCompaniesWithResponse(ctx context.Context, params *ScrollOverAllCompaniesParams, reqEditors ...RequestEditorFn) (*ScrollOverAllCompaniesResponse, error)

ScrollOverAllCompaniesWithResponse request returning *ScrollOverAllCompaniesResponse

func (*ClientWithResponses) SearchArticlesWithResponse

func (c *ClientWithResponses) SearchArticlesWithResponse(ctx context.Context, params *SearchArticlesParams, reqEditors ...RequestEditorFn) (*SearchArticlesResponse, error)

SearchArticlesWithResponse request returning *SearchArticlesResponse

func (*ClientWithResponses) SearchContactsWithBodyWithResponse

func (c *ClientWithResponses) SearchContactsWithBodyWithResponse(ctx context.Context, params *SearchContactsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SearchContactsResponse, error)

SearchContactsWithBodyWithResponse request with arbitrary body returning *SearchContactsResponse

func (*ClientWithResponses) SearchContactsWithResponse

func (c *ClientWithResponses) SearchContactsWithResponse(ctx context.Context, params *SearchContactsParams, body SearchContactsJSONRequestBody, reqEditors ...RequestEditorFn) (*SearchContactsResponse, error)

func (*ClientWithResponses) SearchConversationsWithBodyWithResponse

func (c *ClientWithResponses) SearchConversationsWithBodyWithResponse(ctx context.Context, params *SearchConversationsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SearchConversationsResponse, error)

SearchConversationsWithBodyWithResponse request with arbitrary body returning *SearchConversationsResponse

func (*ClientWithResponses) SearchConversationsWithResponse

func (*ClientWithResponses) SearchInternalArticlesWithResponse

func (c *ClientWithResponses) SearchInternalArticlesWithResponse(ctx context.Context, params *SearchInternalArticlesParams, reqEditors ...RequestEditorFn) (*SearchInternalArticlesResponse, error)

SearchInternalArticlesWithResponse request returning *SearchInternalArticlesResponse

func (*ClientWithResponses) SearchTicketsWithBodyWithResponse

func (c *ClientWithResponses) SearchTicketsWithBodyWithResponse(ctx context.Context, params *SearchTicketsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SearchTicketsResponse, error)

SearchTicketsWithBodyWithResponse request with arbitrary body returning *SearchTicketsResponse

func (*ClientWithResponses) SearchTicketsWithResponse

func (c *ClientWithResponses) SearchTicketsWithResponse(ctx context.Context, params *SearchTicketsParams, body SearchTicketsJSONRequestBody, reqEditors ...RequestEditorFn) (*SearchTicketsResponse, error)

func (*ClientWithResponses) SetAwayAdminWithBodyWithResponse

func (c *ClientWithResponses) SetAwayAdminWithBodyWithResponse(ctx context.Context, adminId int, params *SetAwayAdminParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetAwayAdminResponse, error)

SetAwayAdminWithBodyWithResponse request with arbitrary body returning *SetAwayAdminResponse

func (*ClientWithResponses) SetAwayAdminWithResponse

func (c *ClientWithResponses) SetAwayAdminWithResponse(ctx context.Context, adminId int, params *SetAwayAdminParams, body SetAwayAdminJSONRequestBody, reqEditors ...RequestEditorFn) (*SetAwayAdminResponse, error)

func (*ClientWithResponses) ShowCallRecordingWithResponse

func (c *ClientWithResponses) ShowCallRecordingWithResponse(ctx context.Context, callId string, params *ShowCallRecordingParams, reqEditors ...RequestEditorFn) (*ShowCallRecordingResponse, error)

ShowCallRecordingWithResponse request returning *ShowCallRecordingResponse

func (*ClientWithResponses) ShowCallTranscriptWithResponse

func (c *ClientWithResponses) ShowCallTranscriptWithResponse(ctx context.Context, callId string, params *ShowCallTranscriptParams, reqEditors ...RequestEditorFn) (*ShowCallTranscriptResponse, error)

ShowCallTranscriptWithResponse request returning *ShowCallTranscriptResponse

func (*ClientWithResponses) ShowCallWithResponse

func (c *ClientWithResponses) ShowCallWithResponse(ctx context.Context, callId string, params *ShowCallParams, reqEditors ...RequestEditorFn) (*ShowCallResponse, error)

ShowCallWithResponse request returning *ShowCallResponse

func (*ClientWithResponses) ShowContactByExternalIdWithResponse

func (c *ClientWithResponses) ShowContactByExternalIdWithResponse(ctx context.Context, externalId string, params *ShowContactByExternalIdParams, reqEditors ...RequestEditorFn) (*ShowContactByExternalIdResponse, error)

ShowContactByExternalIdWithResponse request returning *ShowContactByExternalIdResponse

func (*ClientWithResponses) ShowContactWithResponse

func (c *ClientWithResponses) ShowContactWithResponse(ctx context.Context, contactId string, params *ShowContactParams, reqEditors ...RequestEditorFn) (*ShowContactResponse, error)

ShowContactWithResponse request returning *ShowContactResponse

func (*ClientWithResponses) StartFinConversationWithBodyWithResponse

func (c *ClientWithResponses) StartFinConversationWithBodyWithResponse(ctx context.Context, params *StartFinConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*StartFinConversationResponse, error)

StartFinConversationWithBodyWithResponse request with arbitrary body returning *StartFinConversationResponse

func (*ClientWithResponses) StartFinConversationWithResponse

func (*ClientWithResponses) UnarchiveContactWithResponse

func (c *ClientWithResponses) UnarchiveContactWithResponse(ctx context.Context, contactId string, params *UnarchiveContactParams, reqEditors ...RequestEditorFn) (*UnarchiveContactResponse, error)

UnarchiveContactWithResponse request returning *UnarchiveContactResponse

func (*ClientWithResponses) UpdateArticleWithBodyWithResponse

func (c *ClientWithResponses) UpdateArticleWithBodyWithResponse(ctx context.Context, articleId int, params *UpdateArticleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateArticleResponse, error)

UpdateArticleWithBodyWithResponse request with arbitrary body returning *UpdateArticleResponse

func (*ClientWithResponses) UpdateArticleWithResponse

func (c *ClientWithResponses) UpdateArticleWithResponse(ctx context.Context, articleId int, params *UpdateArticleParams, body UpdateArticleJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateArticleResponse, error)

func (*ClientWithResponses) UpdateCollectionWithBodyWithResponse

func (c *ClientWithResponses) UpdateCollectionWithBodyWithResponse(ctx context.Context, collectionId int, params *UpdateCollectionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateCollectionResponse, error)

UpdateCollectionWithBodyWithResponse request with arbitrary body returning *UpdateCollectionResponse

func (*ClientWithResponses) UpdateCollectionWithResponse

func (c *ClientWithResponses) UpdateCollectionWithResponse(ctx context.Context, collectionId int, params *UpdateCollectionParams, body UpdateCollectionJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateCollectionResponse, error)

func (*ClientWithResponses) UpdateCompanyWithBodyWithResponse

func (c *ClientWithResponses) UpdateCompanyWithBodyWithResponse(ctx context.Context, companyId string, params *UpdateCompanyParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateCompanyResponse, error)

UpdateCompanyWithBodyWithResponse request with arbitrary body returning *UpdateCompanyResponse

func (*ClientWithResponses) UpdateCompanyWithResponse

func (c *ClientWithResponses) UpdateCompanyWithResponse(ctx context.Context, companyId string, params *UpdateCompanyParams, body UpdateCompanyJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateCompanyResponse, error)

func (*ClientWithResponses) UpdateContactWithBodyWithResponse

func (c *ClientWithResponses) UpdateContactWithBodyWithResponse(ctx context.Context, contactId string, params *UpdateContactParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateContactResponse, error)

UpdateContactWithBodyWithResponse request with arbitrary body returning *UpdateContactResponse

func (*ClientWithResponses) UpdateContactWithResponse

func (c *ClientWithResponses) UpdateContactWithResponse(ctx context.Context, contactId string, params *UpdateContactParams, body UpdateContactJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateContactResponse, error)

func (*ClientWithResponses) UpdateContentImportSourceWithBodyWithResponse

func (c *ClientWithResponses) UpdateContentImportSourceWithBodyWithResponse(ctx context.Context, sourceId string, params *UpdateContentImportSourceParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateContentImportSourceResponse, error)

UpdateContentImportSourceWithBodyWithResponse request with arbitrary body returning *UpdateContentImportSourceResponse

func (*ClientWithResponses) UpdateContentImportSourceWithResponse

func (*ClientWithResponses) UpdateConversationWithBodyWithResponse

func (c *ClientWithResponses) UpdateConversationWithBodyWithResponse(ctx context.Context, conversationId int, params *UpdateConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateConversationResponse, error)

UpdateConversationWithBodyWithResponse request with arbitrary body returning *UpdateConversationResponse

func (*ClientWithResponses) UpdateConversationWithResponse

func (c *ClientWithResponses) UpdateConversationWithResponse(ctx context.Context, conversationId int, params *UpdateConversationParams, body UpdateConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateConversationResponse, error)

func (*ClientWithResponses) UpdateDataAttributeWithBodyWithResponse

func (c *ClientWithResponses) UpdateDataAttributeWithBodyWithResponse(ctx context.Context, dataAttributeId int, params *UpdateDataAttributeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDataAttributeResponse, error)

UpdateDataAttributeWithBodyWithResponse request with arbitrary body returning *UpdateDataAttributeResponse

func (*ClientWithResponses) UpdateDataAttributeWithResponse

func (c *ClientWithResponses) UpdateDataAttributeWithResponse(ctx context.Context, dataAttributeId int, params *UpdateDataAttributeParams, body UpdateDataAttributeJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDataAttributeResponse, error)

func (*ClientWithResponses) UpdateExternalPageWithBodyWithResponse

func (c *ClientWithResponses) UpdateExternalPageWithBodyWithResponse(ctx context.Context, pageId string, params *UpdateExternalPageParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateExternalPageResponse, error)

UpdateExternalPageWithBodyWithResponse request with arbitrary body returning *UpdateExternalPageResponse

func (*ClientWithResponses) UpdateExternalPageWithResponse

func (c *ClientWithResponses) UpdateExternalPageWithResponse(ctx context.Context, pageId string, params *UpdateExternalPageParams, body UpdateExternalPageJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateExternalPageResponse, error)

func (*ClientWithResponses) UpdateInternalArticleWithBodyWithResponse

func (c *ClientWithResponses) UpdateInternalArticleWithBodyWithResponse(ctx context.Context, internalArticleId int, params *UpdateInternalArticleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateInternalArticleResponse, error)

UpdateInternalArticleWithBodyWithResponse request with arbitrary body returning *UpdateInternalArticleResponse

func (*ClientWithResponses) UpdateInternalArticleWithResponse

func (c *ClientWithResponses) UpdateInternalArticleWithResponse(ctx context.Context, internalArticleId int, params *UpdateInternalArticleParams, body UpdateInternalArticleJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateInternalArticleResponse, error)

func (*ClientWithResponses) UpdateIpAllowlistWithBodyWithResponse

func (c *ClientWithResponses) UpdateIpAllowlistWithBodyWithResponse(ctx context.Context, params *UpdateIpAllowlistParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateIpAllowlistResponse, error)

UpdateIpAllowlistWithBodyWithResponse request with arbitrary body returning *UpdateIpAllowlistResponse

func (*ClientWithResponses) UpdateIpAllowlistWithResponse

func (*ClientWithResponses) UpdateNewsItemWithBodyWithResponse

func (c *ClientWithResponses) UpdateNewsItemWithBodyWithResponse(ctx context.Context, newsItemId int, params *UpdateNewsItemParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateNewsItemResponse, error)

UpdateNewsItemWithBodyWithResponse request with arbitrary body returning *UpdateNewsItemResponse

func (*ClientWithResponses) UpdateNewsItemWithResponse

func (c *ClientWithResponses) UpdateNewsItemWithResponse(ctx context.Context, newsItemId int, params *UpdateNewsItemParams, body UpdateNewsItemJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateNewsItemResponse, error)

func (*ClientWithResponses) UpdateTicketTypeAttributeWithBodyWithResponse

func (c *ClientWithResponses) UpdateTicketTypeAttributeWithBodyWithResponse(ctx context.Context, ticketTypeId string, attributeId string, params *UpdateTicketTypeAttributeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateTicketTypeAttributeResponse, error)

UpdateTicketTypeAttributeWithBodyWithResponse request with arbitrary body returning *UpdateTicketTypeAttributeResponse

func (*ClientWithResponses) UpdateTicketTypeAttributeWithResponse

func (c *ClientWithResponses) UpdateTicketTypeAttributeWithResponse(ctx context.Context, ticketTypeId string, attributeId string, params *UpdateTicketTypeAttributeParams, body UpdateTicketTypeAttributeJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateTicketTypeAttributeResponse, error)

func (*ClientWithResponses) UpdateTicketTypeWithBodyWithResponse

func (c *ClientWithResponses) UpdateTicketTypeWithBodyWithResponse(ctx context.Context, ticketTypeId string, params *UpdateTicketTypeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateTicketTypeResponse, error)

UpdateTicketTypeWithBodyWithResponse request with arbitrary body returning *UpdateTicketTypeResponse

func (*ClientWithResponses) UpdateTicketTypeWithResponse

func (c *ClientWithResponses) UpdateTicketTypeWithResponse(ctx context.Context, ticketTypeId string, params *UpdateTicketTypeParams, body UpdateTicketTypeJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateTicketTypeResponse, error)

func (*ClientWithResponses) UpdateTicketWithBodyWithResponse

func (c *ClientWithResponses) UpdateTicketWithBodyWithResponse(ctx context.Context, ticketId string, params *UpdateTicketParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateTicketResponse, error)

UpdateTicketWithBodyWithResponse request with arbitrary body returning *UpdateTicketResponse

func (*ClientWithResponses) UpdateTicketWithResponse

func (c *ClientWithResponses) UpdateTicketWithResponse(ctx context.Context, ticketId string, params *UpdateTicketParams, body UpdateTicketJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateTicketResponse, error)

func (*ClientWithResponses) UpdateVisitorWithBodyWithResponse

func (c *ClientWithResponses) UpdateVisitorWithBodyWithResponse(ctx context.Context, params *UpdateVisitorParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateVisitorResponse, error)

UpdateVisitorWithBodyWithResponse request with arbitrary body returning *UpdateVisitorResponse

func (*ClientWithResponses) UpdateVisitorWithResponse

func (c *ClientWithResponses) UpdateVisitorWithResponse(ctx context.Context, params *UpdateVisitorParams, body UpdateVisitorJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateVisitorResponse, error)

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// ListAdminsWithResponse request
	ListAdminsWithResponse(ctx context.Context, params *ListAdminsParams, reqEditors ...RequestEditorFn) (*ListAdminsResponse, error)

	// ListActivityLogsWithResponse request
	ListActivityLogsWithResponse(ctx context.Context, params *ListActivityLogsParams, reqEditors ...RequestEditorFn) (*ListActivityLogsResponse, error)

	// RetrieveAdminWithResponse request
	RetrieveAdminWithResponse(ctx context.Context, adminId int, params *RetrieveAdminParams, reqEditors ...RequestEditorFn) (*RetrieveAdminResponse, error)

	// SetAwayAdminWithBodyWithResponse request with any body
	SetAwayAdminWithBodyWithResponse(ctx context.Context, adminId int, params *SetAwayAdminParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetAwayAdminResponse, error)

	SetAwayAdminWithResponse(ctx context.Context, adminId int, params *SetAwayAdminParams, body SetAwayAdminJSONRequestBody, reqEditors ...RequestEditorFn) (*SetAwayAdminResponse, error)

	// ListContentImportSourcesWithResponse request
	ListContentImportSourcesWithResponse(ctx context.Context, params *ListContentImportSourcesParams, reqEditors ...RequestEditorFn) (*ListContentImportSourcesResponse, error)

	// CreateContentImportSourceWithBodyWithResponse request with any body
	CreateContentImportSourceWithBodyWithResponse(ctx context.Context, params *CreateContentImportSourceParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateContentImportSourceResponse, error)

	CreateContentImportSourceWithResponse(ctx context.Context, params *CreateContentImportSourceParams, body CreateContentImportSourceJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateContentImportSourceResponse, error)

	// DeleteContentImportSourceWithResponse request
	DeleteContentImportSourceWithResponse(ctx context.Context, sourceId string, params *DeleteContentImportSourceParams, reqEditors ...RequestEditorFn) (*DeleteContentImportSourceResponse, error)

	// GetContentImportSourceWithResponse request
	GetContentImportSourceWithResponse(ctx context.Context, sourceId string, params *GetContentImportSourceParams, reqEditors ...RequestEditorFn) (*GetContentImportSourceResponse, error)

	// UpdateContentImportSourceWithBodyWithResponse request with any body
	UpdateContentImportSourceWithBodyWithResponse(ctx context.Context, sourceId string, params *UpdateContentImportSourceParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateContentImportSourceResponse, error)

	UpdateContentImportSourceWithResponse(ctx context.Context, sourceId string, params *UpdateContentImportSourceParams, body UpdateContentImportSourceJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateContentImportSourceResponse, error)

	// ListExternalPagesWithResponse request
	ListExternalPagesWithResponse(ctx context.Context, params *ListExternalPagesParams, reqEditors ...RequestEditorFn) (*ListExternalPagesResponse, error)

	// CreateExternalPageWithBodyWithResponse request with any body
	CreateExternalPageWithBodyWithResponse(ctx context.Context, params *CreateExternalPageParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateExternalPageResponse, error)

	CreateExternalPageWithResponse(ctx context.Context, params *CreateExternalPageParams, body CreateExternalPageJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateExternalPageResponse, error)

	// DeleteExternalPageWithResponse request
	DeleteExternalPageWithResponse(ctx context.Context, pageId string, params *DeleteExternalPageParams, reqEditors ...RequestEditorFn) (*DeleteExternalPageResponse, error)

	// GetExternalPageWithResponse request
	GetExternalPageWithResponse(ctx context.Context, pageId string, params *GetExternalPageParams, reqEditors ...RequestEditorFn) (*GetExternalPageResponse, error)

	// UpdateExternalPageWithBodyWithResponse request with any body
	UpdateExternalPageWithBodyWithResponse(ctx context.Context, pageId string, params *UpdateExternalPageParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateExternalPageResponse, error)

	UpdateExternalPageWithResponse(ctx context.Context, pageId string, params *UpdateExternalPageParams, body UpdateExternalPageJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateExternalPageResponse, error)

	// ListArticlesWithResponse request
	ListArticlesWithResponse(ctx context.Context, params *ListArticlesParams, reqEditors ...RequestEditorFn) (*ListArticlesResponse, error)

	// CreateArticleWithBodyWithResponse request with any body
	CreateArticleWithBodyWithResponse(ctx context.Context, params *CreateArticleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateArticleResponse, error)

	CreateArticleWithResponse(ctx context.Context, params *CreateArticleParams, body CreateArticleJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateArticleResponse, error)

	// SearchArticlesWithResponse request
	SearchArticlesWithResponse(ctx context.Context, params *SearchArticlesParams, reqEditors ...RequestEditorFn) (*SearchArticlesResponse, error)

	// DeleteArticleWithResponse request
	DeleteArticleWithResponse(ctx context.Context, articleId int, params *DeleteArticleParams, reqEditors ...RequestEditorFn) (*DeleteArticleResponse, error)

	// RetrieveArticleWithResponse request
	RetrieveArticleWithResponse(ctx context.Context, articleId int, params *RetrieveArticleParams, reqEditors ...RequestEditorFn) (*RetrieveArticleResponse, error)

	// UpdateArticleWithBodyWithResponse request with any body
	UpdateArticleWithBodyWithResponse(ctx context.Context, articleId int, params *UpdateArticleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateArticleResponse, error)

	UpdateArticleWithResponse(ctx context.Context, articleId int, params *UpdateArticleParams, body UpdateArticleJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateArticleResponse, error)

	// ListAwayStatusReasonsWithResponse request
	ListAwayStatusReasonsWithResponse(ctx context.Context, params *ListAwayStatusReasonsParams, reqEditors ...RequestEditorFn) (*ListAwayStatusReasonsResponse, error)

	// ListBrandsWithResponse request
	ListBrandsWithResponse(ctx context.Context, params *ListBrandsParams, reqEditors ...RequestEditorFn) (*ListBrandsResponse, error)

	// RetrieveBrandWithResponse request
	RetrieveBrandWithResponse(ctx context.Context, id string, params *RetrieveBrandParams, reqEditors ...RequestEditorFn) (*RetrieveBrandResponse, error)

	// ListCallsWithResponse request
	ListCallsWithResponse(ctx context.Context, params *ListCallsParams, reqEditors ...RequestEditorFn) (*ListCallsResponse, error)

	// ListCallsWithTranscriptsWithBodyWithResponse request with any body
	ListCallsWithTranscriptsWithBodyWithResponse(ctx context.Context, params *ListCallsWithTranscriptsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ListCallsWithTranscriptsResponse, error)

	ListCallsWithTranscriptsWithResponse(ctx context.Context, params *ListCallsWithTranscriptsParams, body ListCallsWithTranscriptsJSONRequestBody, reqEditors ...RequestEditorFn) (*ListCallsWithTranscriptsResponse, error)

	// ShowCallWithResponse request
	ShowCallWithResponse(ctx context.Context, callId string, params *ShowCallParams, reqEditors ...RequestEditorFn) (*ShowCallResponse, error)

	// ShowCallRecordingWithResponse request
	ShowCallRecordingWithResponse(ctx context.Context, callId string, params *ShowCallRecordingParams, reqEditors ...RequestEditorFn) (*ShowCallRecordingResponse, error)

	// ShowCallTranscriptWithResponse request
	ShowCallTranscriptWithResponse(ctx context.Context, callId string, params *ShowCallTranscriptParams, reqEditors ...RequestEditorFn) (*ShowCallTranscriptResponse, error)

	// RetrieveCompanyWithResponse request
	RetrieveCompanyWithResponse(ctx context.Context, params *RetrieveCompanyParams, reqEditors ...RequestEditorFn) (*RetrieveCompanyResponse, error)

	// CreateOrUpdateCompanyWithBodyWithResponse request with any body
	CreateOrUpdateCompanyWithBodyWithResponse(ctx context.Context, params *CreateOrUpdateCompanyParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateOrUpdateCompanyResponse, error)

	CreateOrUpdateCompanyWithResponse(ctx context.Context, params *CreateOrUpdateCompanyParams, body CreateOrUpdateCompanyJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateOrUpdateCompanyResponse, error)

	// ListAllCompaniesWithResponse request
	ListAllCompaniesWithResponse(ctx context.Context, params *ListAllCompaniesParams, reqEditors ...RequestEditorFn) (*ListAllCompaniesResponse, error)

	// ScrollOverAllCompaniesWithResponse request
	ScrollOverAllCompaniesWithResponse(ctx context.Context, params *ScrollOverAllCompaniesParams, reqEditors ...RequestEditorFn) (*ScrollOverAllCompaniesResponse, error)

	// DeleteCompanyWithResponse request
	DeleteCompanyWithResponse(ctx context.Context, companyId string, params *DeleteCompanyParams, reqEditors ...RequestEditorFn) (*DeleteCompanyResponse, error)

	// RetrieveACompanyByIdWithResponse request
	RetrieveACompanyByIdWithResponse(ctx context.Context, companyId string, params *RetrieveACompanyByIdParams, reqEditors ...RequestEditorFn) (*RetrieveACompanyByIdResponse, error)

	// UpdateCompanyWithBodyWithResponse request with any body
	UpdateCompanyWithBodyWithResponse(ctx context.Context, companyId string, params *UpdateCompanyParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateCompanyResponse, error)

	UpdateCompanyWithResponse(ctx context.Context, companyId string, params *UpdateCompanyParams, body UpdateCompanyJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateCompanyResponse, error)

	// ListAttachedContactsWithResponse request
	ListAttachedContactsWithResponse(ctx context.Context, companyId string, params *ListAttachedContactsParams, reqEditors ...RequestEditorFn) (*ListAttachedContactsResponse, error)

	// ListCompanyNotesWithResponse request
	ListCompanyNotesWithResponse(ctx context.Context, companyId string, params *ListCompanyNotesParams, reqEditors ...RequestEditorFn) (*ListCompanyNotesResponse, error)

	// ListAttachedSegmentsForCompaniesWithResponse request
	ListAttachedSegmentsForCompaniesWithResponse(ctx context.Context, companyId string, params *ListAttachedSegmentsForCompaniesParams, reqEditors ...RequestEditorFn) (*ListAttachedSegmentsForCompaniesResponse, error)

	// ListContactsWithResponse request
	ListContactsWithResponse(ctx context.Context, params *ListContactsParams, reqEditors ...RequestEditorFn) (*ListContactsResponse, error)

	// CreateContactWithBodyWithResponse request with any body
	CreateContactWithBodyWithResponse(ctx context.Context, params *CreateContactParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateContactResponse, error)

	CreateContactWithResponse(ctx context.Context, params *CreateContactParams, body CreateContactJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateContactResponse, error)

	// ShowContactByExternalIdWithResponse request
	ShowContactByExternalIdWithResponse(ctx context.Context, externalId string, params *ShowContactByExternalIdParams, reqEditors ...RequestEditorFn) (*ShowContactByExternalIdResponse, error)

	// MergeContactWithBodyWithResponse request with any body
	MergeContactWithBodyWithResponse(ctx context.Context, params *MergeContactParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*MergeContactResponse, error)

	MergeContactWithResponse(ctx context.Context, params *MergeContactParams, body MergeContactJSONRequestBody, reqEditors ...RequestEditorFn) (*MergeContactResponse, error)

	// SearchContactsWithBodyWithResponse request with any body
	SearchContactsWithBodyWithResponse(ctx context.Context, params *SearchContactsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SearchContactsResponse, error)

	SearchContactsWithResponse(ctx context.Context, params *SearchContactsParams, body SearchContactsJSONRequestBody, reqEditors ...RequestEditorFn) (*SearchContactsResponse, error)

	// DeleteContactWithResponse request
	DeleteContactWithResponse(ctx context.Context, contactId string, params *DeleteContactParams, reqEditors ...RequestEditorFn) (*DeleteContactResponse, error)

	// ShowContactWithResponse request
	ShowContactWithResponse(ctx context.Context, contactId string, params *ShowContactParams, reqEditors ...RequestEditorFn) (*ShowContactResponse, error)

	// UpdateContactWithBodyWithResponse request with any body
	UpdateContactWithBodyWithResponse(ctx context.Context, contactId string, params *UpdateContactParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateContactResponse, error)

	UpdateContactWithResponse(ctx context.Context, contactId string, params *UpdateContactParams, body UpdateContactJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateContactResponse, error)

	// ArchiveContactWithResponse request
	ArchiveContactWithResponse(ctx context.Context, contactId string, params *ArchiveContactParams, reqEditors ...RequestEditorFn) (*ArchiveContactResponse, error)

	// BlockContactWithResponse request
	BlockContactWithResponse(ctx context.Context, contactId string, params *BlockContactParams, reqEditors ...RequestEditorFn) (*BlockContactResponse, error)

	// ListCompaniesForAContactWithResponse request
	ListCompaniesForAContactWithResponse(ctx context.Context, contactId string, params *ListCompaniesForAContactParams, reqEditors ...RequestEditorFn) (*ListCompaniesForAContactResponse, error)

	// AttachContactToACompanyWithBodyWithResponse request with any body
	AttachContactToACompanyWithBodyWithResponse(ctx context.Context, contactId string, params *AttachContactToACompanyParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AttachContactToACompanyResponse, error)

	AttachContactToACompanyWithResponse(ctx context.Context, contactId string, params *AttachContactToACompanyParams, body AttachContactToACompanyJSONRequestBody, reqEditors ...RequestEditorFn) (*AttachContactToACompanyResponse, error)

	// DetachContactFromACompanyWithResponse request
	DetachContactFromACompanyWithResponse(ctx context.Context, contactId string, companyId string, params *DetachContactFromACompanyParams, reqEditors ...RequestEditorFn) (*DetachContactFromACompanyResponse, error)

	// ListNotesWithResponse request
	ListNotesWithResponse(ctx context.Context, contactId string, params *ListNotesParams, reqEditors ...RequestEditorFn) (*ListNotesResponse, error)

	// CreateNoteWithBodyWithResponse request with any body
	CreateNoteWithBodyWithResponse(ctx context.Context, contactId int, params *CreateNoteParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateNoteResponse, error)

	CreateNoteWithResponse(ctx context.Context, contactId int, params *CreateNoteParams, body CreateNoteJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateNoteResponse, error)

	// ListSegmentsForAContactWithResponse request
	ListSegmentsForAContactWithResponse(ctx context.Context, contactId string, params *ListSegmentsForAContactParams, reqEditors ...RequestEditorFn) (*ListSegmentsForAContactResponse, error)

	// ListSubscriptionsForAContactWithResponse request
	ListSubscriptionsForAContactWithResponse(ctx context.Context, contactId string, params *ListSubscriptionsForAContactParams, reqEditors ...RequestEditorFn) (*ListSubscriptionsForAContactResponse, error)

	// AttachSubscriptionTypeToContactWithBodyWithResponse request with any body
	AttachSubscriptionTypeToContactWithBodyWithResponse(ctx context.Context, contactId string, params *AttachSubscriptionTypeToContactParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AttachSubscriptionTypeToContactResponse, error)

	AttachSubscriptionTypeToContactWithResponse(ctx context.Context, contactId string, params *AttachSubscriptionTypeToContactParams, body AttachSubscriptionTypeToContactJSONRequestBody, reqEditors ...RequestEditorFn) (*AttachSubscriptionTypeToContactResponse, error)

	// DetachSubscriptionTypeToContactWithResponse request
	DetachSubscriptionTypeToContactWithResponse(ctx context.Context, contactId string, subscriptionId string, params *DetachSubscriptionTypeToContactParams, reqEditors ...RequestEditorFn) (*DetachSubscriptionTypeToContactResponse, error)

	// ListTagsForAContactWithResponse request
	ListTagsForAContactWithResponse(ctx context.Context, contactId string, params *ListTagsForAContactParams, reqEditors ...RequestEditorFn) (*ListTagsForAContactResponse, error)

	// AttachTagToContactWithBodyWithResponse request with any body
	AttachTagToContactWithBodyWithResponse(ctx context.Context, contactId string, params *AttachTagToContactParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AttachTagToContactResponse, error)

	AttachTagToContactWithResponse(ctx context.Context, contactId string, params *AttachTagToContactParams, body AttachTagToContactJSONRequestBody, reqEditors ...RequestEditorFn) (*AttachTagToContactResponse, error)

	// DetachTagFromContactWithResponse request
	DetachTagFromContactWithResponse(ctx context.Context, contactId string, tagId string, params *DetachTagFromContactParams, reqEditors ...RequestEditorFn) (*DetachTagFromContactResponse, error)

	// UnarchiveContactWithResponse request
	UnarchiveContactWithResponse(ctx context.Context, contactId string, params *UnarchiveContactParams, reqEditors ...RequestEditorFn) (*UnarchiveContactResponse, error)

	// ListConversationsWithResponse request
	ListConversationsWithResponse(ctx context.Context, params *ListConversationsParams, reqEditors ...RequestEditorFn) (*ListConversationsResponse, error)

	// CreateConversationWithBodyWithResponse request with any body
	CreateConversationWithBodyWithResponse(ctx context.Context, params *CreateConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateConversationResponse, error)

	CreateConversationWithResponse(ctx context.Context, params *CreateConversationParams, body CreateConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateConversationResponse, error)

	// RedactConversationWithBodyWithResponse request with any body
	RedactConversationWithBodyWithResponse(ctx context.Context, params *RedactConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RedactConversationResponse, error)

	RedactConversationWithResponse(ctx context.Context, params *RedactConversationParams, body RedactConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*RedactConversationResponse, error)

	// SearchConversationsWithBodyWithResponse request with any body
	SearchConversationsWithBodyWithResponse(ctx context.Context, params *SearchConversationsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SearchConversationsResponse, error)

	SearchConversationsWithResponse(ctx context.Context, params *SearchConversationsParams, body SearchConversationsJSONRequestBody, reqEditors ...RequestEditorFn) (*SearchConversationsResponse, error)

	// DeleteConversationWithResponse request
	DeleteConversationWithResponse(ctx context.Context, conversationId int, params *DeleteConversationParams, reqEditors ...RequestEditorFn) (*DeleteConversationResponse, error)

	// RetrieveConversationWithResponse request
	RetrieveConversationWithResponse(ctx context.Context, conversationId int, params *RetrieveConversationParams, reqEditors ...RequestEditorFn) (*RetrieveConversationResponse, error)

	// UpdateConversationWithBodyWithResponse request with any body
	UpdateConversationWithBodyWithResponse(ctx context.Context, conversationId int, params *UpdateConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateConversationResponse, error)

	UpdateConversationWithResponse(ctx context.Context, conversationId int, params *UpdateConversationParams, body UpdateConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateConversationResponse, error)

	// ConvertConversationToTicketWithBodyWithResponse request with any body
	ConvertConversationToTicketWithBodyWithResponse(ctx context.Context, conversationId int, params *ConvertConversationToTicketParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ConvertConversationToTicketResponse, error)

	ConvertConversationToTicketWithResponse(ctx context.Context, conversationId int, params *ConvertConversationToTicketParams, body ConvertConversationToTicketJSONRequestBody, reqEditors ...RequestEditorFn) (*ConvertConversationToTicketResponse, error)

	// AttachContactToConversationWithBodyWithResponse request with any body
	AttachContactToConversationWithBodyWithResponse(ctx context.Context, conversationId string, params *AttachContactToConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AttachContactToConversationResponse, error)

	AttachContactToConversationWithResponse(ctx context.Context, conversationId string, params *AttachContactToConversationParams, body AttachContactToConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*AttachContactToConversationResponse, error)

	// DetachContactFromConversationWithBodyWithResponse request with any body
	DetachContactFromConversationWithBodyWithResponse(ctx context.Context, conversationId string, contactId string, params *DetachContactFromConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DetachContactFromConversationResponse, error)

	DetachContactFromConversationWithResponse(ctx context.Context, conversationId string, contactId string, params *DetachContactFromConversationParams, body DetachContactFromConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*DetachContactFromConversationResponse, error)

	// ManageConversationWithBodyWithResponse request with any body
	ManageConversationWithBodyWithResponse(ctx context.Context, conversationId string, params *ManageConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ManageConversationResponse, error)

	ManageConversationWithResponse(ctx context.Context, conversationId string, params *ManageConversationParams, body ManageConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*ManageConversationResponse, error)

	// ReplyConversationWithBodyWithResponse request with any body
	ReplyConversationWithBodyWithResponse(ctx context.Context, conversationId string, params *ReplyConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ReplyConversationResponse, error)

	ReplyConversationWithResponse(ctx context.Context, conversationId string, params *ReplyConversationParams, body ReplyConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*ReplyConversationResponse, error)

	// AttachTagToConversationWithBodyWithResponse request with any body
	AttachTagToConversationWithBodyWithResponse(ctx context.Context, conversationId string, params *AttachTagToConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AttachTagToConversationResponse, error)

	AttachTagToConversationWithResponse(ctx context.Context, conversationId string, params *AttachTagToConversationParams, body AttachTagToConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*AttachTagToConversationResponse, error)

	// DetachTagFromConversationWithBodyWithResponse request with any body
	DetachTagFromConversationWithBodyWithResponse(ctx context.Context, conversationId string, tagId string, params *DetachTagFromConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DetachTagFromConversationResponse, error)

	DetachTagFromConversationWithResponse(ctx context.Context, conversationId string, tagId string, params *DetachTagFromConversationParams, body DetachTagFromConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*DetachTagFromConversationResponse, error)

	// ListHandlingEventsWithResponse request
	ListHandlingEventsWithResponse(ctx context.Context, id string, params *ListHandlingEventsParams, reqEditors ...RequestEditorFn) (*ListHandlingEventsResponse, error)

	// DeleteCustomObjectInstancesByIdWithResponse request
	DeleteCustomObjectInstancesByIdWithResponse(ctx context.Context, customObjectTypeIdentifier string, params *DeleteCustomObjectInstancesByIdParams, reqEditors ...RequestEditorFn) (*DeleteCustomObjectInstancesByIdResponse, error)

	// GetCustomObjectInstancesByExternalIdWithResponse request
	GetCustomObjectInstancesByExternalIdWithResponse(ctx context.Context, customObjectTypeIdentifier string, params *GetCustomObjectInstancesByExternalIdParams, reqEditors ...RequestEditorFn) (*GetCustomObjectInstancesByExternalIdResponse, error)

	// CreateCustomObjectInstancesWithBodyWithResponse request with any body
	CreateCustomObjectInstancesWithBodyWithResponse(ctx context.Context, customObjectTypeIdentifier string, params *CreateCustomObjectInstancesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateCustomObjectInstancesResponse, error)

	CreateCustomObjectInstancesWithResponse(ctx context.Context, customObjectTypeIdentifier string, params *CreateCustomObjectInstancesParams, body CreateCustomObjectInstancesJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateCustomObjectInstancesResponse, error)

	// DeleteCustomObjectInstancesByExternalIdWithResponse request
	DeleteCustomObjectInstancesByExternalIdWithResponse(ctx context.Context, customObjectTypeIdentifier string, customObjectInstanceId string, params *DeleteCustomObjectInstancesByExternalIdParams, reqEditors ...RequestEditorFn) (*DeleteCustomObjectInstancesByExternalIdResponse, error)

	// GetCustomObjectInstancesByIdWithResponse request
	GetCustomObjectInstancesByIdWithResponse(ctx context.Context, customObjectTypeIdentifier string, customObjectInstanceId string, params *GetCustomObjectInstancesByIdParams, reqEditors ...RequestEditorFn) (*GetCustomObjectInstancesByIdResponse, error)

	// LisDataAttributesWithResponse request
	LisDataAttributesWithResponse(ctx context.Context, params *LisDataAttributesParams, reqEditors ...RequestEditorFn) (*LisDataAttributesResponse, error)

	// CreateDataAttributeWithBodyWithResponse request with any body
	CreateDataAttributeWithBodyWithResponse(ctx context.Context, params *CreateDataAttributeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDataAttributeResponse, error)

	CreateDataAttributeWithResponse(ctx context.Context, params *CreateDataAttributeParams, body CreateDataAttributeJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateDataAttributeResponse, error)

	// UpdateDataAttributeWithBodyWithResponse request with any body
	UpdateDataAttributeWithBodyWithResponse(ctx context.Context, dataAttributeId int, params *UpdateDataAttributeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDataAttributeResponse, error)

	UpdateDataAttributeWithResponse(ctx context.Context, dataAttributeId int, params *UpdateDataAttributeParams, body UpdateDataAttributeJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDataAttributeResponse, error)

	// DownloadDataExportWithResponse request
	DownloadDataExportWithResponse(ctx context.Context, jobIdentifier string, params *DownloadDataExportParams, reqEditors ...RequestEditorFn) (*DownloadDataExportResponse, error)

	// GetDownloadReportingDataJobIdentifierWithResponse request
	GetDownloadReportingDataJobIdentifierWithResponse(ctx context.Context, jobIdentifier string, params *GetDownloadReportingDataJobIdentifierParams, reqEditors ...RequestEditorFn) (*GetDownloadReportingDataJobIdentifierResponse, error)

	// ListEmailsWithResponse request
	ListEmailsWithResponse(ctx context.Context, params *ListEmailsParams, reqEditors ...RequestEditorFn) (*ListEmailsResponse, error)

	// RetrieveEmailWithResponse request
	RetrieveEmailWithResponse(ctx context.Context, id string, params *RetrieveEmailParams, reqEditors ...RequestEditorFn) (*RetrieveEmailResponse, error)

	// LisDataEventsWithResponse request
	LisDataEventsWithResponse(ctx context.Context, params *LisDataEventsParams, reqEditors ...RequestEditorFn) (*LisDataEventsResponse, error)

	// CreateDataEventWithBodyWithResponse request with any body
	CreateDataEventWithBodyWithResponse(ctx context.Context, params *CreateDataEventParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDataEventResponse, error)

	CreateDataEventWithResponse(ctx context.Context, params *CreateDataEventParams, body CreateDataEventJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateDataEventResponse, error)

	// DataEventSummariesWithBodyWithResponse request with any body
	DataEventSummariesWithBodyWithResponse(ctx context.Context, params *DataEventSummariesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DataEventSummariesResponse, error)

	DataEventSummariesWithResponse(ctx context.Context, params *DataEventSummariesParams, body DataEventSummariesJSONRequestBody, reqEditors ...RequestEditorFn) (*DataEventSummariesResponse, error)

	// CancelDataExportWithResponse request
	CancelDataExportWithResponse(ctx context.Context, jobIdentifier string, params *CancelDataExportParams, reqEditors ...RequestEditorFn) (*CancelDataExportResponse, error)

	// CreateDataExportWithBodyWithResponse request with any body
	CreateDataExportWithBodyWithResponse(ctx context.Context, params *CreateDataExportParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDataExportResponse, error)

	CreateDataExportWithResponse(ctx context.Context, params *CreateDataExportParams, body CreateDataExportJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateDataExportResponse, error)

	// GetDataExportWithResponse request
	GetDataExportWithResponse(ctx context.Context, jobIdentifier string, params *GetDataExportParams, reqEditors ...RequestEditorFn) (*GetDataExportResponse, error)

	// PostExportReportingDataEnqueueWithBodyWithResponse request with any body
	PostExportReportingDataEnqueueWithBodyWithResponse(ctx context.Context, params *PostExportReportingDataEnqueueParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostExportReportingDataEnqueueResponse, error)

	PostExportReportingDataEnqueueWithResponse(ctx context.Context, params *PostExportReportingDataEnqueueParams, body PostExportReportingDataEnqueueJSONRequestBody, reqEditors ...RequestEditorFn) (*PostExportReportingDataEnqueueResponse, error)

	// GetExportReportingDataGetDatasetsWithResponse request
	GetExportReportingDataGetDatasetsWithResponse(ctx context.Context, params *GetExportReportingDataGetDatasetsParams, reqEditors ...RequestEditorFn) (*GetExportReportingDataGetDatasetsResponse, error)

	// GetExportReportingDataJobIdentifierWithResponse request
	GetExportReportingDataJobIdentifierWithResponse(ctx context.Context, jobIdentifier string, params *GetExportReportingDataJobIdentifierParams, reqEditors ...RequestEditorFn) (*GetExportReportingDataJobIdentifierResponse, error)

	// ExportWorkflowWithResponse request
	ExportWorkflowWithResponse(ctx context.Context, id string, params *ExportWorkflowParams, reqEditors ...RequestEditorFn) (*ExportWorkflowResponse, error)

	// ReplyToFinWithBodyWithResponse request with any body
	ReplyToFinWithBodyWithResponse(ctx context.Context, params *ReplyToFinParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ReplyToFinResponse, error)

	ReplyToFinWithResponse(ctx context.Context, params *ReplyToFinParams, body ReplyToFinJSONRequestBody, reqEditors ...RequestEditorFn) (*ReplyToFinResponse, error)

	// StartFinConversationWithBodyWithResponse request with any body
	StartFinConversationWithBodyWithResponse(ctx context.Context, params *StartFinConversationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*StartFinConversationResponse, error)

	StartFinConversationWithResponse(ctx context.Context, params *StartFinConversationParams, body StartFinConversationJSONRequestBody, reqEditors ...RequestEditorFn) (*StartFinConversationResponse, error)

	// CollectFinVoiceCallByIdWithResponse request
	CollectFinVoiceCallByIdWithResponse(ctx context.Context, id int, reqEditors ...RequestEditorFn) (*CollectFinVoiceCallByIdResponse, error)

	// CollectFinVoiceCallsByConversationIdWithResponse request
	CollectFinVoiceCallsByConversationIdWithResponse(ctx context.Context, conversationId string, reqEditors ...RequestEditorFn) (*CollectFinVoiceCallsByConversationIdResponse, error)

	// CollectFinVoiceCallByExternalIdWithResponse request
	CollectFinVoiceCallByExternalIdWithResponse(ctx context.Context, externalId string, reqEditors ...RequestEditorFn) (*CollectFinVoiceCallByExternalIdResponse, error)

	// CollectFinVoiceCallByPhoneNumberWithResponse request
	CollectFinVoiceCallByPhoneNumberWithResponse(ctx context.Context, phoneNumber string, reqEditors ...RequestEditorFn) (*CollectFinVoiceCallByPhoneNumberResponse, error)

	// RegisterFinVoiceCallWithBodyWithResponse request with any body
	RegisterFinVoiceCallWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RegisterFinVoiceCallResponse, error)

	RegisterFinVoiceCallWithResponse(ctx context.Context, body RegisterFinVoiceCallJSONRequestBody, reqEditors ...RequestEditorFn) (*RegisterFinVoiceCallResponse, error)

	// ListAllCollectionsWithResponse request
	ListAllCollectionsWithResponse(ctx context.Context, params *ListAllCollectionsParams, reqEditors ...RequestEditorFn) (*ListAllCollectionsResponse, error)

	// CreateCollectionWithBodyWithResponse request with any body
	CreateCollectionWithBodyWithResponse(ctx context.Context, params *CreateCollectionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateCollectionResponse, error)

	CreateCollectionWithResponse(ctx context.Context, params *CreateCollectionParams, body CreateCollectionJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateCollectionResponse, error)

	// DeleteCollectionWithResponse request
	DeleteCollectionWithResponse(ctx context.Context, collectionId int, params *DeleteCollectionParams, reqEditors ...RequestEditorFn) (*DeleteCollectionResponse, error)

	// RetrieveCollectionWithResponse request
	RetrieveCollectionWithResponse(ctx context.Context, collectionId int, params *RetrieveCollectionParams, reqEditors ...RequestEditorFn) (*RetrieveCollectionResponse, error)

	// UpdateCollectionWithBodyWithResponse request with any body
	UpdateCollectionWithBodyWithResponse(ctx context.Context, collectionId int, params *UpdateCollectionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateCollectionResponse, error)

	UpdateCollectionWithResponse(ctx context.Context, collectionId int, params *UpdateCollectionParams, body UpdateCollectionJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateCollectionResponse, error)

	// ListHelpCentersWithResponse request
	ListHelpCentersWithResponse(ctx context.Context, params *ListHelpCentersParams, reqEditors ...RequestEditorFn) (*ListHelpCentersResponse, error)

	// RetrieveHelpCenterWithResponse request
	RetrieveHelpCenterWithResponse(ctx context.Context, helpCenterId int, params *RetrieveHelpCenterParams, reqEditors ...RequestEditorFn) (*RetrieveHelpCenterResponse, error)

	// ListInternalArticlesWithResponse request
	ListInternalArticlesWithResponse(ctx context.Context, params *ListInternalArticlesParams, reqEditors ...RequestEditorFn) (*ListInternalArticlesResponse, error)

	// CreateInternalArticleWithBodyWithResponse request with any body
	CreateInternalArticleWithBodyWithResponse(ctx context.Context, params *CreateInternalArticleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateInternalArticleResponse, error)

	CreateInternalArticleWithResponse(ctx context.Context, params *CreateInternalArticleParams, body CreateInternalArticleJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateInternalArticleResponse, error)

	// SearchInternalArticlesWithResponse request
	SearchInternalArticlesWithResponse(ctx context.Context, params *SearchInternalArticlesParams, reqEditors ...RequestEditorFn) (*SearchInternalArticlesResponse, error)

	// DeleteInternalArticleWithResponse request
	DeleteInternalArticleWithResponse(ctx context.Context, internalArticleId int, params *DeleteInternalArticleParams, reqEditors ...RequestEditorFn) (*DeleteInternalArticleResponse, error)

	// RetrieveInternalArticleWithResponse request
	RetrieveInternalArticleWithResponse(ctx context.Context, internalArticleId int, params *RetrieveInternalArticleParams, reqEditors ...RequestEditorFn) (*RetrieveInternalArticleResponse, error)

	// UpdateInternalArticleWithBodyWithResponse request with any body
	UpdateInternalArticleWithBodyWithResponse(ctx context.Context, internalArticleId int, params *UpdateInternalArticleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateInternalArticleResponse, error)

	UpdateInternalArticleWithResponse(ctx context.Context, internalArticleId int, params *UpdateInternalArticleParams, body UpdateInternalArticleJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateInternalArticleResponse, error)

	// GetIpAllowlistWithResponse request
	GetIpAllowlistWithResponse(ctx context.Context, params *GetIpAllowlistParams, reqEditors ...RequestEditorFn) (*GetIpAllowlistResponse, error)

	// UpdateIpAllowlistWithBodyWithResponse request with any body
	UpdateIpAllowlistWithBodyWithResponse(ctx context.Context, params *UpdateIpAllowlistParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateIpAllowlistResponse, error)

	UpdateIpAllowlistWithResponse(ctx context.Context, params *UpdateIpAllowlistParams, body UpdateIpAllowlistJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateIpAllowlistResponse, error)

	// JobsStatusWithResponse request
	JobsStatusWithResponse(ctx context.Context, jobId string, params *JobsStatusParams, reqEditors ...RequestEditorFn) (*JobsStatusResponse, error)

	// IdentifyAdminWithResponse request
	IdentifyAdminWithResponse(ctx context.Context, params *IdentifyAdminParams, reqEditors ...RequestEditorFn) (*IdentifyAdminResponse, error)

	// CreateMessageWithBodyWithResponse request with any body
	CreateMessageWithBodyWithResponse(ctx context.Context, params *CreateMessageParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateMessageResponse, error)

	CreateMessageWithResponse(ctx context.Context, params *CreateMessageParams, body CreateMessageJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateMessageResponse, error)

	// ListNewsItemsWithResponse request
	ListNewsItemsWithResponse(ctx context.Context, params *ListNewsItemsParams, reqEditors ...RequestEditorFn) (*ListNewsItemsResponse, error)

	// CreateNewsItemWithBodyWithResponse request with any body
	CreateNewsItemWithBodyWithResponse(ctx context.Context, params *CreateNewsItemParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateNewsItemResponse, error)

	CreateNewsItemWithResponse(ctx context.Context, params *CreateNewsItemParams, body CreateNewsItemJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateNewsItemResponse, error)

	// DeleteNewsItemWithResponse request
	DeleteNewsItemWithResponse(ctx context.Context, newsItemId int, params *DeleteNewsItemParams, reqEditors ...RequestEditorFn) (*DeleteNewsItemResponse, error)

	// RetrieveNewsItemWithResponse request
	RetrieveNewsItemWithResponse(ctx context.Context, newsItemId int, params *RetrieveNewsItemParams, reqEditors ...RequestEditorFn) (*RetrieveNewsItemResponse, error)

	// UpdateNewsItemWithBodyWithResponse request with any body
	UpdateNewsItemWithBodyWithResponse(ctx context.Context, newsItemId int, params *UpdateNewsItemParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateNewsItemResponse, error)

	UpdateNewsItemWithResponse(ctx context.Context, newsItemId int, params *UpdateNewsItemParams, body UpdateNewsItemJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateNewsItemResponse, error)

	// ListNewsfeedsWithResponse request
	ListNewsfeedsWithResponse(ctx context.Context, params *ListNewsfeedsParams, reqEditors ...RequestEditorFn) (*ListNewsfeedsResponse, error)

	// RetrieveNewsfeedWithResponse request
	RetrieveNewsfeedWithResponse(ctx context.Context, newsfeedId string, params *RetrieveNewsfeedParams, reqEditors ...RequestEditorFn) (*RetrieveNewsfeedResponse, error)

	// ListLiveNewsfeedItemsWithResponse request
	ListLiveNewsfeedItemsWithResponse(ctx context.Context, newsfeedId string, params *ListLiveNewsfeedItemsParams, reqEditors ...RequestEditorFn) (*ListLiveNewsfeedItemsResponse, error)

	// RetrieveNoteWithResponse request
	RetrieveNoteWithResponse(ctx context.Context, noteId int, params *RetrieveNoteParams, reqEditors ...RequestEditorFn) (*RetrieveNoteResponse, error)

	// CreatePhoneSwitchWithBodyWithResponse request with any body
	CreatePhoneSwitchWithBodyWithResponse(ctx context.Context, params *CreatePhoneSwitchParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreatePhoneSwitchResponse, error)

	CreatePhoneSwitchWithResponse(ctx context.Context, params *CreatePhoneSwitchParams, body CreatePhoneSwitchJSONRequestBody, reqEditors ...RequestEditorFn) (*CreatePhoneSwitchResponse, error)

	// ListSegmentsWithResponse request
	ListSegmentsWithResponse(ctx context.Context, params *ListSegmentsParams, reqEditors ...RequestEditorFn) (*ListSegmentsResponse, error)

	// RetrieveSegmentWithResponse request
	RetrieveSegmentWithResponse(ctx context.Context, segmentId string, params *RetrieveSegmentParams, reqEditors ...RequestEditorFn) (*RetrieveSegmentResponse, error)

	// ListSubscriptionTypesWithResponse request
	ListSubscriptionTypesWithResponse(ctx context.Context, params *ListSubscriptionTypesParams, reqEditors ...RequestEditorFn) (*ListSubscriptionTypesResponse, error)

	// ListTagsWithResponse request
	ListTagsWithResponse(ctx context.Context, params *ListTagsParams, reqEditors ...RequestEditorFn) (*ListTagsResponse, error)

	// CreateTagWithBodyWithResponse request with any body
	CreateTagWithBodyWithResponse(ctx context.Context, params *CreateTagParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateTagResponse, error)

	CreateTagWithResponse(ctx context.Context, params *CreateTagParams, body CreateTagJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateTagResponse, error)

	// DeleteTagWithResponse request
	DeleteTagWithResponse(ctx context.Context, tagId string, params *DeleteTagParams, reqEditors ...RequestEditorFn) (*DeleteTagResponse, error)

	// FindTagWithResponse request
	FindTagWithResponse(ctx context.Context, tagId string, params *FindTagParams, reqEditors ...RequestEditorFn) (*FindTagResponse, error)

	// ListTeamsWithResponse request
	ListTeamsWithResponse(ctx context.Context, params *ListTeamsParams, reqEditors ...RequestEditorFn) (*ListTeamsResponse, error)

	// RetrieveTeamWithResponse request
	RetrieveTeamWithResponse(ctx context.Context, teamId string, params *RetrieveTeamParams, reqEditors ...RequestEditorFn) (*RetrieveTeamResponse, error)

	// ListTicketStatesWithResponse request
	ListTicketStatesWithResponse(ctx context.Context, params *ListTicketStatesParams, reqEditors ...RequestEditorFn) (*ListTicketStatesResponse, error)

	// ListTicketTypesWithResponse request
	ListTicketTypesWithResponse(ctx context.Context, params *ListTicketTypesParams, reqEditors ...RequestEditorFn) (*ListTicketTypesResponse, error)

	// CreateTicketTypeWithBodyWithResponse request with any body
	CreateTicketTypeWithBodyWithResponse(ctx context.Context, params *CreateTicketTypeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateTicketTypeResponse, error)

	CreateTicketTypeWithResponse(ctx context.Context, params *CreateTicketTypeParams, body CreateTicketTypeJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateTicketTypeResponse, error)

	// GetTicketTypeWithResponse request
	GetTicketTypeWithResponse(ctx context.Context, ticketTypeId string, params *GetTicketTypeParams, reqEditors ...RequestEditorFn) (*GetTicketTypeResponse, error)

	// UpdateTicketTypeWithBodyWithResponse request with any body
	UpdateTicketTypeWithBodyWithResponse(ctx context.Context, ticketTypeId string, params *UpdateTicketTypeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateTicketTypeResponse, error)

	UpdateTicketTypeWithResponse(ctx context.Context, ticketTypeId string, params *UpdateTicketTypeParams, body UpdateTicketTypeJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateTicketTypeResponse, error)

	// CreateTicketTypeAttributeWithBodyWithResponse request with any body
	CreateTicketTypeAttributeWithBodyWithResponse(ctx context.Context, ticketTypeId string, params *CreateTicketTypeAttributeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateTicketTypeAttributeResponse, error)

	CreateTicketTypeAttributeWithResponse(ctx context.Context, ticketTypeId string, params *CreateTicketTypeAttributeParams, body CreateTicketTypeAttributeJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateTicketTypeAttributeResponse, error)

	// UpdateTicketTypeAttributeWithBodyWithResponse request with any body
	UpdateTicketTypeAttributeWithBodyWithResponse(ctx context.Context, ticketTypeId string, attributeId string, params *UpdateTicketTypeAttributeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateTicketTypeAttributeResponse, error)

	UpdateTicketTypeAttributeWithResponse(ctx context.Context, ticketTypeId string, attributeId string, params *UpdateTicketTypeAttributeParams, body UpdateTicketTypeAttributeJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateTicketTypeAttributeResponse, error)

	// CreateTicketWithBodyWithResponse request with any body
	CreateTicketWithBodyWithResponse(ctx context.Context, params *CreateTicketParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateTicketResponse, error)

	CreateTicketWithResponse(ctx context.Context, params *CreateTicketParams, body CreateTicketJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateTicketResponse, error)

	// EnqueueCreateTicketWithBodyWithResponse request with any body
	EnqueueCreateTicketWithBodyWithResponse(ctx context.Context, params *EnqueueCreateTicketParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*EnqueueCreateTicketResponse, error)

	EnqueueCreateTicketWithResponse(ctx context.Context, params *EnqueueCreateTicketParams, body EnqueueCreateTicketJSONRequestBody, reqEditors ...RequestEditorFn) (*EnqueueCreateTicketResponse, error)

	// SearchTicketsWithBodyWithResponse request with any body
	SearchTicketsWithBodyWithResponse(ctx context.Context, params *SearchTicketsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SearchTicketsResponse, error)

	SearchTicketsWithResponse(ctx context.Context, params *SearchTicketsParams, body SearchTicketsJSONRequestBody, reqEditors ...RequestEditorFn) (*SearchTicketsResponse, error)

	// DeleteTicketWithResponse request
	DeleteTicketWithResponse(ctx context.Context, ticketId string, params *DeleteTicketParams, reqEditors ...RequestEditorFn) (*DeleteTicketResponse, error)

	// GetTicketWithResponse request
	GetTicketWithResponse(ctx context.Context, ticketId string, params *GetTicketParams, reqEditors ...RequestEditorFn) (*GetTicketResponse, error)

	// UpdateTicketWithBodyWithResponse request with any body
	UpdateTicketWithBodyWithResponse(ctx context.Context, ticketId string, params *UpdateTicketParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateTicketResponse, error)

	UpdateTicketWithResponse(ctx context.Context, ticketId string, params *UpdateTicketParams, body UpdateTicketJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateTicketResponse, error)

	// ReplyTicketWithBodyWithResponse request with any body
	ReplyTicketWithBodyWithResponse(ctx context.Context, ticketId string, params *ReplyTicketParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ReplyTicketResponse, error)

	ReplyTicketWithResponse(ctx context.Context, ticketId string, params *ReplyTicketParams, body ReplyTicketJSONRequestBody, reqEditors ...RequestEditorFn) (*ReplyTicketResponse, error)

	// AttachTagToTicketWithBodyWithResponse request with any body
	AttachTagToTicketWithBodyWithResponse(ctx context.Context, ticketId string, params *AttachTagToTicketParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AttachTagToTicketResponse, error)

	AttachTagToTicketWithResponse(ctx context.Context, ticketId string, params *AttachTagToTicketParams, body AttachTagToTicketJSONRequestBody, reqEditors ...RequestEditorFn) (*AttachTagToTicketResponse, error)

	// DetachTagFromTicketWithBodyWithResponse request with any body
	DetachTagFromTicketWithBodyWithResponse(ctx context.Context, ticketId string, tagId string, params *DetachTagFromTicketParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DetachTagFromTicketResponse, error)

	DetachTagFromTicketWithResponse(ctx context.Context, ticketId string, tagId string, params *DetachTagFromTicketParams, body DetachTagFromTicketJSONRequestBody, reqEditors ...RequestEditorFn) (*DetachTagFromTicketResponse, error)

	// RetrieveVisitorWithUserIdWithResponse request
	RetrieveVisitorWithUserIdWithResponse(ctx context.Context, params *RetrieveVisitorWithUserIdParams, reqEditors ...RequestEditorFn) (*RetrieveVisitorWithUserIdResponse, error)

	// UpdateVisitorWithBodyWithResponse request with any body
	UpdateVisitorWithBodyWithResponse(ctx context.Context, params *UpdateVisitorParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateVisitorResponse, error)

	UpdateVisitorWithResponse(ctx context.Context, params *UpdateVisitorParams, body UpdateVisitorJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateVisitorResponse, error)

	// ConvertVisitorWithBodyWithResponse request with any body
	ConvertVisitorWithBodyWithResponse(ctx context.Context, params *ConvertVisitorParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ConvertVisitorResponse, error)

	ConvertVisitorWithResponse(ctx context.Context, params *ConvertVisitorParams, body ConvertVisitorJSONRequestBody, reqEditors ...RequestEditorFn) (*ConvertVisitorResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type CloseConversationRequestMessageType

type CloseConversationRequestMessageType string

CloseConversationRequestMessageType defines model for CloseConversationRequest.MessageType.

const (
	Close CloseConversationRequestMessageType = "close"
)

Defines values for CloseConversationRequestMessageType.

func (CloseConversationRequestMessageType) Valid

Valid indicates whether the value is a known member of the CloseConversationRequestMessageType enum.

type CloseConversationRequestSchema

type CloseConversationRequestSchema struct {
	// AdminId The id of the admin who is performing the action.
	AdminId string `json:"admin_id"`

	// Body Optionally you can leave a message in the conversation to provide additional context to the user and other teammates.
	Body        *string                             `json:"body,omitempty"`
	MessageType CloseConversationRequestMessageType `json:"message_type"`
	Type        CloseConversationRequestType        `json:"type"`
}

CloseConversationRequestSchema Payload of the request to close a conversation

type CloseConversationRequestType

type CloseConversationRequestType string

CloseConversationRequestType defines model for CloseConversationRequest.Type.

const (
	CloseConversationRequestTypeAdmin CloseConversationRequestType = "admin"
)

Defines values for CloseConversationRequestType.

func (CloseConversationRequestType) Valid

Valid indicates whether the value is a known member of the CloseConversationRequestType enum.

type CollectFinVoiceCallByExternalIdResponse

type CollectFinVoiceCallByExternalIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *AiCallResponseSchema
	JSON404      *ErrorSchema
	JSONDefault  *ErrorSchema
}

func ParseCollectFinVoiceCallByExternalIdResponse

func ParseCollectFinVoiceCallByExternalIdResponse(rsp *http.Response) (*CollectFinVoiceCallByExternalIdResponse, error)

ParseCollectFinVoiceCallByExternalIdResponse parses an HTTP response from a CollectFinVoiceCallByExternalIdWithResponse call

func (CollectFinVoiceCallByExternalIdResponse) Status

Status returns HTTPResponse.Status

func (CollectFinVoiceCallByExternalIdResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type CollectFinVoiceCallByIdResponse

type CollectFinVoiceCallByIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *AiCallResponseSchema
	JSON404      *ErrorSchema
	JSONDefault  *ErrorSchema
}

func ParseCollectFinVoiceCallByIdResponse

func ParseCollectFinVoiceCallByIdResponse(rsp *http.Response) (*CollectFinVoiceCallByIdResponse, error)

ParseCollectFinVoiceCallByIdResponse parses an HTTP response from a CollectFinVoiceCallByIdWithResponse call

func (CollectFinVoiceCallByIdResponse) Status

Status returns HTTPResponse.Status

func (CollectFinVoiceCallByIdResponse) StatusCode

func (r CollectFinVoiceCallByIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CollectFinVoiceCallByPhoneNumberResponse

type CollectFinVoiceCallByPhoneNumberResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
	JSONDefault  *ErrorSchema
}

func ParseCollectFinVoiceCallByPhoneNumberResponse

func ParseCollectFinVoiceCallByPhoneNumberResponse(rsp *http.Response) (*CollectFinVoiceCallByPhoneNumberResponse, error)

ParseCollectFinVoiceCallByPhoneNumberResponse parses an HTTP response from a CollectFinVoiceCallByPhoneNumberWithResponse call

func (CollectFinVoiceCallByPhoneNumberResponse) Status

Status returns HTTPResponse.Status

func (CollectFinVoiceCallByPhoneNumberResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type CollectFinVoiceCallsByConversationIdResponse

type CollectFinVoiceCallsByConversationIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]AiCallResponseSchema
	JSON401      *ErrorSchema
	JSONDefault  *ErrorSchema
}

func ParseCollectFinVoiceCallsByConversationIdResponse

func ParseCollectFinVoiceCallsByConversationIdResponse(rsp *http.Response) (*CollectFinVoiceCallsByConversationIdResponse, error)

ParseCollectFinVoiceCallsByConversationIdResponse parses an HTTP response from a CollectFinVoiceCallsByConversationIdWithResponse call

func (CollectFinVoiceCallsByConversationIdResponse) Status

Status returns HTTPResponse.Status

func (CollectFinVoiceCallsByConversationIdResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type CollectionListSchema

type CollectionListSchema struct {
	// Data An array of collection objects
	Data  *[]CollectionSchema `json:"data,omitempty"`
	Pages *CursorPagesSchema  `json:"pages,omitempty"`

	// TotalCount A count of the total number of collections.
	TotalCount *int `json:"total_count,omitempty"`

	// Type The type of the object - `list`.
	Type *CollectionListType `json:"type,omitempty"`
}

CollectionListSchema This will return a list of Collections for the App.

type CollectionListType

type CollectionListType string

CollectionListType The type of the object - `list`.

const (
	CollectionListTypeList CollectionListType = "list"
)

Defines values for CollectionListType.

func (CollectionListType) Valid

func (e CollectionListType) Valid() bool

Valid indicates whether the value is a known member of the CollectionListType enum.

type CollectionSchema

type CollectionSchema struct {
	// CreatedAt The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content.
	CreatedAt *int `json:"created_at,omitempty"`

	// DefaultLocale The default locale of the help center. This field is only returned for multilingual help centers.
	DefaultLocale *string `json:"default_locale,omitempty"`

	// Description The description of the collection. For multilingual help centers, this will be the description of the collection for the default language.
	Description *string `json:"description,omitempty"`

	// HelpCenterId The id of the help center the collection is in.
	HelpCenterId *int `json:"help_center_id,omitempty"`

	// Icon The icon of the collection.
	Icon *string `json:"icon,omitempty"`

	// Id The unique identifier for the collection which is given by Intercom.
	Id *string `json:"id,omitempty"`

	// Name The name of the collection. For multilingual collections, this will be the name of the default language's content.
	Name *string `json:"name,omitempty"`

	// Order The order of the section in relation to others sections within a collection. Values go from `0` upwards. `0` is the default if there's no order.
	Order *int `json:"order,omitempty"`

	// ParentId The id of the parent collection. If `null` then it is the first level collection.
	ParentId          *string                       `json:"parent_id,omitempty"`
	TranslatedContent *GroupTranslatedContentSchema `json:"translated_content,omitempty"`

	// UpdatedAt The time when the article was last updated (seconds). For multilingual articles, this will be the timestamp of last update of the default language's content.
	UpdatedAt *int `json:"updated_at,omitempty"`

	// Url The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language.
	Url *string `json:"url,omitempty"`

	// WorkspaceId The id of the workspace which the collection belongs to.
	WorkspaceId *string `json:"workspace_id,omitempty"`
}

CollectionSchema Collections are top level containers for Articles within the Help Center.

type CompanyAttachedContactsSchema

type CompanyAttachedContactsSchema struct {
	// Data An array containing Contact Objects
	Data  *[]ContactSchema   `json:"data,omitempty"`
	Pages *CursorPagesSchema `json:"pages,omitempty"`

	// TotalCount The total number of contacts
	TotalCount *int `json:"total_count,omitempty"`

	// Type The type of object - `list`
	Type *CompanyAttachedContactsType `json:"type,omitempty"`
}

CompanyAttachedContactsSchema A list of Contact Objects

type CompanyAttachedContactsType

type CompanyAttachedContactsType string

CompanyAttachedContactsType The type of object - `list`

const (
	CompanyAttachedContactsTypeList CompanyAttachedContactsType = "list"
)

Defines values for CompanyAttachedContactsType.

func (CompanyAttachedContactsType) Valid

Valid indicates whether the value is a known member of the CompanyAttachedContactsType enum.

type CompanyAttachedSegmentsSchema

type CompanyAttachedSegmentsSchema struct {
	// Data An array containing Segment Objects
	Data *[]SegmentSchema `json:"data,omitempty"`

	// Type The type of object - `list`
	Type *CompanyAttachedSegmentsType `json:"type,omitempty"`
}

CompanyAttachedSegmentsSchema A list of Segment Objects

type CompanyAttachedSegmentsType

type CompanyAttachedSegmentsType string

CompanyAttachedSegmentsType The type of object - `list`

const (
	CompanyAttachedSegmentsTypeList CompanyAttachedSegmentsType = "list"
)

Defines values for CompanyAttachedSegmentsType.

func (CompanyAttachedSegmentsType) Valid

Valid indicates whether the value is a known member of the CompanyAttachedSegmentsType enum.

type CompanyDataSchema

type CompanyDataSchema struct {
	// Id The unique identifier for the company which is given by Intercom.
	Id *string `json:"id,omitempty"`

	// Type The type of the object. Always company.
	Type *CompanyDataType `json:"type,omitempty"`

	// Url The relative URL of the company.
	Url *string `json:"url,omitempty"`
}

CompanyDataSchema An object containing data about the companies that a contact is associated with.

type CompanyDataType

type CompanyDataType string

CompanyDataType The type of the object. Always company.

const (
	CompanyDataTypeCompany CompanyDataType = "company"
)

Defines values for CompanyDataType.

func (CompanyDataType) Valid

func (e CompanyDataType) Valid() bool

Valid indicates whether the value is a known member of the CompanyDataType enum.

type CompanyListSchema

type CompanyListSchema struct {
	// Data An array containing Company Objects.
	Data  *[]CompanySchema   `json:"data,omitempty"`
	Pages *CursorPagesSchema `json:"pages,omitempty"`

	// TotalCount The total number of companies.
	TotalCount *int `json:"total_count,omitempty"`

	// Type The type of object - `list`.
	Type *CompanyListType `json:"type,omitempty"`
}

CompanyListSchema This will return a list of companies for the App.

type CompanyListType

type CompanyListType string

CompanyListType The type of object - `list`.

const (
	CompanyListTypeList CompanyListType = "list"
)

Defines values for CompanyListType.

func (CompanyListType) Valid

func (e CompanyListType) Valid() bool

Valid indicates whether the value is a known member of the CompanyListType enum.

type CompanyNoteSchema

type CompanyNoteSchema struct {
	// Author Optional. Represents the Admin that created the note.
	Author *AdminSchema `json:"author,omitempty"`

	// Body The body text of the note.
	Body *string `json:"body,omitempty"`

	// Company Represents the company that the note was created about.
	Company *struct {
		// Id The id of the company.
		Id *string `json:"id,omitempty"`

		// Type String representing the object's type. Always has the value `company`.
		Type *string `json:"type,omitempty"`
	} `json:"company,omitempty"`

	// CreatedAt The time the note was created.
	CreatedAt *int `json:"created_at,omitempty"`

	// Id The id of the note.
	Id *string `json:"id,omitempty"`

	// Type String representing the object's type. Always has the value `note`.
	Type *string `json:"type,omitempty"`
}

CompanyNoteSchema Notes allow you to annotate and comment on companies.

type CompanySchema

type CompanySchema struct {
	// AppId The Intercom defined code of the workspace the company is associated to.
	AppId *string `json:"app_id,omitempty"`

	// CompanyId The company id you have defined for the company.
	CompanyId *string `json:"company_id,omitempty"`

	// CreatedAt The time the company was added in Intercom.
	CreatedAt *int `json:"created_at,omitempty"`

	// CustomAttributes The custom attributes you have set on the company.
	CustomAttributes *map[string]string `json:"custom_attributes,omitempty"`

	// Id The Intercom defined id representing the company.
	Id *string `json:"id,omitempty"`

	// Industry The industry that the company operates in.
	Industry *string `json:"industry,omitempty"`

	// LastRequestAt The time the company last recorded making a request.
	LastRequestAt *int `json:"last_request_at,omitempty"`

	// MonthlySpend How much revenue the company generates for your business.
	MonthlySpend *int `json:"monthly_spend,omitempty"`

	// Name The name of the company.
	Name *string `json:"name,omitempty"`
	Plan *struct {
		// Id The id of the plan
		Id *string `json:"id,omitempty"`

		// Name The name of the plan
		Name *string `json:"name,omitempty"`

		// Type Value is always "plan"
		Type *string `json:"type,omitempty"`
	} `json:"plan,omitempty"`

	// RemoteCreatedAt The time the company was created by you.
	RemoteCreatedAt *int `json:"remote_created_at,omitempty"`

	// Segments The list of segments associated with the company
	Segments *struct {
		Segments *[]SegmentSchema `json:"segments,omitempty"`

		// Type The type of the object
		Type *CompanySegmentsType `json:"type,omitempty"`
	} `json:"segments,omitempty"`

	// SessionCount How many sessions the company has recorded.
	SessionCount *int `json:"session_count,omitempty"`

	// Size The number of employees in the company.
	Size *int `json:"size,omitempty"`

	// Tags The list of tags associated with the company
	Tags *struct {
		Tags *[]TagBasicSchema `json:"tags,omitempty"`

		// Type The type of the object
		Type *CompanyTagsType `json:"type,omitempty"`
	} `json:"tags,omitempty"`

	// Type Value is `company`
	Type *CompanyType `json:"type,omitempty"`

	// UpdatedAt The last time the company was updated.
	UpdatedAt *int `json:"updated_at,omitempty"`

	// UserCount The number of users in the company.
	UserCount *int `json:"user_count,omitempty"`

	// Website The URL for the company website.
	Website *string `json:"website,omitempty"`
}

CompanySchema Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies.

type CompanyScrollSchema

type CompanyScrollSchema struct {
	Data  *[]CompanySchema   `json:"data,omitempty"`
	Pages *CursorPagesSchema `json:"pages,omitempty"`

	// ScrollParam The scroll parameter to use in the next request to fetch the next page of results.
	ScrollParam *string `json:"scroll_param,omitempty"`

	// TotalCount The total number of companies
	TotalCount *int `json:"total_count,omitempty"`

	// Type The type of object - `list`
	Type *CompanyScrollType `json:"type,omitempty"`
}

CompanyScrollSchema Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies.

type CompanyScrollType

type CompanyScrollType string

CompanyScrollType The type of object - `list`

const (
	CompanyScrollTypeList CompanyScrollType = "list"
)

Defines values for CompanyScrollType.

func (CompanyScrollType) Valid

func (e CompanyScrollType) Valid() bool

Valid indicates whether the value is a known member of the CompanyScrollType enum.

type CompanySegmentsType

type CompanySegmentsType string

CompanySegmentsType The type of the object

const (
	CompanySegmentsTypeSegmentList CompanySegmentsType = "segment.list"
)

Defines values for CompanySegmentsType.

func (CompanySegmentsType) Valid

func (e CompanySegmentsType) Valid() bool

Valid indicates whether the value is a known member of the CompanySegmentsType enum.

type CompanyTagsType

type CompanyTagsType string

CompanyTagsType The type of the object

const (
	CompanyTagsTypeTagList CompanyTagsType = "tag.list"
)

Defines values for CompanyTagsType.

func (CompanyTagsType) Valid

func (e CompanyTagsType) Valid() bool

Valid indicates whether the value is a known member of the CompanyTagsType enum.

type CompanyType

type CompanyType string

CompanyType Value is `company`

const (
	CompanyTypeCompany CompanyType = "company"
)

Defines values for CompanyType.

func (CompanyType) Valid

func (e CompanyType) Valid() bool

Valid indicates whether the value is a known member of the CompanyType enum.

type ContactArchived

type ContactArchived = ContactReferenceSchema

ContactArchived reference to contact object

type ContactAttachedCompaniesSchema

type ContactAttachedCompaniesSchema struct {
	// Companies An array containing Company Objects
	Companies *[]CompanySchema `json:"companies,omitempty"`
	Pages     *PagesLinkSchema `json:"pages,omitempty"`

	// TotalCount The total number of companies associated to this contact
	TotalCount *int `json:"total_count,omitempty"`

	// Type The type of object
	Type *ContactAttachedCompaniesType `json:"type,omitempty"`
}

ContactAttachedCompaniesSchema A list of Company Objects

type ContactAttachedCompaniesType

type ContactAttachedCompaniesType string

ContactAttachedCompaniesType The type of object

const (
	ContactAttachedCompaniesTypeList ContactAttachedCompaniesType = "list"
)

Defines values for ContactAttachedCompaniesType.

func (ContactAttachedCompaniesType) Valid

Valid indicates whether the value is a known member of the ContactAttachedCompaniesType enum.

type ContactBlockedSchema

type ContactBlockedSchema = ContactReferenceSchema

ContactBlockedSchema reference to contact object

type ContactCompaniesSchema

type ContactCompaniesSchema struct {
	// Data An array of company data objects attached to the contact.
	Data *[]CompanyDataSchema `json:"data,omitempty"`

	// HasMore Whether there's more Addressable Objects to be viewed. If true, use the url to view all
	HasMore *bool `json:"has_more,omitempty"`

	// TotalCount Integer representing the total number of companies attached to this contact
	TotalCount *int `json:"total_count,omitempty"`

	// Url Url to get more company resources for this contact
	Url *string `json:"url,omitempty"`
}

ContactCompaniesSchema An object with metadata about companies attached to a contact . Up to 10 will be displayed here. Use the url to get more.

type ContactDeleted

type ContactDeleted = ContactReferenceSchema

ContactDeleted reference to contact object

type ContactListSchema

type ContactListSchema struct {
	// Data The list of contact objects
	Data  *[]ContactSchema   `json:"data,omitempty"`
	Pages *CursorPagesSchema `json:"pages,omitempty"`

	// TotalCount A count of the total number of objects.
	TotalCount *int `json:"total_count,omitempty"`

	// Type Always list
	Type *ContactListType `json:"type,omitempty"`
}

ContactListSchema Contacts are your users in Intercom.

type ContactListType

type ContactListType string

ContactListType Always list

const (
	ContactListTypeList ContactListType = "list"
)

Defines values for ContactListType.

func (ContactListType) Valid

func (e ContactListType) Valid() bool

Valid indicates whether the value is a known member of the ContactListType enum.

type ContactLocationSchema

type ContactLocationSchema struct {
	// City The city that the contact is located in
	City *string `json:"city,omitempty"`

	// Country The country that the contact is located in
	Country *string `json:"country,omitempty"`

	// Region The overal region that the contact is located in
	Region *string `json:"region,omitempty"`

	// Type Always location
	Type *string `json:"type,omitempty"`
}

ContactLocationSchema An object containing location meta data about a Intercom contact.

type ContactNotesSchema

type ContactNotesSchema struct {
	// Data This object represents the notes attached to a contact.
	Data *[]AddressableListSchema `json:"data,omitempty"`

	// HasMore Whether there's more Addressable Objects to be viewed. If true, use the url to view all
	HasMore *bool `json:"has_more,omitempty"`

	// TotalCount Int representing the total number of companyies attached to this contact
	TotalCount *int `json:"total_count,omitempty"`

	// Url Url to get more company resources for this contact
	Url *string `json:"url,omitempty"`
}

ContactNotesSchema An object containing notes meta data about the notes that a contact has. Up to 10 will be displayed here. Use the url to get more.

type ContactReferenceSchema

type ContactReferenceSchema struct {
	// ExternalId The unique identifier for the contact which is provided by the Client.
	ExternalId *string `json:"external_id,omitempty"`

	// Id The unique identifier for the contact which is given by Intercom.
	Id *string `json:"id,omitempty"`

	// Type always contact
	Type *ContactReferenceType `json:"type,omitempty"`
}

ContactReferenceSchema reference to contact object

type ContactReferenceType

type ContactReferenceType string

ContactReferenceType always contact

const (
	ContactReferenceTypeContact ContactReferenceType = "contact"
)

Defines values for ContactReferenceType.

func (ContactReferenceType) Valid

func (e ContactReferenceType) Valid() bool

Valid indicates whether the value is a known member of the ContactReferenceType enum.

type ContactReplyBaseRequestMessageType

type ContactReplyBaseRequestMessageType string

ContactReplyBaseRequestMessageType defines model for ContactReplyBaseRequest.MessageType.

const (
	ContactReplyBaseRequestMessageTypeComment ContactReplyBaseRequestMessageType = "comment"
)

Defines values for ContactReplyBaseRequestMessageType.

func (ContactReplyBaseRequestMessageType) Valid

Valid indicates whether the value is a known member of the ContactReplyBaseRequestMessageType enum.

type ContactReplyBaseRequestSchema

type ContactReplyBaseRequestSchema struct {
	// AttachmentUrls A list of image URLs that will be added as attachments. You can include up to 10 URLs.
	AttachmentUrls *[]string `json:"attachment_urls,omitempty"`

	// Body The text body of the comment.
	Body string `json:"body"`

	// CreatedAt The time the reply was created. If not provided, the current time will be used.
	CreatedAt   *int                               `json:"created_at,omitempty"`
	MessageType ContactReplyBaseRequestMessageType `json:"message_type"`

	// ReplyOptions The quick reply selection the contact wishes to respond with. These map to buttons displayed in the Messenger UI if sent by a bot, or the reply options sent by an Admin via the API.
	ReplyOptions *[]struct {
		// Text The text of the chosen reply option.
		Text string `json:"text"`

		// Uuid The unique identifier for the quick reply option selected.
		Uuid openapi_types.UUID `json:"uuid"`
	} `json:"reply_options,omitempty"`
	Type ContactReplyBaseRequestType `json:"type"`
}

ContactReplyBaseRequestSchema defines model for contact_reply_base_request.

type ContactReplyBaseRequestType

type ContactReplyBaseRequestType string

ContactReplyBaseRequestType defines model for ContactReplyBaseRequest.Type.

const (
	ContactReplyBaseRequestTypeUser ContactReplyBaseRequestType = "user"
)

Defines values for ContactReplyBaseRequestType.

func (ContactReplyBaseRequestType) Valid

Valid indicates whether the value is a known member of the ContactReplyBaseRequestType enum.

type ContactReplyConversationRequest

type ContactReplyConversationRequest struct {
	// contains filtered or unexported fields
}

ContactReplyConversationRequest defines model for contact_reply_conversation_request.

func (ContactReplyConversationRequest) AsContactReplyEmailRequestSchema

func (t ContactReplyConversationRequest) AsContactReplyEmailRequestSchema() (ContactReplyEmailRequestSchema, error)

AsContactReplyEmailRequestSchema returns the union data inside the ContactReplyConversationRequest as a ContactReplyEmailRequestSchema

func (ContactReplyConversationRequest) AsContactReplyIntercomUserIdRequestSchema

func (t ContactReplyConversationRequest) AsContactReplyIntercomUserIdRequestSchema() (ContactReplyIntercomUserIdRequestSchema, error)

AsContactReplyIntercomUserIdRequestSchema returns the union data inside the ContactReplyConversationRequest as a ContactReplyIntercomUserIdRequestSchema

func (ContactReplyConversationRequest) AsContactReplyUserIdRequestSchema

func (t ContactReplyConversationRequest) AsContactReplyUserIdRequestSchema() (ContactReplyUserIdRequestSchema, error)

AsContactReplyUserIdRequestSchema returns the union data inside the ContactReplyConversationRequest as a ContactReplyUserIdRequestSchema

func (*ContactReplyConversationRequest) FromContactReplyEmailRequestSchema

func (t *ContactReplyConversationRequest) FromContactReplyEmailRequestSchema(v ContactReplyEmailRequestSchema) error

FromContactReplyEmailRequestSchema overwrites any union data inside the ContactReplyConversationRequest as the provided ContactReplyEmailRequestSchema

func (*ContactReplyConversationRequest) FromContactReplyIntercomUserIdRequestSchema

func (t *ContactReplyConversationRequest) FromContactReplyIntercomUserIdRequestSchema(v ContactReplyIntercomUserIdRequestSchema) error

FromContactReplyIntercomUserIdRequestSchema overwrites any union data inside the ContactReplyConversationRequest as the provided ContactReplyIntercomUserIdRequestSchema

func (*ContactReplyConversationRequest) FromContactReplyUserIdRequestSchema

func (t *ContactReplyConversationRequest) FromContactReplyUserIdRequestSchema(v ContactReplyUserIdRequestSchema) error

FromContactReplyUserIdRequestSchema overwrites any union data inside the ContactReplyConversationRequest as the provided ContactReplyUserIdRequestSchema

func (ContactReplyConversationRequest) MarshalJSON

func (t ContactReplyConversationRequest) MarshalJSON() ([]byte, error)

func (*ContactReplyConversationRequest) MergeContactReplyEmailRequestSchema

func (t *ContactReplyConversationRequest) MergeContactReplyEmailRequestSchema(v ContactReplyEmailRequestSchema) error

MergeContactReplyEmailRequestSchema performs a merge with any union data inside the ContactReplyConversationRequest, using the provided ContactReplyEmailRequestSchema

func (*ContactReplyConversationRequest) MergeContactReplyIntercomUserIdRequestSchema

func (t *ContactReplyConversationRequest) MergeContactReplyIntercomUserIdRequestSchema(v ContactReplyIntercomUserIdRequestSchema) error

MergeContactReplyIntercomUserIdRequestSchema performs a merge with any union data inside the ContactReplyConversationRequest, using the provided ContactReplyIntercomUserIdRequestSchema

func (*ContactReplyConversationRequest) MergeContactReplyUserIdRequestSchema

func (t *ContactReplyConversationRequest) MergeContactReplyUserIdRequestSchema(v ContactReplyUserIdRequestSchema) error

MergeContactReplyUserIdRequestSchema performs a merge with any union data inside the ContactReplyConversationRequest, using the provided ContactReplyUserIdRequestSchema

func (*ContactReplyConversationRequest) UnmarshalJSON

func (t *ContactReplyConversationRequest) UnmarshalJSON(b []byte) error

type ContactReplyEmailRequestSchema

type ContactReplyEmailRequestSchema = ContactReplyBaseRequestSchema

ContactReplyEmailRequestSchema defines model for contact_reply_email_request.

type ContactReplyIntercomUserIdRequestSchema

type ContactReplyIntercomUserIdRequestSchema = ContactReplyBaseRequestSchema

ContactReplyIntercomUserIdRequestSchema defines model for contact_reply_intercom_user_id_request.

type ContactReplyTicketEmailRequestSchema

type ContactReplyTicketEmailRequestSchema = ContactReplyBaseRequestSchema

ContactReplyTicketEmailRequestSchema defines model for contact_reply_ticket_email_request.

type ContactReplyTicketIntercomUserIdRequestSchema

type ContactReplyTicketIntercomUserIdRequestSchema = ContactReplyBaseRequestSchema

ContactReplyTicketIntercomUserIdRequestSchema defines model for contact_reply_ticket_intercom_user_id_request.

type ContactReplyTicketRequest

type ContactReplyTicketRequest struct {
	// contains filtered or unexported fields
}

ContactReplyTicketRequest defines model for contact_reply_ticket_request.

func (ContactReplyTicketRequest) AsContactReplyTicketEmailRequestSchema

func (t ContactReplyTicketRequest) AsContactReplyTicketEmailRequestSchema() (ContactReplyTicketEmailRequestSchema, error)

AsContactReplyTicketEmailRequestSchema returns the union data inside the ContactReplyTicketRequest as a ContactReplyTicketEmailRequestSchema

func (ContactReplyTicketRequest) AsContactReplyTicketIntercomUserIdRequestSchema

func (t ContactReplyTicketRequest) AsContactReplyTicketIntercomUserIdRequestSchema() (ContactReplyTicketIntercomUserIdRequestSchema, error)

AsContactReplyTicketIntercomUserIdRequestSchema returns the union data inside the ContactReplyTicketRequest as a ContactReplyTicketIntercomUserIdRequestSchema

func (ContactReplyTicketRequest) AsContactReplyTicketUserIdRequestSchema

func (t ContactReplyTicketRequest) AsContactReplyTicketUserIdRequestSchema() (ContactReplyTicketUserIdRequestSchema, error)

AsContactReplyTicketUserIdRequestSchema returns the union data inside the ContactReplyTicketRequest as a ContactReplyTicketUserIdRequestSchema

func (*ContactReplyTicketRequest) FromContactReplyTicketEmailRequestSchema

func (t *ContactReplyTicketRequest) FromContactReplyTicketEmailRequestSchema(v ContactReplyTicketEmailRequestSchema) error

FromContactReplyTicketEmailRequestSchema overwrites any union data inside the ContactReplyTicketRequest as the provided ContactReplyTicketEmailRequestSchema

func (*ContactReplyTicketRequest) FromContactReplyTicketIntercomUserIdRequestSchema

func (t *ContactReplyTicketRequest) FromContactReplyTicketIntercomUserIdRequestSchema(v ContactReplyTicketIntercomUserIdRequestSchema) error

FromContactReplyTicketIntercomUserIdRequestSchema overwrites any union data inside the ContactReplyTicketRequest as the provided ContactReplyTicketIntercomUserIdRequestSchema

func (*ContactReplyTicketRequest) FromContactReplyTicketUserIdRequestSchema

func (t *ContactReplyTicketRequest) FromContactReplyTicketUserIdRequestSchema(v ContactReplyTicketUserIdRequestSchema) error

FromContactReplyTicketUserIdRequestSchema overwrites any union data inside the ContactReplyTicketRequest as the provided ContactReplyTicketUserIdRequestSchema

func (ContactReplyTicketRequest) MarshalJSON

func (t ContactReplyTicketRequest) MarshalJSON() ([]byte, error)

func (*ContactReplyTicketRequest) MergeContactReplyTicketEmailRequestSchema

func (t *ContactReplyTicketRequest) MergeContactReplyTicketEmailRequestSchema(v ContactReplyTicketEmailRequestSchema) error

MergeContactReplyTicketEmailRequestSchema performs a merge with any union data inside the ContactReplyTicketRequest, using the provided ContactReplyTicketEmailRequestSchema

func (*ContactReplyTicketRequest) MergeContactReplyTicketIntercomUserIdRequestSchema

func (t *ContactReplyTicketRequest) MergeContactReplyTicketIntercomUserIdRequestSchema(v ContactReplyTicketIntercomUserIdRequestSchema) error

MergeContactReplyTicketIntercomUserIdRequestSchema performs a merge with any union data inside the ContactReplyTicketRequest, using the provided ContactReplyTicketIntercomUserIdRequestSchema

func (*ContactReplyTicketRequest) MergeContactReplyTicketUserIdRequestSchema

func (t *ContactReplyTicketRequest) MergeContactReplyTicketUserIdRequestSchema(v ContactReplyTicketUserIdRequestSchema) error

MergeContactReplyTicketUserIdRequestSchema performs a merge with any union data inside the ContactReplyTicketRequest, using the provided ContactReplyTicketUserIdRequestSchema

func (*ContactReplyTicketRequest) UnmarshalJSON

func (t *ContactReplyTicketRequest) UnmarshalJSON(b []byte) error

type ContactReplyTicketUserIdRequestSchema

type ContactReplyTicketUserIdRequestSchema = ContactReplyBaseRequestSchema

ContactReplyTicketUserIdRequestSchema defines model for contact_reply_ticket_user_id_request.

type ContactReplyUserIdRequestSchema

type ContactReplyUserIdRequestSchema = ContactReplyBaseRequestSchema

ContactReplyUserIdRequestSchema defines model for contact_reply_user_id_request.

type ContactSchema

type ContactSchema struct {
	// AndroidAppName The name of the Android app which the contact is using.
	AndroidAppName *string `json:"android_app_name,omitempty"`

	// AndroidAppVersion The version of the Android app which the contact is using.
	AndroidAppVersion *string `json:"android_app_version,omitempty"`

	// AndroidDevice The Android device which the contact is using.
	AndroidDevice *string `json:"android_device,omitempty"`

	// AndroidLastSeenAt (Unix timestamp in seconds) The time when the contact was last seen on an Android device.
	AndroidLastSeenAt *int `json:"android_last_seen_at,omitempty"`

	// AndroidOsVersion The version of the Android OS which the contact is using.
	AndroidOsVersion *string `json:"android_os_version,omitempty"`

	// AndroidSdkVersion The version of the Android SDK which the contact is using.
	AndroidSdkVersion *string `json:"android_sdk_version,omitempty"`
	Avatar            *struct {
		// ImageUrl An image URL containing the avatar of a contact.
		ImageUrl *string `json:"image_url,omitempty"`

		// Type The type of object
		Type *string `json:"type,omitempty"`
	} `json:"avatar,omitempty"`

	// Browser The name of the browser which the contact is using.
	Browser *string `json:"browser,omitempty"`

	// BrowserLanguage The language set by the browser which the contact is using.
	BrowserLanguage *string `json:"browser_language,omitempty"`

	// BrowserVersion The version of the browser which the contact is using.
	BrowserVersion *string                 `json:"browser_version,omitempty"`
	Companies      *ContactCompaniesSchema `json:"companies,omitempty"`

	// CreatedAt (Unix timestamp in seconds) The time when the contact was created.
	CreatedAt *int `json:"created_at,omitempty"`

	// CustomAttributes The custom attributes which are set for the contact.
	CustomAttributes *map[string]interface{} `json:"custom_attributes,omitempty"`

	// Email The contact's email.
	Email *string `json:"email,omitempty"`

	// EmailDomain The contact's email domain.
	EmailDomain *string `json:"email_domain,omitempty"`

	// ExternalId The unique identifier for the contact which is provided by the Client.
	ExternalId *string `json:"external_id,omitempty"`

	// HasHardBounced Whether the contact has had an email sent to them hard bounce.
	HasHardBounced *bool `json:"has_hard_bounced,omitempty"`

	// Id The unique identifier for the contact which is given by Intercom.
	Id *string `json:"id,omitempty"`

	// IosAppName The name of the iOS app which the contact is using.
	IosAppName *string `json:"ios_app_name,omitempty"`

	// IosAppVersion The version of the iOS app which the contact is using.
	IosAppVersion *string `json:"ios_app_version,omitempty"`

	// IosDevice The iOS device which the contact is using.
	IosDevice *string `json:"ios_device,omitempty"`

	// IosLastSeenAt (Unix timestamp in seconds) The last time the contact used the iOS app.
	IosLastSeenAt *int `json:"ios_last_seen_at,omitempty"`

	// IosOsVersion The version of iOS which the contact is using.
	IosOsVersion *string `json:"ios_os_version,omitempty"`

	// IosSdkVersion The version of the iOS SDK which the contact is using.
	IosSdkVersion *string `json:"ios_sdk_version,omitempty"`

	// LanguageOverride A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.
	LanguageOverride *string `json:"language_override,omitempty"`

	// LastContactedAt (Unix timestamp in seconds) The time when the contact was last messaged.
	LastContactedAt *int `json:"last_contacted_at,omitempty"`

	// LastEmailClickedAt (Unix timestamp in seconds) The time when the contact last clicked a link in an email.
	LastEmailClickedAt *int `json:"last_email_clicked_at,omitempty"`

	// LastEmailOpenedAt (Unix timestamp in seconds) The time when the contact last opened an email.
	LastEmailOpenedAt *int `json:"last_email_opened_at,omitempty"`

	// LastRepliedAt (Unix timestamp in seconds) The time when the contact last messaged in.
	LastRepliedAt *int `json:"last_replied_at,omitempty"`

	// LastSeenAt (Unix timestamp in seconds) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).
	LastSeenAt *int                   `json:"last_seen_at,omitempty"`
	Location   *ContactLocationSchema `json:"location,omitempty"`

	// MarkedEmailAsSpam Whether the contact has marked an email sent to them as spam.
	MarkedEmailAsSpam *bool `json:"marked_email_as_spam,omitempty"`

	// Name The contacts name.
	Name  *string             `json:"name,omitempty"`
	Notes *ContactNotesSchema `json:"notes,omitempty"`

	// Os The operating system which the contact is using.
	Os *string `json:"os,omitempty"`

	// OwnerId The id of an admin that has been assigned account ownership of the contact.
	OwnerId *int `json:"owner_id,omitempty"`

	// Phone The contacts phone.
	Phone *string `json:"phone,omitempty"`

	// Role The role of the contact.
	Role *string `json:"role,omitempty"`

	// SignedUpAt (Unix timestamp in seconds) The time specified for when a contact signed up.
	SignedUpAt     *int                         `json:"signed_up_at,omitempty"`
	SocialProfiles *ContactSocialProfilesSchema `json:"social_profiles,omitempty"`
	Tags           *ContactTagsSchema           `json:"tags,omitempty"`

	// Type The type of object.
	Type *string `json:"type,omitempty"`

	// UnsubscribedFromEmails Whether the contact is unsubscribed from emails.
	UnsubscribedFromEmails *bool `json:"unsubscribed_from_emails,omitempty"`

	// UpdatedAt (Unix timestamp in seconds) The time when the contact was last updated.
	UpdatedAt *int `json:"updated_at,omitempty"`

	// WorkspaceId The id of the workspace which the contact belongs to.
	WorkspaceId *string `json:"workspace_id,omitempty"`
}

ContactSchema Contacts represent your leads and users in Intercom.

type ContactSegmentsSchema

type ContactSegmentsSchema struct {
	// Data Segment objects associated with the contact.
	Data *[]SegmentSchema `json:"data,omitempty"`

	// Type The type of the object
	Type *ContactSegmentsType `json:"type,omitempty"`
}

ContactSegmentsSchema A list of segments objects attached to a specific contact.

type ContactSegmentsType

type ContactSegmentsType string

ContactSegmentsType The type of the object

const (
	ContactSegmentsTypeList ContactSegmentsType = "list"
)

Defines values for ContactSegmentsType.

func (ContactSegmentsType) Valid

func (e ContactSegmentsType) Valid() bool

Valid indicates whether the value is a known member of the ContactSegmentsType enum.

type ContactSocialProfilesSchema

type ContactSocialProfilesSchema struct {
	// Data A list of social profiles objects associated with the contact.
	Data *[]SocialProfileSchema `json:"data,omitempty"`
}

ContactSocialProfilesSchema An object containing social profiles that a contact has.

type ContactSubscriptionTypesSchema

type ContactSubscriptionTypesSchema struct {
	// Data This object represents the subscriptions attached to a contact.
	Data *[]AddressableListSchema `json:"data,omitempty"`

	// HasMore Whether there's more Addressable Objects to be viewed. If true, use the url to view all
	HasMore *bool `json:"has_more,omitempty"`

	// TotalCount Int representing the total number of subscription types attached to this contact
	TotalCount *int `json:"total_count,omitempty"`

	// Url Url to get more subscription type resources for this contact
	Url *string `json:"url,omitempty"`
}

ContactSubscriptionTypesSchema An object containing Subscription Types meta data about the SubscriptionTypes that a contact has.

type ContactTagsSchema

type ContactTagsSchema struct {
	// Data This object represents the tags attached to a contact.
	Data *[]AddressableListSchema `json:"data,omitempty"`

	// HasMore Whether there's more Addressable Objects to be viewed. If true, use the url to view all
	HasMore *bool `json:"has_more,omitempty"`

	// TotalCount Int representing the total number of tags attached to this contact
	TotalCount *int `json:"total_count,omitempty"`

	// Url url to get more tag resources for this contact
	Url *string `json:"url,omitempty"`
}

ContactTagsSchema An object containing tags meta data about the tags that a contact has. Up to 10 will be displayed here. Use the url to get more.

type ContactUnarchived

type ContactUnarchived = ContactReferenceSchema

ContactUnarchived reference to contact object

type ContentImportSourceSchema

type ContentImportSourceSchema struct {
	// AudienceIds The unique identifiers for the audiences associated with this content import source.
	AudienceIds *[]int `json:"audience_ids,omitempty"`

	// CreatedAt The time when the content import source was created.
	CreatedAt int `json:"created_at"`

	// Id The unique identifier for the content import source which is given by Intercom.
	Id int `json:"id"`

	// LastSyncedAt The time when the content import source was last synced.
	LastSyncedAt int `json:"last_synced_at"`

	// Status The status of the content import source.
	Status ContentImportSourceStatus `json:"status"`

	// SyncBehavior If you intend to create or update External Pages via the API, this should be set to `api`.
	SyncBehavior ContentImportSourceSyncBehavior `json:"sync_behavior"`

	// Type Always external_page
	Type ContentImportSourceType `json:"type"`

	// UpdatedAt The time when the content import source was last updated.
	UpdatedAt int `json:"updated_at"`

	// Url The URL of the root of the external source.
	Url string `json:"url"`
}

ContentImportSourceSchema An external source for External Pages that you add to your Fin Content Library.

type ContentImportSourceStatus

type ContentImportSourceStatus string

ContentImportSourceStatus The status of the content import source.

const (
	ContentImportSourceStatusActive      ContentImportSourceStatus = "active"
	ContentImportSourceStatusDeactivated ContentImportSourceStatus = "deactivated"
)

Defines values for ContentImportSourceStatus.

func (ContentImportSourceStatus) Valid

func (e ContentImportSourceStatus) Valid() bool

Valid indicates whether the value is a known member of the ContentImportSourceStatus enum.

type ContentImportSourceSyncBehavior

type ContentImportSourceSyncBehavior string

ContentImportSourceSyncBehavior If you intend to create or update External Pages via the API, this should be set to `api`.

const (
	ContentImportSourceSyncBehaviorApi       ContentImportSourceSyncBehavior = "api"
	ContentImportSourceSyncBehaviorAutomatic ContentImportSourceSyncBehavior = "automatic"
	ContentImportSourceSyncBehaviorManual    ContentImportSourceSyncBehavior = "manual"
)

Defines values for ContentImportSourceSyncBehavior.

func (ContentImportSourceSyncBehavior) Valid

Valid indicates whether the value is a known member of the ContentImportSourceSyncBehavior enum.

type ContentImportSourceType

type ContentImportSourceType string

ContentImportSourceType Always external_page

const (
	ContentImportSource ContentImportSourceType = "content_import_source"
)

Defines values for ContentImportSourceType.

func (ContentImportSourceType) Valid

func (e ContentImportSourceType) Valid() bool

Valid indicates whether the value is a known member of the ContentImportSourceType enum.

type ContentImportSourcesListSchema

type ContentImportSourcesListSchema struct {
	// Data An array of Content Import Source objects
	Data  *[]ContentImportSourceSchema `json:"data,omitempty"`
	Pages *PagesLinkSchema             `json:"pages,omitempty"`

	// TotalCount A count of the total number of content import sources.
	TotalCount *int `json:"total_count,omitempty"`

	// Type The type of the object - `list`.
	Type *ContentImportSourcesListType `json:"type,omitempty"`
}

ContentImportSourcesListSchema This will return a list of the content import sources for the App.

type ContentImportSourcesListType

type ContentImportSourcesListType string

ContentImportSourcesListType The type of the object - `list`.

const (
	ContentImportSourcesListTypeList ContentImportSourcesListType = "list"
)

Defines values for ContentImportSourcesListType.

func (ContentImportSourcesListType) Valid

Valid indicates whether the value is a known member of the ContentImportSourcesListType enum.

type ContentSourceContentType

type ContentSourceContentType string

ContentSourceContentType The type of the content source.

const (
	ContentSourceContentTypeArticle                 ContentSourceContentType = "article"
	ContentSourceContentTypeContentSnippet          ContentSourceContentType = "content_snippet"
	ContentSourceContentTypeExternalContent         ContentSourceContentType = "external_content"
	ContentSourceContentTypeFile                    ContentSourceContentType = "file"
	ContentSourceContentTypeWorkflowConnectorAction ContentSourceContentType = "workflow_connector_action"
)

Defines values for ContentSourceContentType.

func (ContentSourceContentType) Valid

func (e ContentSourceContentType) Valid() bool

Valid indicates whether the value is a known member of the ContentSourceContentType enum.

type ContentSourceSchema

type ContentSourceSchema struct {
	// ContentType The type of the content source.
	ContentType *ContentSourceContentType `json:"content_type,omitempty"`

	// Locale The ISO 639 language code of the content source.
	Locale *string `json:"locale,omitempty"`

	// Title The title of the content source.
	Title *string `json:"title,omitempty"`

	// Url The internal URL linking to the content source for teammates.
	Url *string `json:"url,omitempty"`
}

ContentSourceSchema The content source used by AI Agent in the conversation.

type ContentSourcesList

type ContentSourcesList struct {
	// ContentSources The content sources used by AI Agent in the conversation.
	ContentSources *[]ContentSourceSchema `json:"content_sources,omitempty"`

	// TotalCount The total number of content sources used by AI Agent in the conversation.
	TotalCount *int                    `json:"total_count,omitempty"`
	Type       *ContentSourcesListType `json:"type,omitempty"`
}

ContentSourcesList defines model for content_sources_list.

type ContentSourcesListType

type ContentSourcesListType string

ContentSourcesListType defines model for ContentSourcesList.Type.

const (
	ContentSourceList ContentSourcesListType = "content_source.list"
)

Defines values for ContentSourcesListType.

func (ContentSourcesListType) Valid

func (e ContentSourcesListType) Valid() bool

Valid indicates whether the value is a known member of the ContentSourcesListType enum.

type ConversationAttachmentFilesSchema

type ConversationAttachmentFilesSchema struct {
	// ContentType The content type of the file
	ContentType *string `json:"content_type,omitempty"`

	// Data The base64 encoded file data.
	Data *string `json:"data,omitempty"`

	// Name The name of the file.
	Name *string `json:"name,omitempty"`
}

ConversationAttachmentFilesSchema Properties of the attachment files in a conversation part

type ConversationAttributeUpdatedByAdminSchema

type ConversationAttributeUpdatedByAdminSchema struct {
	Attribute *struct {
		// Name Name of the CDA updated
		Name *string `json:"name,omitempty"`
	} `json:"attribute,omitempty"`
	Value *struct {
		// Name Current value of the CDA updated
		Name *string `json:"name,omitempty"`

		// Previous Previous value of the CDA
		Previous *string `json:"previous,omitempty"`
	} `json:"value,omitempty"`
}

ConversationAttributeUpdatedByAdminSchema Contains details about Custom Data Attributes (CDAs) that were modified by an admin (operator) for conversation part type <code>conversation_attribute_updated_by_admin</code>.

type ConversationAttributeUpdatedByUserSchema

type ConversationAttributeUpdatedByUserSchema struct {
	Attribute *struct {
		// Name Name of the CDA updated
		Name *string `json:"name,omitempty"`
	} `json:"attribute,omitempty"`
	Value *struct {
		// Name Current value of the CDA updated
		Name *string `json:"name,omitempty"`

		// Previous Previous value of the CDA (null for older events)
		Previous *string `json:"previous,omitempty"`
	} `json:"value,omitempty"`
}

ConversationAttributeUpdatedByUserSchema Contains details about Custom Data Attributes (CDAs) that were modified by a user for conversation part type <code>conversation_attribute_updated_by_user</code>.

type ConversationAttributeUpdatedByWorkflowSchema

type ConversationAttributeUpdatedByWorkflowSchema struct {
	Attribute *struct {
		// Name Name of the CDA updated
		Name *string `json:"name,omitempty"`
	} `json:"attribute,omitempty"`
	Value *struct {
		// Name Value of the CDA updated
		Name *string `json:"name,omitempty"`
	} `json:"value,omitempty"`
	Workflow *struct {
		// Name Name of the workflow
		Name *string `json:"name,omitempty"`
	} `json:"workflow,omitempty"`
}

ConversationAttributeUpdatedByWorkflowSchema Contains details about the workflow that was triggered and any Custom Data Attributes (CDAs) that were modified during the workflow execution for conversation part type <code>conversation_attribute_updated_by_workflow</code>.

type ConversationContactsSchema

type ConversationContactsSchema struct {
	// Contacts The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature.
	Contacts *[]ContactReferenceSchema `json:"contacts,omitempty"`
	Type     *ConversationContactsType `json:"type,omitempty"`
}

ConversationContactsSchema The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature.

type ConversationContactsType

type ConversationContactsType string

ConversationContactsType defines model for ConversationContacts.Type.

const (
	ConversationContactsTypeContactList ConversationContactsType = "contact.list"
)

Defines values for ConversationContactsType.

func (ConversationContactsType) Valid

func (e ConversationContactsType) Valid() bool

Valid indicates whether the value is a known member of the ConversationContactsType enum.

type ConversationDeletedObject

type ConversationDeletedObject string

ConversationDeletedObject always conversation

const (
	ConversationDeletedObjectConversation ConversationDeletedObject = "conversation"
)

Defines values for ConversationDeletedObject.

func (ConversationDeletedObject) Valid

func (e ConversationDeletedObject) Valid() bool

Valid indicates whether the value is a known member of the ConversationDeletedObject enum.

type ConversationDeletedSchema

type ConversationDeletedSchema struct {
	// Deleted Whether the conversation is deleted or not.
	Deleted *bool `json:"deleted,omitempty"`

	// Id The unique identifier for the conversation.
	Id *string `json:"id,omitempty"`

	// Object always conversation
	Object *ConversationDeletedObject `json:"object,omitempty"`
}

ConversationDeletedSchema deleted conversation object

type ConversationFirstContactReplySchema

type ConversationFirstContactReplySchema struct {
	CreatedAt *int    `json:"created_at,omitempty"`
	Type      *string `json:"type,omitempty"`
	Url       *string `json:"url,omitempty"`
}

ConversationFirstContactReplySchema An object containing information on the first users message. For a contact initiated message this will represent the users original message.

type ConversationListItemPriority

type ConversationListItemPriority string

ConversationListItemPriority If marked as priority, it will return priority or else not_priority.

const (
	ConversationListItemPriorityNotPriority ConversationListItemPriority = "not_priority"
	ConversationListItemPriorityPriority    ConversationListItemPriority = "priority"
)

Defines values for ConversationListItemPriority.

func (ConversationListItemPriority) Valid

Valid indicates whether the value is a known member of the ConversationListItemPriority enum.

type ConversationListItemSchema

type ConversationListItemSchema struct {
	// AdminAssigneeId The id of the admin assigned to the conversation. If it's not assigned to an admin it will return null.
	AdminAssigneeId *int           `json:"admin_assignee_id,omitempty"`
	AiAgent         *AiAgentSchema `json:"ai_agent,omitempty"`

	// AiAgentParticipated Indicates whether the AI Agent participated in the conversation.
	AiAgentParticipated *bool `json:"ai_agent_participated,omitempty"`

	// Company The company associated with the conversation.
	Company            *CompanySchema              `json:"company,omitempty"`
	Contacts           *ConversationContactsSchema `json:"contacts,omitempty"`
	ConversationRating *ConversationRatingSchema   `json:"conversation_rating,omitempty"`

	// CreatedAt The time the conversation was created.
	CreatedAt         *int                                 `json:"created_at,omitempty"`
	CustomAttributes  *CustomAttributesSchema              `json:"custom_attributes,omitempty"`
	FirstContactReply *ConversationFirstContactReplySchema `json:"first_contact_reply,omitempty"`

	// Id The id representing the conversation.
	Id            *string                 `json:"id,omitempty"`
	LinkedObjects *LinkedObjectListSchema `json:"linked_objects,omitempty"`

	// Open Indicates whether a conversation is open (true) or closed (false).
	Open *bool `json:"open,omitempty"`

	// Priority If marked as priority, it will return priority or else not_priority.
	Priority *ConversationListItemPriority `json:"priority,omitempty"`

	// Read Indicates whether a conversation has been read.
	Read       *bool             `json:"read,omitempty"`
	SlaApplied *SlaAppliedSchema `json:"sla_applied,omitempty"`

	// SnoozedUntil If set this is the time in the future when this conversation will be marked as open. i.e. it will be in a snoozed state until this time. i.e. it will be in a snoozed state until this time.
	SnoozedUntil *int                      `json:"snoozed_until,omitempty"`
	Source       *ConversationSourceSchema `json:"source,omitempty"`

	// State Can be set to "open", "closed" or "snoozed".
	State      *ConversationListItemState    `json:"state,omitempty"`
	Statistics *ConversationStatisticsSchema `json:"statistics,omitempty"`
	Tags       *TagsSchema                   `json:"tags,omitempty"`

	// TeamAssigneeId The id of the team assigned to the conversation. If it's not assigned to a team it will return null.
	TeamAssigneeId *int                         `json:"team_assignee_id,omitempty"`
	Teammates      *ConversationTeammatesSchema `json:"teammates,omitempty"`

	// Title The title given to the conversation.
	Title *string `json:"title,omitempty"`

	// Type Always conversation.
	Type *string `json:"type,omitempty"`

	// UpdatedAt The last time the conversation was updated.
	UpdatedAt *int `json:"updated_at,omitempty"`

	// WaitingSince The last time a Contact responded to an Admin. In other words, the time a customer started waiting for a response. Set to null if last reply is from an Admin.
	WaitingSince *int `json:"waiting_since,omitempty"`
}

ConversationListItemSchema The data returned about your conversations when you list or search them.

type ConversationListItemState

type ConversationListItemState string

ConversationListItemState Can be set to "open", "closed" or "snoozed".

const (
	ConversationListItemStateClosed  ConversationListItemState = "closed"
	ConversationListItemStateOpen    ConversationListItemState = "open"
	ConversationListItemStateSnoozed ConversationListItemState = "snoozed"
)

Defines values for ConversationListItemState.

func (ConversationListItemState) Valid

func (e ConversationListItemState) Valid() bool

Valid indicates whether the value is a known member of the ConversationListItemState enum.

type ConversationListSchema

type ConversationListSchema struct {
	// Conversations The list of conversation objects
	Conversations *[]ConversationListItemSchema `json:"conversations,omitempty"`
	Pages         *CursorPagesSchema            `json:"pages,omitempty"`

	// TotalCount A count of the total number of objects.
	TotalCount *int `json:"total_count,omitempty"`

	// Type Always conversation.list
	Type *ConversationListType `json:"type,omitempty"`
}

ConversationListSchema Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.

type ConversationListType

type ConversationListType string

ConversationListType Always conversation.list

const (
	ConversationListTypeConversationList ConversationListType = "conversation.list"
)

Defines values for ConversationListType.

func (ConversationListType) Valid

func (e ConversationListType) Valid() bool

Valid indicates whether the value is a known member of the ConversationListType enum.

type ConversationPartAuthorSchema

type ConversationPartAuthorSchema struct {
	// Email The email of the author
	Email *openapi_types.Email `json:"email,omitempty"`

	// FromAiAgent If this conversation part was sent by the AI Agent
	FromAiAgent *bool `json:"from_ai_agent,omitempty"`

	// Id The id of the author
	Id *string `json:"id,omitempty"`

	// IsAiAnswer If this conversation part body was generated by the AI Agent
	IsAiAnswer *bool `json:"is_ai_answer,omitempty"`

	// Name The name of the author
	Name *string `json:"name,omitempty"`

	// Type The type of the author
	Type *string `json:"type,omitempty"`
}

ConversationPartAuthorSchema The object who initiated the conversation, which can be a Contact, Admin or Team. Bots and campaigns send messages on behalf of Admins or Teams. For Twitter, this will be blank.

type ConversationPartMetadataSchema

type ConversationPartMetadataSchema struct {
	// QuickReplyOptions The quick reply options sent by the Admin or bot, presented in this conversation part.
	QuickReplyOptions *[]QuickReplyOptionSchema `json:"quick_reply_options,omitempty"`

	// QuickReplyUuid The unique identifier for the quick reply option that was clicked by the end user.
	QuickReplyUuid *openapi_types.UUID `json:"quick_reply_uuid,omitempty"`
}

ConversationPartMetadataSchema Metadata for a conversation part

type ConversationPartSchema

type ConversationPartSchema struct {
	// AppPackageCode The app package code if this part was created via API. null if the part was not created via API.
	AppPackageCode *string `json:"app_package_code,omitempty"`

	// AssignedTo The id of the admin that was assigned the conversation by this conversation_part (null if there has been no change in assignment.)
	AssignedTo *ReferenceSchema `json:"assigned_to,omitempty"`

	// Attachments A list of attachments for the part.
	Attachments *[]PartAttachmentSchema       `json:"attachments,omitempty"`
	Author      *ConversationPartAuthorSchema `json:"author,omitempty"`

	// Body The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured. In webhook payloads for API version 2.15+, this field returns plain text.
	Body *string `json:"body,omitempty"`

	// CreatedAt The time the conversation part was created.
	CreatedAt            *int                        `json:"created_at,omitempty"`
	EmailMessageMetadata *EmailMessageMetadataSchema `json:"email_message_metadata,omitempty"`
	EventDetails         *EventDetailsSchema         `json:"event_details,omitempty"`

	// ExternalId The external id of the conversation part
	ExternalId *string `json:"external_id,omitempty"`

	// Id The id representing the conversation part.
	Id       *string                         `json:"id,omitempty"`
	Metadata *ConversationPartMetadataSchema `json:"metadata,omitempty"`

	// NotifiedAt The time the user was notified with the conversation part.
	NotifiedAt *int `json:"notified_at,omitempty"`

	// PartType The type of conversation part.
	PartType *string `json:"part_type,omitempty"`

	// Redacted Whether or not the conversation part has been redacted.
	Redacted *bool `json:"redacted,omitempty"`

	// State Indicates the current state of conversation when the conversation part was created.
	State *ConversationPartState `json:"state,omitempty"`

	// Tags A list of tags objects associated with the conversation part.
	Tags *[]TagBasicSchema `json:"tags,omitempty"`

	// Type Always conversation_part
	Type *string `json:"type,omitempty"`

	// UpdatedAt The last time the conversation part was updated.
	UpdatedAt *int `json:"updated_at,omitempty"`
}

ConversationPartSchema A Conversation Part represents a message in the conversation.

type ConversationPartState

type ConversationPartState string

ConversationPartState Indicates the current state of conversation when the conversation part was created.

const (
	ConversationPartStateClosed  ConversationPartState = "closed"
	ConversationPartStateOpen    ConversationPartState = "open"
	ConversationPartStateSnoozed ConversationPartState = "snoozed"
)

Defines values for ConversationPartState.

func (ConversationPartState) Valid

func (e ConversationPartState) Valid() bool

Valid indicates whether the value is a known member of the ConversationPartState enum.

type ConversationPartsSchema

type ConversationPartsSchema struct {
	// ConversationParts A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts.
	ConversationParts *[]ConversationPartSchema `json:"conversation_parts,omitempty"`
	TotalCount        *int                      `json:"total_count,omitempty"`
	Type              *ConversationPartsType    `json:"type,omitempty"`
}

ConversationPartsSchema A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts.

type ConversationPartsType

type ConversationPartsType string

ConversationPartsType defines model for ConversationParts.Type.

const (
	ConversationPartList ConversationPartsType = "conversation_part.list"
)

Defines values for ConversationPartsType.

func (ConversationPartsType) Valid

func (e ConversationPartsType) Valid() bool

Valid indicates whether the value is a known member of the ConversationPartsType enum.

type ConversationPriority

type ConversationPriority string

ConversationPriority If marked as priority, it will return priority or else not_priority.

const (
	ConversationPriorityNotPriority ConversationPriority = "not_priority"
	ConversationPriorityPriority    ConversationPriority = "priority"
)

Defines values for ConversationPriority.

func (ConversationPriority) Valid

func (e ConversationPriority) Valid() bool

Valid indicates whether the value is a known member of the ConversationPriority enum.

type ConversationRatingSchema

type ConversationRatingSchema struct {
	Contact *ContactReferenceSchema `json:"contact,omitempty"`

	// CreatedAt The time the rating was requested in the conversation being rated.
	CreatedAt *int `json:"created_at,omitempty"`

	// Rating The rating, between 1 and 5, for the conversation.
	Rating *int `json:"rating,omitempty"`

	// Remark An optional field to add a remark to correspond to the number rating
	Remark   *string          `json:"remark,omitempty"`
	Teammate *ReferenceSchema `json:"teammate,omitempty"`

	// UpdatedAt The time the rating was last updated.
	UpdatedAt *int `json:"updated_at,omitempty"`
}

ConversationRatingSchema The Conversation Rating object which contains information on the rating and/or remark added by a Contact and the Admin assigned to the conversation.

type ConversationResponseTimeSchema

type ConversationResponseTimeSchema struct {
	// ResponseTime First response time of assigned team in seconds.
	ResponseTime *int `json:"response_time,omitempty"`

	// TeamId Id of the assigned team.
	TeamId *int `json:"team_id,omitempty"`

	// TeamName Name of the assigned Team, null if team does not exist, Unassigned if no team is assigned.
	TeamName *string `json:"team_name,omitempty"`
}

ConversationResponseTimeSchema Details of first response time of assigned team in seconds.

type ConversationSchema

type ConversationSchema struct {
	// AdminAssigneeId The id of the admin assigned to the conversation. If it's not assigned to an admin it will return null.
	AdminAssigneeId *int           `json:"admin_assignee_id,omitempty"`
	AiAgent         *AiAgentSchema `json:"ai_agent,omitempty"`

	// AiAgentParticipated Indicates whether the AI Agent participated in the conversation.
	AiAgentParticipated *bool `json:"ai_agent_participated,omitempty"`

	// Company The company associated with the conversation.
	Company            *CompanySchema              `json:"company,omitempty"`
	Contacts           *ConversationContactsSchema `json:"contacts,omitempty"`
	ConversationParts  *ConversationPartsSchema    `json:"conversation_parts,omitempty"`
	ConversationRating *ConversationRatingSchema   `json:"conversation_rating,omitempty"`

	// CreatedAt The time the conversation was created.
	CreatedAt         *int                                 `json:"created_at,omitempty"`
	CustomAttributes  *CustomAttributesSchema              `json:"custom_attributes,omitempty"`
	FirstContactReply *ConversationFirstContactReplySchema `json:"first_contact_reply,omitempty"`

	// Id The id representing the conversation.
	Id            *string                 `json:"id,omitempty"`
	LinkedObjects *LinkedObjectListSchema `json:"linked_objects,omitempty"`

	// Open Indicates whether a conversation is open (true) or closed (false).
	Open *bool `json:"open,omitempty"`

	// Priority If marked as priority, it will return priority or else not_priority.
	Priority *ConversationPriority `json:"priority,omitempty"`

	// Read Indicates whether a conversation has been read.
	Read       *bool             `json:"read,omitempty"`
	SlaApplied *SlaAppliedSchema `json:"sla_applied,omitempty"`

	// SnoozedUntil If set this is the time in the future when this conversation will be marked as open. i.e. it will be in a snoozed state until this time. i.e. it will be in a snoozed state until this time.
	SnoozedUntil *int                      `json:"snoozed_until,omitempty"`
	Source       *ConversationSourceSchema `json:"source,omitempty"`

	// State Can be set to "open", "closed" or "snoozed".
	State      *ConversationState            `json:"state,omitempty"`
	Statistics *ConversationStatisticsSchema `json:"statistics,omitempty"`
	Tags       *TagsSchema                   `json:"tags,omitempty"`

	// TeamAssigneeId The id of the team assigned to the conversation. If it's not assigned to a team it will return null.
	TeamAssigneeId *int                         `json:"team_assignee_id,omitempty"`
	Teammates      *ConversationTeammatesSchema `json:"teammates,omitempty"`

	// Title The title given to the conversation.
	Title *string `json:"title,omitempty"`

	// Type Always conversation.
	Type *string `json:"type,omitempty"`

	// UpdatedAt The last time the conversation was updated.
	UpdatedAt *int `json:"updated_at,omitempty"`

	// WaitingSince The last time a Contact responded to an Admin. In other words, the time a customer started waiting for a response. Set to null if last reply is from an Admin.
	WaitingSince *int `json:"waiting_since,omitempty"`
}

ConversationSchema Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.

type ConversationSourceSchema

type ConversationSourceSchema struct {
	// Attachments A list of attachments for the part.
	Attachments *[]PartAttachmentSchema       `json:"attachments,omitempty"`
	Author      *ConversationPartAuthorSchema `json:"author,omitempty"`

	// Body The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured. In webhook payloads for API version 2.15+, this field returns plain text.
	Body *string `json:"body,omitempty"`

	// DeliveredAs The conversation's initiation type. Possible values are customer_initiated, campaigns_initiated (legacy campaigns), operator_initiated (Custom bot), automated (Series and other outbounds with dynamic audience message) and admin_initiated (fixed audience message, ticket initiated by an admin, group email).
	DeliveredAs *string `json:"delivered_as,omitempty"`

	// Id The id representing the message.
	Id *string `json:"id,omitempty"`

	// Redacted Whether or not the source message has been redacted. Only applicable for contact initiated messages.
	Redacted *bool `json:"redacted,omitempty"`

	// Subject Optional. The message subject. For Twitter, this will show a generic message regarding why the subject is obscured. In webhook payloads for API version 2.15+, this field returns plain text.
	Subject *string `json:"subject,omitempty"`

	// Type This includes conversation, email, facebook, instagram, phone_call, phone_switch, push, sms, twitter and whatsapp.
	Type *ConversationSourceType `json:"type,omitempty"`

	// Url The URL where the conversation was started. For Twitter, Email, and Bots, this will be blank.
	Url *string `json:"url,omitempty"`
}

ConversationSourceSchema The type of the conversation part that started this conversation. Can be Contact, Admin, Campaign, Automated or Operator initiated.

type ConversationSourceType

type ConversationSourceType string

ConversationSourceType This includes conversation, email, facebook, instagram, phone_call, phone_switch, push, sms, twitter and whatsapp.

const (
	ConversationSourceTypeConversation ConversationSourceType = "conversation"
	ConversationSourceTypeEmail        ConversationSourceType = "email"
	ConversationSourceTypeFacebook     ConversationSourceType = "facebook"
	ConversationSourceTypeInstagram    ConversationSourceType = "instagram"
	ConversationSourceTypePhoneCall    ConversationSourceType = "phone_call"
	ConversationSourceTypePhoneSwitch  ConversationSourceType = "phone_switch"
	ConversationSourceTypePush         ConversationSourceType = "push"
	ConversationSourceTypeSms          ConversationSourceType = "sms"
	ConversationSourceTypeTwitter      ConversationSourceType = "twitter"
	ConversationSourceTypeWhatsapp     ConversationSourceType = "whatsapp"
)

Defines values for ConversationSourceType.

func (ConversationSourceType) Valid

func (e ConversationSourceType) Valid() bool

Valid indicates whether the value is a known member of the ConversationSourceType enum.

type ConversationState

type ConversationState string

ConversationState Can be set to "open", "closed" or "snoozed".

const (
	ConversationStateClosed  ConversationState = "closed"
	ConversationStateOpen    ConversationState = "open"
	ConversationStateSnoozed ConversationState = "snoozed"
)

Defines values for ConversationState.

func (ConversationState) Valid

func (e ConversationState) Valid() bool

Valid indicates whether the value is a known member of the ConversationState enum.

type ConversationStatisticsSchema

type ConversationStatisticsSchema struct {
	// AdjustedHandlingTime Adjusted handling time for conversation in seconds. This is the active handling time excluding idle periods when teammates are not actively working on the conversation.
	AdjustedHandlingTime *int `json:"adjusted_handling_time,omitempty"`

	// AssignedTeamFirstResponseTime An array of conversation response time objects
	AssignedTeamFirstResponseTime *[]ConversationResponseTimeSchema `json:"assigned_team_first_response_time,omitempty"`

	// AssignedTeamFirstResponseTimeInOfficeHours An array of conversation response time objects within office hours
	AssignedTeamFirstResponseTimeInOfficeHours *[]ConversationResponseTimeSchema `json:"assigned_team_first_response_time_in_office_hours,omitempty"`

	// CountAssignments Number of assignments after first_contact_reply_at.
	CountAssignments *int `json:"count_assignments,omitempty"`

	// CountConversationParts Total number of conversation parts.
	CountConversationParts *int `json:"count_conversation_parts,omitempty"`

	// CountReopens Number of reopens after first_contact_reply_at.
	CountReopens *int `json:"count_reopens,omitempty"`

	// FirstAdminReplyAt Time of first admin reply after first_contact_reply_at.
	FirstAdminReplyAt *int `json:"first_admin_reply_at,omitempty"`

	// FirstAssignmentAt Time of first assignment after first_contact_reply_at.
	FirstAssignmentAt *int `json:"first_assignment_at,omitempty"`

	// FirstCloseAt Time of first close after first_contact_reply_at.
	FirstCloseAt *int `json:"first_close_at,omitempty"`

	// FirstContactReplyAt Time of first text conversation part from a contact.
	FirstContactReplyAt *int `json:"first_contact_reply_at,omitempty"`

	// HandlingTime Time from conversation assignment to conversation close in seconds.
	HandlingTime *int `json:"handling_time,omitempty"`

	// LastAdminReplyAt Time of the last conversation part from an admin.
	LastAdminReplyAt *int `json:"last_admin_reply_at,omitempty"`

	// LastAssignmentAdminReplyAt Time of first admin reply since most recent assignment.
	LastAssignmentAdminReplyAt *int `json:"last_assignment_admin_reply_at,omitempty"`

	// LastAssignmentAt Time of last assignment after first_contact_reply_at.
	LastAssignmentAt *int `json:"last_assignment_at,omitempty"`

	// LastCloseAt Time of the last conversation close.
	LastCloseAt *int `json:"last_close_at,omitempty"`

	// LastClosedById The last admin who closed the conversation. Returns a reference to an Admin object.
	LastClosedById *string `json:"last_closed_by_id,omitempty"`

	// LastContactReplyAt Time of the last conversation part from a contact.
	LastContactReplyAt *int `json:"last_contact_reply_at,omitempty"`

	// MedianTimeToReply Median based on all admin replies after a contact reply. Subtracts out of business hours. In seconds.
	MedianTimeToReply *int `json:"median_time_to_reply,omitempty"`

	// TimeToAdminReply Duration until first admin reply. Subtracts out of business hours. In seconds.
	TimeToAdminReply *int `json:"time_to_admin_reply,omitempty"`

	// TimeToAssignment Duration until last assignment before first admin reply. In seconds.
	TimeToAssignment *int `json:"time_to_assignment,omitempty"`

	// TimeToFirstClose Duration until conversation was closed first time. Subtracts out of business hours. In seconds.
	TimeToFirstClose *int `json:"time_to_first_close,omitempty"`

	// TimeToLastClose Duration until conversation was closed last time. Subtracts out of business hours. In seconds.
	TimeToLastClose *int    `json:"time_to_last_close,omitempty"`
	Type            *string `json:"type,omitempty"`
}

ConversationStatisticsSchema A Statistics object containing all information required for reporting, with timestamps and calculated metrics.

type ConversationTeammatesSchema

type ConversationTeammatesSchema struct {
	// Teammates The list of teammates who participated in the conversation (wrote at least one conversation part).
	Teammates *[]ReferenceSchema `json:"teammates,omitempty"`

	// Type The type of the object - `admin.list`.
	Type *string `json:"type,omitempty"`
}

ConversationTeammatesSchema The list of teammates who participated in the conversation (wrote at least one conversation part).

type ConvertConversationToTicketJSONRequestBody

type ConvertConversationToTicketJSONRequestBody = ConvertConversationToTicketRequestSchema

ConvertConversationToTicketJSONRequestBody defines body for ConvertConversationToTicket for application/json ContentType.

type ConvertConversationToTicketParams

type ConvertConversationToTicketParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ConvertConversationToTicketParams defines parameters for ConvertConversationToTicket.

type ConvertConversationToTicketRequestSchema

type ConvertConversationToTicketRequestSchema struct {
	Attributes *TicketRequestCustomAttributesSchema `json:"attributes,omitempty"`

	// TicketTypeId The ID of the type of ticket you want to convert the conversation to
	TicketTypeId string `json:"ticket_type_id"`
}

ConvertConversationToTicketRequestSchema You can convert a Conversation to a Ticket

type ConvertConversationToTicketResponse

type ConvertConversationToTicketResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TicketSchema
	JSON400      *ErrorSchema
}

func ParseConvertConversationToTicketResponse

func ParseConvertConversationToTicketResponse(rsp *http.Response) (*ConvertConversationToTicketResponse, error)

ParseConvertConversationToTicketResponse parses an HTTP response from a ConvertConversationToTicketWithResponse call

func (ConvertConversationToTicketResponse) Status

Status returns HTTPResponse.Status

func (ConvertConversationToTicketResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type ConvertVisitorJSONRequestBody

type ConvertVisitorJSONRequestBody = ConvertVisitorRequestSchema

ConvertVisitorJSONRequestBody defines body for ConvertVisitor for application/json ContentType.

type ConvertVisitorParams

type ConvertVisitorParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ConvertVisitorParams defines parameters for ConvertVisitor.

type ConvertVisitorRequestSchema

type ConvertVisitorRequestSchema struct {
	// Type Represents the role of the Contact model. Accepts `lead` or `user`.
	Type string `json:"type"`

	// User The unique identifiers retained after converting or merging.
	User ConvertVisitorRequest_User `json:"user"`

	// Visitor The unique identifiers to convert a single Visitor.
	Visitor ConvertVisitorRequest_Visitor `json:"visitor"`
}

ConvertVisitorRequestSchema You can merge a Visitor to a Contact of role type lead or user.

type ConvertVisitorRequestUser0

type ConvertVisitorRequestUser0 = interface{}

ConvertVisitorRequestUser0 defines model for .

type ConvertVisitorRequestUser1

type ConvertVisitorRequestUser1 = interface{}

ConvertVisitorRequestUser1 defines model for .

type ConvertVisitorRequestVisitor0

type ConvertVisitorRequestVisitor0 = interface{}

ConvertVisitorRequestVisitor0 defines model for .

type ConvertVisitorRequestVisitor1

type ConvertVisitorRequestVisitor1 = interface{}

ConvertVisitorRequestVisitor1 defines model for .

type ConvertVisitorRequestVisitor2

type ConvertVisitorRequestVisitor2 = interface{}

ConvertVisitorRequestVisitor2 defines model for .

type ConvertVisitorRequest_User

type ConvertVisitorRequest_User struct {
	// Email The contact's email, retained by default if one is present.
	Email *string `json:"email,omitempty"`

	// Id The unique identifier for the contact which is given by Intercom.
	Id *string `json:"id,omitempty"`

	// UserId A unique identifier for the contact which is given to Intercom, which will be represented as external_id.
	UserId *string `json:"user_id,omitempty"`
	// contains filtered or unexported fields
}

ConvertVisitorRequest_User The unique identifiers retained after converting or merging.

func (ConvertVisitorRequest_User) AsConvertVisitorRequestUser0

func (t ConvertVisitorRequest_User) AsConvertVisitorRequestUser0() (ConvertVisitorRequestUser0, error)

AsConvertVisitorRequestUser0 returns the union data inside the ConvertVisitorRequest_User as a ConvertVisitorRequestUser0

func (ConvertVisitorRequest_User) AsConvertVisitorRequestUser1

func (t ConvertVisitorRequest_User) AsConvertVisitorRequestUser1() (ConvertVisitorRequestUser1, error)

AsConvertVisitorRequestUser1 returns the union data inside the ConvertVisitorRequest_User as a ConvertVisitorRequestUser1

func (*ConvertVisitorRequest_User) FromConvertVisitorRequestUser0

func (t *ConvertVisitorRequest_User) FromConvertVisitorRequestUser0(v ConvertVisitorRequestUser0) error

FromConvertVisitorRequestUser0 overwrites any union data inside the ConvertVisitorRequest_User as the provided ConvertVisitorRequestUser0

func (*ConvertVisitorRequest_User) FromConvertVisitorRequestUser1

func (t *ConvertVisitorRequest_User) FromConvertVisitorRequestUser1(v ConvertVisitorRequestUser1) error

FromConvertVisitorRequestUser1 overwrites any union data inside the ConvertVisitorRequest_User as the provided ConvertVisitorRequestUser1

func (ConvertVisitorRequest_User) MarshalJSON

func (t ConvertVisitorRequest_User) MarshalJSON() ([]byte, error)

func (*ConvertVisitorRequest_User) MergeConvertVisitorRequestUser0

func (t *ConvertVisitorRequest_User) MergeConvertVisitorRequestUser0(v ConvertVisitorRequestUser0) error

MergeConvertVisitorRequestUser0 performs a merge with any union data inside the ConvertVisitorRequest_User, using the provided ConvertVisitorRequestUser0

func (*ConvertVisitorRequest_User) MergeConvertVisitorRequestUser1

func (t *ConvertVisitorRequest_User) MergeConvertVisitorRequestUser1(v ConvertVisitorRequestUser1) error

MergeConvertVisitorRequestUser1 performs a merge with any union data inside the ConvertVisitorRequest_User, using the provided ConvertVisitorRequestUser1

func (*ConvertVisitorRequest_User) UnmarshalJSON

func (t *ConvertVisitorRequest_User) UnmarshalJSON(b []byte) error

type ConvertVisitorRequest_Visitor

type ConvertVisitorRequest_Visitor struct {
	// Email The visitor's email.
	Email *string `json:"email,omitempty"`

	// Id The unique identifier for the contact which is given by Intercom.
	Id *string `json:"id,omitempty"`

	// UserId A unique identifier for the contact which is given to Intercom.
	UserId *string `json:"user_id,omitempty"`
	// contains filtered or unexported fields
}

ConvertVisitorRequest_Visitor The unique identifiers to convert a single Visitor.

func (ConvertVisitorRequest_Visitor) AsConvertVisitorRequestVisitor0

func (t ConvertVisitorRequest_Visitor) AsConvertVisitorRequestVisitor0() (ConvertVisitorRequestVisitor0, error)

AsConvertVisitorRequestVisitor0 returns the union data inside the ConvertVisitorRequest_Visitor as a ConvertVisitorRequestVisitor0

func (ConvertVisitorRequest_Visitor) AsConvertVisitorRequestVisitor1

func (t ConvertVisitorRequest_Visitor) AsConvertVisitorRequestVisitor1() (ConvertVisitorRequestVisitor1, error)

AsConvertVisitorRequestVisitor1 returns the union data inside the ConvertVisitorRequest_Visitor as a ConvertVisitorRequestVisitor1

func (ConvertVisitorRequest_Visitor) AsConvertVisitorRequestVisitor2

func (t ConvertVisitorRequest_Visitor) AsConvertVisitorRequestVisitor2() (ConvertVisitorRequestVisitor2, error)

AsConvertVisitorRequestVisitor2 returns the union data inside the ConvertVisitorRequest_Visitor as a ConvertVisitorRequestVisitor2

func (*ConvertVisitorRequest_Visitor) FromConvertVisitorRequestVisitor0

func (t *ConvertVisitorRequest_Visitor) FromConvertVisitorRequestVisitor0(v ConvertVisitorRequestVisitor0) error

FromConvertVisitorRequestVisitor0 overwrites any union data inside the ConvertVisitorRequest_Visitor as the provided ConvertVisitorRequestVisitor0

func (*ConvertVisitorRequest_Visitor) FromConvertVisitorRequestVisitor1

func (t *ConvertVisitorRequest_Visitor) FromConvertVisitorRequestVisitor1(v ConvertVisitorRequestVisitor1) error

FromConvertVisitorRequestVisitor1 overwrites any union data inside the ConvertVisitorRequest_Visitor as the provided ConvertVisitorRequestVisitor1

func (*ConvertVisitorRequest_Visitor) FromConvertVisitorRequestVisitor2

func (t *ConvertVisitorRequest_Visitor) FromConvertVisitorRequestVisitor2(v ConvertVisitorRequestVisitor2) error

FromConvertVisitorRequestVisitor2 overwrites any union data inside the ConvertVisitorRequest_Visitor as the provided ConvertVisitorRequestVisitor2

func (ConvertVisitorRequest_Visitor) MarshalJSON

func (t ConvertVisitorRequest_Visitor) MarshalJSON() ([]byte, error)

func (*ConvertVisitorRequest_Visitor) MergeConvertVisitorRequestVisitor0

func (t *ConvertVisitorRequest_Visitor) MergeConvertVisitorRequestVisitor0(v ConvertVisitorRequestVisitor0) error

MergeConvertVisitorRequestVisitor0 performs a merge with any union data inside the ConvertVisitorRequest_Visitor, using the provided ConvertVisitorRequestVisitor0

func (*ConvertVisitorRequest_Visitor) MergeConvertVisitorRequestVisitor1

func (t *ConvertVisitorRequest_Visitor) MergeConvertVisitorRequestVisitor1(v ConvertVisitorRequestVisitor1) error

MergeConvertVisitorRequestVisitor1 performs a merge with any union data inside the ConvertVisitorRequest_Visitor, using the provided ConvertVisitorRequestVisitor1

func (*ConvertVisitorRequest_Visitor) MergeConvertVisitorRequestVisitor2

func (t *ConvertVisitorRequest_Visitor) MergeConvertVisitorRequestVisitor2(v ConvertVisitorRequestVisitor2) error

MergeConvertVisitorRequestVisitor2 performs a merge with any union data inside the ConvertVisitorRequest_Visitor, using the provided ConvertVisitorRequestVisitor2

func (*ConvertVisitorRequest_Visitor) UnmarshalJSON

func (t *ConvertVisitorRequest_Visitor) UnmarshalJSON(b []byte) error

type ConvertVisitorResponse

type ConvertVisitorResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ContactSchema
	JSON401      *ErrorSchema
}

func ParseConvertVisitorResponse

func ParseConvertVisitorResponse(rsp *http.Response) (*ConvertVisitorResponse, error)

ParseConvertVisitorResponse parses an HTTP response from a ConvertVisitorWithResponse call

func (ConvertVisitorResponse) Status

func (r ConvertVisitorResponse) Status() string

Status returns HTTPResponse.Status

func (ConvertVisitorResponse) StatusCode

func (r ConvertVisitorResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateArticleJSONRequestBody

type CreateArticleJSONRequestBody = CreateArticleRequestSchema

CreateArticleJSONRequestBody defines body for CreateArticle for application/json ContentType.

type CreateArticleParams

type CreateArticleParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

CreateArticleParams defines parameters for CreateArticle.

type CreateArticleRequestSchema

type CreateArticleRequestSchema struct {
	// AuthorId The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.
	AuthorId int `json:"author_id"`

	// Body The content of the article. For multilingual articles, this will be the body of the default language's content.
	Body *string `json:"body,omitempty"`

	// Description The description of the article. For multilingual articles, this will be the description of the default language's content.
	Description *string `json:"description,omitempty"`

	// ParentId The id of the article's parent collection or section. An article without this field stands alone.
	ParentId *int `json:"parent_id,omitempty"`

	// ParentType The type of parent, which can either be a `collection` or `section`.
	ParentType *string `json:"parent_type,omitempty"`

	// State Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language's content.
	State *CreateArticleRequestState `json:"state,omitempty"`

	// Title The title of the article.For multilingual articles, this will be the title of the default language's content.
	Title             string                          `json:"title"`
	TranslatedContent *ArticleTranslatedContentSchema `json:"translated_content,omitempty"`
}

CreateArticleRequestSchema You can create an Article

type CreateArticleRequestState

type CreateArticleRequestState string

CreateArticleRequestState Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language's content.

const (
	CreateArticleRequestStateDraft     CreateArticleRequestState = "draft"
	CreateArticleRequestStatePublished CreateArticleRequestState = "published"
)

Defines values for CreateArticleRequestState.

func (CreateArticleRequestState) Valid

func (e CreateArticleRequestState) Valid() bool

Valid indicates whether the value is a known member of the CreateArticleRequestState enum.

type CreateArticleResponse

type CreateArticleResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ArticleSchema
	JSON400      *ErrorSchema
	JSON401      *ErrorSchema
}

func ParseCreateArticleResponse

func ParseCreateArticleResponse(rsp *http.Response) (*CreateArticleResponse, error)

ParseCreateArticleResponse parses an HTTP response from a CreateArticleWithResponse call

func (CreateArticleResponse) Status

func (r CreateArticleResponse) Status() string

Status returns HTTPResponse.Status

func (CreateArticleResponse) StatusCode

func (r CreateArticleResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateCollectionJSONRequestBody

type CreateCollectionJSONRequestBody = CreateCollectionRequestSchema

CreateCollectionJSONRequestBody defines body for CreateCollection for application/json ContentType.

type CreateCollectionParams

type CreateCollectionParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

CreateCollectionParams defines parameters for CreateCollection.

type CreateCollectionRequestSchema

type CreateCollectionRequestSchema struct {
	// Description The description of the collection. For multilingual collections, this will be the description of the default language's content.
	Description *string `json:"description,omitempty"`

	// HelpCenterId The id of the help center where the collection will be created. If `null` then it will be created in the default help center.
	HelpCenterId *int `json:"help_center_id,omitempty"`

	// Name The name of the collection. For multilingual collections, this will be the name of the default language's content.
	Name string `json:"name"`

	// ParentId The id of the parent collection. If `null` then it will be created as the first level collection.
	ParentId          *string                       `json:"parent_id,omitempty"`
	TranslatedContent *GroupTranslatedContentSchema `json:"translated_content,omitempty"`
}

CreateCollectionRequestSchema You can create a collection

type CreateCollectionResponse

type CreateCollectionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CollectionSchema
	JSON400      *ErrorSchema
	JSON401      *ErrorSchema
}

func ParseCreateCollectionResponse

func ParseCreateCollectionResponse(rsp *http.Response) (*CreateCollectionResponse, error)

ParseCreateCollectionResponse parses an HTTP response from a CreateCollectionWithResponse call

func (CreateCollectionResponse) Status

func (r CreateCollectionResponse) Status() string

Status returns HTTPResponse.Status

func (CreateCollectionResponse) StatusCode

func (r CreateCollectionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateContactJSONBody

type CreateContactJSONBody struct {
	// contains filtered or unexported fields
}

CreateContactJSONBody defines parameters for CreateContact.

type CreateContactJSONRequestBody

type CreateContactJSONRequestBody CreateContactJSONBody

CreateContactJSONRequestBody defines body for CreateContact for application/json ContentType.

type CreateContactParams

type CreateContactParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

CreateContactParams defines parameters for CreateContact.

type CreateContactRequest0

type CreateContactRequest0 = interface{}

CreateContactRequest0 defines model for .

type CreateContactRequest1

type CreateContactRequest1 = interface{}

CreateContactRequest1 defines model for .

type CreateContactRequest2

type CreateContactRequest2 = interface{}

CreateContactRequest2 defines model for .

type CreateContactRequestSchema

type CreateContactRequestSchema struct {
	// Avatar An image URL containing the avatar of a contact
	Avatar *string `json:"avatar,omitempty"`

	// CustomAttributes The custom attributes which are set for the contact
	CustomAttributes *map[string]interface{} `json:"custom_attributes,omitempty"`

	// Email The contacts email
	Email *string `json:"email,omitempty"`

	// ExternalId A unique identifier for the contact which is given to Intercom
	ExternalId *string `json:"external_id,omitempty"`

	// LastSeenAt (Unix timestamp in seconds) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).
	LastSeenAt *int `json:"last_seen_at,omitempty"`

	// Name The contacts name
	Name *string `json:"name,omitempty"`

	// OwnerId The id of an admin that has been assigned account ownership of the contact
	OwnerId *int `json:"owner_id,omitempty"`

	// Phone The contacts phone
	Phone *string `json:"phone,omitempty"`

	// Role The role of the contact.
	Role *string `json:"role,omitempty"`

	// SignedUpAt (Unix timestamp in seconds) The time specified for when a contact signed up.
	SignedUpAt *int `json:"signed_up_at,omitempty"`

	// UnsubscribedFromEmails Whether the contact is unsubscribed from emails
	UnsubscribedFromEmails *bool `json:"unsubscribed_from_emails,omitempty"`
	// contains filtered or unexported fields
}

CreateContactRequestSchema Payload to create a contact

func (CreateContactRequestSchema) AsCreateContactRequest0

func (t CreateContactRequestSchema) AsCreateContactRequest0() (CreateContactRequest0, error)

AsCreateContactRequest0 returns the union data inside the CreateContactRequestSchema as a CreateContactRequest0

func (CreateContactRequestSchema) AsCreateContactRequest1

func (t CreateContactRequestSchema) AsCreateContactRequest1() (CreateContactRequest1, error)

AsCreateContactRequest1 returns the union data inside the CreateContactRequestSchema as a CreateContactRequest1

func (CreateContactRequestSchema) AsCreateContactRequest2

func (t CreateContactRequestSchema) AsCreateContactRequest2() (CreateContactRequest2, error)

AsCreateContactRequest2 returns the union data inside the CreateContactRequestSchema as a CreateContactRequest2

func (*CreateContactRequestSchema) FromCreateContactRequest0

func (t *CreateContactRequestSchema) FromCreateContactRequest0(v CreateContactRequest0) error

FromCreateContactRequest0 overwrites any union data inside the CreateContactRequestSchema as the provided CreateContactRequest0

func (*CreateContactRequestSchema) FromCreateContactRequest1

func (t *CreateContactRequestSchema) FromCreateContactRequest1(v CreateContactRequest1) error

FromCreateContactRequest1 overwrites any union data inside the CreateContactRequestSchema as the provided CreateContactRequest1

func (*CreateContactRequestSchema) FromCreateContactRequest2

func (t *CreateContactRequestSchema) FromCreateContactRequest2(v CreateContactRequest2) error

FromCreateContactRequest2 overwrites any union data inside the CreateContactRequestSchema as the provided CreateContactRequest2

func (CreateContactRequestSchema) MarshalJSON

func (t CreateContactRequestSchema) MarshalJSON() ([]byte, error)

func (*CreateContactRequestSchema) MergeCreateContactRequest0

func (t *CreateContactRequestSchema) MergeCreateContactRequest0(v CreateContactRequest0) error

MergeCreateContactRequest0 performs a merge with any union data inside the CreateContactRequestSchema, using the provided CreateContactRequest0

func (*CreateContactRequestSchema) MergeCreateContactRequest1

func (t *CreateContactRequestSchema) MergeCreateContactRequest1(v CreateContactRequest1) error

MergeCreateContactRequest1 performs a merge with any union data inside the CreateContactRequestSchema, using the provided CreateContactRequest1

func (*CreateContactRequestSchema) MergeCreateContactRequest2

func (t *CreateContactRequestSchema) MergeCreateContactRequest2(v CreateContactRequest2) error

MergeCreateContactRequest2 performs a merge with any union data inside the CreateContactRequestSchema, using the provided CreateContactRequest2

func (*CreateContactRequestSchema) UnmarshalJSON

func (t *CreateContactRequestSchema) UnmarshalJSON(b []byte) error

type CreateContactResponse

type CreateContactResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ContactSchema
	JSON401      *ErrorSchema
}

func ParseCreateContactResponse

func ParseCreateContactResponse(rsp *http.Response) (*CreateContactResponse, error)

ParseCreateContactResponse parses an HTTP response from a CreateContactWithResponse call

func (CreateContactResponse) Status

func (r CreateContactResponse) Status() string

Status returns HTTPResponse.Status

func (CreateContactResponse) StatusCode

func (r CreateContactResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateContentImportSourceJSONRequestBody

type CreateContentImportSourceJSONRequestBody = CreateContentImportSourceRequestSchema

CreateContentImportSourceJSONRequestBody defines body for CreateContentImportSource for application/json ContentType.

type CreateContentImportSourceParams

type CreateContentImportSourceParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

CreateContentImportSourceParams defines parameters for CreateContentImportSource.

type CreateContentImportSourceRequestAudienceIds0

type CreateContentImportSourceRequestAudienceIds0 = int

CreateContentImportSourceRequestAudienceIds0 defines model for .

type CreateContentImportSourceRequestAudienceIds1

type CreateContentImportSourceRequestAudienceIds1 = []int

CreateContentImportSourceRequestAudienceIds1 defines model for .

type CreateContentImportSourceRequestSchema

type CreateContentImportSourceRequestSchema struct {
	// AudienceIds The unique identifiers for the audiences to associate with this content import source. Can be a single integer or an array of integers.
	AudienceIds *CreateContentImportSourceRequest_AudienceIds `json:"audience_ids,omitempty"`

	// Status The status of the content import source.
	Status *CreateContentImportSourceRequestStatus `json:"status,omitempty"`

	// SyncBehavior If you intend to create or update External Pages via the API, this should be set to `api`.
	SyncBehavior CreateContentImportSourceRequestSyncBehavior `json:"sync_behavior"`

	// Url The URL of the content import source.
	Url string `json:"url"`
}

CreateContentImportSourceRequestSchema You can add an Content Import Source to your Fin Content Library.

type CreateContentImportSourceRequestStatus

type CreateContentImportSourceRequestStatus string

CreateContentImportSourceRequestStatus The status of the content import source.

const (
	CreateContentImportSourceRequestStatusActive      CreateContentImportSourceRequestStatus = "active"
	CreateContentImportSourceRequestStatusDeactivated CreateContentImportSourceRequestStatus = "deactivated"
)

Defines values for CreateContentImportSourceRequestStatus.

func (CreateContentImportSourceRequestStatus) Valid

Valid indicates whether the value is a known member of the CreateContentImportSourceRequestStatus enum.

type CreateContentImportSourceRequestSyncBehavior

type CreateContentImportSourceRequestSyncBehavior string

CreateContentImportSourceRequestSyncBehavior If you intend to create or update External Pages via the API, this should be set to `api`.

const (
	CreateContentImportSourceRequestSyncBehaviorApi CreateContentImportSourceRequestSyncBehavior = "api"
)

Defines values for CreateContentImportSourceRequestSyncBehavior.

func (CreateContentImportSourceRequestSyncBehavior) Valid

Valid indicates whether the value is a known member of the CreateContentImportSourceRequestSyncBehavior enum.

type CreateContentImportSourceRequest_AudienceIds

type CreateContentImportSourceRequest_AudienceIds struct {
	// contains filtered or unexported fields
}

CreateContentImportSourceRequest_AudienceIds The unique identifiers for the audiences to associate with this content import source. Can be a single integer or an array of integers.

func (CreateContentImportSourceRequest_AudienceIds) AsCreateContentImportSourceRequestAudienceIds0

func (t CreateContentImportSourceRequest_AudienceIds) AsCreateContentImportSourceRequestAudienceIds0() (CreateContentImportSourceRequestAudienceIds0, error)

AsCreateContentImportSourceRequestAudienceIds0 returns the union data inside the CreateContentImportSourceRequest_AudienceIds as a CreateContentImportSourceRequestAudienceIds0

func (CreateContentImportSourceRequest_AudienceIds) AsCreateContentImportSourceRequestAudienceIds1

func (t CreateContentImportSourceRequest_AudienceIds) AsCreateContentImportSourceRequestAudienceIds1() (CreateContentImportSourceRequestAudienceIds1, error)

AsCreateContentImportSourceRequestAudienceIds1 returns the union data inside the CreateContentImportSourceRequest_AudienceIds as a CreateContentImportSourceRequestAudienceIds1

func (*CreateContentImportSourceRequest_AudienceIds) FromCreateContentImportSourceRequestAudienceIds0

func (t *CreateContentImportSourceRequest_AudienceIds) FromCreateContentImportSourceRequestAudienceIds0(v CreateContentImportSourceRequestAudienceIds0) error

FromCreateContentImportSourceRequestAudienceIds0 overwrites any union data inside the CreateContentImportSourceRequest_AudienceIds as the provided CreateContentImportSourceRequestAudienceIds0

func (*CreateContentImportSourceRequest_AudienceIds) FromCreateContentImportSourceRequestAudienceIds1

func (t *CreateContentImportSourceRequest_AudienceIds) FromCreateContentImportSourceRequestAudienceIds1(v CreateContentImportSourceRequestAudienceIds1) error

FromCreateContentImportSourceRequestAudienceIds1 overwrites any union data inside the CreateContentImportSourceRequest_AudienceIds as the provided CreateContentImportSourceRequestAudienceIds1

func (CreateContentImportSourceRequest_AudienceIds) MarshalJSON

func (*CreateContentImportSourceRequest_AudienceIds) MergeCreateContentImportSourceRequestAudienceIds0

func (t *CreateContentImportSourceRequest_AudienceIds) MergeCreateContentImportSourceRequestAudienceIds0(v CreateContentImportSourceRequestAudienceIds0) error

MergeCreateContentImportSourceRequestAudienceIds0 performs a merge with any union data inside the CreateContentImportSourceRequest_AudienceIds, using the provided CreateContentImportSourceRequestAudienceIds0

func (*CreateContentImportSourceRequest_AudienceIds) MergeCreateContentImportSourceRequestAudienceIds1

func (t *CreateContentImportSourceRequest_AudienceIds) MergeCreateContentImportSourceRequestAudienceIds1(v CreateContentImportSourceRequestAudienceIds1) error

MergeCreateContentImportSourceRequestAudienceIds1 performs a merge with any union data inside the CreateContentImportSourceRequest_AudienceIds, using the provided CreateContentImportSourceRequestAudienceIds1

func (*CreateContentImportSourceRequest_AudienceIds) UnmarshalJSON

type CreateContentImportSourceResponse

type CreateContentImportSourceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ContentImportSourceSchema
	JSON401      *ErrorSchema
}

func ParseCreateContentImportSourceResponse

func ParseCreateContentImportSourceResponse(rsp *http.Response) (*CreateContentImportSourceResponse, error)

ParseCreateContentImportSourceResponse parses an HTTP response from a CreateContentImportSourceWithResponse call

func (CreateContentImportSourceResponse) Status

Status returns HTTPResponse.Status

func (CreateContentImportSourceResponse) StatusCode

func (r CreateContentImportSourceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateConversationJSONRequestBody

type CreateConversationJSONRequestBody = CreateConversationRequestSchema

CreateConversationJSONRequestBody defines body for CreateConversation for application/json ContentType.

type CreateConversationParams

type CreateConversationParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

CreateConversationParams defines parameters for CreateConversation.

type CreateConversationRequestFromType

type CreateConversationRequestFromType string

CreateConversationRequestFromType The role associated to the contact - user or lead.

const (
	CreateConversationRequestFromTypeContact CreateConversationRequestFromType = "contact"
	CreateConversationRequestFromTypeLead    CreateConversationRequestFromType = "lead"
	CreateConversationRequestFromTypeUser    CreateConversationRequestFromType = "user"
)

Defines values for CreateConversationRequestFromType.

func (CreateConversationRequestFromType) Valid

Valid indicates whether the value is a known member of the CreateConversationRequestFromType enum.

type CreateConversationRequestSchema

type CreateConversationRequestSchema struct {
	// AttachmentUrls A list of image URLs that will be added as attachments. You can include up to 10 URLs.
	AttachmentUrls *[]string `json:"attachment_urls,omitempty"`

	// Body The content of the message. HTML is not supported.
	Body string `json:"body"`

	// CreatedAt The time the conversation was created as a UTC Unix timestamp. If not provided, the current time will be used. This field is only recommneded for migrating past conversations from another source into Intercom.
	CreatedAt *int `json:"created_at,omitempty"`
	From      struct {
		// Id The identifier for the contact which is given by Intercom.
		Id openapi_types.UUID `json:"id"`

		// Type The role associated to the contact - user or lead.
		Type CreateConversationRequestFromType `json:"type"`
	} `json:"from"`

	// Subject The title of the email. Only applicable if the message type is email.
	Subject *string `json:"subject,omitempty"`
}

CreateConversationRequestSchema Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.

type CreateConversationResponse

type CreateConversationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *MessageSchema
	JSON401      *ErrorSchema
	JSON403      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseCreateConversationResponse

func ParseCreateConversationResponse(rsp *http.Response) (*CreateConversationResponse, error)

ParseCreateConversationResponse parses an HTTP response from a CreateConversationWithResponse call

func (CreateConversationResponse) Status

Status returns HTTPResponse.Status

func (CreateConversationResponse) StatusCode

func (r CreateConversationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateCustomObjectInstancesJSONRequestBody

type CreateCustomObjectInstancesJSONRequestBody = CreateOrUpdateCustomObjectInstanceRequestSchema

CreateCustomObjectInstancesJSONRequestBody defines body for CreateCustomObjectInstances for application/json ContentType.

type CreateCustomObjectInstancesParams

type CreateCustomObjectInstancesParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

CreateCustomObjectInstancesParams defines parameters for CreateCustomObjectInstances.

type CreateCustomObjectInstancesResponse

type CreateCustomObjectInstancesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CustomObjectInstanceSchema
	JSON401      *Unauthorized
	JSON404      *TypeNotFound
}

func ParseCreateCustomObjectInstancesResponse

func ParseCreateCustomObjectInstancesResponse(rsp *http.Response) (*CreateCustomObjectInstancesResponse, error)

ParseCreateCustomObjectInstancesResponse parses an HTTP response from a CreateCustomObjectInstancesWithResponse call

func (CreateCustomObjectInstancesResponse) Status

Status returns HTTPResponse.Status

func (CreateCustomObjectInstancesResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type CreateDataAttributeJSONRequestBody

type CreateDataAttributeJSONRequestBody = CreateDataAttributeRequestSchema

CreateDataAttributeJSONRequestBody defines body for CreateDataAttribute for application/json ContentType.

type CreateDataAttributeParams

type CreateDataAttributeParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

CreateDataAttributeParams defines parameters for CreateDataAttribute.

type CreateDataAttributeRequest0

type CreateDataAttributeRequest0 struct {
	DataType interface{} `json:"data_type,omitempty"`

	// Options Array of objects representing the options of the list, with `value` as the key and the option as the value. At least two options are required.
	Options []struct {
		Value *string `json:"value,omitempty"`
	} `json:"options"`
}

CreateDataAttributeRequest0 defines model for .

type CreateDataAttributeRequest1

type CreateDataAttributeRequest1 struct {
	DataType interface{} `json:"data_type,omitempty"`
}

CreateDataAttributeRequest1 defines model for .

type CreateDataAttributeRequestModel

type CreateDataAttributeRequestModel string

CreateDataAttributeRequestModel The model that the data attribute belongs to.

const (
	CreateDataAttributeRequestModelCompany CreateDataAttributeRequestModel = "company"
	CreateDataAttributeRequestModelContact CreateDataAttributeRequestModel = "contact"
)

Defines values for CreateDataAttributeRequestModel.

func (CreateDataAttributeRequestModel) Valid

Valid indicates whether the value is a known member of the CreateDataAttributeRequestModel enum.

type CreateDataAttributeRequestSchema

type CreateDataAttributeRequestSchema struct {
	// Description The readable description you see in the UI for the attribute.
	Description *string `json:"description,omitempty"`

	// MessengerWritable Can this attribute be updated by the Messenger
	MessengerWritable *bool `json:"messenger_writable,omitempty"`

	// Model The model that the data attribute belongs to.
	Model CreateDataAttributeRequestModel `json:"model"`

	// Name The name of the data attribute.
	Name string `json:"name"`
	// contains filtered or unexported fields
}

CreateDataAttributeRequestSchema defines model for create_data_attribute_request.

func (CreateDataAttributeRequestSchema) AsCreateDataAttributeRequest0

func (t CreateDataAttributeRequestSchema) AsCreateDataAttributeRequest0() (CreateDataAttributeRequest0, error)

AsCreateDataAttributeRequest0 returns the union data inside the CreateDataAttributeRequestSchema as a CreateDataAttributeRequest0

func (CreateDataAttributeRequestSchema) AsCreateDataAttributeRequest1

func (t CreateDataAttributeRequestSchema) AsCreateDataAttributeRequest1() (CreateDataAttributeRequest1, error)

AsCreateDataAttributeRequest1 returns the union data inside the CreateDataAttributeRequestSchema as a CreateDataAttributeRequest1

func (*CreateDataAttributeRequestSchema) FromCreateDataAttributeRequest0

func (t *CreateDataAttributeRequestSchema) FromCreateDataAttributeRequest0(v CreateDataAttributeRequest0) error

FromCreateDataAttributeRequest0 overwrites any union data inside the CreateDataAttributeRequestSchema as the provided CreateDataAttributeRequest0

func (*CreateDataAttributeRequestSchema) FromCreateDataAttributeRequest1

func (t *CreateDataAttributeRequestSchema) FromCreateDataAttributeRequest1(v CreateDataAttributeRequest1) error

FromCreateDataAttributeRequest1 overwrites any union data inside the CreateDataAttributeRequestSchema as the provided CreateDataAttributeRequest1

func (CreateDataAttributeRequestSchema) MarshalJSON

func (t CreateDataAttributeRequestSchema) MarshalJSON() ([]byte, error)

func (*CreateDataAttributeRequestSchema) MergeCreateDataAttributeRequest0

func (t *CreateDataAttributeRequestSchema) MergeCreateDataAttributeRequest0(v CreateDataAttributeRequest0) error

MergeCreateDataAttributeRequest0 performs a merge with any union data inside the CreateDataAttributeRequestSchema, using the provided CreateDataAttributeRequest0

func (*CreateDataAttributeRequestSchema) MergeCreateDataAttributeRequest1

func (t *CreateDataAttributeRequestSchema) MergeCreateDataAttributeRequest1(v CreateDataAttributeRequest1) error

MergeCreateDataAttributeRequest1 performs a merge with any union data inside the CreateDataAttributeRequestSchema, using the provided CreateDataAttributeRequest1

func (*CreateDataAttributeRequestSchema) UnmarshalJSON

func (t *CreateDataAttributeRequestSchema) UnmarshalJSON(b []byte) error

type CreateDataAttributeResponse

type CreateDataAttributeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DataAttributeSchema
	JSON400      *ErrorSchema
	JSON401      *ErrorSchema
}

func ParseCreateDataAttributeResponse

func ParseCreateDataAttributeResponse(rsp *http.Response) (*CreateDataAttributeResponse, error)

ParseCreateDataAttributeResponse parses an HTTP response from a CreateDataAttributeWithResponse call

func (CreateDataAttributeResponse) Status

Status returns HTTPResponse.Status

func (CreateDataAttributeResponse) StatusCode

func (r CreateDataAttributeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateDataEventJSONRequestBody

type CreateDataEventJSONRequestBody = CreateDataEventRequestSchema

CreateDataEventJSONRequestBody defines body for CreateDataEvent for application/json ContentType.

type CreateDataEventParams

type CreateDataEventParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

CreateDataEventParams defines parameters for CreateDataEvent.

type CreateDataEventRequest0

type CreateDataEventRequest0 = interface{}

CreateDataEventRequest0 defines model for .

type CreateDataEventRequest1

type CreateDataEventRequest1 = interface{}

CreateDataEventRequest1 defines model for .

type CreateDataEventRequest2

type CreateDataEventRequest2 = interface{}

CreateDataEventRequest2 defines model for .

type CreateDataEventRequestSchema

type CreateDataEventRequestSchema struct {
	// CreatedAt The time the event occurred as a UTC Unix timestamp
	CreatedAt *int `json:"created_at,omitempty"`

	// Email An email address for your user. An email should only be used where your application uses email to uniquely identify users.
	Email *string `json:"email,omitempty"`

	// EventName The name of the event that occurred. This is presented to your App's admins when filtering and creating segments - a good event name is typically a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`.
	EventName *string `json:"event_name,omitempty"`

	// Id The unique identifier for the contact (lead or user) which is given by Intercom.
	Id *string `json:"id,omitempty"`

	// Metadata Optional metadata about the event.
	Metadata *map[string]string `json:"metadata,omitempty"`

	// UserId Your identifier for the user.
	UserId *string `json:"user_id,omitempty"`
	// contains filtered or unexported fields
}

CreateDataEventRequestSchema defines model for create_data_event_request.

func (CreateDataEventRequestSchema) AsCreateDataEventRequest0

func (t CreateDataEventRequestSchema) AsCreateDataEventRequest0() (CreateDataEventRequest0, error)

AsCreateDataEventRequest0 returns the union data inside the CreateDataEventRequestSchema as a CreateDataEventRequest0

func (CreateDataEventRequestSchema) AsCreateDataEventRequest1

func (t CreateDataEventRequestSchema) AsCreateDataEventRequest1() (CreateDataEventRequest1, error)

AsCreateDataEventRequest1 returns the union data inside the CreateDataEventRequestSchema as a CreateDataEventRequest1

func (CreateDataEventRequestSchema) AsCreateDataEventRequest2

func (t CreateDataEventRequestSchema) AsCreateDataEventRequest2() (CreateDataEventRequest2, error)

AsCreateDataEventRequest2 returns the union data inside the CreateDataEventRequestSchema as a CreateDataEventRequest2

func (*CreateDataEventRequestSchema) FromCreateDataEventRequest0

func (t *CreateDataEventRequestSchema) FromCreateDataEventRequest0(v CreateDataEventRequest0) error

FromCreateDataEventRequest0 overwrites any union data inside the CreateDataEventRequestSchema as the provided CreateDataEventRequest0

func (*CreateDataEventRequestSchema) FromCreateDataEventRequest1

func (t *CreateDataEventRequestSchema) FromCreateDataEventRequest1(v CreateDataEventRequest1) error

FromCreateDataEventRequest1 overwrites any union data inside the CreateDataEventRequestSchema as the provided CreateDataEventRequest1

func (*CreateDataEventRequestSchema) FromCreateDataEventRequest2

func (t *CreateDataEventRequestSchema) FromCreateDataEventRequest2(v CreateDataEventRequest2) error

FromCreateDataEventRequest2 overwrites any union data inside the CreateDataEventRequestSchema as the provided CreateDataEventRequest2

func (CreateDataEventRequestSchema) MarshalJSON

func (t CreateDataEventRequestSchema) MarshalJSON() ([]byte, error)

func (*CreateDataEventRequestSchema) MergeCreateDataEventRequest0

func (t *CreateDataEventRequestSchema) MergeCreateDataEventRequest0(v CreateDataEventRequest0) error

MergeCreateDataEventRequest0 performs a merge with any union data inside the CreateDataEventRequestSchema, using the provided CreateDataEventRequest0

func (*CreateDataEventRequestSchema) MergeCreateDataEventRequest1

func (t *CreateDataEventRequestSchema) MergeCreateDataEventRequest1(v CreateDataEventRequest1) error

MergeCreateDataEventRequest1 performs a merge with any union data inside the CreateDataEventRequestSchema, using the provided CreateDataEventRequest1

func (*CreateDataEventRequestSchema) MergeCreateDataEventRequest2

func (t *CreateDataEventRequestSchema) MergeCreateDataEventRequest2(v CreateDataEventRequest2) error

MergeCreateDataEventRequest2 performs a merge with any union data inside the CreateDataEventRequestSchema, using the provided CreateDataEventRequest2

func (*CreateDataEventRequestSchema) UnmarshalJSON

func (t *CreateDataEventRequestSchema) UnmarshalJSON(b []byte) error

type CreateDataEventResponse

type CreateDataEventResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON401      *ErrorSchema
}

func ParseCreateDataEventResponse

func ParseCreateDataEventResponse(rsp *http.Response) (*CreateDataEventResponse, error)

ParseCreateDataEventResponse parses an HTTP response from a CreateDataEventWithResponse call

func (CreateDataEventResponse) Status

func (r CreateDataEventResponse) Status() string

Status returns HTTPResponse.Status

func (CreateDataEventResponse) StatusCode

func (r CreateDataEventResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateDataEventSummariesRequestSchema

type CreateDataEventSummariesRequestSchema struct {
	// EventSummaries A list of event summaries for the user. Each event summary should contain the event name, the time the event occurred, and the number of times the event occurred. The event name should be a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`.
	EventSummaries *struct {
		// Count The number of times the event occurred.
		Count *int `json:"count,omitempty"`

		// EventName The name of the event that occurred. A good event name is typically a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`.
		EventName *string `json:"event_name,omitempty"`

		// First The first time the event was sent
		First *int `json:"first,omitempty"`

		// Last The last time the event was sent
		Last *int `json:"last,omitempty"`
	} `json:"event_summaries,omitempty"`

	// UserId Your identifier for the user.
	UserId *string `json:"user_id,omitempty"`
}

CreateDataEventSummariesRequestSchema You can send a list of event summaries for a user. Each event summary should contain the event name, the time the event occurred, and the number of times the event occurred. The event name should be a past tense "verb-noun" combination, to improve readability, for example `updated-plan`.

type CreateDataExportJSONRequestBody

type CreateDataExportJSONRequestBody = CreateDataExportsRequestSchema

CreateDataExportJSONRequestBody defines body for CreateDataExport for application/json ContentType.

type CreateDataExportParams

type CreateDataExportParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

CreateDataExportParams defines parameters for CreateDataExport.

type CreateDataExportResponse

type CreateDataExportResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DataExportSchema
}

func ParseCreateDataExportResponse

func ParseCreateDataExportResponse(rsp *http.Response) (*CreateDataExportResponse, error)

ParseCreateDataExportResponse parses an HTTP response from a CreateDataExportWithResponse call

func (CreateDataExportResponse) Status

func (r CreateDataExportResponse) Status() string

Status returns HTTPResponse.Status

func (CreateDataExportResponse) StatusCode

func (r CreateDataExportResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateDataExportsRequestSchema

type CreateDataExportsRequestSchema struct {
	// CreatedAtAfter The start date that you request data for. It must be formatted as a unix timestamp.
	CreatedAtAfter int `json:"created_at_after"`

	// CreatedAtBefore The end date that you request data for. It must be formatted as a unix timestamp.
	CreatedAtBefore int `json:"created_at_before"`
}

CreateDataExportsRequestSchema Request for creating a data export

type CreateExternalPageJSONRequestBody

type CreateExternalPageJSONRequestBody = CreateExternalPageRequestSchema

CreateExternalPageJSONRequestBody defines body for CreateExternalPage for application/json ContentType.

type CreateExternalPageParams

type CreateExternalPageParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

CreateExternalPageParams defines parameters for CreateExternalPage.

type CreateExternalPageRequestLocale

type CreateExternalPageRequestLocale string

CreateExternalPageRequestLocale Always en

const (
	CreateExternalPageRequestLocaleEn CreateExternalPageRequestLocale = "en"
)

Defines values for CreateExternalPageRequestLocale.

func (CreateExternalPageRequestLocale) Valid

Valid indicates whether the value is a known member of the CreateExternalPageRequestLocale enum.

type CreateExternalPageRequestSchema

type CreateExternalPageRequestSchema struct {
	// AiAgentAvailability Whether the external page should be used to answer questions by AI Agent. Will not default when updating an existing external page.
	AiAgentAvailability *bool `json:"ai_agent_availability,omitempty"`

	// AiCopilotAvailability Whether the external page should be used to answer questions by AI Copilot. Will not default when updating an existing external page.
	AiCopilotAvailability *bool `json:"ai_copilot_availability,omitempty"`

	// ExternalId The identifier for the external page which was given by the source. Must be unique for the source.
	ExternalId string `json:"external_id"`

	// Html The body of the external page in HTML.
	Html string `json:"html"`

	// Locale Always en
	Locale CreateExternalPageRequestLocale `json:"locale"`

	// SourceId The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response.
	SourceId int `json:"source_id"`

	// Title The title of the external page.
	Title string `json:"title"`

	// Url The URL of the external page. This will be used by Fin to link end users to the page it based its answer on. When a URL is not present, Fin will not reference the source.
	Url *string `json:"url,omitempty"`
}

CreateExternalPageRequestSchema You can add an External Page to your Fin Content Library.

type CreateExternalPageResponse

type CreateExternalPageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ExternalPageSchema
	JSON401      *ErrorSchema
}

func ParseCreateExternalPageResponse

func ParseCreateExternalPageResponse(rsp *http.Response) (*CreateExternalPageResponse, error)

ParseCreateExternalPageResponse parses an HTTP response from a CreateExternalPageWithResponse call

func (CreateExternalPageResponse) Status

Status returns HTTPResponse.Status

func (CreateExternalPageResponse) StatusCode

func (r CreateExternalPageResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateInternalArticleJSONRequestBody

type CreateInternalArticleJSONRequestBody = CreateInternalArticleRequestSchema

CreateInternalArticleJSONRequestBody defines body for CreateInternalArticle for application/json ContentType.

type CreateInternalArticleParams

type CreateInternalArticleParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

CreateInternalArticleParams defines parameters for CreateInternalArticle.

type CreateInternalArticleRequestSchema

type CreateInternalArticleRequestSchema struct {
	// AuthorId The id of the author of the article.
	AuthorId int `json:"author_id"`

	// Body The content of the article.
	Body *string `json:"body,omitempty"`

	// OwnerId The id of the owner of the article.
	OwnerId int `json:"owner_id"`

	// Title The title of the article.
	Title string `json:"title"`
}

CreateInternalArticleRequestSchema You can create an Internal Article

type CreateInternalArticleResponse

type CreateInternalArticleResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *InternalArticleSchema
	JSON400      *ErrorSchema
	JSON401      *ErrorSchema
}

func ParseCreateInternalArticleResponse

func ParseCreateInternalArticleResponse(rsp *http.Response) (*CreateInternalArticleResponse, error)

ParseCreateInternalArticleResponse parses an HTTP response from a CreateInternalArticleWithResponse call

func (CreateInternalArticleResponse) Status

Status returns HTTPResponse.Status

func (CreateInternalArticleResponse) StatusCode

func (r CreateInternalArticleResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateMessageJSONRequestBody

type CreateMessageJSONRequestBody = CreateMessageRequestSchema

CreateMessageJSONRequestBody defines body for CreateMessage for application/json ContentType.

type CreateMessageParams

type CreateMessageParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

CreateMessageParams defines parameters for CreateMessage.

type CreateMessageRequest0

type CreateMessageRequest0 = interface{}

CreateMessageRequest0 defines model for .

type CreateMessageRequest1

type CreateMessageRequest1 = interface{}

CreateMessageRequest1 defines model for .

type CreateMessageRequestBcc1

type CreateMessageRequestBcc1 = []RecipientSchema

CreateMessageRequestBcc1 The BCC recipients of the message.

type CreateMessageRequestCc1

type CreateMessageRequestCc1 = []RecipientSchema

CreateMessageRequestCc1 The CC recipients of the message.

type CreateMessageRequestFromType

type CreateMessageRequestFromType string

CreateMessageRequestFromType Always `admin`.

const (
	CreateMessageRequestFromTypeAdmin CreateMessageRequestFromType = "admin"
)

Defines values for CreateMessageRequestFromType.

func (CreateMessageRequestFromType) Valid

Valid indicates whether the value is a known member of the CreateMessageRequestFromType enum.

type CreateMessageRequestMessageType

type CreateMessageRequestMessageType string

CreateMessageRequestMessageType The kind of message being created. Values: `in_app` or `email`.

const (
	CreateMessageRequestMessageTypeEmail CreateMessageRequestMessageType = "email"
	CreateMessageRequestMessageTypeInApp CreateMessageRequestMessageType = "in_app"
)

Defines values for CreateMessageRequestMessageType.

func (CreateMessageRequestMessageType) Valid

Valid indicates whether the value is a known member of the CreateMessageRequestMessageType enum.

type CreateMessageRequestSchema

type CreateMessageRequestSchema struct {
	Bcc *CreateMessageRequest_Bcc `json:"bcc,omitempty"`

	// Body The content of the message. HTML and plaintext are supported.
	Body *string                  `json:"body,omitempty"`
	Cc   *CreateMessageRequest_Cc `json:"cc,omitempty"`

	// CreateConversationWithoutContactReply Whether a conversation should be opened in the inbox for the message without the contact replying. Defaults to false if not provided.
	CreateConversationWithoutContactReply *bool `json:"create_conversation_without_contact_reply,omitempty"`

	// CreatedAt The time the message was created. If not provided, the current time will be used.
	CreatedAt *int `json:"created_at,omitempty"`

	// From The sender of the message. If not provided, the default sender will be used.
	From *struct {
		// Id The identifier for the admin which is given by Intercom.
		Id int `json:"id"`

		// Type Always `admin`.
		Type CreateMessageRequestFromType `json:"type"`
	} `json:"from,omitempty"`

	// MessageType The kind of message being created. Values: `in_app` or `email`.
	MessageType *CreateMessageRequestMessageType `json:"message_type,omitempty"`

	// Subject The title of the email.
	Subject *string `json:"subject,omitempty"`

	// Template The style of the outgoing message. Possible values `plain` or `personal`.
	Template *string                  `json:"template,omitempty"`
	To       *CreateMessageRequest_To `json:"to,omitempty"`
	// contains filtered or unexported fields
}

CreateMessageRequestSchema You can create a message

func (CreateMessageRequestSchema) AsCreateMessageRequest0

func (t CreateMessageRequestSchema) AsCreateMessageRequest0() (CreateMessageRequest0, error)

AsCreateMessageRequest0 returns the union data inside the CreateMessageRequestSchema as a CreateMessageRequest0

func (CreateMessageRequestSchema) AsCreateMessageRequest1

func (t CreateMessageRequestSchema) AsCreateMessageRequest1() (CreateMessageRequest1, error)

AsCreateMessageRequest1 returns the union data inside the CreateMessageRequestSchema as a CreateMessageRequest1

func (*CreateMessageRequestSchema) FromCreateMessageRequest0

func (t *CreateMessageRequestSchema) FromCreateMessageRequest0(v CreateMessageRequest0) error

FromCreateMessageRequest0 overwrites any union data inside the CreateMessageRequestSchema as the provided CreateMessageRequest0

func (*CreateMessageRequestSchema) FromCreateMessageRequest1

func (t *CreateMessageRequestSchema) FromCreateMessageRequest1(v CreateMessageRequest1) error

FromCreateMessageRequest1 overwrites any union data inside the CreateMessageRequestSchema as the provided CreateMessageRequest1

func (CreateMessageRequestSchema) MarshalJSON

func (t CreateMessageRequestSchema) MarshalJSON() ([]byte, error)

func (*CreateMessageRequestSchema) MergeCreateMessageRequest0

func (t *CreateMessageRequestSchema) MergeCreateMessageRequest0(v CreateMessageRequest0) error

MergeCreateMessageRequest0 performs a merge with any union data inside the CreateMessageRequestSchema, using the provided CreateMessageRequest0

func (*CreateMessageRequestSchema) MergeCreateMessageRequest1

func (t *CreateMessageRequestSchema) MergeCreateMessageRequest1(v CreateMessageRequest1) error

MergeCreateMessageRequest1 performs a merge with any union data inside the CreateMessageRequestSchema, using the provided CreateMessageRequest1

func (*CreateMessageRequestSchema) UnmarshalJSON

func (t *CreateMessageRequestSchema) UnmarshalJSON(b []byte) error

type CreateMessageRequestTo1

type CreateMessageRequestTo1 = []RecipientSchema

CreateMessageRequestTo1 The recipients of the message.

type CreateMessageRequest_Bcc

type CreateMessageRequest_Bcc struct {
	// contains filtered or unexported fields
}

CreateMessageRequest_Bcc defines model for CreateMessageRequest.Bcc.

func (CreateMessageRequest_Bcc) AsCreateMessageRequestBcc1

func (t CreateMessageRequest_Bcc) AsCreateMessageRequestBcc1() (CreateMessageRequestBcc1, error)

AsCreateMessageRequestBcc1 returns the union data inside the CreateMessageRequest_Bcc as a CreateMessageRequestBcc1

func (CreateMessageRequest_Bcc) AsRecipientSchema

func (t CreateMessageRequest_Bcc) AsRecipientSchema() (RecipientSchema, error)

AsRecipientSchema returns the union data inside the CreateMessageRequest_Bcc as a RecipientSchema

func (*CreateMessageRequest_Bcc) FromCreateMessageRequestBcc1

func (t *CreateMessageRequest_Bcc) FromCreateMessageRequestBcc1(v CreateMessageRequestBcc1) error

FromCreateMessageRequestBcc1 overwrites any union data inside the CreateMessageRequest_Bcc as the provided CreateMessageRequestBcc1

func (*CreateMessageRequest_Bcc) FromRecipientSchema

func (t *CreateMessageRequest_Bcc) FromRecipientSchema(v RecipientSchema) error

FromRecipientSchema overwrites any union data inside the CreateMessageRequest_Bcc as the provided RecipientSchema

func (CreateMessageRequest_Bcc) MarshalJSON

func (t CreateMessageRequest_Bcc) MarshalJSON() ([]byte, error)

func (*CreateMessageRequest_Bcc) MergeCreateMessageRequestBcc1

func (t *CreateMessageRequest_Bcc) MergeCreateMessageRequestBcc1(v CreateMessageRequestBcc1) error

MergeCreateMessageRequestBcc1 performs a merge with any union data inside the CreateMessageRequest_Bcc, using the provided CreateMessageRequestBcc1

func (*CreateMessageRequest_Bcc) MergeRecipientSchema

func (t *CreateMessageRequest_Bcc) MergeRecipientSchema(v RecipientSchema) error

MergeRecipientSchema performs a merge with any union data inside the CreateMessageRequest_Bcc, using the provided RecipientSchema

func (*CreateMessageRequest_Bcc) UnmarshalJSON

func (t *CreateMessageRequest_Bcc) UnmarshalJSON(b []byte) error

type CreateMessageRequest_Cc

type CreateMessageRequest_Cc struct {
	// contains filtered or unexported fields
}

CreateMessageRequest_Cc defines model for CreateMessageRequest.Cc.

func (CreateMessageRequest_Cc) AsCreateMessageRequestCc1

func (t CreateMessageRequest_Cc) AsCreateMessageRequestCc1() (CreateMessageRequestCc1, error)

AsCreateMessageRequestCc1 returns the union data inside the CreateMessageRequest_Cc as a CreateMessageRequestCc1

func (CreateMessageRequest_Cc) AsRecipientSchema

func (t CreateMessageRequest_Cc) AsRecipientSchema() (RecipientSchema, error)

AsRecipientSchema returns the union data inside the CreateMessageRequest_Cc as a RecipientSchema

func (*CreateMessageRequest_Cc) FromCreateMessageRequestCc1

func (t *CreateMessageRequest_Cc) FromCreateMessageRequestCc1(v CreateMessageRequestCc1) error

FromCreateMessageRequestCc1 overwrites any union data inside the CreateMessageRequest_Cc as the provided CreateMessageRequestCc1

func (*CreateMessageRequest_Cc) FromRecipientSchema

func (t *CreateMessageRequest_Cc) FromRecipientSchema(v RecipientSchema) error

FromRecipientSchema overwrites any union data inside the CreateMessageRequest_Cc as the provided RecipientSchema

func (CreateMessageRequest_Cc) MarshalJSON

func (t CreateMessageRequest_Cc) MarshalJSON() ([]byte, error)

func (*CreateMessageRequest_Cc) MergeCreateMessageRequestCc1

func (t *CreateMessageRequest_Cc) MergeCreateMessageRequestCc1(v CreateMessageRequestCc1) error

MergeCreateMessageRequestCc1 performs a merge with any union data inside the CreateMessageRequest_Cc, using the provided CreateMessageRequestCc1

func (*CreateMessageRequest_Cc) MergeRecipientSchema

func (t *CreateMessageRequest_Cc) MergeRecipientSchema(v RecipientSchema) error

MergeRecipientSchema performs a merge with any union data inside the CreateMessageRequest_Cc, using the provided RecipientSchema

func (*CreateMessageRequest_Cc) UnmarshalJSON

func (t *CreateMessageRequest_Cc) UnmarshalJSON(b []byte) error

type CreateMessageRequest_To

type CreateMessageRequest_To struct {
	// contains filtered or unexported fields
}

CreateMessageRequest_To defines model for CreateMessageRequest.To.

func (CreateMessageRequest_To) AsCreateMessageRequestTo1

func (t CreateMessageRequest_To) AsCreateMessageRequestTo1() (CreateMessageRequestTo1, error)

AsCreateMessageRequestTo1 returns the union data inside the CreateMessageRequest_To as a CreateMessageRequestTo1

func (CreateMessageRequest_To) AsRecipientSchema

func (t CreateMessageRequest_To) AsRecipientSchema() (RecipientSchema, error)

AsRecipientSchema returns the union data inside the CreateMessageRequest_To as a RecipientSchema

func (*CreateMessageRequest_To) FromCreateMessageRequestTo1

func (t *CreateMessageRequest_To) FromCreateMessageRequestTo1(v CreateMessageRequestTo1) error

FromCreateMessageRequestTo1 overwrites any union data inside the CreateMessageRequest_To as the provided CreateMessageRequestTo1

func (*CreateMessageRequest_To) FromRecipientSchema

func (t *CreateMessageRequest_To) FromRecipientSchema(v RecipientSchema) error

FromRecipientSchema overwrites any union data inside the CreateMessageRequest_To as the provided RecipientSchema

func (CreateMessageRequest_To) MarshalJSON

func (t CreateMessageRequest_To) MarshalJSON() ([]byte, error)

func (*CreateMessageRequest_To) MergeCreateMessageRequestTo1

func (t *CreateMessageRequest_To) MergeCreateMessageRequestTo1(v CreateMessageRequestTo1) error

MergeCreateMessageRequestTo1 performs a merge with any union data inside the CreateMessageRequest_To, using the provided CreateMessageRequestTo1

func (*CreateMessageRequest_To) MergeRecipientSchema

func (t *CreateMessageRequest_To) MergeRecipientSchema(v RecipientSchema) error

MergeRecipientSchema performs a merge with any union data inside the CreateMessageRequest_To, using the provided RecipientSchema

func (*CreateMessageRequest_To) UnmarshalJSON

func (t *CreateMessageRequest_To) UnmarshalJSON(b []byte) error

type CreateMessageResponse

type CreateMessageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *MessageSchema
	JSON400      *ErrorSchema
	JSON401      *ErrorSchema
	JSON403      *ErrorSchema
	JSON422      *ErrorSchema
}

func ParseCreateMessageResponse

func ParseCreateMessageResponse(rsp *http.Response) (*CreateMessageResponse, error)

ParseCreateMessageResponse parses an HTTP response from a CreateMessageWithResponse call

func (CreateMessageResponse) Status

func (r CreateMessageResponse) Status() string

Status returns HTTPResponse.Status

func (CreateMessageResponse) StatusCode

func (r CreateMessageResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateNewsItemJSONRequestBody

type CreateNewsItemJSONRequestBody = NewsItemRequestSchema

CreateNewsItemJSONRequestBody defines body for CreateNewsItem for application/json ContentType.

type CreateNewsItemParams

type CreateNewsItemParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

CreateNewsItemParams defines parameters for CreateNewsItem.

type CreateNewsItemResponse

type CreateNewsItemResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *NewsItemSchema
	JSON401      *ErrorSchema
}

func ParseCreateNewsItemResponse

func ParseCreateNewsItemResponse(rsp *http.Response) (*CreateNewsItemResponse, error)

ParseCreateNewsItemResponse parses an HTTP response from a CreateNewsItemWithResponse call

func (CreateNewsItemResponse) Status

func (r CreateNewsItemResponse) Status() string

Status returns HTTPResponse.Status

func (CreateNewsItemResponse) StatusCode

func (r CreateNewsItemResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateNoteJSONBody

type CreateNoteJSONBody struct {
	// AdminId The unique identifier of a given admin.
	AdminId *string `json:"admin_id,omitempty"`

	// Body The text of the note.
	Body string `json:"body"`
}

CreateNoteJSONBody defines parameters for CreateNote.

type CreateNoteJSONRequestBody

type CreateNoteJSONRequestBody CreateNoteJSONBody

CreateNoteJSONRequestBody defines body for CreateNote for application/json ContentType.

type CreateNoteParams

type CreateNoteParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

CreateNoteParams defines parameters for CreateNote.

type CreateNoteResponse

type CreateNoteResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *NoteSchema
	JSON404      *ErrorSchema
}

func ParseCreateNoteResponse

func ParseCreateNoteResponse(rsp *http.Response) (*CreateNoteResponse, error)

ParseCreateNoteResponse parses an HTTP response from a CreateNoteWithResponse call

func (CreateNoteResponse) Status

func (r CreateNoteResponse) Status() string

Status returns HTTPResponse.Status

func (CreateNoteResponse) StatusCode

func (r CreateNoteResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateOrUpdateCompanyJSONRequestBody

type CreateOrUpdateCompanyJSONRequestBody = CreateOrUpdateCompanyRequestSchema

CreateOrUpdateCompanyJSONRequestBody defines body for CreateOrUpdateCompany for application/json ContentType.

type CreateOrUpdateCompanyParams

type CreateOrUpdateCompanyParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

CreateOrUpdateCompanyParams defines parameters for CreateOrUpdateCompany.

type CreateOrUpdateCompanyRequestSchema

type CreateOrUpdateCompanyRequestSchema struct {
	// CompanyId The company id you have defined for the company. Can't be updated
	CompanyId *string `json:"company_id,omitempty"`

	// CustomAttributes A hash of key/value pairs containing any other data about the company you want Intercom to store.
	CustomAttributes *map[string]string `json:"custom_attributes,omitempty"`

	// Industry The industry that this company operates in.
	Industry *string `json:"industry,omitempty"`

	// MonthlySpend How much revenue the company generates for your business. Note that this will truncate floats. i.e. it only allow for whole integers, 155.98 will be truncated to 155. Note that this has an upper limit of 2**31-1 or 2147483647..
	MonthlySpend *int `json:"monthly_spend,omitempty"`

	// Name The name of the Company
	Name *string `json:"name,omitempty"`

	// Plan The name of the plan you have associated with the company.
	Plan *string `json:"plan,omitempty"`

	// RemoteCreatedAt The time the company was created by you.
	RemoteCreatedAt *int `json:"remote_created_at,omitempty"`

	// Size The number of employees in this company.
	Size *int `json:"size,omitempty"`

	// Website The URL for this company's website. Please note that the value specified here is not validated. Accepts any string.
	Website *string `json:"website,omitempty"`
}

CreateOrUpdateCompanyRequestSchema You can create or update a Company

type CreateOrUpdateCompanyResponse

type CreateOrUpdateCompanyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CompanySchema
	JSON400      *ErrorSchema
	JSON401      *ErrorSchema
}

func ParseCreateOrUpdateCompanyResponse

func ParseCreateOrUpdateCompanyResponse(rsp *http.Response) (*CreateOrUpdateCompanyResponse, error)

ParseCreateOrUpdateCompanyResponse parses an HTTP response from a CreateOrUpdateCompanyWithResponse call

func (CreateOrUpdateCompanyResponse) Status

Status returns HTTPResponse.Status

func (CreateOrUpdateCompanyResponse) StatusCode

func (r CreateOrUpdateCompanyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateOrUpdateCustomObjectInstanceRequestSchema

type CreateOrUpdateCustomObjectInstanceRequestSchema struct {
	// CustomAttributes The custom attributes which are set for the Custom Object instance.
	CustomAttributes *map[string]string `json:"custom_attributes,omitempty"`

	// ExternalCreatedAt The time when the Custom Object instance was created in the external system it originated from.
	ExternalCreatedAt *int `json:"external_created_at,omitempty"`

	// ExternalId A unique identifier for the Custom Object instance in the external system it originated from.
	ExternalId *string `json:"external_id,omitempty"`

	// ExternalUpdatedAt The time when the Custom Object instance was last updated in the external system it originated from.
	ExternalUpdatedAt *int `json:"external_updated_at,omitempty"`
}

CreateOrUpdateCustomObjectInstanceRequestSchema Payload to create or update a Custom Object instance

type CreateOrUpdateTagRequestSchema

type CreateOrUpdateTagRequestSchema struct {
	// Id The id of tag to updates.
	Id *string `json:"id,omitempty"`

	// Name The name of the tag, which will be created if not found, or the new name for the tag if this is an update request. Names are case insensitive.
	Name string `json:"name"`
}

CreateOrUpdateTagRequestSchema You can create or update an existing tag.

type CreatePhoneSwitchJSONRequestBody

type CreatePhoneSwitchJSONRequestBody = CreatePhoneSwitchRequestSchema

CreatePhoneSwitchJSONRequestBody defines body for CreatePhoneSwitch for application/json ContentType.

type CreatePhoneSwitchParams

type CreatePhoneSwitchParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

CreatePhoneSwitchParams defines parameters for CreatePhoneSwitch.

type CreatePhoneSwitchRequestSchema

type CreatePhoneSwitchRequestSchema struct {
	CustomAttributes *CustomAttributesSchema `json:"custom_attributes,omitempty"`

	// Phone Phone number in E.164 format, that will receive the SMS to continue the conversation in the Messenger.
	Phone string `json:"phone"`
}

CreatePhoneSwitchRequestSchema You can create an phone switch

type CreatePhoneSwitchResponse

type CreatePhoneSwitchResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PhoneSwitchSchema
	JSON401      *ErrorSchema
}

func ParseCreatePhoneSwitchResponse

func ParseCreatePhoneSwitchResponse(rsp *http.Response) (*CreatePhoneSwitchResponse, error)

ParseCreatePhoneSwitchResponse parses an HTTP response from a CreatePhoneSwitchWithResponse call

func (CreatePhoneSwitchResponse) Status

func (r CreatePhoneSwitchResponse) Status() string

Status returns HTTPResponse.Status

func (CreatePhoneSwitchResponse) StatusCode

func (r CreatePhoneSwitchResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateTagJSONBody

type CreateTagJSONBody struct {
	// contains filtered or unexported fields
}

CreateTagJSONBody defines parameters for CreateTag.

type CreateTagJSONRequestBody

type CreateTagJSONRequestBody CreateTagJSONBody

CreateTagJSONRequestBody defines body for CreateTag for application/json ContentType.

type CreateTagParams

type CreateTagParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

CreateTagParams defines parameters for CreateTag.

type CreateTagResponse

type CreateTagResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TagBasicSchema
	JSON400      *ErrorSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseCreateTagResponse

func ParseCreateTagResponse(rsp *http.Response) (*CreateTagResponse, error)

ParseCreateTagResponse parses an HTTP response from a CreateTagWithResponse call

func (CreateTagResponse) Status

func (r CreateTagResponse) Status() string

Status returns HTTPResponse.Status

func (CreateTagResponse) StatusCode

func (r CreateTagResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateTicketJSONBody

type CreateTicketJSONBody = CreateTicketRequestSchema

CreateTicketJSONBody defines parameters for CreateTicket.

type CreateTicketJSONRequestBody

type CreateTicketJSONRequestBody = CreateTicketJSONBody

CreateTicketJSONRequestBody defines body for CreateTicket for application/json ContentType.

type CreateTicketParams

type CreateTicketParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

CreateTicketParams defines parameters for CreateTicket.

type CreateTicketReplyWithCommentRequest

type CreateTicketReplyWithCommentRequest struct {
	// contains filtered or unexported fields
}

CreateTicketReplyWithCommentRequest defines model for create_ticket_reply_with_comment_request.

func (CreateTicketReplyWithCommentRequest) AsAdminReplyTicketRequestSchema

func (t CreateTicketReplyWithCommentRequest) AsAdminReplyTicketRequestSchema() (AdminReplyTicketRequestSchema, error)

AsAdminReplyTicketRequestSchema returns the union data inside the CreateTicketReplyWithCommentRequest as a AdminReplyTicketRequestSchema

func (CreateTicketReplyWithCommentRequest) AsContactReplyTicketRequest

func (t CreateTicketReplyWithCommentRequest) AsContactReplyTicketRequest() (ContactReplyTicketRequest, error)

AsContactReplyTicketRequest returns the union data inside the CreateTicketReplyWithCommentRequest as a ContactReplyTicketRequest

func (*CreateTicketReplyWithCommentRequest) FromAdminReplyTicketRequestSchema

func (t *CreateTicketReplyWithCommentRequest) FromAdminReplyTicketRequestSchema(v AdminReplyTicketRequestSchema) error

FromAdminReplyTicketRequestSchema overwrites any union data inside the CreateTicketReplyWithCommentRequest as the provided AdminReplyTicketRequestSchema

func (*CreateTicketReplyWithCommentRequest) FromContactReplyTicketRequest

func (t *CreateTicketReplyWithCommentRequest) FromContactReplyTicketRequest(v ContactReplyTicketRequest) error

FromContactReplyTicketRequest overwrites any union data inside the CreateTicketReplyWithCommentRequest as the provided ContactReplyTicketRequest

func (CreateTicketReplyWithCommentRequest) MarshalJSON

func (t CreateTicketReplyWithCommentRequest) MarshalJSON() ([]byte, error)

func (*CreateTicketReplyWithCommentRequest) MergeAdminReplyTicketRequestSchema

func (t *CreateTicketReplyWithCommentRequest) MergeAdminReplyTicketRequestSchema(v AdminReplyTicketRequestSchema) error

MergeAdminReplyTicketRequestSchema performs a merge with any union data inside the CreateTicketReplyWithCommentRequest, using the provided AdminReplyTicketRequestSchema

func (*CreateTicketReplyWithCommentRequest) MergeContactReplyTicketRequest

func (t *CreateTicketReplyWithCommentRequest) MergeContactReplyTicketRequest(v ContactReplyTicketRequest) error

MergeContactReplyTicketRequest performs a merge with any union data inside the CreateTicketReplyWithCommentRequest, using the provided ContactReplyTicketRequest

func (*CreateTicketReplyWithCommentRequest) UnmarshalJSON

func (t *CreateTicketReplyWithCommentRequest) UnmarshalJSON(b []byte) error

type CreateTicketRequestContacts0

type CreateTicketRequestContacts0 struct {
	// Id The identifier for the contact as given by Intercom.
	Id string `json:"id"`
}

CreateTicketRequestContacts0 defines model for .

type CreateTicketRequestContacts1

type CreateTicketRequestContacts1 struct {
	// ExternalId The external_id you have defined for the contact who is being added as a participant.
	ExternalId string `json:"external_id"`
}

CreateTicketRequestContacts1 defines model for .

type CreateTicketRequestContacts2

type CreateTicketRequestContacts2 struct {
	// Email The email you have defined for the contact who is being added as a participant. If a contact with this email does not exist, one will be created.
	Email string `json:"email"`
}

CreateTicketRequestContacts2 defines model for .

type CreateTicketRequestSchema

type CreateTicketRequestSchema struct {
	Assignment *struct {
		// AdminAssigneeId The ID of the admin to which the ticket is assigned. If not provided, the ticket will be unassigned.
		AdminAssigneeId *string `json:"admin_assignee_id,omitempty"`

		// TeamAssigneeId The ID of the team to which the ticket is assigned. If not provided, the ticket will be unassigned.
		TeamAssigneeId *string `json:"team_assignee_id,omitempty"`
	} `json:"assignment,omitempty"`

	// CompanyId The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom
	CompanyId *string `json:"company_id,omitempty"`

	// Contacts The list of contacts (users or leads) affected by this ticket. Currently only one is allowed
	Contacts []CreateTicketRequest_Contacts_Item `json:"contacts"`

	// ConversationToLinkId The ID of the conversation you want to link to the ticket. Here are the valid ways of linking two tickets:
	//  - conversation | back-office ticket
	//  - customer tickets | non-shared back-office ticket
	//  - conversation | tracker ticket
	//  - customer ticket | tracker ticket
	ConversationToLinkId *string `json:"conversation_to_link_id,omitempty"`

	// CreatedAt The time the ticket was created. If not provided, the current time will be used.
	CreatedAt        *int                                 `json:"created_at,omitempty"`
	TicketAttributes *TicketRequestCustomAttributesSchema `json:"ticket_attributes,omitempty"`

	// TicketTypeId The ID of the type of ticket you want to create
	TicketTypeId string `json:"ticket_type_id"`
}

CreateTicketRequestSchema You can create a Ticket

type CreateTicketRequest_Contacts_Item

type CreateTicketRequest_Contacts_Item struct {
	// contains filtered or unexported fields
}

CreateTicketRequest_Contacts_Item defines model for create_ticket_request.contacts.Item.

func (CreateTicketRequest_Contacts_Item) AsCreateTicketRequestContacts0

func (t CreateTicketRequest_Contacts_Item) AsCreateTicketRequestContacts0() (CreateTicketRequestContacts0, error)

AsCreateTicketRequestContacts0 returns the union data inside the CreateTicketRequest_Contacts_Item as a CreateTicketRequestContacts0

func (CreateTicketRequest_Contacts_Item) AsCreateTicketRequestContacts1

func (t CreateTicketRequest_Contacts_Item) AsCreateTicketRequestContacts1() (CreateTicketRequestContacts1, error)

AsCreateTicketRequestContacts1 returns the union data inside the CreateTicketRequest_Contacts_Item as a CreateTicketRequestContacts1

func (CreateTicketRequest_Contacts_Item) AsCreateTicketRequestContacts2

func (t CreateTicketRequest_Contacts_Item) AsCreateTicketRequestContacts2() (CreateTicketRequestContacts2, error)

AsCreateTicketRequestContacts2 returns the union data inside the CreateTicketRequest_Contacts_Item as a CreateTicketRequestContacts2

func (*CreateTicketRequest_Contacts_Item) FromCreateTicketRequestContacts0

func (t *CreateTicketRequest_Contacts_Item) FromCreateTicketRequestContacts0(v CreateTicketRequestContacts0) error

FromCreateTicketRequestContacts0 overwrites any union data inside the CreateTicketRequest_Contacts_Item as the provided CreateTicketRequestContacts0

func (*CreateTicketRequest_Contacts_Item) FromCreateTicketRequestContacts1

func (t *CreateTicketRequest_Contacts_Item) FromCreateTicketRequestContacts1(v CreateTicketRequestContacts1) error

FromCreateTicketRequestContacts1 overwrites any union data inside the CreateTicketRequest_Contacts_Item as the provided CreateTicketRequestContacts1

func (*CreateTicketRequest_Contacts_Item) FromCreateTicketRequestContacts2

func (t *CreateTicketRequest_Contacts_Item) FromCreateTicketRequestContacts2(v CreateTicketRequestContacts2) error

FromCreateTicketRequestContacts2 overwrites any union data inside the CreateTicketRequest_Contacts_Item as the provided CreateTicketRequestContacts2

func (CreateTicketRequest_Contacts_Item) MarshalJSON

func (t CreateTicketRequest_Contacts_Item) MarshalJSON() ([]byte, error)

func (*CreateTicketRequest_Contacts_Item) MergeCreateTicketRequestContacts0

func (t *CreateTicketRequest_Contacts_Item) MergeCreateTicketRequestContacts0(v CreateTicketRequestContacts0) error

MergeCreateTicketRequestContacts0 performs a merge with any union data inside the CreateTicketRequest_Contacts_Item, using the provided CreateTicketRequestContacts0

func (*CreateTicketRequest_Contacts_Item) MergeCreateTicketRequestContacts1

func (t *CreateTicketRequest_Contacts_Item) MergeCreateTicketRequestContacts1(v CreateTicketRequestContacts1) error

MergeCreateTicketRequestContacts1 performs a merge with any union data inside the CreateTicketRequest_Contacts_Item, using the provided CreateTicketRequestContacts1

func (*CreateTicketRequest_Contacts_Item) MergeCreateTicketRequestContacts2

func (t *CreateTicketRequest_Contacts_Item) MergeCreateTicketRequestContacts2(v CreateTicketRequestContacts2) error

MergeCreateTicketRequestContacts2 performs a merge with any union data inside the CreateTicketRequest_Contacts_Item, using the provided CreateTicketRequestContacts2

func (*CreateTicketRequest_Contacts_Item) UnmarshalJSON

func (t *CreateTicketRequest_Contacts_Item) UnmarshalJSON(b []byte) error

type CreateTicketResponse

type CreateTicketResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TicketSchema
	JSON401      *ErrorSchema
}

func ParseCreateTicketResponse

func ParseCreateTicketResponse(rsp *http.Response) (*CreateTicketResponse, error)

ParseCreateTicketResponse parses an HTTP response from a CreateTicketWithResponse call

func (CreateTicketResponse) Status

func (r CreateTicketResponse) Status() string

Status returns HTTPResponse.Status

func (CreateTicketResponse) StatusCode

func (r CreateTicketResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateTicketTypeAttributeJSONRequestBody

type CreateTicketTypeAttributeJSONRequestBody = CreateTicketTypeAttributeRequestSchema

CreateTicketTypeAttributeJSONRequestBody defines body for CreateTicketTypeAttribute for application/json ContentType.

type CreateTicketTypeAttributeParams

type CreateTicketTypeAttributeParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

CreateTicketTypeAttributeParams defines parameters for CreateTicketTypeAttribute.

type CreateTicketTypeAttributeRequestDataType

type CreateTicketTypeAttributeRequestDataType string

CreateTicketTypeAttributeRequestDataType The data type of the attribute

const (
	CreateTicketTypeAttributeRequestDataTypeBoolean  CreateTicketTypeAttributeRequestDataType = "boolean"
	CreateTicketTypeAttributeRequestDataTypeDatetime CreateTicketTypeAttributeRequestDataType = "datetime"
	CreateTicketTypeAttributeRequestDataTypeDecimal  CreateTicketTypeAttributeRequestDataType = "decimal"
	CreateTicketTypeAttributeRequestDataTypeFiles    CreateTicketTypeAttributeRequestDataType = "files"
	CreateTicketTypeAttributeRequestDataTypeInteger  CreateTicketTypeAttributeRequestDataType = "integer"
	CreateTicketTypeAttributeRequestDataTypeList     CreateTicketTypeAttributeRequestDataType = "list"
	CreateTicketTypeAttributeRequestDataTypeString   CreateTicketTypeAttributeRequestDataType = "string"
)

Defines values for CreateTicketTypeAttributeRequestDataType.

func (CreateTicketTypeAttributeRequestDataType) Valid

Valid indicates whether the value is a known member of the CreateTicketTypeAttributeRequestDataType enum.

type CreateTicketTypeAttributeRequestSchema

type CreateTicketTypeAttributeRequestSchema struct {
	// AllowMultipleValues Whether the attribute allows multiple files to be attached to it (only applicable to file attributes)
	AllowMultipleValues *bool `json:"allow_multiple_values,omitempty"`

	// DataType The data type of the attribute
	DataType CreateTicketTypeAttributeRequestDataType `json:"data_type"`

	// Description The description of the attribute presented to the teammate or contact
	Description string `json:"description"`

	// ListItems A comma delimited list of items for the attribute value (only applicable to list attributes)
	ListItems *string `json:"list_items,omitempty"`

	// Multiline Whether the attribute allows multiple lines of text (only applicable to string attributes)
	Multiline *bool `json:"multiline,omitempty"`

	// Name The name of the ticket type attribute
	Name string `json:"name"`

	// RequiredToCreate Whether the attribute is required to be filled in when teammates are creating the ticket in Inbox.
	RequiredToCreate *bool `json:"required_to_create,omitempty"`

	// RequiredToCreateForContacts Whether the attribute is required to be filled in when contacts are creating the ticket in Messenger.
	RequiredToCreateForContacts *bool `json:"required_to_create_for_contacts,omitempty"`

	// VisibleOnCreate Whether the attribute is visible to teammates when creating a ticket in Inbox.
	VisibleOnCreate *bool `json:"visible_on_create,omitempty"`

	// VisibleToContacts Whether the attribute is visible to contacts when creating a ticket in Messenger.
	VisibleToContacts *bool `json:"visible_to_contacts,omitempty"`
}

CreateTicketTypeAttributeRequestSchema You can create a Ticket Type Attribute

type CreateTicketTypeAttributeResponse

type CreateTicketTypeAttributeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TicketTypeAttributeSchema
	JSON401      *ErrorSchema
}

func ParseCreateTicketTypeAttributeResponse

func ParseCreateTicketTypeAttributeResponse(rsp *http.Response) (*CreateTicketTypeAttributeResponse, error)

ParseCreateTicketTypeAttributeResponse parses an HTTP response from a CreateTicketTypeAttributeWithResponse call

func (CreateTicketTypeAttributeResponse) Status

Status returns HTTPResponse.Status

func (CreateTicketTypeAttributeResponse) StatusCode

func (r CreateTicketTypeAttributeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateTicketTypeJSONRequestBody

type CreateTicketTypeJSONRequestBody = CreateTicketTypeRequestSchema

CreateTicketTypeJSONRequestBody defines body for CreateTicketType for application/json ContentType.

type CreateTicketTypeParams

type CreateTicketTypeParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

CreateTicketTypeParams defines parameters for CreateTicketType.

type CreateTicketTypeRequestCategory

type CreateTicketTypeRequestCategory string

CreateTicketTypeRequestCategory Category of the Ticket Type.

const (
	CreateTicketTypeRequestCategoryBackOffice CreateTicketTypeRequestCategory = "Back-office"
	CreateTicketTypeRequestCategoryCustomer   CreateTicketTypeRequestCategory = "Customer"
	CreateTicketTypeRequestCategoryTracker    CreateTicketTypeRequestCategory = "Tracker"
)

Defines values for CreateTicketTypeRequestCategory.

func (CreateTicketTypeRequestCategory) Valid

Valid indicates whether the value is a known member of the CreateTicketTypeRequestCategory enum.

type CreateTicketTypeRequestSchema

type CreateTicketTypeRequestSchema struct {
	// Category Category of the Ticket Type.
	Category *CreateTicketTypeRequestCategory `json:"category,omitempty"`

	// Description The description of the ticket type.
	Description *string `json:"description,omitempty"`

	// Icon The icon of the ticket type.
	Icon *string `json:"icon,omitempty"`

	// IsInternal Whether the tickets associated with this ticket type are intended for internal use only or will be shared with customers. This is currently a limited attribute.
	IsInternal *bool `json:"is_internal,omitempty"`

	// Name The name of the ticket type.
	Name string `json:"name"`
}

CreateTicketTypeRequestSchema The request payload for creating a ticket type.

You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)

type CreateTicketTypeResponse

type CreateTicketTypeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TicketTypeSchema
	JSON401      *ErrorSchema
}

func ParseCreateTicketTypeResponse

func ParseCreateTicketTypeResponse(rsp *http.Response) (*CreateTicketTypeResponse, error)

ParseCreateTicketTypeResponse parses an HTTP response from a CreateTicketTypeWithResponse call

func (CreateTicketTypeResponse) Status

func (r CreateTicketTypeResponse) Status() string

Status returns HTTPResponse.Status

func (CreateTicketTypeResponse) StatusCode

func (r CreateTicketTypeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CursorPagesSchema

type CursorPagesSchema struct {
	Next *StartingAfterPagingSchema `json:"next,omitempty"`

	// Page The current page
	Page *int `json:"page,omitempty"`

	// PerPage Number of results per page
	PerPage *int `json:"per_page,omitempty"`

	// TotalPages Total number of pages
	TotalPages *int `json:"total_pages,omitempty"`

	// Type the type of object `pages`.
	Type *CursorPagesType `json:"type,omitempty"`
}

CursorPagesSchema Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed.

type CursorPagesType

type CursorPagesType string

CursorPagesType the type of object `pages`.

const (
	CursorPagesTypePages CursorPagesType = "pages"
)

Defines values for CursorPagesType.

func (CursorPagesType) Valid

func (e CursorPagesType) Valid() bool

Valid indicates whether the value is a known member of the CursorPagesType enum.

type CustomActionFinishedActionResult

type CustomActionFinishedActionResult string

CustomActionFinishedActionResult Status of the action

const (
	CustomActionFinishedActionResultFailed  CustomActionFinishedActionResult = "failed"
	CustomActionFinishedActionResultSuccess CustomActionFinishedActionResult = "success"
)

Defines values for CustomActionFinishedActionResult.

func (CustomActionFinishedActionResult) Valid

Valid indicates whether the value is a known member of the CustomActionFinishedActionResult enum.

type CustomActionFinishedSchema

type CustomActionFinishedSchema struct {
	Action *struct {
		// Name Name of the action
		Name *string `json:"name,omitempty"`

		// Result Status of the action
		Result *CustomActionFinishedActionResult `json:"result,omitempty"`
	} `json:"action,omitempty"`
}

CustomActionFinishedSchema Contains details about final status of the completed action for conversation part type <code>custom_action_finished</code>.

type CustomActionStartedSchema

type CustomActionStartedSchema struct {
	Action *struct {
		// Name Name of the action
		Name *string `json:"name,omitempty"`
	} `json:"action,omitempty"`
}

CustomActionStartedSchema Contains details about name of the action that was initiated for conversation part type <code>custom_action_started</code>.

type CustomAttributes0

type CustomAttributes0 = string

CustomAttributes0 defines model for .

type CustomAttributes1

type CustomAttributes1 = int

CustomAttributes1 defines model for .

type CustomAttributesSchema

type CustomAttributesSchema map[string]CustomAttributes_AdditionalProperties

CustomAttributesSchema An object containing the different custom attributes associated to the conversation as key-value pairs. For relationship attributes the value will be a list of custom object instance models. System-defined attributes such as "CX Score rating" and "CX Score explanation" may also be included.

type CustomAttributes_AdditionalProperties

type CustomAttributes_AdditionalProperties struct {
	// contains filtered or unexported fields
}

CustomAttributes_AdditionalProperties defines model for custom_attributes.AdditionalProperties.

func (CustomAttributes_AdditionalProperties) AsCustomAttributes0

AsCustomAttributes0 returns the union data inside the CustomAttributes_AdditionalProperties as a CustomAttributes0

func (CustomAttributes_AdditionalProperties) AsCustomAttributes1

AsCustomAttributes1 returns the union data inside the CustomAttributes_AdditionalProperties as a CustomAttributes1

func (CustomAttributes_AdditionalProperties) AsCustomObjectInstanceListSchema

func (t CustomAttributes_AdditionalProperties) AsCustomObjectInstanceListSchema() (CustomObjectInstanceListSchema, error)

AsCustomObjectInstanceListSchema returns the union data inside the CustomAttributes_AdditionalProperties as a CustomObjectInstanceListSchema

func (CustomAttributes_AdditionalProperties) AsDatetime

AsDatetime returns the union data inside the CustomAttributes_AdditionalProperties as a Datetime

func (*CustomAttributes_AdditionalProperties) FromCustomAttributes0

FromCustomAttributes0 overwrites any union data inside the CustomAttributes_AdditionalProperties as the provided CustomAttributes0

func (*CustomAttributes_AdditionalProperties) FromCustomAttributes1

FromCustomAttributes1 overwrites any union data inside the CustomAttributes_AdditionalProperties as the provided CustomAttributes1

func (*CustomAttributes_AdditionalProperties) FromCustomObjectInstanceListSchema

func (t *CustomAttributes_AdditionalProperties) FromCustomObjectInstanceListSchema(v CustomObjectInstanceListSchema) error

FromCustomObjectInstanceListSchema overwrites any union data inside the CustomAttributes_AdditionalProperties as the provided CustomObjectInstanceListSchema

func (*CustomAttributes_AdditionalProperties) FromDatetime

FromDatetime overwrites any union data inside the CustomAttributes_AdditionalProperties as the provided Datetime

func (CustomAttributes_AdditionalProperties) MarshalJSON

func (t CustomAttributes_AdditionalProperties) MarshalJSON() ([]byte, error)

func (*CustomAttributes_AdditionalProperties) MergeCustomAttributes0

func (t *CustomAttributes_AdditionalProperties) MergeCustomAttributes0(v CustomAttributes0) error

MergeCustomAttributes0 performs a merge with any union data inside the CustomAttributes_AdditionalProperties, using the provided CustomAttributes0

func (*CustomAttributes_AdditionalProperties) MergeCustomAttributes1

func (t *CustomAttributes_AdditionalProperties) MergeCustomAttributes1(v CustomAttributes1) error

MergeCustomAttributes1 performs a merge with any union data inside the CustomAttributes_AdditionalProperties, using the provided CustomAttributes1

func (*CustomAttributes_AdditionalProperties) MergeCustomObjectInstanceListSchema

func (t *CustomAttributes_AdditionalProperties) MergeCustomObjectInstanceListSchema(v CustomObjectInstanceListSchema) error

MergeCustomObjectInstanceListSchema performs a merge with any union data inside the CustomAttributes_AdditionalProperties, using the provided CustomObjectInstanceListSchema

func (*CustomAttributes_AdditionalProperties) MergeDatetime

MergeDatetime performs a merge with any union data inside the CustomAttributes_AdditionalProperties, using the provided Datetime

func (*CustomAttributes_AdditionalProperties) UnmarshalJSON

func (t *CustomAttributes_AdditionalProperties) UnmarshalJSON(b []byte) error

type CustomObjectInstanceDeletedSchema

type CustomObjectInstanceDeletedSchema struct {
	// Deleted Whether the Custom Object instance is deleted or not.
	Deleted *bool `json:"deleted,omitempty"`

	// Id The Intercom defined id representing the Custom Object instance.
	Id *string `json:"id,omitempty"`

	// Object The unique identifier of the Custom Object type that defines the structure of the Custom Object instance.
	Object *string `json:"object,omitempty"`
}

CustomObjectInstanceDeletedSchema deleted custom object instance object

type CustomObjectInstanceListSchema

type CustomObjectInstanceListSchema struct {
	// Instances The list of associated custom object instances for a given reference attribute on the parent object.
	Instances *[]*CustomObjectInstanceSchema `json:"instances,omitempty"`
	Type      *string                        `json:"type,omitempty"`
}

CustomObjectInstanceListSchema The list of associated custom object instances for a given reference attribute on the parent object.

type CustomObjectInstanceSchema

type CustomObjectInstanceSchema struct {
	// CreatedAt The time the attribute was created as a UTC Unix timestamp
	CreatedAt *int `json:"created_at,omitempty"`

	// CustomAttributes The custom attributes you have set on the custom object instance.
	CustomAttributes *map[string]string `json:"custom_attributes,omitempty"`

	// ExternalCreatedAt The time when the Custom Object instance was created in the external system it originated from.
	ExternalCreatedAt *int `json:"external_created_at,omitempty"`

	// ExternalId The id you have defined for the custom object instance.
	ExternalId *string `json:"external_id,omitempty"`

	// ExternalUpdatedAt The time when the Custom Object instance was last updated in the external system it originated from.
	ExternalUpdatedAt *int `json:"external_updated_at,omitempty"`

	// Id The Intercom defined id representing the custom object instance.
	Id *string `json:"id,omitempty"`

	// Type The identifier of the custom object type that defines the structure of the custom object instance.
	Type *string `json:"type,omitempty"`

	// UpdatedAt The time the attribute was last updated as a UTC Unix timestamp
	UpdatedAt *int `json:"updated_at,omitempty"`
}

CustomObjectInstanceSchema A Custom Object Instance represents an instance of a custom object type. This allows you to create and set custom attributes to store data about your customers that is not already captured by Intercom. The parent object includes recommended default attributes and you can add your own custom attributes.

type CustomerRequest0

type CustomerRequest0 struct {
	// IntercomUserId The identifier for the contact as given by Intercom.
	IntercomUserId string `json:"intercom_user_id"`
}

CustomerRequest0 defines model for .

type CustomerRequest1

type CustomerRequest1 struct {
	// UserId The external_id you have defined for the contact who is being added as a participant.
	UserId string `json:"user_id"`
}

CustomerRequest1 defines model for .

type CustomerRequest2

type CustomerRequest2 struct {
	// Email The email you have defined for the contact who is being added as a participant.
	Email string `json:"email"`
}

CustomerRequest2 defines model for .

type CustomerRequestSchema

type CustomerRequestSchema struct {
	// contains filtered or unexported fields
}

CustomerRequestSchema defines model for customer_request.

func (CustomerRequestSchema) AsCustomerRequest0

func (t CustomerRequestSchema) AsCustomerRequest0() (CustomerRequest0, error)

AsCustomerRequest0 returns the union data inside the CustomerRequestSchema as a CustomerRequest0

func (CustomerRequestSchema) AsCustomerRequest1

func (t CustomerRequestSchema) AsCustomerRequest1() (CustomerRequest1, error)

AsCustomerRequest1 returns the union data inside the CustomerRequestSchema as a CustomerRequest1

func (CustomerRequestSchema) AsCustomerRequest2

func (t CustomerRequestSchema) AsCustomerRequest2() (CustomerRequest2, error)

AsCustomerRequest2 returns the union data inside the CustomerRequestSchema as a CustomerRequest2

func (*CustomerRequestSchema) FromCustomerRequest0

func (t *CustomerRequestSchema) FromCustomerRequest0(v CustomerRequest0) error

FromCustomerRequest0 overwrites any union data inside the CustomerRequestSchema as the provided CustomerRequest0

func (*CustomerRequestSchema) FromCustomerRequest1

func (t *CustomerRequestSchema) FromCustomerRequest1(v CustomerRequest1) error

FromCustomerRequest1 overwrites any union data inside the CustomerRequestSchema as the provided CustomerRequest1

func (*CustomerRequestSchema) FromCustomerRequest2

func (t *CustomerRequestSchema) FromCustomerRequest2(v CustomerRequest2) error

FromCustomerRequest2 overwrites any union data inside the CustomerRequestSchema as the provided CustomerRequest2

func (CustomerRequestSchema) MarshalJSON

func (t CustomerRequestSchema) MarshalJSON() ([]byte, error)

func (*CustomerRequestSchema) MergeCustomerRequest0

func (t *CustomerRequestSchema) MergeCustomerRequest0(v CustomerRequest0) error

MergeCustomerRequest0 performs a merge with any union data inside the CustomerRequestSchema, using the provided CustomerRequest0

func (*CustomerRequestSchema) MergeCustomerRequest1

func (t *CustomerRequestSchema) MergeCustomerRequest1(v CustomerRequest1) error

MergeCustomerRequest1 performs a merge with any union data inside the CustomerRequestSchema, using the provided CustomerRequest1

func (*CustomerRequestSchema) MergeCustomerRequest2

func (t *CustomerRequestSchema) MergeCustomerRequest2(v CustomerRequest2) error

MergeCustomerRequest2 performs a merge with any union data inside the CustomerRequestSchema, using the provided CustomerRequest2

func (*CustomerRequestSchema) UnmarshalJSON

func (t *CustomerRequestSchema) UnmarshalJSON(b []byte) error

type DataAttributeDataType

type DataAttributeDataType string

DataAttributeDataType The data type of the attribute.

const (
	Boolean DataAttributeDataType = "boolean"
	Date    DataAttributeDataType = "date"
	Float   DataAttributeDataType = "float"
	Integer DataAttributeDataType = "integer"
	String  DataAttributeDataType = "string"
)

Defines values for DataAttributeDataType.

func (DataAttributeDataType) Valid

func (e DataAttributeDataType) Valid() bool

Valid indicates whether the value is a known member of the DataAttributeDataType enum.

type DataAttributeListSchema

type DataAttributeListSchema struct {
	// Data A list of data attributes
	Data *[]DataAttributeSchema `json:"data,omitempty"`

	// Type The type of the object
	Type *DataAttributeListType `json:"type,omitempty"`
}

DataAttributeListSchema A list of all data attributes belonging to a workspace for contacts, companies or conversations.

type DataAttributeListType

type DataAttributeListType string

DataAttributeListType The type of the object

const (
	DataAttributeListTypeList DataAttributeListType = "list"
)

Defines values for DataAttributeListType.

func (DataAttributeListType) Valid

func (e DataAttributeListType) Valid() bool

Valid indicates whether the value is a known member of the DataAttributeListType enum.

type DataAttributeModel

type DataAttributeModel string

DataAttributeModel Value is `contact` for user/lead attributes and `company` for company attributes.

const (
	DataAttributeModelCompany DataAttributeModel = "company"
	DataAttributeModelContact DataAttributeModel = "contact"
)

Defines values for DataAttributeModel.

func (DataAttributeModel) Valid

func (e DataAttributeModel) Valid() bool

Valid indicates whether the value is a known member of the DataAttributeModel enum.

type DataAttributeSchema

type DataAttributeSchema struct {
	// AdminId Teammate who created the attribute. Only applicable to CDAs
	AdminId *string `json:"admin_id,omitempty"`

	// ApiWritable Can this attribute be updated through API
	ApiWritable *bool `json:"api_writable,omitempty"`

	// Archived Is this attribute archived. (Only applicable to CDAs)
	Archived *bool `json:"archived,omitempty"`

	// CreatedAt The time the attribute was created as a UTC Unix timestamp
	CreatedAt *int `json:"created_at,omitempty"`

	// Custom Set to true if this is a CDA
	Custom *bool `json:"custom,omitempty"`

	// DataType The data type of the attribute.
	DataType *DataAttributeDataType `json:"data_type,omitempty"`

	// Description Readable description of the attribute.
	Description *string `json:"description,omitempty"`

	// FullName Full name of the attribute. Should match the name unless it's a nested attribute. We can split full_name on `.` to access nested user object values.
	FullName *string `json:"full_name,omitempty"`

	// Id The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes.
	Id *int `json:"id,omitempty"`

	// Label Readable name of the attribute (i.e. name you see in the UI)
	Label *string `json:"label,omitempty"`

	// MessengerWritable Can this attribute be updated by the Messenger
	MessengerWritable *bool `json:"messenger_writable,omitempty"`

	// Model Value is `contact` for user/lead attributes and `company` for company attributes.
	Model *DataAttributeModel `json:"model,omitempty"`

	// Name Name of the attribute.
	Name *string `json:"name,omitempty"`

	// Options List of predefined options for attribute value.
	Options *[]string `json:"options,omitempty"`

	// Type Value is `data_attribute`.
	Type *DataAttributeType `json:"type,omitempty"`

	// UiWritable Can this attribute be updated in the UI
	UiWritable *bool `json:"ui_writable,omitempty"`

	// UpdatedAt The time the attribute was last updated as a UTC Unix timestamp
	UpdatedAt *int `json:"updated_at,omitempty"`
}

DataAttributeSchema Data Attributes are metadata used to describe your contact, company and conversation models. These include standard and custom attributes. By using the data attributes endpoint, you can get the global list of attributes for your workspace, as well as create and archive custom attributes.

type DataAttributeType

type DataAttributeType string

DataAttributeType Value is `data_attribute`.

const (
	DataAttribute DataAttributeType = "data_attribute"
)

Defines values for DataAttributeType.

func (DataAttributeType) Valid

func (e DataAttributeType) Valid() bool

Valid indicates whether the value is a known member of the DataAttributeType enum.

type DataEventListSchema

type DataEventListSchema struct {
	// Events A list of data events
	Events *[]DataEventSchema `json:"events,omitempty"`

	// Pages Pagination
	Pages *struct {
		Next  *string `json:"next,omitempty"`
		Since *string `json:"since,omitempty"`
	} `json:"pages,omitempty"`

	// Type The type of the object
	Type *DataEventListType `json:"type,omitempty"`
}

DataEventListSchema This will return a list of data events for the App.

type DataEventListType

type DataEventListType string

DataEventListType The type of the object

const (
	EventList DataEventListType = "event.list"
)

Defines values for DataEventListType.

func (DataEventListType) Valid

func (e DataEventListType) Valid() bool

Valid indicates whether the value is a known member of the DataEventListType enum.

type DataEventSchema

type DataEventSchema struct {
	// CreatedAt The time the event occurred as a UTC Unix timestamp
	CreatedAt int `json:"created_at"`

	// Email An email address for your user. An email should only be used where your application uses email to uniquely identify users.
	Email *string `json:"email,omitempty"`

	// EventName The name of the event that occurred. This is presented to your App's admins when filtering and creating segments - a good event name is typically a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`.
	EventName string `json:"event_name"`

	// Id Your identifier for a lead or a user.
	Id *string `json:"id,omitempty"`

	// IntercomUserId The Intercom identifier for the user.
	IntercomUserId *string `json:"intercom_user_id,omitempty"`

	// Metadata Optional metadata about the event.
	Metadata *map[string]string `json:"metadata,omitempty"`

	// Type The type of the object
	Type *DataEventType `json:"type,omitempty"`

	// UserId Your identifier for the user.
	UserId *string `json:"user_id,omitempty"`
}

DataEventSchema Data events are used to notify Intercom of changes to your data.

type DataEventSummariesJSONRequestBody

type DataEventSummariesJSONRequestBody = CreateDataEventSummariesRequestSchema

DataEventSummariesJSONRequestBody defines body for DataEventSummaries for application/json ContentType.

type DataEventSummariesParams

type DataEventSummariesParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

DataEventSummariesParams defines parameters for DataEventSummaries.

type DataEventSummariesResponse

type DataEventSummariesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON401      *ErrorSchema
}

func ParseDataEventSummariesResponse

func ParseDataEventSummariesResponse(rsp *http.Response) (*DataEventSummariesResponse, error)

ParseDataEventSummariesResponse parses an HTTP response from a DataEventSummariesWithResponse call

func (DataEventSummariesResponse) Status

Status returns HTTPResponse.Status

func (DataEventSummariesResponse) StatusCode

func (r DataEventSummariesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DataEventSummaryItemSchema

type DataEventSummaryItemSchema struct {
	// Count The number of times the event was sent
	Count *int `json:"count,omitempty"`

	// Description The description of the event
	Description *string `json:"description,omitempty"`

	// First The first time the event was sent
	First *string `json:"first,omitempty"`

	// Last The last time the event was sent
	Last *string `json:"last,omitempty"`

	// Name The name of the event
	Name *string `json:"name,omitempty"`
}

DataEventSummaryItemSchema This will return a summary of a data event for the App.

type DataEventSummarySchema

type DataEventSummarySchema struct {
	// Email The email address of the user
	Email *string `json:"email,omitempty"`

	// Events A summary of data events
	Events *[]*DataEventSummaryItemSchema `json:"events,omitempty"`

	// IntercomUserId The Intercom user ID of the user
	IntercomUserId *string `json:"intercom_user_id,omitempty"`

	// Type The type of the object
	Type *DataEventSummaryType `json:"type,omitempty"`

	// UserId The user ID of the user
	UserId *string `json:"user_id,omitempty"`
}

DataEventSummarySchema This will return a summary of data events for the App.

type DataEventSummaryType

type DataEventSummaryType string

DataEventSummaryType The type of the object

const (
	EventSummary DataEventSummaryType = "event.summary"
)

Defines values for DataEventSummaryType.

func (DataEventSummaryType) Valid

func (e DataEventSummaryType) Valid() bool

Valid indicates whether the value is a known member of the DataEventSummaryType enum.

type DataEventType

type DataEventType string

DataEventType The type of the object

const (
	Event DataEventType = "event"
)

Defines values for DataEventType.

func (DataEventType) Valid

func (e DataEventType) Valid() bool

Valid indicates whether the value is a known member of the DataEventType enum.

type DataExportCsvSchema

type DataExportCsvSchema struct {
	// CompanyId The company ID of the user in relation to the message that was sent. Will return -1 if no company is present.
	CompanyId *string `json:"company_id,omitempty"`

	// ContentId The specific content that was received. In an A/B test each version has its own Content ID.
	ContentId *string `json:"content_id,omitempty"`

	// ContentTitle The title of the content you see in your Intercom workspace.
	ContentTitle *string `json:"content_title,omitempty"`

	// ContentType Email, Chat, Post etc.
	ContentType *string `json:"content_type,omitempty"`

	// Email The users email who was sent the message.
	Email *string `json:"email,omitempty"`

	// FirstClick The first time the series the user clicked on a link within this message. Only events within the export job's requested date range are counted.
	FirstClick *int `json:"first_click,omitempty"`

	// FirstCompletion The first time a user completed this message if the content was able to be completed e.g. Tours, Surveys. Only events within the export job's requested date range are counted.
	FirstCompletion *int `json:"first_completion,omitempty"`

	// FirstDismisall The first time the series the user dismissed this message. Only events within the export job's requested date range are counted.
	FirstDismisall *int `json:"first_dismisall,omitempty"`

	// FirstGoalSuccess The first time the user met this messages associated goal if one exists. Only events within the export job's requested date range are counted.
	FirstGoalSuccess *int `json:"first_goal_success,omitempty"`

	// FirstHardBounce The first time this message hard bounced for this user. Only events within the export job's requested date range are counted.
	FirstHardBounce *int `json:"first_hard_bounce,omitempty"`

	// FirstOpen The first time the user opened this message. Only events within the export job's requested date range are counted.
	FirstOpen *int `json:"first_open,omitempty"`

	// FirstReply The first time a user replied to this message if the content was able to receive replies. Only events within the export job's requested date range are counted.
	FirstReply *int `json:"first_reply,omitempty"`

	// FirstSeriesCompletion The first time the series this message was a part of was completed by the user. Only events within the export job's requested date range are counted.
	FirstSeriesCompletion *int `json:"first_series_completion,omitempty"`

	// FirstSeriesDisengagement The first time the series this message was a part of was disengaged by the user. Only events within the export job's requested date range are counted.
	FirstSeriesDisengagement *int `json:"first_series_disengagement,omitempty"`

	// FirstSeriesExit The first time the series this message was a part of was exited by the user. Only events within the export job's requested date range are counted.
	FirstSeriesExit *int `json:"first_series_exit,omitempty"`

	// FirstUnsubscribe The first time the user unsubscribed from this message. Only events within the export job's requested date range are counted.
	FirstUnsubscribe *int `json:"first_unsubscribe,omitempty"`

	// Name The full name of the user receiving the message
	Name *string `json:"name,omitempty"`

	// NodeId The id of the series node that this ruleset is associated with. Each block in a series has a corresponding node_id.
	NodeId *string `json:"node_id,omitempty"`

	// ReceiptId ID for this receipt. Will be included with any related stats in other files to identify this specific delivery of a message.
	ReceiptId *string `json:"receipt_id,omitempty"`

	// ReceivedAt Timestamp for when the receipt was recorded.
	ReceivedAt *int `json:"received_at,omitempty"`

	// RulesetId The id of the message.
	RulesetId *string `json:"ruleset_id,omitempty"`

	// RulesetVersionId As you edit content we record new versions. This ID can help you determine which version of a piece of content that was received.
	RulesetVersionId *string `json:"ruleset_version_id,omitempty"`

	// SeriesId The id of the series that this content is part of. Will return -1 if not part of a series.
	SeriesId *string `json:"series_id,omitempty"`

	// SeriesTitle The title of the series that this content is part of.
	SeriesTitle *string `json:"series_title,omitempty"`

	// UserExternalId The external_user_id of the user who was sent the message
	UserExternalId *string `json:"user_external_id,omitempty"`

	// UserId The user_id of the user who was sent the message.
	UserId *string `json:"user_id,omitempty"`
}

DataExportCsvSchema A CSV output file

type DataExportSchema

type DataExportSchema struct {
	// DownloadExpiresAt The time after which you will not be able to access the data.
	DownloadExpiresAt *string `json:"download_expires_at,omitempty"`

	// DownloadUrl The location where you can download your data.
	DownloadUrl *string `json:"download_url,omitempty"`

	// JobIdentifier The identifier for your job.
	JobIdentifier *string `json:"job_identifier,omitempty"`

	// Status The current state of your job.
	Status *DataExportStatus `json:"status,omitempty"`
}

DataExportSchema The data export API is used to export message delivery and engagement statistics for outbound content (Emails, Posts, Custom Bots, Surveys, Tours, Series, and more) sent in a given timeframe. The exported data includes who received each message, when they received it, and how they engaged with it (opens, clicks, replies, completions, dismissals, unsubscribes, and bounces).

type DataExportStatus

type DataExportStatus string

DataExportStatus The current state of your job.

const (
	DataExportStatusCanceled   DataExportStatus = "canceled"
	DataExportStatusCompleted  DataExportStatus = "completed"
	DataExportStatusFailed     DataExportStatus = "failed"
	DataExportStatusInProgress DataExportStatus = "in_progress"
	DataExportStatusNoData     DataExportStatus = "no_data"
	DataExportStatusPending    DataExportStatus = "pending"
)

Defines values for DataExportStatus.

func (DataExportStatus) Valid

func (e DataExportStatus) Valid() bool

Valid indicates whether the value is a known member of the DataExportStatus enum.

type Datetime

type Datetime struct {
	// contains filtered or unexported fields
}

Datetime defines model for datetime.

func (Datetime) AsDatetime0

func (t Datetime) AsDatetime0() (Datetime0, error)

AsDatetime0 returns the union data inside the Datetime as a Datetime0

func (Datetime) AsDatetime1

func (t Datetime) AsDatetime1() (Datetime1, error)

AsDatetime1 returns the union data inside the Datetime as a Datetime1

func (*Datetime) FromDatetime0

func (t *Datetime) FromDatetime0(v Datetime0) error

FromDatetime0 overwrites any union data inside the Datetime as the provided Datetime0

func (*Datetime) FromDatetime1

func (t *Datetime) FromDatetime1(v Datetime1) error

FromDatetime1 overwrites any union data inside the Datetime as the provided Datetime1

func (Datetime) MarshalJSON

func (t Datetime) MarshalJSON() ([]byte, error)

func (*Datetime) MergeDatetime0

func (t *Datetime) MergeDatetime0(v Datetime0) error

MergeDatetime0 performs a merge with any union data inside the Datetime, using the provided Datetime0

func (*Datetime) MergeDatetime1

func (t *Datetime) MergeDatetime1(v Datetime1) error

MergeDatetime1 performs a merge with any union data inside the Datetime, using the provided Datetime1

func (*Datetime) UnmarshalJSON

func (t *Datetime) UnmarshalJSON(b []byte) error

type Datetime0

type Datetime0 = time.Time

Datetime0 A date and time following the ISO8601 notation.

type Datetime1

type Datetime1 = int

Datetime1 A date and time as UNIX timestamp notation.

type DeleteArticleParams

type DeleteArticleParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

DeleteArticleParams defines parameters for DeleteArticle.

type DeleteArticleResponse

type DeleteArticleResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DeletedArticleObjectSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseDeleteArticleResponse

func ParseDeleteArticleResponse(rsp *http.Response) (*DeleteArticleResponse, error)

ParseDeleteArticleResponse parses an HTTP response from a DeleteArticleWithResponse call

func (DeleteArticleResponse) Status

func (r DeleteArticleResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteArticleResponse) StatusCode

func (r DeleteArticleResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteCollectionParams

type DeleteCollectionParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

DeleteCollectionParams defines parameters for DeleteCollection.

type DeleteCollectionResponse

type DeleteCollectionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DeletedCollectionObjectSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseDeleteCollectionResponse

func ParseDeleteCollectionResponse(rsp *http.Response) (*DeleteCollectionResponse, error)

ParseDeleteCollectionResponse parses an HTTP response from a DeleteCollectionWithResponse call

func (DeleteCollectionResponse) Status

func (r DeleteCollectionResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteCollectionResponse) StatusCode

func (r DeleteCollectionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteCompanyParams

type DeleteCompanyParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

DeleteCompanyParams defines parameters for DeleteCompany.

type DeleteCompanyResponse

type DeleteCompanyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DeletedCompanyObjectSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseDeleteCompanyResponse

func ParseDeleteCompanyResponse(rsp *http.Response) (*DeleteCompanyResponse, error)

ParseDeleteCompanyResponse parses an HTTP response from a DeleteCompanyWithResponse call

func (DeleteCompanyResponse) Status

func (r DeleteCompanyResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteCompanyResponse) StatusCode

func (r DeleteCompanyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteContactParams

type DeleteContactParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

DeleteContactParams defines parameters for DeleteContact.

type DeleteContactResponse

type DeleteContactResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ContactDeleted
	JSON401      *ErrorSchema
}

func ParseDeleteContactResponse

func ParseDeleteContactResponse(rsp *http.Response) (*DeleteContactResponse, error)

ParseDeleteContactResponse parses an HTTP response from a DeleteContactWithResponse call

func (DeleteContactResponse) Status

func (r DeleteContactResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteContactResponse) StatusCode

func (r DeleteContactResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteContentImportSourceParams

type DeleteContentImportSourceParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

DeleteContentImportSourceParams defines parameters for DeleteContentImportSource.

type DeleteContentImportSourceResponse

type DeleteContentImportSourceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON401      *ErrorSchema
}

func ParseDeleteContentImportSourceResponse

func ParseDeleteContentImportSourceResponse(rsp *http.Response) (*DeleteContentImportSourceResponse, error)

ParseDeleteContentImportSourceResponse parses an HTTP response from a DeleteContentImportSourceWithResponse call

func (DeleteContentImportSourceResponse) Status

Status returns HTTPResponse.Status

func (DeleteContentImportSourceResponse) StatusCode

func (r DeleteContentImportSourceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteConversationParams

type DeleteConversationParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

DeleteConversationParams defines parameters for DeleteConversation.

type DeleteConversationResponse

type DeleteConversationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ConversationDeletedSchema
	JSON401      *ErrorSchema
	JSON403      *ErrorSchema
}

func ParseDeleteConversationResponse

func ParseDeleteConversationResponse(rsp *http.Response) (*DeleteConversationResponse, error)

ParseDeleteConversationResponse parses an HTTP response from a DeleteConversationWithResponse call

func (DeleteConversationResponse) Status

Status returns HTTPResponse.Status

func (DeleteConversationResponse) StatusCode

func (r DeleteConversationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteCustomObjectInstancesByExternalIdParams

type DeleteCustomObjectInstancesByExternalIdParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

DeleteCustomObjectInstancesByExternalIdParams defines parameters for DeleteCustomObjectInstancesByExternalId.

type DeleteCustomObjectInstancesByExternalIdResponse

type DeleteCustomObjectInstancesByExternalIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CustomObjectInstanceDeletedSchema
	JSON401      *Unauthorized
	JSON404      *ObjectNotFound
}

func ParseDeleteCustomObjectInstancesByExternalIdResponse

func ParseDeleteCustomObjectInstancesByExternalIdResponse(rsp *http.Response) (*DeleteCustomObjectInstancesByExternalIdResponse, error)

ParseDeleteCustomObjectInstancesByExternalIdResponse parses an HTTP response from a DeleteCustomObjectInstancesByExternalIdWithResponse call

func (DeleteCustomObjectInstancesByExternalIdResponse) Status

Status returns HTTPResponse.Status

func (DeleteCustomObjectInstancesByExternalIdResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type DeleteCustomObjectInstancesByIdParams

type DeleteCustomObjectInstancesByIdParams struct {
	ExternalId      string           `form:"external_id" json:"external_id"`
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

DeleteCustomObjectInstancesByIdParams defines parameters for DeleteCustomObjectInstancesById.

type DeleteCustomObjectInstancesByIdResponse

type DeleteCustomObjectInstancesByIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CustomObjectInstanceDeletedSchema
	JSON401      *Unauthorized
	JSON404      *ObjectNotFound
}

func ParseDeleteCustomObjectInstancesByIdResponse

func ParseDeleteCustomObjectInstancesByIdResponse(rsp *http.Response) (*DeleteCustomObjectInstancesByIdResponse, error)

ParseDeleteCustomObjectInstancesByIdResponse parses an HTTP response from a DeleteCustomObjectInstancesByIdWithResponse call

func (DeleteCustomObjectInstancesByIdResponse) Status

Status returns HTTPResponse.Status

func (DeleteCustomObjectInstancesByIdResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type DeleteExternalPageParams

type DeleteExternalPageParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

DeleteExternalPageParams defines parameters for DeleteExternalPage.

type DeleteExternalPageResponse

type DeleteExternalPageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ExternalPageSchema
	JSON401      *ErrorSchema
}

func ParseDeleteExternalPageResponse

func ParseDeleteExternalPageResponse(rsp *http.Response) (*DeleteExternalPageResponse, error)

ParseDeleteExternalPageResponse parses an HTTP response from a DeleteExternalPageWithResponse call

func (DeleteExternalPageResponse) Status

Status returns HTTPResponse.Status

func (DeleteExternalPageResponse) StatusCode

func (r DeleteExternalPageResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteInternalArticleParams

type DeleteInternalArticleParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

DeleteInternalArticleParams defines parameters for DeleteInternalArticle.

type DeleteInternalArticleResponse

type DeleteInternalArticleResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DeletedInternalArticleObjectSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseDeleteInternalArticleResponse

func ParseDeleteInternalArticleResponse(rsp *http.Response) (*DeleteInternalArticleResponse, error)

ParseDeleteInternalArticleResponse parses an HTTP response from a DeleteInternalArticleWithResponse call

func (DeleteInternalArticleResponse) Status

Status returns HTTPResponse.Status

func (DeleteInternalArticleResponse) StatusCode

func (r DeleteInternalArticleResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteNewsItemParams

type DeleteNewsItemParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

DeleteNewsItemParams defines parameters for DeleteNewsItem.

type DeleteNewsItemResponse

type DeleteNewsItemResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DeletedObjectSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseDeleteNewsItemResponse

func ParseDeleteNewsItemResponse(rsp *http.Response) (*DeleteNewsItemResponse, error)

ParseDeleteNewsItemResponse parses an HTTP response from a DeleteNewsItemWithResponse call

func (DeleteNewsItemResponse) Status

func (r DeleteNewsItemResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteNewsItemResponse) StatusCode

func (r DeleteNewsItemResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteTagParams

type DeleteTagParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

DeleteTagParams defines parameters for DeleteTag.

type DeleteTagResponse

type DeleteTagResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *ErrorSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseDeleteTagResponse

func ParseDeleteTagResponse(rsp *http.Response) (*DeleteTagResponse, error)

ParseDeleteTagResponse parses an HTTP response from a DeleteTagWithResponse call

func (DeleteTagResponse) Status

func (r DeleteTagResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteTagResponse) StatusCode

func (r DeleteTagResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteTicketParams

type DeleteTicketParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

DeleteTicketParams defines parameters for DeleteTicket.

type DeleteTicketResponse

type DeleteTicketResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TicketDeletedSchema
	JSON401      *ErrorSchema
	JSON403      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseDeleteTicketResponse

func ParseDeleteTicketResponse(rsp *http.Response) (*DeleteTicketResponse, error)

ParseDeleteTicketResponse parses an HTTP response from a DeleteTicketWithResponse call

func (DeleteTicketResponse) Status

func (r DeleteTicketResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteTicketResponse) StatusCode

func (r DeleteTicketResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeletedArticleObjectObject

type DeletedArticleObjectObject string

DeletedArticleObjectObject The type of object which was deleted. - article

const (
	Article DeletedArticleObjectObject = "article"
)

Defines values for DeletedArticleObjectObject.

func (DeletedArticleObjectObject) Valid

func (e DeletedArticleObjectObject) Valid() bool

Valid indicates whether the value is a known member of the DeletedArticleObjectObject enum.

type DeletedArticleObjectSchema

type DeletedArticleObjectSchema struct {
	// Deleted Whether the article was deleted successfully or not.
	Deleted *bool `json:"deleted,omitempty"`

	// Id The unique identifier for the article which you provided in the URL.
	Id *string `json:"id,omitempty"`

	// Object The type of object which was deleted. - article
	Object *DeletedArticleObjectObject `json:"object,omitempty"`
}

DeletedArticleObjectSchema Response returned when an object is deleted

type DeletedCollectionObjectObject

type DeletedCollectionObjectObject string

DeletedCollectionObjectObject The type of object which was deleted. - `collection`

const (
	Collection DeletedCollectionObjectObject = "collection"
)

Defines values for DeletedCollectionObjectObject.

func (DeletedCollectionObjectObject) Valid

Valid indicates whether the value is a known member of the DeletedCollectionObjectObject enum.

type DeletedCollectionObjectSchema

type DeletedCollectionObjectSchema struct {
	// Deleted Whether the collection was deleted successfully or not.
	Deleted *bool `json:"deleted,omitempty"`

	// Id The unique identifier for the collection which you provided in the URL.
	Id *string `json:"id,omitempty"`

	// Object The type of object which was deleted. - `collection`
	Object *DeletedCollectionObjectObject `json:"object,omitempty"`
}

DeletedCollectionObjectSchema Response returned when an object is deleted

type DeletedCompanyObjectObject

type DeletedCompanyObjectObject string

DeletedCompanyObjectObject The type of object which was deleted. - `company`

const (
	DeletedCompanyObjectObjectCompany DeletedCompanyObjectObject = "company"
)

Defines values for DeletedCompanyObjectObject.

func (DeletedCompanyObjectObject) Valid

func (e DeletedCompanyObjectObject) Valid() bool

Valid indicates whether the value is a known member of the DeletedCompanyObjectObject enum.

type DeletedCompanyObjectSchema

type DeletedCompanyObjectSchema struct {
	// Deleted Whether the company was deleted successfully or not.
	Deleted *bool `json:"deleted,omitempty"`

	// Id The unique identifier for the company which is given by Intercom.
	Id *string `json:"id,omitempty"`

	// Object The type of object which was deleted. - `company`
	Object *DeletedCompanyObjectObject `json:"object,omitempty"`
}

DeletedCompanyObjectSchema Response returned when an object is deleted

type DeletedInternalArticleObjectObject

type DeletedInternalArticleObjectObject string

DeletedInternalArticleObjectObject The type of object which was deleted. - internal_article

const (
	DeletedInternalArticleObjectObjectInternalArticle DeletedInternalArticleObjectObject = "internal_article"
)

Defines values for DeletedInternalArticleObjectObject.

func (DeletedInternalArticleObjectObject) Valid

Valid indicates whether the value is a known member of the DeletedInternalArticleObjectObject enum.

type DeletedInternalArticleObjectSchema

type DeletedInternalArticleObjectSchema struct {
	// Deleted Whether the internal article was deleted successfully or not.
	Deleted *bool `json:"deleted,omitempty"`

	// Id The unique identifier for the internal article which you provided in the URL.
	Id *string `json:"id,omitempty"`

	// Object The type of object which was deleted. - internal_article
	Object *DeletedInternalArticleObjectObject `json:"object,omitempty"`
}

DeletedInternalArticleObjectSchema Response returned when an object is deleted

type DeletedObjectObject

type DeletedObjectObject string

DeletedObjectObject The type of object which was deleted - news-item.

const (
	DeletedObjectObjectNewsItem DeletedObjectObject = "news-item"
)

Defines values for DeletedObjectObject.

func (DeletedObjectObject) Valid

func (e DeletedObjectObject) Valid() bool

Valid indicates whether the value is a known member of the DeletedObjectObject enum.

type DeletedObjectSchema

type DeletedObjectSchema struct {
	// Deleted Whether the news item was deleted successfully or not.
	Deleted *bool `json:"deleted,omitempty"`

	// Id The unique identifier for the news item which you provided in the URL.
	Id *string `json:"id,omitempty"`

	// Object The type of object which was deleted - news-item.
	Object *DeletedObjectObject `json:"object,omitempty"`
}

DeletedObjectSchema Response returned when an object is deleted

type DetachContactFromACompanyParams

type DetachContactFromACompanyParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

DetachContactFromACompanyParams defines parameters for DetachContactFromACompany.

type DetachContactFromACompanyResponse

type DetachContactFromACompanyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CompanySchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseDetachContactFromACompanyResponse

func ParseDetachContactFromACompanyResponse(rsp *http.Response) (*DetachContactFromACompanyResponse, error)

ParseDetachContactFromACompanyResponse parses an HTTP response from a DetachContactFromACompanyWithResponse call

func (DetachContactFromACompanyResponse) Status

Status returns HTTPResponse.Status

func (DetachContactFromACompanyResponse) StatusCode

func (r DetachContactFromACompanyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DetachContactFromConversationJSONRequestBody

type DetachContactFromConversationJSONRequestBody = DetachContactFromConversationRequest

DetachContactFromConversationJSONRequestBody defines body for DetachContactFromConversation for application/json ContentType.

type DetachContactFromConversationParams

type DetachContactFromConversationParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

DetachContactFromConversationParams defines parameters for DetachContactFromConversation.

type DetachContactFromConversationRequest

type DetachContactFromConversationRequest struct {
	// AdminId The `id` of the admin who is performing the action.
	AdminId string `json:"admin_id"`
}

DetachContactFromConversationRequest defines model for detach_contact_from_conversation_request.

type DetachContactFromConversationResponse

type DetachContactFromConversationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ConversationSchema
	JSON401      *ErrorSchema
	JSON403      *ErrorSchema
	JSON404      *ErrorSchema
	JSON422      *ErrorSchema
}

func ParseDetachContactFromConversationResponse

func ParseDetachContactFromConversationResponse(rsp *http.Response) (*DetachContactFromConversationResponse, error)

ParseDetachContactFromConversationResponse parses an HTTP response from a DetachContactFromConversationWithResponse call

func (DetachContactFromConversationResponse) Status

Status returns HTTPResponse.Status

func (DetachContactFromConversationResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type DetachSubscriptionTypeToContactParams

type DetachSubscriptionTypeToContactParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

DetachSubscriptionTypeToContactParams defines parameters for DetachSubscriptionTypeToContact.

type DetachSubscriptionTypeToContactResponse

type DetachSubscriptionTypeToContactResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SubscriptionTypeSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseDetachSubscriptionTypeToContactResponse

func ParseDetachSubscriptionTypeToContactResponse(rsp *http.Response) (*DetachSubscriptionTypeToContactResponse, error)

ParseDetachSubscriptionTypeToContactResponse parses an HTTP response from a DetachSubscriptionTypeToContactWithResponse call

func (DetachSubscriptionTypeToContactResponse) Status

Status returns HTTPResponse.Status

func (DetachSubscriptionTypeToContactResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type DetachTagFromContactParams

type DetachTagFromContactParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

DetachTagFromContactParams defines parameters for DetachTagFromContact.

type DetachTagFromContactResponse

type DetachTagFromContactResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TagSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseDetachTagFromContactResponse

func ParseDetachTagFromContactResponse(rsp *http.Response) (*DetachTagFromContactResponse, error)

ParseDetachTagFromContactResponse parses an HTTP response from a DetachTagFromContactWithResponse call

func (DetachTagFromContactResponse) Status

Status returns HTTPResponse.Status

func (DetachTagFromContactResponse) StatusCode

func (r DetachTagFromContactResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DetachTagFromConversationJSONBody

type DetachTagFromConversationJSONBody struct {
	// AdminId The unique identifier for the admin which is given by Intercom.
	AdminId string `json:"admin_id"`
}

DetachTagFromConversationJSONBody defines parameters for DetachTagFromConversation.

type DetachTagFromConversationJSONRequestBody

type DetachTagFromConversationJSONRequestBody DetachTagFromConversationJSONBody

DetachTagFromConversationJSONRequestBody defines body for DetachTagFromConversation for application/json ContentType.

type DetachTagFromConversationParams

type DetachTagFromConversationParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

DetachTagFromConversationParams defines parameters for DetachTagFromConversation.

type DetachTagFromConversationResponse

type DetachTagFromConversationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TagSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseDetachTagFromConversationResponse

func ParseDetachTagFromConversationResponse(rsp *http.Response) (*DetachTagFromConversationResponse, error)

ParseDetachTagFromConversationResponse parses an HTTP response from a DetachTagFromConversationWithResponse call

func (DetachTagFromConversationResponse) Status

Status returns HTTPResponse.Status

func (DetachTagFromConversationResponse) StatusCode

func (r DetachTagFromConversationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DetachTagFromTicketJSONBody

type DetachTagFromTicketJSONBody struct {
	// AdminId The unique identifier for the admin which is given by Intercom.
	AdminId string `json:"admin_id"`
}

DetachTagFromTicketJSONBody defines parameters for DetachTagFromTicket.

type DetachTagFromTicketJSONRequestBody

type DetachTagFromTicketJSONRequestBody DetachTagFromTicketJSONBody

DetachTagFromTicketJSONRequestBody defines body for DetachTagFromTicket for application/json ContentType.

type DetachTagFromTicketParams

type DetachTagFromTicketParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

DetachTagFromTicketParams defines parameters for DetachTagFromTicket.

type DetachTagFromTicketResponse

type DetachTagFromTicketResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TagSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseDetachTagFromTicketResponse

func ParseDetachTagFromTicketResponse(rsp *http.Response) (*DetachTagFromTicketResponse, error)

ParseDetachTagFromTicketResponse parses an HTTP response from a DetachTagFromTicketWithResponse call

func (DetachTagFromTicketResponse) Status

Status returns HTTPResponse.Status

func (DetachTagFromTicketResponse) StatusCode

func (r DetachTagFromTicketResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DownloadDataExportParams

type DownloadDataExportParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

DownloadDataExportParams defines parameters for DownloadDataExport.

type DownloadDataExportResponse

type DownloadDataExportResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseDownloadDataExportResponse

func ParseDownloadDataExportResponse(rsp *http.Response) (*DownloadDataExportResponse, error)

ParseDownloadDataExportResponse parses an HTTP response from a DownloadDataExportWithResponse call

func (DownloadDataExportResponse) Status

Status returns HTTPResponse.Status

func (DownloadDataExportResponse) StatusCode

func (r DownloadDataExportResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type EmailAddressHeaderSchema

type EmailAddressHeaderSchema struct {
	// EmailAddress The email address
	EmailAddress *string `json:"email_address,omitempty"`

	// Name The name associated with the email address
	Name *string `json:"name,omitempty"`

	// Type The type of email address header
	Type *string `json:"type,omitempty"`
}

EmailAddressHeaderSchema Contains data for an email address header for a conversation part that was sent as an email.

type EmailListSchema

type EmailListSchema struct {
	Data *[]EmailSettingSchema `json:"data,omitempty"`

	// Type The type of object
	Type *string `json:"type,omitempty"`
}

EmailListSchema A list of email settings

type EmailMessageMetadataSchema

type EmailMessageMetadataSchema struct {
	// EmailAddressHeaders A list of an email address headers.
	EmailAddressHeaders *[]EmailAddressHeaderSchema `json:"email_address_headers,omitempty"`

	// MessageId The unique identifier for the email message as specified in the Message-ID header
	MessageId *string `json:"message_id,omitempty"`

	// Subject The subject of the email
	Subject *string `json:"subject,omitempty"`
}

EmailMessageMetadataSchema Contains metadata if the message was sent as an email

type EmailSettingSchema

type EmailSettingSchema struct {
	// BrandId Associated brand identifier
	BrandId *string `json:"brand_id,omitempty"`

	// CreatedAt Unix timestamp of creation
	CreatedAt *int `json:"created_at,omitempty"`

	// Domain Domain portion of the email address
	Domain *string `json:"domain,omitempty"`

	// Email Full sender email address
	Email *string `json:"email,omitempty"`

	// ForwardedEmailLastReceivedAt Unix timestamp of last forwarded email received (null if never)
	ForwardedEmailLastReceivedAt *int `json:"forwarded_email_last_received_at,omitempty"`

	// ForwardingEnabled Whether email forwarding is active
	ForwardingEnabled *bool `json:"forwarding_enabled,omitempty"`

	// Id Unique email setting identifier
	Id *string `json:"id,omitempty"`

	// Type The type of object
	Type *string `json:"type,omitempty"`

	// UpdatedAt Unix timestamp of last modification
	UpdatedAt *int `json:"updated_at,omitempty"`

	// Verified Whether the email address has been verified
	Verified *bool `json:"verified,omitempty"`
}

EmailSettingSchema Represents a sender email address configuration

type EnqueueCreateTicketJSONBody

type EnqueueCreateTicketJSONBody = CreateTicketRequestSchema

EnqueueCreateTicketJSONBody defines parameters for EnqueueCreateTicket.

type EnqueueCreateTicketJSONRequestBody

type EnqueueCreateTicketJSONRequestBody = EnqueueCreateTicketJSONBody

EnqueueCreateTicketJSONRequestBody defines body for EnqueueCreateTicket for application/json ContentType.

type EnqueueCreateTicketParams

type EnqueueCreateTicketParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

EnqueueCreateTicketParams defines parameters for EnqueueCreateTicket.

type EnqueueCreateTicketResponse

type EnqueueCreateTicketResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *JobsSchema
	JSON400      *ErrorSchema
	JSON401      *ErrorSchema
}

func ParseEnqueueCreateTicketResponse

func ParseEnqueueCreateTicketResponse(rsp *http.Response) (*EnqueueCreateTicketResponse, error)

ParseEnqueueCreateTicketResponse parses an HTTP response from a EnqueueCreateTicketWithResponse call

func (EnqueueCreateTicketResponse) Status

Status returns HTTPResponse.Status

func (EnqueueCreateTicketResponse) StatusCode

func (r EnqueueCreateTicketResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ErrorSchema

type ErrorSchema struct {
	// Errors An array of one or more error objects
	Errors []struct {
		// Code A string indicating the kind of error, used to further qualify the HTTP response code
		Code string `json:"code"`

		// Field Optional. Used to identify a particular field or query parameter that was in error.
		Field *string `json:"field,omitempty"`

		// Message Optional. Human readable description of the error.
		Message *string `json:"message,omitempty"`
	} `json:"errors"`
	RequestId *openapi_types.UUID `json:"request_id,omitempty"`

	// Type The type is error.list
	Type string `json:"type"`
}

ErrorSchema The API will return an Error List for a failed request, which will contain one or more Error objects.

type EventDetailsSchema

type EventDetailsSchema struct {
	// contains filtered or unexported fields
}

EventDetailsSchema defines model for event_details.

func (EventDetailsSchema) AsConversationAttributeUpdatedByAdminSchema

func (t EventDetailsSchema) AsConversationAttributeUpdatedByAdminSchema() (ConversationAttributeUpdatedByAdminSchema, error)

AsConversationAttributeUpdatedByAdminSchema returns the union data inside the EventDetailsSchema as a ConversationAttributeUpdatedByAdminSchema

func (EventDetailsSchema) AsConversationAttributeUpdatedByUserSchema

func (t EventDetailsSchema) AsConversationAttributeUpdatedByUserSchema() (ConversationAttributeUpdatedByUserSchema, error)

AsConversationAttributeUpdatedByUserSchema returns the union data inside the EventDetailsSchema as a ConversationAttributeUpdatedByUserSchema

func (EventDetailsSchema) AsConversationAttributeUpdatedByWorkflowSchema

func (t EventDetailsSchema) AsConversationAttributeUpdatedByWorkflowSchema() (ConversationAttributeUpdatedByWorkflowSchema, error)

AsConversationAttributeUpdatedByWorkflowSchema returns the union data inside the EventDetailsSchema as a ConversationAttributeUpdatedByWorkflowSchema

func (EventDetailsSchema) AsCustomActionFinishedSchema

func (t EventDetailsSchema) AsCustomActionFinishedSchema() (CustomActionFinishedSchema, error)

AsCustomActionFinishedSchema returns the union data inside the EventDetailsSchema as a CustomActionFinishedSchema

func (EventDetailsSchema) AsCustomActionStartedSchema

func (t EventDetailsSchema) AsCustomActionStartedSchema() (CustomActionStartedSchema, error)

AsCustomActionStartedSchema returns the union data inside the EventDetailsSchema as a CustomActionStartedSchema

func (EventDetailsSchema) AsOperatorWorkflowEventSchema

func (t EventDetailsSchema) AsOperatorWorkflowEventSchema() (OperatorWorkflowEventSchema, error)

AsOperatorWorkflowEventSchema returns the union data inside the EventDetailsSchema as a OperatorWorkflowEventSchema

func (*EventDetailsSchema) FromConversationAttributeUpdatedByAdminSchema

func (t *EventDetailsSchema) FromConversationAttributeUpdatedByAdminSchema(v ConversationAttributeUpdatedByAdminSchema) error

FromConversationAttributeUpdatedByAdminSchema overwrites any union data inside the EventDetailsSchema as the provided ConversationAttributeUpdatedByAdminSchema

func (*EventDetailsSchema) FromConversationAttributeUpdatedByUserSchema

func (t *EventDetailsSchema) FromConversationAttributeUpdatedByUserSchema(v ConversationAttributeUpdatedByUserSchema) error

FromConversationAttributeUpdatedByUserSchema overwrites any union data inside the EventDetailsSchema as the provided ConversationAttributeUpdatedByUserSchema

func (*EventDetailsSchema) FromConversationAttributeUpdatedByWorkflowSchema

func (t *EventDetailsSchema) FromConversationAttributeUpdatedByWorkflowSchema(v ConversationAttributeUpdatedByWorkflowSchema) error

FromConversationAttributeUpdatedByWorkflowSchema overwrites any union data inside the EventDetailsSchema as the provided ConversationAttributeUpdatedByWorkflowSchema

func (*EventDetailsSchema) FromCustomActionFinishedSchema

func (t *EventDetailsSchema) FromCustomActionFinishedSchema(v CustomActionFinishedSchema) error

FromCustomActionFinishedSchema overwrites any union data inside the EventDetailsSchema as the provided CustomActionFinishedSchema

func (*EventDetailsSchema) FromCustomActionStartedSchema

func (t *EventDetailsSchema) FromCustomActionStartedSchema(v CustomActionStartedSchema) error

FromCustomActionStartedSchema overwrites any union data inside the EventDetailsSchema as the provided CustomActionStartedSchema

func (*EventDetailsSchema) FromOperatorWorkflowEventSchema

func (t *EventDetailsSchema) FromOperatorWorkflowEventSchema(v OperatorWorkflowEventSchema) error

FromOperatorWorkflowEventSchema overwrites any union data inside the EventDetailsSchema as the provided OperatorWorkflowEventSchema

func (EventDetailsSchema) MarshalJSON

func (t EventDetailsSchema) MarshalJSON() ([]byte, error)

func (*EventDetailsSchema) MergeConversationAttributeUpdatedByAdminSchema

func (t *EventDetailsSchema) MergeConversationAttributeUpdatedByAdminSchema(v ConversationAttributeUpdatedByAdminSchema) error

MergeConversationAttributeUpdatedByAdminSchema performs a merge with any union data inside the EventDetailsSchema, using the provided ConversationAttributeUpdatedByAdminSchema

func (*EventDetailsSchema) MergeConversationAttributeUpdatedByUserSchema

func (t *EventDetailsSchema) MergeConversationAttributeUpdatedByUserSchema(v ConversationAttributeUpdatedByUserSchema) error

MergeConversationAttributeUpdatedByUserSchema performs a merge with any union data inside the EventDetailsSchema, using the provided ConversationAttributeUpdatedByUserSchema

func (*EventDetailsSchema) MergeConversationAttributeUpdatedByWorkflowSchema

func (t *EventDetailsSchema) MergeConversationAttributeUpdatedByWorkflowSchema(v ConversationAttributeUpdatedByWorkflowSchema) error

MergeConversationAttributeUpdatedByWorkflowSchema performs a merge with any union data inside the EventDetailsSchema, using the provided ConversationAttributeUpdatedByWorkflowSchema

func (*EventDetailsSchema) MergeCustomActionFinishedSchema

func (t *EventDetailsSchema) MergeCustomActionFinishedSchema(v CustomActionFinishedSchema) error

MergeCustomActionFinishedSchema performs a merge with any union data inside the EventDetailsSchema, using the provided CustomActionFinishedSchema

func (*EventDetailsSchema) MergeCustomActionStartedSchema

func (t *EventDetailsSchema) MergeCustomActionStartedSchema(v CustomActionStartedSchema) error

MergeCustomActionStartedSchema performs a merge with any union data inside the EventDetailsSchema, using the provided CustomActionStartedSchema

func (*EventDetailsSchema) MergeOperatorWorkflowEventSchema

func (t *EventDetailsSchema) MergeOperatorWorkflowEventSchema(v OperatorWorkflowEventSchema) error

MergeOperatorWorkflowEventSchema performs a merge with any union data inside the EventDetailsSchema, using the provided OperatorWorkflowEventSchema

func (*EventDetailsSchema) UnmarshalJSON

func (t *EventDetailsSchema) UnmarshalJSON(b []byte) error

type ExportWorkflowParams

type ExportWorkflowParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ExportWorkflowParams defines parameters for ExportWorkflow.

type ExportWorkflowResponse

type ExportWorkflowResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *WorkflowExportSchema
	JSON403      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseExportWorkflowResponse

func ParseExportWorkflowResponse(rsp *http.Response) (*ExportWorkflowResponse, error)

ParseExportWorkflowResponse parses an HTTP response from a ExportWorkflowWithResponse call

func (ExportWorkflowResponse) Status

func (r ExportWorkflowResponse) Status() string

Status returns HTTPResponse.Status

func (ExportWorkflowResponse) StatusCode

func (r ExportWorkflowResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ExternalPageLocale

type ExternalPageLocale string

ExternalPageLocale Always en

const (
	ExternalPageLocaleEn ExternalPageLocale = "en"
)

Defines values for ExternalPageLocale.

func (ExternalPageLocale) Valid

func (e ExternalPageLocale) Valid() bool

Valid indicates whether the value is a known member of the ExternalPageLocale enum.

type ExternalPageSchema

type ExternalPageSchema struct {
	// AiAgentAvailability Whether the external page should be used to answer questions by AI Agent.
	AiAgentAvailability bool `json:"ai_agent_availability"`

	// AiCopilotAvailability Whether the external page should be used to answer questions by AI Copilot.
	AiCopilotAvailability bool `json:"ai_copilot_availability"`

	// AiSalesAgentAvailability Whether the external page should be used to answer questions by AI Sales Agent.
	AiSalesAgentAvailability *bool `json:"ai_sales_agent_availability,omitempty"`

	// CreatedAt The time when the external page was created.
	CreatedAt int `json:"created_at"`

	// ExternalId The identifier for the external page which was given by the source. Must be unique for the source.
	ExternalId string `json:"external_id"`

	// FinAvailability Deprecated. Use ai_agent_availability and ai_copilot_availability instead.
	FinAvailability *bool `json:"fin_availability,omitempty"`

	// Html The body of the external page in HTML.
	Html string `json:"html"`

	// Id The unique identifier for the external page which is given by Intercom.
	Id string `json:"id"`

	// LastIngestedAt The time when the external page was last ingested.
	LastIngestedAt int `json:"last_ingested_at"`

	// Locale Always en
	Locale ExternalPageLocale `json:"locale"`

	// SourceId The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response.
	SourceId int `json:"source_id"`

	// Title The title of the external page.
	Title string `json:"title"`

	// Type Always external_page
	Type ExternalPageType `json:"type"`

	// UpdatedAt The time when the external page was last updated.
	UpdatedAt int `json:"updated_at"`

	// Url The URL of the external page. This will be used by Fin to link end users to the page it based its answer on.
	Url *string `json:"url,omitempty"`
}

ExternalPageSchema External pages that you have added to your Fin Content Library.

type ExternalPageType

type ExternalPageType string

ExternalPageType Always external_page

const (
	ExternalPage ExternalPageType = "external_page"
)

Defines values for ExternalPageType.

func (ExternalPageType) Valid

func (e ExternalPageType) Valid() bool

Valid indicates whether the value is a known member of the ExternalPageType enum.

type ExternalPagesListSchema

type ExternalPagesListSchema struct {
	// Data An array of External Page objects
	Data  *[]ExternalPageSchema `json:"data,omitempty"`
	Pages *PagesLinkSchema      `json:"pages,omitempty"`

	// TotalCount A count of the total number of external pages.
	TotalCount *int `json:"total_count,omitempty"`

	// Type The type of the object - `list`.
	Type *ExternalPagesListType `json:"type,omitempty"`
}

ExternalPagesListSchema This will return a list of external pages for the App.

type ExternalPagesListType

type ExternalPagesListType string

ExternalPagesListType The type of the object - `list`.

const (
	ExternalPagesListTypeList ExternalPagesListType = "list"
)

Defines values for ExternalPagesListType.

func (ExternalPagesListType) Valid

func (e ExternalPagesListType) Valid() bool

Valid indicates whether the value is a known member of the ExternalPagesListType enum.

type FileAttributeSchema

type FileAttributeSchema struct {
	// ContentType The type of file
	ContentType *string `json:"content_type,omitempty"`

	// Filesize The size of the file in bytes
	Filesize *int `json:"filesize,omitempty"`

	// Height The height of the file in pixels, if applicable
	Height *int `json:"height,omitempty"`

	// Name The name of the file
	Name *string `json:"name,omitempty"`
	Type *string `json:"type,omitempty"`

	// Url The url of the file. This is a temporary URL and will expire after 30 minutes.
	Url *string `json:"url,omitempty"`

	// Width The width of the file in pixels, if applicable
	Width *int `json:"width,omitempty"`
}

FileAttributeSchema The value describing a file upload set for a custom attribute

type FinAgentAttachmentSchema

type FinAgentAttachmentSchema struct {
	// ContentType The MIME type of the file. Required when type is 'file'.
	ContentType *string `json:"content_type,omitempty"`

	// Data Base64-encoded file data. Required when type is 'file'.
	Data *[]byte `json:"data,omitempty"`

	// Name The name of the file. Required when type is 'file'.
	Name *string `json:"name,omitempty"`

	// Type The type of attachment.
	Type FinAgentAttachmentType `json:"type"`

	// Url The URL of the attachment. Required when type is 'url'. Must be publicly accessible.
	Url *string `json:"url,omitempty"`
}

FinAgentAttachmentSchema An attachment object representing a file or URL attachment included with a message. Attachments can be used to provide additional context to Fin. Maximum of 10 attachments per request.

type FinAgentAttachmentType

type FinAgentAttachmentType string

FinAgentAttachmentType The type of attachment.

const (
	File FinAgentAttachmentType = "file"
	Url  FinAgentAttachmentType = "url"
)

Defines values for FinAgentAttachmentType.

func (FinAgentAttachmentType) Valid

func (e FinAgentAttachmentType) Valid() bool

Valid indicates whether the value is a known member of the FinAgentAttachmentType enum.

type FinAgentAttributeErrorsSchema

type FinAgentAttributeErrorsSchema struct {
	// Conversation Conversation-related attribute errors.
	Conversation *struct {
		// Attributes Map of conversation attribute names to error messages.
		Attributes *map[string]string `json:"attributes,omitempty"`
	} `json:"conversation,omitempty"`

	// User User-related attribute errors.
	User *struct {
		// Attributes Map of user attribute names to error messages.
		Attributes *map[string]string `json:"attributes,omitempty"`
	} `json:"user,omitempty"`
}

FinAgentAttributeErrorsSchema Contains error details if any user or conversation attribute updates failed.

type FinAgentConversationMetadataSchema

type FinAgentConversationMetadataSchema struct {
	// Attributes A hash of attributes associated with the conversation.
	// These attributes can be used by Fin to provide more contextual responses.
	// Limit to 10 attributes.
	Attributes *map[string]interface{} `json:"attributes,omitempty"`

	// History An array of previous messages in the conversation before Fin is initialized.
	// This data provides context to Fin and helps generate a better answer.
	// Limit to the last 10 messages.
	History *[]FinAgentMessageSchema `json:"history,omitempty"`
}

FinAgentConversationMetadataSchema Metadata about the conversation, including history and attributes.

type FinAgentMessageAuthor

type FinAgentMessageAuthor string

FinAgentMessageAuthor The author that created the message.

const (
	FinAgentMessageAuthorAgent FinAgentMessageAuthor = "agent"
	FinAgentMessageAuthorFin   FinAgentMessageAuthor = "fin"
	FinAgentMessageAuthorUser  FinAgentMessageAuthor = "user"
)

Defines values for FinAgentMessageAuthor.

func (FinAgentMessageAuthor) Valid

func (e FinAgentMessageAuthor) Valid() bool

Valid indicates whether the value is a known member of the FinAgentMessageAuthor enum.

type FinAgentMessageSchema

type FinAgentMessageSchema struct {
	// Author The author that created the message.
	Author FinAgentMessageAuthor `json:"author"`

	// Body The body of the message. Accepts both plain text and HTML format.
	// When sending a message to Fin, this should contain the user's message.
	// Fin's response will be returned as HTML.
	Body string `json:"body"`

	// Timestamp The timestamp when the message was created.
	// Used to deduplicate messages sent within a 5 minute window.
	// Ideally should include milliseconds for higher precision.
	Timestamp time.Time `json:"timestamp"`

	// TimestampMs The timestamp when the message was created, with millisecond precision.
	// Only present in webhook event responses (fin_replied).
	TimestampMs *time.Time `json:"timestamp_ms,omitempty"`
}

FinAgentMessageSchema A message exchanged within a Fin Agent conversation.

type FinAgentRepliedEventEventName

type FinAgentRepliedEventEventName string

FinAgentRepliedEventEventName The name of the event.

const (
	FinReplied FinAgentRepliedEventEventName = "fin_replied"
)

Defines values for FinAgentRepliedEventEventName.

func (FinAgentRepliedEventEventName) Valid

Valid indicates whether the value is a known member of the FinAgentRepliedEventEventName enum.

type FinAgentRepliedEventMessageAuthor

type FinAgentRepliedEventMessageAuthor string

FinAgentRepliedEventMessageAuthor The author of the message (always 'fin' for this event).

const (
	Fin FinAgentRepliedEventMessageAuthor = "fin"
)

Defines values for FinAgentRepliedEventMessageAuthor.

func (FinAgentRepliedEventMessageAuthor) Valid

Valid indicates whether the value is a known member of the FinAgentRepliedEventMessageAuthor enum.

type FinAgentRepliedEventSchema

type FinAgentRepliedEventSchema struct {
	// ConversationId The ID of the conversation.
	ConversationId string `json:"conversation_id"`

	// CreatedAtMs The timestamp the event was created at, with millisecond precision.
	CreatedAtMs time.Time `json:"created_at_ms"`

	// EventName The name of the event.
	EventName FinAgentRepliedEventEventName `json:"event_name"`

	// Message Fin's answer to the user's query.
	Message struct {
		// Author The author of the message (always 'fin' for this event).
		Author FinAgentRepliedEventMessageAuthor `json:"author"`

		// Body The HTML body of Fin's response.
		Body string `json:"body"`

		// Id A unique identifier for this message.
		Id *string `json:"id,omitempty"`

		// TimestampMs The timestamp the message was created at, with millisecond precision.
		TimestampMs time.Time `json:"timestamp_ms"`
	} `json:"message"`

	// Status Fin's current status (always 'awaiting_user_reply' for this event).
	Status FinAgentRepliedEventStatus `json:"status"`

	// StreamId Optional. Present when the reply was generated via streaming.
	// Correlates this event with the fin_reply_chunk events that preceded it.
	// Use this to know when to replace streamed chunk_text with the final message body.
	StreamId *string `json:"stream_id,omitempty"`

	// UserId The ID of the user.
	UserId string `json:"user_id"`
}

FinAgentRepliedEventSchema Event fired when Fin replies to a user. Delivered via webhooks or SSE. The content of the response will be contained in the message object. Fin's status will update to 'awaiting_user_reply'.

type FinAgentRepliedEventStatus

type FinAgentRepliedEventStatus string

FinAgentRepliedEventStatus Fin's current status (always 'awaiting_user_reply' for this event).

const (
	AwaitingUserReply FinAgentRepliedEventStatus = "awaiting_user_reply"
)

Defines values for FinAgentRepliedEventStatus.

func (FinAgentRepliedEventStatus) Valid

func (e FinAgentRepliedEventStatus) Valid() bool

Valid indicates whether the value is a known member of the FinAgentRepliedEventStatus enum.

type FinAgentReplyChunkEventEventName

type FinAgentReplyChunkEventEventName string

FinAgentReplyChunkEventEventName The name of the event.

const (
	FinReplyChunk FinAgentReplyChunkEventEventName = "fin_reply_chunk"
)

Defines values for FinAgentReplyChunkEventEventName.

func (FinAgentReplyChunkEventEventName) Valid

Valid indicates whether the value is a known member of the FinAgentReplyChunkEventEventName enum.

type FinAgentReplyChunkEventSchema

type FinAgentReplyChunkEventSchema struct {
	// ChunkIndex 0-based counter for this chunk within the stream. Contiguous.
	ChunkIndex int `json:"chunk_index"`

	// ChunkText The full accumulated plain text of Fin's answer so far.
	// Each chunk supersedes the previous — replace rather than append.
	ChunkText string `json:"chunk_text"`

	// ConversationId The ID of the conversation.
	ConversationId string `json:"conversation_id"`

	// CreatedAtMs The timestamp the event was created at, with millisecond precision.
	CreatedAtMs time.Time `json:"created_at_ms"`

	// EventName The name of the event.
	EventName FinAgentReplyChunkEventEventName `json:"event_name"`

	// Status Fin's current status (always 'replying' for this event).
	Status *FinAgentReplyChunkEventStatus `json:"status,omitempty"`

	// StreamId A unique identifier for this streaming response.
	// Correlates chunks with each other and with the eventual fin_replied event.
	StreamId string `json:"stream_id"`
}

FinAgentReplyChunkEventSchema SSE-only event fired during streaming reply generation. Each chunk contains the full accumulated plain text of Fin's answer so far (cumulative, not a delta). Only delivered over SSE when streaming is enabled. Not available via webhooks. When the fin_replied event arrives with the same stream_id, replace streamed text with the final HTML body.

type FinAgentReplyChunkEventStatus

type FinAgentReplyChunkEventStatus string

FinAgentReplyChunkEventStatus Fin's current status (always 'replying' for this event).

const (
	Replying FinAgentReplyChunkEventStatus = "replying"
)

Defines values for FinAgentReplyChunkEventStatus.

func (FinAgentReplyChunkEventStatus) Valid

Valid indicates whether the value is a known member of the FinAgentReplyChunkEventStatus enum.

type FinAgentStatusUpdatedEventEventName

type FinAgentStatusUpdatedEventEventName string

FinAgentStatusUpdatedEventEventName The name of the event.

const (
	FinStatusUpdated FinAgentStatusUpdatedEventEventName = "fin_status_updated"
)

Defines values for FinAgentStatusUpdatedEventEventName.

func (FinAgentStatusUpdatedEventEventName) Valid

Valid indicates whether the value is a known member of the FinAgentStatusUpdatedEventEventName enum.

type FinAgentStatusUpdatedEventSchema

type FinAgentStatusUpdatedEventSchema struct {
	// ConversationId The ID of the conversation.
	ConversationId string `json:"conversation_id"`

	// CreatedAtMs The timestamp the event was created at, with millisecond precision.
	CreatedAtMs time.Time `json:"created_at_ms"`

	// EventName The name of the event.
	EventName FinAgentStatusUpdatedEventEventName `json:"event_name"`

	// Reason Optional. A human-readable explanation of why the conversation was escalated.
	// Only present when status is 'escalated'.
	// Possible values include:
	// - "Escalation requested by user"
	// - "Escalation rule: {rule_name}"
	// - "Escalation rule matched"
	// - "Routed to team"
	// - "Conversation finished without resolution"
	Reason *string `json:"reason,omitempty"`

	// Status Fin's current status.
	// - escalated: The conversation has been escalated to a human
	// - resolved: The user's query has been resolved
	// - complete: Fin has completed its workflow
	Status FinAgentStatusUpdatedEventStatus `json:"status"`

	// UserId The ID of the user.
	UserId string `json:"user_id"`
}

FinAgentStatusUpdatedEventSchema Event fired when Fin's status changes during a conversation. Delivered via webhooks or SSE. Fin will report its status to the client via this event.

type FinAgentStatusUpdatedEventStatus

type FinAgentStatusUpdatedEventStatus string

FinAgentStatusUpdatedEventStatus Fin's current status. - escalated: The conversation has been escalated to a human - resolved: The user's query has been resolved - complete: Fin has completed its workflow

const (
	FinAgentStatusUpdatedEventStatusComplete  FinAgentStatusUpdatedEventStatus = "complete"
	FinAgentStatusUpdatedEventStatusEscalated FinAgentStatusUpdatedEventStatus = "escalated"
	FinAgentStatusUpdatedEventStatusResolved  FinAgentStatusUpdatedEventStatus = "resolved"
)

Defines values for FinAgentStatusUpdatedEventStatus.

func (FinAgentStatusUpdatedEventStatus) Valid

Valid indicates whether the value is a known member of the FinAgentStatusUpdatedEventStatus enum.

type FinAgentUserSchema

type FinAgentUserSchema struct {
	// Attributes A hash of attributes associated with the user.
	// Attributes can be used by Fin to target content and responses.
	// Limit to 10 attributes.
	Attributes *map[string]interface{} `json:"attributes,omitempty"`

	// Email The email of the user.
	Email *openapi_types.Email `json:"email,omitempty"`

	// Id The ID of the user. This value will be used to uniquely identify the user
	// during a conversation with Fin. Maps to the user_id field on the Intercom User object.
	Id string `json:"id"`

	// Name The name of the user.
	Name *string `json:"name,omitempty"`
}

FinAgentUserSchema A user object representing the user in a Fin Agent conversation.

type FindTagParams

type FindTagParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

FindTagParams defines parameters for FindTag.

type FindTagResponse

type FindTagResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TagBasicSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseFindTagResponse

func ParseFindTagResponse(rsp *http.Response) (*FindTagResponse, error)

ParseFindTagResponse parses an HTTP response from a FindTagWithResponse call

func (FindTagResponse) Status

func (r FindTagResponse) Status() string

Status returns HTTPResponse.Status

func (FindTagResponse) StatusCode

func (r FindTagResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetContentImportSourceParams

type GetContentImportSourceParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

GetContentImportSourceParams defines parameters for GetContentImportSource.

type GetContentImportSourceResponse

type GetContentImportSourceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ContentImportSourceSchema
	JSON401      *ErrorSchema
}

func ParseGetContentImportSourceResponse

func ParseGetContentImportSourceResponse(rsp *http.Response) (*GetContentImportSourceResponse, error)

ParseGetContentImportSourceResponse parses an HTTP response from a GetContentImportSourceWithResponse call

func (GetContentImportSourceResponse) Status

Status returns HTTPResponse.Status

func (GetContentImportSourceResponse) StatusCode

func (r GetContentImportSourceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetCustomObjectInstancesByExternalIdParams

type GetCustomObjectInstancesByExternalIdParams struct {
	ExternalId      string           `form:"external_id" json:"external_id"`
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

GetCustomObjectInstancesByExternalIdParams defines parameters for GetCustomObjectInstancesByExternalId.

type GetCustomObjectInstancesByExternalIdResponse

type GetCustomObjectInstancesByExternalIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CustomObjectInstanceSchema
	JSON401      *Unauthorized
	JSON404      *ObjectNotFound
}

func ParseGetCustomObjectInstancesByExternalIdResponse

func ParseGetCustomObjectInstancesByExternalIdResponse(rsp *http.Response) (*GetCustomObjectInstancesByExternalIdResponse, error)

ParseGetCustomObjectInstancesByExternalIdResponse parses an HTTP response from a GetCustomObjectInstancesByExternalIdWithResponse call

func (GetCustomObjectInstancesByExternalIdResponse) Status

Status returns HTTPResponse.Status

func (GetCustomObjectInstancesByExternalIdResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetCustomObjectInstancesByIdParams

type GetCustomObjectInstancesByIdParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

GetCustomObjectInstancesByIdParams defines parameters for GetCustomObjectInstancesById.

type GetCustomObjectInstancesByIdResponse

type GetCustomObjectInstancesByIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CustomObjectInstanceSchema
	JSON401      *Unauthorized
	JSON404      *ObjectNotFound
}

func ParseGetCustomObjectInstancesByIdResponse

func ParseGetCustomObjectInstancesByIdResponse(rsp *http.Response) (*GetCustomObjectInstancesByIdResponse, error)

ParseGetCustomObjectInstancesByIdResponse parses an HTTP response from a GetCustomObjectInstancesByIdWithResponse call

func (GetCustomObjectInstancesByIdResponse) Status

Status returns HTTPResponse.Status

func (GetCustomObjectInstancesByIdResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetDataExportParams

type GetDataExportParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

GetDataExportParams defines parameters for GetDataExport.

type GetDataExportResponse

type GetDataExportResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DataExportSchema
}

func ParseGetDataExportResponse

func ParseGetDataExportResponse(rsp *http.Response) (*GetDataExportResponse, error)

ParseGetDataExportResponse parses an HTTP response from a GetDataExportWithResponse call

func (GetDataExportResponse) Status

func (r GetDataExportResponse) Status() string

Status returns HTTPResponse.Status

func (GetDataExportResponse) StatusCode

func (r GetDataExportResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetDownloadReportingDataJobIdentifierParams

type GetDownloadReportingDataJobIdentifierParams struct {
	AppId           string           `form:"app_id" json:"app_id"`
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`

	// Accept Required header for downloading the export file
	Accept GetDownloadReportingDataJobIdentifierParamsAccept `json:"Accept"`
}

GetDownloadReportingDataJobIdentifierParams defines parameters for GetDownloadReportingDataJobIdentifier.

type GetDownloadReportingDataJobIdentifierParamsAccept

type GetDownloadReportingDataJobIdentifierParamsAccept string

GetDownloadReportingDataJobIdentifierParamsAccept defines parameters for GetDownloadReportingDataJobIdentifier.

const (
	ApplicationoctetStream GetDownloadReportingDataJobIdentifierParamsAccept = "application/octet-stream"
)

Defines values for GetDownloadReportingDataJobIdentifierParamsAccept.

func (GetDownloadReportingDataJobIdentifierParamsAccept) Valid

Valid indicates whether the value is a known member of the GetDownloadReportingDataJobIdentifierParamsAccept enum.

type GetDownloadReportingDataJobIdentifierResponse

type GetDownloadReportingDataJobIdentifierResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON404      *ErrorSchema
}

func ParseGetDownloadReportingDataJobIdentifierResponse

func ParseGetDownloadReportingDataJobIdentifierResponse(rsp *http.Response) (*GetDownloadReportingDataJobIdentifierResponse, error)

ParseGetDownloadReportingDataJobIdentifierResponse parses an HTTP response from a GetDownloadReportingDataJobIdentifierWithResponse call

func (GetDownloadReportingDataJobIdentifierResponse) Status

Status returns HTTPResponse.Status

func (GetDownloadReportingDataJobIdentifierResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetExportReportingDataGetDatasetsParams

type GetExportReportingDataGetDatasetsParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

GetExportReportingDataGetDatasetsParams defines parameters for GetExportReportingDataGetDatasets.

type GetExportReportingDataGetDatasetsResponse

type GetExportReportingDataGetDatasetsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data *[]struct {
			Attributes *[]struct {
				Id   *string `json:"id,omitempty"`
				Name *string `json:"name,omitempty"`
			} `json:"attributes,omitempty"`
			DefaultTimeAttributeId *string `json:"default_time_attribute_id,omitempty"`
			Description            *string `json:"description,omitempty"`
			Id                     *string `json:"id,omitempty"`
			Name                   *string `json:"name,omitempty"`
		} `json:"data,omitempty"`
		Type *string `json:"type,omitempty"`
	}
}

func ParseGetExportReportingDataGetDatasetsResponse

func ParseGetExportReportingDataGetDatasetsResponse(rsp *http.Response) (*GetExportReportingDataGetDatasetsResponse, error)

ParseGetExportReportingDataGetDatasetsResponse parses an HTTP response from a GetExportReportingDataGetDatasetsWithResponse call

func (GetExportReportingDataGetDatasetsResponse) Status

Status returns HTTPResponse.Status

func (GetExportReportingDataGetDatasetsResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetExportReportingDataJobIdentifierParams

type GetExportReportingDataJobIdentifierParams struct {
	// AppId The Intercom defined code of the workspace the company is associated to.
	AppId           string           `form:"app_id" json:"app_id"`
	ClientId        string           `form:"client_id" json:"client_id"`
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

GetExportReportingDataJobIdentifierParams defines parameters for GetExportReportingDataJobIdentifier.

type GetExportReportingDataJobIdentifierResponse

type GetExportReportingDataJobIdentifierResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		DownloadExpiresAt *string `json:"download_expires_at,omitempty"`
		DownloadUrl       *string `json:"download_url,omitempty"`
		JobIdentifier     *string `json:"job_identifier,omitempty"`
		Status            *string `json:"status,omitempty"`
	}
	JSON404 *ErrorSchema
}

func ParseGetExportReportingDataJobIdentifierResponse

func ParseGetExportReportingDataJobIdentifierResponse(rsp *http.Response) (*GetExportReportingDataJobIdentifierResponse, error)

ParseGetExportReportingDataJobIdentifierResponse parses an HTTP response from a GetExportReportingDataJobIdentifierWithResponse call

func (GetExportReportingDataJobIdentifierResponse) Status

Status returns HTTPResponse.Status

func (GetExportReportingDataJobIdentifierResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetExternalPageParams

type GetExternalPageParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

GetExternalPageParams defines parameters for GetExternalPage.

type GetExternalPageResponse

type GetExternalPageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ExternalPageSchema
	JSON401      *ErrorSchema
}

func ParseGetExternalPageResponse

func ParseGetExternalPageResponse(rsp *http.Response) (*GetExternalPageResponse, error)

ParseGetExternalPageResponse parses an HTTP response from a GetExternalPageWithResponse call

func (GetExternalPageResponse) Status

func (r GetExternalPageResponse) Status() string

Status returns HTTPResponse.Status

func (GetExternalPageResponse) StatusCode

func (r GetExternalPageResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetIpAllowlistParams

type GetIpAllowlistParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

GetIpAllowlistParams defines parameters for GetIpAllowlist.

type GetIpAllowlistResponse

type GetIpAllowlistResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *IpAllowlistSchema
	JSON401      *ErrorSchema
}

func ParseGetIpAllowlistResponse

func ParseGetIpAllowlistResponse(rsp *http.Response) (*GetIpAllowlistResponse, error)

ParseGetIpAllowlistResponse parses an HTTP response from a GetIpAllowlistWithResponse call

func (GetIpAllowlistResponse) Status

func (r GetIpAllowlistResponse) Status() string

Status returns HTTPResponse.Status

func (GetIpAllowlistResponse) StatusCode

func (r GetIpAllowlistResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTicketParams

type GetTicketParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

GetTicketParams defines parameters for GetTicket.

type GetTicketResponse

type GetTicketResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TicketSchema
	JSON401      *ErrorSchema
}

func ParseGetTicketResponse

func ParseGetTicketResponse(rsp *http.Response) (*GetTicketResponse, error)

ParseGetTicketResponse parses an HTTP response from a GetTicketWithResponse call

func (GetTicketResponse) Status

func (r GetTicketResponse) Status() string

Status returns HTTPResponse.Status

func (GetTicketResponse) StatusCode

func (r GetTicketResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTicketTypeParams

type GetTicketTypeParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

GetTicketTypeParams defines parameters for GetTicketType.

type GetTicketTypeResponse

type GetTicketTypeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TicketTypeSchema
	JSON401      *ErrorSchema
}

func ParseGetTicketTypeResponse

func ParseGetTicketTypeResponse(rsp *http.Response) (*GetTicketTypeResponse, error)

ParseGetTicketTypeResponse parses an HTTP response from a GetTicketTypeWithResponse call

func (GetTicketTypeResponse) Status

func (r GetTicketTypeResponse) Status() string

Status returns HTTPResponse.Status

func (GetTicketTypeResponse) StatusCode

func (r GetTicketTypeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GroupContentSchema

type GroupContentSchema struct {
	// Description The description of the collection. Only available for collections.
	Description *string `json:"description,omitempty"`

	// Name The name of the collection or section.
	Name *string `json:"name,omitempty"`

	// Type The type of object - `group_content` .
	Type *GroupContentType `json:"type,omitempty"`
}

GroupContentSchema The Content of a Group.

type GroupContentType

type GroupContentType string

GroupContentType The type of object - `group_content` .

const (
	GroupContentTypeGroupContent GroupContentType = "group_content"
	GroupContentTypeLessThannil  GroupContentType = "<nil>"
)

Defines values for GroupContentType.

func (GroupContentType) Valid

func (e GroupContentType) Valid() bool

Valid indicates whether the value is a known member of the GroupContentType enum.

type GroupTranslatedContentSchema

type GroupTranslatedContentSchema struct {
	// Ar The content of the group in Arabic
	Ar *GroupContentSchema `json:"ar,omitempty"`

	// Bg The content of the group in Bulgarian
	Bg *GroupContentSchema `json:"bg,omitempty"`

	// Bs The content of the group in Bosnian
	Bs *GroupContentSchema `json:"bs,omitempty"`

	// Ca The content of the group in Catalan
	Ca *GroupContentSchema `json:"ca,omitempty"`

	// Cs The content of the group in Czech
	Cs *GroupContentSchema `json:"cs,omitempty"`

	// Da The content of the group in Danish
	Da *GroupContentSchema `json:"da,omitempty"`

	// De The content of the group in German
	De *GroupContentSchema `json:"de,omitempty"`

	// El The content of the group in Greek
	El *GroupContentSchema `json:"el,omitempty"`

	// En The content of the group in English
	En *GroupContentSchema `json:"en,omitempty"`

	// Es The content of the group in Spanish
	Es *GroupContentSchema `json:"es,omitempty"`

	// Et The content of the group in Estonian
	Et *GroupContentSchema `json:"et,omitempty"`

	// Fi The content of the group in Finnish
	Fi *GroupContentSchema `json:"fi,omitempty"`

	// Fr The content of the group in French
	Fr *GroupContentSchema `json:"fr,omitempty"`

	// He The content of the group in Hebrew
	He *GroupContentSchema `json:"he,omitempty"`

	// Hr The content of the group in Croatian
	Hr *GroupContentSchema `json:"hr,omitempty"`

	// Hu The content of the group in Hungarian
	Hu *GroupContentSchema `json:"hu,omitempty"`

	// Id The content of the group in Indonesian
	Id *GroupContentSchema `json:"id,omitempty"`

	// It The content of the group in Italian
	It *GroupContentSchema `json:"it,omitempty"`

	// Ja The content of the group in Japanese
	Ja *GroupContentSchema `json:"ja,omitempty"`

	// Ko The content of the group in Korean
	Ko *GroupContentSchema `json:"ko,omitempty"`

	// Lt The content of the group in Lithuanian
	Lt *GroupContentSchema `json:"lt,omitempty"`

	// Lv The content of the group in Latvian
	Lv *GroupContentSchema `json:"lv,omitempty"`

	// Mn The content of the group in Mongolian
	Mn *GroupContentSchema `json:"mn,omitempty"`

	// Nb The content of the group in Norwegian
	Nb *GroupContentSchema `json:"nb,omitempty"`

	// Nl The content of the group in Dutch
	Nl *GroupContentSchema `json:"nl,omitempty"`

	// Pl The content of the group in Polish
	Pl *GroupContentSchema `json:"pl,omitempty"`

	// Pt The content of the group in Portuguese (Portugal)
	Pt *GroupContentSchema `json:"pt,omitempty"`

	// PtBR The content of the group in Portuguese (Brazil)
	PtBR *GroupContentSchema `json:"pt-BR,omitempty"`

	// Ro The content of the group in Romanian
	Ro *GroupContentSchema `json:"ro,omitempty"`

	// Ru The content of the group in Russian
	Ru *GroupContentSchema `json:"ru,omitempty"`

	// Sl The content of the group in Slovenian
	Sl *GroupContentSchema `json:"sl,omitempty"`

	// Sr The content of the group in Serbian
	Sr *GroupContentSchema `json:"sr,omitempty"`

	// Sv The content of the group in Swedish
	Sv *GroupContentSchema `json:"sv,omitempty"`

	// Tr The content of the group in Turkish
	Tr *GroupContentSchema `json:"tr,omitempty"`

	// Type The type of object - group_translated_content.
	Type *GroupTranslatedContentType `json:"type,omitempty"`

	// Vi The content of the group in Vietnamese
	Vi *GroupContentSchema `json:"vi,omitempty"`

	// ZhCN The content of the group in Chinese (China)
	ZhCN *GroupContentSchema `json:"zh-CN,omitempty"`

	// ZhTW The content of the group in Chinese (Taiwan)
	ZhTW *GroupContentSchema `json:"zh-TW,omitempty"`
}

GroupTranslatedContentSchema The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.

type GroupTranslatedContentType

type GroupTranslatedContentType string

GroupTranslatedContentType The type of object - group_translated_content.

const (
	GroupTranslatedContentTypeGroupTranslatedContent GroupTranslatedContentType = "group_translated_content"
	GroupTranslatedContentTypeLessThannil            GroupTranslatedContentType = "<nil>"
)

Defines values for GroupTranslatedContentType.

func (GroupTranslatedContentType) Valid

func (e GroupTranslatedContentType) Valid() bool

Valid indicates whether the value is a known member of the GroupTranslatedContentType enum.

type HandlingEventListSchema

type HandlingEventListSchema struct {
	// HandlingEvents Array of handling events
	HandlingEvents *[]HandlingEventSchema `json:"handling_events,omitempty"`
}

HandlingEventListSchema A list of handling events for a conversation

type HandlingEventSchema

type HandlingEventSchema struct {
	// Reason Optional reason for the event (e.g., "Paused", "Away")
	Reason   *string                 `json:"reason,omitempty"`
	Teammate TeammateReferenceSchema `json:"teammate"`

	// Timestamp ISO8601 timestamp when the event occurred
	Timestamp time.Time `json:"timestamp"`

	// Type The type of handling event
	Type HandlingEventType `json:"type"`
}

HandlingEventSchema A pause or resume event for a conversation

type HandlingEventType

type HandlingEventType string

HandlingEventType The type of handling event

const (
	HandlingEventTypePaused  HandlingEventType = "paused"
	HandlingEventTypeResumed HandlingEventType = "resumed"
)

Defines values for HandlingEventType.

func (HandlingEventType) Valid

func (e HandlingEventType) Valid() bool

Valid indicates whether the value is a known member of the HandlingEventType enum.

type HelpCenterListSchema

type HelpCenterListSchema struct {
	// Data An array of Help Center objects
	Data *[]HelpCenterSchema `json:"data,omitempty"`

	// Type The type of the object - `list`.
	Type *HelpCenterListType `json:"type,omitempty"`
}

HelpCenterListSchema A list of Help Centers belonging to the App

type HelpCenterListType

type HelpCenterListType string

HelpCenterListType The type of the object - `list`.

const (
	HelpCenterListTypeList HelpCenterListType = "list"
)

Defines values for HelpCenterListType.

func (HelpCenterListType) Valid

func (e HelpCenterListType) Valid() bool

Valid indicates whether the value is a known member of the HelpCenterListType enum.

type HelpCenterSchema

type HelpCenterSchema struct {
	// CreatedAt The time when the Help Center was created.
	CreatedAt *int `json:"created_at,omitempty"`

	// CustomDomain Custom domain configured for the help center
	CustomDomain *string `json:"custom_domain,omitempty"`

	// DisplayName The display name of the Help Center only seen by teammates.
	DisplayName *string `json:"display_name,omitempty"`

	// Id The unique identifier for the Help Center which is given by Intercom.
	Id *string `json:"id,omitempty"`

	// Identifier The identifier of the Help Center. This is used in the URL of the Help Center.
	Identifier *string `json:"identifier,omitempty"`

	// UpdatedAt The time when the Help Center was last updated.
	UpdatedAt *int `json:"updated_at,omitempty"`

	// Url The URL for the help center, if you have a custom domain then this will show the URL using the custom domain.
	Url *string `json:"url,omitempty"`

	// WebsiteTurnedOn Whether the Help Center is turned on or not. This is controlled in your Help Center settings.
	WebsiteTurnedOn *bool `json:"website_turned_on,omitempty"`

	// WorkspaceId The id of the workspace which the Help Center belongs to.
	WorkspaceId *string `json:"workspace_id,omitempty"`
}

HelpCenterSchema Help Centers contain collections

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type IdentifyAdminParams

type IdentifyAdminParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

IdentifyAdminParams defines parameters for IdentifyAdmin.

type IdentifyAdminResponse

type IdentifyAdminResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *AdminWithAppSchema
}

func ParseIdentifyAdminResponse

func ParseIdentifyAdminResponse(rsp *http.Response) (*IdentifyAdminResponse, error)

ParseIdentifyAdminResponse parses an HTTP response from a IdentifyAdminWithResponse call

func (IdentifyAdminResponse) Status

func (r IdentifyAdminResponse) Status() string

Status returns HTTPResponse.Status

func (IdentifyAdminResponse) StatusCode

func (r IdentifyAdminResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type IntercomVersion

type IntercomVersion string

IntercomVersion Intercom API version.</br>By default, it's equal to the version set in the app package.

const (
	N10  IntercomVersion = "1.0"
	N11  IntercomVersion = "1.1"
	N12  IntercomVersion = "1.2"
	N13  IntercomVersion = "1.3"
	N14  IntercomVersion = "1.4"
	N20  IntercomVersion = "2.0"
	N21  IntercomVersion = "2.1"
	N210 IntercomVersion = "2.10"
	N211 IntercomVersion = "2.11"
	N212 IntercomVersion = "2.12"
	N213 IntercomVersion = "2.13"
	N214 IntercomVersion = "2.14"
	N215 IntercomVersion = "2.15"
	N22  IntercomVersion = "2.2"
	N23  IntercomVersion = "2.3"
	N24  IntercomVersion = "2.4"
	N25  IntercomVersion = "2.5"
	N26  IntercomVersion = "2.6"
	N27  IntercomVersion = "2.7"
	N28  IntercomVersion = "2.8"
	N29  IntercomVersion = "2.9"
)

Defines values for IntercomVersion.

func (IntercomVersion) Valid

func (e IntercomVersion) Valid() bool

Valid indicates whether the value is a known member of the IntercomVersion enum.

type InternalArticleListItemSchema

type InternalArticleListItemSchema struct {
	// AuthorId The id of the author of the article.
	AuthorId *int `json:"author_id,omitempty"`

	// Body The body of the article in HTML.
	Body *string `json:"body,omitempty"`

	// CreatedAt The time when the article was created.
	CreatedAt *int `json:"created_at,omitempty"`

	// Id The unique identifier for the article which is given by Intercom.
	Id *string `json:"id,omitempty"`

	// Locale The default locale of the article.
	Locale *string `json:"locale,omitempty"`

	// OwnerId The id of the owner of the article.
	OwnerId *int `json:"owner_id,omitempty"`

	// Title The title of the article.
	Title *string `json:"title,omitempty"`

	// Type The type of object - `internal_article`.
	Type *InternalArticleListItemType `json:"type,omitempty"`

	// UpdatedAt The time when the article was last updated.
	UpdatedAt *int `json:"updated_at,omitempty"`
}

InternalArticleListItemSchema The data returned about your internal articles when you list them.

type InternalArticleListItemType

type InternalArticleListItemType string

InternalArticleListItemType The type of object - `internal_article`.

const (
	InternalArticleListItemTypeInternalArticle InternalArticleListItemType = "internal_article"
)

Defines values for InternalArticleListItemType.

func (InternalArticleListItemType) Valid

Valid indicates whether the value is a known member of the InternalArticleListItemType enum.

type InternalArticleListSchema

type InternalArticleListSchema struct {
	// Data An array of Internal Article objects
	Data  *[]InternalArticleListItemSchema `json:"data,omitempty"`
	Pages *CursorPagesSchema               `json:"pages,omitempty"`

	// TotalCount A count of the total number of internal articles.
	TotalCount *int `json:"total_count,omitempty"`

	// Type The type of the object - `list`.
	Type *InternalArticleListType `json:"type,omitempty"`
}

InternalArticleListSchema This will return a list of internal articles for the App.

type InternalArticleListType

type InternalArticleListType string

InternalArticleListType The type of the object - `list`.

const (
	InternalArticleListTypeList InternalArticleListType = "list"
)

Defines values for InternalArticleListType.

func (InternalArticleListType) Valid

func (e InternalArticleListType) Valid() bool

Valid indicates whether the value is a known member of the InternalArticleListType enum.

type InternalArticleSchema

type InternalArticleSchema = InternalArticleListItemSchema

InternalArticleSchema The data returned about your internal articles when you list them.

type InternalArticleSearchResponseSchema

type InternalArticleSearchResponseSchema struct {
	// Data An object containing the results of the search.
	Data *struct {
		// InternalArticles An array of Internal Article objects
		InternalArticles *[]InternalArticleSchema `json:"internal_articles,omitempty"`
	} `json:"data,omitempty"`
	Pages *CursorPagesSchema `json:"pages,omitempty"`

	// TotalCount The total number of Internal Articles matching the search query
	TotalCount *int `json:"total_count,omitempty"`

	// Type The type of the object - `list`.
	Type *InternalArticleSearchResponseType `json:"type,omitempty"`
}

InternalArticleSearchResponseSchema The results of an Internal Article search

type InternalArticleSearchResponseType

type InternalArticleSearchResponseType string

InternalArticleSearchResponseType The type of the object - `list`.

const (
	InternalArticleSearchResponseTypeList InternalArticleSearchResponseType = "list"
)

Defines values for InternalArticleSearchResponseType.

func (InternalArticleSearchResponseType) Valid

Valid indicates whether the value is a known member of the InternalArticleSearchResponseType enum.

type IpAllowlistSchema

type IpAllowlistSchema struct {
	// Enabled Whether the IP allowlist is enabled for the workspace.
	Enabled *bool `json:"enabled,omitempty"`

	// IpAllowlist List of allowed IP addresses and/or IP ranges in CIDR notation.
	// Examples:
	// - Single IP: `192.168.0.1`
	// - IP range: `192.168.0.1/24` (allows 192.168.0.0 - 192.168.0.255)
	IpAllowlist *[]string `json:"ip_allowlist,omitempty"`

	// Type String representing the object's type. Always has the value `ip_allowlist`.
	Type *string `json:"type,omitempty"`
}

IpAllowlistSchema IP allowlist settings for the workspace.

type JobsSchema

type JobsSchema struct {
	// Id The id of the job that's currently being processed or has completed.
	Id string `json:"id"`

	// ResourceId The id of the resource created during job execution (e.g. ticket id)
	ResourceId *string `json:"resource_id,omitempty"`

	// ResourceType The type of resource created during job execution.
	ResourceType *string `json:"resource_type,omitempty"`

	// ResourceUrl The url of the resource created during job exeuction. Use this url to fetch the resource.
	ResourceUrl *string `json:"resource_url,omitempty"`

	// Status The status of the job execution.
	Status *JobsStatus `json:"status,omitempty"`

	// Type The type of the object
	Type *JobsType `json:"type,omitempty"`

	// Url API endpoint URL to check the job status.
	Url *string `json:"url,omitempty"`
}

JobsSchema Jobs are tasks that are processed asynchronously by the Intercom system after being enqueued via the API. This allows for efficient handling of operations that may take time to complete, such as data imports or exports. You can check the status of your jobs to monitor their progress and ensure they are completed successfully.

type JobsStatus

type JobsStatus string

JobsStatus The status of the job execution.

const (
	JobsStatusFailed  JobsStatus = "failed"
	JobsStatusPending JobsStatus = "pending"
	JobsStatusSuccess JobsStatus = "success"
)

Defines values for JobsStatus.

func (JobsStatus) Valid

func (e JobsStatus) Valid() bool

Valid indicates whether the value is a known member of the JobsStatus enum.

type JobsStatusParams

type JobsStatusParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

JobsStatusParams defines parameters for JobsStatus.

type JobsStatusResponse

type JobsStatusResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *JobsSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseJobsStatusResponse

func ParseJobsStatusResponse(rsp *http.Response) (*JobsStatusResponse, error)

ParseJobsStatusResponse parses an HTTP response from a JobsStatusWithResponse call

func (JobsStatusResponse) Status

func (r JobsStatusResponse) Status() string

Status returns HTTPResponse.Status

func (JobsStatusResponse) StatusCode

func (r JobsStatusResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type JobsType

type JobsType string

JobsType The type of the object

const (
	Job JobsType = "job"
)

Defines values for JobsType.

func (JobsType) Valid

func (e JobsType) Valid() bool

Valid indicates whether the value is a known member of the JobsType enum.

type LinkedObjectCategory

type LinkedObjectCategory string

LinkedObjectCategory Category of the Linked Ticket Object.

const (
	LinkedObjectCategoryBackOffice  LinkedObjectCategory = "Back-office"
	LinkedObjectCategoryCustomer    LinkedObjectCategory = "Customer"
	LinkedObjectCategoryLessThannil LinkedObjectCategory = "<nil>"
	LinkedObjectCategoryTracker     LinkedObjectCategory = "Tracker"
)

Defines values for LinkedObjectCategory.

func (LinkedObjectCategory) Valid

func (e LinkedObjectCategory) Valid() bool

Valid indicates whether the value is a known member of the LinkedObjectCategory enum.

type LinkedObjectListSchema

type LinkedObjectListSchema struct {
	// Data An array containing the linked conversations and linked tickets.
	Data *[]LinkedObjectSchema `json:"data,omitempty"`

	// HasMore Whether or not there are more linked objects than returned.
	HasMore *bool `json:"has_more,omitempty"`

	// TotalCount The total number of linked objects.
	TotalCount *int `json:"total_count,omitempty"`

	// Type Always list.
	Type *LinkedObjectListType `json:"type,omitempty"`
}

LinkedObjectListSchema An object containing metadata about linked conversations and linked tickets. Up to 1000 can be returned.

type LinkedObjectListType

type LinkedObjectListType string

LinkedObjectListType Always list.

const (
	LinkedObjectListTypeList LinkedObjectListType = "list"
)

Defines values for LinkedObjectListType.

func (LinkedObjectListType) Valid

func (e LinkedObjectListType) Valid() bool

Valid indicates whether the value is a known member of the LinkedObjectListType enum.

type LinkedObjectSchema

type LinkedObjectSchema struct {
	// Category Category of the Linked Ticket Object.
	Category *LinkedObjectCategory `json:"category,omitempty"`

	// Id The ID of the linked object
	Id *string `json:"id,omitempty"`

	// Type ticket or conversation
	Type *LinkedObjectType `json:"type,omitempty"`
}

LinkedObjectSchema A linked conversation or ticket.

type LinkedObjectType

type LinkedObjectType string

LinkedObjectType ticket or conversation

const (
	LinkedObjectTypeConversation LinkedObjectType = "conversation"
	LinkedObjectTypeTicket       LinkedObjectType = "ticket"
)

Defines values for LinkedObjectType.

func (LinkedObjectType) Valid

func (e LinkedObjectType) Valid() bool

Valid indicates whether the value is a known member of the LinkedObjectType enum.

type LisDataAttributesParams

type LisDataAttributesParams struct {
	// Model Specify the data attribute model to return.
	Model *LisDataAttributesParamsModel `form:"model,omitempty" json:"model,omitempty"`

	// IncludeArchived Include archived attributes in the list. By default we return only non archived data attributes.
	IncludeArchived *bool            `form:"include_archived,omitempty" json:"include_archived,omitempty"`
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

LisDataAttributesParams defines parameters for LisDataAttributes.

type LisDataAttributesParamsModel

type LisDataAttributesParamsModel string

LisDataAttributesParamsModel defines parameters for LisDataAttributes.

const (
	LisDataAttributesParamsModelCompany      LisDataAttributesParamsModel = "company"
	LisDataAttributesParamsModelContact      LisDataAttributesParamsModel = "contact"
	LisDataAttributesParamsModelConversation LisDataAttributesParamsModel = "conversation"
)

Defines values for LisDataAttributesParamsModel.

func (LisDataAttributesParamsModel) Valid

Valid indicates whether the value is a known member of the LisDataAttributesParamsModel enum.

type LisDataAttributesResponse

type LisDataAttributesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DataAttributeListSchema
	JSON401      *ErrorSchema
}

func ParseLisDataAttributesResponse

func ParseLisDataAttributesResponse(rsp *http.Response) (*LisDataAttributesResponse, error)

ParseLisDataAttributesResponse parses an HTTP response from a LisDataAttributesWithResponse call

func (LisDataAttributesResponse) Status

func (r LisDataAttributesResponse) Status() string

Status returns HTTPResponse.Status

func (LisDataAttributesResponse) StatusCode

func (r LisDataAttributesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type LisDataEventsParams

type LisDataEventsParams struct {
	Filter struct {
		// contains filtered or unexported fields
	} `form:"filter" json:"filter"`

	// Type The value must be user
	Type string `form:"type" json:"type"`

	// Summary summary flag
	Summary         *bool            `form:"summary,omitempty" json:"summary,omitempty"`
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

LisDataEventsParams defines parameters for LisDataEvents.

type LisDataEventsParamsFilter0

type LisDataEventsParamsFilter0 struct {
	UserId string `json:"user_id"`
}

LisDataEventsParamsFilter0 defines parameters for LisDataEvents.

type LisDataEventsParamsFilter1

type LisDataEventsParamsFilter1 struct {
	IntercomUserId string `json:"intercom_user_id"`
}

LisDataEventsParamsFilter1 defines parameters for LisDataEvents.

type LisDataEventsParamsFilter2

type LisDataEventsParamsFilter2 struct {
	Email string `json:"email"`
}

LisDataEventsParamsFilter2 defines parameters for LisDataEvents.

type LisDataEventsResponse

type LisDataEventsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DataEventSummarySchema
	JSON401      *ErrorSchema
}

func ParseLisDataEventsResponse

func ParseLisDataEventsResponse(rsp *http.Response) (*LisDataEventsResponse, error)

ParseLisDataEventsResponse parses an HTTP response from a LisDataEventsWithResponse call

func (LisDataEventsResponse) Status

func (r LisDataEventsResponse) Status() string

Status returns HTTPResponse.Status

func (LisDataEventsResponse) StatusCode

func (r LisDataEventsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListActivityLogsParams

type ListActivityLogsParams struct {
	// CreatedAtAfter The start date that you request data for. It must be formatted as a UNIX timestamp.
	CreatedAtAfter string `form:"created_at_after" json:"created_at_after"`

	// CreatedAtBefore The end date that you request data for. It must be formatted as a UNIX timestamp.
	CreatedAtBefore *string          `form:"created_at_before,omitempty" json:"created_at_before,omitempty"`
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListActivityLogsParams defines parameters for ListActivityLogs.

type ListActivityLogsResponse

type ListActivityLogsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ActivityLogListSchema
	JSON401      *ErrorSchema
}

func ParseListActivityLogsResponse

func ParseListActivityLogsResponse(rsp *http.Response) (*ListActivityLogsResponse, error)

ParseListActivityLogsResponse parses an HTTP response from a ListActivityLogsWithResponse call

func (ListActivityLogsResponse) Status

func (r ListActivityLogsResponse) Status() string

Status returns HTTPResponse.Status

func (ListActivityLogsResponse) StatusCode

func (r ListActivityLogsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListAdminsParams

type ListAdminsParams struct {
	// DisplayAvatar If set to true, the response will include the admin's avatar object containing the image URL. Defaults to false.
	DisplayAvatar   *bool            `form:"display_avatar,omitempty" json:"display_avatar,omitempty"`
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListAdminsParams defines parameters for ListAdmins.

type ListAdminsResponse

type ListAdminsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *AdminListSchema
	JSON401      *ErrorSchema
}

func ParseListAdminsResponse

func ParseListAdminsResponse(rsp *http.Response) (*ListAdminsResponse, error)

ParseListAdminsResponse parses an HTTP response from a ListAdminsWithResponse call

func (ListAdminsResponse) Status

func (r ListAdminsResponse) Status() string

Status returns HTTPResponse.Status

func (ListAdminsResponse) StatusCode

func (r ListAdminsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListAllCollectionsParams

type ListAllCollectionsParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListAllCollectionsParams defines parameters for ListAllCollections.

type ListAllCollectionsResponse

type ListAllCollectionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CollectionListSchema
	JSON401      *ErrorSchema
}

func ParseListAllCollectionsResponse

func ParseListAllCollectionsResponse(rsp *http.Response) (*ListAllCollectionsResponse, error)

ParseListAllCollectionsResponse parses an HTTP response from a ListAllCollectionsWithResponse call

func (ListAllCollectionsResponse) Status

Status returns HTTPResponse.Status

func (ListAllCollectionsResponse) StatusCode

func (r ListAllCollectionsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListAllCompaniesParams

type ListAllCompaniesParams struct {
	// Page The page of results to fetch. Defaults to first page
	Page *int `form:"page,omitempty" json:"page,omitempty"`

	// PerPage How many results to return per page. Defaults to 15
	PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"`

	// Order `asc` or `desc`. Return the companies in ascending or descending order. Defaults to desc
	Order           *string          `form:"order,omitempty" json:"order,omitempty"`
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListAllCompaniesParams defines parameters for ListAllCompanies.

type ListAllCompaniesResponse

type ListAllCompaniesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CompanyListSchema
	JSON401      *ErrorSchema
}

func ParseListAllCompaniesResponse

func ParseListAllCompaniesResponse(rsp *http.Response) (*ListAllCompaniesResponse, error)

ParseListAllCompaniesResponse parses an HTTP response from a ListAllCompaniesWithResponse call

func (ListAllCompaniesResponse) Status

func (r ListAllCompaniesResponse) Status() string

Status returns HTTPResponse.Status

func (ListAllCompaniesResponse) StatusCode

func (r ListAllCompaniesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListArticlesParams

type ListArticlesParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListArticlesParams defines parameters for ListArticles.

type ListArticlesResponse

type ListArticlesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ArticleListSchema
	JSON401      *ErrorSchema
}

func ParseListArticlesResponse

func ParseListArticlesResponse(rsp *http.Response) (*ListArticlesResponse, error)

ParseListArticlesResponse parses an HTTP response from a ListArticlesWithResponse call

func (ListArticlesResponse) Status

func (r ListArticlesResponse) Status() string

Status returns HTTPResponse.Status

func (ListArticlesResponse) StatusCode

func (r ListArticlesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListAttachedContactsParams

type ListAttachedContactsParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListAttachedContactsParams defines parameters for ListAttachedContacts.

type ListAttachedContactsResponse

type ListAttachedContactsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CompanyAttachedContactsSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseListAttachedContactsResponse

func ParseListAttachedContactsResponse(rsp *http.Response) (*ListAttachedContactsResponse, error)

ParseListAttachedContactsResponse parses an HTTP response from a ListAttachedContactsWithResponse call

func (ListAttachedContactsResponse) Status

Status returns HTTPResponse.Status

func (ListAttachedContactsResponse) StatusCode

func (r ListAttachedContactsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListAttachedSegmentsForCompaniesParams

type ListAttachedSegmentsForCompaniesParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListAttachedSegmentsForCompaniesParams defines parameters for ListAttachedSegmentsForCompanies.

type ListAttachedSegmentsForCompaniesResponse

type ListAttachedSegmentsForCompaniesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CompanyAttachedSegmentsSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseListAttachedSegmentsForCompaniesResponse

func ParseListAttachedSegmentsForCompaniesResponse(rsp *http.Response) (*ListAttachedSegmentsForCompaniesResponse, error)

ParseListAttachedSegmentsForCompaniesResponse parses an HTTP response from a ListAttachedSegmentsForCompaniesWithResponse call

func (ListAttachedSegmentsForCompaniesResponse) Status

Status returns HTTPResponse.Status

func (ListAttachedSegmentsForCompaniesResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type ListAwayStatusReasonsParams

type ListAwayStatusReasonsParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListAwayStatusReasonsParams defines parameters for ListAwayStatusReasons.

type ListAwayStatusReasonsResponse

type ListAwayStatusReasonsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]AwayStatusReasonSchema
	JSON401      *Unauthorized
}

func ParseListAwayStatusReasonsResponse

func ParseListAwayStatusReasonsResponse(rsp *http.Response) (*ListAwayStatusReasonsResponse, error)

ParseListAwayStatusReasonsResponse parses an HTTP response from a ListAwayStatusReasonsWithResponse call

func (ListAwayStatusReasonsResponse) Status

Status returns HTTPResponse.Status

func (ListAwayStatusReasonsResponse) StatusCode

func (r ListAwayStatusReasonsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListBrandsParams

type ListBrandsParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListBrandsParams defines parameters for ListBrands.

type ListBrandsResponse

type ListBrandsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *BrandListSchema
	JSON401      *ErrorSchema
}

func ParseListBrandsResponse

func ParseListBrandsResponse(rsp *http.Response) (*ListBrandsResponse, error)

ParseListBrandsResponse parses an HTTP response from a ListBrandsWithResponse call

func (ListBrandsResponse) Status

func (r ListBrandsResponse) Status() string

Status returns HTTPResponse.Status

func (ListBrandsResponse) StatusCode

func (r ListBrandsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListCallsParams

type ListCallsParams struct {
	// Page The page of results to fetch. Defaults to first page
	Page *int `form:"page,omitempty" json:"page,omitempty"`

	// PerPage How many results to display per page. Defaults to 25. Max 25.
	PerPage         *int             `form:"per_page,omitempty" json:"per_page,omitempty"`
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListCallsParams defines parameters for ListCalls.

type ListCallsResponse

type ListCallsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CallListSchema
	JSON401      *ErrorSchema
}

func ParseListCallsResponse

func ParseListCallsResponse(rsp *http.Response) (*ListCallsResponse, error)

ParseListCallsResponse parses an HTTP response from a ListCallsWithResponse call

func (ListCallsResponse) Status

func (r ListCallsResponse) Status() string

Status returns HTTPResponse.Status

func (ListCallsResponse) StatusCode

func (r ListCallsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListCallsWithTranscriptsJSONBody

type ListCallsWithTranscriptsJSONBody struct {
	// ConversationIds A list of conversation ids to fetch calls for. Maximum 20.
	ConversationIds []string `json:"conversation_ids"`
}

ListCallsWithTranscriptsJSONBody defines parameters for ListCallsWithTranscripts.

type ListCallsWithTranscriptsJSONRequestBody

type ListCallsWithTranscriptsJSONRequestBody ListCallsWithTranscriptsJSONBody

ListCallsWithTranscriptsJSONRequestBody defines body for ListCallsWithTranscripts for application/json ContentType.

type ListCallsWithTranscriptsParams

type ListCallsWithTranscriptsParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListCallsWithTranscriptsParams defines parameters for ListCallsWithTranscripts.

type ListCallsWithTranscriptsResponse

type ListCallsWithTranscriptsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data *[]struct {
			// AdminId The id of the admin associated with the call, if any.
			AdminId    *string   `json:"admin_id,omitempty"`
			AnsweredAt *Datetime `json:"answered_at,omitempty"`

			// CallType The type of call.
			CallType *string `json:"call_type,omitempty"`

			// ContactId The id of the contact associated with the call, if any.
			ContactId *string `json:"contact_id,omitempty"`

			// ConversationId The id of the conversation associated with the call, if any.
			ConversationId *string   `json:"conversation_id,omitempty"`
			CreatedAt      *Datetime `json:"created_at,omitempty"`

			// Direction The direction of the call.
			Direction *string   `json:"direction,omitempty"`
			EndedAt   *Datetime `json:"ended_at,omitempty"`

			// EndedReason The reason for the call end, if applicable.
			EndedReason *string `json:"ended_reason,omitempty"`

			// FinRecordingUrl API URL to the AI Agent (Fin) call recording if available.
			FinRecordingUrl *string `json:"fin_recording_url,omitempty"`

			// FinTranscriptionUrl API URL to the AI Agent (Fin) call transcript if available.
			FinTranscriptionUrl *string `json:"fin_transcription_url,omitempty"`

			// Id The id of the call.
			Id          *string   `json:"id,omitempty"`
			InitiatedAt *Datetime `json:"initiated_at,omitempty"`

			// Phone The phone number involved in the call, in E.164 format.
			Phone *string `json:"phone,omitempty"`

			// RecordingUrl API URL to download or redirect to the call recording if available.
			RecordingUrl *string `json:"recording_url,omitempty"`

			// State The current state of the call.
			State *string `json:"state,omitempty"`

			// Transcript The call transcript if available, otherwise an empty array.
			Transcript *[]map[string]interface{} `json:"transcript,omitempty"`

			// TranscriptStatus The status of the transcript if available.
			TranscriptStatus *string `json:"transcript_status,omitempty"`

			// TranscriptionUrl API URL to download or redirect to the call transcript if available.
			TranscriptionUrl *string `json:"transcription_url,omitempty"`

			// Type String representing the object's type. Always has the value `call`.
			Type      *string   `json:"type,omitempty"`
			UpdatedAt *Datetime `json:"updated_at,omitempty"`
		} `json:"data,omitempty"`
		Type *string `json:"type,omitempty"`
	}
	JSON400 *ErrorSchema
	JSON401 *ErrorSchema
}

func ParseListCallsWithTranscriptsResponse

func ParseListCallsWithTranscriptsResponse(rsp *http.Response) (*ListCallsWithTranscriptsResponse, error)

ParseListCallsWithTranscriptsResponse parses an HTTP response from a ListCallsWithTranscriptsWithResponse call

func (ListCallsWithTranscriptsResponse) Status

Status returns HTTPResponse.Status

func (ListCallsWithTranscriptsResponse) StatusCode

func (r ListCallsWithTranscriptsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListCompaniesForAContactParams

type ListCompaniesForAContactParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListCompaniesForAContactParams defines parameters for ListCompaniesForAContact.

type ListCompaniesForAContactResponse

type ListCompaniesForAContactResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ContactAttachedCompaniesSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseListCompaniesForAContactResponse

func ParseListCompaniesForAContactResponse(rsp *http.Response) (*ListCompaniesForAContactResponse, error)

ParseListCompaniesForAContactResponse parses an HTTP response from a ListCompaniesForAContactWithResponse call

func (ListCompaniesForAContactResponse) Status

Status returns HTTPResponse.Status

func (ListCompaniesForAContactResponse) StatusCode

func (r ListCompaniesForAContactResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListCompanyNotesParams

type ListCompanyNotesParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListCompanyNotesParams defines parameters for ListCompanyNotes.

type ListCompanyNotesResponse

type ListCompanyNotesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *NoteListSchema
	JSON404      *ErrorSchema
}

func ParseListCompanyNotesResponse

func ParseListCompanyNotesResponse(rsp *http.Response) (*ListCompanyNotesResponse, error)

ParseListCompanyNotesResponse parses an HTTP response from a ListCompanyNotesWithResponse call

func (ListCompanyNotesResponse) Status

func (r ListCompanyNotesResponse) Status() string

Status returns HTTPResponse.Status

func (ListCompanyNotesResponse) StatusCode

func (r ListCompanyNotesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListContactsParams

type ListContactsParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListContactsParams defines parameters for ListContacts.

type ListContactsResponse

type ListContactsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ContactListSchema
	JSON401      *ErrorSchema
}

func ParseListContactsResponse

func ParseListContactsResponse(rsp *http.Response) (*ListContactsResponse, error)

ParseListContactsResponse parses an HTTP response from a ListContactsWithResponse call

func (ListContactsResponse) Status

func (r ListContactsResponse) Status() string

Status returns HTTPResponse.Status

func (ListContactsResponse) StatusCode

func (r ListContactsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListContentImportSourcesParams

type ListContentImportSourcesParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListContentImportSourcesParams defines parameters for ListContentImportSources.

type ListContentImportSourcesResponse

type ListContentImportSourcesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ContentImportSourcesListSchema
	JSON401      *ErrorSchema
}

func ParseListContentImportSourcesResponse

func ParseListContentImportSourcesResponse(rsp *http.Response) (*ListContentImportSourcesResponse, error)

ParseListContentImportSourcesResponse parses an HTTP response from a ListContentImportSourcesWithResponse call

func (ListContentImportSourcesResponse) Status

Status returns HTTPResponse.Status

func (ListContentImportSourcesResponse) StatusCode

func (r ListContentImportSourcesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListConversationsParams

type ListConversationsParams struct {
	// PerPage How many results per page
	PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"`

	// StartingAfter String used to get the next page of conversations.
	StartingAfter   *string          `form:"starting_after,omitempty" json:"starting_after,omitempty"`
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListConversationsParams defines parameters for ListConversations.

type ListConversationsResponse

type ListConversationsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ConversationListSchema
	JSON401      *ErrorSchema
	JSON403      *ErrorSchema
}

func ParseListConversationsResponse

func ParseListConversationsResponse(rsp *http.Response) (*ListConversationsResponse, error)

ParseListConversationsResponse parses an HTTP response from a ListConversationsWithResponse call

func (ListConversationsResponse) Status

func (r ListConversationsResponse) Status() string

Status returns HTTPResponse.Status

func (ListConversationsResponse) StatusCode

func (r ListConversationsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListEmailsParams

type ListEmailsParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListEmailsParams defines parameters for ListEmails.

type ListEmailsResponse

type ListEmailsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *EmailListSchema
	JSON401      *ErrorSchema
}

func ParseListEmailsResponse

func ParseListEmailsResponse(rsp *http.Response) (*ListEmailsResponse, error)

ParseListEmailsResponse parses an HTTP response from a ListEmailsWithResponse call

func (ListEmailsResponse) Status

func (r ListEmailsResponse) Status() string

Status returns HTTPResponse.Status

func (ListEmailsResponse) StatusCode

func (r ListEmailsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListExternalPagesParams

type ListExternalPagesParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListExternalPagesParams defines parameters for ListExternalPages.

type ListExternalPagesResponse

type ListExternalPagesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ExternalPagesListSchema
	JSON401      *ErrorSchema
}

func ParseListExternalPagesResponse

func ParseListExternalPagesResponse(rsp *http.Response) (*ListExternalPagesResponse, error)

ParseListExternalPagesResponse parses an HTTP response from a ListExternalPagesWithResponse call

func (ListExternalPagesResponse) Status

func (r ListExternalPagesResponse) Status() string

Status returns HTTPResponse.Status

func (ListExternalPagesResponse) StatusCode

func (r ListExternalPagesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListHandlingEventsParams

type ListHandlingEventsParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListHandlingEventsParams defines parameters for ListHandlingEvents.

type ListHandlingEventsResponse

type ListHandlingEventsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *HandlingEventListSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseListHandlingEventsResponse

func ParseListHandlingEventsResponse(rsp *http.Response) (*ListHandlingEventsResponse, error)

ParseListHandlingEventsResponse parses an HTTP response from a ListHandlingEventsWithResponse call

func (ListHandlingEventsResponse) Status

Status returns HTTPResponse.Status

func (ListHandlingEventsResponse) StatusCode

func (r ListHandlingEventsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListHelpCentersParams

type ListHelpCentersParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListHelpCentersParams defines parameters for ListHelpCenters.

type ListHelpCentersResponse

type ListHelpCentersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *HelpCenterListSchema
	JSON401      *ErrorSchema
}

func ParseListHelpCentersResponse

func ParseListHelpCentersResponse(rsp *http.Response) (*ListHelpCentersResponse, error)

ParseListHelpCentersResponse parses an HTTP response from a ListHelpCentersWithResponse call

func (ListHelpCentersResponse) Status

func (r ListHelpCentersResponse) Status() string

Status returns HTTPResponse.Status

func (ListHelpCentersResponse) StatusCode

func (r ListHelpCentersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListInternalArticlesParams

type ListInternalArticlesParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListInternalArticlesParams defines parameters for ListInternalArticles.

type ListInternalArticlesResponse

type ListInternalArticlesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *InternalArticleListSchema
	JSON401      *ErrorSchema
}

func ParseListInternalArticlesResponse

func ParseListInternalArticlesResponse(rsp *http.Response) (*ListInternalArticlesResponse, error)

ParseListInternalArticlesResponse parses an HTTP response from a ListInternalArticlesWithResponse call

func (ListInternalArticlesResponse) Status

Status returns HTTPResponse.Status

func (ListInternalArticlesResponse) StatusCode

func (r ListInternalArticlesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListLiveNewsfeedItemsParams

type ListLiveNewsfeedItemsParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListLiveNewsfeedItemsParams defines parameters for ListLiveNewsfeedItems.

type ListLiveNewsfeedItemsResponse

type ListLiveNewsfeedItemsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PaginatedResponseSchema
	JSON401      *ErrorSchema
}

func ParseListLiveNewsfeedItemsResponse

func ParseListLiveNewsfeedItemsResponse(rsp *http.Response) (*ListLiveNewsfeedItemsResponse, error)

ParseListLiveNewsfeedItemsResponse parses an HTTP response from a ListLiveNewsfeedItemsWithResponse call

func (ListLiveNewsfeedItemsResponse) Status

Status returns HTTPResponse.Status

func (ListLiveNewsfeedItemsResponse) StatusCode

func (r ListLiveNewsfeedItemsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListNewsItemsParams

type ListNewsItemsParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListNewsItemsParams defines parameters for ListNewsItems.

type ListNewsItemsResponse

type ListNewsItemsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PaginatedResponseSchema
	JSON401      *ErrorSchema
}

func ParseListNewsItemsResponse

func ParseListNewsItemsResponse(rsp *http.Response) (*ListNewsItemsResponse, error)

ParseListNewsItemsResponse parses an HTTP response from a ListNewsItemsWithResponse call

func (ListNewsItemsResponse) Status

func (r ListNewsItemsResponse) Status() string

Status returns HTTPResponse.Status

func (ListNewsItemsResponse) StatusCode

func (r ListNewsItemsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListNewsfeedsParams

type ListNewsfeedsParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListNewsfeedsParams defines parameters for ListNewsfeeds.

type ListNewsfeedsResponse

type ListNewsfeedsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PaginatedResponseSchema
	JSON401      *ErrorSchema
}

func ParseListNewsfeedsResponse

func ParseListNewsfeedsResponse(rsp *http.Response) (*ListNewsfeedsResponse, error)

ParseListNewsfeedsResponse parses an HTTP response from a ListNewsfeedsWithResponse call

func (ListNewsfeedsResponse) Status

func (r ListNewsfeedsResponse) Status() string

Status returns HTTPResponse.Status

func (ListNewsfeedsResponse) StatusCode

func (r ListNewsfeedsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListNotesParams

type ListNotesParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListNotesParams defines parameters for ListNotes.

type ListNotesResponse

type ListNotesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *NoteListSchema
	JSON404      *ErrorSchema
}

func ParseListNotesResponse

func ParseListNotesResponse(rsp *http.Response) (*ListNotesResponse, error)

ParseListNotesResponse parses an HTTP response from a ListNotesWithResponse call

func (ListNotesResponse) Status

func (r ListNotesResponse) Status() string

Status returns HTTPResponse.Status

func (ListNotesResponse) StatusCode

func (r ListNotesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListSegmentsForAContactParams

type ListSegmentsForAContactParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListSegmentsForAContactParams defines parameters for ListSegmentsForAContact.

type ListSegmentsForAContactResponse

type ListSegmentsForAContactResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ContactSegmentsSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseListSegmentsForAContactResponse

func ParseListSegmentsForAContactResponse(rsp *http.Response) (*ListSegmentsForAContactResponse, error)

ParseListSegmentsForAContactResponse parses an HTTP response from a ListSegmentsForAContactWithResponse call

func (ListSegmentsForAContactResponse) Status

Status returns HTTPResponse.Status

func (ListSegmentsForAContactResponse) StatusCode

func (r ListSegmentsForAContactResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListSegmentsParams

type ListSegmentsParams struct {
	// IncludeCount It includes the count of contacts that belong to each segment.
	IncludeCount    *bool            `form:"include_count,omitempty" json:"include_count,omitempty"`
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListSegmentsParams defines parameters for ListSegments.

type ListSegmentsResponse

type ListSegmentsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SegmentListSchema
	JSON401      *ErrorSchema
}

func ParseListSegmentsResponse

func ParseListSegmentsResponse(rsp *http.Response) (*ListSegmentsResponse, error)

ParseListSegmentsResponse parses an HTTP response from a ListSegmentsWithResponse call

func (ListSegmentsResponse) Status

func (r ListSegmentsResponse) Status() string

Status returns HTTPResponse.Status

func (ListSegmentsResponse) StatusCode

func (r ListSegmentsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListSubscriptionTypesParams

type ListSubscriptionTypesParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListSubscriptionTypesParams defines parameters for ListSubscriptionTypes.

type ListSubscriptionTypesResponse

type ListSubscriptionTypesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SubscriptionTypeListSchema
	JSON401      *ErrorSchema
}

func ParseListSubscriptionTypesResponse

func ParseListSubscriptionTypesResponse(rsp *http.Response) (*ListSubscriptionTypesResponse, error)

ParseListSubscriptionTypesResponse parses an HTTP response from a ListSubscriptionTypesWithResponse call

func (ListSubscriptionTypesResponse) Status

Status returns HTTPResponse.Status

func (ListSubscriptionTypesResponse) StatusCode

func (r ListSubscriptionTypesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListSubscriptionsForAContactParams

type ListSubscriptionsForAContactParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListSubscriptionsForAContactParams defines parameters for ListSubscriptionsForAContact.

type ListSubscriptionsForAContactResponse

type ListSubscriptionsForAContactResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SubscriptionTypeListSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseListSubscriptionsForAContactResponse

func ParseListSubscriptionsForAContactResponse(rsp *http.Response) (*ListSubscriptionsForAContactResponse, error)

ParseListSubscriptionsForAContactResponse parses an HTTP response from a ListSubscriptionsForAContactWithResponse call

func (ListSubscriptionsForAContactResponse) Status

Status returns HTTPResponse.Status

func (ListSubscriptionsForAContactResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type ListTagsForAContactParams

type ListTagsForAContactParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListTagsForAContactParams defines parameters for ListTagsForAContact.

type ListTagsForAContactResponse

type ListTagsForAContactResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TagListSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseListTagsForAContactResponse

func ParseListTagsForAContactResponse(rsp *http.Response) (*ListTagsForAContactResponse, error)

ParseListTagsForAContactResponse parses an HTTP response from a ListTagsForAContactWithResponse call

func (ListTagsForAContactResponse) Status

Status returns HTTPResponse.Status

func (ListTagsForAContactResponse) StatusCode

func (r ListTagsForAContactResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListTagsParams

type ListTagsParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListTagsParams defines parameters for ListTags.

type ListTagsResponse

type ListTagsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TagListSchema
	JSON401      *ErrorSchema
}

func ParseListTagsResponse

func ParseListTagsResponse(rsp *http.Response) (*ListTagsResponse, error)

ParseListTagsResponse parses an HTTP response from a ListTagsWithResponse call

func (ListTagsResponse) Status

func (r ListTagsResponse) Status() string

Status returns HTTPResponse.Status

func (ListTagsResponse) StatusCode

func (r ListTagsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListTeamsParams

type ListTeamsParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListTeamsParams defines parameters for ListTeams.

type ListTeamsResponse

type ListTeamsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TeamListSchema
	JSON401      *ErrorSchema
}

func ParseListTeamsResponse

func ParseListTeamsResponse(rsp *http.Response) (*ListTeamsResponse, error)

ParseListTeamsResponse parses an HTTP response from a ListTeamsWithResponse call

func (ListTeamsResponse) Status

func (r ListTeamsResponse) Status() string

Status returns HTTPResponse.Status

func (ListTeamsResponse) StatusCode

func (r ListTeamsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListTicketStatesParams

type ListTicketStatesParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListTicketStatesParams defines parameters for ListTicketStates.

type ListTicketStatesResponse

type ListTicketStatesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TicketStateListSchema
	JSON401      *ErrorSchema
}

func ParseListTicketStatesResponse

func ParseListTicketStatesResponse(rsp *http.Response) (*ListTicketStatesResponse, error)

ParseListTicketStatesResponse parses an HTTP response from a ListTicketStatesWithResponse call

func (ListTicketStatesResponse) Status

func (r ListTicketStatesResponse) Status() string

Status returns HTTPResponse.Status

func (ListTicketStatesResponse) StatusCode

func (r ListTicketStatesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListTicketTypesParams

type ListTicketTypesParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ListTicketTypesParams defines parameters for ListTicketTypes.

type ListTicketTypesResponse

type ListTicketTypesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TicketTypeListSchema
	JSON401      *ErrorSchema
}

func ParseListTicketTypesResponse

func ParseListTicketTypesResponse(rsp *http.Response) (*ListTicketTypesResponse, error)

ParseListTicketTypesResponse parses an HTTP response from a ListTicketTypesWithResponse call

func (ListTicketTypesResponse) Status

func (r ListTicketTypesResponse) Status() string

Status returns HTTPResponse.Status

func (ListTicketTypesResponse) StatusCode

func (r ListTicketTypesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ManageConversationJSONBody

type ManageConversationJSONBody struct {
	// contains filtered or unexported fields
}

ManageConversationJSONBody defines parameters for ManageConversation.

type ManageConversationJSONRequestBody

type ManageConversationJSONRequestBody ManageConversationJSONBody

ManageConversationJSONRequestBody defines body for ManageConversation for application/json ContentType.

type ManageConversationParams

type ManageConversationParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ManageConversationParams defines parameters for ManageConversation.

type ManageConversationResponse

type ManageConversationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ConversationSchema
	JSON401      *ErrorSchema
	JSON403      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseManageConversationResponse

func ParseManageConversationResponse(rsp *http.Response) (*ManageConversationResponse, error)

ParseManageConversationResponse parses an HTTP response from a ManageConversationWithResponse call

func (ManageConversationResponse) Status

Status returns HTTPResponse.Status

func (ManageConversationResponse) StatusCode

func (r ManageConversationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type MergeContactJSONRequestBody

type MergeContactJSONRequestBody = MergeContactsRequestSchema

MergeContactJSONRequestBody defines body for MergeContact for application/json ContentType.

type MergeContactParams

type MergeContactParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

MergeContactParams defines parameters for MergeContact.

type MergeContactResponse

type MergeContactResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ContactSchema
	JSON401      *ErrorSchema
}

func ParseMergeContactResponse

func ParseMergeContactResponse(rsp *http.Response) (*MergeContactResponse, error)

ParseMergeContactResponse parses an HTTP response from a MergeContactWithResponse call

func (MergeContactResponse) Status

func (r MergeContactResponse) Status() string

Status returns HTTPResponse.Status

func (MergeContactResponse) StatusCode

func (r MergeContactResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type MergeContactsRequestSchema

type MergeContactsRequestSchema struct {
	// From The unique identifier for the contact to merge away from. Must be a lead.
	From *string `json:"from,omitempty"`

	// Into The unique identifier for the contact to merge into. Must be a user.
	Into *string `json:"into,omitempty"`
}

MergeContactsRequestSchema Merge contact data.

type MessageMessageType

type MessageMessageType string

MessageMessageType The type of message that was sent. Can be email, inapp, facebook or twitter.

const (
	MessageMessageTypeEmail    MessageMessageType = "email"
	MessageMessageTypeFacebook MessageMessageType = "facebook"
	MessageMessageTypeInapp    MessageMessageType = "inapp"
	MessageMessageTypeTwitter  MessageMessageType = "twitter"
)

Defines values for MessageMessageType.

func (MessageMessageType) Valid

func (e MessageMessageType) Valid() bool

Valid indicates whether the value is a known member of the MessageMessageType enum.

type MessageSchema

type MessageSchema struct {
	// Body The message body, which may contain HTML.
	Body string `json:"body"`

	// ConversationId The associated conversation_id
	ConversationId *string `json:"conversation_id,omitempty"`

	// CreatedAt The time the conversation was created.
	CreatedAt int `json:"created_at"`

	// Id The id representing the message.
	Id string `json:"id"`

	// MessageType The type of message that was sent. Can be email, inapp, facebook or twitter.
	MessageType MessageMessageType `json:"message_type"`

	// Subject The subject of the message. Only present if message_type: email.
	Subject *string `json:"subject,omitempty"`

	// Type The type of the message
	Type string `json:"type"`
}

MessageSchema Message are how you reach out to contacts in Intercom. They are created when an admin sends an outbound message to a contact.

type Metadata

Metadata Metadata for a conversation part

type MultipleFilterSearchRequestOperator

type MultipleFilterSearchRequestOperator string

MultipleFilterSearchRequestOperator An operator to allow boolean inspection between multiple fields.

Defines values for MultipleFilterSearchRequestOperator.

func (MultipleFilterSearchRequestOperator) Valid

Valid indicates whether the value is a known member of the MultipleFilterSearchRequestOperator enum.

type MultipleFilterSearchRequestSchema

type MultipleFilterSearchRequestSchema struct {
	// Operator An operator to allow boolean inspection between multiple fields.
	Operator *MultipleFilterSearchRequestOperator `json:"operator,omitempty"`
	Value    *MultipleFilterSearchRequest_Value   `json:"value,omitempty"`
}

MultipleFilterSearchRequestSchema Search using Intercoms Search APIs with more than one filter.

type MultipleFilterSearchRequestValue0

type MultipleFilterSearchRequestValue0 = []MultipleFilterSearchRequestSchema

MultipleFilterSearchRequestValue0 Add mutiple filters.

type MultipleFilterSearchRequestValue1

type MultipleFilterSearchRequestValue1 = []SingleFilterSearchRequestSchema

MultipleFilterSearchRequestValue1 Add a single filter field.

type MultipleFilterSearchRequest_Value

type MultipleFilterSearchRequest_Value struct {
	// contains filtered or unexported fields
}

MultipleFilterSearchRequest_Value defines model for MultipleFilterSearchRequest.Value.

func (MultipleFilterSearchRequest_Value) AsMultipleFilterSearchRequestValue0

func (t MultipleFilterSearchRequest_Value) AsMultipleFilterSearchRequestValue0() (MultipleFilterSearchRequestValue0, error)

AsMultipleFilterSearchRequestValue0 returns the union data inside the MultipleFilterSearchRequest_Value as a MultipleFilterSearchRequestValue0

func (MultipleFilterSearchRequest_Value) AsMultipleFilterSearchRequestValue1

func (t MultipleFilterSearchRequest_Value) AsMultipleFilterSearchRequestValue1() (MultipleFilterSearchRequestValue1, error)

AsMultipleFilterSearchRequestValue1 returns the union data inside the MultipleFilterSearchRequest_Value as a MultipleFilterSearchRequestValue1

func (*MultipleFilterSearchRequest_Value) FromMultipleFilterSearchRequestValue0

func (t *MultipleFilterSearchRequest_Value) FromMultipleFilterSearchRequestValue0(v MultipleFilterSearchRequestValue0) error

FromMultipleFilterSearchRequestValue0 overwrites any union data inside the MultipleFilterSearchRequest_Value as the provided MultipleFilterSearchRequestValue0

func (*MultipleFilterSearchRequest_Value) FromMultipleFilterSearchRequestValue1

func (t *MultipleFilterSearchRequest_Value) FromMultipleFilterSearchRequestValue1(v MultipleFilterSearchRequestValue1) error

FromMultipleFilterSearchRequestValue1 overwrites any union data inside the MultipleFilterSearchRequest_Value as the provided MultipleFilterSearchRequestValue1

func (MultipleFilterSearchRequest_Value) MarshalJSON

func (t MultipleFilterSearchRequest_Value) MarshalJSON() ([]byte, error)

func (*MultipleFilterSearchRequest_Value) MergeMultipleFilterSearchRequestValue0

func (t *MultipleFilterSearchRequest_Value) MergeMultipleFilterSearchRequestValue0(v MultipleFilterSearchRequestValue0) error

MergeMultipleFilterSearchRequestValue0 performs a merge with any union data inside the MultipleFilterSearchRequest_Value, using the provided MultipleFilterSearchRequestValue0

func (*MultipleFilterSearchRequest_Value) MergeMultipleFilterSearchRequestValue1

func (t *MultipleFilterSearchRequest_Value) MergeMultipleFilterSearchRequestValue1(v MultipleFilterSearchRequestValue1) error

MergeMultipleFilterSearchRequestValue1 performs a merge with any union data inside the MultipleFilterSearchRequest_Value, using the provided MultipleFilterSearchRequestValue1

func (*MultipleFilterSearchRequest_Value) UnmarshalJSON

func (t *MultipleFilterSearchRequest_Value) UnmarshalJSON(b []byte) error

type NewsItemRequestSchema

type NewsItemRequestSchema struct {
	// Body The news item body, which may contain HTML.
	Body *string `json:"body,omitempty"`

	// DeliverSilently When set to `true`, the news item will appear in the messenger newsfeed without showing a notification badge.
	DeliverSilently *bool `json:"deliver_silently,omitempty"`

	// Labels Label names displayed to users to categorize the news item.
	Labels *[]string `json:"labels,omitempty"`

	// NewsfeedAssignments A list of newsfeed_assignments to assign to the specified newsfeed.
	NewsfeedAssignments *[]NewsfeedAssignmentSchema `json:"newsfeed_assignments,omitempty"`

	// Reactions Ordered list of emoji reactions to the news item. When empty, reactions are disabled.
	Reactions *[]*string `json:"reactions,omitempty"`

	// SenderId The id of the sender of the news item. Must be a teammate on the workspace.
	SenderId int `json:"sender_id"`

	// State News items will not be visible to your users in the assigned newsfeeds until they are set live.
	State *NewsItemRequestState `json:"state,omitempty"`

	// Title The title of the news item.
	Title string `json:"title"`
}

NewsItemRequestSchema A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers.

type NewsItemRequestState

type NewsItemRequestState string

NewsItemRequestState News items will not be visible to your users in the assigned newsfeeds until they are set live.

const (
	NewsItemRequestStateDraft NewsItemRequestState = "draft"
	NewsItemRequestStateLive  NewsItemRequestState = "live"
)

Defines values for NewsItemRequestState.

func (NewsItemRequestState) Valid

func (e NewsItemRequestState) Valid() bool

Valid indicates whether the value is a known member of the NewsItemRequestState enum.

type NewsItemSchema

type NewsItemSchema struct {
	// Body The news item body, which may contain HTML.
	Body *string `json:"body,omitempty"`

	// CoverImageUrl URL of the image used as cover. Must have .jpg or .png extension.
	CoverImageUrl *string `json:"cover_image_url,omitempty"`

	// CreatedAt Timestamp for when the news item was created.
	CreatedAt *int `json:"created_at,omitempty"`

	// DeliverSilently When set to true, the news item will appear in the messenger newsfeed without showing a notification badge.
	DeliverSilently *bool `json:"deliver_silently,omitempty"`

	// Id The unique identifier for the news item which is given by Intercom.
	Id *string `json:"id,omitempty"`

	// Labels Label names displayed to users to categorize the news item.
	Labels *[]*string `json:"labels,omitempty"`

	// NewsfeedAssignments A list of newsfeed_assignments to assign to the specified newsfeed.
	NewsfeedAssignments *[]NewsfeedAssignmentSchema `json:"newsfeed_assignments,omitempty"`

	// Reactions Ordered list of emoji reactions to the news item. When empty, reactions are disabled.
	Reactions *[]*string `json:"reactions,omitempty"`

	// SenderId The id of the sender of the news item. Must be a teammate on the workspace.
	SenderId *int `json:"sender_id,omitempty"`

	// State News items will not be visible to your users in the assigned newsfeeds until they are set live.
	State *NewsItemState `json:"state,omitempty"`

	// Title The title of the news item.
	Title *string `json:"title,omitempty"`

	// Type The type of object.
	Type *NewsItemType `json:"type,omitempty"`

	// UpdatedAt Timestamp for when the news item was last updated.
	UpdatedAt *int `json:"updated_at,omitempty"`

	// WorkspaceId The id of the workspace which the news item belongs to.
	WorkspaceId *string `json:"workspace_id,omitempty"`
}

NewsItemSchema A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers.

type NewsItemState

type NewsItemState string

NewsItemState News items will not be visible to your users in the assigned newsfeeds until they are set live.

const (
	NewsItemStateDraft NewsItemState = "draft"
	NewsItemStateLive  NewsItemState = "live"
)

Defines values for NewsItemState.

func (NewsItemState) Valid

func (e NewsItemState) Valid() bool

Valid indicates whether the value is a known member of the NewsItemState enum.

type NewsItemType

type NewsItemType string

NewsItemType The type of object.

const (
	NewsItemTypeNewsItem NewsItemType = "news-item"
)

Defines values for NewsItemType.

func (NewsItemType) Valid

func (e NewsItemType) Valid() bool

Valid indicates whether the value is a known member of the NewsItemType enum.

type NewsfeedAssignmentSchema

type NewsfeedAssignmentSchema struct {
	// NewsfeedId The unique identifier for the newsfeed which is given by Intercom. Publish dates cannot be in the future, to schedule news items use the dedicated feature in app (see this article).
	NewsfeedId *int `json:"newsfeed_id,omitempty"`

	// PublishedAt Publish date of the news item on the newsfeed, use this field if you want to set a publish date in the past (e.g. when importing existing news items). On write, this field will be ignored if the news item state is "draft".
	PublishedAt *int `json:"published_at,omitempty"`
}

NewsfeedAssignmentSchema Assigns a news item to a newsfeed.

type NewsfeedSchema

type NewsfeedSchema struct {
	// CreatedAt Timestamp for when the newsfeed was created.
	CreatedAt *int `json:"created_at,omitempty"`

	// Id The unique identifier for the newsfeed which is given by Intercom.
	Id *string `json:"id,omitempty"`

	// Name The name of the newsfeed. This name will never be visible to your users.
	Name *string `json:"name,omitempty"`

	// Type The type of object.
	Type *NewsfeedType `json:"type,omitempty"`

	// UpdatedAt Timestamp for when the newsfeed was last updated.
	UpdatedAt *int `json:"updated_at,omitempty"`
}

NewsfeedSchema A newsfeed is a collection of news items, targeted to a specific audience.

Newsfeeds currently cannot be edited through the API, please refer to [this article](https://www.intercom.com/help/en/articles/6362267-getting-started-with-news) to set up your newsfeeds in Intercom.

type NewsfeedType

type NewsfeedType string

NewsfeedType The type of object.

const (
	Newsfeed NewsfeedType = "newsfeed"
)

Defines values for NewsfeedType.

func (NewsfeedType) Valid

func (e NewsfeedType) Valid() bool

Valid indicates whether the value is a known member of the NewsfeedType enum.

type NoteListSchema

type NoteListSchema struct {
	// Data An array of notes.
	Data  *[]NoteSchema      `json:"data,omitempty"`
	Pages *CursorPagesSchema `json:"pages,omitempty"`

	// TotalCount A count of the total number of notes.
	TotalCount *int `json:"total_count,omitempty"`

	// Type String representing the object's type. Always has the value `list`.
	Type *string `json:"type,omitempty"`
}

NoteListSchema A paginated list of notes associated with a contact.

type NoteSchema

type NoteSchema struct {
	// Author Optional. Represents the Admin that created the note.
	Author *AdminSchema `json:"author,omitempty"`

	// Body The body text of the note.
	Body *string `json:"body,omitempty"`

	// Contact Represents the contact that the note was created about.
	Contact *struct {
		// Id The id of the contact.
		Id *string `json:"id,omitempty"`

		// Type String representing the object's type. Always has the value `contact`.
		Type *string `json:"type,omitempty"`
	} `json:"contact,omitempty"`

	// CreatedAt The time the note was created.
	CreatedAt *int `json:"created_at,omitempty"`

	// Id The id of the note.
	Id *string `json:"id,omitempty"`

	// Type String representing the object's type. Always has the value `note`.
	Type *string `json:"type,omitempty"`
}

NoteSchema Notes allow you to annotate and comment on your contacts.

type ObjectNotFound

type ObjectNotFound = ErrorSchema

ObjectNotFound The API will return an Error List for a failed request, which will contain one or more Error objects.

type OpenConversationRequestMessageType

type OpenConversationRequestMessageType string

OpenConversationRequestMessageType defines model for OpenConversationRequest.MessageType.

const (
	OpenConversationRequestMessageTypeOpen OpenConversationRequestMessageType = "open"
)

Defines values for OpenConversationRequestMessageType.

func (OpenConversationRequestMessageType) Valid

Valid indicates whether the value is a known member of the OpenConversationRequestMessageType enum.

type OpenConversationRequestSchema

type OpenConversationRequestSchema struct {
	// AdminId The id of the admin who is performing the action.
	AdminId     string                             `json:"admin_id"`
	MessageType OpenConversationRequestMessageType `json:"message_type"`
}

OpenConversationRequestSchema Payload of the request to open a conversation

type OperatorWorkflowEventSchema

type OperatorWorkflowEventSchema struct {
	Event *struct {
		// Result Result of the workflow event
		Result *string `json:"result,omitempty"`

		// Type Type of the workflow event initiated
		Type *string `json:"type,omitempty"`
	} `json:"event,omitempty"`
	Workflow *struct {
		// Name The name of the workflow
		Name *string `json:"name,omitempty"`
	} `json:"workflow,omitempty"`
}

OperatorWorkflowEventSchema Contains details about name of the workflow for conversation part type <code>operator_workflow_event</code>.

type PagesLinkSchema

type PagesLinkSchema struct {
	// Next A link to the next page of results. A response that does not contain a next link does not have further data to fetch.
	Next       *string        `json:"next,omitempty"`
	Page       *int           `json:"page,omitempty"`
	PerPage    *int           `json:"per_page,omitempty"`
	TotalPages *int           `json:"total_pages,omitempty"`
	Type       *PagesLinkType `json:"type,omitempty"`
}

PagesLinkSchema The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests.

Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows.

type PagesLinkType

type PagesLinkType string

PagesLinkType defines model for PagesLink.Type.

const (
	PagesLinkTypePages PagesLinkType = "pages"
)

Defines values for PagesLinkType.

func (PagesLinkType) Valid

func (e PagesLinkType) Valid() bool

Valid indicates whether the value is a known member of the PagesLinkType enum.

type PaginatedResponseSchema

type PaginatedResponseSchema struct {
	// Data An array of Objects
	Data  *[]PaginatedResponse_Data_Item `json:"data,omitempty"`
	Pages *CursorPagesSchema             `json:"pages,omitempty"`

	// TotalCount A count of the total number of objects.
	TotalCount *int `json:"total_count,omitempty"`

	// Type The type of object
	Type *PaginatedResponseType `json:"type,omitempty"`
}

PaginatedResponseSchema Paginated Response

type PaginatedResponseType

type PaginatedResponseType string

PaginatedResponseType The type of object

const (
	PaginatedResponseTypeConversationList PaginatedResponseType = "conversation.list"
	PaginatedResponseTypeList             PaginatedResponseType = "list"
)

Defines values for PaginatedResponseType.

func (PaginatedResponseType) Valid

func (e PaginatedResponseType) Valid() bool

Valid indicates whether the value is a known member of the PaginatedResponseType enum.

type PaginatedResponse_Data_Item

type PaginatedResponse_Data_Item struct {
	// contains filtered or unexported fields
}

PaginatedResponse_Data_Item defines model for paginated_response.data.Item.

func (PaginatedResponse_Data_Item) AsNewsItemSchema

func (t PaginatedResponse_Data_Item) AsNewsItemSchema() (NewsItemSchema, error)

AsNewsItemSchema returns the union data inside the PaginatedResponse_Data_Item as a NewsItemSchema

func (PaginatedResponse_Data_Item) AsNewsfeedSchema

func (t PaginatedResponse_Data_Item) AsNewsfeedSchema() (NewsfeedSchema, error)

AsNewsfeedSchema returns the union data inside the PaginatedResponse_Data_Item as a NewsfeedSchema

func (*PaginatedResponse_Data_Item) FromNewsItemSchema

func (t *PaginatedResponse_Data_Item) FromNewsItemSchema(v NewsItemSchema) error

FromNewsItemSchema overwrites any union data inside the PaginatedResponse_Data_Item as the provided NewsItemSchema

func (*PaginatedResponse_Data_Item) FromNewsfeedSchema

func (t *PaginatedResponse_Data_Item) FromNewsfeedSchema(v NewsfeedSchema) error

FromNewsfeedSchema overwrites any union data inside the PaginatedResponse_Data_Item as the provided NewsfeedSchema

func (PaginatedResponse_Data_Item) MarshalJSON

func (t PaginatedResponse_Data_Item) MarshalJSON() ([]byte, error)

func (*PaginatedResponse_Data_Item) MergeNewsItemSchema

func (t *PaginatedResponse_Data_Item) MergeNewsItemSchema(v NewsItemSchema) error

MergeNewsItemSchema performs a merge with any union data inside the PaginatedResponse_Data_Item, using the provided NewsItemSchema

func (*PaginatedResponse_Data_Item) MergeNewsfeedSchema

func (t *PaginatedResponse_Data_Item) MergeNewsfeedSchema(v NewsfeedSchema) error

MergeNewsfeedSchema performs a merge with any union data inside the PaginatedResponse_Data_Item, using the provided NewsfeedSchema

func (*PaginatedResponse_Data_Item) UnmarshalJSON

func (t *PaginatedResponse_Data_Item) UnmarshalJSON(b []byte) error

type PartAttachmentSchema

type PartAttachmentSchema struct {
	// ContentType The content type of the attachment
	ContentType *string `json:"content_type,omitempty"`

	// Filesize The size of the attachment
	Filesize *int `json:"filesize,omitempty"`

	// Height The height of the attachment
	Height *int `json:"height,omitempty"`

	// Name The name of the attachment
	Name *string `json:"name,omitempty"`

	// Type The type of attachment
	Type *string `json:"type,omitempty"`

	// Url The URL of the attachment
	Url *string `json:"url,omitempty"`

	// Width The width of the attachment
	Width *int `json:"width,omitempty"`
}

PartAttachmentSchema The file attached to a part

type PhoneSwitchSchema

type PhoneSwitchSchema struct {
	// Phone Phone number in E.164 format, that has received the SMS to continue the conversation in the Messenger.
	Phone *string          `json:"phone,omitempty"`
	Type  *PhoneSwitchType `json:"type,omitempty"`
}

PhoneSwitchSchema Phone Switch Response

type PhoneSwitchType

type PhoneSwitchType string

PhoneSwitchType defines model for PhoneSwitch.Type.

const (
	PhoneCallRedirect PhoneSwitchType = "phone_call_redirect"
)

Defines values for PhoneSwitchType.

func (PhoneSwitchType) Valid

func (e PhoneSwitchType) Valid() bool

Valid indicates whether the value is a known member of the PhoneSwitchType enum.

type PostExportReportingDataEnqueueJSONBody

type PostExportReportingDataEnqueueJSONBody struct {
	AttributeIds []string `json:"attribute_ids"`
	DatasetId    string   `json:"dataset_id"`
	EndTime      int64    `json:"end_time"`
	StartTime    int64    `json:"start_time"`
}

PostExportReportingDataEnqueueJSONBody defines parameters for PostExportReportingDataEnqueue.

type PostExportReportingDataEnqueueJSONRequestBody

type PostExportReportingDataEnqueueJSONRequestBody PostExportReportingDataEnqueueJSONBody

PostExportReportingDataEnqueueJSONRequestBody defines body for PostExportReportingDataEnqueue for application/json ContentType.

type PostExportReportingDataEnqueueParams

type PostExportReportingDataEnqueueParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

PostExportReportingDataEnqueueParams defines parameters for PostExportReportingDataEnqueue.

type PostExportReportingDataEnqueueResponse

type PostExportReportingDataEnqueueResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		DownloadExpiresAt *string `json:"download_expires_at,omitempty"`
		DownloadUrl       *string `json:"download_url,omitempty"`
		JobIdentifier     *string `json:"job_identifier,omitempty"`
		Status            *string `json:"status,omitempty"`
	}
	JSON400 *ErrorSchema
	JSON401 *ErrorSchema
	JSON429 *ErrorSchema
}

func ParsePostExportReportingDataEnqueueResponse

func ParsePostExportReportingDataEnqueueResponse(rsp *http.Response) (*PostExportReportingDataEnqueueResponse, error)

ParsePostExportReportingDataEnqueueResponse parses an HTTP response from a PostExportReportingDataEnqueueWithResponse call

func (PostExportReportingDataEnqueueResponse) Status

Status returns HTTPResponse.Status

func (PostExportReportingDataEnqueueResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type QuickReplyOptionSchema

type QuickReplyOptionSchema struct {
	// Text The text to display in this quick reply option.
	Text string `json:"text"`

	// Uuid A unique identifier for this quick reply option. This value will be available within the metadata of the comment conversation part that is created when a user clicks on this reply option.
	Uuid openapi_types.UUID `json:"uuid"`
}

QuickReplyOptionSchema defines model for quick_reply_option.

type RecipientSchema

type RecipientSchema struct {
	// Id The identifier for the contact which is given by Intercom.
	Id string `json:"id"`

	// Type The role associated to the contact - `user` or `lead`.
	Type RecipientType `json:"type"`
}

RecipientSchema A recipient of a message

type RecipientType

type RecipientType string

RecipientType The role associated to the contact - `user` or `lead`.

const (
	RecipientTypeLead RecipientType = "lead"
	RecipientTypeUser RecipientType = "user"
)

Defines values for RecipientType.

func (RecipientType) Valid

func (e RecipientType) Valid() bool

Valid indicates whether the value is a known member of the RecipientType enum.

type RedactConversationJSONRequestBody

type RedactConversationJSONRequestBody = RedactConversationRequest

RedactConversationJSONRequestBody defines body for RedactConversation for application/json ContentType.

type RedactConversationParams

type RedactConversationParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

RedactConversationParams defines parameters for RedactConversation.

type RedactConversationRequest

type RedactConversationRequest struct {
	// contains filtered or unexported fields
}

RedactConversationRequest defines model for redact_conversation_request.

func (RedactConversationRequest) AsRedactConversationRequest0

func (t RedactConversationRequest) AsRedactConversationRequest0() (RedactConversationRequest0, error)

AsRedactConversationRequest0 returns the union data inside the RedactConversationRequest as a RedactConversationRequest0

func (RedactConversationRequest) AsRedactConversationRequest1

func (t RedactConversationRequest) AsRedactConversationRequest1() (RedactConversationRequest1, error)

AsRedactConversationRequest1 returns the union data inside the RedactConversationRequest as a RedactConversationRequest1

func (*RedactConversationRequest) FromRedactConversationRequest0

func (t *RedactConversationRequest) FromRedactConversationRequest0(v RedactConversationRequest0) error

FromRedactConversationRequest0 overwrites any union data inside the RedactConversationRequest as the provided RedactConversationRequest0

func (*RedactConversationRequest) FromRedactConversationRequest1

func (t *RedactConversationRequest) FromRedactConversationRequest1(v RedactConversationRequest1) error

FromRedactConversationRequest1 overwrites any union data inside the RedactConversationRequest as the provided RedactConversationRequest1

func (RedactConversationRequest) MarshalJSON

func (t RedactConversationRequest) MarshalJSON() ([]byte, error)

func (*RedactConversationRequest) MergeRedactConversationRequest0

func (t *RedactConversationRequest) MergeRedactConversationRequest0(v RedactConversationRequest0) error

MergeRedactConversationRequest0 performs a merge with any union data inside the RedactConversationRequest, using the provided RedactConversationRequest0

func (*RedactConversationRequest) MergeRedactConversationRequest1

func (t *RedactConversationRequest) MergeRedactConversationRequest1(v RedactConversationRequest1) error

MergeRedactConversationRequest1 performs a merge with any union data inside the RedactConversationRequest, using the provided RedactConversationRequest1

func (*RedactConversationRequest) UnmarshalJSON

func (t *RedactConversationRequest) UnmarshalJSON(b []byte) error

type RedactConversationRequest0

type RedactConversationRequest0 struct {
	// ConversationId The id of the conversation.
	ConversationId string `json:"conversation_id"`

	// ConversationPartId The id of the conversation_part.
	ConversationPartId string `json:"conversation_part_id"`

	// Type The type of resource being redacted.
	Type RedactConversationRequest0Type `json:"type"`
}

RedactConversationRequest0 Payload of the request to redact a conversation part

type RedactConversationRequest0Type

type RedactConversationRequest0Type string

RedactConversationRequest0Type The type of resource being redacted.

const (
	ConversationPart RedactConversationRequest0Type = "conversation_part"
)

Defines values for RedactConversationRequest0Type.

func (RedactConversationRequest0Type) Valid

Valid indicates whether the value is a known member of the RedactConversationRequest0Type enum.

type RedactConversationRequest1

type RedactConversationRequest1 struct {
	// ConversationId The id of the conversation.
	ConversationId string `json:"conversation_id"`

	// SourceId The id of the source.
	SourceId string `json:"source_id"`

	// Type The type of resource being redacted.
	Type RedactConversationRequest1Type `json:"type"`
}

RedactConversationRequest1 Payload of the request to redact a conversation source

type RedactConversationRequest1Type

type RedactConversationRequest1Type string

RedactConversationRequest1Type The type of resource being redacted.

const (
	Source RedactConversationRequest1Type = "source"
)

Defines values for RedactConversationRequest1Type.

func (RedactConversationRequest1Type) Valid

Valid indicates whether the value is a known member of the RedactConversationRequest1Type enum.

type RedactConversationResponse

type RedactConversationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ConversationSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseRedactConversationResponse

func ParseRedactConversationResponse(rsp *http.Response) (*RedactConversationResponse, error)

ParseRedactConversationResponse parses an HTTP response from a RedactConversationWithResponse call

func (RedactConversationResponse) Status

Status returns HTTPResponse.Status

func (RedactConversationResponse) StatusCode

func (r RedactConversationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ReferenceSchema

type ReferenceSchema struct {
	Id   *string `json:"id,omitempty"`
	Type *string `json:"type,omitempty"`
}

ReferenceSchema reference to another object

type RegisterFinVoiceCallJSONRequestBody

type RegisterFinVoiceCallJSONRequestBody = RegisterFinVoiceCallRequestSchema

RegisterFinVoiceCallJSONRequestBody defines body for RegisterFinVoiceCall for application/json ContentType.

type RegisterFinVoiceCallRequestSchema

type RegisterFinVoiceCallRequestSchema struct {
	// CallId External call identifier from the call provider
	CallId string `json:"call_id"`

	// Data Additional metadata about the call
	Data *map[string]interface{} `json:"data,omitempty"`

	// PhoneNumber Phone number in E.164 format for the call
	PhoneNumber string `json:"phone_number"`

	// Source Source of the call. Can be "five9", "zoom_phone", or defaults to "aws_connect"
	Source *RegisterFinVoiceCallRequestSource `json:"source,omitempty"`
}

RegisterFinVoiceCallRequestSchema Register a Fin Voice call with Intercom

type RegisterFinVoiceCallRequestSource

type RegisterFinVoiceCallRequestSource string

RegisterFinVoiceCallRequestSource Source of the call. Can be "five9", "zoom_phone", or defaults to "aws_connect"

const (
	AwsConnect RegisterFinVoiceCallRequestSource = "aws_connect"
	Five9      RegisterFinVoiceCallRequestSource = "five9"
	ZoomPhone  RegisterFinVoiceCallRequestSource = "zoom_phone"
)

Defines values for RegisterFinVoiceCallRequestSource.

func (RegisterFinVoiceCallRequestSource) Valid

Valid indicates whether the value is a known member of the RegisterFinVoiceCallRequestSource enum.

type RegisterFinVoiceCallResponse

type RegisterFinVoiceCallResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *AiCallResponseSchema
	JSON400      *ErrorSchema
	JSON409      *ErrorSchema
	JSONDefault  *ErrorSchema
}

func ParseRegisterFinVoiceCallResponse

func ParseRegisterFinVoiceCallResponse(rsp *http.Response) (*RegisterFinVoiceCallResponse, error)

ParseRegisterFinVoiceCallResponse parses an HTTP response from a RegisterFinVoiceCallWithResponse call

func (RegisterFinVoiceCallResponse) Status

Status returns HTTPResponse.Status

func (RegisterFinVoiceCallResponse) StatusCode

func (r RegisterFinVoiceCallResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ReplyConversationJSONRequestBody

type ReplyConversationJSONRequestBody = ReplyConversationRequest

ReplyConversationJSONRequestBody defines body for ReplyConversation for application/json ContentType.

type ReplyConversationParams

type ReplyConversationParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ReplyConversationParams defines parameters for ReplyConversation.

type ReplyConversationRequest

type ReplyConversationRequest struct {
	// contains filtered or unexported fields
}

ReplyConversationRequest defines model for reply_conversation_request.

func (ReplyConversationRequest) AsAdminReplyConversationRequestSchema

func (t ReplyConversationRequest) AsAdminReplyConversationRequestSchema() (AdminReplyConversationRequestSchema, error)

AsAdminReplyConversationRequestSchema returns the union data inside the ReplyConversationRequest as a AdminReplyConversationRequestSchema

func (ReplyConversationRequest) AsContactReplyConversationRequest

func (t ReplyConversationRequest) AsContactReplyConversationRequest() (ContactReplyConversationRequest, error)

AsContactReplyConversationRequest returns the union data inside the ReplyConversationRequest as a ContactReplyConversationRequest

func (*ReplyConversationRequest) FromAdminReplyConversationRequestSchema

func (t *ReplyConversationRequest) FromAdminReplyConversationRequestSchema(v AdminReplyConversationRequestSchema) error

FromAdminReplyConversationRequestSchema overwrites any union data inside the ReplyConversationRequest as the provided AdminReplyConversationRequestSchema

func (*ReplyConversationRequest) FromContactReplyConversationRequest

func (t *ReplyConversationRequest) FromContactReplyConversationRequest(v ContactReplyConversationRequest) error

FromContactReplyConversationRequest overwrites any union data inside the ReplyConversationRequest as the provided ContactReplyConversationRequest

func (ReplyConversationRequest) MarshalJSON

func (t ReplyConversationRequest) MarshalJSON() ([]byte, error)

func (*ReplyConversationRequest) MergeAdminReplyConversationRequestSchema

func (t *ReplyConversationRequest) MergeAdminReplyConversationRequestSchema(v AdminReplyConversationRequestSchema) error

MergeAdminReplyConversationRequestSchema performs a merge with any union data inside the ReplyConversationRequest, using the provided AdminReplyConversationRequestSchema

func (*ReplyConversationRequest) MergeContactReplyConversationRequest

func (t *ReplyConversationRequest) MergeContactReplyConversationRequest(v ContactReplyConversationRequest) error

MergeContactReplyConversationRequest performs a merge with any union data inside the ReplyConversationRequest, using the provided ContactReplyConversationRequest

func (*ReplyConversationRequest) UnmarshalJSON

func (t *ReplyConversationRequest) UnmarshalJSON(b []byte) error

type ReplyConversationResponse

type ReplyConversationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ConversationSchema
	JSON401      *ErrorSchema
	JSON403      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseReplyConversationResponse

func ParseReplyConversationResponse(rsp *http.Response) (*ReplyConversationResponse, error)

ParseReplyConversationResponse parses an HTTP response from a ReplyConversationWithResponse call

func (ReplyConversationResponse) Status

func (r ReplyConversationResponse) Status() string

Status returns HTTPResponse.Status

func (ReplyConversationResponse) StatusCode

func (r ReplyConversationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ReplyTicketJSONBody

type ReplyTicketJSONBody struct {
	// SkipNotifications Option to disable notifications when replying to a Ticket.
	SkipNotifications *bool `json:"skip_notifications,omitempty"`
	// contains filtered or unexported fields
}

ReplyTicketJSONBody defines parameters for ReplyTicket.

type ReplyTicketJSONRequestBody

type ReplyTicketJSONRequestBody ReplyTicketJSONBody

ReplyTicketJSONRequestBody defines body for ReplyTicket for application/json ContentType.

type ReplyTicketParams

type ReplyTicketParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ReplyTicketParams defines parameters for ReplyTicket.

type ReplyTicketResponse

type ReplyTicketResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TicketReplySchema
	JSON400      *ErrorSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseReplyTicketResponse

func ParseReplyTicketResponse(rsp *http.Response) (*ReplyTicketResponse, error)

ParseReplyTicketResponse parses an HTTP response from a ReplyTicketWithResponse call

func (ReplyTicketResponse) Status

func (r ReplyTicketResponse) Status() string

Status returns HTTPResponse.Status

func (ReplyTicketResponse) StatusCode

func (r ReplyTicketResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ReplyToFin200Status

type ReplyToFin200Status string

type ReplyToFinJSONBody

type ReplyToFinJSONBody struct {
	// Attachments An array of attachments to include with the message. Maximum of 10 attachments.
	Attachments *[]FinAgentAttachmentSchema `json:"attachments,omitempty"`

	// ConversationId The ID of the conversation.
	ConversationId string `json:"conversation_id"`

	// FinAgentMessageSchema A message exchanged within a Fin Agent conversation.
	FinAgentMessageSchema FinAgentMessageSchema `json:"message"`

	// FinAgentUserSchema A user object representing the user in a Fin Agent conversation.
	FinAgentUserSchema FinAgentUserSchema `json:"user"`
}

ReplyToFinJSONBody defines parameters for ReplyToFin.

type ReplyToFinJSONRequestBody

type ReplyToFinJSONRequestBody ReplyToFinJSONBody

ReplyToFinJSONRequestBody defines body for ReplyToFin for application/json ContentType.

type ReplyToFinParams

type ReplyToFinParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ReplyToFinParams defines parameters for ReplyToFin.

type ReplyToFinResponse

type ReplyToFinResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// ConversationId The ID of the conversation.
		ConversationId *string `json:"conversation_id,omitempty"`

		// CreatedAtMs The timestamp the response was created at, with millisecond precision.
		CreatedAtMs *time.Time `json:"created_at_ms,omitempty"`

		// FinAgentAttributeErrorsSchema Contains error details if any user or conversation attribute updates failed.
		FinAgentAttributeErrorsSchema *FinAgentAttributeErrorsSchema `json:"errors,omitempty"`

		// SseSubscriptionUrl Optional. A URL to subscribe to Server-Sent Events (SSE) for this conversation, if SSE is enabled. The access token is a JWT with a 3-minute TTL. The token is revoked when Fin sets the conversation to awaiting_user_reply or complete status.
		SseSubscriptionUrl *string `json:"sse_subscription_url,omitempty"`

		// Status Fin's current status in the conversation workflow.
		Status *ReplyToFin200Status `json:"status,omitempty"`

		// UserId The ID of the user.
		UserId *string `json:"user_id,omitempty"`
	}
	JSON400 *ErrorSchema
	JSON401 *ErrorSchema
}

func ParseReplyToFinResponse

func ParseReplyToFinResponse(rsp *http.Response) (*ReplyToFinResponse, error)

ParseReplyToFinResponse parses an HTTP response from a ReplyToFinWithResponse call

func (ReplyToFinResponse) Status

func (r ReplyToFinResponse) Status() string

Status returns HTTPResponse.Status

func (ReplyToFinResponse) StatusCode

func (r ReplyToFinResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type RetrieveACompanyByIdParams

type RetrieveACompanyByIdParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

RetrieveACompanyByIdParams defines parameters for RetrieveACompanyById.

type RetrieveACompanyByIdResponse

type RetrieveACompanyByIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CompanySchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseRetrieveACompanyByIdResponse

func ParseRetrieveACompanyByIdResponse(rsp *http.Response) (*RetrieveACompanyByIdResponse, error)

ParseRetrieveACompanyByIdResponse parses an HTTP response from a RetrieveACompanyByIdWithResponse call

func (RetrieveACompanyByIdResponse) Status

Status returns HTTPResponse.Status

func (RetrieveACompanyByIdResponse) StatusCode

func (r RetrieveACompanyByIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RetrieveAdminParams

type RetrieveAdminParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

RetrieveAdminParams defines parameters for RetrieveAdmin.

type RetrieveAdminResponse

type RetrieveAdminResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *AdminSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseRetrieveAdminResponse

func ParseRetrieveAdminResponse(rsp *http.Response) (*RetrieveAdminResponse, error)

ParseRetrieveAdminResponse parses an HTTP response from a RetrieveAdminWithResponse call

func (RetrieveAdminResponse) Status

func (r RetrieveAdminResponse) Status() string

Status returns HTTPResponse.Status

func (RetrieveAdminResponse) StatusCode

func (r RetrieveAdminResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RetrieveArticleParams

type RetrieveArticleParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

RetrieveArticleParams defines parameters for RetrieveArticle.

type RetrieveArticleResponse

type RetrieveArticleResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ArticleSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseRetrieveArticleResponse

func ParseRetrieveArticleResponse(rsp *http.Response) (*RetrieveArticleResponse, error)

ParseRetrieveArticleResponse parses an HTTP response from a RetrieveArticleWithResponse call

func (RetrieveArticleResponse) Status

func (r RetrieveArticleResponse) Status() string

Status returns HTTPResponse.Status

func (RetrieveArticleResponse) StatusCode

func (r RetrieveArticleResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RetrieveBrandParams

type RetrieveBrandParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

RetrieveBrandParams defines parameters for RetrieveBrand.

type RetrieveBrandResponse

type RetrieveBrandResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *BrandSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseRetrieveBrandResponse

func ParseRetrieveBrandResponse(rsp *http.Response) (*RetrieveBrandResponse, error)

ParseRetrieveBrandResponse parses an HTTP response from a RetrieveBrandWithResponse call

func (RetrieveBrandResponse) Status

func (r RetrieveBrandResponse) Status() string

Status returns HTTPResponse.Status

func (RetrieveBrandResponse) StatusCode

func (r RetrieveBrandResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RetrieveCollectionParams

type RetrieveCollectionParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

RetrieveCollectionParams defines parameters for RetrieveCollection.

type RetrieveCollectionResponse

type RetrieveCollectionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CollectionSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseRetrieveCollectionResponse

func ParseRetrieveCollectionResponse(rsp *http.Response) (*RetrieveCollectionResponse, error)

ParseRetrieveCollectionResponse parses an HTTP response from a RetrieveCollectionWithResponse call

func (RetrieveCollectionResponse) Status

Status returns HTTPResponse.Status

func (RetrieveCollectionResponse) StatusCode

func (r RetrieveCollectionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RetrieveCompanyParams

type RetrieveCompanyParams struct {
	// Name The `name` of the company to filter by.
	Name *string `form:"name,omitempty" json:"name,omitempty"`

	// CompanyId The `company_id` of the company to filter by.
	CompanyId *string `form:"company_id,omitempty" json:"company_id,omitempty"`

	// TagId The `tag_id` of the company to filter by.
	TagId *string `form:"tag_id,omitempty" json:"tag_id,omitempty"`

	// SegmentId The `segment_id` of the company to filter by.
	SegmentId *string `form:"segment_id,omitempty" json:"segment_id,omitempty"`

	// Page The page of results to fetch. Defaults to first page
	Page *int `form:"page,omitempty" json:"page,omitempty"`

	// PerPage How many results to display per page. Defaults to 15
	PerPage         *int             `form:"per_page,omitempty" json:"per_page,omitempty"`
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

RetrieveCompanyParams defines parameters for RetrieveCompany.

type RetrieveCompanyResponse

type RetrieveCompanyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CompanyListSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseRetrieveCompanyResponse

func ParseRetrieveCompanyResponse(rsp *http.Response) (*RetrieveCompanyResponse, error)

ParseRetrieveCompanyResponse parses an HTTP response from a RetrieveCompanyWithResponse call

func (RetrieveCompanyResponse) Status

func (r RetrieveCompanyResponse) Status() string

Status returns HTTPResponse.Status

func (RetrieveCompanyResponse) StatusCode

func (r RetrieveCompanyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RetrieveConversationParams

type RetrieveConversationParams struct {
	// DisplayAs Set to plaintext to retrieve conversation messages in plain text.
	DisplayAs *string `form:"display_as,omitempty" json:"display_as,omitempty"`

	// IncludeTranslations If set to true, conversation parts will be translated to the detected language of the conversation.
	IncludeTranslations *bool            `form:"include_translations,omitempty" json:"include_translations,omitempty"`
	IntercomVersion     *IntercomVersion `json:"Intercom-Version,omitempty"`
}

RetrieveConversationParams defines parameters for RetrieveConversation.

type RetrieveConversationResponse

type RetrieveConversationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ConversationSchema
	JSON401      *ErrorSchema
	JSON403      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseRetrieveConversationResponse

func ParseRetrieveConversationResponse(rsp *http.Response) (*RetrieveConversationResponse, error)

ParseRetrieveConversationResponse parses an HTTP response from a RetrieveConversationWithResponse call

func (RetrieveConversationResponse) Status

Status returns HTTPResponse.Status

func (RetrieveConversationResponse) StatusCode

func (r RetrieveConversationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RetrieveEmailParams

type RetrieveEmailParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

RetrieveEmailParams defines parameters for RetrieveEmail.

type RetrieveEmailResponse

type RetrieveEmailResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *EmailSettingSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseRetrieveEmailResponse

func ParseRetrieveEmailResponse(rsp *http.Response) (*RetrieveEmailResponse, error)

ParseRetrieveEmailResponse parses an HTTP response from a RetrieveEmailWithResponse call

func (RetrieveEmailResponse) Status

func (r RetrieveEmailResponse) Status() string

Status returns HTTPResponse.Status

func (RetrieveEmailResponse) StatusCode

func (r RetrieveEmailResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RetrieveHelpCenterParams

type RetrieveHelpCenterParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

RetrieveHelpCenterParams defines parameters for RetrieveHelpCenter.

type RetrieveHelpCenterResponse

type RetrieveHelpCenterResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *HelpCenterSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseRetrieveHelpCenterResponse

func ParseRetrieveHelpCenterResponse(rsp *http.Response) (*RetrieveHelpCenterResponse, error)

ParseRetrieveHelpCenterResponse parses an HTTP response from a RetrieveHelpCenterWithResponse call

func (RetrieveHelpCenterResponse) Status

Status returns HTTPResponse.Status

func (RetrieveHelpCenterResponse) StatusCode

func (r RetrieveHelpCenterResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RetrieveInternalArticleParams

type RetrieveInternalArticleParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

RetrieveInternalArticleParams defines parameters for RetrieveInternalArticle.

type RetrieveInternalArticleResponse

type RetrieveInternalArticleResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *InternalArticleSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseRetrieveInternalArticleResponse

func ParseRetrieveInternalArticleResponse(rsp *http.Response) (*RetrieveInternalArticleResponse, error)

ParseRetrieveInternalArticleResponse parses an HTTP response from a RetrieveInternalArticleWithResponse call

func (RetrieveInternalArticleResponse) Status

Status returns HTTPResponse.Status

func (RetrieveInternalArticleResponse) StatusCode

func (r RetrieveInternalArticleResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RetrieveNewsItemParams

type RetrieveNewsItemParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

RetrieveNewsItemParams defines parameters for RetrieveNewsItem.

type RetrieveNewsItemResponse

type RetrieveNewsItemResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *NewsItemSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseRetrieveNewsItemResponse

func ParseRetrieveNewsItemResponse(rsp *http.Response) (*RetrieveNewsItemResponse, error)

ParseRetrieveNewsItemResponse parses an HTTP response from a RetrieveNewsItemWithResponse call

func (RetrieveNewsItemResponse) Status

func (r RetrieveNewsItemResponse) Status() string

Status returns HTTPResponse.Status

func (RetrieveNewsItemResponse) StatusCode

func (r RetrieveNewsItemResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RetrieveNewsfeedParams

type RetrieveNewsfeedParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

RetrieveNewsfeedParams defines parameters for RetrieveNewsfeed.

type RetrieveNewsfeedResponse

type RetrieveNewsfeedResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *NewsfeedSchema
	JSON401      *ErrorSchema
}

func ParseRetrieveNewsfeedResponse

func ParseRetrieveNewsfeedResponse(rsp *http.Response) (*RetrieveNewsfeedResponse, error)

ParseRetrieveNewsfeedResponse parses an HTTP response from a RetrieveNewsfeedWithResponse call

func (RetrieveNewsfeedResponse) Status

func (r RetrieveNewsfeedResponse) Status() string

Status returns HTTPResponse.Status

func (RetrieveNewsfeedResponse) StatusCode

func (r RetrieveNewsfeedResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RetrieveNoteParams

type RetrieveNoteParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

RetrieveNoteParams defines parameters for RetrieveNote.

type RetrieveNoteResponse

type RetrieveNoteResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *NoteSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseRetrieveNoteResponse

func ParseRetrieveNoteResponse(rsp *http.Response) (*RetrieveNoteResponse, error)

ParseRetrieveNoteResponse parses an HTTP response from a RetrieveNoteWithResponse call

func (RetrieveNoteResponse) Status

func (r RetrieveNoteResponse) Status() string

Status returns HTTPResponse.Status

func (RetrieveNoteResponse) StatusCode

func (r RetrieveNoteResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RetrieveSegmentParams

type RetrieveSegmentParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

RetrieveSegmentParams defines parameters for RetrieveSegment.

type RetrieveSegmentResponse

type RetrieveSegmentResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SegmentSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseRetrieveSegmentResponse

func ParseRetrieveSegmentResponse(rsp *http.Response) (*RetrieveSegmentResponse, error)

ParseRetrieveSegmentResponse parses an HTTP response from a RetrieveSegmentWithResponse call

func (RetrieveSegmentResponse) Status

func (r RetrieveSegmentResponse) Status() string

Status returns HTTPResponse.Status

func (RetrieveSegmentResponse) StatusCode

func (r RetrieveSegmentResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RetrieveTeamParams

type RetrieveTeamParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

RetrieveTeamParams defines parameters for RetrieveTeam.

type RetrieveTeamResponse

type RetrieveTeamResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TeamSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseRetrieveTeamResponse

func ParseRetrieveTeamResponse(rsp *http.Response) (*RetrieveTeamResponse, error)

ParseRetrieveTeamResponse parses an HTTP response from a RetrieveTeamWithResponse call

func (RetrieveTeamResponse) Status

func (r RetrieveTeamResponse) Status() string

Status returns HTTPResponse.Status

func (RetrieveTeamResponse) StatusCode

func (r RetrieveTeamResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RetrieveVisitorWithUserIdParams

type RetrieveVisitorWithUserIdParams struct {
	// UserId The user_id of the Visitor you want to retrieve.
	UserId          string           `form:"user_id" json:"user_id"`
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

RetrieveVisitorWithUserIdParams defines parameters for RetrieveVisitorWithUserId.

type RetrieveVisitorWithUserIdResponse

type RetrieveVisitorWithUserIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *VisitorSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseRetrieveVisitorWithUserIdResponse

func ParseRetrieveVisitorWithUserIdResponse(rsp *http.Response) (*RetrieveVisitorWithUserIdResponse, error)

ParseRetrieveVisitorWithUserIdResponse parses an HTTP response from a RetrieveVisitorWithUserIdWithResponse call

func (RetrieveVisitorWithUserIdResponse) Status

Status returns HTTPResponse.Status

func (RetrieveVisitorWithUserIdResponse) StatusCode

func (r RetrieveVisitorWithUserIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ScrollOverAllCompaniesParams

type ScrollOverAllCompaniesParams struct {
	ScrollParam     *string          `form:"scroll_param,omitempty" json:"scroll_param,omitempty"`
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ScrollOverAllCompaniesParams defines parameters for ScrollOverAllCompanies.

type ScrollOverAllCompaniesResponse

type ScrollOverAllCompaniesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CompanyScrollSchema
	JSON401      *ErrorSchema
}

func ParseScrollOverAllCompaniesResponse

func ParseScrollOverAllCompaniesResponse(rsp *http.Response) (*ScrollOverAllCompaniesResponse, error)

ParseScrollOverAllCompaniesResponse parses an HTTP response from a ScrollOverAllCompaniesWithResponse call

func (ScrollOverAllCompaniesResponse) Status

Status returns HTTPResponse.Status

func (ScrollOverAllCompaniesResponse) StatusCode

func (r ScrollOverAllCompaniesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SearchArticlesParams

type SearchArticlesParams struct {
	// Phrase The phrase within your articles to search for.
	Phrase *string `form:"phrase,omitempty" json:"phrase,omitempty"`

	// State The state of the Articles returned. One of `published`, `draft` or `all`.
	State *string `form:"state,omitempty" json:"state,omitempty"`

	// HelpCenterId The ID of the Help Center to search in.
	HelpCenterId *int `form:"help_center_id,omitempty" json:"help_center_id,omitempty"`

	// Highlight Return a highlighted version of the matching content within your articles. Refer to the response schema for more details.
	Highlight       *bool            `form:"highlight,omitempty" json:"highlight,omitempty"`
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

SearchArticlesParams defines parameters for SearchArticles.

type SearchArticlesResponse

type SearchArticlesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ArticleSearchResponseSchema
	JSON401      *ErrorSchema
}

func ParseSearchArticlesResponse

func ParseSearchArticlesResponse(rsp *http.Response) (*SearchArticlesResponse, error)

ParseSearchArticlesResponse parses an HTTP response from a SearchArticlesWithResponse call

func (SearchArticlesResponse) Status

func (r SearchArticlesResponse) Status() string

Status returns HTTPResponse.Status

func (SearchArticlesResponse) StatusCode

func (r SearchArticlesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SearchContactsJSONRequestBody

type SearchContactsJSONRequestBody = SearchRequestSchema

SearchContactsJSONRequestBody defines body for SearchContacts for application/json ContentType.

type SearchContactsParams

type SearchContactsParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

SearchContactsParams defines parameters for SearchContacts.

type SearchContactsResponse

type SearchContactsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ContactListSchema
	JSON401      *ErrorSchema
}

func ParseSearchContactsResponse

func ParseSearchContactsResponse(rsp *http.Response) (*SearchContactsResponse, error)

ParseSearchContactsResponse parses an HTTP response from a SearchContactsWithResponse call

func (SearchContactsResponse) Status

func (r SearchContactsResponse) Status() string

Status returns HTTPResponse.Status

func (SearchContactsResponse) StatusCode

func (r SearchContactsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SearchConversationsJSONRequestBody

type SearchConversationsJSONRequestBody = SearchRequestSchema

SearchConversationsJSONRequestBody defines body for SearchConversations for application/json ContentType.

type SearchConversationsParams

type SearchConversationsParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

SearchConversationsParams defines parameters for SearchConversations.

type SearchConversationsResponse

type SearchConversationsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ConversationListSchema
}

func ParseSearchConversationsResponse

func ParseSearchConversationsResponse(rsp *http.Response) (*SearchConversationsResponse, error)

ParseSearchConversationsResponse parses an HTTP response from a SearchConversationsWithResponse call

func (SearchConversationsResponse) Status

Status returns HTTPResponse.Status

func (SearchConversationsResponse) StatusCode

func (r SearchConversationsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SearchInternalArticlesParams

type SearchInternalArticlesParams struct {
	// FolderId The ID of the folder to search in.
	FolderId        *string          `form:"folder_id,omitempty" json:"folder_id,omitempty"`
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

SearchInternalArticlesParams defines parameters for SearchInternalArticles.

type SearchInternalArticlesResponse

type SearchInternalArticlesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *InternalArticleSearchResponseSchema
	JSON401      *ErrorSchema
}

func ParseSearchInternalArticlesResponse

func ParseSearchInternalArticlesResponse(rsp *http.Response) (*SearchInternalArticlesResponse, error)

ParseSearchInternalArticlesResponse parses an HTTP response from a SearchInternalArticlesWithResponse call

func (SearchInternalArticlesResponse) Status

Status returns HTTPResponse.Status

func (SearchInternalArticlesResponse) StatusCode

func (r SearchInternalArticlesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SearchRequestSchema

type SearchRequestSchema struct {
	Pagination *StartingAfterPagingSchema `json:"pagination,omitempty"`
	Query      SearchRequest_Query        `json:"query"`
}

SearchRequestSchema Search using Intercoms Search APIs.

type SearchRequest_Query

type SearchRequest_Query struct {
	// contains filtered or unexported fields
}

SearchRequest_Query defines model for SearchRequest.Query.

func (SearchRequest_Query) AsMultipleFilterSearchRequestSchema

func (t SearchRequest_Query) AsMultipleFilterSearchRequestSchema() (MultipleFilterSearchRequestSchema, error)

AsMultipleFilterSearchRequestSchema returns the union data inside the SearchRequest_Query as a MultipleFilterSearchRequestSchema

func (SearchRequest_Query) AsSingleFilterSearchRequestSchema

func (t SearchRequest_Query) AsSingleFilterSearchRequestSchema() (SingleFilterSearchRequestSchema, error)

AsSingleFilterSearchRequestSchema returns the union data inside the SearchRequest_Query as a SingleFilterSearchRequestSchema

func (*SearchRequest_Query) FromMultipleFilterSearchRequestSchema

func (t *SearchRequest_Query) FromMultipleFilterSearchRequestSchema(v MultipleFilterSearchRequestSchema) error

FromMultipleFilterSearchRequestSchema overwrites any union data inside the SearchRequest_Query as the provided MultipleFilterSearchRequestSchema

func (*SearchRequest_Query) FromSingleFilterSearchRequestSchema

func (t *SearchRequest_Query) FromSingleFilterSearchRequestSchema(v SingleFilterSearchRequestSchema) error

FromSingleFilterSearchRequestSchema overwrites any union data inside the SearchRequest_Query as the provided SingleFilterSearchRequestSchema

func (SearchRequest_Query) MarshalJSON

func (t SearchRequest_Query) MarshalJSON() ([]byte, error)

func (*SearchRequest_Query) MergeMultipleFilterSearchRequestSchema

func (t *SearchRequest_Query) MergeMultipleFilterSearchRequestSchema(v MultipleFilterSearchRequestSchema) error

MergeMultipleFilterSearchRequestSchema performs a merge with any union data inside the SearchRequest_Query, using the provided MultipleFilterSearchRequestSchema

func (*SearchRequest_Query) MergeSingleFilterSearchRequestSchema

func (t *SearchRequest_Query) MergeSingleFilterSearchRequestSchema(v SingleFilterSearchRequestSchema) error

MergeSingleFilterSearchRequestSchema performs a merge with any union data inside the SearchRequest_Query, using the provided SingleFilterSearchRequestSchema

func (*SearchRequest_Query) UnmarshalJSON

func (t *SearchRequest_Query) UnmarshalJSON(b []byte) error

type SearchTicketsJSONRequestBody

type SearchTicketsJSONRequestBody = SearchRequestSchema

SearchTicketsJSONRequestBody defines body for SearchTickets for application/json ContentType.

type SearchTicketsParams

type SearchTicketsParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

SearchTicketsParams defines parameters for SearchTickets.

type SearchTicketsResponse

type SearchTicketsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TicketListSchema
}

func ParseSearchTicketsResponse

func ParseSearchTicketsResponse(rsp *http.Response) (*SearchTicketsResponse, error)

ParseSearchTicketsResponse parses an HTTP response from a SearchTicketsWithResponse call

func (SearchTicketsResponse) Status

func (r SearchTicketsResponse) Status() string

Status returns HTTPResponse.Status

func (SearchTicketsResponse) StatusCode

func (r SearchTicketsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SegmentListSchema

type SegmentListSchema struct {
	// Pages A pagination object, which may be empty, indicating no further pages to fetch.
	Pages *map[string]interface{} `json:"pages,omitempty"`

	// Segments A list of Segment objects
	Segments *[]SegmentSchema `json:"segments,omitempty"`

	// Type The type of the object
	Type *SegmentListType `json:"type,omitempty"`
}

SegmentListSchema This will return a list of Segment Objects. The result may also have a pages object if the response is paginated.

type SegmentListType

type SegmentListType string

SegmentListType The type of the object

const (
	SegmentListTypeSegmentList SegmentListType = "segment.list"
)

Defines values for SegmentListType.

func (SegmentListType) Valid

func (e SegmentListType) Valid() bool

Valid indicates whether the value is a known member of the SegmentListType enum.

type SegmentPersonType

type SegmentPersonType string

SegmentPersonType Type of the contact: contact (lead) or user.

const (
	SegmentPersonTypeContact SegmentPersonType = "contact"
	SegmentPersonTypeUser    SegmentPersonType = "user"
)

Defines values for SegmentPersonType.

func (SegmentPersonType) Valid

func (e SegmentPersonType) Valid() bool

Valid indicates whether the value is a known member of the SegmentPersonType enum.

type SegmentSchema

type SegmentSchema struct {
	// Count The number of items in the user segment. It's returned when `include_count=true` is included in the request.
	Count *int `json:"count,omitempty"`

	// CreatedAt The time the segment was created.
	CreatedAt *int `json:"created_at,omitempty"`

	// Id The unique identifier representing the segment.
	Id *string `json:"id,omitempty"`

	// Name The name of the segment.
	Name *string `json:"name,omitempty"`

	// PersonType Type of the contact: contact (lead) or user.
	PersonType *SegmentPersonType `json:"person_type,omitempty"`

	// Type The type of object.
	Type *SegmentType `json:"type,omitempty"`

	// UpdatedAt The time the segment was updated.
	UpdatedAt *int `json:"updated_at,omitempty"`
}

SegmentSchema A segment is a group of your contacts defined by the rules that you set.

type SegmentType

type SegmentType string

SegmentType The type of object.

const (
	Segment SegmentType = "segment"
)

Defines values for SegmentType.

func (SegmentType) Valid

func (e SegmentType) Valid() bool

Valid indicates whether the value is a known member of the SegmentType enum.

type SetAwayAdminJSONBody

type SetAwayAdminJSONBody struct {
	// AwayModeEnabled Set to "true" to change the status of the admin to away.
	AwayModeEnabled bool `json:"away_mode_enabled"`

	// AwayModeReassign Set to "true" to assign any new conversation replies to your default inbox.
	AwayModeReassign bool `json:"away_mode_reassign"`

	// AwayStatusReasonId The unique identifier of the away status reason
	AwayStatusReasonId *int `json:"away_status_reason_id,omitempty"`
}

SetAwayAdminJSONBody defines parameters for SetAwayAdmin.

type SetAwayAdminJSONRequestBody

type SetAwayAdminJSONRequestBody SetAwayAdminJSONBody

SetAwayAdminJSONRequestBody defines body for SetAwayAdmin for application/json ContentType.

type SetAwayAdminParams

type SetAwayAdminParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

SetAwayAdminParams defines parameters for SetAwayAdmin.

type SetAwayAdminResponse

type SetAwayAdminResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *AdminSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseSetAwayAdminResponse

func ParseSetAwayAdminResponse(rsp *http.Response) (*SetAwayAdminResponse, error)

ParseSetAwayAdminResponse parses an HTTP response from a SetAwayAdminWithResponse call

func (SetAwayAdminResponse) Status

func (r SetAwayAdminResponse) Status() string

Status returns HTTPResponse.Status

func (SetAwayAdminResponse) StatusCode

func (r SetAwayAdminResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ShowCallParams

type ShowCallParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ShowCallParams defines parameters for ShowCall.

type ShowCallRecordingParams

type ShowCallRecordingParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ShowCallRecordingParams defines parameters for ShowCallRecording.

type ShowCallRecordingResponse

type ShowCallRecordingResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseShowCallRecordingResponse

func ParseShowCallRecordingResponse(rsp *http.Response) (*ShowCallRecordingResponse, error)

ParseShowCallRecordingResponse parses an HTTP response from a ShowCallRecordingWithResponse call

func (ShowCallRecordingResponse) Status

func (r ShowCallRecordingResponse) Status() string

Status returns HTTPResponse.Status

func (ShowCallRecordingResponse) StatusCode

func (r ShowCallRecordingResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ShowCallResponse

type ShowCallResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CallSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseShowCallResponse

func ParseShowCallResponse(rsp *http.Response) (*ShowCallResponse, error)

ParseShowCallResponse parses an HTTP response from a ShowCallWithResponse call

func (ShowCallResponse) Status

func (r ShowCallResponse) Status() string

Status returns HTTPResponse.Status

func (ShowCallResponse) StatusCode

func (r ShowCallResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ShowCallTranscriptParams

type ShowCallTranscriptParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ShowCallTranscriptParams defines parameters for ShowCallTranscript.

type ShowCallTranscriptResponse

type ShowCallTranscriptResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON404      *ErrorSchema
}

func ParseShowCallTranscriptResponse

func ParseShowCallTranscriptResponse(rsp *http.Response) (*ShowCallTranscriptResponse, error)

ParseShowCallTranscriptResponse parses an HTTP response from a ShowCallTranscriptWithResponse call

func (ShowCallTranscriptResponse) Status

Status returns HTTPResponse.Status

func (ShowCallTranscriptResponse) StatusCode

func (r ShowCallTranscriptResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ShowContactByExternalIdParams

type ShowContactByExternalIdParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ShowContactByExternalIdParams defines parameters for ShowContactByExternalId.

type ShowContactByExternalIdResponse

type ShowContactByExternalIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ContactSchema
	JSON401      *ErrorSchema
}

func ParseShowContactByExternalIdResponse

func ParseShowContactByExternalIdResponse(rsp *http.Response) (*ShowContactByExternalIdResponse, error)

ParseShowContactByExternalIdResponse parses an HTTP response from a ShowContactByExternalIdWithResponse call

func (ShowContactByExternalIdResponse) Status

Status returns HTTPResponse.Status

func (ShowContactByExternalIdResponse) StatusCode

func (r ShowContactByExternalIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ShowContactParams

type ShowContactParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

ShowContactParams defines parameters for ShowContact.

type ShowContactResponse

type ShowContactResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ContactSchema
	JSON401      *ErrorSchema
}

func ParseShowContactResponse

func ParseShowContactResponse(rsp *http.Response) (*ShowContactResponse, error)

ParseShowContactResponse parses an HTTP response from a ShowContactWithResponse call

func (ShowContactResponse) Status

func (r ShowContactResponse) Status() string

Status returns HTTPResponse.Status

func (ShowContactResponse) StatusCode

func (r ShowContactResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SingleFilterSearchRequestOperator

type SingleFilterSearchRequestOperator string

SingleFilterSearchRequestOperator The accepted operators you can use to define how you want to search for the value.

func (SingleFilterSearchRequestOperator) Valid

Valid indicates whether the value is a known member of the SingleFilterSearchRequestOperator enum.

type SingleFilterSearchRequestSchema

type SingleFilterSearchRequestSchema struct {
	// Field The accepted field that you want to search on.
	Field *string `json:"field,omitempty"`

	// Operator The accepted operators you can use to define how you want to search for the value.
	Operator *SingleFilterSearchRequestOperator `json:"operator,omitempty"`

	// Value The value that you want to search on.
	Value *SingleFilterSearchRequest_Value `json:"value,omitempty"`
}

SingleFilterSearchRequestSchema Search using Intercoms Search APIs with a single filter.

type SingleFilterSearchRequestValue0

type SingleFilterSearchRequestValue0 = string

SingleFilterSearchRequestValue0 defines model for .

type SingleFilterSearchRequestValue1

type SingleFilterSearchRequestValue1 = int

SingleFilterSearchRequestValue1 defines model for .

type SingleFilterSearchRequestValue2

type SingleFilterSearchRequestValue2 = bool

SingleFilterSearchRequestValue2 defines model for .

type SingleFilterSearchRequestValue3

type SingleFilterSearchRequestValue3 = []SingleFilterSearchRequest_Value_3_Item

SingleFilterSearchRequestValue3 defines model for .

type SingleFilterSearchRequestValue30

type SingleFilterSearchRequestValue30 = string

SingleFilterSearchRequestValue30 defines model for .

type SingleFilterSearchRequestValue31

type SingleFilterSearchRequestValue31 = int

SingleFilterSearchRequestValue31 defines model for .

type SingleFilterSearchRequest_Value

type SingleFilterSearchRequest_Value struct {
	// contains filtered or unexported fields
}

SingleFilterSearchRequest_Value The value that you want to search on.

func (SingleFilterSearchRequest_Value) AsSingleFilterSearchRequestValue0

func (t SingleFilterSearchRequest_Value) AsSingleFilterSearchRequestValue0() (SingleFilterSearchRequestValue0, error)

AsSingleFilterSearchRequestValue0 returns the union data inside the SingleFilterSearchRequest_Value as a SingleFilterSearchRequestValue0

func (SingleFilterSearchRequest_Value) AsSingleFilterSearchRequestValue1

func (t SingleFilterSearchRequest_Value) AsSingleFilterSearchRequestValue1() (SingleFilterSearchRequestValue1, error)

AsSingleFilterSearchRequestValue1 returns the union data inside the SingleFilterSearchRequest_Value as a SingleFilterSearchRequestValue1

func (SingleFilterSearchRequest_Value) AsSingleFilterSearchRequestValue2

func (t SingleFilterSearchRequest_Value) AsSingleFilterSearchRequestValue2() (SingleFilterSearchRequestValue2, error)

AsSingleFilterSearchRequestValue2 returns the union data inside the SingleFilterSearchRequest_Value as a SingleFilterSearchRequestValue2

func (SingleFilterSearchRequest_Value) AsSingleFilterSearchRequestValue3

func (t SingleFilterSearchRequest_Value) AsSingleFilterSearchRequestValue3() (SingleFilterSearchRequestValue3, error)

AsSingleFilterSearchRequestValue3 returns the union data inside the SingleFilterSearchRequest_Value as a SingleFilterSearchRequestValue3

func (*SingleFilterSearchRequest_Value) FromSingleFilterSearchRequestValue0

func (t *SingleFilterSearchRequest_Value) FromSingleFilterSearchRequestValue0(v SingleFilterSearchRequestValue0) error

FromSingleFilterSearchRequestValue0 overwrites any union data inside the SingleFilterSearchRequest_Value as the provided SingleFilterSearchRequestValue0

func (*SingleFilterSearchRequest_Value) FromSingleFilterSearchRequestValue1

func (t *SingleFilterSearchRequest_Value) FromSingleFilterSearchRequestValue1(v SingleFilterSearchRequestValue1) error

FromSingleFilterSearchRequestValue1 overwrites any union data inside the SingleFilterSearchRequest_Value as the provided SingleFilterSearchRequestValue1

func (*SingleFilterSearchRequest_Value) FromSingleFilterSearchRequestValue2

func (t *SingleFilterSearchRequest_Value) FromSingleFilterSearchRequestValue2(v SingleFilterSearchRequestValue2) error

FromSingleFilterSearchRequestValue2 overwrites any union data inside the SingleFilterSearchRequest_Value as the provided SingleFilterSearchRequestValue2

func (*SingleFilterSearchRequest_Value) FromSingleFilterSearchRequestValue3

func (t *SingleFilterSearchRequest_Value) FromSingleFilterSearchRequestValue3(v SingleFilterSearchRequestValue3) error

FromSingleFilterSearchRequestValue3 overwrites any union data inside the SingleFilterSearchRequest_Value as the provided SingleFilterSearchRequestValue3

func (SingleFilterSearchRequest_Value) MarshalJSON

func (t SingleFilterSearchRequest_Value) MarshalJSON() ([]byte, error)

func (*SingleFilterSearchRequest_Value) MergeSingleFilterSearchRequestValue0

func (t *SingleFilterSearchRequest_Value) MergeSingleFilterSearchRequestValue0(v SingleFilterSearchRequestValue0) error

MergeSingleFilterSearchRequestValue0 performs a merge with any union data inside the SingleFilterSearchRequest_Value, using the provided SingleFilterSearchRequestValue0

func (*SingleFilterSearchRequest_Value) MergeSingleFilterSearchRequestValue1

func (t *SingleFilterSearchRequest_Value) MergeSingleFilterSearchRequestValue1(v SingleFilterSearchRequestValue1) error

MergeSingleFilterSearchRequestValue1 performs a merge with any union data inside the SingleFilterSearchRequest_Value, using the provided SingleFilterSearchRequestValue1

func (*SingleFilterSearchRequest_Value) MergeSingleFilterSearchRequestValue2

func (t *SingleFilterSearchRequest_Value) MergeSingleFilterSearchRequestValue2(v SingleFilterSearchRequestValue2) error

MergeSingleFilterSearchRequestValue2 performs a merge with any union data inside the SingleFilterSearchRequest_Value, using the provided SingleFilterSearchRequestValue2

func (*SingleFilterSearchRequest_Value) MergeSingleFilterSearchRequestValue3

func (t *SingleFilterSearchRequest_Value) MergeSingleFilterSearchRequestValue3(v SingleFilterSearchRequestValue3) error

MergeSingleFilterSearchRequestValue3 performs a merge with any union data inside the SingleFilterSearchRequest_Value, using the provided SingleFilterSearchRequestValue3

func (*SingleFilterSearchRequest_Value) UnmarshalJSON

func (t *SingleFilterSearchRequest_Value) UnmarshalJSON(b []byte) error

type SingleFilterSearchRequest_Value_3_Item

type SingleFilterSearchRequest_Value_3_Item struct {
	// contains filtered or unexported fields
}

SingleFilterSearchRequest_Value_3_Item defines model for SingleFilterSearchRequest.Value.3.Item.

func (SingleFilterSearchRequest_Value_3_Item) AsSingleFilterSearchRequestValue30

func (t SingleFilterSearchRequest_Value_3_Item) AsSingleFilterSearchRequestValue30() (SingleFilterSearchRequestValue30, error)

AsSingleFilterSearchRequestValue30 returns the union data inside the SingleFilterSearchRequest_Value_3_Item as a SingleFilterSearchRequestValue30

func (SingleFilterSearchRequest_Value_3_Item) AsSingleFilterSearchRequestValue31

func (t SingleFilterSearchRequest_Value_3_Item) AsSingleFilterSearchRequestValue31() (SingleFilterSearchRequestValue31, error)

AsSingleFilterSearchRequestValue31 returns the union data inside the SingleFilterSearchRequest_Value_3_Item as a SingleFilterSearchRequestValue31

func (*SingleFilterSearchRequest_Value_3_Item) FromSingleFilterSearchRequestValue30

func (t *SingleFilterSearchRequest_Value_3_Item) FromSingleFilterSearchRequestValue30(v SingleFilterSearchRequestValue30) error

FromSingleFilterSearchRequestValue30 overwrites any union data inside the SingleFilterSearchRequest_Value_3_Item as the provided SingleFilterSearchRequestValue30

func (*SingleFilterSearchRequest_Value_3_Item) FromSingleFilterSearchRequestValue31

func (t *SingleFilterSearchRequest_Value_3_Item) FromSingleFilterSearchRequestValue31(v SingleFilterSearchRequestValue31) error

FromSingleFilterSearchRequestValue31 overwrites any union data inside the SingleFilterSearchRequest_Value_3_Item as the provided SingleFilterSearchRequestValue31

func (SingleFilterSearchRequest_Value_3_Item) MarshalJSON

func (t SingleFilterSearchRequest_Value_3_Item) MarshalJSON() ([]byte, error)

func (*SingleFilterSearchRequest_Value_3_Item) MergeSingleFilterSearchRequestValue30

func (t *SingleFilterSearchRequest_Value_3_Item) MergeSingleFilterSearchRequestValue30(v SingleFilterSearchRequestValue30) error

MergeSingleFilterSearchRequestValue30 performs a merge with any union data inside the SingleFilterSearchRequest_Value_3_Item, using the provided SingleFilterSearchRequestValue30

func (*SingleFilterSearchRequest_Value_3_Item) MergeSingleFilterSearchRequestValue31

func (t *SingleFilterSearchRequest_Value_3_Item) MergeSingleFilterSearchRequestValue31(v SingleFilterSearchRequestValue31) error

MergeSingleFilterSearchRequestValue31 performs a merge with any union data inside the SingleFilterSearchRequest_Value_3_Item, using the provided SingleFilterSearchRequestValue31

func (*SingleFilterSearchRequest_Value_3_Item) UnmarshalJSON

func (t *SingleFilterSearchRequest_Value_3_Item) UnmarshalJSON(b []byte) error

type SlaAppliedSchema

type SlaAppliedSchema struct {
	// SlaName The name of the SLA as given by the teammate when it was created.
	SlaName *string `json:"sla_name,omitempty"`

	// SlaStatus SLA statuses:
	//             - `hit`: If there’s at least one hit event in the underlying sla_events table, and no “missed” or “canceled” events for the conversation.
	//             - `missed`: If there are any missed sla_events for the conversation and no canceled events. If there’s even a single missed sla event, the status will always be missed. A missed status is not applied when the SLA expires, only the next time a teammate replies.
	//             - `active`: An SLA has been applied to a conversation, but has not yet been fulfilled. SLA status is active only if there are no “hit, “missed”, or “canceled” events.
	SlaStatus *SlaAppliedSlaStatus `json:"sla_status,omitempty"`

	// Type object type
	Type *string `json:"type,omitempty"`
}

SlaAppliedSchema The SLA Applied object contains the details for which SLA has been applied to this conversation. Important: if there are any canceled sla_events for the conversation - meaning an SLA has been manually removed from a conversation, the sla_status will always be returned as null.

type SlaAppliedSlaStatus

type SlaAppliedSlaStatus string

SlaAppliedSlaStatus SLA statuses:

  • `hit`: If there’s at least one hit event in the underlying sla_events table, and no “missed” or “canceled” events for the conversation.
  • `missed`: If there are any missed sla_events for the conversation and no canceled events. If there’s even a single missed sla event, the status will always be missed. A missed status is not applied when the SLA expires, only the next time a teammate replies.
  • `active`: An SLA has been applied to a conversation, but has not yet been fulfilled. SLA status is active only if there are no “hit, “missed”, or “canceled” events.
const (
	SlaAppliedSlaStatusActive    SlaAppliedSlaStatus = "active"
	SlaAppliedSlaStatusCancelled SlaAppliedSlaStatus = "cancelled"
	SlaAppliedSlaStatusHit       SlaAppliedSlaStatus = "hit"
	SlaAppliedSlaStatusMissed    SlaAppliedSlaStatus = "missed"
)

Defines values for SlaAppliedSlaStatus.

func (SlaAppliedSlaStatus) Valid

func (e SlaAppliedSlaStatus) Valid() bool

Valid indicates whether the value is a known member of the SlaAppliedSlaStatus enum.

type SnoozeConversationRequestMessageType

type SnoozeConversationRequestMessageType string

SnoozeConversationRequestMessageType defines model for SnoozeConversationRequest.MessageType.

const (
	Snoozed SnoozeConversationRequestMessageType = "snoozed"
)

Defines values for SnoozeConversationRequestMessageType.

func (SnoozeConversationRequestMessageType) Valid

Valid indicates whether the value is a known member of the SnoozeConversationRequestMessageType enum.

type SnoozeConversationRequestSchema

type SnoozeConversationRequestSchema struct {
	// AdminId The id of the admin who is performing the action.
	AdminId     string                               `json:"admin_id"`
	MessageType SnoozeConversationRequestMessageType `json:"message_type"`

	// SnoozedUntil The time you want the conversation to reopen.
	SnoozedUntil int `json:"snoozed_until"`
}

SnoozeConversationRequestSchema Payload of the request to snooze a conversation

type SocialProfileSchema

type SocialProfileSchema struct {
	// Name The name of the Social media profile
	Name *string `json:"name,omitempty"`

	// Type value is "social_profile"
	Type *string `json:"type,omitempty"`

	// Url The name of the Social media profile
	Url *string `json:"url,omitempty"`
}

SocialProfileSchema A Social Profile allows you to label your contacts, companies, and conversations and list them using that Social Profile.

type StartFinConversation200Status

type StartFinConversation200Status string

type StartFinConversationJSONBody

type StartFinConversationJSONBody struct {
	// Attachments An array of attachments to include with the message. Maximum of 10 attachments.
	Attachments *[]FinAgentAttachmentSchema `json:"attachments,omitempty"`

	// ConversationId The ID of the conversation that is calling Fin via this API.
	ConversationId string `json:"conversation_id"`

	// FinAgentConversationMetadataSchema Metadata about the conversation, including history and attributes.
	FinAgentConversationMetadataSchema *FinAgentConversationMetadataSchema `json:"conversation_metadata,omitempty"`

	// FinAgentMessageSchema A message exchanged within a Fin Agent conversation.
	FinAgentMessageSchema FinAgentMessageSchema `json:"message"`

	// FinAgentUserSchema A user object representing the user in a Fin Agent conversation.
	FinAgentUserSchema FinAgentUserSchema `json:"user"`
}

StartFinConversationJSONBody defines parameters for StartFinConversation.

type StartFinConversationJSONRequestBody

type StartFinConversationJSONRequestBody StartFinConversationJSONBody

StartFinConversationJSONRequestBody defines body for StartFinConversation for application/json ContentType.

type StartFinConversationParams

type StartFinConversationParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

StartFinConversationParams defines parameters for StartFinConversation.

type StartFinConversationResponse

type StartFinConversationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// ConversationId The ID of the conversation.
		ConversationId *string `json:"conversation_id,omitempty"`

		// CreatedAtMs The timestamp the response was created at, with millisecond precision.
		CreatedAtMs *time.Time `json:"created_at_ms,omitempty"`

		// FinAgentAttributeErrorsSchema Contains error details if any user or conversation attribute updates failed.
		FinAgentAttributeErrorsSchema *FinAgentAttributeErrorsSchema `json:"errors,omitempty"`

		// SseSubscriptionUrl Optional. A URL to subscribe to Server-Sent Events (SSE) for this conversation, if SSE is enabled. The access token is a JWT with a 3-minute TTL. The token is revoked when Fin sets the conversation to awaiting_user_reply or complete status.
		SseSubscriptionUrl *string `json:"sse_subscription_url,omitempty"`

		// Status Fin's current status in the conversation workflow.
		Status *StartFinConversation200Status `json:"status,omitempty"`

		// UserId The ID of the user.
		UserId *string `json:"user_id,omitempty"`
	}
	JSON400 *ErrorSchema
	JSON401 *ErrorSchema
}

func ParseStartFinConversationResponse

func ParseStartFinConversationResponse(rsp *http.Response) (*StartFinConversationResponse, error)

ParseStartFinConversationResponse parses an HTTP response from a StartFinConversationWithResponse call

func (StartFinConversationResponse) Status

Status returns HTTPResponse.Status

func (StartFinConversationResponse) StatusCode

func (r StartFinConversationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type StartingAfterPagingSchema

type StartingAfterPagingSchema struct {
	// PerPage The number of results to fetch per page.
	PerPage *int `json:"per_page,omitempty"`

	// StartingAfter The cursor to use in the next request to get the next page of results.
	StartingAfter *string `json:"starting_after,omitempty"`
}

StartingAfterPagingSchema defines model for starting_after_paging.

type SubscriptionTypeConsentType

type SubscriptionTypeConsentType string

SubscriptionTypeConsentType Describes the type of consent.

const (
	OptIn  SubscriptionTypeConsentType = "opt_in"
	OptOut SubscriptionTypeConsentType = "opt_out"
)

Defines values for SubscriptionTypeConsentType.

func (SubscriptionTypeConsentType) Valid

Valid indicates whether the value is a known member of the SubscriptionTypeConsentType enum.

type SubscriptionTypeContentTypes

type SubscriptionTypeContentTypes string

SubscriptionTypeContentTypes defines model for SubscriptionType.ContentTypes.

const (
	Email      SubscriptionTypeContentTypes = "email"
	SmsMessage SubscriptionTypeContentTypes = "sms_message"
)

Defines values for SubscriptionTypeContentTypes.

func (SubscriptionTypeContentTypes) Valid

Valid indicates whether the value is a known member of the SubscriptionTypeContentTypes enum.

type SubscriptionTypeListSchema

type SubscriptionTypeListSchema struct {
	// Data A list of subscription type objects associated with the workspace .
	Data *[]SubscriptionTypeSchema `json:"data,omitempty"`

	// Type The type of the object
	Type *SubscriptionTypeListType `json:"type,omitempty"`
}

SubscriptionTypeListSchema A list of subscription type objects.

type SubscriptionTypeListType

type SubscriptionTypeListType string

SubscriptionTypeListType The type of the object

const (
	SubscriptionTypeListTypeList SubscriptionTypeListType = "list"
)

Defines values for SubscriptionTypeListType.

func (SubscriptionTypeListType) Valid

func (e SubscriptionTypeListType) Valid() bool

Valid indicates whether the value is a known member of the SubscriptionTypeListType enum.

type SubscriptionTypeSchema

type SubscriptionTypeSchema struct {
	// ConsentType Describes the type of consent.
	ConsentType *SubscriptionTypeConsentType `json:"consent_type,omitempty"`

	// ContentTypes The message types that this subscription supports - can contain `email` or `sms_message`.
	ContentTypes       *[]SubscriptionTypeContentTypes `json:"content_types,omitempty"`
	DefaultTranslation *TranslationSchema              `json:"default_translation,omitempty"`

	// Id The unique identifier representing the subscription type.
	Id *string `json:"id,omitempty"`

	// State The state of the subscription type.
	State *SubscriptionTypeState `json:"state,omitempty"`

	// Translations An array of translations objects with the localised version of the subscription type in each available locale within your translation settings.
	Translations *[]TranslationSchema `json:"translations,omitempty"`

	// Type The type of the object - subscription
	Type *string `json:"type,omitempty"`
}

SubscriptionTypeSchema A subscription type lets customers easily opt out of non-essential communications without missing what's important to them.

type SubscriptionTypeState

type SubscriptionTypeState string

SubscriptionTypeState The state of the subscription type.

const (
	SubscriptionTypeStateArchived SubscriptionTypeState = "archived"
	SubscriptionTypeStateDraft    SubscriptionTypeState = "draft"
	SubscriptionTypeStateLive     SubscriptionTypeState = "live"
)

Defines values for SubscriptionTypeState.

func (SubscriptionTypeState) Valid

func (e SubscriptionTypeState) Valid() bool

Valid indicates whether the value is a known member of the SubscriptionTypeState enum.

type TagBasicSchema

type TagBasicSchema struct {
	// Id The id of the tag
	Id *string `json:"id,omitempty"`

	// Name The name of the tag
	Name *string `json:"name,omitempty"`

	// Type value is "tag"
	Type *string `json:"type,omitempty"`
}

TagBasicSchema A tag allows you to label your contacts, companies, and conversations and list them using that tag.

type TagCompanyRequestSchema

type TagCompanyRequestSchema struct {
	// Companies The id or company_id of the company can be passed as input parameters.
	Companies []struct {
		// CompanyId The company id you have defined for the company.
		CompanyId *string `json:"company_id,omitempty"`

		// Id The Intercom defined id representing the company.
		Id *string `json:"id,omitempty"`
	} `json:"companies"`

	// Name The name of the tag, which will be created if not found.
	Name string `json:"name"`
}

TagCompanyRequestSchema You can tag a single company or a list of companies.

type TagListSchema

type TagListSchema struct {
	// Data A list of tags objects associated with the workspace .
	Data *[]TagSchema `json:"data,omitempty"`

	// Type The type of the object
	Type *TagListType `json:"type,omitempty"`
}

TagListSchema A list of tags objects in the workspace.

type TagListType

type TagListType string

TagListType The type of the object

const (
	TagListTypeList TagListType = "list"
)

Defines values for TagListType.

func (TagListType) Valid

func (e TagListType) Valid() bool

Valid indicates whether the value is a known member of the TagListType enum.

type TagMultipleUsersRequestSchema

type TagMultipleUsersRequestSchema struct {
	// Name The name of the tag, which will be created if not found.
	Name  string `json:"name"`
	Users []struct {
		// Id The Intercom defined id representing the user.
		Id *string `json:"id,omitempty"`
	} `json:"users"`
}

TagMultipleUsersRequestSchema You can tag a list of users.

type TagSchema

type TagSchema struct {
	// AppliedAt The time when the tag was applied to the object. Only present when the tag is returned as part of a tagging operation on a contact, conversation, or ticket.
	AppliedAt *int `json:"applied_at,omitempty"`

	// AppliedBy The admin who applied the tag. Only present when the tag is returned as part of a tagging operation on a contact, conversation, or ticket.
	AppliedBy *ReferenceSchema `json:"applied_by,omitempty"`

	// Id The id of the tag
	Id *string `json:"id,omitempty"`

	// Name The name of the tag
	Name *string `json:"name,omitempty"`

	// Type value is "tag"
	Type *string `json:"type,omitempty"`
}

TagSchema A tag allows you to label your contacts, companies, and conversations and list them using that tag.

type TagsSchema

type TagsSchema struct {
	// Tags A list of tags objects associated with the conversation.
	Tags *[]TagSchema `json:"tags,omitempty"`

	// Type The type of the object
	Type *TagsType `json:"type,omitempty"`
}

TagsSchema A list of tags objects associated with a conversation

type TagsType

type TagsType string

TagsType The type of the object

const (
	TagsTypeTagList TagsType = "tag.list"
)

Defines values for TagsType.

func (TagsType) Valid

func (e TagsType) Valid() bool

Valid indicates whether the value is a known member of the TagsType enum.

type TeamListSchema

type TeamListSchema struct {
	// Teams A list of team objects
	Teams *[]TeamSchema `json:"teams,omitempty"`

	// Type The type of the object
	Type *TeamListType `json:"type,omitempty"`
}

TeamListSchema This will return a list of team objects for the App.

type TeamListType

type TeamListType string

TeamListType The type of the object

const (
	TeamList TeamListType = "team.list"
)

Defines values for TeamListType.

func (TeamListType) Valid

func (e TeamListType) Valid() bool

Valid indicates whether the value is a known member of the TeamListType enum.

type TeamPriorityLevelSchema

type TeamPriorityLevelSchema struct {
	// PrimaryTeamIds The primary team ids for the team
	PrimaryTeamIds *[]int `json:"primary_team_ids,omitempty"`

	// SecondaryTeamIds The secondary team ids for the team
	SecondaryTeamIds *[]int `json:"secondary_team_ids,omitempty"`
}

TeamPriorityLevelSchema Admin priority levels for teams

type TeamSchema

type TeamSchema struct {
	// AdminIds The list of admin IDs that are a part of the team.
	AdminIds           *[]int                    `json:"admin_ids,omitempty"`
	AdminPriorityLevel *AdminPriorityLevelSchema `json:"admin_priority_level,omitempty"`

	// AssignmentLimit The assignment limit for the team. This field is only present when the team's distribution type is load balanced.
	AssignmentLimit *int `json:"assignment_limit,omitempty"`

	// DistributionMethod Describes how assignments are distributed among the team members
	DistributionMethod *string `json:"distribution_method,omitempty"`

	// Id The id of the team
	Id *string `json:"id,omitempty"`

	// Name The name of the team
	Name *string `json:"name,omitempty"`

	// Type Value is always "team"
	Type *string `json:"type,omitempty"`
}

TeamSchema Teams are groups of admins in Intercom.

type TeammateReferenceSchema

type TeammateReferenceSchema struct {
	// Email The email address of the teammate (optional for teams/bots)
	Email *openapi_types.Email `json:"email,omitempty"`

	// Id The unique identifier of the teammate
	Id int `json:"id"`

	// Name The display name of the teammate
	Name string `json:"name"`

	// Type The type of teammate
	Type TeammateReferenceType `json:"type"`
}

TeammateReferenceSchema A reference to a teammate

type TeammateReferenceType

type TeammateReferenceType string

TeammateReferenceType The type of teammate

const (
	TeammateReferenceTypeAdmin TeammateReferenceType = "admin"
	TeammateReferenceTypeBot   TeammateReferenceType = "bot"
	TeammateReferenceTypeTeam  TeammateReferenceType = "team"
)

Defines values for TeammateReferenceType.

func (TeammateReferenceType) Valid

func (e TeammateReferenceType) Valid() bool

Valid indicates whether the value is a known member of the TeammateReferenceType enum.

type TicketCategory

type TicketCategory string

TicketCategory Category of the Ticket.

const (
	TicketCategoryBackOffice TicketCategory = "Back-office"
	TicketCategoryCustomer   TicketCategory = "Customer"
	TicketCategoryTracker    TicketCategory = "Tracker"
)

Defines values for TicketCategory.

func (TicketCategory) Valid

func (e TicketCategory) Valid() bool

Valid indicates whether the value is a known member of the TicketCategory enum.

type TicketContactsSchema

type TicketContactsSchema struct {
	// Contacts The list of contacts affected by this ticket.
	Contacts *[]ContactReferenceSchema `json:"contacts,omitempty"`

	// Type always contact.list
	Type *TicketContactsType `json:"type,omitempty"`
}

TicketContactsSchema The list of contacts affected by a ticket.

type TicketContactsType

type TicketContactsType string

TicketContactsType always contact.list

const (
	TicketContactsTypeContactList TicketContactsType = "contact.list"
)

Defines values for TicketContactsType.

func (TicketContactsType) Valid

func (e TicketContactsType) Valid() bool

Valid indicates whether the value is a known member of the TicketContactsType enum.

type TicketCustomAttributes0

type TicketCustomAttributes0 = string

TicketCustomAttributes0 defines model for .

type TicketCustomAttributes1

type TicketCustomAttributes1 = float32

TicketCustomAttributes1 defines model for .

type TicketCustomAttributes2

type TicketCustomAttributes2 = bool

TicketCustomAttributes2 defines model for .

type TicketCustomAttributes3

type TicketCustomAttributes3 = []interface{}

TicketCustomAttributes3 defines model for .

type TicketCustomAttributesSchema

type TicketCustomAttributesSchema map[string]TicketCustomAttributes_AdditionalProperties

TicketCustomAttributesSchema An object containing the different attributes associated to the ticket as key-value pairs. For the default title and description attributes, the keys are `_default_title_` and `_default_description_`.

type TicketCustomAttributes_AdditionalProperties

type TicketCustomAttributes_AdditionalProperties struct {
	// contains filtered or unexported fields
}

TicketCustomAttributes_AdditionalProperties defines model for ticket_custom_attributes.AdditionalProperties.

func (TicketCustomAttributes_AdditionalProperties) AsFileAttributeSchema

AsFileAttributeSchema returns the union data inside the TicketCustomAttributes_AdditionalProperties as a FileAttributeSchema

func (TicketCustomAttributes_AdditionalProperties) AsTicketCustomAttributes0

AsTicketCustomAttributes0 returns the union data inside the TicketCustomAttributes_AdditionalProperties as a TicketCustomAttributes0

func (TicketCustomAttributes_AdditionalProperties) AsTicketCustomAttributes1

AsTicketCustomAttributes1 returns the union data inside the TicketCustomAttributes_AdditionalProperties as a TicketCustomAttributes1

func (TicketCustomAttributes_AdditionalProperties) AsTicketCustomAttributes2

AsTicketCustomAttributes2 returns the union data inside the TicketCustomAttributes_AdditionalProperties as a TicketCustomAttributes2

func (TicketCustomAttributes_AdditionalProperties) AsTicketCustomAttributes3

AsTicketCustomAttributes3 returns the union data inside the TicketCustomAttributes_AdditionalProperties as a TicketCustomAttributes3

func (*TicketCustomAttributes_AdditionalProperties) FromFileAttributeSchema

FromFileAttributeSchema overwrites any union data inside the TicketCustomAttributes_AdditionalProperties as the provided FileAttributeSchema

func (*TicketCustomAttributes_AdditionalProperties) FromTicketCustomAttributes0

FromTicketCustomAttributes0 overwrites any union data inside the TicketCustomAttributes_AdditionalProperties as the provided TicketCustomAttributes0

func (*TicketCustomAttributes_AdditionalProperties) FromTicketCustomAttributes1

FromTicketCustomAttributes1 overwrites any union data inside the TicketCustomAttributes_AdditionalProperties as the provided TicketCustomAttributes1

func (*TicketCustomAttributes_AdditionalProperties) FromTicketCustomAttributes2

FromTicketCustomAttributes2 overwrites any union data inside the TicketCustomAttributes_AdditionalProperties as the provided TicketCustomAttributes2

func (*TicketCustomAttributes_AdditionalProperties) FromTicketCustomAttributes3

FromTicketCustomAttributes3 overwrites any union data inside the TicketCustomAttributes_AdditionalProperties as the provided TicketCustomAttributes3

func (TicketCustomAttributes_AdditionalProperties) MarshalJSON

func (*TicketCustomAttributes_AdditionalProperties) MergeFileAttributeSchema

MergeFileAttributeSchema performs a merge with any union data inside the TicketCustomAttributes_AdditionalProperties, using the provided FileAttributeSchema

func (*TicketCustomAttributes_AdditionalProperties) MergeTicketCustomAttributes0

MergeTicketCustomAttributes0 performs a merge with any union data inside the TicketCustomAttributes_AdditionalProperties, using the provided TicketCustomAttributes0

func (*TicketCustomAttributes_AdditionalProperties) MergeTicketCustomAttributes1

MergeTicketCustomAttributes1 performs a merge with any union data inside the TicketCustomAttributes_AdditionalProperties, using the provided TicketCustomAttributes1

func (*TicketCustomAttributes_AdditionalProperties) MergeTicketCustomAttributes2

MergeTicketCustomAttributes2 performs a merge with any union data inside the TicketCustomAttributes_AdditionalProperties, using the provided TicketCustomAttributes2

func (*TicketCustomAttributes_AdditionalProperties) MergeTicketCustomAttributes3

MergeTicketCustomAttributes3 performs a merge with any union data inside the TicketCustomAttributes_AdditionalProperties, using the provided TicketCustomAttributes3

func (*TicketCustomAttributes_AdditionalProperties) UnmarshalJSON

type TicketDeletedObject

type TicketDeletedObject string

TicketDeletedObject always ticket

const (
	Ticket TicketDeletedObject = "ticket"
)

Defines values for TicketDeletedObject.

func (TicketDeletedObject) Valid

func (e TicketDeletedObject) Valid() bool

Valid indicates whether the value is a known member of the TicketDeletedObject enum.

type TicketDeletedSchema

type TicketDeletedSchema struct {
	// Deleted Whether the ticket is deleted or not.
	Deleted *bool `json:"deleted,omitempty"`

	// Id The unique identifier for the ticket.
	Id *string `json:"id,omitempty"`

	// Object always ticket
	Object *TicketDeletedObject `json:"object,omitempty"`
}

TicketDeletedSchema deleted ticket object

type TicketListSchema

type TicketListSchema struct {
	Pages *CursorPagesSchema `json:"pages,omitempty"`

	// Tickets The list of ticket objects
	Tickets *[]*TicketSchema `json:"tickets,omitempty"`

	// TotalCount A count of the total number of objects.
	TotalCount *int `json:"total_count,omitempty"`

	// Type Always ticket.list
	Type *TicketListType `json:"type,omitempty"`
}

TicketListSchema Tickets are how you track requests from your users.

type TicketListType

type TicketListType string

TicketListType Always ticket.list

const (
	TicketList TicketListType = "ticket.list"
)

Defines values for TicketListType.

func (TicketListType) Valid

func (e TicketListType) Valid() bool

Valid indicates whether the value is a known member of the TicketListType enum.

type TicketPartAuthorSchema

type TicketPartAuthorSchema struct {
	// Email The email of the author
	Email *openapi_types.Email `json:"email,omitempty"`

	// Id The id of the author
	Id *string `json:"id,omitempty"`

	// Name The name of the author
	Name *string `json:"name,omitempty"`

	// Type The type of the author
	Type *TicketPartAuthorType `json:"type,omitempty"`
}

TicketPartAuthorSchema The author that wrote or triggered the part. Can be a bot, admin, team or user.

type TicketPartAuthorType

type TicketPartAuthorType string

TicketPartAuthorType The type of the author

const (
	Admin TicketPartAuthorType = "admin"
	Bot   TicketPartAuthorType = "bot"
	Team  TicketPartAuthorType = "team"
	User  TicketPartAuthorType = "user"
)

Defines values for TicketPartAuthorType.

func (TicketPartAuthorType) Valid

func (e TicketPartAuthorType) Valid() bool

Valid indicates whether the value is a known member of the TicketPartAuthorType enum.

type TicketPartPreviousTicketState

type TicketPartPreviousTicketState string

TicketPartPreviousTicketState The previous state of the ticket.

const (
	TicketPartPreviousTicketStateInProgress        TicketPartPreviousTicketState = "in_progress"
	TicketPartPreviousTicketStateResolved          TicketPartPreviousTicketState = "resolved"
	TicketPartPreviousTicketStateSubmitted         TicketPartPreviousTicketState = "submitted"
	TicketPartPreviousTicketStateWaitingOnCustomer TicketPartPreviousTicketState = "waiting_on_customer"
)

Defines values for TicketPartPreviousTicketState.

func (TicketPartPreviousTicketState) Valid

Valid indicates whether the value is a known member of the TicketPartPreviousTicketState enum.

type TicketPartSchema

type TicketPartSchema struct {
	// AppPackageCode The app package code if this part was created via API. Note this field won't show if the part was not created via API.
	AppPackageCode *string `json:"app_package_code,omitempty"`

	// AssignedTo The id of the admin that was assigned the ticket by this ticket_part (null if there has been no change in assignment.)
	AssignedTo *ReferenceSchema `json:"assigned_to,omitempty"`

	// Attachments A list of attachments for the part.
	Attachments *[]PartAttachmentSchema `json:"attachments,omitempty"`
	Author      *TicketPartAuthorSchema `json:"author,omitempty"`

	// Body The message body, which may contain HTML.
	Body *string `json:"body,omitempty"`

	// CreatedAt The time the ticket part was created.
	CreatedAt *int `json:"created_at,omitempty"`

	// ExternalId The external id of the ticket part
	ExternalId *string `json:"external_id,omitempty"`

	// Id The id representing the ticket part.
	Id *string `json:"id,omitempty"`

	// PartType The type of ticket part.
	PartType *string `json:"part_type,omitempty"`

	// PreviousTicketState The previous state of the ticket.
	PreviousTicketState *TicketPartPreviousTicketState `json:"previous_ticket_state,omitempty"`

	// Redacted Whether or not the ticket part has been redacted.
	Redacted *bool `json:"redacted,omitempty"`

	// TicketState The state of the ticket.
	TicketState *TicketPartTicketState `json:"ticket_state,omitempty"`

	// Type Always ticket_part
	Type *string `json:"type,omitempty"`

	// UpdatedAt The last time the ticket part was updated.
	UpdatedAt *int `json:"updated_at,omitempty"`

	// UpdatedAttributeData The updated attribute data of the ticket part. Only present for attribute update parts.
	UpdatedAttributeData *struct {
		// Attribute Information about the attribute that was updated.
		Attribute struct {
			// Id The unique identifier of the attribute.
			Id string `json:"id"`

			// Label The human-readable name of the attribute.
			Label string `json:"label"`

			// Type The type of the object. Always 'attribute'.
			Type TicketPartUpdatedAttributeDataAttributeType `json:"type"`
		} `json:"attribute"`

		// Value The new value of the attribute.
		Value struct {
			Id    TicketPart_UpdatedAttributeData_Value_Id    `json:"id"`
			Label TicketPart_UpdatedAttributeData_Value_Label `json:"label"`

			// Type The type of the object. Always 'value'.
			Type TicketPartUpdatedAttributeDataValueType `json:"type"`
		} `json:"value"`
	} `json:"updated_attribute_data,omitempty"`
}

TicketPartSchema A Ticket Part represents a message in the ticket.

type TicketPartTicketState

type TicketPartTicketState string

TicketPartTicketState The state of the ticket.

const (
	TicketPartTicketStateInProgress        TicketPartTicketState = "in_progress"
	TicketPartTicketStateResolved          TicketPartTicketState = "resolved"
	TicketPartTicketStateSubmitted         TicketPartTicketState = "submitted"
	TicketPartTicketStateWaitingOnCustomer TicketPartTicketState = "waiting_on_customer"
)

Defines values for TicketPartTicketState.

func (TicketPartTicketState) Valid

func (e TicketPartTicketState) Valid() bool

Valid indicates whether the value is a known member of the TicketPartTicketState enum.

type TicketPartUpdatedAttributeDataAttributeType

type TicketPartUpdatedAttributeDataAttributeType string

TicketPartUpdatedAttributeDataAttributeType The type of the object. Always 'attribute'.

const (
	Attribute TicketPartUpdatedAttributeDataAttributeType = "attribute"
)

Defines values for TicketPartUpdatedAttributeDataAttributeType.

func (TicketPartUpdatedAttributeDataAttributeType) Valid

Valid indicates whether the value is a known member of the TicketPartUpdatedAttributeDataAttributeType enum.

type TicketPartUpdatedAttributeDataValueId0

type TicketPartUpdatedAttributeDataValueId0 = string

TicketPartUpdatedAttributeDataValueId0 The value for text/number/decimal/boolean/date attributes, or the ID of the list option for list attributes.

type TicketPartUpdatedAttributeDataValueId1

type TicketPartUpdatedAttributeDataValueId1 = []int

TicketPartUpdatedAttributeDataValueId1 Array of file IDs for file attributes.

type TicketPartUpdatedAttributeDataValueLabel0

type TicketPartUpdatedAttributeDataValueLabel0 = string

TicketPartUpdatedAttributeDataValueLabel0 The display value for text/number/decimal/boolean/date/list attributes.

type TicketPartUpdatedAttributeDataValueLabel1

type TicketPartUpdatedAttributeDataValueLabel1 = []string

TicketPartUpdatedAttributeDataValueLabel1 Array of file names for file attributes.

type TicketPartUpdatedAttributeDataValueType

type TicketPartUpdatedAttributeDataValueType string

TicketPartUpdatedAttributeDataValueType The type of the object. Always 'value'.

const (
	Value TicketPartUpdatedAttributeDataValueType = "value"
)

Defines values for TicketPartUpdatedAttributeDataValueType.

func (TicketPartUpdatedAttributeDataValueType) Valid

Valid indicates whether the value is a known member of the TicketPartUpdatedAttributeDataValueType enum.

type TicketPart_UpdatedAttributeData_Value_Id

type TicketPart_UpdatedAttributeData_Value_Id struct {
	// contains filtered or unexported fields
}

TicketPart_UpdatedAttributeData_Value_Id defines model for TicketPart.UpdatedAttributeData.Value.Id.

func (TicketPart_UpdatedAttributeData_Value_Id) AsTicketPartUpdatedAttributeDataValueId0

func (t TicketPart_UpdatedAttributeData_Value_Id) AsTicketPartUpdatedAttributeDataValueId0() (TicketPartUpdatedAttributeDataValueId0, error)

AsTicketPartUpdatedAttributeDataValueId0 returns the union data inside the TicketPart_UpdatedAttributeData_Value_Id as a TicketPartUpdatedAttributeDataValueId0

func (TicketPart_UpdatedAttributeData_Value_Id) AsTicketPartUpdatedAttributeDataValueId1

func (t TicketPart_UpdatedAttributeData_Value_Id) AsTicketPartUpdatedAttributeDataValueId1() (TicketPartUpdatedAttributeDataValueId1, error)

AsTicketPartUpdatedAttributeDataValueId1 returns the union data inside the TicketPart_UpdatedAttributeData_Value_Id as a TicketPartUpdatedAttributeDataValueId1

func (*TicketPart_UpdatedAttributeData_Value_Id) FromTicketPartUpdatedAttributeDataValueId0

func (t *TicketPart_UpdatedAttributeData_Value_Id) FromTicketPartUpdatedAttributeDataValueId0(v TicketPartUpdatedAttributeDataValueId0) error

FromTicketPartUpdatedAttributeDataValueId0 overwrites any union data inside the TicketPart_UpdatedAttributeData_Value_Id as the provided TicketPartUpdatedAttributeDataValueId0

func (*TicketPart_UpdatedAttributeData_Value_Id) FromTicketPartUpdatedAttributeDataValueId1

func (t *TicketPart_UpdatedAttributeData_Value_Id) FromTicketPartUpdatedAttributeDataValueId1(v TicketPartUpdatedAttributeDataValueId1) error

FromTicketPartUpdatedAttributeDataValueId1 overwrites any union data inside the TicketPart_UpdatedAttributeData_Value_Id as the provided TicketPartUpdatedAttributeDataValueId1

func (TicketPart_UpdatedAttributeData_Value_Id) MarshalJSON

func (*TicketPart_UpdatedAttributeData_Value_Id) MergeTicketPartUpdatedAttributeDataValueId0

func (t *TicketPart_UpdatedAttributeData_Value_Id) MergeTicketPartUpdatedAttributeDataValueId0(v TicketPartUpdatedAttributeDataValueId0) error

MergeTicketPartUpdatedAttributeDataValueId0 performs a merge with any union data inside the TicketPart_UpdatedAttributeData_Value_Id, using the provided TicketPartUpdatedAttributeDataValueId0

func (*TicketPart_UpdatedAttributeData_Value_Id) MergeTicketPartUpdatedAttributeDataValueId1

func (t *TicketPart_UpdatedAttributeData_Value_Id) MergeTicketPartUpdatedAttributeDataValueId1(v TicketPartUpdatedAttributeDataValueId1) error

MergeTicketPartUpdatedAttributeDataValueId1 performs a merge with any union data inside the TicketPart_UpdatedAttributeData_Value_Id, using the provided TicketPartUpdatedAttributeDataValueId1

func (*TicketPart_UpdatedAttributeData_Value_Id) UnmarshalJSON

func (t *TicketPart_UpdatedAttributeData_Value_Id) UnmarshalJSON(b []byte) error

type TicketPart_UpdatedAttributeData_Value_Label

type TicketPart_UpdatedAttributeData_Value_Label struct {
	// contains filtered or unexported fields
}

TicketPart_UpdatedAttributeData_Value_Label defines model for TicketPart.UpdatedAttributeData.Value.Label.

func (TicketPart_UpdatedAttributeData_Value_Label) AsTicketPartUpdatedAttributeDataValueLabel0

func (t TicketPart_UpdatedAttributeData_Value_Label) AsTicketPartUpdatedAttributeDataValueLabel0() (TicketPartUpdatedAttributeDataValueLabel0, error)

AsTicketPartUpdatedAttributeDataValueLabel0 returns the union data inside the TicketPart_UpdatedAttributeData_Value_Label as a TicketPartUpdatedAttributeDataValueLabel0

func (TicketPart_UpdatedAttributeData_Value_Label) AsTicketPartUpdatedAttributeDataValueLabel1

func (t TicketPart_UpdatedAttributeData_Value_Label) AsTicketPartUpdatedAttributeDataValueLabel1() (TicketPartUpdatedAttributeDataValueLabel1, error)

AsTicketPartUpdatedAttributeDataValueLabel1 returns the union data inside the TicketPart_UpdatedAttributeData_Value_Label as a TicketPartUpdatedAttributeDataValueLabel1

func (*TicketPart_UpdatedAttributeData_Value_Label) FromTicketPartUpdatedAttributeDataValueLabel0

func (t *TicketPart_UpdatedAttributeData_Value_Label) FromTicketPartUpdatedAttributeDataValueLabel0(v TicketPartUpdatedAttributeDataValueLabel0) error

FromTicketPartUpdatedAttributeDataValueLabel0 overwrites any union data inside the TicketPart_UpdatedAttributeData_Value_Label as the provided TicketPartUpdatedAttributeDataValueLabel0

func (*TicketPart_UpdatedAttributeData_Value_Label) FromTicketPartUpdatedAttributeDataValueLabel1

func (t *TicketPart_UpdatedAttributeData_Value_Label) FromTicketPartUpdatedAttributeDataValueLabel1(v TicketPartUpdatedAttributeDataValueLabel1) error

FromTicketPartUpdatedAttributeDataValueLabel1 overwrites any union data inside the TicketPart_UpdatedAttributeData_Value_Label as the provided TicketPartUpdatedAttributeDataValueLabel1

func (TicketPart_UpdatedAttributeData_Value_Label) MarshalJSON

func (*TicketPart_UpdatedAttributeData_Value_Label) MergeTicketPartUpdatedAttributeDataValueLabel0

func (t *TicketPart_UpdatedAttributeData_Value_Label) MergeTicketPartUpdatedAttributeDataValueLabel0(v TicketPartUpdatedAttributeDataValueLabel0) error

MergeTicketPartUpdatedAttributeDataValueLabel0 performs a merge with any union data inside the TicketPart_UpdatedAttributeData_Value_Label, using the provided TicketPartUpdatedAttributeDataValueLabel0

func (*TicketPart_UpdatedAttributeData_Value_Label) MergeTicketPartUpdatedAttributeDataValueLabel1

func (t *TicketPart_UpdatedAttributeData_Value_Label) MergeTicketPartUpdatedAttributeDataValueLabel1(v TicketPartUpdatedAttributeDataValueLabel1) error

MergeTicketPartUpdatedAttributeDataValueLabel1 performs a merge with any union data inside the TicketPart_UpdatedAttributeData_Value_Label, using the provided TicketPartUpdatedAttributeDataValueLabel1

func (*TicketPart_UpdatedAttributeData_Value_Label) UnmarshalJSON

type TicketPartsSchema

type TicketPartsSchema struct {
	// TicketParts A list of Ticket Part objects for each ticket. There is a limit of 500 parts.
	TicketParts *[]TicketPartSchema `json:"ticket_parts,omitempty"`
	TotalCount  *int                `json:"total_count,omitempty"`
	Type        *TicketPartsType    `json:"type,omitempty"`
}

TicketPartsSchema A list of Ticket Part objects for each note and event in the ticket. There is a limit of 500 parts.

type TicketPartsType

type TicketPartsType string

TicketPartsType defines model for TicketParts.Type.

const (
	TicketPartList TicketPartsType = "ticket_part.list"
)

Defines values for TicketPartsType.

func (TicketPartsType) Valid

func (e TicketPartsType) Valid() bool

Valid indicates whether the value is a known member of the TicketPartsType enum.

type TicketReplyPartType

type TicketReplyPartType string

TicketReplyPartType Type of the part

const (
	TicketReplyPartTypeComment    TicketReplyPartType = "comment"
	TicketReplyPartTypeNote       TicketReplyPartType = "note"
	TicketReplyPartTypeQuickReply TicketReplyPartType = "quick_reply"
)

Defines values for TicketReplyPartType.

func (TicketReplyPartType) Valid

func (e TicketReplyPartType) Valid() bool

Valid indicates whether the value is a known member of the TicketReplyPartType enum.

type TicketReplySchema

type TicketReplySchema struct {
	// Attachments A list of attachments for the part.
	Attachments *[]PartAttachmentSchema `json:"attachments,omitempty"`
	Author      *TicketPartAuthorSchema `json:"author,omitempty"`

	// Body The message body, which may contain HTML.
	Body *string `json:"body,omitempty"`

	// CreatedAt The time the note was created.
	CreatedAt *int `json:"created_at,omitempty"`

	// Id The id representing the part.
	Id *string `json:"id,omitempty"`

	// PartType Type of the part
	PartType *TicketReplyPartType `json:"part_type,omitempty"`

	// Redacted Whether or not the ticket part has been redacted.
	Redacted *bool `json:"redacted,omitempty"`

	// Type Always ticket_part
	Type *TicketReplyType `json:"type,omitempty"`

	// UpdatedAt The last time the note was updated.
	UpdatedAt *int `json:"updated_at,omitempty"`
}

TicketReplySchema A Ticket Part representing a note, comment, or quick_reply on a ticket

type TicketReplyType

type TicketReplyType string

TicketReplyType Always ticket_part

const (
	TicketPart TicketReplyType = "ticket_part"
)

Defines values for TicketReplyType.

func (TicketReplyType) Valid

func (e TicketReplyType) Valid() bool

Valid indicates whether the value is a known member of the TicketReplyType enum.

type TicketRequestCustomAttributes0

type TicketRequestCustomAttributes0 = string

TicketRequestCustomAttributes0 defines model for .

type TicketRequestCustomAttributes1

type TicketRequestCustomAttributes1 = float32

TicketRequestCustomAttributes1 defines model for .

type TicketRequestCustomAttributes2

type TicketRequestCustomAttributes2 = bool

TicketRequestCustomAttributes2 defines model for .

type TicketRequestCustomAttributes3

type TicketRequestCustomAttributes3 = []interface{}

TicketRequestCustomAttributes3 defines model for .

type TicketRequestCustomAttributesSchema

type TicketRequestCustomAttributesSchema map[string]TicketRequestCustomAttributes_AdditionalProperties

TicketRequestCustomAttributesSchema The attributes set on the ticket. When setting the default title and description attributes, the attribute keys that should be used are `_default_title_` and `_default_description_`. When setting ticket type attributes of the list attribute type, the key should be the attribute name and the value of the attribute should be the list item id, obtainable by [listing the ticket type](ref:get_ticket-types). For example, if the ticket type has an attribute called `priority` of type `list`, the key should be `priority` and the value of the attribute should be the guid of the list item (e.g. `de1825a0-0164-4070-8ca6-13e22462fa7e`).

type TicketRequestCustomAttributes_AdditionalProperties

type TicketRequestCustomAttributes_AdditionalProperties struct {
	// contains filtered or unexported fields
}

TicketRequestCustomAttributes_AdditionalProperties defines model for ticket_request_custom_attributes.AdditionalProperties.

func (TicketRequestCustomAttributes_AdditionalProperties) AsTicketRequestCustomAttributes0

AsTicketRequestCustomAttributes0 returns the union data inside the TicketRequestCustomAttributes_AdditionalProperties as a TicketRequestCustomAttributes0

func (TicketRequestCustomAttributes_AdditionalProperties) AsTicketRequestCustomAttributes1

AsTicketRequestCustomAttributes1 returns the union data inside the TicketRequestCustomAttributes_AdditionalProperties as a TicketRequestCustomAttributes1

func (TicketRequestCustomAttributes_AdditionalProperties) AsTicketRequestCustomAttributes2

AsTicketRequestCustomAttributes2 returns the union data inside the TicketRequestCustomAttributes_AdditionalProperties as a TicketRequestCustomAttributes2

func (TicketRequestCustomAttributes_AdditionalProperties) AsTicketRequestCustomAttributes3

AsTicketRequestCustomAttributes3 returns the union data inside the TicketRequestCustomAttributes_AdditionalProperties as a TicketRequestCustomAttributes3

func (*TicketRequestCustomAttributes_AdditionalProperties) FromTicketRequestCustomAttributes0

FromTicketRequestCustomAttributes0 overwrites any union data inside the TicketRequestCustomAttributes_AdditionalProperties as the provided TicketRequestCustomAttributes0

func (*TicketRequestCustomAttributes_AdditionalProperties) FromTicketRequestCustomAttributes1

FromTicketRequestCustomAttributes1 overwrites any union data inside the TicketRequestCustomAttributes_AdditionalProperties as the provided TicketRequestCustomAttributes1

func (*TicketRequestCustomAttributes_AdditionalProperties) FromTicketRequestCustomAttributes2

FromTicketRequestCustomAttributes2 overwrites any union data inside the TicketRequestCustomAttributes_AdditionalProperties as the provided TicketRequestCustomAttributes2

func (*TicketRequestCustomAttributes_AdditionalProperties) FromTicketRequestCustomAttributes3

FromTicketRequestCustomAttributes3 overwrites any union data inside the TicketRequestCustomAttributes_AdditionalProperties as the provided TicketRequestCustomAttributes3

func (TicketRequestCustomAttributes_AdditionalProperties) MarshalJSON

func (*TicketRequestCustomAttributes_AdditionalProperties) MergeTicketRequestCustomAttributes0

MergeTicketRequestCustomAttributes0 performs a merge with any union data inside the TicketRequestCustomAttributes_AdditionalProperties, using the provided TicketRequestCustomAttributes0

func (*TicketRequestCustomAttributes_AdditionalProperties) MergeTicketRequestCustomAttributes1

MergeTicketRequestCustomAttributes1 performs a merge with any union data inside the TicketRequestCustomAttributes_AdditionalProperties, using the provided TicketRequestCustomAttributes1

func (*TicketRequestCustomAttributes_AdditionalProperties) MergeTicketRequestCustomAttributes2

MergeTicketRequestCustomAttributes2 performs a merge with any union data inside the TicketRequestCustomAttributes_AdditionalProperties, using the provided TicketRequestCustomAttributes2

func (*TicketRequestCustomAttributes_AdditionalProperties) MergeTicketRequestCustomAttributes3

MergeTicketRequestCustomAttributes3 performs a merge with any union data inside the TicketRequestCustomAttributes_AdditionalProperties, using the provided TicketRequestCustomAttributes3

func (*TicketRequestCustomAttributes_AdditionalProperties) UnmarshalJSON

type TicketSchema

type TicketSchema struct {
	// AdminAssigneeId The id representing the admin assigned to the ticket.
	AdminAssigneeId *string `json:"admin_assignee_id,omitempty"`

	// Category Category of the Ticket.
	Category *TicketCategory       `json:"category,omitempty"`
	Contacts *TicketContactsSchema `json:"contacts,omitempty"`

	// CreatedAt The time the ticket was created as a UTC Unix timestamp.
	CreatedAt *int `json:"created_at,omitempty"`

	// Id The unique identifier for the ticket which is given by Intercom.
	Id *string `json:"id,omitempty"`

	// IsShared Whether or not the ticket is shared with the customer.
	IsShared      *bool                   `json:"is_shared,omitempty"`
	LinkedObjects *LinkedObjectListSchema `json:"linked_objects,omitempty"`

	// Open Whether or not the ticket is open. If false, the ticket is closed.
	Open *bool `json:"open,omitempty"`

	// SnoozedUntil The time the ticket will be snoozed until as a UTC Unix timestamp. If null, the ticket is not currently snoozed.
	SnoozedUntil *int `json:"snoozed_until,omitempty"`

	// TeamAssigneeId The id representing the team assigned to the ticket.
	TeamAssigneeId   *string                       `json:"team_assignee_id,omitempty"`
	TicketAttributes *TicketCustomAttributesSchema `json:"ticket_attributes,omitempty"`

	// TicketId The ID of the Ticket used in the Intercom Inbox and Messenger. Do not use ticket_id for API queries.
	TicketId    *string            `json:"ticket_id,omitempty"`
	TicketParts *TicketPartsSchema `json:"ticket_parts,omitempty"`
	TicketState *TicketStateSchema `json:"ticket_state,omitempty"`
	TicketType  *TicketTypeSchema  `json:"ticket_type,omitempty"`

	// Type Always ticket
	Type *TicketType `json:"type,omitempty"`

	// UpdatedAt The last time the ticket was updated as a UTC Unix timestamp.
	UpdatedAt *int `json:"updated_at,omitempty"`
}

TicketSchema Tickets are how you track requests from your users.

type TicketStateCategory

type TicketStateCategory string

TicketStateCategory The category of the ticket state

const (
	TicketStateCategoryInProgress        TicketStateCategory = "in_progress"
	TicketStateCategoryResolved          TicketStateCategory = "resolved"
	TicketStateCategorySubmitted         TicketStateCategory = "submitted"
	TicketStateCategoryWaitingOnCustomer TicketStateCategory = "waiting_on_customer"
)

Defines values for TicketStateCategory.

func (TicketStateCategory) Valid

func (e TicketStateCategory) Valid() bool

Valid indicates whether the value is a known member of the TicketStateCategory enum.

type TicketStateDetailedCategory

type TicketStateDetailedCategory string

TicketStateDetailedCategory The category of the ticket state

const (
	InProgress        TicketStateDetailedCategory = "in_progress"
	Resolved          TicketStateDetailedCategory = "resolved"
	Submitted         TicketStateDetailedCategory = "submitted"
	WaitingOnCustomer TicketStateDetailedCategory = "waiting_on_customer"
)

Defines values for TicketStateDetailedCategory.

func (TicketStateDetailedCategory) Valid

Valid indicates whether the value is a known member of the TicketStateDetailedCategory enum.

type TicketStateDetailedSchema

type TicketStateDetailedSchema struct {
	// Archived Whether the ticket state is archived
	Archived *bool `json:"archived,omitempty"`

	// Category The category of the ticket state
	Category *TicketStateDetailedCategory `json:"category,omitempty"`

	// ExternalLabel The state the ticket is currently in, in a human readable form - visible to customers, in the messenger, email and tickets portal.
	ExternalLabel *string `json:"external_label,omitempty"`

	// Id The id of the ticket state
	Id *string `json:"id,omitempty"`

	// InternalLabel The state the ticket is currently in, in a human readable form - visible in Intercom
	InternalLabel *string `json:"internal_label,omitempty"`

	// TicketTypes A list of ticket types associated with a given ticket state.
	TicketTypes *struct {
		// Data A list of ticket type attributes associated with a given ticket type.
		Data *[]*TicketTypeSchema `json:"data,omitempty"`

		// Type String representing the object's type. Always has the value `list`.
		Type *string `json:"type,omitempty"`
	} `json:"ticket_types,omitempty"`

	// Type String representing the object's type. Always has the value `ticket_state`.
	Type *string `json:"type,omitempty"`
}

TicketStateDetailedSchema A ticket state, used to define the state of a ticket.

type TicketStateListSchema

type TicketStateListSchema struct {
	// Data A list of ticket states associated with a given ticket type.
	Data *[]*TicketStateDetailedSchema `json:"data,omitempty"`

	// Type String representing the object's type. Always has the value `list`.
	Type *string `json:"type,omitempty"`
}

TicketStateListSchema A list of ticket states associated with a given ticket type.

type TicketStateSchema

type TicketStateSchema struct {
	// Category The category of the ticket state
	Category *TicketStateCategory `json:"category,omitempty"`

	// ExternalLabel The state the ticket is currently in, in a human readable form - visible to customers, in the messenger, email and tickets portal.
	ExternalLabel *string `json:"external_label,omitempty"`

	// Id The id of the ticket state
	Id *string `json:"id,omitempty"`

	// InternalLabel The state the ticket is currently in, in a human readable form - visible in Intercom
	InternalLabel *string `json:"internal_label,omitempty"`

	// Type String representing the object's type. Always has the value `ticket_state`.
	Type *string `json:"type,omitempty"`
}

TicketStateSchema A ticket state, used to define the state of a ticket.

type TicketType

type TicketType string

TicketType Always ticket

const (
	TicketTypeTicket TicketType = "ticket"
)

Defines values for TicketType.

func (TicketType) Valid

func (e TicketType) Valid() bool

Valid indicates whether the value is a known member of the TicketType enum.

type TicketTypeAttributeListSchema

type TicketTypeAttributeListSchema struct {
	// TicketTypeAttributes A list of ticket type attributes associated with a given ticket type.
	TicketTypeAttributes *[]*TicketTypeAttributeSchema `json:"ticket_type_attributes,omitempty"`

	// Type String representing the object's type. Always has the value `ticket_type_attributes.list`.
	Type *string `json:"type,omitempty"`
}

TicketTypeAttributeListSchema A list of attributes associated with a given ticket type.

type TicketTypeAttributeSchema

type TicketTypeAttributeSchema struct {
	// Archived Whether the ticket type attribute is archived or not.
	Archived *bool `json:"archived,omitempty"`

	// CreatedAt The date and time the ticket type attribute was created.
	CreatedAt *int `json:"created_at,omitempty"`

	// DataType The type of the data attribute (allowed values: "string list integer decimal boolean datetime files")
	DataType *string `json:"data_type,omitempty"`

	// Default Whether the attribute is built in or not.
	Default *bool `json:"default,omitempty"`

	// Description The description of the ticket type attribute
	Description *string `json:"description,omitempty"`

	// Id The id representing the ticket type attribute.
	Id *string `json:"id,omitempty"`

	// InputOptions Input options for the attribute
	InputOptions *map[string]interface{} `json:"input_options,omitempty"`

	// Name The name of the ticket type attribute
	Name *string `json:"name,omitempty"`

	// Order The order of the attribute against other attributes
	Order *int `json:"order,omitempty"`

	// RequiredToCreate Whether the attribute is required or not for teammates.
	RequiredToCreate *bool `json:"required_to_create,omitempty"`

	// RequiredToCreateForContacts Whether the attribute is required or not for contacts.
	RequiredToCreateForContacts *bool `json:"required_to_create_for_contacts,omitempty"`

	// TicketTypeId The id of the ticket type that the attribute belongs to.
	TicketTypeId *int `json:"ticket_type_id,omitempty"`

	// Type String representing the object's type. Always has the value `ticket_type_attribute`.
	Type *string `json:"type,omitempty"`

	// UpdatedAt The date and time the ticket type attribute was last updated.
	UpdatedAt *int `json:"updated_at,omitempty"`

	// VisibleOnCreate Whether the attribute is visible or not to teammates.
	VisibleOnCreate *bool `json:"visible_on_create,omitempty"`

	// VisibleToContacts Whether the attribute is visible or not to contacts.
	VisibleToContacts *bool `json:"visible_to_contacts,omitempty"`

	// WorkspaceId The id of the workspace that the ticket type attribute belongs to.
	WorkspaceId *string `json:"workspace_id,omitempty"`
}

TicketTypeAttributeSchema Ticket type attribute, used to define each data field to be captured in a ticket.

type TicketTypeCategory

type TicketTypeCategory string

TicketTypeCategory Category of the Ticket Type.

const (
	TicketTypeCategoryBackOffice TicketTypeCategory = "Back-office"
	TicketTypeCategoryCustomer   TicketTypeCategory = "Customer"
	TicketTypeCategoryTracker    TicketTypeCategory = "Tracker"
)

Defines values for TicketTypeCategory.

func (TicketTypeCategory) Valid

func (e TicketTypeCategory) Valid() bool

Valid indicates whether the value is a known member of the TicketTypeCategory enum.

type TicketTypeListSchema

type TicketTypeListSchema struct {
	// Data A list of ticket_types associated with a given workspace.
	Data *[]*TicketTypeSchema `json:"data,omitempty"`

	// Type String representing the object's type. Always has the value `list`.
	Type *string `json:"type,omitempty"`
}

TicketTypeListSchema A list of ticket types associated with a given workspace.

type TicketTypeSchema

type TicketTypeSchema struct {
	// Archived Whether the ticket type is archived or not.
	Archived *bool `json:"archived,omitempty"`

	// Category Category of the Ticket Type.
	Category *TicketTypeCategory `json:"category,omitempty"`

	// CreatedAt The date and time the ticket type was created.
	CreatedAt *int `json:"created_at,omitempty"`

	// Description The description of the ticket type
	Description *string `json:"description,omitempty"`

	// Icon The icon of the ticket type
	Icon *string `json:"icon,omitempty"`

	// Id The id representing the ticket type.
	Id *string `json:"id,omitempty"`

	// Name The name of the ticket type
	Name *string `json:"name,omitempty"`

	// TicketStates A list of ticket states associated with a given ticket type.
	TicketStates *struct {
		// Data A list of ticket states associated with a given ticket type.
		Data *[]*TicketStateSchema `json:"data,omitempty"`

		// Type String representing the object's type. Always has the value `list`.
		Type *string `json:"type,omitempty"`
	} `json:"ticket_states,omitempty"`
	TicketTypeAttributes *TicketTypeAttributeListSchema `json:"ticket_type_attributes,omitempty"`

	// Type String representing the object's type. Always has the value `ticket_type`.
	Type *string `json:"type,omitempty"`

	// UpdatedAt The date and time the ticket type was last updated.
	UpdatedAt *int `json:"updated_at,omitempty"`

	// WorkspaceId The id of the workspace that the ticket type belongs to.
	WorkspaceId *string `json:"workspace_id,omitempty"`
}

TicketTypeSchema A ticket type, used to define the data fields to be captured in a ticket.

type TranslationSchema

type TranslationSchema struct {
	// Description The localised description of the subscription type.
	Description *string `json:"description,omitempty"`

	// Locale The two character identifier for the language of the translation object.
	Locale *string `json:"locale,omitempty"`

	// Name The localised name of the subscription type.
	Name *string `json:"name,omitempty"`
}

TranslationSchema A translation object contains the localised details of a subscription type.

type TypeNotFound

type TypeNotFound = ErrorSchema

TypeNotFound The API will return an Error List for a failed request, which will contain one or more Error objects.

type UnarchiveContactParams

type UnarchiveContactParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

UnarchiveContactParams defines parameters for UnarchiveContact.

type UnarchiveContactResponse

type UnarchiveContactResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ContactUnarchived
}

func ParseUnarchiveContactResponse

func ParseUnarchiveContactResponse(rsp *http.Response) (*UnarchiveContactResponse, error)

ParseUnarchiveContactResponse parses an HTTP response from a UnarchiveContactWithResponse call

func (UnarchiveContactResponse) Status

func (r UnarchiveContactResponse) Status() string

Status returns HTTPResponse.Status

func (UnarchiveContactResponse) StatusCode

func (r UnarchiveContactResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Unauthorized

type Unauthorized = ErrorSchema

Unauthorized The API will return an Error List for a failed request, which will contain one or more Error objects.

type UntagCompanyRequestSchema

type UntagCompanyRequestSchema struct {
	// Companies The id or company_id of the company can be passed as input parameters.
	Companies []struct {
		// CompanyId The company id you have defined for the company.
		CompanyId *string `json:"company_id,omitempty"`

		// Id The Intercom defined id representing the company.
		Id *string `json:"id,omitempty"`

		// Untag Always set to true
		Untag *bool `json:"untag,omitempty"`
	} `json:"companies"`

	// Name The name of the tag which will be untagged from the company
	Name string `json:"name"`
}

UntagCompanyRequestSchema You can tag a single company or a list of companies.

type UpdateArticleJSONRequestBody

type UpdateArticleJSONRequestBody = UpdateArticleRequestSchema

UpdateArticleJSONRequestBody defines body for UpdateArticle for application/json ContentType.

type UpdateArticleParams

type UpdateArticleParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

UpdateArticleParams defines parameters for UpdateArticle.

type UpdateArticleRequestSchema

type UpdateArticleRequestSchema struct {
	// AuthorId The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.
	AuthorId *int `json:"author_id,omitempty"`

	// Body The content of the article. For multilingual articles, this will be the body of the default language's content.
	Body *string `json:"body,omitempty"`

	// Description The description of the article. For multilingual articles, this will be the description of the default language's content.
	Description *string `json:"description,omitempty"`

	// ParentId The id of the article's parent collection or section. An article without this field stands alone.
	ParentId *string `json:"parent_id,omitempty"`

	// ParentType The type of parent, which can either be a `collection` or `section`.
	ParentType *string `json:"parent_type,omitempty"`

	// State Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language's content.
	State *UpdateArticleRequestState `json:"state,omitempty"`

	// Title The title of the article.For multilingual articles, this will be the title of the default language's content.
	Title             *string                         `json:"title,omitempty"`
	TranslatedContent *ArticleTranslatedContentSchema `json:"translated_content,omitempty"`
}

UpdateArticleRequestSchema You can Update an Article

type UpdateArticleRequestState

type UpdateArticleRequestState string

UpdateArticleRequestState Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language's content.

const (
	Draft     UpdateArticleRequestState = "draft"
	Published UpdateArticleRequestState = "published"
)

Defines values for UpdateArticleRequestState.

func (UpdateArticleRequestState) Valid

func (e UpdateArticleRequestState) Valid() bool

Valid indicates whether the value is a known member of the UpdateArticleRequestState enum.

type UpdateArticleResponse

type UpdateArticleResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ArticleSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseUpdateArticleResponse

func ParseUpdateArticleResponse(rsp *http.Response) (*UpdateArticleResponse, error)

ParseUpdateArticleResponse parses an HTTP response from a UpdateArticleWithResponse call

func (UpdateArticleResponse) Status

func (r UpdateArticleResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateArticleResponse) StatusCode

func (r UpdateArticleResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateCollectionJSONRequestBody

type UpdateCollectionJSONRequestBody = UpdateCollectionRequestSchema

UpdateCollectionJSONRequestBody defines body for UpdateCollection for application/json ContentType.

type UpdateCollectionParams

type UpdateCollectionParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

UpdateCollectionParams defines parameters for UpdateCollection.

type UpdateCollectionRequestSchema

type UpdateCollectionRequestSchema struct {
	// Description The description of the collection. For multilingual collections, this will be the description of the default language's content.
	Description *string `json:"description,omitempty"`

	// Name The name of the collection. For multilingual collections, this will be the name of the default language's content.
	Name *string `json:"name,omitempty"`

	// ParentId The id of the parent collection. If `null` then it will be updated as the first level collection.
	ParentId          *string                       `json:"parent_id,omitempty"`
	TranslatedContent *GroupTranslatedContentSchema `json:"translated_content,omitempty"`
}

UpdateCollectionRequestSchema You can update a collection

type UpdateCollectionResponse

type UpdateCollectionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CollectionSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseUpdateCollectionResponse

func ParseUpdateCollectionResponse(rsp *http.Response) (*UpdateCollectionResponse, error)

ParseUpdateCollectionResponse parses an HTTP response from a UpdateCollectionWithResponse call

func (UpdateCollectionResponse) Status

func (r UpdateCollectionResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateCollectionResponse) StatusCode

func (r UpdateCollectionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateCompanyJSONRequestBody

type UpdateCompanyJSONRequestBody = UpdateCompanyRequestSchema

UpdateCompanyJSONRequestBody defines body for UpdateCompany for application/json ContentType.

type UpdateCompanyParams

type UpdateCompanyParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

UpdateCompanyParams defines parameters for UpdateCompany.

type UpdateCompanyRequestSchema

type UpdateCompanyRequestSchema struct {
	// CustomAttributes A hash of key/value pairs containing any other data about the company you want Intercom to store.
	CustomAttributes *map[string]string `json:"custom_attributes,omitempty"`

	// Industry The industry that this company operates in.
	Industry *string `json:"industry,omitempty"`

	// MonthlySpend How much revenue the company generates for your business. Note that this will truncate floats. i.e. it only allow for whole integers, 155.98 will be truncated to 155. Note that this has an upper limit of 2**31-1 or 2147483647..
	MonthlySpend *int `json:"monthly_spend,omitempty"`

	// Name The name of the Company
	Name *string `json:"name,omitempty"`

	// Plan The name of the plan you have associated with the company.
	Plan *string `json:"plan,omitempty"`

	// Size The number of employees in this company.
	Size *int `json:"size,omitempty"`

	// Website The URL for this company's website. Please note that the value specified here is not validated. Accepts any string.
	Website *string `json:"website,omitempty"`
}

UpdateCompanyRequestSchema You can update a Company

type UpdateCompanyResponse

type UpdateCompanyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CompanySchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseUpdateCompanyResponse

func ParseUpdateCompanyResponse(rsp *http.Response) (*UpdateCompanyResponse, error)

ParseUpdateCompanyResponse parses an HTTP response from a UpdateCompanyWithResponse call

func (UpdateCompanyResponse) Status

func (r UpdateCompanyResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateCompanyResponse) StatusCode

func (r UpdateCompanyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateContactJSONBody

type UpdateContactJSONBody struct {
	// contains filtered or unexported fields
}

UpdateContactJSONBody defines parameters for UpdateContact.

type UpdateContactJSONRequestBody

type UpdateContactJSONRequestBody UpdateContactJSONBody

UpdateContactJSONRequestBody defines body for UpdateContact for application/json ContentType.

type UpdateContactParams

type UpdateContactParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

UpdateContactParams defines parameters for UpdateContact.

type UpdateContactRequestSchema

type UpdateContactRequestSchema struct {
	// Avatar An image URL containing the avatar of a contact
	Avatar *string `json:"avatar,omitempty"`

	// CustomAttributes The custom attributes which are set for the contact
	CustomAttributes *map[string]interface{} `json:"custom_attributes,omitempty"`

	// Email The contacts email
	Email *string `json:"email,omitempty"`

	// ExternalId A unique identifier for the contact which is given to Intercom
	ExternalId *string `json:"external_id,omitempty"`

	// LastSeenAt (Unix timestamp in seconds) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).
	LastSeenAt *int `json:"last_seen_at,omitempty"`

	// Name The contacts name
	Name *string `json:"name,omitempty"`

	// OwnerId The id of an admin that has been assigned account ownership of the contact
	OwnerId *int `json:"owner_id,omitempty"`

	// Phone The contacts phone
	Phone *string `json:"phone,omitempty"`

	// Role The role of the contact.
	Role *string `json:"role,omitempty"`

	// SignedUpAt (Unix timestamp in seconds) The time specified for when a contact signed up.
	SignedUpAt *int `json:"signed_up_at,omitempty"`

	// UnsubscribedFromEmails Whether the contact is unsubscribed from emails
	UnsubscribedFromEmails *bool `json:"unsubscribed_from_emails,omitempty"`
}

UpdateContactRequestSchema You can update a contact

type UpdateContactResponse

type UpdateContactResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ContactSchema
	JSON401      *ErrorSchema
}

func ParseUpdateContactResponse

func ParseUpdateContactResponse(rsp *http.Response) (*UpdateContactResponse, error)

ParseUpdateContactResponse parses an HTTP response from a UpdateContactWithResponse call

func (UpdateContactResponse) Status

func (r UpdateContactResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateContactResponse) StatusCode

func (r UpdateContactResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateContentImportSourceJSONRequestBody

type UpdateContentImportSourceJSONRequestBody = UpdateContentImportSourceRequestSchema

UpdateContentImportSourceJSONRequestBody defines body for UpdateContentImportSource for application/json ContentType.

type UpdateContentImportSourceParams

type UpdateContentImportSourceParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

UpdateContentImportSourceParams defines parameters for UpdateContentImportSource.

type UpdateContentImportSourceRequestAudienceIds0

type UpdateContentImportSourceRequestAudienceIds0 = int

UpdateContentImportSourceRequestAudienceIds0 defines model for .

type UpdateContentImportSourceRequestAudienceIds1

type UpdateContentImportSourceRequestAudienceIds1 = []int

UpdateContentImportSourceRequestAudienceIds1 defines model for .

type UpdateContentImportSourceRequestSchema

type UpdateContentImportSourceRequestSchema struct {
	// ApplyAudienceToExistingContent When true, the audience will be applied to all existing external pages belonging to this content import source.
	ApplyAudienceToExistingContent *bool `json:"apply_audience_to_existing_content,omitempty"`

	// AudienceIds The unique identifiers for the audiences to associate with this content import source. Can be a single integer or an array of integers. Set to null or an empty array to remove all audiences.
	AudienceIds *UpdateContentImportSourceRequest_AudienceIds `json:"audience_ids,omitempty"`

	// Status The status of the content import source.
	Status *UpdateContentImportSourceRequestStatus `json:"status,omitempty"`

	// SyncBehavior If you intend to create or update External Pages via the API, this should be set to `api`. You can not change the value to or from api.
	SyncBehavior UpdateContentImportSourceRequestSyncBehavior `json:"sync_behavior"`

	// Url The URL of the content import source. This may only be different from the existing value if the sync behavior is API.
	Url string `json:"url"`
}

UpdateContentImportSourceRequestSchema You can modify a Content Import Source of your Fin Content Library.

type UpdateContentImportSourceRequestStatus

type UpdateContentImportSourceRequestStatus string

UpdateContentImportSourceRequestStatus The status of the content import source.

const (
	UpdateContentImportSourceRequestStatusActive      UpdateContentImportSourceRequestStatus = "active"
	UpdateContentImportSourceRequestStatusDeactivated UpdateContentImportSourceRequestStatus = "deactivated"
)

Defines values for UpdateContentImportSourceRequestStatus.

func (UpdateContentImportSourceRequestStatus) Valid

Valid indicates whether the value is a known member of the UpdateContentImportSourceRequestStatus enum.

type UpdateContentImportSourceRequestSyncBehavior

type UpdateContentImportSourceRequestSyncBehavior string

UpdateContentImportSourceRequestSyncBehavior If you intend to create or update External Pages via the API, this should be set to `api`. You can not change the value to or from api.

Defines values for UpdateContentImportSourceRequestSyncBehavior.

func (UpdateContentImportSourceRequestSyncBehavior) Valid

Valid indicates whether the value is a known member of the UpdateContentImportSourceRequestSyncBehavior enum.

type UpdateContentImportSourceRequest_AudienceIds

type UpdateContentImportSourceRequest_AudienceIds struct {
	// contains filtered or unexported fields
}

UpdateContentImportSourceRequest_AudienceIds The unique identifiers for the audiences to associate with this content import source. Can be a single integer or an array of integers. Set to null or an empty array to remove all audiences.

func (UpdateContentImportSourceRequest_AudienceIds) AsUpdateContentImportSourceRequestAudienceIds0

func (t UpdateContentImportSourceRequest_AudienceIds) AsUpdateContentImportSourceRequestAudienceIds0() (UpdateContentImportSourceRequestAudienceIds0, error)

AsUpdateContentImportSourceRequestAudienceIds0 returns the union data inside the UpdateContentImportSourceRequest_AudienceIds as a UpdateContentImportSourceRequestAudienceIds0

func (UpdateContentImportSourceRequest_AudienceIds) AsUpdateContentImportSourceRequestAudienceIds1

func (t UpdateContentImportSourceRequest_AudienceIds) AsUpdateContentImportSourceRequestAudienceIds1() (UpdateContentImportSourceRequestAudienceIds1, error)

AsUpdateContentImportSourceRequestAudienceIds1 returns the union data inside the UpdateContentImportSourceRequest_AudienceIds as a UpdateContentImportSourceRequestAudienceIds1

func (*UpdateContentImportSourceRequest_AudienceIds) FromUpdateContentImportSourceRequestAudienceIds0

func (t *UpdateContentImportSourceRequest_AudienceIds) FromUpdateContentImportSourceRequestAudienceIds0(v UpdateContentImportSourceRequestAudienceIds0) error

FromUpdateContentImportSourceRequestAudienceIds0 overwrites any union data inside the UpdateContentImportSourceRequest_AudienceIds as the provided UpdateContentImportSourceRequestAudienceIds0

func (*UpdateContentImportSourceRequest_AudienceIds) FromUpdateContentImportSourceRequestAudienceIds1

func (t *UpdateContentImportSourceRequest_AudienceIds) FromUpdateContentImportSourceRequestAudienceIds1(v UpdateContentImportSourceRequestAudienceIds1) error

FromUpdateContentImportSourceRequestAudienceIds1 overwrites any union data inside the UpdateContentImportSourceRequest_AudienceIds as the provided UpdateContentImportSourceRequestAudienceIds1

func (UpdateContentImportSourceRequest_AudienceIds) MarshalJSON

func (*UpdateContentImportSourceRequest_AudienceIds) MergeUpdateContentImportSourceRequestAudienceIds0

func (t *UpdateContentImportSourceRequest_AudienceIds) MergeUpdateContentImportSourceRequestAudienceIds0(v UpdateContentImportSourceRequestAudienceIds0) error

MergeUpdateContentImportSourceRequestAudienceIds0 performs a merge with any union data inside the UpdateContentImportSourceRequest_AudienceIds, using the provided UpdateContentImportSourceRequestAudienceIds0

func (*UpdateContentImportSourceRequest_AudienceIds) MergeUpdateContentImportSourceRequestAudienceIds1

func (t *UpdateContentImportSourceRequest_AudienceIds) MergeUpdateContentImportSourceRequestAudienceIds1(v UpdateContentImportSourceRequestAudienceIds1) error

MergeUpdateContentImportSourceRequestAudienceIds1 performs a merge with any union data inside the UpdateContentImportSourceRequest_AudienceIds, using the provided UpdateContentImportSourceRequestAudienceIds1

func (*UpdateContentImportSourceRequest_AudienceIds) UnmarshalJSON

type UpdateContentImportSourceResponse

type UpdateContentImportSourceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ContentImportSourceSchema
	JSON401      *ErrorSchema
}

func ParseUpdateContentImportSourceResponse

func ParseUpdateContentImportSourceResponse(rsp *http.Response) (*UpdateContentImportSourceResponse, error)

ParseUpdateContentImportSourceResponse parses an HTTP response from a UpdateContentImportSourceWithResponse call

func (UpdateContentImportSourceResponse) Status

Status returns HTTPResponse.Status

func (UpdateContentImportSourceResponse) StatusCode

func (r UpdateContentImportSourceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateConversationJSONRequestBody

type UpdateConversationJSONRequestBody = UpdateConversationRequestSchema

UpdateConversationJSONRequestBody defines body for UpdateConversation for application/json ContentType.

type UpdateConversationParams

type UpdateConversationParams struct {
	// DisplayAs Set to plaintext to retrieve conversation messages in plain text.
	DisplayAs       *string          `form:"display_as,omitempty" json:"display_as,omitempty"`
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

UpdateConversationParams defines parameters for UpdateConversation.

type UpdateConversationRequestSchema

type UpdateConversationRequestSchema struct {
	// CompanyId The ID of the company that the conversation is associated with. The unique identifier for the company which is given by Intercom. Set to nil to remove company.
	CompanyId        *string                 `json:"company_id,omitempty"`
	CustomAttributes *CustomAttributesSchema `json:"custom_attributes,omitempty"`

	// Read Mark a conversation as read within Intercom.
	Read *bool `json:"read,omitempty"`

	// Title The title given to the conversation
	Title *string `json:"title,omitempty"`
}

UpdateConversationRequestSchema Payload of the request to update a conversation

type UpdateConversationResponse

type UpdateConversationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ConversationSchema
	JSON401      *ErrorSchema
	JSON403      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseUpdateConversationResponse

func ParseUpdateConversationResponse(rsp *http.Response) (*UpdateConversationResponse, error)

ParseUpdateConversationResponse parses an HTTP response from a UpdateConversationWithResponse call

func (UpdateConversationResponse) Status

Status returns HTTPResponse.Status

func (UpdateConversationResponse) StatusCode

func (r UpdateConversationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateDataAttributeJSONRequestBody

type UpdateDataAttributeJSONRequestBody = UpdateDataAttributeRequestSchema

UpdateDataAttributeJSONRequestBody defines body for UpdateDataAttribute for application/json ContentType.

type UpdateDataAttributeParams

type UpdateDataAttributeParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

UpdateDataAttributeParams defines parameters for UpdateDataAttribute.

type UpdateDataAttributeRequest0

type UpdateDataAttributeRequest0 struct {
	// Options Array of objects representing the options of the list, with `value` as the key and the option as the value. At least two options are required.
	Options []struct {
		Value *string `json:"value,omitempty"`
	} `json:"options"`
}

UpdateDataAttributeRequest0 defines model for .

type UpdateDataAttributeRequest1

type UpdateDataAttributeRequest1 = interface{}

UpdateDataAttributeRequest1 defines model for .

type UpdateDataAttributeRequestSchema

type UpdateDataAttributeRequestSchema struct {
	// Archived Whether the attribute is to be archived or not.
	Archived *bool `json:"archived,omitempty"`

	// Description The readable description you see in the UI for the attribute.
	Description *string `json:"description,omitempty"`

	// MessengerWritable Can this attribute be updated by the Messenger
	MessengerWritable *bool `json:"messenger_writable,omitempty"`
	// contains filtered or unexported fields
}

UpdateDataAttributeRequestSchema defines model for update_data_attribute_request.

func (UpdateDataAttributeRequestSchema) AsUpdateDataAttributeRequest0

func (t UpdateDataAttributeRequestSchema) AsUpdateDataAttributeRequest0() (UpdateDataAttributeRequest0, error)

AsUpdateDataAttributeRequest0 returns the union data inside the UpdateDataAttributeRequestSchema as a UpdateDataAttributeRequest0

func (UpdateDataAttributeRequestSchema) AsUpdateDataAttributeRequest1

func (t UpdateDataAttributeRequestSchema) AsUpdateDataAttributeRequest1() (UpdateDataAttributeRequest1, error)

AsUpdateDataAttributeRequest1 returns the union data inside the UpdateDataAttributeRequestSchema as a UpdateDataAttributeRequest1

func (*UpdateDataAttributeRequestSchema) FromUpdateDataAttributeRequest0

func (t *UpdateDataAttributeRequestSchema) FromUpdateDataAttributeRequest0(v UpdateDataAttributeRequest0) error

FromUpdateDataAttributeRequest0 overwrites any union data inside the UpdateDataAttributeRequestSchema as the provided UpdateDataAttributeRequest0

func (*UpdateDataAttributeRequestSchema) FromUpdateDataAttributeRequest1

func (t *UpdateDataAttributeRequestSchema) FromUpdateDataAttributeRequest1(v UpdateDataAttributeRequest1) error

FromUpdateDataAttributeRequest1 overwrites any union data inside the UpdateDataAttributeRequestSchema as the provided UpdateDataAttributeRequest1

func (UpdateDataAttributeRequestSchema) MarshalJSON

func (t UpdateDataAttributeRequestSchema) MarshalJSON() ([]byte, error)

func (*UpdateDataAttributeRequestSchema) MergeUpdateDataAttributeRequest0

func (t *UpdateDataAttributeRequestSchema) MergeUpdateDataAttributeRequest0(v UpdateDataAttributeRequest0) error

MergeUpdateDataAttributeRequest0 performs a merge with any union data inside the UpdateDataAttributeRequestSchema, using the provided UpdateDataAttributeRequest0

func (*UpdateDataAttributeRequestSchema) MergeUpdateDataAttributeRequest1

func (t *UpdateDataAttributeRequestSchema) MergeUpdateDataAttributeRequest1(v UpdateDataAttributeRequest1) error

MergeUpdateDataAttributeRequest1 performs a merge with any union data inside the UpdateDataAttributeRequestSchema, using the provided UpdateDataAttributeRequest1

func (*UpdateDataAttributeRequestSchema) UnmarshalJSON

func (t *UpdateDataAttributeRequestSchema) UnmarshalJSON(b []byte) error

type UpdateDataAttributeResponse

type UpdateDataAttributeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DataAttributeSchema
	JSON400      *ErrorSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
	JSON422      *ErrorSchema
}

func ParseUpdateDataAttributeResponse

func ParseUpdateDataAttributeResponse(rsp *http.Response) (*UpdateDataAttributeResponse, error)

ParseUpdateDataAttributeResponse parses an HTTP response from a UpdateDataAttributeWithResponse call

func (UpdateDataAttributeResponse) Status

Status returns HTTPResponse.Status

func (UpdateDataAttributeResponse) StatusCode

func (r UpdateDataAttributeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateExternalPageJSONRequestBody

type UpdateExternalPageJSONRequestBody = UpdateExternalPageRequestSchema

UpdateExternalPageJSONRequestBody defines body for UpdateExternalPage for application/json ContentType.

type UpdateExternalPageParams

type UpdateExternalPageParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

UpdateExternalPageParams defines parameters for UpdateExternalPage.

type UpdateExternalPageRequestLocale

type UpdateExternalPageRequestLocale string

UpdateExternalPageRequestLocale Always en

const (
	En UpdateExternalPageRequestLocale = "en"
)

Defines values for UpdateExternalPageRequestLocale.

func (UpdateExternalPageRequestLocale) Valid

Valid indicates whether the value is a known member of the UpdateExternalPageRequestLocale enum.

type UpdateExternalPageRequestSchema

type UpdateExternalPageRequestSchema struct {
	// ExternalId The identifier for the external page which was given by the source. Must be unique for the source.
	ExternalId *string `json:"external_id,omitempty"`

	// FinAvailability Whether the external page should be used to answer questions by Fin.
	FinAvailability *bool `json:"fin_availability,omitempty"`

	// Html The body of the external page in HTML.
	Html string `json:"html"`

	// Locale Always en
	Locale UpdateExternalPageRequestLocale `json:"locale"`

	// SourceId The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response.
	SourceId int `json:"source_id"`

	// Title The title of the external page.
	Title string `json:"title"`

	// Url The URL of the external page. This will be used by Fin to link end users to the page it based its answer on.
	Url string `json:"url"`
}

UpdateExternalPageRequestSchema You can update an External Page in your Fin Content Library.

type UpdateExternalPageResponse

type UpdateExternalPageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ExternalPageSchema
	JSON401      *ErrorSchema
}

func ParseUpdateExternalPageResponse

func ParseUpdateExternalPageResponse(rsp *http.Response) (*UpdateExternalPageResponse, error)

ParseUpdateExternalPageResponse parses an HTTP response from a UpdateExternalPageWithResponse call

func (UpdateExternalPageResponse) Status

Status returns HTTPResponse.Status

func (UpdateExternalPageResponse) StatusCode

func (r UpdateExternalPageResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateInternalArticleJSONRequestBody

type UpdateInternalArticleJSONRequestBody = UpdateInternalArticleRequestSchema

UpdateInternalArticleJSONRequestBody defines body for UpdateInternalArticle for application/json ContentType.

type UpdateInternalArticleParams

type UpdateInternalArticleParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

UpdateInternalArticleParams defines parameters for UpdateInternalArticle.

type UpdateInternalArticleRequestSchema

type UpdateInternalArticleRequestSchema struct {
	// AuthorId The id of the author of the article.
	AuthorId *int `json:"author_id,omitempty"`

	// Body The content of the article.
	Body *string `json:"body,omitempty"`

	// OwnerId The id of the author of the article.
	OwnerId *int `json:"owner_id,omitempty"`

	// Title The title of the article.
	Title *string `json:"title,omitempty"`
}

UpdateInternalArticleRequestSchema You can Update an Internal Article

type UpdateInternalArticleResponse

type UpdateInternalArticleResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *InternalArticleSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseUpdateInternalArticleResponse

func ParseUpdateInternalArticleResponse(rsp *http.Response) (*UpdateInternalArticleResponse, error)

ParseUpdateInternalArticleResponse parses an HTTP response from a UpdateInternalArticleWithResponse call

func (UpdateInternalArticleResponse) Status

Status returns HTTPResponse.Status

func (UpdateInternalArticleResponse) StatusCode

func (r UpdateInternalArticleResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateIpAllowlistJSONRequestBody

type UpdateIpAllowlistJSONRequestBody = IpAllowlistSchema

UpdateIpAllowlistJSONRequestBody defines body for UpdateIpAllowlist for application/json ContentType.

type UpdateIpAllowlistParams

type UpdateIpAllowlistParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

UpdateIpAllowlistParams defines parameters for UpdateIpAllowlist.

type UpdateIpAllowlistResponse

type UpdateIpAllowlistResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *IpAllowlistSchema
	JSON401      *ErrorSchema
	JSON422      *ErrorSchema
}

func ParseUpdateIpAllowlistResponse

func ParseUpdateIpAllowlistResponse(rsp *http.Response) (*UpdateIpAllowlistResponse, error)

ParseUpdateIpAllowlistResponse parses an HTTP response from a UpdateIpAllowlistWithResponse call

func (UpdateIpAllowlistResponse) Status

func (r UpdateIpAllowlistResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateIpAllowlistResponse) StatusCode

func (r UpdateIpAllowlistResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateNewsItemJSONRequestBody

type UpdateNewsItemJSONRequestBody = NewsItemRequestSchema

UpdateNewsItemJSONRequestBody defines body for UpdateNewsItem for application/json ContentType.

type UpdateNewsItemParams

type UpdateNewsItemParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

UpdateNewsItemParams defines parameters for UpdateNewsItem.

type UpdateNewsItemResponse

type UpdateNewsItemResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *NewsItemSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseUpdateNewsItemResponse

func ParseUpdateNewsItemResponse(rsp *http.Response) (*UpdateNewsItemResponse, error)

ParseUpdateNewsItemResponse parses an HTTP response from a UpdateNewsItemWithResponse call

func (UpdateNewsItemResponse) Status

func (r UpdateNewsItemResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateNewsItemResponse) StatusCode

func (r UpdateNewsItemResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateTicketJSONBody

type UpdateTicketJSONBody = UpdateTicketRequestSchema

UpdateTicketJSONBody defines parameters for UpdateTicket.

type UpdateTicketJSONRequestBody

type UpdateTicketJSONRequestBody = UpdateTicketJSONBody

UpdateTicketJSONRequestBody defines body for UpdateTicket for application/json ContentType.

type UpdateTicketParams

type UpdateTicketParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

UpdateTicketParams defines parameters for UpdateTicket.

type UpdateTicketRequestSchema

type UpdateTicketRequestSchema struct {
	// AdminId The ID of the admin performing ticket update. Needed for workflows execution and attributing actions to specific admins.
	AdminId *int `json:"admin_id,omitempty"`

	// AssigneeId The ID of the admin or team to which the ticket is assigned. Set this 0 to unassign it.
	AssigneeId *string `json:"assignee_id,omitempty"`

	// CompanyId The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom. Set to nil to remove company.
	CompanyId *string `json:"company_id,omitempty"`

	// IsShared Specify whether the ticket is visible to users.
	IsShared *bool `json:"is_shared,omitempty"`

	// Open Specify if a ticket is open. Set to false to close a ticket. Closing a ticket will also unsnooze it.
	Open *bool `json:"open,omitempty"`

	// SnoozedUntil The time you want the ticket to reopen.
	SnoozedUntil *int `json:"snoozed_until,omitempty"`

	// TicketAttributes The attributes set on the ticket.
	TicketAttributes *map[string]interface{} `json:"ticket_attributes,omitempty"`

	// TicketStateId The ID of the ticket state associated with the ticket type.
	TicketStateId *string `json:"ticket_state_id,omitempty"`
}

UpdateTicketRequestSchema You can update a Ticket

type UpdateTicketResponse

type UpdateTicketResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TicketSchema
	JSON401      *ErrorSchema
}

func ParseUpdateTicketResponse

func ParseUpdateTicketResponse(rsp *http.Response) (*UpdateTicketResponse, error)

ParseUpdateTicketResponse parses an HTTP response from a UpdateTicketWithResponse call

func (UpdateTicketResponse) Status

func (r UpdateTicketResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateTicketResponse) StatusCode

func (r UpdateTicketResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateTicketTypeAttributeJSONRequestBody

type UpdateTicketTypeAttributeJSONRequestBody = UpdateTicketTypeAttributeRequestSchema

UpdateTicketTypeAttributeJSONRequestBody defines body for UpdateTicketTypeAttribute for application/json ContentType.

type UpdateTicketTypeAttributeParams

type UpdateTicketTypeAttributeParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

UpdateTicketTypeAttributeParams defines parameters for UpdateTicketTypeAttribute.

type UpdateTicketTypeAttributeRequestSchema

type UpdateTicketTypeAttributeRequestSchema struct {
	// AllowMultipleValues Whether the attribute allows multiple files to be attached to it (only applicable to file attributes)
	AllowMultipleValues *bool `json:"allow_multiple_values,omitempty"`

	// Archived Whether the attribute should be archived and not shown during creation of the ticket (it will still be present on previously created tickets)
	Archived *bool `json:"archived,omitempty"`

	// Description The description of the attribute presented to the teammate or contact
	Description *string `json:"description,omitempty"`

	// ListItems A comma delimited list of items for the attribute value (only applicable to list attributes)
	ListItems *string `json:"list_items,omitempty"`

	// Multiline Whether the attribute allows multiple lines of text (only applicable to string attributes)
	Multiline *bool `json:"multiline,omitempty"`

	// Name The name of the ticket type attribute
	Name *string `json:"name,omitempty"`

	// RequiredToCreate Whether the attribute is required to be filled in when teammates are creating the ticket in Inbox.
	RequiredToCreate *bool `json:"required_to_create,omitempty"`

	// RequiredToCreateForContacts Whether the attribute is required to be filled in when contacts are creating the ticket in Messenger.
	RequiredToCreateForContacts *bool `json:"required_to_create_for_contacts,omitempty"`

	// VisibleOnCreate Whether the attribute is visible to teammates when creating a ticket in Inbox.
	VisibleOnCreate *bool `json:"visible_on_create,omitempty"`

	// VisibleToContacts Whether the attribute is visible to contacts when creating a ticket in Messenger.
	VisibleToContacts *bool `json:"visible_to_contacts,omitempty"`
}

UpdateTicketTypeAttributeRequestSchema You can update a Ticket Type Attribute

type UpdateTicketTypeAttributeResponse

type UpdateTicketTypeAttributeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TicketTypeAttributeSchema
	JSON401      *ErrorSchema
}

func ParseUpdateTicketTypeAttributeResponse

func ParseUpdateTicketTypeAttributeResponse(rsp *http.Response) (*UpdateTicketTypeAttributeResponse, error)

ParseUpdateTicketTypeAttributeResponse parses an HTTP response from a UpdateTicketTypeAttributeWithResponse call

func (UpdateTicketTypeAttributeResponse) Status

Status returns HTTPResponse.Status

func (UpdateTicketTypeAttributeResponse) StatusCode

func (r UpdateTicketTypeAttributeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateTicketTypeJSONRequestBody

type UpdateTicketTypeJSONRequestBody = UpdateTicketTypeRequestSchema

UpdateTicketTypeJSONRequestBody defines body for UpdateTicketType for application/json ContentType.

type UpdateTicketTypeParams

type UpdateTicketTypeParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

UpdateTicketTypeParams defines parameters for UpdateTicketType.

type UpdateTicketTypeRequestCategory

type UpdateTicketTypeRequestCategory string

UpdateTicketTypeRequestCategory Category of the Ticket Type.

const (
	BackOffice UpdateTicketTypeRequestCategory = "Back-office"
	Customer   UpdateTicketTypeRequestCategory = "Customer"
	Tracker    UpdateTicketTypeRequestCategory = "Tracker"
)

Defines values for UpdateTicketTypeRequestCategory.

func (UpdateTicketTypeRequestCategory) Valid

Valid indicates whether the value is a known member of the UpdateTicketTypeRequestCategory enum.

type UpdateTicketTypeRequestSchema

type UpdateTicketTypeRequestSchema struct {
	// Archived The archived status of the ticket type.
	Archived *bool `json:"archived,omitempty"`

	// Category Category of the Ticket Type.
	Category *UpdateTicketTypeRequestCategory `json:"category,omitempty"`

	// Description The description of the ticket type.
	Description *string `json:"description,omitempty"`

	// Icon The icon of the ticket type.
	Icon *string `json:"icon,omitempty"`

	// IsInternal Whether the tickets associated with this ticket type are intended for internal use only or will be shared with customers. This is currently a limited attribute.
	IsInternal *bool `json:"is_internal,omitempty"`

	// Name The name of the ticket type.
	Name *string `json:"name,omitempty"`
}

UpdateTicketTypeRequestSchema The request payload for updating a ticket type. You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)

type UpdateTicketTypeResponse

type UpdateTicketTypeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TicketTypeSchema
	JSON401      *ErrorSchema
}

func ParseUpdateTicketTypeResponse

func ParseUpdateTicketTypeResponse(rsp *http.Response) (*UpdateTicketTypeResponse, error)

ParseUpdateTicketTypeResponse parses an HTTP response from a UpdateTicketTypeWithResponse call

func (UpdateTicketTypeResponse) Status

func (r UpdateTicketTypeResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateTicketTypeResponse) StatusCode

func (r UpdateTicketTypeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateVisitorJSONRequestBody

type UpdateVisitorJSONRequestBody = UpdateVisitorRequestSchema

UpdateVisitorJSONRequestBody defines body for UpdateVisitor for application/json ContentType.

type UpdateVisitorParams

type UpdateVisitorParams struct {
	IntercomVersion *IntercomVersion `json:"Intercom-Version,omitempty"`
}

UpdateVisitorParams defines parameters for UpdateVisitor.

type UpdateVisitorRequest0

type UpdateVisitorRequest0 = interface{}

UpdateVisitorRequest0 defines model for .

type UpdateVisitorRequest1

type UpdateVisitorRequest1 = interface{}

UpdateVisitorRequest1 defines model for .

type UpdateVisitorRequestSchema

type UpdateVisitorRequestSchema struct {
	// CustomAttributes The custom attributes which are set for the visitor.
	CustomAttributes *map[string]string `json:"custom_attributes,omitempty"`

	// Id A unique identified for the visitor which is given by Intercom.
	Id *string `json:"id,omitempty"`

	// Name The visitor's name.
	Name *string `json:"name,omitempty"`

	// UserId A unique identified for the visitor which is given by you.
	UserId *string `json:"user_id,omitempty"`
	// contains filtered or unexported fields
}

UpdateVisitorRequestSchema Update an existing visitor.

func (UpdateVisitorRequestSchema) AsUpdateVisitorRequest0

func (t UpdateVisitorRequestSchema) AsUpdateVisitorRequest0() (UpdateVisitorRequest0, error)

AsUpdateVisitorRequest0 returns the union data inside the UpdateVisitorRequestSchema as a UpdateVisitorRequest0

func (UpdateVisitorRequestSchema) AsUpdateVisitorRequest1

func (t UpdateVisitorRequestSchema) AsUpdateVisitorRequest1() (UpdateVisitorRequest1, error)

AsUpdateVisitorRequest1 returns the union data inside the UpdateVisitorRequestSchema as a UpdateVisitorRequest1

func (*UpdateVisitorRequestSchema) FromUpdateVisitorRequest0

func (t *UpdateVisitorRequestSchema) FromUpdateVisitorRequest0(v UpdateVisitorRequest0) error

FromUpdateVisitorRequest0 overwrites any union data inside the UpdateVisitorRequestSchema as the provided UpdateVisitorRequest0

func (*UpdateVisitorRequestSchema) FromUpdateVisitorRequest1

func (t *UpdateVisitorRequestSchema) FromUpdateVisitorRequest1(v UpdateVisitorRequest1) error

FromUpdateVisitorRequest1 overwrites any union data inside the UpdateVisitorRequestSchema as the provided UpdateVisitorRequest1

func (UpdateVisitorRequestSchema) MarshalJSON

func (t UpdateVisitorRequestSchema) MarshalJSON() ([]byte, error)

func (*UpdateVisitorRequestSchema) MergeUpdateVisitorRequest0

func (t *UpdateVisitorRequestSchema) MergeUpdateVisitorRequest0(v UpdateVisitorRequest0) error

MergeUpdateVisitorRequest0 performs a merge with any union data inside the UpdateVisitorRequestSchema, using the provided UpdateVisitorRequest0

func (*UpdateVisitorRequestSchema) MergeUpdateVisitorRequest1

func (t *UpdateVisitorRequestSchema) MergeUpdateVisitorRequest1(v UpdateVisitorRequest1) error

MergeUpdateVisitorRequest1 performs a merge with any union data inside the UpdateVisitorRequestSchema, using the provided UpdateVisitorRequest1

func (*UpdateVisitorRequestSchema) UnmarshalJSON

func (t *UpdateVisitorRequestSchema) UnmarshalJSON(b []byte) error

type UpdateVisitorResponse

type UpdateVisitorResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *VisitorSchema
	JSON401      *ErrorSchema
	JSON404      *ErrorSchema
}

func ParseUpdateVisitorResponse

func ParseUpdateVisitorResponse(rsp *http.Response) (*UpdateVisitorResponse, error)

ParseUpdateVisitorResponse parses an HTTP response from a UpdateVisitorWithResponse call

func (UpdateVisitorResponse) Status

func (r UpdateVisitorResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateVisitorResponse) StatusCode

func (r UpdateVisitorResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ValidationError

type ValidationError = ErrorSchema

ValidationError The API will return an Error List for a failed request, which will contain one or more Error objects.

type VisitorCompaniesType

type VisitorCompaniesType string

VisitorCompaniesType The type of the object

const (
	CompanyList VisitorCompaniesType = "company.list"
)

Defines values for VisitorCompaniesType.

func (VisitorCompaniesType) Valid

func (e VisitorCompaniesType) Valid() bool

Valid indicates whether the value is a known member of the VisitorCompaniesType enum.

type VisitorDeletedObjectSchema

type VisitorDeletedObjectSchema struct {
	// Id The unique identifier for the visitor which is given by Intercom.
	Id *string `json:"id,omitempty"`

	// Type The type of object which was deleted
	Type *VisitorDeletedObjectType `json:"type,omitempty"`

	// UserId Automatically generated identifier for the Visitor.
	UserId *string `json:"user_id,omitempty"`
}

VisitorDeletedObjectSchema Response returned when an object is deleted

type VisitorDeletedObjectType

type VisitorDeletedObjectType string

VisitorDeletedObjectType The type of object which was deleted

const (
	Visitor VisitorDeletedObjectType = "visitor"
)

Defines values for VisitorDeletedObjectType.

func (VisitorDeletedObjectType) Valid

func (e VisitorDeletedObjectType) Valid() bool

Valid indicates whether the value is a known member of the VisitorDeletedObjectType enum.

type VisitorSchema

type VisitorSchema struct {
	// Anonymous Identifies if this visitor is anonymous.
	Anonymous *bool `json:"anonymous,omitempty"`

	// AppId The id of the app the visitor is associated with.
	AppId  *string `json:"app_id,omitempty"`
	Avatar *struct {
		// ImageUrl This object represents the avatar associated with the visitor.
		ImageUrl *string `json:"image_url,omitempty"`
		Type     *string `json:"type,omitempty"`
	} `json:"avatar,omitempty"`
	Companies *struct {
		Companies *[]CompanySchema `json:"companies,omitempty"`

		// Type The type of the object
		Type *VisitorCompaniesType `json:"type,omitempty"`
	} `json:"companies,omitempty"`

	// CreatedAt The time the Visitor was added to Intercom.
	CreatedAt *int `json:"created_at,omitempty"`

	// CustomAttributes The custom attributes you have set on the Visitor.
	CustomAttributes *map[string]string `json:"custom_attributes,omitempty"`

	// DoNotTrack Identifies if this visitor has do not track enabled.
	DoNotTrack *bool `json:"do_not_track,omitempty"`

	// Email The email of the visitor.
	Email *openapi_types.Email `json:"email,omitempty"`

	// HasHardBounced Identifies if this visitor has had a hard bounce.
	HasHardBounced *bool `json:"has_hard_bounced,omitempty"`

	// Id The Intercom defined id representing the Visitor.
	Id *string `json:"id,omitempty"`

	// LasRequestAt The time the Lead last recorded making a request.
	LasRequestAt *int `json:"las_request_at,omitempty"`
	LocationData *struct {
		// CityName The city name of the visitor.
		CityName *string `json:"city_name,omitempty"`

		// ContinentCode The continent code of the visitor.
		ContinentCode *string `json:"continent_code,omitempty"`

		// CountryCode The country code of the visitor.
		CountryCode *string `json:"country_code,omitempty"`

		// CountryName The country name of the visitor.
		CountryName *string `json:"country_name,omitempty"`

		// PostalCode The postal code of the visitor.
		PostalCode *string `json:"postal_code,omitempty"`

		// RegionName The region name of the visitor.
		RegionName *string `json:"region_name,omitempty"`

		// Timezone The timezone of the visitor.
		Timezone *string `json:"timezone,omitempty"`
		Type     *string `json:"type,omitempty"`
	} `json:"location_data,omitempty"`

	// MarkedEmailAsSpam Identifies if this visitor has marked an email as spam.
	MarkedEmailAsSpam *bool `json:"marked_email_as_spam,omitempty"`

	// Name The name of the visitor.
	Name *string `json:"name,omitempty"`

	// OwnerId The id of the admin that owns the Visitor.
	OwnerId *string `json:"owner_id,omitempty"`

	// Phone The phone number of the visitor.
	Phone *string `json:"phone,omitempty"`

	// Pseudonym The pseudonym of the visitor.
	Pseudonym *string `json:"pseudonym,omitempty"`

	// Referrer The referer of the visitor.
	Referrer *string `json:"referrer,omitempty"`

	// RemoteCreatedAt The time the Visitor was added to Intercom.
	RemoteCreatedAt *int `json:"remote_created_at,omitempty"`
	Segments        *struct {
		Segments *[]string `json:"segments,omitempty"`

		// Type The type of the object
		Type *VisitorSegmentsType `json:"type,omitempty"`
	} `json:"segments,omitempty"`

	// SessionCount The number of sessions the Visitor has had.
	SessionCount *int `json:"session_count,omitempty"`

	// SignedUpAt The time the Visitor signed up for your product.
	SignedUpAt     *int `json:"signed_up_at,omitempty"`
	SocialProfiles *struct {
		SocialProfiles *[]string `json:"social_profiles,omitempty"`

		// Type The type of the object
		Type *VisitorSocialProfilesType `json:"type,omitempty"`
	} `json:"social_profiles,omitempty"`
	Tags *struct {
		Tags *[]struct {
			// Id The id of the tag.
			Id *string `json:"id,omitempty"`

			// Name The name of the tag.
			Name *string `json:"name,omitempty"`

			// Type The type of the object
			Type *VisitorTagsTagsType `json:"type,omitempty"`
		} `json:"tags,omitempty"`

		// Type The type of the object
		Type *VisitorTagsType `json:"type,omitempty"`
	} `json:"tags,omitempty"`

	// Type Value is 'visitor'
	Type *string `json:"type,omitempty"`

	// UnsubscribedFromEmails Whether the Visitor is unsubscribed from emails.
	UnsubscribedFromEmails *bool `json:"unsubscribed_from_emails,omitempty"`

	// UpdatedAt The last time the Visitor was updated.
	UpdatedAt *int `json:"updated_at,omitempty"`

	// UserId Automatically generated identifier for the Visitor.
	UserId *string `json:"user_id,omitempty"`

	// UtmCampaign The utm_campaign of the visitor.
	UtmCampaign *string `json:"utm_campaign,omitempty"`

	// UtmContent The utm_content of the visitor.
	UtmContent *string `json:"utm_content,omitempty"`

	// UtmMedium The utm_medium of the visitor.
	UtmMedium *string `json:"utm_medium,omitempty"`

	// UtmSource The utm_source of the visitor.
	UtmSource *string `json:"utm_source,omitempty"`

	// UtmTerm The utm_term of the visitor.
	UtmTerm *string `json:"utm_term,omitempty"`
}

VisitorSchema Visitors are useful for representing anonymous people that have not yet been identified. They usually represent website visitors. Visitors are not visible in Intercom platform. The Visitors resource provides methods to fetch, update, convert and delete.

type VisitorSegmentsType

type VisitorSegmentsType string

VisitorSegmentsType The type of the object

const (
	SegmentList VisitorSegmentsType = "segment.list"
)

Defines values for VisitorSegmentsType.

func (VisitorSegmentsType) Valid

func (e VisitorSegmentsType) Valid() bool

Valid indicates whether the value is a known member of the VisitorSegmentsType enum.

type VisitorSocialProfilesType

type VisitorSocialProfilesType string

VisitorSocialProfilesType The type of the object

const (
	SocialProfileList VisitorSocialProfilesType = "social_profile.list"
)

Defines values for VisitorSocialProfilesType.

func (VisitorSocialProfilesType) Valid

func (e VisitorSocialProfilesType) Valid() bool

Valid indicates whether the value is a known member of the VisitorSocialProfilesType enum.

type VisitorTagsTagsType

type VisitorTagsTagsType string

VisitorTagsTagsType The type of the object

const (
	Tag VisitorTagsTagsType = "tag"
)

Defines values for VisitorTagsTagsType.

func (VisitorTagsTagsType) Valid

func (e VisitorTagsTagsType) Valid() bool

Valid indicates whether the value is a known member of the VisitorTagsTagsType enum.

type VisitorTagsType

type VisitorTagsType string

VisitorTagsType The type of the object

const (
	TagList VisitorTagsType = "tag.list"
)

Defines values for VisitorTagsType.

func (VisitorTagsType) Valid

func (e VisitorTagsType) Valid() bool

Valid indicates whether the value is a known member of the VisitorTagsType enum.

type WhatsappMessageStatusListEventsStatus

type WhatsappMessageStatusListEventsStatus string

WhatsappMessageStatusListEventsStatus Current status of the message

const (
	WhatsappMessageStatusListEventsStatusDelivered WhatsappMessageStatusListEventsStatus = "delivered"
	WhatsappMessageStatusListEventsStatusFailed    WhatsappMessageStatusListEventsStatus = "failed"
	WhatsappMessageStatusListEventsStatusRead      WhatsappMessageStatusListEventsStatus = "read"
	WhatsappMessageStatusListEventsStatusSent      WhatsappMessageStatusListEventsStatus = "sent"
)

Defines values for WhatsappMessageStatusListEventsStatus.

func (WhatsappMessageStatusListEventsStatus) Valid

Valid indicates whether the value is a known member of the WhatsappMessageStatusListEventsStatus enum.

type WhatsappMessageStatusListEventsType

type WhatsappMessageStatusListEventsType string

WhatsappMessageStatusListEventsType Event type

const (
	BroadcastOutbound WhatsappMessageStatusListEventsType = "broadcast_outbound"
)

Defines values for WhatsappMessageStatusListEventsType.

func (WhatsappMessageStatusListEventsType) Valid

Valid indicates whether the value is a known member of the WhatsappMessageStatusListEventsType enum.

type WhatsappMessageStatusListPagesType

type WhatsappMessageStatusListPagesType string

WhatsappMessageStatusListPagesType defines model for WhatsappMessageStatusList.Pages.Type.

const (
	Pages WhatsappMessageStatusListPagesType = "pages"
)

Defines values for WhatsappMessageStatusListPagesType.

func (WhatsappMessageStatusListPagesType) Valid

Valid indicates whether the value is a known member of the WhatsappMessageStatusListPagesType enum.

type WhatsappMessageStatusListSchema

type WhatsappMessageStatusListSchema struct {
	Events []struct {
		// ConversationId ID of the conversation
		ConversationId string `json:"conversation_id"`

		// CreatedAt Creation timestamp
		CreatedAt int `json:"created_at"`

		// Id Event ID
		Id string `json:"id"`

		// Status Current status of the message
		Status WhatsappMessageStatusListEventsStatus `json:"status"`

		// TemplateName Name of the WhatsApp template used
		TemplateName *string `json:"template_name,omitempty"`

		// Type Event type
		Type WhatsappMessageStatusListEventsType `json:"type"`

		// UpdatedAt Last update timestamp
		UpdatedAt int `json:"updated_at"`

		// WhatsappMessageId WhatsApp's message identifier
		WhatsappMessageId string `json:"whatsapp_message_id"`
	} `json:"events"`
	Pages struct {
		// Next Information for fetching next page (null if no more pages)
		Next *struct {
			// StartingAfter Cursor for the next page
			StartingAfter *string `json:"starting_after,omitempty"`
		} `json:"next,omitempty"`

		// PerPage Number of results per page
		PerPage int `json:"per_page"`

		// TotalPages Total number of pages
		TotalPages int                                `json:"total_pages"`
		Type       WhatsappMessageStatusListPagesType `json:"type"`
	} `json:"pages"`

	// RulesetId The provided ruleset ID
	RulesetId string `json:"ruleset_id"`

	// TotalCount Total number of events
	TotalCount int                           `json:"total_count"`
	Type       WhatsappMessageStatusListType `json:"type"`
}

WhatsappMessageStatusListSchema defines model for whatsapp_message_status_list.

type WhatsappMessageStatusListType

type WhatsappMessageStatusListType string

WhatsappMessageStatusListType defines model for WhatsappMessageStatusList.Type.

const (
	List WhatsappMessageStatusListType = "list"
)

Defines values for WhatsappMessageStatusListType.

func (WhatsappMessageStatusListType) Valid

Valid indicates whether the value is a known member of the WhatsappMessageStatusListType enum.

type WorkflowExportSchema

type WorkflowExportSchema struct {
	// AppId The workspace identifier.
	AppId *int `json:"app_id,omitempty"`

	// ExportVersion The version of the export format.
	ExportVersion *string `json:"export_version,omitempty"`

	// ExportedAt The timestamp when the export was generated.
	ExportedAt *time.Time `json:"exported_at,omitempty"`

	// Workflow The workflow configuration.
	Workflow *struct {
		// Attributes Custom attributes defined for this workflow.
		Attributes *[]map[string]interface{} `json:"attributes,omitempty"`

		// CreatedAt When the workflow was created.
		CreatedAt *time.Time `json:"created_at,omitempty"`

		// Description The description of the workflow.
		Description *string `json:"description,omitempty"`

		// EmbeddedRules Rules embedded within the workflow steps.
		EmbeddedRules *[]map[string]interface{} `json:"embedded_rules,omitempty"`

		// Id The unique identifier for the workflow.
		Id *string `json:"id,omitempty"`

		// PreferredDevices The preferred devices for this workflow.
		PreferredDevices *[]string `json:"preferred_devices,omitempty"`

		// Snapshot The current snapshot of workflow steps and configuration.
		Snapshot *map[string]interface{} `json:"snapshot,omitempty"`

		// State The current state of the workflow.
		State *WorkflowExportWorkflowState `json:"state,omitempty"`

		// TargetChannels The channels this workflow targets.
		TargetChannels *[]string `json:"target_channels,omitempty"`

		// Targeting The targeting rules for this workflow.
		Targeting *map[string]interface{} `json:"targeting,omitempty"`

		// Title The title of the workflow.
		Title *string `json:"title,omitempty"`

		// TriggerType The type of trigger that starts this workflow.
		TriggerType *string `json:"trigger_type,omitempty"`

		// UpdatedAt When the workflow was last updated.
		UpdatedAt *time.Time `json:"updated_at,omitempty"`
	} `json:"workflow,omitempty"`
}

WorkflowExportSchema A workflow export containing the complete workflow configuration.

type WorkflowExportWorkflowState

type WorkflowExportWorkflowState string

WorkflowExportWorkflowState The current state of the workflow.

const (
	WorkflowExportWorkflowStateDraft  WorkflowExportWorkflowState = "draft"
	WorkflowExportWorkflowStateLive   WorkflowExportWorkflowState = "live"
	WorkflowExportWorkflowStatePaused WorkflowExportWorkflowState = "paused"
)

Defines values for WorkflowExportWorkflowState.

func (WorkflowExportWorkflowState) Valid

Valid indicates whether the value is a known member of the WorkflowExportWorkflowState enum.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL