client

Aug 1, 2025

Changes in this version

type AgentMessageEvent

+ Intent string

+ type AsyncDefinition struct

+ StartExecutionTool ChildTool

+ Timeout time.Duration

type Channel

+ const ChannelChat

+ type ChildTool struct

+ HTTP *HTTPDefinition

+ Webhook *ToolWebhookConfiguration

type Client

+ func (c *Client) DeleteArticle(ctx context.Context, articleID string) error

+ func (c *Client) DeleteHandOffTarget(ctx context.Context, p *HandOffTargetDeleteParams) error

+ func (c *Client) ListProcedureVersions(ctx context.Context, procedureID string) (*ListProcedureVersionsResponse, error)

+ func (c *Client) SetArticleUsageStatus(ctx context.Context, articleID string, p *SetArticleUsageStatusParams) error

+ func (c *Client) SetDefaultHandOffTarget(ctx context.Context, p *SetDefaultHandOffTargetParams) error

+ func (c *Client) SetProcedureExperimentVersion(ctx context.Context, procedureID string, version int, ...) error

+ func (c *Client) SetProcedureLiveVersion(ctx context.Context, procedureID string, version int) error

+ func (c *Client) UnsetProcedureExperimentVersion(ctx context.Context, procedureID string, version int) error

+ func (c *Client) UnsetProcedureLiveVersion(ctx context.Context, procedureID string, version int) error

+ type ExperimentalConfig struct

+ MaxDailyConversations int

+ type HandOffTargetDeleteParams struct

+ ID string

+ type ListProcedureVersionsResponse struct

+ Versions []*ProcedureVersion

+ type ProcedureVersion struct

+ Author string

+ Created time.Time

+ Description string

+ Experimental bool

+ ExperimentalConfig *ExperimentalConfig

+ Live bool

+ Name string

+ Version int

+ type SetArticleUsageStatusParams struct

+ UsageStatus UsageStatus

+ type SetDefaultHandOffTargetParams struct

+ Channel Channel

+ ID string

+ type SetProcedureExperimentVersionParams struct

+ MaxDailyConversations int

+ Replace bool

type StartConversationParams

+ Resources map[string]any

type Tool

+ Async *AsyncDefinition

+ type UsageStatus string

+ const UsageStatusOff

+ const UsageStatusOn

Jun 12, 2025

Changes in this version

+ const CacheNever

+ type Attribute struct

+ Cardinality AttributeCardinality

+ Description string

+ IsTopLevel bool

+ Name string

+ Path string

+ Type AttributeType

+ type AttributeCardinality string

+ const AttributeCardinalityMany

+ const AttributeCardinalityOne

+ type AttributeType string

+ const AttributeTypeArray

+ const AttributeTypeBoolean

+ const AttributeTypeComplex

+ const AttributeTypeDate

+ const AttributeTypeNumber

+ const AttributeTypeString

+ const AttributeTypeTimestamp

type Client

+ func (c *Client) CreateResourceSource(ctx context.Context, req *ResourceSourceCreateParams) (*ResourceSource, error)

+ func (c *Client) CreateResourceType(ctx context.Context, req *ResourceTypeCreateParams) (*ResourceType, error)

+ func (c *Client) DeleteResourceSource(ctx context.Context, id string) error

+ func (c *Client) DeleteResourceType(ctx context.Context, id string) error

+ func (c *Client) ListResourceSources(ctx context.Context) (*ResourceSourceListResponse, error)

+ func (c *Client) ListResourceTypes(ctx context.Context) (*ResourceTypeListResponse, error)

+ func (c *Client) ReadResourceSource(ctx context.Context, id string) (*ResourceSource, error)

+ func (c *Client) ReadResourceType(ctx context.Context, id string) (*ResourceType, error)

+ func (c *Client) UpdateResourceSource(ctx context.Context, id string, req *ResourceSourceUpdateParams) (*ResourceSource, error)

+ func (c *Client) UpdateResourceType(ctx context.Context, id string, req *ResourceTypeUpdateParams) (*ResourceType, error)

type ConversationEventType

+ const ConversationEventInternalNote

+ type RefreshStrategy string

+ const RefreshStrategyDynamic

+ const RefreshStrategyStatic

+ type ResourceHTTPBodyDefinition struct

+ Encoding string

+ FormFieldTemplates map[string]string

+ JSONTemplate string

+ type ResourceHTTPDefinition struct

+ Body *HTTPBodyDefinition

+ HeaderTemplates map[string]string

+ Method string

+ URLTemplate string

+ type ResourceSource struct

+ AttributeDescriptions map[string]string

+ Created time.Time

+ Description string

+ DisplayName string

+ HTTPConfig *ResourceHTTPDefinition

+ ID string

+ Schema *Schema

+ SourceType SourceType

+ Updated time.Time

+ WebhookConfig *ResourceWebhookDefinition

+ type ResourceSourceCreateParams struct

+ AttributeDescriptions map[string]string

+ Description string

+ DisplayName string

+ HTTPConfig *ResourceHTTPDefinition

+ SourceType SourceType

+ WebhookConfig *ResourceWebhookDefinition

+ type ResourceSourceListResponse struct

+ ResourceSources []*ResourceSource

+ type ResourceSourceUpdateParams struct

+ AttributeDescriptions map[string]string

+ Description *string

+ DisplayName *string

+ HTTPConfig *ResourceHTTPDefinition

+ SourceType *SourceType

+ WebhookConfig *ResourceWebhookDefinition

+ type ResourceType struct

+ Created time.Time

+ Description string

+ DisplayName string

+ ID string

+ IsEnabled bool

+ RefreshStrategy RefreshStrategy

+ Schema *Schema

+ Scope Scope

+ SourceConfig *SourceConfig

+ Updated time.Time

+ type ResourceTypeCreateParams struct

+ Description string

+ DisplayName string

+ IsEnabled bool

+ RefreshStrategy RefreshStrategy

+ Scope Scope

+ SourceConfig *SourceConfig

+ type ResourceTypeListResponse struct

+ ResourceTypes []*ResourceType

+ type ResourceTypeUpdateParams struct

+ Description *string

+ DisplayName *string

+ IsEnabled *bool

+ RefreshStrategy *RefreshStrategy

+ Scope *Scope

+ SourceConfig *SourceConfig

+ type ResourceWebhookDefinition struct

+ Name string

+ type Schema struct

+ Attributes []Attribute

+ Raw json.RawMessage

+ type Scope string

+ const ScopeGlobal

+ const ScopeLocal

+ type SourceConfig struct

+ Attributes []string

+ Cache string

+ SourceID string

+ type SourceType string

+ const SourceTypeHTTP

+ const SourceTypeInternal

+ const SourceTypeWebhook

May 8, 2025

Changes in this version

type AgentMessageEvent

+ Sequence int

+ Total int

+ type AgentMetadata struct

+ HandOffNote string

+ HandOffReason string

+ Intent string

+ IntentHandOffTarget string

+ type Argument struct

+ Name string

+ Value string

type Client

+ func (c *Client) DeleteTool(ctx context.Context, toolID string) error

+ func (c *Client) ExecuteTool(ctx context.Context, p *ExecutionParams) (*ExecuteResult, error)

type Conversation

+ AgentMetadata *AgentMetadata

+ type ExecuteResult struct

+ ID string

+ RawResult json.RawMessage

+ type ExecutionParams struct

+ Arguments []Argument

+ ID string

+ type HTTPBodyDefinition struct

+ Encoding BodyEncoding

+ FormFieldTemplates map[string]string

+ JSONTemplate string

+ type HTTPDefinition struct

+ Body *HTTPBodyDefinition

+ HeaderTemplates map[string]string

+ Method string

+ URLTemplate string

+ type ReadParams struct

+ SupportPlatform string

+ type UpdateToolParams struct

+ Description string

+ HTTP *HTTPDefinition

+ ID string

+ Mock bool

+ Parameters []ToolParameter

+ Webhook *ToolWebhookConfiguration

Feb 11, 2025

Changes in this version

type Procedure

+ Description string

Feb 7, 2025

Changes in this version

type Client

+ func (c *Client) ListProcedures(ctx context.Context, p *ProcedureListParams) (*ProcedureListResponse, error)

+ func (c *Client) ReadProcedure(ctx context.Context, procedureID string) (*Procedure, error)

+ func (c *Client) SetProcedureLimit(ctx context.Context, procedureID string, p *ProcedureLimitParams) (*Procedure, error)

+ type PaginationInfo struct

+ Next *string

+ Prev *string

+ type Procedure struct

+ Author *UserDetails

+ Created time.Time

+ ID string

+ IsDailyLimited bool

+ MaxDailyConversations int

+ Name string

+ Status ProcedureStatus

+ Updated time.Time

+ type ProcedureLimitParams struct

+ HasDailyLimit bool

+ MaxDailyConversations int

+ type ProcedureListParams struct

+ Cursor string

+ Status ProcedureStatus

+ type ProcedureListResponse struct

+ Pagination *PaginationInfo

+ Procedures []*Procedure

+ type ProcedureStatus string

+ const ProcedureStatusDraft

+ const ProcedureStatusLive

+ type UserDetails struct

+ Email string

Jan 28, 2025

Changes in this version

type Client

+ func (c *Client) ListTools(ctx context.Context) ([]*Tool, error)

+ func (c *Client) RateConversation(ctx context.Context, conversationID string, p *AssignmentParams) error

+ type ParameterOption struct

+ Text string

+ Value string

+ type RatingParams struct

+ Comments string

+ MaxValue int

+ MinValue int

+ SurveyType string

+ Timestamp *time.Time

+ Value int

+ type ToolList struct

+ Tools []*Tool

Dec 16, 2024

Changes in this version

+ type ActionHTTPBodyDefinition struct

+ Encoding BodyEncoding

+ FormFieldTemplates map[string]string

+ JSONTemplate string

+ type ActionHTTPDefinition struct

+ Body *ActionHTTPBodyDefinition

+ HeaderTemplates map[string]string

+ Method string

+ URLTemplate string

+ type BodyEncoding string

+ const BodyEncodingForm

+ const BodyEncodingJSON

type Client

+ func (c *Client) CreateTool(ctx context.Context, p *Tool) (*Tool, error)

+ func (c *Client) ReadTool(ctx context.Context, toolID string) (*Tool, error)

+ func (c *Client) UninstallTool(ctx context.Context, toolID string) error

+ func (c *Client) UpdateTool(ctx context.Context, p *Tool) (*Tool, error)

+ type ParameterType string

+ const ParameterTypeString

+ type Tool struct

+ Description string

+ HTTP *ActionHTTPDefinition

+ ID string

+ Mock bool

+ Name string

+ Parameters []ToolParameter

+ Webhook *ToolWebhookConfiguration

+ type ToolParameter struct

+ Description string

+ Name string

+ Options []string

+ Required *bool

+ Type ParameterType

+ type ToolWebhookConfiguration struct

+ Name string

Dec 12, 2024

Changes in this version

type Client

+ func (c *Client) ListHandOffTargets(ctx context.Context) (*HandOffTargets, error)

type Conversation

+ LatestHandOffTargetID string

+ type HandOffTarget struct

+ ID string

+ Name string

+ type HandOffTargets struct

+ Targets []*HandOffTarget

Dec 7, 2024

Changes in this version

type AssignmentParams

+ Reason string

type CancelParams

+ Reason string

type FinishParams

+ Reason string

Dec 3, 2024

Changes in this version

+ type ResourcePullEvent struct

+ Conversation WebhookConversation

+ ResourceType string

type Webhook

+ func (w Webhook) ResourcePull() (*ResourcePullEvent, bool)

type WebhookType

+ const WebhookTypeResourcePull

Nov 28, 2024

Changes in this version

type Conversation

+ IsActive bool

+ LatestIntent string

Oct 28, 2024

Changes in this version

type ConversationFinishedEvent

+ Intent string

+ Reason string

type ConversationHandOffEvent

+ Intent string

Sep 18, 2024

Changes in this version

+ type ActionExecuteEvent struct

+ Action string

+ Conversation WebhookConversation

+ Params json.RawMessage

+ type CancelParams struct

+ Timestamp *time.Time

type Client

+ func (c *Client) FinishConversation(ctx context.Context, conversationID string, p FinishParams) error

+ type FinishParams struct

+ Timestamp *time.Time

type Webhook

+ func (w Webhook) ActionExecute() (*ActionExecuteEvent, bool)

type WebhookType

+ const WebhookTypeActionExecute

Sep 12, 2024

Changes in this version

type Client

+ func (c *Client) UpsertHandOffTarget(ctx context.Context, p *UpsertHandOffTargetParams) error

+ type UpsertHandOffTargetParams struct

+ ID string

+ Name string

Aug 20, 2024

Changes in this version

type Client

+ func (c *Client) UpsertArticle(ctx context.Context, p *UpsertArticleParams) error

+ func (c *Client) UpsertArticleTopic(ctx context.Context, p *UpsertArticleTopicParams) error

+ type PublicationStatus string

+ const PublicationStatusDraft

+ const PublicationStatusPublished

+ type UpsertArticleParams struct

+ AuthorID string

+ Body string

+ Created time.Time

+ Data json.RawMessage

+ Description string

+ ID string

+ LastEdited time.Time

+ PublicationStatus PublicationStatus

+ Title string

+ TopicID string

+ Visibility Visibility

+ type UpsertArticleTopicParams struct

+ Created time.Time

+ Data json.RawMessage

+ Description string

+ ID string

+ LastEdited time.Time

+ Name string

+ ParentID string

+ PublicationStatus PublicationStatus

+ Visibility Visibility

+ type Visibility string

+ const VisibilityInternal

+ const VisibilityPublic

+ const VisibilityUsers

Jul 24, 2024

Changes in this version

type ConversationHandOffEvent

+ Description string

+ Reason string

+ Target string

Jun 19, 2024

Changes in this version

type Client

+ func (c *Client) AddResource(ctx context.Context, conversationID string, name string, resource any) error

Jun 7, 2024

Changes in this version

type Client

+ func (c *Client) AddConversationEvent(ctx context.Context, conversationID string, p *EventParams) error

+ type ConversationEventType string

+ const ConversationEventTypeJoin

+ const ConversationEventTypeLeave

+ const ConversationEventTypeMessageDelivered

+ const ConversationEventTypeMessageRead

+ const ConversationEventTypeTyping

+ type EventParams struct

+ IdempotencyKey string

+ MessageID *string

+ ParticipantID string

+ ParticipantType ParticipantType

+ Timestamp *time.Time

+ Type ConversationEventType

Apr 23, 2024

Changes in this version

type AssignmentParams

+ Timestamp *time.Time

+ type EndParams struct

+ Timestamp *time.Time

type StartConversationParams

+ Created *time.Time

Apr 5, 2024

Changes in this version

+ type AssignmentParams struct

+ AssigneeID string

+ AssigneeType ParticipantType

type Client

+ func (c *Client) AssignConversation(ctx context.Context, conversationID string, p *AssignmentParams) error

+ func (c *Client) EndConversation(ctx context.Context, conversationID string) error

+ func (c *Client) ReadConversation(ctx context.Context, conversationID string) (*Conversation, error)

type ParticipantType

+ const ParticipantTypeAIAgent

+ const ParticipantTypeHumanAgent

type StartConversationParams

+ AssigneeID string

+ AssigneeType ParticipantType

Mar 15, 2024

Changes in this version

type AddMessageParams

+ Attachments []*Attachment

Mar 15, 2024

Changes in this version

type AddMessageParams

+ Attachment []*Attachment

+ type Attachment struct

+ FileName string

+ Type AttachmentType

+ type AttachmentType string

+ const AttachmentTypeFile

+ const AttachmentTypeImage

type Message

+ Attachment []*Attachment

Feb 29, 2024

Changes in this version

+ var ErrInvalidWebhookSignature = fmt.Errorf("%s header is invalid", signatureHeader)

+ var ErrUnknownWebhookType = errors.New("unknown webhook type")

+ type AddMessageParams struct

+ Body string

+ Created time.Time

+ ID string

+ Metadata any

+ ParticipantID string

+ ParticipantType ParticipantType

+ type AgentMessageEvent struct

+ Body string

+ Conversation WebhookConversation

+ type Channel string

+ const ChannelEmail

+ const ChannelWeb

+ type Client struct

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

+ func (c *Client) AddMessage(ctx context.Context, conversationID string, p AddMessageParams) (*Message, error)

+ func (c *Client) CancelConversation(ctx context.Context, conversationID string) error

+ func (c *Client) ParseWebhook(req *http.Request) (*Webhook, error)

+ func (c *Client) StartConversation(ctx context.Context, p StartConversationParams) (*Conversation, error)

+ func (c *Client) VerifyWebhookRequest(req *http.Request) error

+ type Conversation struct

+ Channel Channel

+ Created time.Time

+ CustomerID string

+ ID string

+ Metadata any

+ Status Status

+ Updated time.Time

+ type ConversationFinishedEvent struct

+ Conversation WebhookConversation

+ type ConversationHandOffEvent struct

+ Conversation WebhookConversation

+ type Message struct

+ Body string

+ Created time.Time

+ ID string

+ Metadata any

+ ParticipantID string

+ ParticipantType ParticipantType

+ type Option interface

+ func WithAPIKey(key string) Option

+ func WithTransport(rt http.RoundTripper) Option

+ func WithURL(url string) Option

+ func WithWebhookLeeway(leeway time.Duration) Option

+ func WithWebhookSigningKey(key string) Option

+ type ParticipantType string

+ const ParticipantTypeAgent

+ const ParticipantTypeBot

+ const ParticipantTypeCustomer

+ type ResponseError struct

+ Details map[string]any

+ Message string

+ StatusCode int

+ func (re *ResponseError) Error() string

+ func (re *ResponseError) TraceID() string

+ type StartConversationParams struct

+ Channel Channel

+ CustomerID string

+ ID string

+ Metadata any

+ type Status string

+ const StatusActive

+ const StatusCancelled

+ const StatusFailed

+ const StatusFinished

+ const StatusObserving

+ type Webhook struct

+ Data any

+ ID string

+ SequenceNumber int

+ Timestamp time.Time

+ Type WebhookType

+ func (w Webhook) AgentMessage() (*AgentMessageEvent, bool)

+ func (w Webhook) ConversationFinished() (*ConversationFinishedEvent, bool)

+ func (w Webhook) ConversationHandOff() (*ConversationHandOffEvent, bool)

+ type WebhookConversation struct

+ CustomerID string

+ ID string

+ Metadata any

+ type WebhookType string

+ const WebhookTypeAgentMessage

+ const WebhookTypeConversationFinished

+ const WebhookTypeConversationHandOff

+ type WebhookVerifier struct

+ func (v WebhookVerifier) VerifyRequest(req *http.Request) error

+ func (v WebhookVerifier) VerifySignature(body []byte, sig string) error