Class: Twilio::REST::FlexApi::V1::FlexFlowList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ FlexFlowList

Initialize the FlexFlowList

Parameters:

  • version (Version) —

    Version that contains the resource



18
19
20
21
22
23
24
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 18

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/FlexFlows"
end

Instance Method Details

#create(friendly_name: nil, chat_service_sid: nil, channel_type: nil, contact_identity: :unset, enabled: :unset, integration_type: :unset, integration_flow_sid: :unset, integration_url: :unset, integration_workspace_sid: :unset, integration_workflow_sid: :unset, integration_channel: :unset, integration_timeout: :unset, integration_priority: :unset, integration_creation_on_message: :unset, long_lived: :unset, janitor_enabled: :unset, integration_retry_count: :unset) ⇒ FlexFlowInstance

Create the FlexFlowInstance

Parameters:

  • friendly_name (String) (defaults to: nil) —

    A descriptive string that you create to describe the FlexFlow resource.

  • chat_service_sid (String) (defaults to: nil) —

    The SID of the chat service.

  • channel_type (flex_flow.ChannelType) (defaults to: nil) —

    The channel type. Can be: ‘web`, `facebook`, `sms`, `whatsapp`, `line` or `custom`.

  • contact_identity (String) (defaults to: :unset) —

    The channel contact’s Identity.

  • enabled (Boolean) (defaults to: :unset) —

    Whether the new FlexFlow is enabled.

  • integration_type (flex_flow.IntegrationType) (defaults to: :unset) —

    The integration type. Can be: ‘studio`, `external`, or `task`.

  • integration_flow_sid (String) (defaults to: :unset) —

    The SID of the Flow when ‘integration_type` is `studio`.

  • integration_url (String) (defaults to: :unset) —

    The External Webhook URL when ‘integration_type` is `external`.

  • integration_workspace_sid (String) (defaults to: :unset) —

    The Workspace SID for a new task for Task ‘integration_type`.

  • integration_workflow_sid (String) (defaults to: :unset) —

    The Workflow SID for a new task when ‘integration_type` is `task`.

  • integration_channel (String) (defaults to: :unset) —

    The task channel for a new task when ‘integration_type` is `task`. The default is `default`.

  • integration_timeout (String) (defaults to: :unset) —

    The task timeout in seconds for a new task when ‘integration_type` is `task`. The default is `86,400` seconds (24 hours).

  • integration_priority (String) (defaults to: :unset) —

    The task priority of a new task when ‘integration_type` is `task`. The default priority is `0`.

  • integration_creation_on_message (Boolean) (defaults to: :unset) —

    Whether to create a task when the first message arrives when ‘integration_type` is `task`. If `false`, the task is created with the channel. Note that does not apply when channel type is `web`. Setting the value to `true` for channel type `web` will result in misconfigured Flex Flow and no tasks will be created.

  • long_lived (Boolean) (defaults to: :unset) —

    When enabled, Flex will keep the chat channel active so that it may be used for subsequent interactions with a contact identity. Defaults to ‘false`.

  • janitor_enabled (Boolean) (defaults to: :unset) —

    When enabled, the Messaging Channel Janitor will remove active Proxy sessions if the associated Task is deleted outside of the Flex UI. Defaults to ‘false`.

  • integration_retry_count (String) (defaults to: :unset) —

    The number of times to retry the webhook if the first attempt fails. Can be an integer between 0 and 3, inclusive, and the default is 0.

Returns:



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 153

def create(friendly_name: nil, chat_service_sid: nil, channel_type: nil, contact_identity: :unset, enabled: :unset, integration_type: :unset, integration_flow_sid: :unset, integration_url: :unset, integration_workspace_sid: :unset, integration_workflow_sid: :unset, integration_channel: :unset, integration_timeout: :unset, integration_priority: :unset, integration_creation_on_message: :unset, long_lived: :unset, janitor_enabled: :unset, integration_retry_count: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'ChatServiceSid' => chat_service_sid,
      'ChannelType' => channel_type,
      'ContactIdentity' => contact_identity,
      'Enabled' => enabled,
      'IntegrationType' => integration_type,
      'Integration.FlowSid' => integration_flow_sid,
      'Integration.Url' => integration_url,
      'Integration.WorkspaceSid' => integration_workspace_sid,
      'Integration.WorkflowSid' => integration_workflow_sid,
      'Integration.Channel' => integration_channel,
      'Integration.Timeout' => integration_timeout,
      'Integration.Priority' => integration_priority,
      'Integration.CreationOnMessage' => integration_creation_on_message,
      'LongLived' => long_lived,
      'JanitorEnabled' => janitor_enabled,
      'Integration.RetryCount' => integration_retry_count,
  })

  payload = @version.create('POST', @uri, data: data)

  FlexFlowInstance.new(@version, payload, )
end

#each ⇒ Object

When passed a block, yields FlexFlowInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



68
69
70
71
72
73
74
75
76
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 68

def each
  limits = @version.read_limits

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page,
                  limit: limits[:limit],
                  page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of FlexFlowInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of FlexFlowInstance



105
106
107
108
109
110
111
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 105

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  FlexFlowPage.new(@version, response, @solution)
end

#list(friendly_name: :unset, limit: nil, page_size: nil) ⇒ Array

Lists FlexFlowInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    The ‘friendly_name` of the FlexFlow resources to read.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



39
40
41
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 39

def list(friendly_name: :unset, limit: nil, page_size: nil)
  self.stream(friendly_name: friendly_name, limit: limit, page_size: page_size).entries
end

#page(friendly_name: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of FlexFlowInstance records from the API. Request is executed immediately.

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    The ‘friendly_name` of the FlexFlow resources to read.

  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of FlexFlowInstance



87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 87

def page(friendly_name: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

  response = @version.page('GET', @uri, params: params)

  FlexFlowPage.new(@version, response, @solution)
end

#stream(friendly_name: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams FlexFlowInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    The ‘friendly_name` of the FlexFlow resources to read.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



56
57
58
59
60
61
62
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 56

def stream(friendly_name: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(friendly_name: friendly_name, page_size: limits[:page_size], )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



181
182
183
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 181

def to_s
  '#<Twilio.FlexApi.V1.FlexFlowList>'
end