revisions

Documentation

Overview

Package revisions contains auto-generated files. DO NOT MODIFY

Package revisions contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c *Client) NewRevisionsPaginator() *RevisionsPaginator
  • func (c *Client) NewRevisionsPaginatorWithOptions(options *RevisionsPageOptions) *RevisionsPaginator
  • func (c Client) Page(options *RevisionsPageOptions) (*RevisionsPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *RevisionsPageOptions) (*RevisionsPageResponse, error)
• type ClientProperties
• type PageMetaResponse
• type PageRevisionResponse
• type RevisionsPage
• type RevisionsPageOptions
• type RevisionsPageResponse
• type RevisionsPaginator
  • func (p *RevisionsPaginator) CurrentPage() *RevisionsPageResponse
  • func (p *RevisionsPaginator) Error() error
  • func (p *RevisionsPaginator) Next() bool
  • func (p *RevisionsPaginator) NextWithContext(context context.Context) bool

Types

type Client

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

Client for managing flow revision resources See https://www.twilio.com/docs/studio/rest-api/v2/flow-revision for more details

func New

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

New creates a new instance of the revisions client

func (*Client) NewRevisionsPaginator

func (c *Client) NewRevisionsPaginator() *RevisionsPaginator

NewRevisionsPaginator creates a new instance of the paginator for Page.

func (*Client) NewRevisionsPaginatorWithOptions

func (c *Client) NewRevisionsPaginatorWithOptions(options *RevisionsPageOptions) *RevisionsPaginator

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

func (Client) Page

func (c Client) Page(options *RevisionsPageOptions) (*RevisionsPageResponse, error)

Page retrieves a page of flow revisions See https://www.twilio.com/docs/studio/rest-api/v2/flow-revision#read-multiple-flowrevision-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 *RevisionsPageOptions) (*RevisionsPageResponse, error)

PageWithContext retrieves a page of flow revisions See https://www.twilio.com/docs/studio/rest-api/v2/flow-revision#read-multiple-flowrevision-resources for more details

type ClientProperties

type ClientProperties struct {
	FlowSid string
}

ClientProperties are the properties required to manage the revisions 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 PageRevisionResponse

type PageRevisionResponse struct {
	AccountSid    string                 `json:"account_sid"`
	CommitMessage *string                `json:"commit_message,omitempty"`
	DateCreated   time.Time              `json:"date_created"`
	DateUpdated   *time.Time             `json:"date_updated,omitempty"`
	Definition    map[string]interface{} `json:"definition"`
	Errors        *[]interface{}         `json:"errors,omitempty"`
	FriendlyName  string                 `json:"friendly_name"`
	Revision      int                    `json:"revision"`
	Sid           string                 `json:"sid"`
	Status        string                 `json:"status"`
	URL           string                 `json:"url"`
	Valid         bool                   `json:"valid"`
	Warnings      *[]interface{}         `json:"warnings,omitempty"`
	WebhookURL    string                 `json:"webhook_url"`
}

type RevisionsPage

type RevisionsPage struct {
	CurrentPage *RevisionsPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type RevisionsPageOptions

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

RevisionsPageOptions defines the query options for the api operation

type RevisionsPageResponse

type RevisionsPageResponse struct {
	Meta      PageMetaResponse       `json:"meta"`
	Revisions []PageRevisionResponse `json:"revisions"`
}

RevisionsPageResponse defines the response fields for the flow revisions page

type RevisionsPaginator

type RevisionsPaginator struct {
	Page      *RevisionsPage
	Revisions []PageRevisionResponse
	// contains filtered or unexported fields
}

RevisionsPaginator defines the fields for makings paginated api calls Revisions is an array of revisions that have been returned from all of the page calls

func (*RevisionsPaginator) CurrentPage

func (p *RevisionsPaginator) CurrentPage() *RevisionsPageResponse

CurrentPage retrieves the results for the current page

func (*RevisionsPaginator) Error

func (p *RevisionsPaginator) Error() error

Error retrieves the error returned from the page

func (*RevisionsPaginator) Next

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

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