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.



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 239

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:



282
283
284
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 282

def 
    @properties['account_sid']
end

#binding_type ⇒ BindingType

Returns:

  • (BindingType) 


324
325
326
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 324

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:



267
268
269
270
271
272
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 267

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:



318
319
320
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 318

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:



294
295
296
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 294

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:



300
301
302
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 300

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the BindingInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



349
350
351
352
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 349

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



306
307
308
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 306

def endpoint
    @properties['endpoint']
end

#fetch ⇒ BindingInstance

Fetch the BindingInstance

Returns:



357
358
359
360
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 357

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:



312
313
314
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 312

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



371
372
373
374
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 371

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:



342
343
344
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 342

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:



330
331
332
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 330

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:



288
289
290
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 288

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.



276
277
278
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 276

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



364
365
366
367
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 364

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.



336
337
338
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 336

def url
    @properties['url']
end