Class: Twilio::REST::Chat::V2::ServiceContext::BindingInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, 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.



440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 440

def initialize(version, payload , service_sid: nil, sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'service_sid' => payload['service_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'],
        'credential_sid' => payload['credential_sid'],
        'binding_type' => payload['binding_type'],
        'message_types' => payload['message_types'],
        'url' => payload['url'],
        'links' => payload['links'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Binding resource.

Returns:



484
485
486
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 484

def 
    @properties['account_sid']
end

#binding_type ⇒ BindingType

Returns:

  • (BindingType) 


526
527
528
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 526

def binding_type
    @properties['binding_type']
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:



469
470
471
472
473
474
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 469

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

#credential_sid ⇒ String

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

Returns:



520
521
522
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 520

def credential_sid
    @properties['credential_sid']
end

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



496
497
498
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 496

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



502
503
504
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 502

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the BindingInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

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`.



508
509
510
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 508

def endpoint
    @properties['endpoint']
end

#fetch ⇒ BindingInstance

Fetch the BindingInstance

Returns:



559
560
561
562
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 559

def fetch

    context.fetch
end

#identity ⇒ String

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

Returns:



514
515
516
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 514

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



573
574
575
576
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 573

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

#links ⇒ Hash

Returns The absolute URLs of the Binding’s [User](www.twilio.com/docs/chat/rest/user-resource).

Returns:



544
545
546
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 544

def links
    @properties['links']
end

#message_types ⇒ Array<String>

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

Returns:



532
533
534
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 532

def message_types
    @properties['message_types']
end

#service_sid ⇒ String

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

Returns:



490
491
492
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 490

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that we created to identify the Binding resource.

Returns:

  • (String) —

    The unique string that we created to identify the Binding resource.



478
479
480
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 478

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



566
567
568
569
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 566

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

#url ⇒ String

Returns The absolute URL of the Binding resource.

Returns:

  • (String) —

    The absolute URL of the Binding resource.



538
539
540
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 538

def url
    @properties['url']
end