Class: Twilio::REST::FlexApi::V1::FlexFlowInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ FlexFlowInstance

Initialize the FlexFlowInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • sid (String) (defaults to: nil)

    The SID of the Flex Flow resource to fetch.


355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 355

def initialize(version, payload, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'sid' => payload['sid'],
      'friendly_name' => payload['friendly_name'],
      'chat_service_sid' => payload['chat_service_sid'],
      'channel_type' => payload['channel_type'],
      'contact_identity' => payload['contact_identity'],
      'enabled' => payload['enabled'],
      'integration_type' => payload['integration_type'],
      'integration' => payload['integration'],
      'long_lived' => payload['long_lived'],
      'janitor_enabled' => payload['janitor_enabled'],
      'url' => payload['url'],
  }

  # Context
  @instance_context = nil
  @params = {'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


394
395
396
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 394

def 
  @properties['account_sid']
end

#channel_typeflex_flow.ChannelType

Returns The channel type.

Returns:

  • (flex_flow.ChannelType)

    The channel type


430
431
432
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 430

def channel_type
  @properties['channel_type']
end

#chat_service_sidString

Returns The SID of the chat service.

Returns:

  • (String)

    The SID of the chat service


424
425
426
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 424

def chat_service_sid
  @properties['chat_service_sid']
end

#contact_identityString

Returns The channel contact's Identity.

Returns:

  • (String)

    The channel contact's Identity


436
437
438
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 436

def contact_identity
  @properties['contact_identity']
end

#contextFlexFlowContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:


385
386
387
388
389
390
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 385

def context
  unless @instance_context
    @instance_context = FlexFlowContext.new(@version, @params['sid'], )
  end
  @instance_context
end

#date_createdTime

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time)

    The ISO 8601 date and time in GMT when the resource was created


400
401
402
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 400

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time)

    The ISO 8601 date and time in GMT when the resource was last updated


406
407
408
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 406

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the FlexFlowInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


559
560
561
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 559

def delete
  context.delete
end

#enabledBoolean

Returns Whether the Flex Flow is enabled.

Returns:

  • (Boolean)

    Whether the Flex Flow is enabled


442
443
444
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 442

def enabled
  @properties['enabled']
end

#fetchFlexFlowInstance

Fetch the FlexFlowInstance

Returns:


479
480
481
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 479

def fetch
  context.fetch
end

#friendly_nameString

Returns The string that you assigned to describe the resource.

Returns:

  • (String)

    The string that you assigned to describe the resource


418
419
420
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 418

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation


572
573
574
575
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 572

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.FlexApi.V1.FlexFlowInstance #{values}>"
end

#integrationHash

Returns An object that contains specific parameters for the integration.

Returns:

  • (Hash)

    An object that contains specific parameters for the integration


454
455
456
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 454

def integration
  @properties['integration']
end

#integration_typeflex_flow.IntegrationType

Returns The software that will handle inbound messages.

Returns:

  • (flex_flow.IntegrationType)

    The software that will handle inbound messages.


448
449
450
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 448

def integration_type
  @properties['integration_type']
end

#janitor_enabledBoolean

Returns Remove active Proxy sessions if the corresponding Task is deleted.

Returns:

  • (Boolean)

    Remove active Proxy sessions if the corresponding Task is deleted.


466
467
468
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 466

def janitor_enabled
  @properties['janitor_enabled']
end

#long_livedBoolean

Returns Re-use this chat channel for future interactions with a contact.

Returns:

  • (Boolean)

    Re-use this chat channel for future interactions with a contact


460
461
462
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 460

def long_lived
  @properties['long_lived']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


412
413
414
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 412

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


565
566
567
568
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 565

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.FlexApi.V1.FlexFlowInstance #{values}>"
end

#update(friendly_name: :unset, chat_service_sid: :unset, channel_type: :unset, 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

Update the FlexFlowInstance

Parameters:

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

    A descriptive string that you create to describe the Flex Flow resource.

  • chat_service_sid (String) (defaults to: :unset)

    The SID of the chat service.

  • channel_type (flex_flow.ChannelType) (defaults to: :unset)

    The channel type. One of `web`, `facebook`, `sms`, `whatsapp`, `line` or `custom`. By default, Studio’s Send to Flex widget passes it on to the Task attributes for Tasks created based on this Flex Flow. The Task attributes will be used by the Flex UI to render the respective Task as appropriate (applying channel-specific design and length limits). If `channelType` is `facebook`, `whatsapp` or `line`, the Send to Flex widget should set the Task Channel to Programmable Chat.

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

    The channel contact's Identity.

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

    Whether the new Flex Flow is enabled.

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

    The software that will handle inbound messages. Integration Type can be: `studio`, `external`, or `task`.

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

    The SID of the Studio Flow. Required when `integrationType` is `studio`.

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

    The URL of the external webhook. Required when `integrationType` is `external`.

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

    The Workspace SID for a new Task. Required when `integrationType` is `task`.

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

    The Workflow SID for a new Task. Required when `integrationType` is `task`.

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

    The Task Channel SID (TCXXXX) or unique name (e.g., `sms`) to use for the Task that will be created. Applicable and required when `integrationType` is `task`. The default value is `default`.

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

    The Task timeout in seconds for a new Task. Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`, not applicable otherwise.

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

    The Task priority of a new Task. The default priority is 0. Optional when `integrationType` is `task`, not applicable otherwise.

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

    In the context of outbound messaging, defines whether to create a Task immediately (and therefore reserve the conversation to current agent), or delay Task creation until the customer sends the first response. Set to false to create immediately, true to delay Task creation. This setting is only applicable for outbound messaging.

  • 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 Studio Flow or webhook in case of failure. Takes integer values from 0 to 3 with the default being 3. Optional when `integrationType` is `studio` or `external`, not applicable otherwise.

Returns:


534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 534

def update(friendly_name: :unset, chat_service_sid: :unset, channel_type: :unset, 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)
  context.update(
      friendly_name: friendly_name,
      chat_service_sid: chat_service_sid,
      channel_type: channel_type,
      contact_identity: contact_identity,
      enabled: enabled,
      integration_type: integration_type,
      integration_flow_sid: integration_flow_sid,
      integration_url: integration_url,
      integration_workspace_sid: integration_workspace_sid,
      integration_workflow_sid: integration_workflow_sid,
      integration_channel: integration_channel,
      integration_timeout: integration_timeout,
      integration_priority: integration_priority,
      integration_creation_on_message: integration_creation_on_message,
      long_lived: long_lived,
      janitor_enabled: janitor_enabled,
      integration_retry_count: integration_retry_count,
  )
end

#urlString

Returns The absolute URL of the Flex Flow resource.

Returns:

  • (String)

    The absolute URL of the Flex Flow resource


472
473
474
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 472

def url
  @properties['url']
end