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



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 



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 



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 



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 



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



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 



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 



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



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

def delete
  context.delete
end

#enabled ⇒ Boolean 



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



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

def fetch
  context.fetch
end

#friendly_name ⇒ String 



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 



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 



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 



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 



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 



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



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 



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

def url
  @properties['url']
end