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

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected]

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

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

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


225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 225

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'].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'].to_i,
      'verification_code' => payload['verification_code'],
      'verification_call_sids' => payload['verification_call_sids'],
  }
end

Instance Method Details

#account_sid ⇒ String

Returns Account sid.

Returns:

  • (String) —

    Account sid.


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

def 
  @properties['account_sid']
end

#address_sid ⇒ String

Returns Address sid.

Returns:

  • (String) —

    Address sid.


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

def address_sid
  @properties['address_sid']
end

#call_delay ⇒ String

Returns Seconds (0-30) to delay ownership verification call by.

Returns:

  • (String) —

    Seconds (0-30) to delay ownership verification call by.


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

def call_delay
  @properties['call_delay']
end

#capabilities ⇒ String

Returns A mapping of phone number capabilities.

Returns:

  • (String) —

    A mapping of phone number capabilities.


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

def capabilities
  @properties['capabilities']
end

#cc_emails ⇒ Array[String]

Returns A list of emails.

Returns:

  • (Array[String]) —

    A list of emails.


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

def cc_emails
  @properties['cc_emails']
end

#date_created ⇒ Time

Returns The date this HostedNumberOrder was created.

Returns:

  • (Time) —

    The date this HostedNumberOrder was created.


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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this HostedNumberOrder was updated.

Returns:

  • (Time) —

    The date this HostedNumberOrder was updated.


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

def date_updated
  @properties['date_updated']
end

#email ⇒ String

Returns Email.

Returns:

  • (String) —

    Email.


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

def email
  @properties['email']
end

#extension ⇒ String

Returns Phone extension to use for ownership verification call.

Returns:

  • (String) —

    Phone extension to use for ownership verification call.


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

def extension
  @properties['extension']
end

#failure_reason ⇒ String

Returns Why a hosted_number_order reached status “action-required”.

Returns:

  • (String) —

    Why a hosted_number_order reached status “action-required”


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

def failure_reason
  @properties['failure_reason']
end

#friendly_name ⇒ String

Returns A human readable description of this resource.

Returns:

  • (String) —

    A human readable description of this resource.


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

def friendly_name
  @properties['friendly_name']
end

#incoming_phone_number_sid ⇒ String

Returns IncomingPhoneNumber sid.

Returns:

  • (String) —

    IncomingPhoneNumber sid.


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

def incoming_phone_number_sid
  @properties['incoming_phone_number_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


395
396
397
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 395

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

#phone_number ⇒ String

Returns An E164 formatted phone number.

Returns:

  • (String) —

    An E164 formatted phone number.


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

def phone_number
  @properties['phone_number']
end

#sid ⇒ String

Returns HostedNumberOrder sid.

Returns:

  • (String) —

    HostedNumberOrder sid.


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

def sid
  @properties['sid']
end

#signing_document_sid ⇒ String

Returns LOA document sid.

Returns:

  • (String) —

    LOA document sid.


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

def signing_document_sid
  @properties['signing_document_sid']
end

#status ⇒ dependent_hosted_number_order.Status

Returns The Status of this HostedNumberOrder.

Returns:

  • (dependent_hosted_number_order.Status) —

    The Status of this HostedNumberOrder.


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

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation


389
390
391
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 389

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

#unique_name ⇒ String

Returns A unique, developer assigned name of this HostedNumberOrder.

Returns:

  • (String) —

    A unique, developer assigned name of this HostedNumberOrder.


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

def unique_name
  @properties['unique_name']
end

#verification_attempts ⇒ String

Returns The number of attempts made to verify ownership of the phone number.

Returns:

  • (String) —

    The number of attempts made to verify ownership of the phone number.


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

def verification_attempts
  @properties['verification_attempts']
end

#verification_call_sids ⇒ Array[String]

Returns List of IDs for ownership verification calls.

Returns:

  • (Array[String]) —

    List of IDs for ownership verification calls.


383
384
385
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 383

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.


377
378
379
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 377

def verification_code
  @properties['verification_code']
end

#verification_document_sid ⇒ String

Returns Verification Document Sid.

Returns:

  • (String) —

    Verification Document Sid.


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

def verification_document_sid
  @properties['verification_document_sid']
end

#verification_type ⇒ dependent_hosted_number_order.VerificationType

Returns The method used for verifying ownership of the number to be hosted.

Returns:

  • (dependent_hosted_number_order.VerificationType) —

    The method used for verifying ownership of the number to be hosted.


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

def verification_type
  @properties['verification_type']
end