channel

Documentation

Overview

Package channel contains auto-generated files. DO NOT MODIFY

Package channel contains auto-generated files. DO NOT MODIFY

Package channel contains auto-generated files. 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() (*FetchChannelResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchChannelResponse, error)
• type ClientProperties
• type FetchChannelResponse

Types

type Client

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

Client for managing a specific channel resource

func New

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

New creates a new instance of the channel client

func (Client) Delete

func (c Client) Delete() error

Delete removes a channel resource from the account 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 channel resource from the account

func (Client) Fetch

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

Fetch retrieves a channel resource 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) (*FetchChannelResponse, error)

FetchWithContext retrieves a channel resource

type ClientProperties

type ClientProperties struct {
	Sid string
}

ClientProperties are the properties required to manage the channel resources

type FetchChannelResponse

type FetchChannelResponse struct {
	AccountSid  string     `json:"account_sid"`
	DateCreated time.Time  `json:"date_created"`
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	FlexFlowSid string     `json:"flex_flow_sid"`
	Sid         string     `json:"sid"`
	TaskSid     *string    `json:"task_sid,omitempty"`
	URL         string     `json:"url"`
	UserSid     string     `json:"user_sid"`
}

FetchChannelResponse defines the response fields for the retrieved channel