webhook

Documentation

Overview

Package webhook contains auto-generated files. DO NOT MODIFY

Package webhook contains auto-generated files. DO NOT MODIFY

Package webhook contains auto-generated files. DO NOT MODIFY

Package webhook contains auto-generated files. 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() (*FetchChannelWebhookResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchChannelWebhookResponse, error)
  • func (c Client) Update(input *UpdateChannelWebhookInput) (*UpdateChannelWebhookResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateChannelWebhookInput) (*UpdateChannelWebhookResponse, error)
• type ClientProperties
• type FetchChannelWebhookResponse
• type FetchChannelWebhookResponseConfiguration
• type UpdateChannelWebhookInput
• type UpdateChannelWebhookResponse
• type UpdateChannelWebhookResponseConfiguration

Types

type Client

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

Client for managing a specific webhook resource See https://www.twilio.com/docs/chat/rest/channel-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/chat/rest/channel-webhook-resource#delete-a-channelwebhook-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/chat/rest/channel-webhook-resource#delete-a-channelwebhook-resource for more details

func (Client) Fetch

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

Fetch retrieves a webhook resource See https://www.twilio.com/docs/chat/rest/channel-webhook-resource#fetch-a-channelwebhook-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) (*FetchChannelWebhookResponse, error)

FetchWithContext retrieves a webhook resource See https://www.twilio.com/docs/chat/rest/channel-webhook-resource#fetch-a-channelwebhook-resource for more details

func (Client) Update

func (c Client) Update(input *UpdateChannelWebhookInput) (*UpdateChannelWebhookResponse, error)

Update modifies a webhook resource See https://www.twilio.com/docs/chat/rest/channel-webhook-resource#update-a-channelwebhook-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 *UpdateChannelWebhookInput) (*UpdateChannelWebhookResponse, error)

UpdateWithContext modifies a webhook resource See https://www.twilio.com/docs/chat/rest/channel-webhook-resource#update-a-channelwebhook-resource for more details

type ClientProperties

type ClientProperties struct {
	ChannelSid string
	ServiceSid string
	Sid        string
}

ClientProperties are the properties required to manage the webhook resources

type FetchChannelWebhookResponse

type FetchChannelWebhookResponse struct {
	AccountSid    string                                   `json:"account_sid"`
	ChannelSid    string                                   `json:"channel_sid"`
	Configuration FetchChannelWebhookResponseConfiguration `json:"configuration"`
	DateCreated   time.Time                                `json:"date_created"`
	DateUpdated   *time.Time                               `json:"date_updated,omitempty"`
	ServiceSid    string                                   `json:"service_sid"`
	Sid           string                                   `json:"sid"`
	Type          string                                   `json:"type"`
	URL           string                                   `json:"url"`
}

FetchChannelWebhookResponse defines the response fields for the retrieved webhook

type FetchChannelWebhookResponseConfiguration

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

type UpdateChannelWebhookInput

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

UpdateChannelWebhookInput defines input fields for updating a webhook resource

type UpdateChannelWebhookResponse

type UpdateChannelWebhookResponse struct {
	AccountSid    string                                    `json:"account_sid"`
	ChannelSid    string                                    `json:"channel_sid"`
	Configuration UpdateChannelWebhookResponseConfiguration `json:"configuration"`
	DateCreated   time.Time                                 `json:"date_created"`
	DateUpdated   *time.Time                                `json:"date_updated,omitempty"`
	ServiceSid    string                                    `json:"service_sid"`
	Sid           string                                    `json:"sid"`
	Type          string                                    `json:"type"`
	URL           string                                    `json:"url"`
}

UpdateChannelWebhookResponse defines the response fields for the updated webhook

type UpdateChannelWebhookResponseConfiguration

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