Documentation ¶
Overview ¶
Package webhooks contains auto-generated files. DO NOT MODIFY
Package webhooks contains auto-generated files. DO NOT MODIFY
Package webhooks contains auto-generated files. DO NOT MODIFY
Index ¶
- type ChannelWebhooksPage
- type ChannelWebhooksPageOptions
- type ChannelWebhooksPageResponse
- type ChannelWebhooksPaginator
- type Client
- func (c Client) Create(input *CreateChannelWebhookInput) (*CreateChannelWebhookResponse, error)
- func (c Client) CreateWithContext(context context.Context, input *CreateChannelWebhookInput) (*CreateChannelWebhookResponse, error)
- func (c *Client) NewChannelWebhooksPaginator() *ChannelWebhooksPaginator
- func (c *Client) NewChannelWebhooksPaginatorWithOptions(options *ChannelWebhooksPageOptions) *ChannelWebhooksPaginator
- func (c Client) Page(options *ChannelWebhooksPageOptions) (*ChannelWebhooksPageResponse, error)
- func (c Client) PageWithContext(context context.Context, options *ChannelWebhooksPageOptions) (*ChannelWebhooksPageResponse, error)
- type ClientProperties
- type CreateChannelWebhookConfigurationInput
- type CreateChannelWebhookConfigurationResponse
- type CreateChannelWebhookInput
- type CreateChannelWebhookResponse
- type PageChannelWebhookConfigurationResponse
- type PageChannelWebhookResponse
- type PageMetaResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ChannelWebhooksPage ¶
type ChannelWebhooksPage struct { CurrentPage *ChannelWebhooksPageResponse Error error // contains filtered or unexported fields }
ChannelWebhooksPage defines the fields for the page The CurrentPage and Error fields can be used to access the PageChannelWebhookResponse or error that is returned from the api call(s)
type ChannelWebhooksPageOptions ¶
ChannelWebhooksPageOptions defines the query options for the api operation
type ChannelWebhooksPageResponse ¶
type ChannelWebhooksPageResponse struct { Meta PageMetaResponse `json:"meta"` Webhooks []PageChannelWebhookResponse `json:"webhooks"` }
ChannelWebhooksPageResponse defines the response fields for the channel webhooks page
type ChannelWebhooksPaginator ¶
type ChannelWebhooksPaginator struct { Page *ChannelWebhooksPage Webhooks []PageChannelWebhookResponse // contains filtered or unexported fields }
ChannelWebhooksPaginator defines the fields for makings paginated api calls Webhooks is an array of webhooks that have been returned from all of the page calls
func (*ChannelWebhooksPaginator) CurrentPage ¶
func (p *ChannelWebhooksPaginator) CurrentPage() *ChannelWebhooksPageResponse
CurrentPage retrieves the results for the current page
func (*ChannelWebhooksPaginator) Error ¶
func (p *ChannelWebhooksPaginator) Error() error
Error retrieves the error returned from the page
func (*ChannelWebhooksPaginator) Next ¶
func (p *ChannelWebhooksPaginator) Next() bool
Next retrieves the next page of results. Next will return false when either an error occurs or there are no more pages to iterate Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information
func (*ChannelWebhooksPaginator) NextWithContext ¶
func (p *ChannelWebhooksPaginator) NextWithContext(context context.Context) bool
NextWithContext retrieves the next page of results. NextWithContext will return false when either an error occurs or there are no more pages to iterate
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client for managing webhook resources 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 webhooks client
func (Client) Create ¶
func (c Client) Create(input *CreateChannelWebhookInput) (*CreateChannelWebhookResponse, error)
Create creates a new webhook See https://www.twilio.com/docs/chat/rest/channel-webhook-resource#create-a-channelwebhook-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information
func (Client) CreateWithContext ¶
func (c Client) CreateWithContext(context context.Context, input *CreateChannelWebhookInput) (*CreateChannelWebhookResponse, error)
CreateWithContext creates a new webhook See https://www.twilio.com/docs/chat/rest/channel-webhook-resource#create-a-channelwebhook-resource for more details
func (*Client) NewChannelWebhooksPaginator ¶
func (c *Client) NewChannelWebhooksPaginator() *ChannelWebhooksPaginator
NewChannelWebhooksPaginator creates a new instance of the paginator for Page.
func (*Client) NewChannelWebhooksPaginatorWithOptions ¶
func (c *Client) NewChannelWebhooksPaginatorWithOptions(options *ChannelWebhooksPageOptions) *ChannelWebhooksPaginator
NewChannelWebhooksPaginatorWithOptions creates a new instance of the paginator for Page with options.
func (Client) Page ¶
func (c Client) Page(options *ChannelWebhooksPageOptions) (*ChannelWebhooksPageResponse, error)
Page retrieves a page of channel webhooks See https://www.twilio.com/docs/chat/rest/channel-webhook-resource#read-multiple-channelwebhook-resources for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information
func (Client) PageWithContext ¶
func (c Client) PageWithContext(context context.Context, options *ChannelWebhooksPageOptions) (*ChannelWebhooksPageResponse, error)
PageWithContext retrieves a page of channel webhooks See https://www.twilio.com/docs/chat/rest/channel-webhook-resource#read-multiple-channelwebhook-resources for more details
type ClientProperties ¶
ClientProperties are the properties required to manage the webhooks resources
type CreateChannelWebhookConfigurationInput ¶ added in v0.6.0
type CreateChannelWebhookConfigurationInput struct { Filters *[]string `form:"Filters,omitempty"` FlowSid *string `form:"FlowSid,omitempty"` Method *string `form:"Method,omitempty"` RetryCount *int `form:"RetryCount,omitempty"` Triggers *[]string `form:"Triggers,omitempty"` URL *string `form:"Url,omitempty"` }
type CreateChannelWebhookConfigurationResponse ¶ added in v0.6.0
type CreateChannelWebhookConfigurationResponse 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 CreateChannelWebhookInput ¶
type CreateChannelWebhookInput struct { Configuration *CreateChannelWebhookConfigurationInput `form:"Configuration,omitempty"` Type string `validate:"required" form:"Type"` }
CreateChannelWebhookInput defines the input fields for creating a new webhook resource
type CreateChannelWebhookResponse ¶
type CreateChannelWebhookResponse struct { AccountSid string `json:"account_sid"` ChannelSid string `json:"channel_sid"` Configuration CreateChannelWebhookConfigurationResponse `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"` }
CreateChannelWebhookResponse defines the response fields for the created webhook
type PageChannelWebhookConfigurationResponse ¶ added in v0.6.0
type PageChannelWebhookConfigurationResponse 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 PageChannelWebhookResponse ¶
type PageChannelWebhookResponse struct { AccountSid string `json:"account_sid"` ChannelSid string `json:"channel_sid"` Configuration PageChannelWebhookConfigurationResponse `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"` }