Documentation ¶
Overview ¶
Package addresses contains auto-generated files. DO NOT MODIFY
Package addresses contains auto-generated files. DO NOT MODIFY
Package addresses contains auto-generated files. DO NOT MODIFY
Index ¶
- type AddressesPage
- type AddressesPageOptions
- type AddressesPageResponse
- type AddressesPaginator
- type Client
- func (c Client) Create(input *CreateAddressInput) (*CreateAddressResponse, error)
- func (c Client) CreateWithContext(context context.Context, input *CreateAddressInput) (*CreateAddressResponse, error)
- func (c *Client) NewAddressesPaginator() *AddressesPaginator
- func (c *Client) NewAddressesPaginatorWithOptions(options *AddressesPageOptions) *AddressesPaginator
- func (c Client) Page(options *AddressesPageOptions) (*AddressesPageResponse, error)
- func (c Client) PageWithContext(context context.Context, options *AddressesPageOptions) (*AddressesPageResponse, error)
- type CreateAddressInput
- type CreateAddressResponse
- type CreateAutoCreationInput
- type CreateAutoCreationResponse
- type PageAddressResponse
- type PageAutoCreationResponse
- type PageMetaResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddressesPage ¶
type AddressesPage struct { CurrentPage *AddressesPageResponse Error error // contains filtered or unexported fields }
AddressesPage defines the fields for the page The CurrentPage and Error fields can be used to access the PageAddressResponse or error that is returned from the api call(s)
type AddressesPageOptions ¶
AddressesPageOptions defines the query options for the api operation
type AddressesPageResponse ¶
type AddressesPageResponse struct { Addresses []PageAddressResponse `json:"address_configurations"` Meta PageMetaResponse `json:"meta"` }
AddressesPageResponse defines the response fields for the address configurations page
type AddressesPaginator ¶
type AddressesPaginator struct { Page *AddressesPage Addresses []PageAddressResponse // contains filtered or unexported fields }
AddressesPaginator defines the fields for makings paginated api calls Addresses is an array of addresses that have been returned from all of the page calls
func (*AddressesPaginator) CurrentPage ¶
func (p *AddressesPaginator) CurrentPage() *AddressesPageResponse
CurrentPage retrieves the results for the current page
func (*AddressesPaginator) Error ¶
func (p *AddressesPaginator) Error() error
Error retrieves the error returned from the page
func (*AddressesPaginator) Next ¶
func (p *AddressesPaginator) 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 (*AddressesPaginator) NextWithContext ¶
func (p *AddressesPaginator) 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 address configuration resources See https://www.twilio.com/docs/conversations/api/address-configuration-resource for more details
func (Client) Create ¶
func (c Client) Create(input *CreateAddressInput) (*CreateAddressResponse, error)
Create creates a new address configuration See https://www.twilio.com/docs/conversations/api/address-configuration-resource#create-an-addressconfiguration-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 *CreateAddressInput) (*CreateAddressResponse, error)
CreateWithContext creates a new address configuration See https://www.twilio.com/docs/conversations/api/address-configuration-resource#create-an-addressconfiguration-resource for more details
func (*Client) NewAddressesPaginator ¶
func (c *Client) NewAddressesPaginator() *AddressesPaginator
NewAddressesPaginator creates a new instance of the paginator for Page.
func (*Client) NewAddressesPaginatorWithOptions ¶
func (c *Client) NewAddressesPaginatorWithOptions(options *AddressesPageOptions) *AddressesPaginator
NewAddressesPaginatorWithOptions creates a new instance of the paginator for Page with options.
func (Client) Page ¶
func (c Client) Page(options *AddressesPageOptions) (*AddressesPageResponse, error)
Page retrieves a page of address configurations See https://www.twilio.com/docs/conversations/api/address-configuration-resource#read-multiple-addressconfiguration-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 *AddressesPageOptions) (*AddressesPageResponse, error)
PageWithContext retrieves a page of address configurations See https://www.twilio.com/docs/conversations/api/address-configuration-resource#read-multiple-addressconfiguration-resources for more details
type CreateAddressInput ¶
type CreateAddressInput struct { Address string `validate:"required" form:"Address"` AutoCreation *CreateAutoCreationInput `form:"AutoCreation,omitempty"` FriendlyName *string `form:"FriendlyName,omitempty"` Type string `validate:"required" form:"Type"` }
CreateAddressInput defines the input fields for creating a new address configuration resource
type CreateAddressResponse ¶
type CreateAddressResponse struct { AccountSid string `json:"account_sid"` Address string `json:"address"` AutoCreation CreateAutoCreationResponse `json:"auto_creation"` DateCreated time.Time `json:"date_created"` DateUpdated *time.Time `json:"date_updated,omitempty"` FriendlyName *string `json:"friendly_name,omitempty"` Sid string `json:"sid"` Type string `json:"type"` URL string `json:"url"` }
CreateAddressResponse defines the response fields for the created address configuration
type CreateAutoCreationInput ¶
type CreateAutoCreationInput struct { ConversationServiceSid *string `form:"ConversationServiceSid,omitempty"` Enabled *bool `form:"Enabled,omitempty"` StudioFlowSid *string `form:"StudioFlowSid,omitempty"` StudioRetryCount *int `form:"StudioRetryCount,omitempty"` Type *string `form:"Type,omitempty"` WebhookFilters *[]string `form:"WebhookFilters,omitempty"` WebhookMethod *string `form:"WebhookMethod,omitempty"` WebhookUrl *string `form:"WebhookUrl,omitempty"` }
type CreateAutoCreationResponse ¶
type CreateAutoCreationResponse struct { BindingName *string `json:"binding_name,omitempty"` ConversationServiceSid *string `json:"conversation_service_sid,omitempty"` Enabled bool `json:"enabled"` StudioFlowSid *string `json:"studio_flow_sid,omitempty"` StudioRetryCount *int `json:"studio_retry_count,omitempty"` Type string `json:"type"` WebhookFilters *[]string `json:"webhook_filters,omitempty"` WebhookMethod *string `json:"webhook_method,omitempty"` WebhookUrl *string `json:"webhook_url,omitempty"` }
type PageAddressResponse ¶
type PageAddressResponse struct { AccountSid string `json:"account_sid"` Address string `json:"address"` AutoCreation PageAutoCreationResponse `json:"auto_creation"` DateCreated time.Time `json:"date_created"` DateUpdated *time.Time `json:"date_updated,omitempty"` FriendlyName *string `json:"friendly_name,omitempty"` Sid string `json:"sid"` Type string `json:"type"` URL string `json:"url"` }
type PageAutoCreationResponse ¶
type PageAutoCreationResponse struct { BindingName *string `json:"binding_name,omitempty"` ConversationServiceSid *string `json:"conversation_service_sid,omitempty"` Enabled bool `json:"enabled"` StudioFlowSid *string `json:"studio_flow_sid,omitempty"` StudioRetryCount *int `json:"studio_retry_count,omitempty"` Type string `json:"type"` WebhookFilters *[]string `json:"webhook_filters,omitempty"` WebhookMethod *string `json:"webhook_method,omitempty"` WebhookUrl *string `json:"webhook_url,omitempty"` }