credential_lists

Documentation

Overview

Package credential_lists contains auto-generated files. DO NOT MODIFY

Package credential_lists contains auto-generated files. DO NOT MODIFY

Package credential_lists contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Create(input *CreateCredentialListInput) (*CreateCredentialListResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateCredentialListInput) (*CreateCredentialListResponse, error)
  • func (c *Client) NewCredentialListsPaginator() *CredentialListsPaginator
  • func (c *Client) NewCredentialListsPaginatorWithOptions(options *CredentialListsPageOptions) *CredentialListsPaginator
  • func (c Client) Page(options *CredentialListsPageOptions) (*CredentialListsPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *CredentialListsPageOptions) (*CredentialListsPageResponse, error)
• type ClientProperties
• type CreateCredentialListInput
• type CreateCredentialListResponse
• type CredentialListsPage
• type CredentialListsPageOptions
• type CredentialListsPageResponse
• type CredentialListsPaginator
  • func (p *CredentialListsPaginator) CurrentPage() *CredentialListsPageResponse
  • func (p *CredentialListsPaginator) Error() error
  • func (p *CredentialListsPaginator) Next() bool
  • func (p *CredentialListsPaginator) NextWithContext(context context.Context) bool
• type PageCredentialListResponse
• type PageMetaResponse

Types

type Client

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

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

func New

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

New creates a new instance of the credential lists client

func (Client) Create

func (c Client) Create(input *CreateCredentialListInput) (*CreateCredentialListResponse, error)

Create associates a credential list resource with the SIP trunk See https://www.twilio.com/docs/sip-trunking/api/credentiallist-resource#create-a-credentiallist-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 *CreateCredentialListInput) (*CreateCredentialListResponse, error)

CreateWithContext associates a credential list resource with the SIP trunk See https://www.twilio.com/docs/sip-trunking/api/credentiallist-resource#create-a-credentiallist-resource for more details

func (*Client) NewCredentialListsPaginator

func (c *Client) NewCredentialListsPaginator() *CredentialListsPaginator

NewCredentialListsPaginator creates a new instance of the paginator for Page.

func (*Client) NewCredentialListsPaginatorWithOptions

func (c *Client) NewCredentialListsPaginatorWithOptions(options *CredentialListsPageOptions) *CredentialListsPaginator

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

func (Client) Page

func (c Client) Page(options *CredentialListsPageOptions) (*CredentialListsPageResponse, error)

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

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

type ClientProperties

type ClientProperties struct {
	TrunkSid string
}

ClientProperties are the properties required to manage the credential lists resources

type CreateCredentialListInput

type CreateCredentialListInput struct {
	CredentialListSid string `validate:"required" form:"CredentialListSid"`
}

CreateCredentialListInput defines the input fields for creating a new credential list resource

type CreateCredentialListResponse

type CreateCredentialListResponse struct {
	AccountSid   string     `json:"account_sid"`
	DateCreated  time.Time  `json:"date_created"`
	DateUpdated  *time.Time `json:"date_updated,omitempty"`
	FriendlyName string     `json:"friendly_name"`
	Sid          string     `json:"sid"`
	TrunkSid     string     `json:"trunk_sid"`
	URL          string     `json:"url"`
}

CreateCredentialListResponse defines the response fields for the created credential list resource

type CredentialListsPage

type CredentialListsPage struct {
	CurrentPage *CredentialListsPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type CredentialListsPageOptions

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

CredentialListsPageOptions defines the query options for the api operation

type CredentialListsPageResponse

type CredentialListsPageResponse struct {
	CredentialLists []PageCredentialListResponse `json:"credential_lists"`
	Meta            PageMetaResponse             `json:"meta"`
}

CredentialListsPageResponse defines the response fields for the credential lists page

type CredentialListsPaginator

type CredentialListsPaginator struct {
	Page            *CredentialListsPage
	CredentialLists []PageCredentialListResponse
	// contains filtered or unexported fields
}

CredentialListsPaginator defines the fields for makings paginated api calls CredentialLists is an array of credentiallists that have been returned from all of the page calls

func (*CredentialListsPaginator) CurrentPage

func (p *CredentialListsPaginator) CurrentPage() *CredentialListsPageResponse

CurrentPage retrieves the results for the current page

func (*CredentialListsPaginator) Error

func (p *CredentialListsPaginator) Error() error

Error retrieves the error returned from the page

func (*CredentialListsPaginator) Next

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

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

type PageCredentialListResponse struct {
	AccountSid   string     `json:"account_sid"`
	DateCreated  time.Time  `json:"date_created"`
	DateUpdated  *time.Time `json:"date_updated,omitempty"`
	FriendlyName string     `json:"friendly_name"`
	Sid          string     `json:"sid"`
	TrunkSid     string     `json:"trunk_sid"`
	URL          string     `json:"url"`
}

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"`
}