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 SID of the [Service](www.twilio.com/docs/notify/api/service-resource) the resource is associated with.

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

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



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 318

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 SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



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

def 
  @properties['account_sid']
end

#address ⇒ String

Returns The channel-specific address.

Returns:

  • (String) —

    The channel-specific address



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

def address
  @properties['address']
end

#binding_type ⇒ String

Returns The type of the Binding.

Returns:

  • (String) —

    The type of the Binding



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

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:



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

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 resource to be used to send notifications to this Binding.

Returns:

  • (String) —

    The SID of the Credential resource to be used to send notifications to this Binding



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

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



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

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the BindingInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



449
450
451
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 449

def delete
  context.delete
end

#endpoint ⇒ String

Returns Deprecated.

Returns:

  • (String) —

    Deprecated



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

def endpoint
  @properties['endpoint']
end

#fetch ⇒ BindingInstance

Fetch a BindingInstance

Returns:



442
443
444
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 442

def fetch
  context.fetch
end

#identity ⇒ String

Returns The ‘identity` value that identifies the new resource’s User.

Returns:

  • (String) —

    The ‘identity` value that identifies the new resource’s User



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

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



462
463
464
465
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 462

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

#links ⇒ String

Returns The URLs of related resources.

Returns:

  • (String) —

    The URLs of related resources



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

def links
  @properties['links']
end

#notification_protocol_version ⇒ String

Returns The protocol version to use to send the notification.

Returns:

  • (String) —

    The protocol version to use to send the notification



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

def notification_protocol_version
  @properties['notification_protocol_version']
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



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

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



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

def sid
  @properties['sid']
end

#tags ⇒ String

Returns The list of tags associated with this Binding.

Returns:

  • (String) —

    The list of tags associated with this Binding



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

def tags
  @properties['tags']
end

#to_s ⇒ Object

Provide a user friendly representation



455
456
457
458
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 455

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

#url ⇒ String

Returns The absolute URL of the Binding resource.

Returns:

  • (String) —

    The absolute URL of the Binding resource



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

def url
  @properties['url']
end