Class: Twilio::REST::Conversations::V1::ServiceContext::BindingInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/conversations/v1/service/binding.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, chat_service_sid: nil, sid: nil) ⇒ BindingInstance

Initialize the BindingInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Binding resource.

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

    The SID of the Call resource to fetch.



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 432

def initialize(version, payload , chat_service_sid: nil, sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'chat_service_sid' => payload['chat_service_sid'],
        'credential_sid' => payload['credential_sid'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'endpoint' => payload['endpoint'],
        'identity' => payload['identity'],
        'binding_type' => payload['binding_type'],
        'message_types' => payload['message_types'],
        'url' => payload['url'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns The unique ID of the [Account](www.twilio.com/docs/iam/api/account) responsible for this binding.

Returns:



475
476
477
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 475

def 
    @properties['account_sid']
end

#binding_type ⇒ BindingType

Returns:

  • (BindingType) 


517
518
519
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 517

def binding_type
    @properties['binding_type']
end

#chat_service_sid ⇒ String

Returns The SID of the [Conversation Service](www.twilio.com/docs/conversations/api/service-resource) the Binding resource is associated with.

Returns:



481
482
483
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 481

def chat_service_sid
    @properties['chat_service_sid']
end

#context ⇒ BindingContext

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

Returns:



460
461
462
463
464
465
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 460

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

#credential_sid ⇒ String

Returns The SID of the [Credential](www.twilio.com/docs/conversations/api/credential-resource) for the binding. See [push notification configuration](www.twilio.com/docs/chat/push-notification-configuration) for more info.

Returns:



487
488
489
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 487

def credential_sid
    @properties['credential_sid']
end

#date_created ⇒ Time

Returns The date that this resource was created.

Returns:

  • (Time) —

    The date that this resource was created.



493
494
495
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 493

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was last updated.

Returns:

  • (Time) —

    The date that this resource was last updated.



499
500
501
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 499

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the BindingInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



536
537
538
539
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 536

def delete

    context.delete
end

#endpoint ⇒ String

Returns The unique endpoint identifier for the Binding. The format of this value depends on the binding_type.

Returns:

  • (String) —

    The unique endpoint identifier for the Binding. The format of this value depends on the binding_type.



505
506
507
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 505

def endpoint
    @properties['endpoint']
end

#fetch ⇒ BindingInstance

Fetch the BindingInstance

Returns:



544
545
546
547
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 544

def fetch

    context.fetch
end

#identity ⇒ String

Returns The application-defined string that uniquely identifies the [Conversation User](www.twilio.com/docs/conversations/api/user-resource) within the [Conversation Service](www.twilio.com/docs/conversations/api/service-resource). See [access tokens](www.twilio.com/docs/conversations/create-tokens) for more info.

Returns:



511
512
513
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 511

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



558
559
560
561
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 558

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

#message_types ⇒ Array<String>

Returns The [Conversation message types](www.twilio.com/docs/chat/push-notification-configuration#push-types) the binding is subscribed to.

Returns:



523
524
525
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 523

def message_types
    @properties['message_types']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



469
470
471
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 469

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



551
552
553
554
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 551

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

#url ⇒ String

Returns An absolute API resource URL for this binding.

Returns:

  • (String) —

    An absolute API resource URL for this binding.



529
530
531
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 529

def url
    @properties['url']
end