incoming_phone_number

Documentation

Overview

Package incoming_phone_number contains auto-generated files. DO NOT MODIFY

Package incoming_phone_number contains auto-generated files. DO NOT MODIFY

Package incoming_phone_number contains auto-generated files. DO NOT MODIFY

Package incoming_phone_number 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() (*FetchIncomingPhoneNumberResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchIncomingPhoneNumberResponse, error)
  • func (c Client) Update(input *UpdateIncomingPhoneNumberInput) (*UpdateIncomingPhoneNumberResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateIncomingPhoneNumberInput) (*UpdateIncomingPhoneNumberResponse, error)
• type ClientProperties
• type FetchIncomingPhoneNumberCapabilitiesResponse
• type FetchIncomingPhoneNumberResponse
• type UpdateIncomingPhoneNumberCapabilitiesResponse
• type UpdateIncomingPhoneNumberInput
• type UpdateIncomingPhoneNumberResponse

Types

type Client

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

Client for managing a specific phone number resource 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 number client

func (Client) Delete

func (c Client) Delete() error

Delete removes a phone number from the account See https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource#delete-an-incomingphonenumber-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 phone number from the account See https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource#delete-an-incomingphonenumber-resource for more details

func (Client) Fetch

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

Fetch retrieves a phone number resource See https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource#fetch-an-incomingphonenumber-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) (*FetchIncomingPhoneNumberResponse, error)

FetchWithContext retrieves a phone number resource See https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource#fetch-an-incomingphonenumber-resource for more details

func (Client) Update

func (c Client) Update(input *UpdateIncomingPhoneNumberInput) (*UpdateIncomingPhoneNumberResponse, error)

Update modifies a phone number resource See https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource#update-an-incomingphonenumber-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 *UpdateIncomingPhoneNumberInput) (*UpdateIncomingPhoneNumberResponse, error)

UpdateWithContext modifies a phone number resource See https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource#update-an-incomingphonenumber-resource for more details

type ClientProperties

type ClientProperties struct {
	AccountSid string
	Sid        string
}

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

type FetchIncomingPhoneNumberCapabilitiesResponse

type FetchIncomingPhoneNumberCapabilitiesResponse struct {
	Fax   bool `json:"fax"`
	Mms   bool `json:"MMS"`
	Sms   bool `json:"SMS"`
	Voice bool `json:"voice"`
}

type FetchIncomingPhoneNumberResponse

type FetchIncomingPhoneNumberResponse 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         FetchIncomingPhoneNumberCapabilitiesResponse `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"`
	VoiceURL             *string                                      `json:"voice_url,omitempty"`
}

FetchIncomingPhoneNumberResponse defines the response fields for retrieving a phone number

type UpdateIncomingPhoneNumberCapabilitiesResponse

type UpdateIncomingPhoneNumberCapabilitiesResponse struct {
	Fax   bool `json:"fax"`
	Mms   bool `json:"MMS"`
	Sms   bool `json:"SMS"`
	Voice bool `json:"voice"`
}

type UpdateIncomingPhoneNumberInput

type UpdateIncomingPhoneNumberInput struct {
	APIVersion           *string `form:"ApiVersion,omitempty"`
	AddressSid           *string `form:"AddressSid,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"`
	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"`
}

UpdateIncomingPhoneNumberInput defines input fields for updating a phone number

type UpdateIncomingPhoneNumberResponse

type UpdateIncomingPhoneNumberResponse 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         UpdateIncomingPhoneNumberCapabilitiesResponse `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"`
	VoiceURL             *string                                       `json:"voice_url,omitempty"`
}

UpdateIncomingPhoneNumberResponse defines the response fields for the updated phone number