Class: Twilio::REST::Preview::HostedNumbers::AuthorizationDocumentContext::DependentHostedNumberOrderInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, signing_document_sid: nil) ⇒ DependentHostedNumberOrderInstance

Initialize the DependentHostedNumberOrderInstance

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

  • sid (String) —

    The SID of the Call resource to fetch.



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 199

def initialize(version, payload , signing_document_sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'incoming_phone_number_sid' => payload['incoming_phone_number_sid'],
        'address_sid' => payload['address_sid'],
        'signing_document_sid' => payload['signing_document_sid'],
        'phone_number' => payload['phone_number'],
        'capabilities' => payload['capabilities'],
        'friendly_name' => payload['friendly_name'],
        'unique_name' => payload['unique_name'],
        'status' => payload['status'],
        'failure_reason' => payload['failure_reason'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'verification_attempts' => payload['verification_attempts'] == nil ? payload['verification_attempts'] : payload['verification_attempts'].to_i,
        'email' => payload['email'],
        'cc_emails' => payload['cc_emails'],
        'verification_type' => payload['verification_type'],
        'verification_document_sid' => payload['verification_document_sid'],
        'extension' => payload['extension'],
        'call_delay' => payload['call_delay'] == nil ? payload['call_delay'] : payload['call_delay'].to_i,
        'verification_code' => payload['verification_code'],
        'verification_call_sids' => payload['verification_call_sids'],
    }
end

Instance Method Details

#account_sid ⇒ String

Returns The unique SID identifier of the Account.

Returns:

  • (String) —

    The unique SID identifier of the Account.



238
239
240
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 238

def 
    @properties['account_sid']
end

#address_sid ⇒ String

Returns A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number.

Returns:

  • (String) —

    A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number.



250
251
252
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 250

def address_sid
    @properties['address_sid']
end

#call_delay ⇒ String

Returns A value between 0-30 specifying the number of seconds to delay initiating the ownership verification call.

Returns:

  • (String) —

    A value between 0-30 specifying the number of seconds to delay initiating the ownership verification call.



346
347
348
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 346

def call_delay
    @properties['call_delay']
end

#capabilities ⇒ PreviewHostedNumbersAuthorizationDocumentDependentHostedNumberOrderCapabilities

Returns:

  • (PreviewHostedNumbersAuthorizationDocumentDependentHostedNumberOrderCapabilities) 


268
269
270
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 268

def capabilities
    @properties['capabilities']
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



322
323
324
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 322

def cc_emails
    @properties['cc_emails']
end

#date_created ⇒ Time

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

Returns:



298
299
300
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 298

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:



304
305
306
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 304

def date_updated
    @properties['date_updated']
end

#email ⇒ String

Returns Email of the owner of this phone number that is being hosted.

Returns:

  • (String) —

    Email of the owner of this phone number that is being hosted.



316
317
318
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 316

def email
    @properties['email']
end

#extension ⇒ String

Returns A numerical extension to be used when making the ownership verification call.

Returns:

  • (String) —

    A numerical extension to be used when making the ownership verification call.



340
341
342
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 340

def extension
    @properties['extension']
end

#failure_reason ⇒ String

Returns A message that explains why a hosted_number_order went to status "action-required".

Returns:

  • (String) —

    A message that explains why a hosted_number_order went to status "action-required"



292
293
294
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 292

def failure_reason
    @properties['failure_reason']
end

#friendly_name ⇒ String

Returns A human readable description of this resource, up to 64 characters.

Returns:

  • (String) —

    A human readable description of this resource, up to 64 characters.



274
275
276
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 274

def friendly_name
    @properties['friendly_name']
end

#incoming_phone_number_sid ⇒ String

Returns A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.

Returns:

  • (String) —

    A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.



244
245
246
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 244

def incoming_phone_number_sid
    @properties['incoming_phone_number_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



370
371
372
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 370

def inspect
    "<Twilio.Preview.HostedNumbers.DependentHostedNumberOrderInstance>"
end

#phone_number ⇒ String

Returns An E164 formatted phone number hosted by this HostedNumberOrder.

Returns:

  • (String) —

    An E164 formatted phone number hosted by this HostedNumberOrder.



262
263
264
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 262

def phone_number
    @properties['phone_number']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this Authorization Document.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this Authorization Document



232
233
234
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 232

def sid
    @properties['sid']
end

#signing_document_sid ⇒ String

Returns A 34 character string that uniquely identifies the LOA document associated with this HostedNumberOrder.

Returns:

  • (String) —

    A 34 character string that uniquely identifies the LOA document associated with this HostedNumberOrder.



256
257
258
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 256

def signing_document_sid
    @properties['signing_document_sid']
end

#status ⇒ Status

Returns:

  • (Status) 


286
287
288
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 286

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



364
365
366
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 364

def to_s
    "<Twilio.Preview.HostedNumbers.DependentHostedNumberOrderInstance>"
end

#unique_name ⇒ String

Returns Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.

Returns:

  • (String) —

    Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.



280
281
282
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 280

def unique_name
    @properties['unique_name']
end

#verification_attempts ⇒ String

Returns The number of attempts made to verify ownership of the phone number that is being hosted.

Returns:

  • (String) —

    The number of attempts made to verify ownership of the phone number that is being hosted.



310
311
312
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 310

def verification_attempts
    @properties['verification_attempts']
end

#verification_call_sids ⇒ Array<String>

Returns A list of 34 character strings that are unique identifiers for the calls placed as part of ownership verification.

Returns:

  • (Array<String>) —

    A list of 34 character strings that are unique identifiers for the calls placed as part of ownership verification.



358
359
360
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 358

def verification_call_sids
    @properties['verification_call_sids']
end

#verification_code ⇒ String

Returns The digits passed during the ownership verification call.

Returns:

  • (String) —

    The digits passed during the ownership verification call.



352
353
354
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 352

def verification_code
    @properties['verification_code']
end

#verification_document_sid ⇒ String

Returns A 34 character string that uniquely identifies the Identity Document resource that represents the document for verifying ownership of the number to be hosted.

Returns:

  • (String) —

    A 34 character string that uniquely identifies the Identity Document resource that represents the document for verifying ownership of the number to be hosted.



334
335
336
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 334

def verification_document_sid
    @properties['verification_document_sid']
end

#verification_type ⇒ VerificationType

Returns:

  • (VerificationType) 


328
329
330
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 328

def verification_type
    @properties['verification_type']
end