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() (*FetchWebhookResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchWebhookResponse, error)
  • func (c Client) Update(input *UpdateWebhookInput) (*UpdateWebhookResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateWebhookInput) (*UpdateWebhookResponse, error)
• type ClientProperties
• type FetchWebhookConfigurationResponse
• type FetchWebhookResponse
• type UpdateWebhookConfigurationInput
• type UpdateWebhookConfigurationResponse
• type UpdateWebhookInput
• type UpdateWebhookResponse

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() (*FetchWebhookResponse, 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) (*FetchWebhookResponse, 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 *UpdateWebhookInput) (*UpdateWebhookResponse, 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 *UpdateWebhookInput) (*UpdateWebhookResponse, 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 FetchWebhookConfigurationResponse

type FetchWebhookConfigurationResponse 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 FetchWebhookResponse

type FetchWebhookResponse struct {
	AccountSid      string                            `json:"account_sid"`
	Configuration   FetchWebhookConfigurationResponse `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"`
}

FetchWebhookResponse defines the response fields for the retrieved webhook

type UpdateWebhookConfigurationInput

type UpdateWebhookConfigurationInput struct {
	Filters  *[]string `form:"Filters,omitempty"`
	FlowSid  *string   `form:"FlowSid,omitempty"`
	Method   *string   `form:"Method,omitempty"`
	Triggers *[]string `form:"Triggers,omitempty"`
	URL      *string   `form:"Url,omitempty"`
}

type UpdateWebhookConfigurationResponse

type UpdateWebhookConfigurationResponse 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 UpdateWebhookInput

type UpdateWebhookInput struct {
	Configuration *UpdateWebhookConfigurationInput `form:"Configuration,omitempty"`
}

UpdateWebhookInput defines input fields for updating an webhook resource

type UpdateWebhookResponse

type UpdateWebhookResponse struct {
	AccountSid      string                             `json:"account_sid"`
	Configuration   UpdateWebhookConfigurationResponse `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"`
}

UpdateWebhookResponse defines the response fields for the updated webhook