applications

Documentation

Overview

Package applications contains auto-generated files. DO NOT MODIFY

Package applications contains auto-generated files. DO NOT MODIFY

Package applications contains auto-generated files. DO NOT MODIFY

Index

• type ApplicationsPage
• type ApplicationsPageOptions
• type ApplicationsPageResponse
• type ApplicationsPaginator
  • func (p *ApplicationsPaginator) CurrentPage() *ApplicationsPageResponse
  • func (p *ApplicationsPaginator) Error() error
  • func (p *ApplicationsPaginator) Next() bool
  • func (p *ApplicationsPaginator) NextWithContext(context context.Context) bool
• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Create(input *CreateApplicationInput) (*CreateApplicationResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateApplicationInput) (*CreateApplicationResponse, error)
  • func (c *Client) NewApplicationsPaginator() *ApplicationsPaginator
  • func (c *Client) NewApplicationsPaginatorWithOptions(options *ApplicationsPageOptions) *ApplicationsPaginator
  • func (c Client) Page(options *ApplicationsPageOptions) (*ApplicationsPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *ApplicationsPageOptions) (*ApplicationsPageResponse, error)
• type ClientProperties
• type CreateApplicationInput
• type CreateApplicationResponse
• type PageApplicationResponse

Types

type ApplicationsPage

type ApplicationsPage struct {
	CurrentPage *ApplicationsPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type ApplicationsPageOptions

type ApplicationsPageOptions struct {
	PageSize     *int
	Page         *int
	PageToken    *string
	FriendlyName *string
}

ApplicationsPageOptions defines the query options for the api operation

type ApplicationsPageResponse

type ApplicationsPageResponse struct {
	Applications    []PageApplicationResponse `json:"applications"`
	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"`
	PreviousPageURI *string                   `json:"previous_page_uri,omitempty"`
	Start           int                       `json:"start"`
	URI             string                    `json:"uri"`
}

ApplicationsPageResponse defines the response fields for the applications page

type ApplicationsPaginator

type ApplicationsPaginator struct {
	Page         *ApplicationsPage
	Applications []PageApplicationResponse
	// contains filtered or unexported fields
}

ApplicationsPaginator defines the fields for makings paginated api calls Applications is an array of applications that have been returned from all of the page calls

func (*ApplicationsPaginator) CurrentPage

func (p *ApplicationsPaginator) CurrentPage() *ApplicationsPageResponse

CurrentPage retrieves the results for the current page

func (*ApplicationsPaginator) Error

func (p *ApplicationsPaginator) Error() error

Error retrieves the error returned from the page

func (*ApplicationsPaginator) Next

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

func (p *ApplicationsPaginator) 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 Client

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

Client for managing application resources See https://www.twilio.com/docs/usage/api/applications for more details

func New

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

New creates a new instance of the applications client

func (Client) Create

func (c Client) Create(input *CreateApplicationInput) (*CreateApplicationResponse, error)

Create creates a new application resource See https://www.twilio.com/docs/usage/api/applications#create-an-application-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 *CreateApplicationInput) (*CreateApplicationResponse, error)

CreateWithContext creates a new application resource See https://www.twilio.com/docs/usage/api/applications#create-an-application-resource for more details

func (*Client) NewApplicationsPaginator

func (c *Client) NewApplicationsPaginator() *ApplicationsPaginator

NewApplicationsPaginator creates a new instance of the paginator for Page.

func (*Client) NewApplicationsPaginatorWithOptions

func (c *Client) NewApplicationsPaginatorWithOptions(options *ApplicationsPageOptions) *ApplicationsPaginator

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

func (Client) Page

func (c Client) Page(options *ApplicationsPageOptions) (*ApplicationsPageResponse, error)

Page retrieves a page of applications See https://www.twilio.com/docs/usage/api/applications#read-multiple-application-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 *ApplicationsPageOptions) (*ApplicationsPageResponse, error)

PageWithContext retrieves a page of applications See https://www.twilio.com/docs/usage/api/applications#read-multiple-application-resources for more details

type ClientProperties

type ClientProperties struct {
	AccountSid string
}

ClientProperties are the properties required to manage the applications resources

type CreateApplicationInput

type CreateApplicationInput struct {
	APIVersion            *string `form:"ApiVersion,omitempty"`
	FriendlyName          *string `form:"FriendlyName,omitempty"`
	MessageStatusCallback *string `form:"MessageStatusCallback,omitempty"`
	SmsFallbackMethod     *string `form:"SmsFallbackMethod,omitempty"`
	SmsFallbackURL        *string `form:"SmsFallbackUrl,omitempty"`
	SmsMethod             *string `form:"SmsMethod,omitempty"`
	SmsStatusCallback     *string `form:"SmsStatusCallback,omitempty"`
	SmsURL                *string `form:"SmsUrl,omitempty"`
	StatusCallback        *string `form:"StatusCallback,omitempty"`
	StatusCallbackMethod  *string `form:"StatusCallbackMethod,omitempty"`
	VoiceCallerIDLookup   *bool   `form:"VoiceCallerIdLookup,omitempty"`
	VoiceFallbackMethod   *string `form:"VoiceFallbackMethod,omitempty"`
	VoiceFallbackURL      *string `form:"VoiceFallbackUrl,omitempty"`
	VoiceMethod           *string `form:"VoiceMethod,omitempty"`
	VoiceURL              *string `form:"VoiceUrl,omitempty"`
}

CreateApplicationInput defines input fields for creating a new application

type CreateApplicationResponse

type CreateApplicationResponse struct {
	APIVersion            string             `json:"api_version"`
	AccountSid            string             `json:"account_sid"`
	DateCreated           utils.RFC2822Time  `json:"date_created"`
	DateUpdated           *utils.RFC2822Time `json:"date_updated,omitempty"`
	FriendlyName          *string            `json:"friendly_name,omitempty"`
	MessageStatusCallback *string            `json:"message_status_callback,omitempty"`
	Sid                   string             `json:"sid"`
	SmsFallbackMethod     string             `json:"sms_fallback_method"`
	SmsFallbackURL        *string            `json:"sms_fallback_url,omitempty"`
	SmsMethod             string             `json:"sms_method"`
	SmsStatusCallback     *string            `json:"sms_status_callback,omitempty"`
	SmsURL                *string            `json:"sms_url,omitempty"`
	StatusCallback        *string            `json:"status_callback,omitempty"`
	StatusCallbackMethod  string             `json:"status_callback_method"`
	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"`
	VoiceURL              *string            `json:"voice_url,omitempty"`
}

CreateApplicationResponse defines the response fields for creating a new application

type PageApplicationResponse

type PageApplicationResponse struct {
	APIVersion            string             `json:"api_version"`
	AccountSid            string             `json:"account_sid"`
	DateCreated           utils.RFC2822Time  `json:"date_created"`
	DateUpdated           *utils.RFC2822Time `json:"date_updated,omitempty"`
	FriendlyName          *string            `json:"friendly_name,omitempty"`
	MessageStatusCallback *string            `json:"message_status_callback,omitempty"`
	Sid                   string             `json:"sid"`
	SmsFallbackMethod     string             `json:"sms_fallback_method"`
	SmsFallbackURL        *string            `json:"sms_fallback_url,omitempty"`
	SmsMethod             string             `json:"sms_method"`
	SmsStatusCallback     *string            `json:"sms_status_callback,omitempty"`
	SmsURL                *string            `json:"sms_url,omitempty"`
	StatusCallback        *string            `json:"status_callback,omitempty"`
	StatusCallbackMethod  string             `json:"status_callback_method"`
	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"`
	VoiceURL              *string            `json:"voice_url,omitempty"`
}