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.



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

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:



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

def 
    @properties['account_sid']
end

#binding_type ⇒ BindingType

Returns:

  • (BindingType) 


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

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:



263
264
265
266
267
268
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 263

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:



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

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:



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

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:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the BindingInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



345
346
347
348
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 345

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



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

def endpoint
    @properties['endpoint']
end

#fetch ⇒ BindingInstance

Fetch the BindingInstance

Returns:



353
354
355
356
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 353

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:



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

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



367
368
369
370
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 367

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:



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

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:



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

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:



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

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.



272
273
274
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 272

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



360
361
362
363
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 360

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.



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

def url
    @properties['url']
end