plugin_releases

Documentation

Overview

Package plugin_releases contains auto-generated files. DO NOT MODIFY

Package plugin_releases contains auto-generated files. DO NOT MODIFY

Package plugin_releases contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client) *Client
  • func (c Client) Create(input *CreateReleaseInput) (*CreateReleaseResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateReleaseInput) (*CreateReleaseResponse, error)
  • func (c *Client) NewReleasesPaginator() *ReleasesPaginator
  • func (c *Client) NewReleasesPaginatorWithOptions(options *ReleasesPageOptions) *ReleasesPaginator
  • func (c Client) Page(options *ReleasesPageOptions) (*ReleasesPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *ReleasesPageOptions) (*ReleasesPageResponse, error)
• type CreateReleaseInput
• type CreateReleaseResponse
• type PageMetaResponse
• type PageReleaseResponse
• type ReleasesPage
• type ReleasesPageOptions
• type ReleasesPageResponse
• type ReleasesPaginator
  • func (p *ReleasesPaginator) CurrentPage() *ReleasesPageResponse
  • func (p *ReleasesPaginator) Error() error
  • func (p *ReleasesPaginator) Next() bool
  • func (p *ReleasesPaginator) NextWithContext(context context.Context) bool

Types

type Client

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

Client for managing plugin release resources See https://www.twilio.com/docs/flex/developer/plugins/api/release 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 releases client

func (Client) Create

func (c Client) Create(input *CreateReleaseInput) (*CreateReleaseResponse, error)

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

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

func (*Client) NewReleasesPaginator

func (c *Client) NewReleasesPaginator() *ReleasesPaginator

NewReleasesPaginator creates a new instance of the paginator for Page.

func (*Client) NewReleasesPaginatorWithOptions

func (c *Client) NewReleasesPaginatorWithOptions(options *ReleasesPageOptions) *ReleasesPaginator

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

func (Client) Page

func (c Client) Page(options *ReleasesPageOptions) (*ReleasesPageResponse, error)

Page retrieves a page of plugin release resources See https://www.twilio.com/docs/flex/developer/plugins/api/release#read-multiple-pluginrelease-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 *ReleasesPageOptions) (*ReleasesPageResponse, error)

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

type CreateReleaseInput

type CreateReleaseInput struct {
	ConfigurationId string `validate:"required" form:"ConfigurationId"`
}

CreateReleaseInput defines the input fields for creating a new plugin release resource

type CreateReleaseResponse

type CreateReleaseResponse struct {
	AccountSid       string    `json:"account_sid"`
	ConfigurationSid string    `json:"configuration_sid"`
	DateCreated      time.Time `json:"date_created"`
	Sid              string    `json:"sid"`
	URL              string    `json:"url"`
}

CreateReleaseResponse defines the response fields for the created plugin release

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 PageReleaseResponse

type PageReleaseResponse struct {
	AccountSid       string    `json:"account_sid"`
	ConfigurationSid string    `json:"configuration_sid"`
	DateCreated      time.Time `json:"date_created"`
	Sid              string    `json:"sid"`
	URL              string    `json:"url"`
}

type ReleasesPage

type ReleasesPage struct {
	CurrentPage *ReleasesPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type ReleasesPageOptions

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

ReleasesPageOptions defines the query options for the api operation

type ReleasesPageResponse

type ReleasesPageResponse struct {
	Meta     PageMetaResponse      `json:"meta"`
	Releases []PageReleaseResponse `json:"releases"`
}

ReleasesPageResponse defines the response fields for the plugin releases page

type ReleasesPaginator

type ReleasesPaginator struct {
	Page     *ReleasesPage
	Releases []PageReleaseResponse
	// contains filtered or unexported fields
}

ReleasesPaginator defines the fields for makings paginated api calls Releases is an array of releases that have been returned from all of the page calls

func (*ReleasesPaginator) CurrentPage

func (p *ReleasesPaginator) CurrentPage() *ReleasesPageResponse

CurrentPage retrieves the results for the current page

func (*ReleasesPaginator) Error

func (p *ReleasesPaginator) Error() error

Error retrieves the error returned from the page

func (*ReleasesPaginator) Next

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

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