plugin_configurations

Documentation

Overview

Package plugin_configurations contains auto-generated files. DO NOT MODIFY

Package plugin_configurations contains auto-generated files. DO NOT MODIFY

Package plugin_configurations contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client) *Client
  • func (c Client) Create(input *CreateConfigurationInput) (*CreateConfigurationResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateConfigurationInput) (*CreateConfigurationResponse, error)
  • func (c *Client) NewConfigurationsPaginator() *ConfigurationsPaginator
  • func (c *Client) NewConfigurationsPaginatorWithOptions(options *ConfigurationsPageOptions) *ConfigurationsPaginator
  • func (c Client) Page(options *ConfigurationsPageOptions) (*ConfigurationsPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *ConfigurationsPageOptions) (*ConfigurationsPageResponse, error)
• type ConfigurationsPage
• type ConfigurationsPageOptions
• type ConfigurationsPageResponse
• type ConfigurationsPaginator
  • func (p *ConfigurationsPaginator) CurrentPage() *ConfigurationsPageResponse
  • func (p *ConfigurationsPaginator) Error() error
  • func (p *ConfigurationsPaginator) Next() bool
  • func (p *ConfigurationsPaginator) NextWithContext(context context.Context) bool
• type CreateConfigurationInput
• type CreateConfigurationResponse
• type PageConfigurationResponse
• type PageMetaResponse

Types

type Client

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

Client for managing plugin configuration resources See https://www.twilio.com/docs/flex/developer/plugins/api/plugin-configuration for more details This client is currently in beta and subject to change. Please use with caution

func New

func New(client *client.Client) *Client

New creates a new instance of the plugin configurations client

func (Client) Create

func (c Client) Create(input *CreateConfigurationInput) (*CreateConfigurationResponse, error)

Create creates a new plugin configuration resource See https://www.twilio.com/docs/flex/developer/plugins/api/plugin-configuration#create-a-pluginconfiguration-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information This resource is currently in beta and subject to change. Please use with caution

func (Client) CreateWithContext

func (c Client) CreateWithContext(context context.Context, input *CreateConfigurationInput) (*CreateConfigurationResponse, error)

CreateWithContext creates a new plugin configuration resource See https://www.twilio.com/docs/flex/developer/plugins/api/plugin-configuration#create-a-pluginconfiguration-resource for more details This resource is currently in beta and subject to change. Please use with caution

func (*Client) NewConfigurationsPaginator

func (c *Client) NewConfigurationsPaginator() *ConfigurationsPaginator

NewConfigurationsPaginator creates a new instance of the paginator for Page.

func (*Client) NewConfigurationsPaginatorWithOptions

func (c *Client) NewConfigurationsPaginatorWithOptions(options *ConfigurationsPageOptions) *ConfigurationsPaginator

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

func (Client) Page

func (c Client) Page(options *ConfigurationsPageOptions) (*ConfigurationsPageResponse, error)

Page retrieves a page of plugin configuration resources See https://www.twilio.com/docs/flex/developer/plugins/api/plugin-configuration#read-multiple-pluginconfiguration-resources for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information This resource is currently in beta and subject to change. Please use with caution

func (Client) PageWithContext

func (c Client) PageWithContext(context context.Context, options *ConfigurationsPageOptions) (*ConfigurationsPageResponse, error)

PageWithContext retrieves a page of plugin configuration resources See https://www.twilio.com/docs/flex/developer/plugins/api/plugin-configuration#read-multiple-pluginconfiguration-resources for more details This resource is currently in beta and subject to change. Please use with caution

type ConfigurationsPage

type ConfigurationsPage struct {
	CurrentPage *ConfigurationsPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type ConfigurationsPageOptions

type ConfigurationsPageOptions struct {
	PageSize  *int
	Page      *int
	PageToken *string
}

ConfigurationsPageOptions defines the query options for the api operation

type ConfigurationsPageResponse

type ConfigurationsPageResponse struct {
	Configurations []PageConfigurationResponse `json:"configurations"`
	Meta           PageMetaResponse            `json:"meta"`
}

ConfigurationsPageResponse defines the response fields for the plugin configurations page

type ConfigurationsPaginator

type ConfigurationsPaginator struct {
	Page           *ConfigurationsPage
	Configurations []PageConfigurationResponse
	// contains filtered or unexported fields
}

ConfigurationsPaginator defines the fields for makings paginated api calls Configurations is an array of configurations that have been returned from all of the page calls

func (*ConfigurationsPaginator) CurrentPage

func (p *ConfigurationsPaginator) CurrentPage() *ConfigurationsPageResponse

CurrentPage retrieves the results for the current page

func (*ConfigurationsPaginator) Error

func (p *ConfigurationsPaginator) Error() error

Error retrieves the error returned from the page

func (*ConfigurationsPaginator) Next

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

func (p *ConfigurationsPaginator) 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 CreateConfigurationInput

type CreateConfigurationInput struct {
	Description *string   `form:"Description,omitempty"`
	Name        string    `validate:"required" form:"Name"`
	Plugins     *[]string `form:"Plugins,omitempty"`
}

CreateConfigurationInput defines the input fields for creating a new plugin configuration resource

type CreateConfigurationResponse

type CreateConfigurationResponse struct {
	AccountSid  string    `json:"account_sid"`
	Archived    bool      `json:"archived"`
	DateCreated time.Time `json:"date_created"`
	Description *string   `json:"description,omitempty"`
	Name        string    `json:"name"`
	Sid         string    `json:"sid"`
	URL         string    `json:"url"`
}

CreateConfigurationResponse defines the response fields for the created plugin configuration

type PageConfigurationResponse

type PageConfigurationResponse struct {
	AccountSid  string    `json:"account_sid"`
	Archived    bool      `json:"archived"`
	DateCreated time.Time `json:"date_created"`
	Description *string   `json:"description,omitempty"`
	Name        string    `json:"name"`
	Sid         string    `json:"sid"`
	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"`
}