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 the resource is associated with.

  • sid (String) (defaults to: nil)

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


306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 306

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_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


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

def 
  @properties['account_sid']
end

#addressString

Returns The channel-specific address.

Returns:

  • (String)

    The channel-specific address


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

def address
  @properties['address']
end

#binding_typeString

Returns The type of the Binding.

Returns:

  • (String)

    The type of the Binding


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

def binding_type
  @properties['binding_type']
end

#contextBindingContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:


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

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

#credential_sidString

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


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

def credential_sid
  @properties['credential_sid']
end

#date_createdTime

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


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

def date_created
  @properties['date_created']
end

#date_updatedTime

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


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

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the BindingInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#endpointString

Returns Deprecated.

Returns:

  • (String)

    Deprecated


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

def endpoint
  @properties['endpoint']
end

#fetchBindingInstance

Fetch the BindingInstance

Returns:


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

def fetch
  context.fetch
end

#identityString

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

Returns:

  • (String)

    The `identity` value that identifies the new resource's User


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

def identity
  @properties['identity']
end

#inspectObject

Provide a detailed, user friendly representation


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

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

Returns The URLs of related resources.

Returns:

  • (String)

    The URLs of related resources


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

def links
  @properties['links']
end

#notification_protocol_versionString

Returns The protocol version to use to send the notification.

Returns:

  • (String)

    The protocol version to use to send the notification


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

def notification_protocol_version
  @properties['notification_protocol_version']
end

#service_sidString

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


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

def service_sid
  @properties['service_sid']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


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

def sid
  @properties['sid']
end

#tagsArray[String]

Returns The list of tags associated with this Binding.

Returns:

  • (Array[String])

    The list of tags associated with this Binding


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

def tags
  @properties['tags']
end

#to_sObject

Provide a user friendly representation


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

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

#urlString

Returns The absolute URL of the Binding resource.

Returns:

  • (String)

    The absolute URL of the Binding resource


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

def url
  @properties['url']
end