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 unique id of the [Service](www.twilio.com/docs/api/chat/rest/services) this binding belongs to.

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

    The sid



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 228

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 unique id of the Account responsible for this binding.

Returns:

  • (String) —

    The unique id of the Account responsible for this binding.



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

def 
  @properties['account_sid']
end

#binding_type ⇒ binding.BindingType

Returns The push technology to use for this binding.

Returns:

  • (binding.BindingType) —

    The push technology to use for this binding.



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

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:



256
257
258
259
260
261
 
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 256

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

#credential_sid ⇒ String

Returns The unique id of the Credential for this binding.

Returns:

  • (String) —

    The unique id of the Credential for this binding.



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

def credential_sid
  @properties['credential_sid']
end

#date_created ⇒ Time

Returns The date that this resource was created.

Returns:

  • (Time) —

    The date that this resource was created.



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was last updated.

Returns:

  • (Time) —

    The date that this resource was last updated.



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the BindingInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



345
346
347
 
# 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 this Binding.

Returns:

  • (String) —

    The unique endpoint identifier for this Binding.



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

def endpoint
  @properties['endpoint']
end

#fetch ⇒ BindingInstance

Fetch a BindingInstance

Returns:



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

def fetch
  context.fetch
end

#identity ⇒ String

Returns A unique string identifier for the Binding for this User in this Service.

Returns:

  • (String) —

    A unique string identifier for the Binding for this User in this Service.



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

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ String

Returns Absolute URLs to access the Users for this Binding.

Returns:

  • (String) —

    Absolute URLs to access the Users for this Binding.



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

def links
  @properties['links']
end

#message_types ⇒ String

Returns List of message types for this binding.

Returns:

  • (String) —

    List of message types for this binding.



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

def message_types
  @properties['message_types']
end

#service_sid ⇒ String

Returns The unique id of the Service this binding belongs to.

Returns:

  • (String) —

    The unique id of the Service this binding belongs to.



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#url ⇒ String

Returns An absolute URL for this binding.

Returns:

  • (String) —

    An absolute URL for this binding.



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

def url
  @properties['url']
end