messaging_configurations

Documentation

Overview

Package messaging_configurations contains auto-generated files. DO NOT MODIFY

Package messaging_configurations contains auto-generated files. DO NOT MODIFY

Package messaging_configurations contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Create(input *CreateMessagingConfigurationInput) (*CreateMessagingConfigurationResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateMessagingConfigurationInput) (*CreateMessagingConfigurationResponse, error)
  • func (c *Client) NewMessagingConfigurationsPaginator() *MessagingConfigurationsPaginator
  • func (c *Client) NewMessagingConfigurationsPaginatorWithOptions(options *MessagingConfigurationsPageOptions) *MessagingConfigurationsPaginator
  • func (c Client) Page(options *MessagingConfigurationsPageOptions) (*MessagingConfigurationsPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *MessagingConfigurationsPageOptions) (*MessagingConfigurationsPageResponse, error)
• type ClientProperties
• type CreateMessagingConfigurationInput
• type CreateMessagingConfigurationResponse
• type MessagingConfigurationsPage
• type MessagingConfigurationsPageOptions
• type MessagingConfigurationsPageResponse
• type MessagingConfigurationsPaginator
  • func (p *MessagingConfigurationsPaginator) CurrentPage() *MessagingConfigurationsPageResponse
  • func (p *MessagingConfigurationsPaginator) Error() error
  • func (p *MessagingConfigurationsPaginator) Next() bool
  • func (p *MessagingConfigurationsPaginator) NextWithContext(context context.Context) bool
• type PageMessagingConfigurationResponse
• type PageMetaResponse

Types

type Client

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

Client for managing messaging configuration resources

func New

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

New creates a new instance of the messaging configurations client

func (Client) Create

func (c Client) Create(input *CreateMessagingConfigurationInput) (*CreateMessagingConfigurationResponse, error)

Create creates a new messaging configuration 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 *CreateMessagingConfigurationInput) (*CreateMessagingConfigurationResponse, error)

CreateWithContext creates a new messaging configuration

func (*Client) NewMessagingConfigurationsPaginator

func (c *Client) NewMessagingConfigurationsPaginator() *MessagingConfigurationsPaginator

NewMessagingConfigurationsPaginator creates a new instance of the paginator for Page.

func (*Client) NewMessagingConfigurationsPaginatorWithOptions

func (c *Client) NewMessagingConfigurationsPaginatorWithOptions(options *MessagingConfigurationsPageOptions) *MessagingConfigurationsPaginator

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

func (Client) Page

func (c Client) Page(options *MessagingConfigurationsPageOptions) (*MessagingConfigurationsPageResponse, error)

Page retrieves a page of messaging configuration 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 *MessagingConfigurationsPageOptions) (*MessagingConfigurationsPageResponse, error)

PageWithContext retrieves a page of messaging configuration

type ClientProperties

type ClientProperties struct {
	ServiceSid string
}

ClientProperties are the properties required to manage the messaging configurations resources

type CreateMessagingConfigurationInput

type CreateMessagingConfigurationInput struct {
	Country             string `validate:"required" form:"Country"`
	MessagingServiceSid string `validate:"required" form:"MessagingServiceSid"`
}

CreateMessagingConfigurationInput defines the input fields for creating a new messaging configuration

type CreateMessagingConfigurationResponse

type CreateMessagingConfigurationResponse struct {
	AccountSid          string     `json:"account_sid"`
	Country             string     `json:"country"`
	DateCreated         time.Time  `json:"date_created"`
	DateUpdated         *time.Time `json:"date_updated,omitempty"`
	MessagingServiceSid string     `json:"messaging_service_sid"`
	ServiceSid          string     `json:"service_sid"`
	URL                 string     `json:"url"`
}

CreateMessagingConfigurationResponse defines the response fields for the created messaging configuration

type MessagingConfigurationsPage

type MessagingConfigurationsPage struct {
	CurrentPage *MessagingConfigurationsPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type MessagingConfigurationsPageOptions

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

MessagingConfigurationsPageOptions defines the query options for the api operation

type MessagingConfigurationsPageResponse

type MessagingConfigurationsPageResponse struct {
	MessagingConfigurations []PageMessagingConfigurationResponse `json:"messaging_configurations"`
	Meta                    PageMetaResponse                     `json:"meta"`
}

MessagingConfigurationsPageResponse defines the response fields for the messaging configuration page

type MessagingConfigurationsPaginator

type MessagingConfigurationsPaginator struct {
	Page                    *MessagingConfigurationsPage
	MessagingConfigurations []PageMessagingConfigurationResponse
	// contains filtered or unexported fields
}

MessagingConfigurationsPaginator defines the fields for makings paginated api calls MessagingConfigurations is an array of messagingconfigurations that have been returned from all of the page calls

func (*MessagingConfigurationsPaginator) CurrentPage

func (p *MessagingConfigurationsPaginator) CurrentPage() *MessagingConfigurationsPageResponse

CurrentPage retrieves the results for the current page

func (*MessagingConfigurationsPaginator) Error

func (p *MessagingConfigurationsPaginator) Error() error

Error retrieves the error returned from the page

func (*MessagingConfigurationsPaginator) Next

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

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

type PageMessagingConfigurationResponse struct {
	AccountSid          string     `json:"account_sid"`
	Country             string     `json:"country"`
	DateCreated         time.Time  `json:"date_created"`
	DateUpdated         *time.Time `json:"date_updated,omitempty"`
	MessagingServiceSid string     `json:"messaging_service_sid"`
	ServiceSid          string     `json:"service_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"`
}