plugin

Documentation

Overview

Package plugin contains auto-generated files. DO NOT MODIFY

Package plugin contains auto-generated files. DO NOT MODIFY

Package plugin contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Fetch() (*FetchPluginResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchPluginResponse, error)
  • func (c Client) Update(input *UpdatePluginInput) (*UpdatePluginResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdatePluginInput) (*UpdatePluginResponse, error)
• type ClientProperties
• type FetchPluginResponse
• type UpdatePluginInput
• type UpdatePluginResponse

Types

type Client

type Client struct {
	Version  func(string) *version.Client
	Versions *versions.Client
	// contains filtered or unexported fields
}

Client for managing a specific plugin resource See https://www.twilio.com/docs/flex/developer/plugins/api/plugin for more details

func New

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

New creates a new instance of the plugin client

func (Client) Fetch

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

Fetch retrieves a plugin resource See https://www.twilio.com/docs/flex/developer/plugins/api/plugin#fetch-a-plugin-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) (*FetchPluginResponse, error)

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

func (Client) Update

func (c Client) Update(input *UpdatePluginInput) (*UpdatePluginResponse, error)

Update modifies a plugin resource See https://www.twilio.com/docs/flex/developer/plugins/api/plugin#update-a-plugin-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 *UpdatePluginInput) (*UpdatePluginResponse, error)

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

type ClientProperties

type ClientProperties struct {
	Sid string
}

ClientProperties are the properties required to manage the plugin resources

type FetchPluginResponse

type FetchPluginResponse struct {
	AccountSid   string     `json:"account_sid"`
	DateCreated  time.Time  `json:"date_created"`
	DateUpdated  *time.Time `json:"date_updated,omitempty"`
	Description  *string    `json:"description,omitempty"`
	Disabled     bool       `json:"disabled"`
	FriendlyName string     `json:"friendly_name"`
	Sid          string     `json:"sid"`
	URL          string     `json:"url"`
	UniqueName   string     `json:"unique_name"`
}

FetchPluginResponse defines the response fields for the retrieved plugin resource

type UpdatePluginInput

type UpdatePluginInput struct {
	Description  *string `form:"Description,omitempty"`
	FriendlyName *string `form:"FriendlyName,omitempty"`
}

UpdatePluginInput defines input fields for updating a plugin resource

type UpdatePluginResponse

type UpdatePluginResponse struct {
	AccountSid   string     `json:"account_sid"`
	DateCreated  time.Time  `json:"date_created"`
	DateUpdated  *time.Time `json:"date_updated,omitempty"`
	Description  *string    `json:"description,omitempty"`
	Disabled     bool       `json:"disabled"`
	FriendlyName string     `json:"friendly_name"`
	Sid          string     `json:"sid"`
	URL          string     `json:"url"`
	UniqueName   string     `json:"unique_name"`
}

UpdatePluginResponse defines the response fields for the updated plugin