flex_flows

Documentation

Overview

Package flex_flows contains auto-generated files. DO NOT MODIFY

Package flex_flows contains auto-generated files. DO NOT MODIFY

Package flex_flows contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client) *Client
  • func (c Client) Create(input *CreateFlexFlowInput) (*CreateFlexFlowResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateFlexFlowInput) (*CreateFlexFlowResponse, error)
  • func (c *Client) NewFlexFlowsPaginator() *FlexFlowsPaginator
  • func (c *Client) NewFlexFlowsPaginatorWithOptions(options *FlexFlowsPageOptions) *FlexFlowsPaginator
  • func (c Client) Page(options *FlexFlowsPageOptions) (*FlexFlowsPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *FlexFlowsPageOptions) (*FlexFlowsPageResponse, error)
• type CreateFlexFlowInput
• type CreateFlexFlowIntegrationInput
• type CreateFlexFlowIntegrationResponse
• type CreateFlexFlowResponse
• type FlexFlowsPage
• type FlexFlowsPageOptions
• type FlexFlowsPageResponse
• type FlexFlowsPaginator
  • func (p *FlexFlowsPaginator) CurrentPage() *FlexFlowsPageResponse
  • func (p *FlexFlowsPaginator) Error() error
  • func (p *FlexFlowsPaginator) Next() bool
  • func (p *FlexFlowsPaginator) NextWithContext(context context.Context) bool
• type PageFlexFlowIntegrationResponse
• type PageFlexFlowResponse
• type PageMetaResponse

Types

type Client

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

Client for managing flex flow resources

func New

func New(client *client.Client) *Client

New creates a new instance of the flex flows client

func (Client) Create

func (c Client) Create(input *CreateFlexFlowInput) (*CreateFlexFlowResponse, error)

Create creates a new flex flow 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 *CreateFlexFlowInput) (*CreateFlexFlowResponse, error)

CreateWithContext creates a new flex flow

func (*Client) NewFlexFlowsPaginator

func (c *Client) NewFlexFlowsPaginator() *FlexFlowsPaginator

NewFlexFlowsPaginator creates a new instance of the paginator for Page.

func (*Client) NewFlexFlowsPaginatorWithOptions

func (c *Client) NewFlexFlowsPaginatorWithOptions(options *FlexFlowsPageOptions) *FlexFlowsPaginator

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

func (Client) Page

func (c Client) Page(options *FlexFlowsPageOptions) (*FlexFlowsPageResponse, error)

Page retrieves a page of flex flows 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 *FlexFlowsPageOptions) (*FlexFlowsPageResponse, error)

PageWithContext retrieves a page of flex flows

type CreateFlexFlowInput

type CreateFlexFlowInput struct {
	ChannelType     string                          `validate:"required" form:"ChannelType"`
	ChatServiceSid  string                          `validate:"required" form:"ChatServiceSid"`
	ContactIdentity *string                         `form:"ContactIdentity,omitempty"`
	Enabled         *bool                           `form:"Enabled,omitempty"`
	FriendlyName    string                          `validate:"required" form:"FriendlyName"`
	Integration     *CreateFlexFlowIntegrationInput `form:"Integration,omitempty"`
	IntegrationType *string                         `form:"IntegrationType,omitempty"`
	JanitorEnabled  *bool                           `form:"JanitorEnabled,omitempty"`
	LongLived       *bool                           `form:"LongLived,omitempty"`
}

CreateFlexFlowInput defines the input fields for creating a new flex flow resource

type CreateFlexFlowIntegrationInput

type CreateFlexFlowIntegrationInput struct {
	Channel           *string `form:"Channel,omitempty"`
	CreationOnMessage *bool   `form:"CreationOnMessage,omitempty"`
	FlowSid           *string `form:"FlowSid,omitempty"`
	Priority          *int    `form:"Priority,omitempty"`
	RetryCount        *int    `form:"RetryCount,omitempty"`
	Timeout           *int    `form:"Timeout,omitempty"`
	URL               *string `form:"Url,omitempty"`
	WorkflowSid       *string `form:"WorkflowSid,omitempty"`
	WorkspaceSid      *string `form:"WorkspaceSid,omitempty"`
}

type CreateFlexFlowIntegrationResponse

type CreateFlexFlowIntegrationResponse struct {
	Channel           *string `json:"channel,omitempty"`
	CreationOnMessage *bool   `json:"creation_on_message,omitempty"`
	FlowSid           *string `json:"flow_sid,omitempty"`
	Priority          *int    `json:"priority,omitempty"`
	RetryCount        *int    `json:"retry_count,omitempty"`
	Timeout           *int    `json:"timeout,omitempty"`
	URL               *string `json:"url,omitempty"`
	WorkflowSid       *string `json:"workflow_sid,omitempty"`
	WorkspaceSid      *string `json:"workspace_sid,omitempty"`
}

type CreateFlexFlowResponse

type CreateFlexFlowResponse struct {
	AccountSid      string                             `json:"account_sid"`
	ChannelType     string                             `json:"channel_type"`
	ChatServiceSid  string                             `json:"chat_service_sid"`
	ContactIdentity *string                            `json:"contact_identity,omitempty"`
	DateCreated     time.Time                          `json:"date_created"`
	DateUpdated     *time.Time                         `json:"date_updated,omitempty"`
	Enabled         bool                               `json:"enabled"`
	FriendlyName    string                             `json:"friendly_name"`
	Integration     *CreateFlexFlowIntegrationResponse `json:"integration,omitempty"`
	IntegrationType *string                            `json:"integration_type,omitempty"`
	JanitorEnabled  *bool                              `json:"janitor_enabled,omitempty"`
	LongLived       *bool                              `json:"long_lived,omitempty"`
	Sid             string                             `json:"sid"`
	URL             string                             `json:"url"`
}

CreateFlexFlowResponse defines the response fields for the created flex flow

type FlexFlowsPage

type FlexFlowsPage struct {
	CurrentPage *FlexFlowsPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type FlexFlowsPageOptions

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

FlexFlowsPageOptions defines the query options for the api operation

type FlexFlowsPageResponse

type FlexFlowsPageResponse struct {
	FlexFlows []PageFlexFlowResponse `json:"flex_flows"`
	Meta      PageMetaResponse       `json:"meta"`
}

FlexFlowsPageResponse defines the response fields for the flex flows page

type FlexFlowsPaginator

type FlexFlowsPaginator struct {
	Page      *FlexFlowsPage
	FlexFlows []PageFlexFlowResponse
	// contains filtered or unexported fields
}

FlexFlowsPaginator defines the fields for makings paginated api calls FlexFlows is an array of flexflows that have been returned from all of the page calls

func (*FlexFlowsPaginator) CurrentPage

func (p *FlexFlowsPaginator) CurrentPage() *FlexFlowsPageResponse

CurrentPage retrieves the results for the current page

func (*FlexFlowsPaginator) Error

func (p *FlexFlowsPaginator) Error() error

Error retrieves the error returned from the page

func (*FlexFlowsPaginator) Next

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

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

type PageFlexFlowIntegrationResponse struct {
	Channel           *string `json:"channel,omitempty"`
	CreationOnMessage *bool   `json:"creation_on_message,omitempty"`
	FlowSid           *string `json:"flow_sid,omitempty"`
	Priority          *int    `json:"priority,omitempty"`
	RetryCount        *int    `json:"retry_count,omitempty"`
	Timeout           *int    `json:"timeout,omitempty"`
	URL               *string `json:"url,omitempty"`
	WorkflowSid       *string `json:"workflow_sid,omitempty"`
	WorkspaceSid      *string `json:"workspace_sid,omitempty"`
}

type PageFlexFlowResponse

type PageFlexFlowResponse struct {
	AccountSid      string                           `json:"account_sid"`
	ChannelType     string                           `json:"channel_type"`
	ChatServiceSid  string                           `json:"chat_service_sid"`
	ContactIdentity *string                          `json:"contact_identity,omitempty"`
	DateCreated     time.Time                        `json:"date_created"`
	DateUpdated     *time.Time                       `json:"date_updated,omitempty"`
	Enabled         bool                             `json:"enabled"`
	FriendlyName    string                           `json:"friendly_name"`
	Integration     *PageFlexFlowIntegrationResponse `json:"integration,omitempty"`
	IntegrationType *string                          `json:"integration_type,omitempty"`
	JanitorEnabled  *bool                            `json:"janitor_enabled,omitempty"`
	LongLived       *bool                            `json:"long_lived,omitempty"`
	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"`
}