Class: Twilio::REST::Notify::V1::ServiceContext::BindingInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/notify/v1/service/binding.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

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 service_sid

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

    The sid



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 285

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'],
      'credential_sid' => payload['credential_sid'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'notification_protocol_version' => payload['notification_protocol_version'],
      'endpoint' => payload['endpoint'],
      'identity' => payload['identity'],
      'binding_type' => payload['binding_type'],
      'address' => payload['address'],
      'tags' => payload['tags'],
      '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 account_sid.

Returns:

  • (String) —

    The account_sid



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

def 
  @properties['account_sid']
end

#address ⇒ String

Returns The address.

Returns:

  • (String) —

    The address



391
392
393
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 391

def address
  @properties['address']
end

#binding_type ⇒ String

Returns The binding_type.

Returns:

  • (String) —

    The binding_type



385
386
387
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 385

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:



318
319
320
321
322
323
324
325
326
327
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 318

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

#credential_sid ⇒ String

Returns The credential_sid.

Returns:

  • (String) —

    The credential_sid



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

def credential_sid
  @properties['credential_sid']
end

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



355
356
357
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 355

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



361
362
363
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 361

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the BindingInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



423
424
425
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 423

def delete
  context.delete
end

#endpoint ⇒ String

Returns The endpoint.

Returns:

  • (String) —

    The endpoint



373
374
375
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 373

def endpoint
  @properties['endpoint']
end

#fetch ⇒ BindingInstance

Fetch a BindingInstance

Returns:



416
417
418
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 416

def fetch
  context.fetch
end

#identity ⇒ String

Returns The identity.

Returns:

  • (String) —

    The identity



379
380
381
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 379

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



436
437
438
439
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 436

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

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



409
410
411
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 409

def links
  @properties['links']
end

#notification_protocol_version ⇒ String

Returns The notification_protocol_version.

Returns:

  • (String) —

    The notification_protocol_version



367
368
369
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 367

def notification_protocol_version
  @properties['notification_protocol_version']
end

#service_sid ⇒ String

Returns The service_sid.

Returns:

  • (String) —

    The service_sid



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



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

def sid
  @properties['sid']
end

#tags ⇒ String

Returns The tags.

Returns:

  • (String) —

    The tags



397
398
399
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 397

def tags
  @properties['tags']
end

#to_s ⇒ Object

Provide a user friendly representation



429
430
431
432
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 429

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

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



403
404
405
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 403

def url
  @properties['url']
end