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.



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 341

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_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



380
381
382
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 380

def 
  @properties['account_sid']
end

#channel_type ⇒ flex_flow.ChannelType

Returns The channel type.

Returns:

  • (flex_flow.ChannelType) —

    The channel type



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

def channel_type
  @properties['channel_type']
end

#chat_service_sid ⇒ String

Returns The SID of the chat service.

Returns:

  • (String) —

    The SID of the chat service



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

def chat_service_sid
  @properties['chat_service_sid']
end

#contact_identity ⇒ String

Returns The channel contact’s Identity.

Returns:

  • (String) —

    The channel contact’s Identity



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

def contact_identity
  @properties['contact_identity']
end

#context ⇒ FlexFlowContext

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

Returns:



371
372
373
374
375
376
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 371

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

#date_created ⇒ Time

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



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the FlexFlowInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



538
539
540
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 538

def delete
  context.delete
end

#enabled ⇒ Boolean

Returns Whether the Flex Flow is enabled.

Returns:

  • (Boolean) —

    Whether the Flex Flow is enabled



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

def enabled
  @properties['enabled']
end

#fetch ⇒ FlexFlowInstance

Fetch the FlexFlowInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource.

Returns:

  • (String) —

    The string that you assigned to describe the resource



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



551
552
553
554
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 551

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

#integration ⇒ Hash

Returns An object that contains specific parameters for the integration.

Returns:

  • (Hash) —

    An object that contains specific parameters for the integration



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

def integration
  @properties['integration']
end

#integration_type ⇒ flex_flow.IntegrationType

Returns The integration type.

Returns:

  • (flex_flow.IntegrationType) —

    The integration type



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

def integration_type
  @properties['integration_type']
end

#janitor_enabled ⇒ Boolean

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

Returns:

  • (Boolean) —

    Remove active Proxy sessions if the corresponding Task is deleted.



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

def janitor_enabled
  @properties['janitor_enabled']
end

#long_lived ⇒ Boolean

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



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

def long_lived
  @properties['long_lived']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



544
545
546
547
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 544

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. 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 Flex Flow 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 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 for the TaskRouter Task that will be created. Applicable and required when integrationType is ‘task`. Set to `sms` for SMS, and to `chat` otherwise. 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 webhook if the first attempt fails. Can be an integer between 0 and 3 (included), default is 0. Optional when integrationType is ‘external`, not applicable otherwise.

Returns:



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 513

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

#url ⇒ String

Returns The absolute URL of the Flex Flow resource.

Returns:

  • (String) —

    The absolute URL of the Flex Flow resource



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

def url
  @properties['url']
end