faxes

Documentation

Overview

Package faxes contains auto-generated files. DO NOT MODIFY

Package faxes contains auto-generated files. DO NOT MODIFY

Package faxes contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client) *Client
  • func (c Client) Create(input *CreateFaxInput) (*CreateFaxResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateFaxInput) (*CreateFaxResponse, error)
  • func (c *Client) NewFaxesPaginator() *FaxesPaginator
  • func (c *Client) NewFaxesPaginatorWithOptions(options *FaxesPageOptions) *FaxesPaginator
  • func (c Client) Page(options *FaxesPageOptions) (*FaxesPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *FaxesPageOptions) (*FaxesPageResponse, error)
• type CreateFaxInput
• type CreateFaxResponse
• type FaxesPage
• type FaxesPageOptions
• type FaxesPageResponse
• type FaxesPaginator
  • func (p *FaxesPaginator) CurrentPage() *FaxesPageResponse
  • func (p *FaxesPaginator) Error() error
  • func (p *FaxesPaginator) Next() bool
  • func (p *FaxesPaginator) NextWithContext(context context.Context) bool
• type PageFaxResponse
• type PageMetaResponse

Types

type Client

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

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

func New

func New(client *client.Client) *Client

New creates a new instance of the faxes client

func (Client) Create

func (c Client) Create(input *CreateFaxInput) (*CreateFaxResponse, error)

Create creates a new fax See https://www.twilio.com/docs/fax/api/fax-resource#create-a-fax-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 *CreateFaxInput) (*CreateFaxResponse, error)

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

func (*Client) NewFaxesPaginator

func (c *Client) NewFaxesPaginator() *FaxesPaginator

NewFaxesPaginator creates a new instance of the paginator for Page.

func (*Client) NewFaxesPaginatorWithOptions

func (c *Client) NewFaxesPaginatorWithOptions(options *FaxesPageOptions) *FaxesPaginator

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

func (Client) Page

func (c Client) Page(options *FaxesPageOptions) (*FaxesPageResponse, error)

Page retrieves a page of faxes See https://www.twilio.com/docs/fax/api/fax-resource#read-multiple-fax-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 *FaxesPageOptions) (*FaxesPageResponse, error)

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

type CreateFaxInput

type CreateFaxInput struct {
	From            *string `form:"From,omitempty"`
	MediaURL        string  `validate:"required" form:"MediaUrl"`
	Quality         *string `form:"Quality,omitempty"`
	SipAuthPassword *string `form:"SipAuthPassword,omitempty"`
	SipAuthUsername *string `form:"SipAuthUsername,omitempty"`
	StatusCallback  *string `form:"StatusCallback,omitempty"`
	StoreMedia      *bool   `form:"StoreMedia,omitempty"`
	To              string  `validate:"required" form:"To"`
	Ttl             *int    `form:"Ttl,omitempty"`
}

CreateFaxInput defines the input fields for creating a new fax resource

type CreateFaxResponse

type CreateFaxResponse struct {
	APIVersion  string     `json:"api_version"`
	AccountSid  string     `json:"account_sid"`
	DateCreated time.Time  `json:"date_created"`
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	Direction   string     `json:"direction"`
	Duration    *int       `json:"duration,omitempty"`
	From        string     `json:"from"`
	MediaSid    *string    `json:"media_sid,omitempty"`
	MediaURL    *string    `json:"media_url,omitempty"`
	NumPages    *int       `json:"num_pages,omitempty"`
	Price       *string    `json:"price,omitempty"`
	PriceUnit   *string    `json:"price_unit,omitempty"`
	Quality     string     `json:"quality"`
	Sid         string     `json:"sid"`
	Status      string     `json:"status"`
	To          string     `json:"to"`
	URL         string     `json:"url"`
}

CreateFaxResponse defines the response fields for the created fax

type FaxesPage

type FaxesPage struct {
	CurrentPage *FaxesPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type FaxesPageOptions

type FaxesPageOptions struct {
	PageSize              *int
	Page                  *int
	PageToken             *string
	From                  *string
	To                    *string
	DateCreatedOnOrBefore *time.Time
	DateCreatedAfters     *time.Time
}

FaxesPageOptions defines the query options for the api operation

type FaxesPageResponse

type FaxesPageResponse struct {
	Faxes []PageFaxResponse `json:"faxes"`
	Meta  PageMetaResponse  `json:"meta"`
}

FaxesPageResponse defines the response fields for the faxes page

type FaxesPaginator

type FaxesPaginator struct {
	Page  *FaxesPage
	Faxes []PageFaxResponse
	// contains filtered or unexported fields
}

FaxesPaginator defines the fields for makings paginated api calls Faxes is an array of faxes that have been returned from all of the page calls

func (*FaxesPaginator) CurrentPage

func (p *FaxesPaginator) CurrentPage() *FaxesPageResponse

CurrentPage retrieves the results for the current page

func (*FaxesPaginator) Error

func (p *FaxesPaginator) Error() error

Error retrieves the error returned from the page

func (*FaxesPaginator) Next

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

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

type PageFaxResponse struct {
	APIVersion  string     `json:"api_version"`
	AccountSid  string     `json:"account_sid"`
	DateCreated time.Time  `json:"date_created"`
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	Direction   string     `json:"direction"`
	Duration    *int       `json:"duration,omitempty"`
	From        string     `json:"from"`
	MediaSid    *string    `json:"media_sid,omitempty"`
	MediaURL    *string    `json:"media_url,omitempty"`
	NumPages    *int       `json:"num_pages,omitempty"`
	Price       *string    `json:"price,omitempty"`
	PriceUnit   *string    `json:"price_unit,omitempty"`
	Quality     string     `json:"quality"`
	Sid         string     `json:"sid"`
	Status      string     `json:"status"`
	To          string     `json:"to"`
	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"`
}