fax

Documentation

Overview

This is an autogenerated file. DO NOT MODIFY

This is an autogenerated file. DO NOT MODIFY

This is an autogenerated file. DO NOT MODIFY

This is an autogenerated file. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Delete() error
  • func (c Client) DeleteWithContext(context context.Context) error
  • func (c Client) Fetch() (*FetchFaxResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchFaxResponse, error)
  • func (c Client) Update(input *UpdateFaxInput) (*UpdateFaxResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateFaxInput) (*UpdateFaxResponse, error)
• type ClientProperties
• type FetchFaxResponse
• type UpdateFaxInput
• type UpdateFaxResponse

Types

type Client

type Client struct {
	MediaFile  func(string) *media_file.Client
	MediaFiles *media_files.Client
	// contains filtered or unexported fields
}

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

func New

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

New creates a new instance of the fax client

func (Client) Delete

func (c Client) Delete() error

Delete removes a fax resource from the account See https://www.twilio.com/docs/fax/api/fax-resource#delete-a-fax-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) DeleteWithContext

func (c Client) DeleteWithContext(context context.Context) error

DeleteWithContext removes a fax resource from the account See https://www.twilio.com/docs/fax/api/fax-resource#delete-a-fax-resource for more details

func (Client) Fetch

func (c Client) Fetch() (*FetchFaxResponse, error)

Fetch retrieves a fax resource See https://www.twilio.com/docs/fax/api/fax-resource#fetch-a-fax-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) FetchWithContext

func (c Client) FetchWithContext(context context.Context) (*FetchFaxResponse, error)

FetchWithContext retrieves a fax resource See https://www.twilio.com/docs/fax/api/fax-resource#fetch-a-fax-resource for more details

func (Client) Update

func (c Client) Update(input *UpdateFaxInput) (*UpdateFaxResponse, error)

Update modifies a fax resource See https://www.twilio.com/docs/fax/api/fax-resource#update-a-fax-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) UpdateWithContext

func (c Client) UpdateWithContext(context context.Context, input *UpdateFaxInput) (*UpdateFaxResponse, error)

UpdateWithContext modifies a fax resource See https://www.twilio.com/docs/fax/api/fax-resource#update-a-fax-resource for more details

type ClientProperties

type ClientProperties struct {
	Sid string
}

ClientProperties are the properties required to manage the fax resources

type FetchFaxResponse

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

FetchFaxResponse defines the response fields for the retrieved fax

type UpdateFaxInput

type UpdateFaxInput struct {
	Status *string `form:"Status,omitempty"`
}

UpdateFaxInput defines input fields for updating an fax resource

type UpdateFaxResponse

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

UpdateFaxResponse defines the response fields for the updated fax