credential_list_mappings

Documentation

Overview

Package credential_list_mappings contains auto-generated files. DO NOT MODIFY

Package credential_list_mappings contains auto-generated files. DO NOT MODIFY

Package credential_list_mappings contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Create(input *CreateCredentialListMappingInput) (*CreateCredentialListMappingResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateCredentialListMappingInput) (*CreateCredentialListMappingResponse, error)
  • func (c *Client) NewCredentialListMappingsPaginator() *CredentialListMappingsPaginator
  • func (c *Client) NewCredentialListMappingsPaginatorWithOptions(options *CredentialListMappingsPageOptions) *CredentialListMappingsPaginator
  • func (c Client) Page(options *CredentialListMappingsPageOptions) (*CredentialListMappingsPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *CredentialListMappingsPageOptions) (*CredentialListMappingsPageResponse, error)
• type ClientProperties
• type CreateCredentialListMappingInput
• type CreateCredentialListMappingResponse
• type CredentialListMappingsPage
• type CredentialListMappingsPageOptions
• type CredentialListMappingsPageResponse
• type CredentialListMappingsPaginator
  • func (p *CredentialListMappingsPaginator) CurrentPage() *CredentialListMappingsPageResponse
  • func (p *CredentialListMappingsPaginator) Error() error
  • func (p *CredentialListMappingsPaginator) Next() bool
  • func (p *CredentialListMappingsPaginator) NextWithContext(context context.Context) bool
• type PageCredentialListMappingResponse

Types

type Client

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

Client for managing credential list mapping resources

func New

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

New creates a new instance of the credential list mappings client

func (Client) Create

func (c Client) Create(input *CreateCredentialListMappingInput) (*CreateCredentialListMappingResponse, error)

Create creates a credential list mapping resource See https://www.twilio.com/docs/voice/sip/api/sip-credentiallistmapping-resource#create-a-sip-credentiallistmapping-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 *CreateCredentialListMappingInput) (*CreateCredentialListMappingResponse, error)

CreateWithContext creates a credential list mapping resource See https://www.twilio.com/docs/voice/sip/api/sip-credentiallistmapping-resource#create-a-sip-credentiallistmapping-resource for more details

func (*Client) NewCredentialListMappingsPaginator

func (c *Client) NewCredentialListMappingsPaginator() *CredentialListMappingsPaginator

NewCredentialListMappingsPaginator creates a new instance of the paginator for Page.

func (*Client) NewCredentialListMappingsPaginatorWithOptions

func (c *Client) NewCredentialListMappingsPaginatorWithOptions(options *CredentialListMappingsPageOptions) *CredentialListMappingsPaginator

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

func (Client) Page

func (c Client) Page(options *CredentialListMappingsPageOptions) (*CredentialListMappingsPageResponse, error)

Page retrieves a page of credential list mappings See https://www.twilio.com/docs/voice/sip/api/sip-credentiallistmapping-resource#read-multiple-sip-credentiallistmapping-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 *CredentialListMappingsPageOptions) (*CredentialListMappingsPageResponse, error)

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

type ClientProperties

type ClientProperties struct {
	AccountSid string
	DomainSid  string
}

ClientProperties are the properties required to manage the credential list mappings resources

type CreateCredentialListMappingInput

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

CreateCredentialListMappingInput defines input fields for creating a new credential list mapping

type CreateCredentialListMappingResponse

type CreateCredentialListMappingResponse struct {
	AccountSid   string             `json:"account_sid"`
	DateCreated  utils.RFC2822Time  `json:"date_created"`
	DateUpdated  *utils.RFC2822Time `json:"date_updated,omitempty"`
	FriendlyName string             `json:"friendly_name"`
	Sid          string             `json:"sid"`
}

CreateCredentialListMappingResponse defines the response fields for creating a new credential list mapping

type CredentialListMappingsPage

type CredentialListMappingsPage struct {
	CurrentPage *CredentialListMappingsPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type CredentialListMappingsPageOptions

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

CredentialListMappingsPageOptions defines the query options for the api operation

type CredentialListMappingsPageResponse

type CredentialListMappingsPageResponse struct {
	CredentialListMappings []PageCredentialListMappingResponse `json:"contents"`
	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"`
}

CredentialListMappingsPageResponse defines the response fields for the credential list mapping page

type CredentialListMappingsPaginator

type CredentialListMappingsPaginator struct {
	Page                   *CredentialListMappingsPage
	CredentialListMappings []PageCredentialListMappingResponse
	// contains filtered or unexported fields
}

CredentialListMappingsPaginator defines the fields for makings paginated api calls CredentialListMappings is an array of credentiallistmappings that have been returned from all of the page calls

func (*CredentialListMappingsPaginator) CurrentPage

func (p *CredentialListMappingsPaginator) CurrentPage() *CredentialListMappingsPageResponse

CurrentPage retrieves the results for the current page

func (*CredentialListMappingsPaginator) Error

func (p *CredentialListMappingsPaginator) Error() error

Error retrieves the error returned from the page

func (*CredentialListMappingsPaginator) Next

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

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

type PageCredentialListMappingResponse struct {
	AccountSid   string             `json:"account_sid"`
	DateCreated  utils.RFC2822Time  `json:"date_created"`
	DateUpdated  *utils.RFC2822Time `json:"date_updated,omitempty"`
	FriendlyName string             `json:"friendly_name"`
	Sid          string             `json:"sid"`
}