versions

Documentation

Overview

Package versions contains auto-generated files. DO NOT MODIFY

Package versions contains auto-generated files. DO NOT MODIFY

Package versions contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Create(input *CreateVersionInput) (*CreateVersionResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateVersionInput) (*CreateVersionResponse, error)
  • func (c *Client) NewVersionsPaginator() *VersionsPaginator
  • func (c *Client) NewVersionsPaginatorWithOptions(options *VersionsPageOptions) *VersionsPaginator
  • func (c Client) Page(options *VersionsPageOptions) (*VersionsPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *VersionsPageOptions) (*VersionsPageResponse, error)
• type ClientProperties
• type CreateVersionInput
• type CreateVersionResponse
• type PageMetaResponse
• type PageVersionResponse
• type VersionsPage
• type VersionsPageOptions
• type VersionsPageResponse
• type VersionsPaginator
  • func (p *VersionsPaginator) CurrentPage() *VersionsPageResponse
  • func (p *VersionsPaginator) Error() error
  • func (p *VersionsPaginator) Next() bool
  • func (p *VersionsPaginator) NextWithContext(context context.Context) bool

Types

type Client

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

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

func New

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

New creates a new instance of the versions client

func (Client) Create

func (c Client) Create(input *CreateVersionInput) (*CreateVersionResponse, error)

Create creates a new plugin version resource See https://www.twilio.com/docs/flex/developer/plugins/api/plugin-version#create-a-pluginversion-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 *CreateVersionInput) (*CreateVersionResponse, error)

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

func (*Client) NewVersionsPaginator

func (c *Client) NewVersionsPaginator() *VersionsPaginator

NewVersionsPaginator creates a new instance of the paginator for Page.

func (*Client) NewVersionsPaginatorWithOptions

func (c *Client) NewVersionsPaginatorWithOptions(options *VersionsPageOptions) *VersionsPaginator

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

func (Client) Page

func (c Client) Page(options *VersionsPageOptions) (*VersionsPageResponse, error)

Page retrieves a page of plugin versions See https://www.twilio.com/docs/flex/developer/plugins/api/plugin-version#read-multiple-pluginversion-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 *VersionsPageOptions) (*VersionsPageResponse, error)

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

type ClientProperties

type ClientProperties struct {
	PluginSid string
}

ClientProperties are the properties required to manage the versions resources

type CreateVersionInput

type CreateVersionInput struct {
	Changelog *string `form:"Changelog,omitempty"`
	PluginURL string  `validate:"required" form:"PluginUrl"`
	Private   *bool   `form:"Private,omitempty"`
	Version   string  `validate:"required" form:"Version"`
}

CreateVersionInput defines the input fields for creating a new plugin version resource

type CreateVersionResponse

type CreateVersionResponse struct {
	AccountSid  string    `json:"account_sid"`
	Archived    bool      `json:"archived"`
	Changelog   *string   `json:"changelog,omitempty"`
	DateCreated time.Time `json:"date_created"`
	PluginSid   string    `json:"plugin_sid"`
	PluginURL   string    `json:"plugin_url"`
	Private     bool      `json:"private"`
	Sid         string    `json:"sid"`
	URL         string    `json:"url"`
	Version     string    `json:"version"`
}

CreateVersionResponse defines the response fields for the created plugin version

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

type PageVersionResponse

type PageVersionResponse struct {
	AccountSid  string    `json:"account_sid"`
	Archived    bool      `json:"archived"`
	Changelog   *string   `json:"changelog,omitempty"`
	DateCreated time.Time `json:"date_created"`
	PluginSid   string    `json:"plugin_sid"`
	PluginURL   string    `json:"plugin_url"`
	Private     bool      `json:"private"`
	Sid         string    `json:"sid"`
	URL         string    `json:"url"`
	Version     string    `json:"version"`
}

type VersionsPage

type VersionsPage struct {
	CurrentPage *VersionsPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type VersionsPageOptions

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

VersionsPageOptions defines the query options for the api operation

type VersionsPageResponse

type VersionsPageResponse struct {
	Meta     PageMetaResponse      `json:"meta"`
	Versions []PageVersionResponse `json:"plugin_versions"`
}

VersionsPageResponse defines the response fields for the plugin versions page

type VersionsPaginator

type VersionsPaginator struct {
	Page     *VersionsPage
	Versions []PageVersionResponse
	// contains filtered or unexported fields
}

VersionsPaginator defines the fields for makings paginated api calls Versions is an array of versions that have been returned from all of the page calls

func (*VersionsPaginator) CurrentPage

func (p *VersionsPaginator) CurrentPage() *VersionsPageResponse

CurrentPage retrieves the results for the current page

func (*VersionsPaginator) Error

func (p *VersionsPaginator) Error() error

Error retrieves the error returned from the page

func (*VersionsPaginator) Next

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

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