builds

Documentation

Overview

Package builds contains auto-generated files. DO NOT MODIFY

Package builds contains auto-generated files. DO NOT MODIFY

Package builds contains auto-generated files. DO NOT MODIFY

Index

• type BuildsPage
• type BuildsPageOptions
• type BuildsPageResponse
• type BuildsPaginator
  • func (p *BuildsPaginator) CurrentPage() *BuildsPageResponse
  • func (p *BuildsPaginator) Error() error
  • func (p *BuildsPaginator) Next() bool
  • func (p *BuildsPaginator) NextWithContext(context context.Context) bool
• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Create(input *CreateBuildInput) (*CreateBuildResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateBuildInput) (*CreateBuildResponse, error)
  • func (c *Client) NewBuildsPaginator() *BuildsPaginator
  • func (c *Client) NewBuildsPaginatorWithOptions(options *BuildsPageOptions) *BuildsPaginator
  • func (c Client) Page(options *BuildsPageOptions) (*BuildsPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *BuildsPageOptions) (*BuildsPageResponse, error)
• type ClientProperties
• type CreateAssetVersion
• type CreateBuildInput
• type CreateBuildResponse
• type CreateDependency
• type CreateFunctionVersion
• type PageAssetVersion
• type PageBuildResponse
• type PageDependency
• type PageFunctionVersion
• type PageMetaResponse

Types

type BuildsPage

type BuildsPage struct {
	CurrentPage *BuildsPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type BuildsPageOptions

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

BuildsPageOptions defines the query options for the api operation

type BuildsPageResponse

type BuildsPageResponse struct {
	Builds []PageBuildResponse `json:"builds"`
	Meta   PageMetaResponse    `json:"meta"`
}

BuildsPageResponse defines the response fields for the builds page

type BuildsPaginator

type BuildsPaginator struct {
	Page   *BuildsPage
	Builds []PageBuildResponse
	// contains filtered or unexported fields
}

BuildsPaginator defines the fields for makings paginated api calls Builds is an array of builds that have been returned from all of the page calls

func (*BuildsPaginator) CurrentPage

func (p *BuildsPaginator) CurrentPage() *BuildsPageResponse

CurrentPage retrieves the results for the current page

func (*BuildsPaginator) Error

func (p *BuildsPaginator) Error() error

Error retrieves the error returned from the page

func (*BuildsPaginator) Next

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

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

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

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

func New

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

New creates a new instance of the builds client

func (Client) Create

func (c Client) Create(input *CreateBuildInput) (*CreateBuildResponse, error)

Create creates a new build See https://www.twilio.com/docs/runtime/functions-assets-api/api/build#create-a-build-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 *CreateBuildInput) (*CreateBuildResponse, error)

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

func (*Client) NewBuildsPaginator

func (c *Client) NewBuildsPaginator() *BuildsPaginator

NewBuildsPaginator creates a new instance of the paginator for Page.

func (*Client) NewBuildsPaginatorWithOptions

func (c *Client) NewBuildsPaginatorWithOptions(options *BuildsPageOptions) *BuildsPaginator

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

func (Client) Page

func (c Client) Page(options *BuildsPageOptions) (*BuildsPageResponse, error)

Page retrieves a page of builds See https://www.twilio.com/docs/runtime/functions-assets-api/api/build#read-multiple-build-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 *BuildsPageOptions) (*BuildsPageResponse, error)

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

type ClientProperties

type ClientProperties struct {
	ServiceSid string
}

ClientProperties are the properties required to manage the builds resources

type CreateAssetVersion

type CreateAssetVersion struct {
	AccountSid  string    `json:"account_sid"`
	AssetSid    string    `json:"asset_sid"`
	DateCreated time.Time `json:"date_created"`
	Path        string    `json:"path"`
	ServiceSid  string    `json:"service_sid"`
	Sid         string    `json:"sid"`
	URL         string    `json:"url"`
	Visibility  string    `json:"visibility"`
}

type CreateBuildInput

type CreateBuildInput struct {
	AssetVersions    *[]string `form:"AssetVersions,omitempty"`
	Dependencies     *string   `form:"Dependencies,omitempty"`
	FunctionVersions *[]string `form:"FunctionVersions,omitempty"`
	Runtime          *string   `form:"Runtime,omitempty"`
}

CreateBuildInput defines the input fields for creating a new build resource

type CreateBuildResponse

type CreateBuildResponse struct {
	AccountSid       string                   `json:"account_sid"`
	AssetVersions    *[]CreateAssetVersion    `json:"asset_versions,omitempty"`
	DateCreated      time.Time                `json:"date_created"`
	DateUpdated      *time.Time               `json:"date_updated,omitempty"`
	Dependencies     *[]CreateDependency      `json:"dependencies,omitempty"`
	FunctionVersions *[]CreateFunctionVersion `json:"function_versions,omitempty"`
	Runtime          string                   `json:"runtime"`
	ServiceSid       string                   `json:"service_sid"`
	Sid              string                   `json:"sid"`
	Status           string                   `json:"status"`
	URL              string                   `json:"url"`
}

CreateBuildResponse defines the response fields for the created build

type CreateDependency

type CreateDependency struct {
	Name    string `json:"name"`
	Version string `json:"version"`
}

type CreateFunctionVersion

type CreateFunctionVersion struct {
	AccountSid  string    `json:"account_sid"`
	DateCreated time.Time `json:"date_created"`
	FunctionSid string    `json:"function_sid"`
	Path        string    `json:"path"`
	ServiceSid  string    `json:"service_sid"`
	Sid         string    `json:"sid"`
	URL         string    `json:"url"`
	Visibility  string    `json:"visibility"`
}

type PageAssetVersion

type PageAssetVersion struct {
	AccountSid  string    `json:"account_sid"`
	AssetSid    string    `json:"asset_sid"`
	DateCreated time.Time `json:"date_created"`
	Path        string    `json:"path"`
	ServiceSid  string    `json:"service_sid"`
	Sid         string    `json:"sid"`
	URL         string    `json:"url"`
	Visibility  string    `json:"visibility"`
}

type PageBuildResponse

type PageBuildResponse struct {
	AccountSid       string                 `json:"account_sid"`
	AssetVersions    *[]PageAssetVersion    `json:"asset_versions,omitempty"`
	DateCreated      time.Time              `json:"date_created"`
	DateUpdated      *time.Time             `json:"date_updated,omitempty"`
	Dependencies     *[]PageDependency      `json:"dependencies,omitempty"`
	FunctionVersions *[]PageFunctionVersion `json:"function_versions,omitempty"`
	Runtime          string                 `json:"runtime"`
	ServiceSid       string                 `json:"service_sid"`
	Sid              string                 `json:"sid"`
	Status           string                 `json:"status"`
	URL              string                 `json:"url"`
}

type PageDependency

type PageDependency struct {
	Name    string `json:"name"`
	Version string `json:"version"`
}

type PageFunctionVersion

type PageFunctionVersion struct {
	AccountSid  string    `json:"account_sid"`
	DateCreated time.Time `json:"date_created"`
	FunctionSid string    `json:"function_sid"`
	Path        string    `json:"path"`
	ServiceSid  string    `json:"service_sid"`
	Sid         string    `json:"sid"`
	URL         string    `json:"url"`
	Visibility  string    `json:"visibility"`
}

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