functions

Documentation

Overview

Package functions contains auto-generated files. DO NOT MODIFY

Package functions contains auto-generated files. DO NOT MODIFY

Package functions contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Create(input *CreateFunctionInput) (*CreateFunctionResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateFunctionInput) (*CreateFunctionResponse, error)
  • func (c *Client) NewFunctionsPaginator() *FunctionsPaginator
  • func (c *Client) NewFunctionsPaginatorWithOptions(options *FunctionsPageOptions) *FunctionsPaginator
  • func (c Client) Page(options *FunctionsPageOptions) (*FunctionsPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *FunctionsPageOptions) (*FunctionsPageResponse, error)
• type ClientProperties
• type CreateFunctionInput
• type CreateFunctionResponse
• type FunctionsPage
• type FunctionsPageOptions
• type FunctionsPageResponse
• type FunctionsPaginator
  • func (p *FunctionsPaginator) CurrentPage() *FunctionsPageResponse
  • func (p *FunctionsPaginator) Error() error
  • func (p *FunctionsPaginator) Next() bool
  • func (p *FunctionsPaginator) NextWithContext(context context.Context) bool
• type PageFunctionResponse
• type PageMetaResponse

Types

type Client

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

Client for managing function resources See https://www.twilio.com/docs/runtime/functions-assets-api/api/function for more details

func New

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

New creates a new instance of the functions client

func (Client) Create

func (c Client) Create(input *CreateFunctionInput) (*CreateFunctionResponse, error)

Create creates a new function See https://www.twilio.com/docs/runtime/functions-assets-api/api/function#create-a-function-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) CreateWithContext

func (c Client) CreateWithContext(context context.Context, input *CreateFunctionInput) (*CreateFunctionResponse, error)

CreateWithContext creates a new function See https://www.twilio.com/docs/runtime/functions-assets-api/api/function#create-a-function-resource for more details

func (*Client) NewFunctionsPaginator

func (c *Client) NewFunctionsPaginator() *FunctionsPaginator

NewFunctionsPaginator creates a new instance of the paginator for Page.

func (*Client) NewFunctionsPaginatorWithOptions

func (c *Client) NewFunctionsPaginatorWithOptions(options *FunctionsPageOptions) *FunctionsPaginator

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

func (Client) Page

func (c Client) Page(options *FunctionsPageOptions) (*FunctionsPageResponse, error)

Page retrieves a page of functions See https://www.twilio.com/docs/runtime/functions-assets-api/api/function#read-multiple-function-resources for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) PageWithContext

func (c Client) PageWithContext(context context.Context, options *FunctionsPageOptions) (*FunctionsPageResponse, error)

PageWithContext retrieves a page of functions See https://www.twilio.com/docs/runtime/functions-assets-api/api/function#read-multiple-function-resources for more details

type ClientProperties

type ClientProperties struct {
	ServiceSid string
}

ClientProperties are the properties required to manage the functions resources

type CreateFunctionInput

type CreateFunctionInput struct {
	FriendlyName string `validate:"required" form:"FriendlyName"`
}

CreateFunctionInput defines the input fields for creating a new function resource

type CreateFunctionResponse

type CreateFunctionResponse struct {
	AccountSid   string     `json:"account_sid"`
	DateCreated  time.Time  `json:"date_created"`
	DateUpdated  *time.Time `json:"date_updated,omitempty"`
	FriendlyName string     `json:"friendly_name"`
	ServiceSid   string     `json:"service_sid"`
	Sid          string     `json:"sid"`
	URL          string     `json:"url"`
}

CreateFunctionResponse defines the response fields for the created function

type FunctionsPage

type FunctionsPage struct {
	CurrentPage *FunctionsPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type FunctionsPageOptions

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

FunctionsPageOptions defines the query options for the api operation

type FunctionsPageResponse

type FunctionsPageResponse struct {
	Functions []PageFunctionResponse `json:"functions"`
	Meta      PageMetaResponse       `json:"meta"`
}

FunctionsPageResponse defines the response fields for the functions page

type FunctionsPaginator

type FunctionsPaginator struct {
	Page      *FunctionsPage
	Functions []PageFunctionResponse
	// contains filtered or unexported fields
}

FunctionsPaginator defines the fields for makings paginated api calls Functions is an array of functions that have been returned from all of the page calls

func (*FunctionsPaginator) CurrentPage

func (p *FunctionsPaginator) CurrentPage() *FunctionsPageResponse

CurrentPage retrieves the results for the current page

func (*FunctionsPaginator) Error

func (p *FunctionsPaginator) Error() error

Error retrieves the error returned from the page

func (*FunctionsPaginator) Next

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

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

type PageFunctionResponse struct {
	AccountSid   string     `json:"account_sid"`
	DateCreated  time.Time  `json:"date_created"`
	DateUpdated  *time.Time `json:"date_updated,omitempty"`
	FriendlyName string     `json:"friendly_name"`
	ServiceSid   string     `json:"service_sid"`
	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"`
}