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

Inherits:
Twilio::REST::InstanceResource show all
Defined in:
lib/twilio-ruby/rest/ip_messaging/v2/credential.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the CredentialInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Credential resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/credential.rb', line 293

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

Returns:

  • (String) 


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

def 
    @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

Returns:



317
318
319
320
321
322
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/credential.rb', line 317

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

#date_created ⇒ Time

Returns:

  • (Time) 


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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the CredentialInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



375
376
377
378
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/credential.rb', line 375

def delete

    context.delete
end

#fetch ⇒ CredentialInstance

Fetch the CredentialInstance

Returns:



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

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns:

  • (String) 


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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



425
426
427
428
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/credential.rb', line 425

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

#sandbox ⇒ String

Returns:

  • (String) 


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

def sandbox
    @properties['sandbox']
end

#sid ⇒ String

Returns:

  • (String) 


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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



418
419
420
421
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/credential.rb', line 418

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

#type ⇒ PushService

Returns:

  • (PushService) 


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

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

Parameters:

  • friendly_name (String) (defaults to: :unset)
  • certificate (String) (defaults to: :unset)
  • private_key (String) (defaults to: :unset)
  • sandbox (Boolean) (defaults to: :unset)
  • api_key (String) (defaults to: :unset)
  • secret (String) (defaults to: :unset)

Returns:



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/credential.rb', line 397

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

Returns:

  • (String) 


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

def url
    @properties['url']
end