short_code

Documentation

Overview

Package short_code contains auto-generated files. DO NOT MODIFY

Package short_code contains auto-generated files. DO NOT MODIFY

Package short_code contains auto-generated files. DO NOT MODIFY

Package short_code 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() (*FetchShortCodeResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchShortCodeResponse, error)
  • func (c Client) Update(input *UpdateShortCodeInput) (*UpdateShortCodeResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateShortCodeInput) (*UpdateShortCodeResponse, error)
• type ClientProperties
• type FetchShortCodeCapabilitiesResponse
• type FetchShortCodeResponse
• type UpdateShortCodeCapabilitiesResponse
• type UpdateShortCodeInput
• type UpdateShortCodeResponse

Types

type Client

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

Client for managing a specific short code resource See https://www.twilio.com/docs/proxy/api/short-code for more details

func New

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

New creates a new instance of the short code client

func (Client) Delete

func (c Client) Delete() error

Delete removes a short code resource from the the proxy service See https://www.twilio.com/docs/proxy/api/short-code#remove-a-short-code-from-a-proxy-service 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 short code resource from the the proxy service See https://www.twilio.com/docs/proxy/api/short-code#remove-a-short-code-from-a-proxy-service for more details

func (Client) Fetch

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

Fetch retrieves a short code resource See https://www.twilio.com/docs/proxy/api/short-code#fetch-a-shortcode-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) (*FetchShortCodeResponse, error)

FetchWithContext retrieves a short code resource See https://www.twilio.com/docs/proxy/api/short-code#fetch-a-shortcode-resource for more details

func (Client) Update

func (c Client) Update(input *UpdateShortCodeInput) (*UpdateShortCodeResponse, error)

Update modifies a short code resource See https://www.twilio.com/docs/proxy/api/short-code#update-a-shortcode-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 *UpdateShortCodeInput) (*UpdateShortCodeResponse, error)

UpdateWithContext modifies a short code resource See https://www.twilio.com/docs/proxy/api/short-code#update-a-shortcode-resource for more details

type ClientProperties

type ClientProperties struct {
	ServiceSid string
	Sid        string
}

ClientProperties are the properties required to manage the short code resources

type FetchShortCodeCapabilitiesResponse

type FetchShortCodeCapabilitiesResponse struct {
	FaxInbound               *bool `json:"fax_inbound,omitempty"`
	FaxOutbound              *bool `json:"fax_outbound,omitempty"`
	MmsInbound               *bool `json:"mms_inbound,omitempty"`
	MmsOutbound              *bool `json:"mms_outbound,omitempty"`
	RestrictionFaxDomestic   *bool `json:"restriction_fax_domestic,omitempty"`
	RestrictionMmsDomestic   *bool `json:"restriction_mms_domestic,omitempty"`
	RestrictionSmsDomestic   *bool `json:"restriction_sms_domestic,omitempty"`
	RestrictionVoiceDomestic *bool `json:"restriction_voice_domestic,omitempty"`
	SipTrunking              *bool `json:"sip_trunking,omitempty"`
	SmsInbound               *bool `json:"sms_inbound,omitempty"`
	SmsOutbound              *bool `json:"sms_outbound,omitempty"`
	VoiceInbound             *bool `json:"voice_inbound,omitempty"`
	VoiceOutbound            *bool `json:"voice_outbound,omitempty"`
}

type FetchShortCodeResponse

type FetchShortCodeResponse struct {
	AccountSid   string                              `json:"account_sid"`
	Capabilities *FetchShortCodeCapabilitiesResponse `json:"capabilities,omitempty"`
	DateCreated  time.Time                           `json:"date_created"`
	DateUpdated  *time.Time                          `json:"date_updated,omitempty"`
	IsReserved   *bool                               `json:"is_reserved,omitempty"`
	IsoCountry   *string                             `json:"iso_country,omitempty"`
	ServiceSid   string                              `json:"service_sid"`
	ShortCode    *string                             `json:"short_code,omitempty"`
	Sid          string                              `json:"sid"`
	URL          string                              `json:"url"`
}

FetchShortCodeResponse defines the response fields for the retrieved short code

type UpdateShortCodeCapabilitiesResponse

type UpdateShortCodeCapabilitiesResponse struct {
	FaxInbound               *bool `json:"fax_inbound,omitempty"`
	FaxOutbound              *bool `json:"fax_outbound,omitempty"`
	MmsInbound               *bool `json:"mms_inbound,omitempty"`
	MmsOutbound              *bool `json:"mms_outbound,omitempty"`
	RestrictionFaxDomestic   *bool `json:"restriction_fax_domestic,omitempty"`
	RestrictionMmsDomestic   *bool `json:"restriction_mms_domestic,omitempty"`
	RestrictionSmsDomestic   *bool `json:"restriction_sms_domestic,omitempty"`
	RestrictionVoiceDomestic *bool `json:"restriction_voice_domestic,omitempty"`
	SipTrunking              *bool `json:"sip_trunking,omitempty"`
	SmsInbound               *bool `json:"sms_inbound,omitempty"`
	SmsOutbound              *bool `json:"sms_outbound,omitempty"`
	VoiceInbound             *bool `json:"voice_inbound,omitempty"`
	VoiceOutbound            *bool `json:"voice_outbound,omitempty"`
}

type UpdateShortCodeInput

type UpdateShortCodeInput struct {
	IsReserved *bool `form:"IsReserved,omitempty"`
}

UpdateShortCodeInput defines input fields for updating a short code resource

type UpdateShortCodeResponse

type UpdateShortCodeResponse struct {
	AccountSid   string                               `json:"account_sid"`
	Capabilities *UpdateShortCodeCapabilitiesResponse `json:"capabilities,omitempty"`
	DateCreated  time.Time                            `json:"date_created"`
	DateUpdated  *time.Time                           `json:"date_updated,omitempty"`
	IsReserved   *bool                                `json:"is_reserved,omitempty"`
	IsoCountry   *string                              `json:"iso_country,omitempty"`
	ServiceSid   string                               `json:"service_sid"`
	ShortCode    *string                              `json:"short_code,omitempty"`
	Sid          string                               `json:"sid"`
	URL          string                               `json:"url"`
}

UpdateShortCodeResponse defines the response fields for the updated short code