intercom

package module

Go to main page

Versions in this module

v0

v0.2.2

Jul 31, 2026

v0.2.1

Jul 30, 2026

v0.2.0

Jul 29, 2026

Changes in this version

+ const DefaultWebhookMaxBodyBytes

+ var ErrPaginationStalled = errors.New("intercom: pagination stalled")

+ var ErrWebhookPayloadTooLarge = errors.New("intercom: webhook payload is too large")

+ func IsBadRequest(err error) bool

+ func IsConflict(err error) bool

+ func IsForbidden(err error) bool

+ func IsNotFound(err error) bool

+ func IsRateLimited(err error) bool

+ func IsServerError(err error) bool

+ func IsStatus(err error, statusCodes ...int) bool

+ func IsUnauthorized(err error) bool

+ func WithRequestOptions(ctx context.Context, options RequestOptions) (context.Context, error)

type ErrorResponse

+ Headers http.Header

+ type PaginationStalledError struct

+ Cursor string

+ func (e *PaginationStalledError) Error() string

+ func (e *PaginationStalledError) Unwrap() error

+ type RequestOptions struct

+ Headers http.Header

+ Query url.Values

+ Retry *RetryConfig

type ResponseInfo

+ Attempt int

+ MaxAttempts int

type WebhookEvent

+ func ParseAndVerifyWebhook(r *http.Request, clientSecret string, maxBodyBytes int64) (*WebhookEvent, error)

v0.1.4

Jul 24, 2026

Changes in this version

type Option

+ func WithResponseHook(hook ResponseHook) Option

+ type ResponseHook func(ResponseInfo)

+ type ResponseInfo struct

+ Duration time.Duration

+ Err error

+ Headers http.Header

+ RateLimitLimit string

+ RateLimitRemaining string

+ RateLimitReset string

+ RequestID string

+ RetryAfter string

+ StatusCode int

v0.1.3

Jul 11, 2026

Changes in this version

+ type ContactIterator struct

+ func (i *ContactIterator) Contact() *Contact

+ func (i *ContactIterator) Err() error

+ func (i *ContactIterator) Next() bool

type ContactsService

+ func (s *ContactsService) SearchIter(ctx context.Context, search ContactSearch) *ContactIterator

+ type ConversationIterator struct

+ func (i *ConversationIterator) Conversation() *ConversationListItem

+ func (i *ConversationIterator) Err() error

+ func (i *ConversationIterator) Next() bool

+ type ConversationListItem = gen.ConversationListItemSchema

type ConversationsService

+ func (s *ConversationsService) ListIter(ctx context.Context, options CursorPageOptions) *ConversationIterator

+ func (s *ConversationsService) SearchIter(ctx context.Context, query ConversationSearchQuery, options CursorPageOptions) *ConversationIterator

type Option

+ func WithRetry(config RetryConfig) Option

+ type RetryConfig struct

+ AllowUnsafeMethods bool

+ InitialBackoff time.Duration

+ Jitter float64

+ MaxAttempts int

+ MaxBackoff time.Duration

+ StatusCodes []int

+ type TicketIterator struct

+ func (i *TicketIterator) Err() error

+ func (i *TicketIterator) Next() bool

+ func (i *TicketIterator) Ticket() *Ticket

type TicketsService

+ func (s *TicketsService) SearchIter(ctx context.Context, query TicketSearchQuery, options CursorPageOptions) *TicketIterator

v0.1.2

Jul 3, 2026

Changes in this version

+ const FinAgentWebhookSignatureHeader

+ const WebhookSignatureHeader

+ var ErrWebhookSignatureInvalid = errors.New("intercom: webhook signature is invalid")

+ var ErrWebhookSignatureMissing = errors.New("intercom: webhook signature is missing")

+ var ErrWebhookSignatureSecretRequired = errors.New("intercom: webhook signature secret is required")

+ var ErrWebhookSignatureUnsupported = errors.New("intercom: webhook signature scheme is unsupported")

+ func FinAgentWebhookSignature(secret string, payload []byte) string

+ func VerifyFinAgentWebhookSignature(secret string, payload []byte, signature string) error

+ func VerifyWebhookSignature(clientSecret string, payload []byte, header http.Header) error

+ func WebhookSignature(clientSecret string, payload []byte) string

type CallsService

+ func (s *CallsService) ListWithOptions(ctx context.Context, options PageOptions) (*CallList, error)

type CompaniesService

+ func (s *CompaniesService) List(ctx context.Context, options CompanyListOptions) (*CompanyList, error)

+ func (s *CompaniesService) ListAllWithOptions(ctx context.Context, options CompanyListAllOptions) (*CompanyList, error)

+ func (s *CompaniesService) ScrollWithOptions(ctx context.Context, options CompanyScrollOptions) (*CompanyScroll, error)

+ type CompanyListAllOptions struct

+ Order string

+ Page int

+ PerPage int

+ type CompanyListOptions struct

+ CompanyID string

+ Name string

+ Page int

+ PerPage int

+ SegmentID string

+ TagID string

+ type CompanyScrollOptions struct

+ ScrollParam string

type ConversationsService

+ func (s *ConversationsService) ListWithOptions(ctx context.Context, options CursorPageOptions) (*ConversationList, error)

+ func (s *ConversationsService) SearchWithOptions(ctx context.Context, query ConversationSearchQuery, options CursorPageOptions) (*ConversationList, error)

+ type CursorPageOptions struct

+ PerPage int

+ StartingAfter string

+ type PageOptions struct

+ Page int

+ PerPage int

+ type SearchPagination = gen.StartingAfterPagingSchema

+ func NewSearchPagination(options CursorPageOptions) *SearchPagination

type TicketsService

+ func (s *TicketsService) SearchWithOptions(ctx context.Context, query TicketSearchQuery, options CursorPageOptions) (*TicketList, error)

+ type WebhookEvent struct

+ AppID string

+ CreatedAt int64

+ Data WebhookEventData

+ DeliveredAt int64

+ DeliveryAttempts int

+ DeliveryStatus string

+ FirstSentAt int64

+ ID string

+ Links map[string]any

+ Raw json.RawMessage

+ Self any

+ Topic string

+ Type string

+ func ParseWebhook(r io.Reader) (*WebhookEvent, error)

+ func ParseWebhookPayload(payload []byte) (*WebhookEvent, error)

+ func (e *WebhookEvent) DecodeItem(v any) error

+ type WebhookEventData struct

+ Item json.RawMessage

+ Raw json.RawMessage

+ Type string

+ func (d WebhookEventData) DecodeItem(v any) error

v0.1.1

Jul 3, 2026

v0.1.0

Jul 3, 2026

Changes in this version

+ const DefaultAccessTokenEnv

+ type AIContentService struct

+ func (s *AIContentService) CreateContentImportSource(ctx context.Context, req ContentImportSourceCreate) (*ContentImportSource, error)

+ func (s *AIContentService) CreateExternalPage(ctx context.Context, req ExternalPageCreate) (*ExternalPage, error)

+ func (s *AIContentService) DeleteContentImportSource(ctx context.Context, sourceID string) error

+ func (s *AIContentService) DeleteExternalPage(ctx context.Context, pageID string) (*ExternalPage, error)

+ func (s *AIContentService) GetContentImportSource(ctx context.Context, sourceID string) (*ContentImportSource, error)

+ func (s *AIContentService) GetExternalPage(ctx context.Context, pageID string) (*ExternalPage, error)

+ func (s *AIContentService) ListContentImportSources(ctx context.Context) (*ContentImportSourceList, error)

+ func (s *AIContentService) ListExternalPages(ctx context.Context) (*ExternalPageList, error)

+ func (s *AIContentService) UpdateContentImportSource(ctx context.Context, sourceID string, req ContentImportSourceUpdate) (*ContentImportSource, error)

+ func (s *AIContentService) UpdateExternalPage(ctx context.Context, pageID string, req ExternalPageUpdate) (*ExternalPage, error)

+ type Admin = gen.AdminWithAppSchema

+ type AdminActivityLogs = gen.ActivityLogListSchema

+ type AdminDetail = gen.AdminSchema

+ type AdminList = gen.AdminListSchema

+ type AdminSetAway = gen.SetAwayAdminJSONRequestBody

+ type AdminsService struct

+ func (s *AdminsService) List(ctx context.Context) (*AdminList, error)

+ func (s *AdminsService) ListActivityLogs(ctx context.Context, createdAtAfter string) (*AdminActivityLogs, error)

+ func (s *AdminsService) Me(ctx context.Context) (*Admin, error)

+ func (s *AdminsService) Retrieve(ctx context.Context, adminID string) (*AdminDetail, error)

+ func (s *AdminsService) SetAway(ctx context.Context, adminID string, req AdminSetAway) (*AdminDetail, error)

+ type Article = gen.ArticleSchema

+ type ArticleCreate = gen.CreateArticleRequestSchema

+ type ArticleDeleted = gen.DeletedArticleObjectSchema

+ type ArticleList = gen.ArticleListSchema

+ type ArticleSearch struct

+ HelpCenterID int

+ Highlight *bool

+ Phrase string

+ State string

+ type ArticleSearchResult = gen.ArticleSearchResponseSchema

+ type ArticleUpdate = gen.UpdateArticleRequestSchema

+ type ArticlesService struct

+ func (s *ArticlesService) Create(ctx context.Context, article ArticleCreate) (*Article, error)

+ func (s *ArticlesService) Delete(ctx context.Context, articleID string) (*ArticleDeleted, error)

+ func (s *ArticlesService) List(ctx context.Context) (*ArticleList, error)

+ func (s *ArticlesService) Retrieve(ctx context.Context, articleID string) (*Article, error)

+ func (s *ArticlesService) Search(ctx context.Context, search ArticleSearch) (*ArticleSearchResult, error)

+ func (s *ArticlesService) Update(ctx context.Context, articleID string, article ArticleUpdate) (*Article, error)

+ type AwayStatusReason = gen.AwayStatusReasonSchema

+ type AwayStatusReasonsService struct

+ func (s *AwayStatusReasonsService) List(ctx context.Context) ([]AwayStatusReason, error)

+ type Brand = gen.BrandSchema

+ type BrandList = gen.BrandListSchema

+ type BrandsService struct

+ func (s *BrandsService) List(ctx context.Context) (*BrandList, error)

+ func (s *BrandsService) Retrieve(ctx context.Context, brandID string) (*Brand, error)

+ type Call = gen.CallSchema

+ type CallList = gen.CallListSchema

+ type CallWithTranscript struct

+ AdminId *string

+ AnsweredAt *gen.Datetime

+ CallType *string

+ ContactId *string

+ ConversationId *string

+ CreatedAt *gen.Datetime

+ Direction *string

+ EndedAt *gen.Datetime

+ EndedReason *string

+ FinRecordingUrl *string

+ FinTranscriptionUrl *string

+ Id *string

+ InitiatedAt *gen.Datetime

+ Phone *string

+ RecordingUrl *string

+ State *string

+ Transcript []map[string]any

+ TranscriptStatus *string

+ TranscriptionUrl *string

+ Type *string

+ UpdatedAt *gen.Datetime

+ type CallWithTranscriptList struct

+ Data []CallWithTranscript

+ Type *string

+ type CallsService struct

+ func (s *CallsService) CollectFinVoiceCallByExternalID(ctx context.Context, externalID string) (*FinVoiceCall, error)

+ func (s *CallsService) CollectFinVoiceCallByID(ctx context.Context, id int) (*FinVoiceCall, error)

+ func (s *CallsService) CollectFinVoiceCallByPhoneNumber(ctx context.Context, phone string) (*FinVoiceCall, error)

+ func (s *CallsService) CollectFinVoiceCallsByConversationID(ctx context.Context, conversationID string) ([]FinVoiceCall, error)

+ func (s *CallsService) Get(ctx context.Context, callID string) (*Call, error)

+ func (s *CallsService) GetRecording(ctx context.Context, callID string) ([]byte, error)

+ func (s *CallsService) GetTranscript(ctx context.Context, callID string) ([]byte, error)

+ func (s *CallsService) List(ctx context.Context) (*CallList, error)

+ func (s *CallsService) ListWithTranscripts(ctx context.Context, conversationIDs []string) (*CallWithTranscriptList, error)

+ func (s *CallsService) Recording(ctx context.Context, callID string) ([]byte, error)

+ func (s *CallsService) RegisterFinVoiceCall(ctx context.Context, req RegisterFinVoiceCallRequest) (*FinVoiceCall, error)

+ func (s *CallsService) Transcript(ctx context.Context, callID string) ([]byte, error)

+ type Client struct

+ AIContent *AIContentService

+ Admins *AdminsService

+ Articles *ArticlesService

+ AwayStatusReasons *AwayStatusReasonsService

+ Brands *BrandsService

+ Calls *CallsService

+ Collections *CollectionsService

+ Companies *CompaniesService

+ Contacts *ContactsService

+ Conversations *ConversationsService

+ CustomObjects *CustomObjectsService

+ DataAttributes *DataAttributesService

+ DataEvents *DataEventsService

+ Emails *EmailsService

+ Fin *FinService

+ HelpCenters *HelpCentersService

+ InternalArticles *InternalArticlesService

+ Messages *MessagesService

+ News *NewsService

+ Notes *NotesService

+ PhoneSwitches *PhoneSwitchesService

+ Segments *SegmentsService

+ SubscriptionTypes *SubscriptionTypesService

+ Tags *TagsService

+ Teams *TeamsService

+ Tickets *TicketsService

+ Visitors *VisitorsService

+ Workspace *WorkspaceService

+ func NewClient(token string, opts ...Option) (*Client, error)

+ func NewClientFromEnv(opts ...Option) (*Client, error)

+ func NewClientFromEnvVar(name string, opts ...Option) (*Client, error)

+ func (c *Client) BaseURL() string

+ func (c *Client) Do(req *http.Request) (*http.Response, error)

+ func (c *Client) NewRequest(ctx context.Context, method, path string, body io.Reader) (*http.Request, error)

+ type Collection = gen.CollectionSchema

+ type CollectionCreate = gen.CreateCollectionRequestSchema

+ type CollectionList = gen.CollectionListSchema

+ type CollectionUpdate = gen.UpdateCollectionRequestSchema

+ type CollectionsService struct

+ func (s *CollectionsService) Create(ctx context.Context, collection CollectionCreate) (*Collection, error)

+ func (s *CollectionsService) Delete(ctx context.Context, collectionID string) error

+ func (s *CollectionsService) List(ctx context.Context) (*CollectionList, error)

+ func (s *CollectionsService) Retrieve(ctx context.Context, collectionID string) (*Collection, error)

+ func (s *CollectionsService) Update(ctx context.Context, collectionID string, collection CollectionUpdate) (*Collection, error)

+ type CompaniesService struct

+ func (s *CompaniesService) AttachContact(ctx context.Context, contactID, companyID string) (*Company, error)

+ func (s *CompaniesService) CreateOrUpdate(ctx context.Context, company CompanyCreate) (*Company, error)

+ func (s *CompaniesService) Delete(ctx context.Context, companyID string) (*CompanyDeleted, error)

+ func (s *CompaniesService) DetachContact(ctx context.Context, contactID, companyID string) (*Company, error)

+ func (s *CompaniesService) ListAll(ctx context.Context) (*CompanyList, error)

+ func (s *CompaniesService) ListContacts(ctx context.Context, companyID string) (*CompanyContacts, error)

+ func (s *CompaniesService) ListForContact(ctx context.Context, contactID string) (*ContactCompanies, error)

+ func (s *CompaniesService) ListNotes(ctx context.Context, companyID string) (*NoteList, error)

+ func (s *CompaniesService) ListSegments(ctx context.Context, companyID string) (*CompanySegmentsAttached, error)

+ func (s *CompaniesService) Retrieve(ctx context.Context, companyID string) (*Company, error)

+ func (s *CompaniesService) RetrieveByID(ctx context.Context, companyID string) (*CompanyList, error)

+ func (s *CompaniesService) Scroll(ctx context.Context) (*CompanyScroll, error)

+ func (s *CompaniesService) Update(ctx context.Context, companyID string, update CompanyUpdate) (*Company, error)

+ type Company = gen.CompanySchema

+ type CompanyContacts = gen.CompanyAttachedContactsSchema

+ type CompanyCreate = gen.CreateOrUpdateCompanyRequestSchema

+ type CompanyDeleted = gen.DeletedCompanyObjectSchema

+ type CompanyList = gen.CompanyListSchema

+ type CompanyScroll = gen.CompanyScrollSchema

+ type CompanySegmentsAttached = gen.CompanyAttachedSegmentsSchema

+ type CompanyUpdate = gen.UpdateCompanyRequestSchema

+ type Contact = gen.ContactSchema

+ type ContactArchived = gen.ContactArchived

+ type ContactBlocked = gen.ContactBlockedSchema

+ type ContactCompanies = gen.ContactAttachedCompaniesSchema

+ type ContactCreate = gen.CreateContactRequestSchema

+ type ContactDeleted = gen.ContactDeleted

+ type ContactList = gen.ContactListSchema

+ type ContactSearch struct

+ Field string

+ Operator ContactSearchOperator

+ PerPage int

+ StartingAfter string

+ Value any

+ type ContactSearchOperator string

+ const ContactSearchContains

+ const ContactSearchEquals

+ const ContactSearchGreaterThan

+ const ContactSearchLessThan

+ const ContactSearchNotEquals

+ type ContactSegments = gen.ContactSegmentsSchema

+ type ContactUnarchived = gen.ContactUnarchived

+ type ContactUpdate = gen.UpdateContactRequestSchema

+ type ContactsService struct

+ func (s *ContactsService) Archive(ctx context.Context, contactID string) (*ContactArchived, error)

+ func (s *ContactsService) AttachSubscription(ctx context.Context, contactID, subscriptionID, consentType string) (*SubscriptionType, error)

+ func (s *ContactsService) AttachTag(ctx context.Context, contactID, tagID string) (*Tag, error)

+ func (s *ContactsService) Block(ctx context.Context, contactID string) (*ContactBlocked, error)

+ func (s *ContactsService) Create(ctx context.Context, contact ContactCreate) (*Contact, error)

+ func (s *ContactsService) CreateNote(ctx context.Context, contactID string, body string, adminID string) (*Note, error)

+ func (s *ContactsService) Delete(ctx context.Context, contactID string) (*ContactDeleted, error)

+ func (s *ContactsService) DetachSubscription(ctx context.Context, contactID, subscriptionID string) (*SubscriptionType, error)

+ func (s *ContactsService) DetachTag(ctx context.Context, contactID, tagID string) (*Tag, error)

+ func (s *ContactsService) Get(ctx context.Context, contactID string) (*Contact, error)

+ func (s *ContactsService) GetByExternalID(ctx context.Context, externalID string) (*Contact, error)

+ func (s *ContactsService) List(ctx context.Context) (*ContactList, error)

+ func (s *ContactsService) ListNotes(ctx context.Context, contactID string) (*NoteList, error)

+ func (s *ContactsService) ListSegments(ctx context.Context, contactID string) (*ContactSegments, error)

+ func (s *ContactsService) ListSubscriptions(ctx context.Context, contactID string) (*SubscriptionTypeList, error)

+ func (s *ContactsService) ListTags(ctx context.Context, contactID string) (*TagList, error)

+ func (s *ContactsService) Merge(ctx context.Context, from, into string) (*Contact, error)

+ func (s *ContactsService) Search(ctx context.Context, search ContactSearch) (*ContactList, error)

+ func (s *ContactsService) Unarchive(ctx context.Context, contactID string) (*ContactUnarchived, error)

+ func (s *ContactsService) Update(ctx context.Context, contactID string, contact ContactUpdate) (*Contact, error)

+ type ContentImportSource = gen.ContentImportSourceSchema

+ type ContentImportSourceCreate = gen.CreateContentImportSourceRequestSchema

+ type ContentImportSourceList = gen.ContentImportSourcesListSchema

+ type ContentImportSourceUpdate = gen.UpdateContentImportSourceRequestSchema

+ type Conversation = gen.ConversationSchema

+ type ConversationAdminReply = gen.AdminReplyConversationRequestSchema

+ type ConversationAssign = gen.AssignConversationRequestSchema

+ type ConversationAttachContact = gen.AttachContactToConversationRequestSchema

+ type ConversationClose = gen.CloseConversationRequestSchema

+ type ConversationContactReply = gen.ContactReplyBaseRequestSchema

+ type ConversationCreate = gen.CreateConversationRequestSchema

+ type ConversationDeleted = gen.ConversationDeletedSchema

+ type ConversationDetachContact = gen.DetachContactFromConversationRequest

+ type ConversationHandlingEvent = gen.HandlingEventSchema

+ type ConversationHandlingEventList = gen.HandlingEventListSchema

+ type ConversationList = gen.ConversationListSchema

+ type ConversationMessage = gen.MessageSchema

+ type ConversationOpen = gen.OpenConversationRequestSchema

+ type ConversationRedactPart = gen.RedactConversationRequest0

+ type ConversationRedactSource = gen.RedactConversationRequest1

+ type ConversationSearchQuery = gen.SearchRequestSchema

+ type ConversationSnooze = gen.SnoozeConversationRequestSchema

+ type ConversationToTicket = gen.ConvertConversationToTicketRequestSchema

+ type ConversationUpdate = gen.UpdateConversationRequestSchema

+ type ConversationsService struct

+ func (s *ConversationsService) Assign(ctx context.Context, conversationID string, assign ConversationAssign) (*Conversation, error)

+ func (s *ConversationsService) AttachContact(ctx context.Context, conversationID string, req ConversationAttachContact) (*Conversation, error)

+ func (s *ConversationsService) AttachTag(ctx context.Context, conversationID, tagID, adminID string) (*Tag, error)

+ func (s *ConversationsService) Close(ctx context.Context, conversationID string, req ConversationClose) (*Conversation, error)

+ func (s *ConversationsService) ConvertToTicket(ctx context.Context, conversationID string, req ConversationToTicket) (*Ticket, error)

+ func (s *ConversationsService) Create(ctx context.Context, conversation ConversationCreate) (*ConversationMessage, error)

+ func (s *ConversationsService) Delete(ctx context.Context, conversationID string) (*ConversationDeleted, error)

+ func (s *ConversationsService) DetachContact(ctx context.Context, conversationID, contactID string, ...) (*Conversation, error)

+ func (s *ConversationsService) DetachTag(ctx context.Context, conversationID, tagID, adminID string) (*Tag, error)

+ func (s *ConversationsService) Get(ctx context.Context, conversationID string) (*Conversation, error)

+ func (s *ConversationsService) List(ctx context.Context) (*ConversationList, error)

+ func (s *ConversationsService) ListHandlingEvents(ctx context.Context, conversationID string) (*ConversationHandlingEventList, error)

+ func (s *ConversationsService) Open(ctx context.Context, conversationID string, req ConversationOpen) (*Conversation, error)

+ func (s *ConversationsService) RedactPart(ctx context.Context, req ConversationRedactPart) (*Conversation, error)

+ func (s *ConversationsService) RedactSource(ctx context.Context, req ConversationRedactSource) (*Conversation, error)

+ func (s *ConversationsService) Reply(ctx context.Context, conversationID string, reply ConversationAdminReply) (*Conversation, error)

+ func (s *ConversationsService) ReplyAsContact(ctx context.Context, conversationID string, reply ConversationContactReply) (*Conversation, error)

+ func (s *ConversationsService) Search(ctx context.Context, query ConversationSearchQuery) (*ConversationList, error)

+ func (s *ConversationsService) Snooze(ctx context.Context, conversationID string, req ConversationSnooze) (*Conversation, error)

+ func (s *ConversationsService) Update(ctx context.Context, conversationID string, conversation ConversationUpdate) (*Conversation, error)

+ type CustomObjectInstance = gen.CustomObjectInstanceSchema

+ type CustomObjectInstanceCreateOrUpdate = gen.CreateOrUpdateCustomObjectInstanceRequestSchema

+ type CustomObjectInstanceDeleted = gen.CustomObjectInstanceDeletedSchema

+ type CustomObjectsService struct

+ func (s *CustomObjectsService) CreateOrUpdate(ctx context.Context, customObjectType string, ...) (*CustomObjectInstance, error)

+ func (s *CustomObjectsService) Delete(ctx context.Context, customObjectType, instanceID string) (*CustomObjectInstanceDeleted, error)

+ func (s *CustomObjectsService) DeleteByExternalID(ctx context.Context, customObjectType, externalID string) (*CustomObjectInstanceDeleted, error)

+ func (s *CustomObjectsService) Get(ctx context.Context, customObjectType, instanceID string) (*CustomObjectInstance, error)

+ func (s *CustomObjectsService) GetByExternalID(ctx context.Context, customObjectType, externalID string) (*CustomObjectInstance, error)

+ type DataAttribute = gen.DataAttributeSchema

+ type DataAttributeCreate struct

+ DataType DataAttributeDataType

+ Description *string

+ MessengerWritable *bool

+ Model DataAttributeModel

+ Name string

+ Options []string

+ type DataAttributeDataType string

+ const DataAttributeDataTypeBoolean

+ const DataAttributeDataTypeDate

+ const DataAttributeDataTypeFloat

+ const DataAttributeDataTypeInteger

+ const DataAttributeDataTypeList

+ const DataAttributeDataTypeString

+ type DataAttributeList = gen.DataAttributeListSchema

+ type DataAttributeListParams struct

+ IncludeArchived bool

+ Model DataAttributeModel

+ type DataAttributeModel string

+ const DataAttributeModelCompany

+ const DataAttributeModelContact

+ const DataAttributeModelConversation

+ type DataAttributeUpdate struct

+ Archived *bool

+ Description *string

+ MessengerWritable *bool

+ Options []string

+ type DataAttributesService struct

+ func (s *DataAttributesService) Create(ctx context.Context, attribute DataAttributeCreate) (*DataAttribute, error)

+ func (s *DataAttributesService) List(ctx context.Context, params DataAttributeListParams) (*DataAttributeList, error)

+ func (s *DataAttributesService) Update(ctx context.Context, dataAttributeID string, attribute DataAttributeUpdate) (*DataAttribute, error)

+ type DataEvent = gen.DataEventSchema

+ type DataEventCreate struct

+ CreatedAt *int

+ Email *string

+ EventName string

+ ID *string

+ Metadata map[string]any

+ UserID *string

+ type DataEventListFilter struct

+ Email string

+ IntercomUserID string

+ Summary bool

+ UserID string

+ type DataEventSummariesCreate struct

+ EventSummaries []DataEventSummaryCreate

+ UserID string

+ type DataEventSummary = gen.DataEventSummarySchema

+ type DataEventSummaryCreate struct

+ Count int

+ EventName string

+ First *int

+ Last *int

+ type DataEventSummaryItem = gen.DataEventSummaryItemSchema

+ type DataEventsService struct

+ func (s *DataEventsService) Create(ctx context.Context, event DataEventCreate) error

+ func (s *DataEventsService) CreateSummaries(ctx context.Context, summaries DataEventSummariesCreate) error

+ func (s *DataEventsService) List(ctx context.Context, filter DataEventListFilter) (*DataEventSummary, error)

+ type DataExport = gen.DataExportSchema

+ type DataExportCreate = gen.CreateDataExportsRequestSchema

+ type EmailList = gen.EmailListSchema

+ type EmailSetting = gen.EmailSettingSchema

+ type EmailsService struct

+ func (s *EmailsService) List(ctx context.Context) (*EmailList, error)

+ func (s *EmailsService) Retrieve(ctx context.Context, emailID string) (*EmailSetting, error)

+ type Error struct

+ Code string

+ Message string

+ type ErrorResponse struct

+ Body string

+ Errors []Error

+ RequestID string

+ StatusCode int

+ Type string

+ func (e *ErrorResponse) Error() string

+ type ExternalPage = gen.ExternalPageSchema

+ type ExternalPageCreate = gen.CreateExternalPageRequestSchema

+ type ExternalPageList = gen.ExternalPagesListSchema

+ type ExternalPageUpdate = gen.UpdateExternalPageRequestSchema

+ type FinAttachment = gen.FinAgentAttachmentSchema

+ type FinAttachmentType = gen.FinAgentAttachmentType

+ const FinAttachmentTypeFile

+ const FinAttachmentTypeURL

+ type FinConversationAttributeErrors struct

+ Attributes *map[string]string

+ type FinConversationErrors struct

+ Conversation *FinConversationAttributeErrors

+ User *FinConversationAttributeErrors

+ type FinConversationMetadata = gen.FinAgentConversationMetadataSchema

+ type FinConversationResponse struct

+ ConversationID *string

+ CreatedAtMs *string

+ Errors *FinConversationErrors

+ SSESubscriptionURL *string

+ Status *string

+ UserID *string

+ type FinMessage = gen.FinAgentMessageSchema

+ type FinMessageAuthor = gen.FinAgentMessageAuthor

+ const FinMessageAuthorAgent

+ const FinMessageAuthorFin

+ const FinMessageAuthorUser

+ type FinReply struct

+ Attachments *[]FinAttachment

+ ConversationId string

+ Message FinMessage

+ User FinUser

+ type FinService struct

+ func (s *FinService) GetVoiceCallByExternalID(ctx context.Context, externalID string) (*FinVoiceCall, error)

+ func (s *FinService) GetVoiceCallByID(ctx context.Context, id string) (*FinVoiceCall, error)

+ func (s *FinService) GetVoiceCallByPhoneNumber(ctx context.Context, phoneNumber string) (*FinVoiceCall, error)

+ func (s *FinService) ListVoiceCallsByConversation(ctx context.Context, conversationID string) ([]FinVoiceCall, error)

+ func (s *FinService) RegisterVoiceCall(ctx context.Context, req RegisterFinVoiceCallRequest) (*FinVoiceCall, error)

+ func (s *FinService) Reply(ctx context.Context, req FinReply) (*FinConversationResponse, error)

+ func (s *FinService) StartConversation(ctx context.Context, req FinStartConversation) (*FinConversationResponse, error)

+ type FinStartConversation struct

+ Attachments *[]FinAttachment

+ ConversationId string

+ ConversationMetadata *FinConversationMetadata

+ Message FinMessage

+ User FinUser

+ type FinUser = gen.FinAgentUserSchema

+ type FinVoiceCall = gen.AiCallResponseSchema

+ type FinVoiceCallSource = gen.RegisterFinVoiceCallRequestSource

+ const FinVoiceCallSourceAWSConnect

+ const FinVoiceCallSourceFive9

+ const FinVoiceCallSourceZoomPhone

+ type HelpCenter = gen.HelpCenterSchema

+ type HelpCenterList = gen.HelpCenterListSchema

+ type HelpCentersService struct

+ func (s *HelpCentersService) List(ctx context.Context) (*HelpCenterList, error)

+ func (s *HelpCentersService) Retrieve(ctx context.Context, helpCenterID string) (*HelpCenter, error)

+ type IPAllowlist = gen.IpAllowlistSchema

+ type InternalArticle = gen.InternalArticleSchema

+ type InternalArticleCreate = gen.CreateInternalArticleRequestSchema

+ type InternalArticleDeleted = gen.DeletedInternalArticleObjectSchema

+ type InternalArticleList = gen.InternalArticleListSchema

+ type InternalArticleSearchResult = gen.InternalArticleSearchResponseSchema

+ type InternalArticleUpdate = gen.UpdateInternalArticleRequestSchema

+ type InternalArticlesService struct

+ func (s *InternalArticlesService) Create(ctx context.Context, article InternalArticleCreate) (*InternalArticle, error)

+ func (s *InternalArticlesService) Delete(ctx context.Context, articleID string) (*InternalArticleDeleted, error)

+ func (s *InternalArticlesService) List(ctx context.Context) (*InternalArticleList, error)

+ func (s *InternalArticlesService) Retrieve(ctx context.Context, articleID string) (*InternalArticle, error)

+ func (s *InternalArticlesService) Search(ctx context.Context, folderID *string) (*InternalArticleSearchResult, error)

+ func (s *InternalArticlesService) Update(ctx context.Context, articleID string, article InternalArticleUpdate) (*InternalArticle, error)

+ type Job = gen.JobsSchema

+ type Message = gen.MessageSchema

+ type MessageCreate = gen.CreateMessageJSONRequestBody

+ type MessagesService struct

+ func (s *MessagesService) Create(ctx context.Context, message MessageCreate) (*Message, error)

+ type NewsCursorPages = gen.CursorPagesSchema

+ type NewsItem = gen.NewsItemSchema

+ type NewsItemCreate = gen.NewsItemRequestSchema

+ type NewsItemList struct

+ Data *[]NewsItem

+ Pages *NewsCursorPages

+ TotalCount *int

+ Type *NewsListType

+ type NewsItemUpdate = gen.NewsItemRequestSchema

+ type NewsListType = gen.PaginatedResponseType

+ type NewsService struct

+ func (s *NewsService) CreateItem(ctx context.Context, item NewsItemCreate) (*NewsItem, error)

+ func (s *NewsService) DeleteItem(ctx context.Context, newsItemID string) error

+ func (s *NewsService) ListFeedItems(ctx context.Context, newsfeedID string) (*NewsItemList, error)

+ func (s *NewsService) ListFeeds(ctx context.Context) (*NewsfeedList, error)

+ func (s *NewsService) ListItems(ctx context.Context) (*NewsItemList, error)

+ func (s *NewsService) RetrieveFeed(ctx context.Context, newsfeedID string) (*Newsfeed, error)

+ func (s *NewsService) RetrieveItem(ctx context.Context, newsItemID string) (*NewsItem, error)

+ func (s *NewsService) UpdateItem(ctx context.Context, newsItemID string, item NewsItemUpdate) (*NewsItem, error)

+ type Newsfeed = gen.NewsfeedSchema

+ type NewsfeedList struct

+ Data *[]Newsfeed

+ Pages *NewsCursorPages

+ TotalCount *int

+ Type *NewsListType

+ type Note = gen.NoteSchema

+ type NoteList = gen.NoteListSchema

+ type NotesService struct

+ func (s *NotesService) Retrieve(ctx context.Context, noteID string) (*Note, error)

+ type Option func(*Client) error

+ func WithAPIVersion(version string) Option

+ func WithBaseURL(baseURL string) Option

+ func WithHTTPClient(httpClient *http.Client) Option

+ func WithRegion(region Region) Option

+ func WithUserAgent(userAgent string) Option

+ type PageInfo struct

+ Next *StartingAfterPage

+ Page int

+ PerPage int

+ TotalPages int

+ Type string

+ func (p PageInfo) HasNext() bool

+ type PhoneSwitch = gen.PhoneSwitchSchema

+ type PhoneSwitchCreate = gen.CreatePhoneSwitchRequestSchema

+ type PhoneSwitchesService struct

+ func (s *PhoneSwitchesService) Create(ctx context.Context, req PhoneSwitchCreate) (*PhoneSwitch, error)

+ type Region string

+ const AU

+ const EU

+ const US

+ type RegisterFinVoiceCallRequest = gen.RegisterFinVoiceCallRequestSchema

+ type ReportingDataset struct

+ Attributes *[]ReportingDatasetAttribute

+ DefaultTimeAttributeID *string

+ Description *string

+ ID *string

+ Name *string

+ type ReportingDatasetAttribute struct

+ ID *string

+ Name *string

+ type ReportingDatasetList struct

+ Data *[]ReportingDataset

+ Type *string

+ type ReportingExportCreate = gen.PostExportReportingDataEnqueueJSONBody

+ type ReportingExportJob struct

+ DownloadExpiresAt *string

+ DownloadURL *string

+ JobIdentifier *string

+ Status *string

+ type Segment = gen.SegmentSchema

+ type SegmentList = gen.SegmentListSchema

+ type SegmentsService struct

+ func (s *SegmentsService) List(ctx context.Context) (*SegmentList, error)

+ func (s *SegmentsService) Retrieve(ctx context.Context, segmentID string) (*Segment, error)

+ type StartingAfterPage struct

+ PerPage int

+ StartingAfter string

+ type SubscriptionType = gen.SubscriptionTypeSchema

+ type SubscriptionTypeList = gen.SubscriptionTypeListSchema

+ type SubscriptionTypesService struct

+ func (s *SubscriptionTypesService) List(ctx context.Context) (*SubscriptionTypeList, error)

+ type Tag = gen.TagSchema

+ type TagCompanyReference struct

+ CompanyID *string

+ ID *string

+ type TagCompanyRequest struct

+ Companies []TagCompanyReference

+ Name string

+ type TagCompanyUntagReference struct

+ CompanyID *string

+ ID *string

+ Untag bool

+ type TagCompanyUntagRequest struct

+ Companies []TagCompanyUntagReference

+ Name string

+ func (r TagCompanyUntagRequest) MarshalJSON() ([]byte, error)

+ type TagCreateOrUpdateRequest struct

+ ID *string

+ Name string

+ type TagCreateRequest interface

+ type TagDetail = gen.TagBasicSchema

+ type TagList = gen.TagListSchema

+ type TagUserReference struct

+ ID string

+ type TagUsersRequest struct

+ Name string

+ Users []TagUserReference

+ type TagsService struct

+ func (s *TagsService) Create(ctx context.Context, req TagCreateRequest) (*TagDetail, error)

+ func (s *TagsService) Delete(ctx context.Context, tagID string) error

+ func (s *TagsService) List(ctx context.Context) (*TagList, error)

+ func (s *TagsService) Retrieve(ctx context.Context, tagID string) (*TagDetail, error)

+ type Team = gen.TeamSchema

+ type TeamList = gen.TeamListSchema

+ type TeamsService struct

+ func (s *TeamsService) List(ctx context.Context) (*TeamList, error)

+ func (s *TeamsService) Retrieve(ctx context.Context, teamID string) (*Team, error)

+ type Ticket = gen.TicketSchema

+ type TicketAdminReply struct

+ AdminID string

+ AttachmentURLs *[]string

+ Body *string

+ CreatedAt *int

+ CrossPost *bool

+ MessageType TicketReplyMessageType

+ ReplyOptions *[]TicketReplyOption

+ type TicketContact = gen.CreateTicketRequest_Contacts_Item

+ func NewTicketContactByEmail(email string) TicketContact

+ func NewTicketContactByExternalID(externalID string) TicketContact

+ func NewTicketContactByID(id string) TicketContact

+ type TicketContactEmail = gen.CreateTicketRequestContacts2

+ type TicketContactExternalID = gen.CreateTicketRequestContacts1

+ type TicketContactID = gen.CreateTicketRequestContacts0

+ type TicketContactReply struct

+ AttachmentURLs *[]string

+ Body string

+ Contact TicketReplyContact

+ CreatedAt *int

+ ReplyOptions *[]TicketReplyOption

+ type TicketCreate = gen.CreateTicketJSONBody

+ type TicketEnqueued = gen.JobsSchema

+ type TicketList = gen.TicketListSchema

+ type TicketReply = gen.TicketReplySchema

+ type TicketReplyContact struct

+ Email *string

+ IntercomUserID *string

+ UserID *string

+ func NewTicketReplyContactByEmail(email string) TicketReplyContact

+ func NewTicketReplyContactByIntercomUserID(intercomUserID string) TicketReplyContact

+ func NewTicketReplyContactByUserID(userID string) TicketReplyContact

+ type TicketReplyMessageType string

+ const TicketReplyMessageTypeComment

+ const TicketReplyMessageTypeNote

+ const TicketReplyMessageTypeQuickReply

+ type TicketReplyOption struct

+ Text string

+ UUID string

+ type TicketReplyRequest interface

+ type TicketSearchQuery = gen.SearchRequestSchema

+ type TicketState = gen.TicketStateDetailedSchema

+ type TicketStateList = gen.TicketStateListSchema

+ type TicketTagAttachRequest = gen.AttachTagToTicketJSONBody

+ type TicketTagDetachRequest = gen.DetachTagFromTicketJSONBody

+ type TicketType = gen.TicketTypeSchema

+ type TicketTypeAttribute = gen.TicketTypeAttributeSchema

+ type TicketTypeAttributeCreate = gen.CreateTicketTypeAttributeRequestSchema

+ type TicketTypeAttributeUpdate = gen.UpdateTicketTypeAttributeRequestSchema

+ type TicketTypeCreate = gen.CreateTicketTypeRequestSchema

+ type TicketTypeList = gen.TicketTypeListSchema

+ type TicketTypeUpdate = gen.UpdateTicketTypeRequestSchema

+ type TicketUpdate = gen.UpdateTicketJSONBody

+ type TicketsService struct

+ func (s *TicketsService) AttachTag(ctx context.Context, ticketID string, req TicketTagAttachRequest) (*Tag, error)

+ func (s *TicketsService) Create(ctx context.Context, ticket TicketCreate) (*Ticket, error)

+ func (s *TicketsService) CreateType(ctx context.Context, ticketType TicketTypeCreate) (*TicketType, error)

+ func (s *TicketsService) CreateTypeAttribute(ctx context.Context, ticketTypeID string, attribute TicketTypeAttributeCreate) (*TicketTypeAttribute, error)

+ func (s *TicketsService) Delete(ctx context.Context, ticketID string) error

+ func (s *TicketsService) DetachTag(ctx context.Context, ticketID, tagID string, req TicketTagDetachRequest) (*Tag, error)

+ func (s *TicketsService) EnqueueCreate(ctx context.Context, ticket TicketCreate) (*TicketEnqueued, error)

+ func (s *TicketsService) Get(ctx context.Context, ticketID string) (*Ticket, error)

+ func (s *TicketsService) GetType(ctx context.Context, ticketTypeID string) (*TicketType, error)

+ func (s *TicketsService) ListStates(ctx context.Context) (*TicketStateList, error)

+ func (s *TicketsService) ListTypes(ctx context.Context) (*TicketTypeList, error)

+ func (s *TicketsService) Reply(ctx context.Context, ticketID string, req TicketReplyRequest, ...) (*TicketReply, error)

+ func (s *TicketsService) Search(ctx context.Context, query TicketSearchQuery) (*TicketList, error)

+ func (s *TicketsService) Update(ctx context.Context, ticketID string, ticket TicketUpdate) (*Ticket, error)

+ func (s *TicketsService) UpdateType(ctx context.Context, ticketTypeID string, ticketType TicketTypeUpdate) (*TicketType, error)

+ func (s *TicketsService) UpdateTypeAttribute(ctx context.Context, ticketTypeID, attributeID string, ...) (*TicketTypeAttribute, error)

+ type Visitor = gen.VisitorSchema

+ type VisitorConvert struct

+ Type string

+ User VisitorConvertContact

+ Visitor VisitorConvertSource

+ type VisitorConvertContact struct

+ Email *string

+ ID *string

+ UserID *string

+ type VisitorConvertSource struct

+ Email *string

+ ID *string

+ UserID *string

+ type VisitorConverted = gen.ContactSchema

+ type VisitorUpdate struct

+ CustomAttributes *map[string]string

+ ID *string

+ Name *string

+ UserID *string

+ type VisitorsService struct

+ func (s *VisitorsService) Convert(ctx context.Context, req VisitorConvert) (*VisitorConverted, error)

+ func (s *VisitorsService) GetByUserID(ctx context.Context, userID string) (*Visitor, error)

+ func (s *VisitorsService) Update(ctx context.Context, update VisitorUpdate) (*Visitor, error)

+ type WorkflowExport = gen.WorkflowExportSchema

+ type WorkspaceService struct

+ func (s *WorkspaceService) CancelDataExport(ctx context.Context, jobIdentifier string) (*DataExport, error)

+ func (s *WorkspaceService) CreateDataExport(ctx context.Context, req DataExportCreate) (*DataExport, error)

+ func (s *WorkspaceService) CreateReportingExport(ctx context.Context, req ReportingExportCreate) (*ReportingExportJob, error)

+ func (s *WorkspaceService) DownloadDataExport(ctx context.Context, jobIdentifier string) ([]byte, error)

+ func (s *WorkspaceService) DownloadReportingExport(ctx context.Context, jobIdentifier, appID string) ([]byte, error)

+ func (s *WorkspaceService) ExportWorkflow(ctx context.Context, workflowID string) (*WorkflowExport, error)

+ func (s *WorkspaceService) GetDataExport(ctx context.Context, jobIdentifier string) (*DataExport, error)

+ func (s *WorkspaceService) GetIPAllowlist(ctx context.Context) (*IPAllowlist, error)

+ func (s *WorkspaceService) GetReportingExportJob(ctx context.Context, jobIdentifier, appID, clientID string) (*ReportingExportJob, error)

+ func (s *WorkspaceService) JobStatus(ctx context.Context, jobID string) (*Job, error)

+ func (s *WorkspaceService) ListReportingDatasets(ctx context.Context) (*ReportingDatasetList, error)

+ func (s *WorkspaceService) UpdateIPAllowlist(ctx context.Context, allowlist IPAllowlist) (*IPAllowlist, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL