Class: Twilio::REST::Numbers::V1::PortingPortInInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, port_in_request_sid: nil) ⇒ PortingPortInInstance

Initialize the PortingPortInInstance

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

  • sid (String) —

    The SID of the Call resource to fetch.



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 432

def initialize(version, payload , port_in_request_sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'port_in_request_sid' => payload['port_in_request_sid'],
        'url' => payload['url'],
        'account_sid' => payload['account_sid'],
        'notification_emails' => payload['notification_emails'],
        'target_port_in_date' => Twilio.deserialize_iso8601_date(payload['target_port_in_date']),
        'target_port_in_time_range_start' => payload['target_port_in_time_range_start'],
        'target_port_in_time_range_end' => payload['target_port_in_time_range_end'],
        'port_in_request_status' => payload['port_in_request_status'],
        'order_cancellation_reason' => payload['order_cancellation_reason'],
        'losing_carrier_information' => payload['losing_carrier_information'],
        'phone_numbers' => payload['phone_numbers'],
        'bundle_sid' => payload['bundle_sid'],
        'portability_advance_carrier' => payload['portability_advance_carrier'],
        'auto_cancel_approval_numbers' => payload['auto_cancel_approval_numbers'],
        'documents' => payload['documents'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'support_ticket_id' => payload['support_ticket_id'] == nil ? payload['support_ticket_id'] : payload['support_ticket_id'].to_i,
        'signature_request_url' => payload['signature_request_url'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns Account Sid or subaccount where the phone number(s) will be Ported.

Returns:

  • (String) —

    Account Sid or subaccount where the phone number(s) will be Ported



488
489
490
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 488

def 
    @properties['account_sid']
end

#auto_cancel_approval_numbers ⇒ String

Returns Japan specific field, indicates the number of phone numbers to automatically approve for cancellation.

Returns:

  • (String) —

    Japan specific field, indicates the number of phone numbers to automatically approve for cancellation.



554
555
556
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 554

def auto_cancel_approval_numbers
    @properties['auto_cancel_approval_numbers']
end

#bundle_sid ⇒ String

Returns The bundle sid is an optional identifier to reference a group of regulatory documents for a port request.

Returns:

  • (String) —

    The bundle sid is an optional identifier to reference a group of regulatory documents for a port request.



542
543
544
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 542

def bundle_sid
    @properties['bundle_sid']
end

#context ⇒ PortingPortInContext

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

Returns:



467
468
469
470
471
472
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 467

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

#date_created ⇒ Time

Returns:

  • (Time) 


566
567
568
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 566

def date_created
    @properties['date_created']
end

#delete ⇒ Boolean

Delete the PortingPortInInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



585
586
587
588
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 585

def delete

    context.delete
end

#documents ⇒ Array<String>

Returns List of document SIDs for all phone numbers included in the port in request. At least one document SID referring to a document of the type Utility Bill is required.

Returns:

  • (Array<String>) —

    List of document SIDs for all phone numbers included in the port in request. At least one document SID referring to a document of the type Utility Bill is required.



560
561
562
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 560

def documents
    @properties['documents']
end

#fetch ⇒ PortingPortInInstance

Fetch the PortingPortInInstance

Returns:



593
594
595
596
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 593

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



607
608
609
610
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 607

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

#losing_carrier_information ⇒ NumbersV1PortingLosingCarrierInformation

Returns:

  • (NumbersV1PortingLosingCarrierInformation) 


530
531
532
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 530

def losing_carrier_information
    @properties['losing_carrier_information']
end

#notification_emails ⇒ Array<String>

Returns Additional emails to send a copy of the signed LOA to.

Returns:

  • (Array<String>) —

    Additional emails to send a copy of the signed LOA to.



494
495
496
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 494

def notification_emails
    @properties['notification_emails']
end

#order_cancellation_reason ⇒ String

Returns If the order is cancelled this field will provide further context on the cause of the cancellation.

Returns:

  • (String) —

    If the order is cancelled this field will provide further context on the cause of the cancellation.



524
525
526
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 524

def order_cancellation_reason
    @properties['order_cancellation_reason']
end

#phone_numbers ⇒ Array<NumbersV1PortingPortInPhoneNumberResult>

Returns:

  • (Array<NumbersV1PortingPortInPhoneNumberResult>) 


536
537
538
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 536

def phone_numbers
    @properties['phone_numbers']
end

#port_in_request_sid ⇒ String

Returns The SID of the Port In request. This is a unique identifier of the port in request.

Returns:

  • (String) —

    The SID of the Port In request. This is a unique identifier of the port in request.



476
477
478
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 476

def port_in_request_sid
    @properties['port_in_request_sid']
end

#port_in_request_status ⇒ String

Returns The status of the port in request. The possible values are: In progress, Completed, Expired, In review, Waiting for Signature, Action Required, and Canceled.

Returns:

  • (String) —

    The status of the port in request. The possible values are: In progress, Completed, Expired, In review, Waiting for Signature, Action Required, and Canceled.



518
519
520
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 518

def port_in_request_status
    @properties['port_in_request_status']
end

#portability_advance_carrier ⇒ String

Returns A field only required for Japan port in requests. It is a unique identifier for the donor carrier service the line is being ported from.

Returns:

  • (String) —

    A field only required for Japan port in requests. It is a unique identifier for the donor carrier service the line is being ported from.



548
549
550
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 548

def portability_advance_carrier
    @properties['portability_advance_carrier']
end

#signature_request_url ⇒ String

Returns:

  • (String) 


578
579
580
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 578

def signature_request_url
    @properties['signature_request_url']
end

#support_ticket_id ⇒ String

Returns Unique ID of the request’s support ticket.

Returns:

  • (String) —

    Unique ID of the request’s support ticket



572
573
574
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 572

def support_ticket_id
    @properties['support_ticket_id']
end

#target_port_in_date ⇒ Date

Returns Target date to port the number. We cannot guarantee that this date will be honored by the other carriers, please work with Ops to get a confirmation of the firm order commitment (FOC) date. Expected format is ISO Local Date, example: ‘2011-12-03`. This date must be at least 7 days in the future for US ports and 10 days in the future for Japanese ports. If a start and end range is provided, the date will be converted to its UTC equivalent with the ranges as reference and stored in UTC. We can’t guarantee the exact date and time, as this depends on the losing carrier.

Returns:

  • (Date) —

    Target date to port the number. We cannot guarantee that this date will be honored by the other carriers, please work with Ops to get a confirmation of the firm order commitment (FOC) date. Expected format is ISO Local Date, example: ‘2011-12-03`. This date must be at least 7 days in the future for US ports and 10 days in the future for Japanese ports. If a start and end range is provided, the date will be converted to its UTC equivalent with the ranges as reference and stored in UTC. We can’t guarantee the exact date and time, as this depends on the losing carrier.



500
501
502
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 500

def target_port_in_date
    @properties['target_port_in_date']
end

#target_port_in_time_range_end ⇒ String

Returns The latest time that the port should occur on the target port in date. Expected format is ISO Offset Time, example: ‘10:15:00-08:00’. We can’t guarantee the exact date and time, as this depends on the losing carrier. The time will be stored and returned as UTC standard timezone.

Returns:

  • (String) —

    The latest time that the port should occur on the target port in date. Expected format is ISO Offset Time, example: ‘10:15:00-08:00’. We can’t guarantee the exact date and time, as this depends on the losing carrier. The time will be stored and returned as UTC standard timezone.



512
513
514
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 512

def target_port_in_time_range_end
    @properties['target_port_in_time_range_end']
end

#target_port_in_time_range_start ⇒ String

Returns The earliest time that the port should occur on the target port in date. Expected format is ISO Offset Time, example: ‘10:15:00-08:00’. We can’t guarantee the exact date and time, as this depends on the losing carrier. The time will be stored and returned as UTC standard timezone.

Returns:

  • (String) —

    The earliest time that the port should occur on the target port in date. Expected format is ISO Offset Time, example: ‘10:15:00-08:00’. We can’t guarantee the exact date and time, as this depends on the losing carrier. The time will be stored and returned as UTC standard timezone.



506
507
508
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 506

def target_port_in_time_range_start
    @properties['target_port_in_time_range_start']
end

#to_s ⇒ Object

Provide a user friendly representation



600
601
602
603
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 600

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

#url ⇒ String

Returns The URL of this Port In request.

Returns:

  • (String) —

    The URL of this Port In request



482
483
484
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 482

def url
    @properties['url']
end