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 resource is associated with.

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

    The Twilio-provided string that uniquely identifies the Binding resource to fetch.



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

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



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

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



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

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:



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

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



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

def credential_sid
  @properties['credential_sid']
end

#date_created ⇒ Time

Returns The RFC 2822 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT when the resource was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The RFC 2822 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT when the resource was last updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the BindingInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#endpoint ⇒ String

Returns The unique endpoint identifier for the Binding.

Returns:

  • (String) —

    The unique endpoint identifier for the Binding



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

def endpoint
  @properties['endpoint']
end

#fetch ⇒ BindingInstance

Fetch a BindingInstance

Returns:



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

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



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

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ String

Returns The absolute URLs of the Users for the Binding.

Returns:

  • (String) —

    The absolute URLs of the Users for the Binding



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

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



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

def message_types
  @properties['message_types']
end

#service_sid ⇒ String

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

Returns:

  • (String) —

    The SID of the Service that the resource is associated with



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

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



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



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

def url
  @properties['url']
end