alpha_senders

Documentation

Overview

Package alpha_senders contains auto-generated files. DO NOT MODIFY

Package alpha_senders contains auto-generated files. DO NOT MODIFY

Package alpha_senders contains auto-generated files. DO NOT MODIFY

Index

• type AlphaSendersPage
• type AlphaSendersPageOptions
• type AlphaSendersPageResponse
• type AlphaSendersPaginator
  • func (p *AlphaSendersPaginator) CurrentPage() *AlphaSendersPageResponse
  • func (p *AlphaSendersPaginator) Error() error
  • func (p *AlphaSendersPaginator) Next() bool
  • func (p *AlphaSendersPaginator) NextWithContext(context context.Context) bool
• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Create(input *CreateAlphaSenderInput) (*CreateAlphaSenderResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateAlphaSenderInput) (*CreateAlphaSenderResponse, error)
  • func (c *Client) NewAlphaSendersPaginator() *AlphaSendersPaginator
  • func (c *Client) NewAlphaSendersPaginatorWithOptions(options *AlphaSendersPageOptions) *AlphaSendersPaginator
  • func (c Client) Page(options *AlphaSendersPageOptions) (*AlphaSendersPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *AlphaSendersPageOptions) (*AlphaSendersPageResponse, error)
• type ClientProperties
• type CreateAlphaSenderInput
• type CreateAlphaSenderResponse
• type PageAlphaSenderResponse
• type PageMetaResponse

Types

type AlphaSendersPage

type AlphaSendersPage struct {
	CurrentPage *AlphaSendersPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type AlphaSendersPageOptions

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

AlphaSendersPageOptions defines the query options for the api operation

type AlphaSendersPageResponse

type AlphaSendersPageResponse struct {
	AlphaSenders []PageAlphaSenderResponse `json:"alpha_senders"`
	Meta         PageMetaResponse          `json:"meta"`
}

AlphaSendersPageResponse defines the response fields for the alpha senders page

type AlphaSendersPaginator

type AlphaSendersPaginator struct {
	Page         *AlphaSendersPage
	AlphaSenders []PageAlphaSenderResponse
	// contains filtered or unexported fields
}

AlphaSendersPaginator defines the fields for makings paginated api calls AlphaSenders is an array of alphasenders that have been returned from all of the page calls

func (*AlphaSendersPaginator) CurrentPage

func (p *AlphaSendersPaginator) CurrentPage() *AlphaSendersPageResponse

CurrentPage retrieves the results for the current page

func (*AlphaSendersPaginator) Error

func (p *AlphaSendersPaginator) Error() error

Error retrieves the error returned from the page

func (*AlphaSendersPaginator) Next

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

func (p *AlphaSendersPaginator) 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 alpha sender resources See https://www.twilio.com/docs/sms/services/api/alphasender-resource for more details

func New

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

New creates a new instance of the alphasenders client

func (Client) Create

func (c Client) Create(input *CreateAlphaSenderInput) (*CreateAlphaSenderResponse, error)

Create creates a new alpha sender See https://www.twilio.com/docs/sms/services/api/alphasender-resource#create-an-alphasender-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 *CreateAlphaSenderInput) (*CreateAlphaSenderResponse, error)

CreateWithContext creates a new alpha sender See https://www.twilio.com/docs/sms/services/api/alphasender-resource#create-an-alphasender-resource for more details

func (*Client) NewAlphaSendersPaginator

func (c *Client) NewAlphaSendersPaginator() *AlphaSendersPaginator

NewAlphaSendersPaginator creates a new instance of the paginator for Page.

func (*Client) NewAlphaSendersPaginatorWithOptions

func (c *Client) NewAlphaSendersPaginatorWithOptions(options *AlphaSendersPageOptions) *AlphaSendersPaginator

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

func (Client) Page

func (c Client) Page(options *AlphaSendersPageOptions) (*AlphaSendersPageResponse, error)

Page retrieves a page of alpha senders See https://www.twilio.com/docs/sms/services/api/alphasender-resource#read-multiple-alphasender-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 *AlphaSendersPageOptions) (*AlphaSendersPageResponse, error)

PageWithContext retrieves a page of alpha senders See https://www.twilio.com/docs/sms/services/api/alphasender-resource#read-multiple-alphasender-resources for more details

type ClientProperties

type ClientProperties struct {
	ServiceSid string
}

ClientProperties are the properties required to manage the alphasenders resources

type CreateAlphaSenderInput

type CreateAlphaSenderInput struct {
	AlphaSender string `validate:"required" form:"AlphaSender"`
}

CreateAlphaSenderInput defines the input fields for creating a new alpha sender resource

type CreateAlphaSenderResponse

type CreateAlphaSenderResponse struct {
	AccountSid   string     `json:"account_sid"`
	AlphaSender  string     `json:"alpha_sender"`
	Capabilities []string   `json:"capabilities"`
	DateCreated  time.Time  `json:"date_created"`
	DateUpdated  *time.Time `json:"date_updated,omitempty"`
	ServiceSid   string     `json:"service_sid"`
	Sid          string     `json:"sid"`
	URL          string     `json:"url"`
}

CreateAlphaSenderResponse defines the response fields for the created alpha sender

type PageAlphaSenderResponse

type PageAlphaSenderResponse struct {
	AccountSid   string     `json:"account_sid"`
	AlphaSender  string     `json:"alpha_sender"`
	Capabilities []string   `json:"capabilities"`
	DateCreated  time.Time  `json:"date_created"`
	DateUpdated  *time.Time `json:"date_updated,omitempty"`
	ServiceSid   string     `json:"service_sid"`
	Sid          string     `json:"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"`
}