Class: Twilio::REST::Numbers::V3::HostedNumberOrderInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload) ⇒ HostedNumberOrderInstance

Initialize the HostedNumberOrderInstance

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

  • sid (String) —

    The SID of the Call resource to fetch.



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 153

def initialize(version, payload )
    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'],
        'url' => payload['url'],
        '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 A 34 character string that uniquely identifies the account.

Returns:

  • (String) —

    A 34 character string that uniquely identifies the account.



193
194
195
 
# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 193

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.



205
206
207
 
# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 205

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.



307
308
309
 
# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 307

def call_delay
    @properties['call_delay']
end

#capabilities ⇒ NumbersV3HostedNumbersHostedNumberOrderCapabilities

Returns:

  • (NumbersV3HostedNumbersHostedNumberOrderCapabilities) 


223
224
225
 
# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 223

def capabilities
    @properties['capabilities']
end

#cc_emails ⇒ Array<String>

Returns A list of emails that LOA document for this HostedNumberOrder will be carbon copied to.

Returns:

  • (Array<String>) —

    A list of emails that LOA document for this HostedNumberOrder will be carbon copied to.



277
278
279
 
# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 277

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:



253
254
255
 
# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 253

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:



259
260
261
 
# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 259

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.



271
272
273
 
# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 271

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.



301
302
303
 
# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 301

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"



247
248
249
 
# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 247

def failure_reason
    @properties['failure_reason']
end

#friendly_name ⇒ String

Returns A 64 character string that is a human-readable text that describes this resource.

Returns:

  • (String) —

    A 64 character string that is a human-readable text that describes this resource.



229
230
231
 
# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 229

def friendly_name
    @properties['friendly_name']
end

#incoming_phone_number_sid ⇒ String

Returns A 34 character string that uniquely identifies the [IncomingPhoneNumber](www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource) resource that represents the phone number being hosted.

Returns:



199
200
201
 
# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 199

def incoming_phone_number_sid
    @properties['incoming_phone_number_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



331
332
333
 
# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 331

def inspect
    "<Twilio.Numbers.V3.HostedNumberOrderInstance>"
end

#phone_number ⇒ String

Returns Phone number to be hosted. This must be in [E.164](en.wikipedia.org/wiki/E.164) format, e.g., +16175551212.

Returns:



217
218
219
 
# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 217

def phone_number
    @properties['phone_number']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this HostedNumberOrder.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this HostedNumberOrder.



187
188
189
 
# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 187

def sid
    @properties['sid']
end

#signing_document_sid ⇒ String

Returns A 34 character string that uniquely identifies the [Authorization Document](www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource) the user needs to sign.

Returns:



211
212
213
 
# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 211

def signing_document_sid
    @properties['signing_document_sid']
end

#status ⇒ Status

Returns:

  • (Status) 


241
242
243
 
# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 241

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



325
326
327
 
# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 325

def to_s
    "<Twilio.Numbers.V3.HostedNumberOrderInstance>"
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.



235
236
237
 
# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 235

def unique_name
    @properties['unique_name']
end

#url ⇒ String

Returns The URL of this HostedNumberOrder.

Returns:

  • (String) —

    The URL of this HostedNumberOrder.



283
284
285
 
# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 283

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



265
266
267
 
# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 265

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.



319
320
321
 
# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 319

def verification_call_sids
    @properties['verification_call_sids']
end

#verification_code ⇒ String

Returns A verification code provided in the response for a user to enter when they pick up the phone call.

Returns:

  • (String) —

    A verification code provided in the response for a user to enter when they pick up the phone call.



313
314
315
 
# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 313

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.



295
296
297
 
# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 295

def verification_document_sid
    @properties['verification_document_sid']
end

#verification_type ⇒ VerificationType

Returns:

  • (VerificationType) 


289
290
291
 
# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 289

def verification_type
    @properties['verification_type']
end