Class: Twilio::REST::Numbers::V2::AuthorizationDocumentInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/numbers/v2/authorization_document.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the AuthorizationDocumentInstance

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 AuthorizationDocument resource.

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

    The SID of the Call resource to fetch.



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document.rb', line 278

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'address_sid' => payload['address_sid'],
        'status' => payload['status'],
        'email' => payload['email'],
        'cc_emails' => payload['cc_emails'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'url' => payload['url'],
        'links' => payload['links'],
    }

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

Instance Method Details

#address_sid ⇒ String

Returns A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.

Returns:

  • (String) —

    A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.



318
319
320
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document.rb', line 318

def address_sid
    @properties['address_sid']
end

#cc_emails ⇒ Array<String>

Returns Email recipients who will be informed when an Authorization Document has been sent and signed.

Returns:

  • (Array<String>) —

    Email recipients who will be informed when an Authorization Document has been sent and signed.



336
337
338
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document.rb', line 336

def cc_emails
    @properties['cc_emails']
end

#context ⇒ AuthorizationDocumentContext

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

Returns:



303
304
305
306
307
308
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document.rb', line 303

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

#date_created ⇒ Time

Returns The date this resource was created, given as [GMT RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



342
343
344
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document.rb', line 342

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was updated, given as [GMT RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



348
349
350
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document.rb', line 348

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the AuthorizationDocumentInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



367
368
369
370
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document.rb', line 367

def delete

    context.delete
end

#dependent_hosted_number_orders ⇒ dependent_hosted_number_orders

Access the dependent_hosted_number_orders

Returns:



383
384
385
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document.rb', line 383

def dependent_hosted_number_orders
    context.dependent_hosted_number_orders
end

#email ⇒ String

Returns Email that this AuthorizationDocument will be sent to for signing.

Returns:

  • (String) —

    Email that this AuthorizationDocument will be sent to for signing.



330
331
332
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document.rb', line 330

def email
    @properties['email']
end

#fetch ⇒ AuthorizationDocumentInstance

Fetch the AuthorizationDocumentInstance

Returns:



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

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



396
397
398
399
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document.rb', line 396

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

#links ⇒ Hash

Returns:

  • (Hash) 


360
361
362
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document.rb', line 360

def links
    @properties['links']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this AuthorizationDocument.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this AuthorizationDocument.



312
313
314
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document.rb', line 312

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


324
325
326
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document.rb', line 324

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



389
390
391
392
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document.rb', line 389

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

#url ⇒ String

Returns:

  • (String) 


354
355
356
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document.rb', line 354

def url
    @properties['url']
end