flex_flow

Documentation

Overview

Package flex_flow contains auto-generated files. DO NOT MODIFY

Package flex_flow contains auto-generated files. DO NOT MODIFY

Package flex_flow contains auto-generated files. DO NOT MODIFY

Package flex_flow contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Delete() error
  • func (c Client) DeleteWithContext(context context.Context) error
  • func (c Client) Fetch() (*FetchFlexFlowResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchFlexFlowResponse, error)
  • func (c Client) Update(input *UpdateFlexFlowInput) (*UpdateFlexFlowResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateFlexFlowInput) (*UpdateFlexFlowResponse, error)
• type ClientProperties
• type FetchFlexFlowResponse
• type FetchFlexFlowResponseIntegration
• type UpdateFlexFlowInput
• type UpdateFlexFlowResponse
• type UpdateFlexFlowResponseIntegration

Types

type Client

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

Client for managing a specific flex flow resource

func New

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

New creates a new instance of the flex flow client

func (Client) Delete

func (c Client) Delete() error

Delete removes a flex flow resource from the account Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) DeleteWithContext

func (c Client) DeleteWithContext(context context.Context) error

DeleteWithContext removes a flex flow resource from the account

func (Client) Fetch

func (c Client) Fetch() (*FetchFlexFlowResponse, error)

Fetch retrieves an flex flow resource Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) FetchWithContext

func (c Client) FetchWithContext(context context.Context) (*FetchFlexFlowResponse, error)

FetchWithContext retrieves an flex flow resource

func (Client) Update

func (c Client) Update(input *UpdateFlexFlowInput) (*UpdateFlexFlowResponse, error)

Update modifies a flex flow resource Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) UpdateWithContext

func (c Client) UpdateWithContext(context context.Context, input *UpdateFlexFlowInput) (*UpdateFlexFlowResponse, error)

UpdateWithContext modifies a flex flow resource

type ClientProperties

type ClientProperties struct {
	Sid string
}

ClientProperties are the properties required to manage the flex flow resources

type FetchFlexFlowResponse

type FetchFlexFlowResponse 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     *FetchFlexFlowResponseIntegration `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"`
}

FetchFlexFlowResponse defines the response fields for the retrieved flex flow

type FetchFlexFlowResponseIntegration

type FetchFlexFlowResponseIntegration 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 UpdateFlexFlowInput

type UpdateFlexFlowInput struct {
	ChannelType                  *string `form:"ChannelType,omitempty"`
	ChatServiceSid               *string `form:"ChatServiceSid,omitempty"`
	ContactIdentity              *string `form:"ContactIdentity,omitempty"`
	Enabled                      *bool   `form:"Enabled,omitempty"`
	FriendlyName                 *string `form:"FriendlyName,omitempty"`
	IntegrationChannel           *string `form:"Integration.Channel,omitempty"`
	IntegrationCreationOnMessage *bool   `form:"Integration.CreationOnMessage,omitempty"`
	IntegrationFlowSid           *string `form:"Integration.FlowSid,omitempty"`
	IntegrationPriority          *int    `form:"Integration.Priority,omitempty"`
	IntegrationRetryCount        *int    `form:"Integration.RetryCount,omitempty"`
	IntegrationTimeout           *int    `form:"Integration.Timeout,omitempty"`
	IntegrationType              *string `form:"IntegrationType,omitempty"`
	IntegrationURL               *string `form:"Integration.Url,omitempty"`
	IntegrationWorkflowSid       *string `form:"Integration.WorkflowSid,omitempty"`
	IntegrationWorkspaceSid      *string `form:"Integration.WorkspaceSid,omitempty"`
	JanitorEnabled               *bool   `form:"JanitorEnabled,omitempty"`
	LongLived                    *bool   `form:"LongLived,omitempty"`
}

UpdateFlexFlowInput defines input fields for updating a flex flow resource

type UpdateFlexFlowResponse

type UpdateFlexFlowResponse 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     *UpdateFlexFlowResponseIntegration `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"`
}

UpdateFlexFlowResponse defines the response fields for the updated flex flow

type UpdateFlexFlowResponseIntegration

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