webhook

Documentation

Overview

This is an autogenerated file. DO NOT MODIFY

This is an autogenerated file. DO NOT MODIFY

This is an autogenerated file. DO NOT MODIFY

This is an autogenerated file. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Delete() error
  • func (c Client) DeleteWithContext(context context.Context) error
  • func (c Client) Fetch() (*FetchConversationWebhookResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchConversationWebhookResponse, error)
  • func (c Client) Update(input *UpdateConversationWebhookInput) (*UpdateConversationWebhookResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateConversationWebhookInput) (*UpdateConversationWebhookResponse, error)
• type ClientProperties
• type FetchConversationWebhookResponse
• type FetchConversationWebhookResponseConfiguration
• type UpdateConversationWebhookInput
• type UpdateConversationWebhookResponse
• type UpdateConversationWebhookResponseConfiguration

Types

type Client

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

Client for managing a specific webhook resource See https://www.twilio.com/docs/conversations/api/conversation-scoped-webhook-resource for more details

func New

func New(client *client.Client, properties ClientProperties) *Client

New creates a new instance of the webhook client

func (Client) Delete

func (c Client) Delete() error

Delete removes a webhook resource from the account See https://www.twilio.com/docs/conversations/api/conversation-scoped-webhook-resource#delete-a-conversationscopedwebhook-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) DeleteWithContext

func (c Client) DeleteWithContext(context context.Context) error

DeleteWithContext removes a webhook resource from the account See https://www.twilio.com/docs/conversations/api/conversation-scoped-webhook-resource#delete-a-conversationscopedwebhook-resource for more details

func (Client) Fetch

func (c Client) Fetch() (*FetchConversationWebhookResponse, error)

Fetch retrieves an webhook resource See https://www.twilio.com/docs/conversations/api/conversation-scoped-webhook-resource#fetch-a-conversationscopedwebhook-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) FetchWithContext

func (c Client) FetchWithContext(context context.Context) (*FetchConversationWebhookResponse, error)

FetchWithContext retrieves an webhook resource See https://www.twilio.com/docs/conversations/api/conversation-scoped-webhook-resource#fetch-a-conversationscopedwebhook-resource for more details

func (Client) Update

func (c Client) Update(input *UpdateConversationWebhookInput) (*UpdateConversationWebhookResponse, error)

Update modifies a webhook resource See https://www.twilio.com/docs/conversations/api/conversation-scoped-webhook-resource#update-a-conversationscopedwebhook-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) UpdateWithContext

func (c Client) UpdateWithContext(context context.Context, input *UpdateConversationWebhookInput) (*UpdateConversationWebhookResponse, error)

UpdateWithContext modifies a webhook resource See https://www.twilio.com/docs/conversations/api/conversation-scoped-webhook-resource#update-a-conversationscopedwebhook-resource for more details

type ClientProperties

type ClientProperties struct {
	ConversationSid string
	Sid             string
}

ClientProperties are the properties required to manage the webhook resources

type FetchConversationWebhookResponse

type FetchConversationWebhookResponse struct {
	AccountSid      string                                        `json:"account_sid"`
	Configuration   FetchConversationWebhookResponseConfiguration `json:"configuration"`
	ConversationSid string                                        `json:"conversation_sid"`
	DateCreated     time.Time                                     `json:"date_created"`
	DateUpdated     *time.Time                                    `json:"date_updated,omitempty"`
	Sid             string                                        `json:"sid"`
	Target          string                                        `json:"target"`
	URL             string                                        `json:"url"`
}

FetchConversationWebhookResponse defines the response fields for the retrieved webhook

type FetchConversationWebhookResponseConfiguration

type FetchConversationWebhookResponseConfiguration struct {
	Filters     *[]string `json:"filters,omitempty"`
	FlowSid     *string   `json:"flow_sid,omitempty"`
	Method      *string   `json:"method,omitempty"`
	ReplayAfter *int      `json:"replay_after,omitempty"`
	Triggers    *[]string `json:"triggers,omitempty"`
	URL         *string   `json:"url,omitempty"`
}

type UpdateConversationWebhookInput

type UpdateConversationWebhookInput struct {
	ConfigurationFilters  *[]string `form:"Configuration.Filters,omitempty"`
	ConfigurationFlowSid  *string   `form:"Configuration.FlowSid,omitempty"`
	ConfigurationMethod   *string   `form:"Configuration.Method,omitempty"`
	ConfigurationTriggers *[]string `form:"Configuration.Triggers,omitempty"`
	ConfigurationURL      *string   `form:"Configuration.Url,omitempty"`
}

UpdateConversationWebhookInput defines input fields for updating an webhook resource

type UpdateConversationWebhookResponse

type UpdateConversationWebhookResponse struct {
	AccountSid      string                                         `json:"account_sid"`
	Configuration   UpdateConversationWebhookResponseConfiguration `json:"configuration"`
	ConversationSid string                                         `json:"conversation_sid"`
	DateCreated     time.Time                                      `json:"date_created"`
	DateUpdated     *time.Time                                     `json:"date_updated,omitempty"`
	Sid             string                                         `json:"sid"`
	Target          string                                         `json:"target"`
	URL             string                                         `json:"url"`
}

UpdateConversationWebhookResponse defines the response fields for the updated webhook

type UpdateConversationWebhookResponseConfiguration

type UpdateConversationWebhookResponseConfiguration struct {
	Filters     *[]string `json:"filters,omitempty"`
	FlowSid     *string   `json:"flow_sid,omitempty"`
	Method      *string   `json:"method,omitempty"`
	ReplayAfter *int      `json:"replay_after,omitempty"`
	Triggers    *[]string `json:"triggers,omitempty"`
	URL         *string   `json:"url,omitempty"`
}