short_code

Documentation

Overview

This is an autogenerated file. DO NOT MODIFY

This is an autogenerated file. DO NOT MODIFY

This is an autogenerated file. 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)
• type ClientProperties
• type FetchShortCodeResponse

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/sms/services/api/shortcode-resource for more details

func New

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

New creates a new instance of the shortcode client

func (Client) Delete

func (c Client) Delete() error

Delete removes a short code resource from the account See https://www.twilio.com/docs/sms/services/api/shortcode-resource#delete-a-shortcode-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 short code resource from the account See https://www.twilio.com/docs/sms/services/api/shortcode-resource#delete-a-shortcode-resource for more details

func (Client) Fetch

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

Fetch retrieves a short code resource See https://www.twilio.com/docs/sms/services/api/shortcode-resource#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/sms/services/api/shortcode-resource#fetch-a-shortcode-resource for more details

type ClientProperties

type ClientProperties struct {
	ServiceSid string
	Sid        string
}

ClientProperties are the properties required to manage the shortcode resources

type FetchShortCodeResponse

type FetchShortCodeResponse struct {
	AccountSid   string     `json:"account_sid"`
	Capabilities []string   `json:"capabilities"`
	CountryCode  string     `json:"country_code"`
	DateCreated  time.Time  `json:"date_created"`
	DateUpdated  *time.Time `json:"date_updated,omitempty"`
	ServiceSid   string     `json:"service_sid"`
	ShortCode    string     `json:"short_code"`
	Sid          string     `json:"sid"`
	URL          string     `json:"url"`
}

FetchShortCodeResponse defines the response fields for the retrieved short code