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 UpdateAddressInput
• type UpdateAddressResponse

Types

type Client

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

Client for managing a specific address resource See https://www.twilio.com/docs/usage/api/address 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 resource from the account See https://www.twilio.com/docs/usage/api/address#delete-an-address-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 resource from the account See https://www.twilio.com/docs/usage/api/address#delete-an-address-resource for more details

func (Client) Fetch

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

Fetch retrieves the address resource See https://www.twilio.com/docs/usage/api/address#fetch-an-address-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 the address resource See https://www.twilio.com/docs/usage/api/address#fetch-an-address-resource for more details

func (Client) Update

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

Update modifies an address resource See https://www.twilio.com/docs/usage/api/address#update-an-address-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 an address resource See https://www.twilio.com/docs/usage/api/address#update-an-address-resource for more details

type ClientProperties

type ClientProperties struct {
	AccountSid string
	Sid        string
}

ClientProperties are the properties required to manage the address resources

type FetchAddressResponse

type FetchAddressResponse struct {
	AccountSid       string             `json:"account_sid"`
	City             string             `json:"city"`
	CustomerName     string             `json:"customer_name"`
	DateCreated      utils.RFC2822Time  `json:"date_created"`
	DateUpdated      *utils.RFC2822Time `json:"date_updated,omitempty"`
	EmergencyEnabled bool               `json:"emergency_enabled"`
	FriendlyName     *string            `json:"friendly_name,omitempty"`
	IsoCountry       string             `json:"iso_country"`
	PostalCode       string             `json:"postal_code"`
	Region           string             `json:"region"`
	Sid              string             `json:"sid"`
	Street           string             `json:"street"`
	StreetSecondary  *string            `json:"street_secondary,omitempty"`
	Validated        bool               `json:"validated"`
	Verified         bool               `json:"verified"`
}

FetchAddressResponse defines the response fields for retrieving an address

type UpdateAddressInput

type UpdateAddressInput struct {
	AutoCorrectAddress *bool   `form:"AutoCorrectAddress,omitempty"`
	City               *string `form:"City,omitempty"`
	CustomerName       *string `form:"CustomerName,omitempty"`
	EmergencyEnabled   *bool   `form:"EmergencyEnabled,omitempty"`
	FriendlyName       *string `form:"FriendlyName,omitempty"`
	PostalCode         *string `form:"PostalCode,omitempty"`
	Region             *string `form:"Region,omitempty"`
	Street             *string `form:"Street,omitempty"`
	StreetSecondary    *string `form:"StreetSecondary,omitempty"`
}

UpdateAddressInput defines input fields for updating an addresses

type UpdateAddressResponse

type UpdateAddressResponse struct {
	AccountSid       string             `json:"account_sid"`
	City             string             `json:"city"`
	CustomerName     string             `json:"customer_name"`
	DateCreated      utils.RFC2822Time  `json:"date_created"`
	DateUpdated      *utils.RFC2822Time `json:"date_updated,omitempty"`
	EmergencyEnabled bool               `json:"emergency_enabled"`
	FriendlyName     *string            `json:"friendly_name,omitempty"`
	IsoCountry       string             `json:"iso_country"`
	PostalCode       string             `json:"postal_code"`
	Region           string             `json:"region"`
	Sid              string             `json:"sid"`
	Street           string             `json:"street"`
	StreetSecondary  *string            `json:"street_secondary,omitempty"`
	Validated        bool               `json:"validated"`
	Verified         bool               `json:"verified"`
}

UpdateAddressResponse defines the response fields for the updated addresses