plugins

Documentation

Overview

Package plugins contains auto-generated files. DO NOT MODIFY

Package plugins contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c *Client) NewPluginsPaginator() *PluginsPaginator
  • func (c *Client) NewPluginsPaginatorWithOptions(options *PluginsPageOptions) *PluginsPaginator
  • func (c Client) Page(options *PluginsPageOptions) (*PluginsPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *PluginsPageOptions) (*PluginsPageResponse, error)
• type ClientProperties
• type PageMetaResponse
• type PagePluginResponse
• type PluginsPage
• type PluginsPageOptions
• type PluginsPageResponse
• type PluginsPaginator
  • func (p *PluginsPaginator) CurrentPage() *PluginsPageResponse
  • func (p *PluginsPaginator) Error() error
  • func (p *PluginsPaginator) Next() bool
  • func (p *PluginsPaginator) NextWithContext(context context.Context) bool

Types

type Client

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

Client for managing plugin resources 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 plugins client

func (*Client) NewPluginsPaginator

func (c *Client) NewPluginsPaginator() *PluginsPaginator

NewPluginsPaginator creates a new instance of the paginator for Page.

func (*Client) NewPluginsPaginatorWithOptions

func (c *Client) NewPluginsPaginatorWithOptions(options *PluginsPageOptions) *PluginsPaginator

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

func (Client) Page

func (c Client) Page(options *PluginsPageOptions) (*PluginsPageResponse, error)

Page retrieves a page of plugin resources 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 *PluginsPageOptions) (*PluginsPageResponse, error)

PageWithContext retrieves a page of plugin resources This resource is currently in beta and subject to change. Please use with caution

type ClientProperties

type ClientProperties struct {
	ConfigurationSid string
}

ClientProperties are the properties required to manage the plugins resources

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 PagePluginResponse

type PagePluginResponse struct {
	AccountSid       string    `json:"account_sid"`
	ConfigurationSid string    `json:"configuration_sid"`
	DateCreated      time.Time `json:"date_created"`
	Phase            int       `json:"phase"`
	PluginSid        string    `json:"plugin_sid"`
	PluginURL        string    `json:"plugin_url"`
	PluginVersionSid string    `json:"plugin_version_sid"`
	Private          bool      `json:"private"`
	URL              string    `json:"url"`
	UniqueName       string    `json:"unique_name"`
	Version          string    `json:"version"`
}

type PluginsPage

type PluginsPage struct {
	CurrentPage *PluginsPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type PluginsPageOptions

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

PluginsPageOptions defines the query options for the api operation

type PluginsPageResponse

type PluginsPageResponse struct {
	Meta    PageMetaResponse     `json:"meta"`
	Plugins []PagePluginResponse `json:"plugins"`
}

PluginsPageResponse defines the response fields for the plugins page

type PluginsPaginator

type PluginsPaginator struct {
	Page    *PluginsPage
	Plugins []PagePluginResponse
	// contains filtered or unexported fields
}

PluginsPaginator defines the fields for makings paginated api calls Plugins is an array of plugins that have been returned from all of the page calls

func (*PluginsPaginator) CurrentPage

func (p *PluginsPaginator) CurrentPage() *PluginsPageResponse

CurrentPage retrieves the results for the current page

func (*PluginsPaginator) Error

func (p *PluginsPaginator) Error() error

Error retrieves the error returned from the page

func (*PluginsPaginator) Next

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

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