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

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Notify::V1::ServiceContext::BindingInstance

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

• #account_sid ⇒ String

  The SID of the Account that created the resource.

• #address ⇒ String

  The channel-specific address.

• #binding_type ⇒ String

  The type of the Binding.

• #context ⇒ BindingContext

  Generate an instance context for the instance, the context is capable of performing various actions.

• #credential_sid ⇒ String

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

• #date_created ⇒ Time

  The RFC 2822 date and time in GMT when the resource was created.

• #date_updated ⇒ Time

  The RFC 2822 date and time in GMT when the resource was last updated.

• #delete ⇒ Boolean

  Delete the BindingInstance.

• #endpoint ⇒ String

  Deprecated.

• #fetch ⇒ BindingInstance

  Fetch the BindingInstance.

• #identity ⇒ String

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

• #initialize(version, payload, service_sid: nil, sid: nil) ⇒ BindingInstance constructor

  Initialize the BindingInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #links ⇒ String

  The URLs of related resources.

• #notification_protocol_version ⇒ String

  The protocol version to use to send the notification.

• #service_sid ⇒ String

  The SID of the Service that the resource is associated with.

• #sid ⇒ String

  The unique string that identifies the resource.

• #tags ⇒ String

  The list of tags associated with this Binding.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #url ⇒ String

  The absolute URL of the Binding resource.

Constructor Details

#initialize(version, payload, service_sid: nil, sid: nil) ⇒ BindingInstance

Initialize the BindingInstance

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

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

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

def account_sid
  @properties['account_sid']
end

#address ⇒ String

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

def address
  @properties['address']
end

#binding_type ⇒ String

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

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

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

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

#credential_sid ⇒ String

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

def credential_sid
  @properties['credential_sid']
end

#date_created ⇒ Time

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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the BindingInstance

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

def delete
  context.delete
end

#endpoint ⇒ String

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

def endpoint
  @properties['endpoint']
end

#fetch ⇒ BindingInstance

Fetch the BindingInstance

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

def fetch
  context.fetch
end

#identity ⇒ String

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

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

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

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

#links ⇒ String

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

def links
  @properties['links']
end

#notification_protocol_version ⇒ String

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

def notification_protocol_version
  @properties['notification_protocol_version']
end

#service_sid ⇒ String

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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

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

def sid
  @properties['sid']
end

#tags ⇒ String

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

def tags
  @properties['tags']
end

#to_s ⇒ Object

Provide a user friendly representation

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

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

#url ⇒ String

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

def url
  @properties['url']
end