Class: Twilio::REST::IpMessaging::V2::CredentialInstance

Inherits:

Twilio::REST::InstanceResource

• Object
• Twilio::REST::InstanceResource
• Twilio::REST::IpMessaging::V2::CredentialInstance

Defined in:

lib/twilio-ruby/rest/ip_messaging/v2/credential.rb

Instance Method Summary

• #account_sid ⇒ String

  The unique id of the Account responsible for this resource.

• #context ⇒ CredentialContext

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

• #date_created ⇒ Time

  The date that this resource was created.

• #date_updated ⇒ Time

  The date that this resource was last updated.

• #delete ⇒ Boolean

  Deletes the CredentialInstance.

• #fetch ⇒ CredentialInstance

  Fetch a CredentialInstance.

• #friendly_name ⇒ String

  The human-readable name of this resource.

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

  Initialize the CredentialInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #sandbox ⇒ String

  APN only

  true when this resource should use the sandbox APN service.

• #sid ⇒ String

  A 34 character string that uniquely identifies this resource.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #type ⇒ credential.PushService

  Indicates which push notifications service this credential is for - either gcm, fcm, or apn.

• #update(friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset) ⇒ CredentialInstance

  Update the CredentialInstance.

• #url ⇒ String

  An absolute URL for this credential resource.

Constructor Details

#initialize(version, payload, sid: nil) ⇒ CredentialInstance

Initialize the CredentialInstance

# File 'lib/twilio-ruby/rest/ip_messaging/v2/credential.rb', line 277

def initialize(version, payload, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'friendly_name' => payload['friendly_name'],
      'type' => payload['type'],
      'sandbox' => payload['sandbox'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'url' => payload['url'],
  }

  # Context
  @instance_context = nil
  @params = {'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

# File 'lib/twilio-ruby/rest/ip_messaging/v2/credential.rb', line 316

def account_sid
  @properties['account_sid']
end

#context ⇒ CredentialContext

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/ip_messaging/v2/credential.rb', line 301

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

#date_created ⇒ Time

# File 'lib/twilio-ruby/rest/ip_messaging/v2/credential.rb', line 340

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

# File 'lib/twilio-ruby/rest/ip_messaging/v2/credential.rb', line 346

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the CredentialInstance

# File 'lib/twilio-ruby/rest/ip_messaging/v2/credential.rb', line 397

def delete
  context.delete
end

#fetch ⇒ CredentialInstance

Fetch a CredentialInstance

# File 'lib/twilio-ruby/rest/ip_messaging/v2/credential.rb', line 359

def fetch
  context.fetch
end

#friendly_name ⇒ String

# File 'lib/twilio-ruby/rest/ip_messaging/v2/credential.rb', line 322

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

# File 'lib/twilio-ruby/rest/ip_messaging/v2/credential.rb', line 410

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

#sandbox ⇒ String

# File 'lib/twilio-ruby/rest/ip_messaging/v2/credential.rb', line 334

def sandbox
  @properties['sandbox']
end

#sid ⇒ String

# File 'lib/twilio-ruby/rest/ip_messaging/v2/credential.rb', line 310

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation

# File 'lib/twilio-ruby/rest/ip_messaging/v2/credential.rb', line 403

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

#type ⇒ credential.PushService

# File 'lib/twilio-ruby/rest/ip_messaging/v2/credential.rb', line 328

def type
  @properties['type']
end

#update(friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset) ⇒ CredentialInstance

Update the CredentialInstance

# File 'lib/twilio-ruby/rest/ip_messaging/v2/credential.rb', line 383

def update(friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset)
  context.update(
      friendly_name: friendly_name,
      certificate: certificate,
      private_key: private_key,
      sandbox: sandbox,
      api_key: api_key,
      secret: secret,
  )
end

#url ⇒ String

# File 'lib/twilio-ruby/rest/ip_messaging/v2/credential.rb', line 352

def url
  @properties['url']
end