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



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 300

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



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

def 
  @properties['account_sid']
end

#address ⇒ String

Returns The address specific to the channel.

Returns:

  • (String) —

    The address specific to the channel.



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

def address
  @properties['address']
end

#binding_type ⇒ String

Returns The type of the Binding.

Returns:

  • (String) —

    The type of the Binding.



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

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:



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

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

Returns:

  • (String) —

    The unique identifier of the Credential resource to be used to send notifications to this Binding.



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

def credential_sid
  @properties['credential_sid']
end

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the BindingInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#endpoint ⇒ String

Returns DEPRECATED*.

Returns:

  • (String) —

    DEPRECATED*



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

def endpoint
  @properties['endpoint']
end

#fetch ⇒ BindingInstance

Fetch a BindingInstance

Returns:



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

def fetch
  context.fetch
end

#identity ⇒ String

Returns The Identity to which this Binding belongs to.

Returns:

  • (String) —

    The Identity to which this Binding belongs to.



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

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



444
445
446
447
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 444

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



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

def links
  @properties['links']
end

#notification_protocol_version ⇒ String

Returns The version of the protocol used to send the notification.

Returns:

  • (String) —

    The version of the protocol used to send the notification.



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

def notification_protocol_version
  @properties['notification_protocol_version']
end

#service_sid ⇒ String

Returns The service_sid.

Returns:

  • (String) —

    The service_sid



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



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

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.



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

def tags
  @properties['tags']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



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

def url
  @properties['url']
end