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

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

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

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

    The SID of the Binding resource to fetch.



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 246

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, 'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



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

def 
  @properties['account_sid']
end

#binding_type ⇒ binding.BindingType

Returns The push technology to use for the binding.

Returns:

  • (binding.BindingType) —

    The push technology to use for the binding



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

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:



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

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 for the binding.

Returns:

  • (String) —

    The SID of the Credential for the binding



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

def credential_sid
  @properties['credential_sid']
end

#date_created ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was last updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the BindingInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



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

def delete
  context.delete
end

#endpoint ⇒ String

Returns The unique endpoint identifier for the Binding.

Returns:

  • (String) —

    The unique endpoint identifier for the Binding



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

def endpoint
  @properties['endpoint']
end

#fetch ⇒ BindingInstance

Fetch a BindingInstance

Returns:



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

def fetch
  context.fetch
end

#identity ⇒ String

Returns The string that identifies the resource’s User.

Returns:

  • (String) —

    The string that identifies the resource’s User



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

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



376
377
378
379
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 376

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

#links ⇒ String

Returns The absolute URLs of the Binding’s User.

Returns:

  • (String) —

    The absolute URLs of the Binding’s User



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

def links
  @properties['links']
end

#message_types ⇒ String

Returns The Programmable Chat message types the binding is subscribed to.

Returns:

  • (String) —

    The Programmable Chat message types the binding is subscribed to



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

def message_types
  @properties['message_types']
end

#service_sid ⇒ String

Returns The SID of the Service that the Binding resource is associated with.

Returns:

  • (String) —

    The SID of the Service that the Binding resource is associated with



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



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

def url
  @properties['url']
end