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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 265

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



310
311
312
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 310

def 
  @properties['account_sid']
end

#address ⇒ String

Returns The address.

Returns:

  • (String) —

    The address



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

def address
  @properties['address']
end

#binding_type ⇒ String

Returns The binding_type.

Returns:

  • (String) —

    The binding_type



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

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:



295
296
297
298
299
300
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 295

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



322
323
324
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 322

def credential_sid
  @properties['credential_sid']
end

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



328
329
330
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 328

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



334
335
336
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 334

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the BindingInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#endpoint ⇒ String

Returns The endpoint.

Returns:

  • (String) —

    The endpoint



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

def endpoint
  @properties['endpoint']
end

#fetch ⇒ BindingInstance

Fetch a BindingInstance

Returns:



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

def fetch
  context.fetch
end

#identity ⇒ String

Returns The identity.

Returns:

  • (String) —

    The identity



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

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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



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

def links
  @properties['links']
end

#notification_protocol_version ⇒ String

Returns The notification_protocol_version.

Returns:

  • (String) —

    The notification_protocol_version



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

def notification_protocol_version
  @properties['notification_protocol_version']
end

#service_sid ⇒ String

Returns The service_sid.

Returns:

  • (String) —

    The service_sid



316
317
318
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 316

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



304
305
306
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 304

def sid
  @properties['sid']
end

#tags ⇒ String

Returns The tags.

Returns:

  • (String) —

    The tags



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

def tags
  @properties['tags']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



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

def url
  @properties['url']
end