address

Documentation

Overview

Package address contains auto-generated files. DO NOT MODIFY

Package address contains auto-generated files. DO NOT MODIFY

Package address contains auto-generated files. DO NOT MODIFY

Package address 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() (*FetchAddressResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchAddressResponse, error)
  • func (c Client) Update(input *UpdateAddressInput) (*UpdateAddressResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateAddressInput) (*UpdateAddressResponse, error)
• type ClientProperties
• type FetchAddressResponse
• type FetchAutoCreationResponse
• type UpdateAddressInput
• type UpdateAddressResponse
• type UpdateAutoCreationInput
• type UpdateAutoCreationResponse

Types

type Client

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

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

func New

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

New creates a new instance of the address client

func (Client) Delete

func (c Client) Delete() error

Delete removes a address configuration resource from the account See https://www.twilio.com/docs/conversations/api/address-configuration-resource#delete-an-addressconfiguration-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 address configuration resource from the account See https://www.twilio.com/docs/conversations/api/address-configuration-resource#delete-an-addressconfiguration-resource for more details

func (Client) Fetch

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

Fetch retrieves a address configuration resource See https://www.twilio.com/docs/conversations/api/address-configuration-resource#fetch-an-addressconfiguration-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) (*FetchAddressResponse, error)

FetchWithContext retrieves a address configuration resource See https://www.twilio.com/docs/conversations/api/address-configuration-resource#fetch-an-addressconfiguration-resource for more details

func (Client) Update

func (c Client) Update(input *UpdateAddressInput) (*UpdateAddressResponse, error)

Update modifies a address configuration resource See https://www.twilio.com/docs/conversations/api/address-configuration-resource#update-an-addressconfiguration-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 *UpdateAddressInput) (*UpdateAddressResponse, error)

UpdateWithContext modifies a address configuration resource See https://www.twilio.com/docs/conversations/api/address-configuration-resource#update-an-addressconfiguration-resource for more details

type ClientProperties

type ClientProperties struct {
	Sid string
}

ClientProperties are the properties required to manage the address resources

type FetchAddressResponse

type FetchAddressResponse struct {
	AccountSid   string                    `json:"account_sid"`
	Address      string                    `json:"address"`
	AutoCreation FetchAutoCreationResponse `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"`
}

FetchAddressResponse defines the response fields for the retrieved address configuration

type FetchAutoCreationResponse

type FetchAutoCreationResponse 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 UpdateAddressInput

type UpdateAddressInput struct {
	AutoCreation *UpdateAutoCreationInput `form:"AutoCreation,omitempty"`
	FriendlyName *string                  `form:"FriendlyName,omitempty"`
}

UpdateAddressInput defines input fields for updating a address configuration resource

type UpdateAddressResponse

type UpdateAddressResponse struct {
	AccountSid   string                     `json:"account_sid"`
	Address      string                     `json:"address"`
	AutoCreation UpdateAutoCreationResponse `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"`
}

UpdateAddressResponse defines the response fields for the updated address configuration

type UpdateAutoCreationInput

type UpdateAutoCreationInput 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 UpdateAutoCreationResponse

type UpdateAutoCreationResponse 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"`
}