media_file

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

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() (*FetchMediaResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchMediaResponse, error)
• type ClientProperties
• type FetchMediaResponse

Types

type Client

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

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

func New

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

New creates a new instance of the media file client

func (Client) Delete

func (c Client) Delete() error

Delete removes a media resource from the account See https://www.twilio.com/docs/fax/api/fax-media-resource#delete-a-fax-media-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 media resource from the account See https://www.twilio.com/docs/fax/api/fax-media-resource#delete-a-fax-media-resource for more details

func (Client) Fetch

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

Fetch retrieves a media resource See https://www.twilio.com/docs/fax/api/fax-media-resource#fetch-a-fax-media-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) (*FetchMediaResponse, error)

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

type ClientProperties

type ClientProperties struct {
	FaxSid string
	Sid    string
}

ClientProperties are the properties required to manage the media file resources

type FetchMediaResponse

type FetchMediaResponse struct {
	AccountSid  string     `json:"account_sid"`
	ContentType string     `json:"content_type"`
	DateCreated time.Time  `json:"date_created"`
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	FaxSid      string     `json:"fax_sid"`
	Sid         string     `json:"sid"`
	URL         string     `json:"url"`
}

FetchMediaResponse defines the response fields for the retrieved media