incoming_phone_numbers

Documentation

Overview

Package incoming_phone_numbers contains auto-generated files. DO NOT MODIFY

Package incoming_phone_numbers contains auto-generated files. DO NOT MODIFY

Package incoming_phone_numbers contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Create(input *CreateIncomingPhoneNumberInput) (*CreateIncomingPhoneNumberResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateIncomingPhoneNumberInput) (*CreateIncomingPhoneNumberResponse, error)
  • func (c *Client) NewIncomingPhoneNumbersPaginator() *IncomingPhoneNumbersPaginator
  • func (c *Client) NewIncomingPhoneNumbersPaginatorWithOptions(options *IncomingPhoneNumbersPageOptions) *IncomingPhoneNumbersPaginator
  • func (c Client) Page(options *IncomingPhoneNumbersPageOptions) (*IncomingPhoneNumbersPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *IncomingPhoneNumbersPageOptions) (*IncomingPhoneNumbersPageResponse, error)
• type ClientProperties
• type CreateIncomingPhoneNumberCapabilitiesResponse
• type CreateIncomingPhoneNumberInput
• type CreateIncomingPhoneNumberResponse
• type IncomingPhoneNumbersPage
• type IncomingPhoneNumbersPageOptions
• type IncomingPhoneNumbersPageResponse
• type IncomingPhoneNumbersPaginator
  • func (p *IncomingPhoneNumbersPaginator) CurrentPage() *IncomingPhoneNumbersPageResponse
  • func (p *IncomingPhoneNumbersPaginator) Error() error
  • func (p *IncomingPhoneNumbersPaginator) Next() bool
  • func (p *IncomingPhoneNumbersPaginator) NextWithContext(context context.Context) bool
• type PageIncomingPhoneNumberCapabilitiesResponse
• type PageIncomingPhoneNumberResponse

Types

type Client

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

Client for managing phone number resources See https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource for more details

func New

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

New creates a new instance of the incoming phone numbers client

func (Client) Create

func (c Client) Create(input *CreateIncomingPhoneNumberInput) (*CreateIncomingPhoneNumberResponse, error)

Create creates a new phone number resource See https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource#create-an-incomingphonenumber-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 *CreateIncomingPhoneNumberInput) (*CreateIncomingPhoneNumberResponse, error)

CreateWithContext creates a new phone number resource See https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource#create-an-incomingphonenumber-resource for more details

func (*Client) NewIncomingPhoneNumbersPaginator

func (c *Client) NewIncomingPhoneNumbersPaginator() *IncomingPhoneNumbersPaginator

NewIncomingPhoneNumbersPaginator creates a new instance of the paginator for Page.

func (*Client) NewIncomingPhoneNumbersPaginatorWithOptions

func (c *Client) NewIncomingPhoneNumbersPaginatorWithOptions(options *IncomingPhoneNumbersPageOptions) *IncomingPhoneNumbersPaginator

NewIncomingPhoneNumbersPaginatorWithOptions creates a new instance of the paginator for Page with options.

func (Client) Page

func (c Client) Page(options *IncomingPhoneNumbersPageOptions) (*IncomingPhoneNumbersPageResponse, error)

Page retrieves a page of phone numbers See https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource#read-multiple-incomingphonenumber-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 *IncomingPhoneNumbersPageOptions) (*IncomingPhoneNumbersPageResponse, error)

PageWithContext retrieves a page of phone numbers See https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource#read-multiple-incomingphonenumber-resources for more details

type ClientProperties

type ClientProperties struct {
	AccountSid string
}

ClientProperties are the properties required to manage the incoming phone numbers resources

type CreateIncomingPhoneNumberCapabilitiesResponse

type CreateIncomingPhoneNumberCapabilitiesResponse struct {
	Fax   *bool `json:"fax,omitempty"`
	Mms   bool  `json:"MMS"`
	Sms   bool  `json:"SMS"`
	Voice bool  `json:"voice"`
}

type CreateIncomingPhoneNumberInput

type CreateIncomingPhoneNumberInput struct {
	APIVersion           *string `form:"ApiVersion,omitempty"`
	AddressSid           *string `form:"AddressSid,omitempty"`
	AreaCode             *string `form:"AreaCode,omitempty"`
	BundleSid            *string `form:"BundleSid,omitempty"`
	EmergencyAddressSid  *string `form:"EmergencyAddressSid,omitempty"`
	EmergencyStatus      *string `form:"EmergencyStatus,omitempty"`
	FriendlyName         *string `form:"FriendlyName,omitempty"`
	IdentitySid          *string `form:"IdentitySid,omitempty"`
	PhoneNumber          *string `form:"PhoneNumber,omitempty"`
	SmsApplicationSid    *string `form:"SmsApplicationSid,omitempty"`
	SmsFallbackMethod    *string `form:"SmsFallbackMethod,omitempty"`
	SmsFallbackURL       *string `form:"SmsFallbackUrl,omitempty"`
	SmsMethod            *string `form:"SmsMethod,omitempty"`
	SmsURL               *string `form:"SmsUrl,omitempty"`
	StatusCallback       *string `form:"StatusCallback,omitempty"`
	StatusCallbackMethod *string `form:"StatusCallbackMethod,omitempty"`
	TrunkSid             *string `form:"TrunkSid,omitempty"`
	VoiceApplicationSid  *string `form:"VoiceApplicationSid,omitempty"`
	VoiceCallerIDLookup  *bool   `form:"VoiceCallerIdLookup,omitempty"`
	VoiceFallbackMethod  *string `form:"VoiceFallbackMethod,omitempty"`
	VoiceFallbackURL     *string `form:"VoiceFallbackUrl,omitempty"`
	VoiceMethod          *string `form:"VoiceMethod,omitempty"`
	VoiceReceiveMode     *string `form:"VoiceReceiveMode,omitempty"`
	VoiceURL             *string `form:"VoiceUrl,omitempty"`
}

CreateIncomingPhoneNumberInput defines input fields for creating a new phone number

type CreateIncomingPhoneNumberResponse

type CreateIncomingPhoneNumberResponse struct {
	APIVersion           string                                        `json:"api_version"`
	AccountSid           string                                        `json:"account_sid"`
	AddressRequirements  string                                        `json:"address_requirements"`
	AddressSid           *string                                       `json:"address_sid,omitempty"`
	Beta                 bool                                          `json:"beta"`
	BundleSid            *string                                       `json:"bundle_sid,omitempty"`
	Capabilities         CreateIncomingPhoneNumberCapabilitiesResponse `json:"capabilities"`
	DateCreated          utils.RFC2822Time                             `json:"date_created"`
	DateUpdated          *utils.RFC2822Time                            `json:"date_updated,omitempty"`
	EmergencyAddressSid  *string                                       `json:"emergency_address_sid,omitempty"`
	EmergencyStatus      string                                        `json:"emergency_status"`
	FriendlyName         *string                                       `json:"friendly_name,omitempty"`
	IdentitySid          *string                                       `json:"identity_sid,omitempty"`
	Origin               string                                        `json:"origin"`
	PhoneNumber          string                                        `json:"phone_number"`
	Sid                  string                                        `json:"sid"`
	SmsApplicationSid    *string                                       `json:"sms_application_sid,omitempty"`
	SmsFallbackMethod    string                                        `json:"sms_fallback_method"`
	SmsFallbackURL       *string                                       `json:"sms_fallback_url,omitempty"`
	SmsMethod            string                                        `json:"sms_method"`
	SmsURL               *string                                       `json:"sms_url,omitempty"`
	Status               string                                        `json:"status"`
	StatusCallback       *string                                       `json:"status_callback,omitempty"`
	StatusCallbackMethod string                                        `json:"status_callback_method"`
	TrunkSid             *string                                       `json:"trunk_sid,omitempty"`
	VoiceApplicationSid  *string                                       `json:"voice_application_sid,omitempty"`
	VoiceCallerIDLookup  bool                                          `json:"voice_caller_id_lookup"`
	VoiceFallbackMethod  string                                        `json:"voice_fallback_method"`
	VoiceFallbackURL     *string                                       `json:"voice_fallback_url,omitempty"`
	VoiceMethod          string                                        `json:"voice_method"`
	VoiceReceiveMode     *string                                       `json:"voice_receive_mode,omitempty"`
	VoiceURL             *string                                       `json:"voice_url,omitempty"`
}

CreateIncomingPhoneNumberResponse defines the response fields for creating a new phone number

type IncomingPhoneNumbersPage

type IncomingPhoneNumbersPage struct {
	CurrentPage *IncomingPhoneNumbersPageResponse
	Error       error
	// contains filtered or unexported fields
}

IncomingPhoneNumbersPage defines the fields for the page The CurrentPage and Error fields can be used to access the PageIncomingPhoneNumberResponse or error that is returned from the api call(s)

type IncomingPhoneNumbersPageOptions

type IncomingPhoneNumbersPageOptions struct {
	PageSize     *int
	Page         *int
	PageToken    *string
	FriendlyName *string
	Beta         *bool
	PhoneNumber  *string
	Origin       *string
}

IncomingPhoneNumbersPageOptions defines the query options for the api operation

type IncomingPhoneNumbersPageResponse

type IncomingPhoneNumbersPageResponse struct {
	End             int                               `json:"end"`
	FirstPageURI    string                            `json:"first_page_uri"`
	NextPageURI     *string                           `json:"next_page_uri,omitempty"`
	Page            int                               `json:"page"`
	PageSize        int                               `json:"page_size"`
	PhoneNumbers    []PageIncomingPhoneNumberResponse `json:"incoming_phone_numbers"`
	PreviousPageURI *string                           `json:"previous_page_uri,omitempty"`
	Start           int                               `json:"start"`
	URI             string                            `json:"uri"`
}

IncomingPhoneNumbersPageResponse defines the response fields for the phone numbers page

type IncomingPhoneNumbersPaginator

type IncomingPhoneNumbersPaginator struct {
	Page         *IncomingPhoneNumbersPage
	PhoneNumbers []PageIncomingPhoneNumberResponse
	// contains filtered or unexported fields
}

IncomingPhoneNumbersPaginator defines the fields for makings paginated api calls PhoneNumbers is an array of phonenumbers that have been returned from all of the page calls

func (*IncomingPhoneNumbersPaginator) CurrentPage

func (p *IncomingPhoneNumbersPaginator) CurrentPage() *IncomingPhoneNumbersPageResponse

CurrentPage retrieves the results for the current page

func (*IncomingPhoneNumbersPaginator) Error

func (p *IncomingPhoneNumbersPaginator) Error() error

Error retrieves the error returned from the page

func (*IncomingPhoneNumbersPaginator) Next

func (p *IncomingPhoneNumbersPaginator) 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 (*IncomingPhoneNumbersPaginator) NextWithContext

func (p *IncomingPhoneNumbersPaginator) 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 PageIncomingPhoneNumberCapabilitiesResponse

type PageIncomingPhoneNumberCapabilitiesResponse struct {
	Fax   *bool `json:"fax,omitempty"`
	Mms   bool  `json:"MMS"`
	Sms   bool  `json:"SMS"`
	Voice bool  `json:"voice"`
}

type PageIncomingPhoneNumberResponse

type PageIncomingPhoneNumberResponse struct {
	APIVersion           string                                      `json:"api_version"`
	AccountSid           string                                      `json:"account_sid"`
	AddressRequirements  string                                      `json:"address_requirements"`
	AddressSid           *string                                     `json:"address_sid,omitempty"`
	Beta                 bool                                        `json:"beta"`
	BundleSid            *string                                     `json:"bundle_sid,omitempty"`
	Capabilities         PageIncomingPhoneNumberCapabilitiesResponse `json:"capabilities"`
	DateCreated          utils.RFC2822Time                           `json:"date_created"`
	DateUpdated          *utils.RFC2822Time                          `json:"date_updated,omitempty"`
	EmergencyAddressSid  *string                                     `json:"emergency_address_sid,omitempty"`
	EmergencyStatus      string                                      `json:"emergency_status"`
	FriendlyName         *string                                     `json:"friendly_name,omitempty"`
	IdentitySid          *string                                     `json:"identity_sid,omitempty"`
	Origin               string                                      `json:"origin"`
	PhoneNumber          string                                      `json:"phone_number"`
	Sid                  string                                      `json:"sid"`
	SmsApplicationSid    *string                                     `json:"sms_application_sid,omitempty"`
	SmsFallbackMethod    string                                      `json:"sms_fallback_method"`
	SmsFallbackURL       *string                                     `json:"sms_fallback_url,omitempty"`
	SmsMethod            string                                      `json:"sms_method"`
	SmsURL               *string                                     `json:"sms_url,omitempty"`
	Status               string                                      `json:"status"`
	StatusCallback       *string                                     `json:"status_callback,omitempty"`
	StatusCallbackMethod string                                      `json:"status_callback_method"`
	TrunkSid             *string                                     `json:"trunk_sid,omitempty"`
	VoiceApplicationSid  *string                                     `json:"voice_application_sid,omitempty"`
	VoiceCallerIDLookup  bool                                        `json:"voice_caller_id_lookup"`
	VoiceFallbackMethod  string                                      `json:"voice_fallback_method"`
	VoiceFallbackURL     *string                                     `json:"voice_fallback_url,omitempty"`
	VoiceMethod          string                                      `json:"voice_method"`
	VoiceReceiveMode     *string                                     `json:"voice_receive_mode,omitempty"`
	VoiceURL             *string                                     `json:"voice_url,omitempty"`
}