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) ⇒ FlexFlowInstance

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

Parameters:

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

    Human readable description of this FlexFlow

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

    The unique SID identifier of the chat service

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

    Channel type (web | facebook | sms)

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

    Channel contact Identity (number / contact)

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

    Boolean flag for enabling or disabling the FlexFlow

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

    Integration type (studio | external | task)

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

    The unique SID identifier of the Flow for Studio integration type

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

    External Webhook Url for External integration type

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

    Workspace Sid for a new task for Task integration type

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

    Workflow Sid for a new task for Task integration type

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

    Task Channel for a new task for Task integration type (default is ‘default’)

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

    Task timeout in seconds for a new task for Task integration type (default 86400)

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

    Task priority for a new task for Task integration type (default 0)

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

    Flag for task creation, either creating task with the channel, or if true create task whwn first message arrives (for Task integration type)

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

    Default Flag defining whether the new channels created are long lived or not

Returns:



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 142

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)
  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,
  })

  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.



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

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



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

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) —

    Human readable description of this FlexFlow

  • 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



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

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) —

    Human readable description of this FlexFlow

  • 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



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

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
  )
  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) —

    Human readable description of this FlexFlow

  • 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



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

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



172
173
174
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 172

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