trunks

Documentation

Overview

Package trunks contains auto-generated files. DO NOT MODIFY

Package trunks contains auto-generated files. DO NOT MODIFY

Package trunks contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client) *Client
  • func (c Client) Create(input *CreateTrunkInput) (*CreateTrunkResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateTrunkInput) (*CreateTrunkResponse, error)
  • func (c *Client) NewTrunksPaginator() *TrunksPaginator
  • func (c *Client) NewTrunksPaginatorWithOptions(options *TrunksPageOptions) *TrunksPaginator
  • func (c Client) Page(options *TrunksPageOptions) (*TrunksPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *TrunksPageOptions) (*TrunksPageResponse, error)
• type CreateTrunkInput
• type CreateTrunkRecordingResponse
• type CreateTrunkResponse
• type PageMetaResponse
• type PageTrunkRecordingResponse
• type PageTrunkResponse
• type TrunksPage
• type TrunksPageOptions
• type TrunksPageResponse
• type TrunksPaginator
  • func (p *TrunksPaginator) CurrentPage() *TrunksPageResponse
  • func (p *TrunksPaginator) Error() error
  • func (p *TrunksPaginator) Next() bool
  • func (p *TrunksPaginator) NextWithContext(context context.Context) bool

Types

type Client

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

Client for managing trunk resources See https://www.twilio.com/docs/sip-trunking/api/trunk-resource for more details

func New

func New(client *client.Client) *Client

New creates a new instance of the trunks client

func (Client) Create

func (c Client) Create(input *CreateTrunkInput) (*CreateTrunkResponse, error)

Create creates a new trunk resource See https://www.twilio.com/docs/sip-trunking/api/trunk-resource#create-a-trunk-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 *CreateTrunkInput) (*CreateTrunkResponse, error)

CreateWithContext creates a new trunk resource See https://www.twilio.com/docs/sip-trunking/api/trunk-resource#create-a-trunk-resource for more details

func (*Client) NewTrunksPaginator

func (c *Client) NewTrunksPaginator() *TrunksPaginator

NewTrunksPaginator creates a new instance of the paginator for Page.

func (*Client) NewTrunksPaginatorWithOptions

func (c *Client) NewTrunksPaginatorWithOptions(options *TrunksPageOptions) *TrunksPaginator

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

func (Client) Page

func (c Client) Page(options *TrunksPageOptions) (*TrunksPageResponse, error)

Page retrieves a page of trunk resources See https://www.twilio.com/docs/sip-trunking/api/trunk-resource#read-multiple-trunk-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 *TrunksPageOptions) (*TrunksPageResponse, error)

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

type CreateTrunkInput

type CreateTrunkInput struct {
	CnamLookupEnabled      *bool   `form:"CnamLookupEnabled,omitempty"`
	DisasterRecoveryMethod *string `form:"DisasterRecoveryMethod,omitempty"`
	DisasterRecoveryURL    *string `form:"DisasterRecoveryUrl,omitempty"`
	DomainName             *string `form:"DomainName,omitempty"`
	FriendlyName           *string `form:"FriendlyName,omitempty"`
	Secure                 *bool   `form:"Secure,omitempty"`
	TransferMode           *string `form:"TransferMode,omitempty"`
}

CreateTrunkInput defines the input fields for creating a new trunk resource

type CreateTrunkRecordingResponse

type CreateTrunkRecordingResponse struct {
	Mode string `json:"mode"`
	Trim string `json:"trim"`
}

type CreateTrunkResponse

type CreateTrunkResponse struct {
	AccountSid             string                       `json:"account_sid"`
	AuthType               *string                      `json:"auth_type,omitempty"`
	AuthTypeSet            *[]string                    `json:"auth_type_set,omitempty"`
	CnamLookupEnabled      bool                         `json:"cnam_lookup_enabled"`
	DateCreated            time.Time                    `json:"date_created"`
	DateUpdated            *time.Time                   `json:"date_updated,omitempty"`
	DisasterRecoveryMethod *string                      `json:"disaster_recovery_method,omitempty"`
	DisasterRecoveryURL    *string                      `json:"disaster_recovery_url,omitempty"`
	DomainName             *string                      `json:"domain_name,omitempty"`
	FriendlyName           *string                      `json:"friendly_name,omitempty"`
	Recording              CreateTrunkRecordingResponse `json:"recording"`
	Secure                 bool                         `json:"secure"`
	Sid                    string                       `json:"sid"`
	TransferMode           string                       `json:"transfer_mode"`
	URL                    string                       `json:"url"`
}

CreateTrunkResponse defines the response fields for the created trunk resource

type PageMetaResponse

type PageMetaResponse struct {
	FirstPageURL    string  `json:"first_page_url"`
	Key             string  `json:"key"`
	NextPageURL     *string `json:"next_page_url,omitempty"`
	Page            int     `json:"page"`
	PageSize        int     `json:"page_size"`
	PreviousPageURL *string `json:"previous_page_url,omitempty"`
	URL             string  `json:"url"`
}

type PageTrunkRecordingResponse

type PageTrunkRecordingResponse struct {
	Mode string `json:"mode"`
	Trim string `json:"trim"`
}

type PageTrunkResponse

type PageTrunkResponse struct {
	AccountSid             string                     `json:"account_sid"`
	AuthType               *string                    `json:"auth_type,omitempty"`
	AuthTypeSet            *[]string                  `json:"auth_type_set,omitempty"`
	CnamLookupEnabled      bool                       `json:"cnam_lookup_enabled"`
	DateCreated            time.Time                  `json:"date_created"`
	DateUpdated            *time.Time                 `json:"date_updated,omitempty"`
	DisasterRecoveryMethod *string                    `json:"disaster_recovery_method,omitempty"`
	DisasterRecoveryURL    *string                    `json:"disaster_recovery_url,omitempty"`
	DomainName             *string                    `json:"domain_name,omitempty"`
	FriendlyName           *string                    `json:"friendly_name,omitempty"`
	Recording              PageTrunkRecordingResponse `json:"recording"`
	Secure                 bool                       `json:"secure"`
	Sid                    string                     `json:"sid"`
	TransferMode           string                     `json:"transfer_mode"`
	URL                    string                     `json:"url"`
}

type TrunksPage

type TrunksPage struct {
	CurrentPage *TrunksPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type TrunksPageOptions

type TrunksPageOptions struct {
	PageSize  *int
	Page      *int
	PageToken *string
}

TrunksPageOptions defines the query options for the api operation

type TrunksPageResponse

type TrunksPageResponse struct {
	Meta   PageMetaResponse    `json:"meta"`
	Trunks []PageTrunkResponse `json:"trunks"`
}

TrunksPageResponse defines the response fields for the trunks page

type TrunksPaginator

type TrunksPaginator struct {
	Page   *TrunksPage
	Trunks []PageTrunkResponse
	// contains filtered or unexported fields
}

TrunksPaginator defines the fields for makings paginated api calls Trunks is an array of trunks that have been returned from all of the page calls

func (*TrunksPaginator) CurrentPage

func (p *TrunksPaginator) CurrentPage() *TrunksPageResponse

CurrentPage retrieves the results for the current page

func (*TrunksPaginator) Error

func (p *TrunksPaginator) Error() error

Error retrieves the error returned from the page

func (*TrunksPaginator) Next

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

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