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.



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 163

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'],
        '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']),
    }

    # 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



215
216
217
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 215

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.



275
276
277
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 275

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.



263
264
265
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 263

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:



194
195
196
197
198
199
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 194

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

#date_created ⇒ Time

Returns:

  • (Time) 


287
288
289
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 287

def date_created
    @properties['date_created']
end

#delete ⇒ Boolean

Delete the PortingPortInInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



294
295
296
297
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 294

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.



281
282
283
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 281

def documents
    @properties['documents']
end

#fetch ⇒ PortingPortInInstance

Fetch the PortingPortInInstance

Returns:



302
303
304
305
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 302

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



316
317
318
319
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 316

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

#losing_carrier_information ⇒ Hash

Returns Details regarding the customer’s information with the losing carrier. These values will be used to generate the letter of authorization and should match the losing carrier’s data as closely as possible to ensure the port is accepted.

Returns:

  • (Hash) —

    Details regarding the customer’s information with the losing carrier. These values will be used to generate the letter of authorization and should match the losing carrier’s data as closely as possible to ensure the port is accepted.



251
252
253
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 251

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.



221
222
223
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 221

def notification_emails
    @properties['notification_emails']
end

#phone_numbers ⇒ Array<Hash>

Returns:

  • (Array<Hash>) 


257
258
259
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 257

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.



203
204
205
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 203

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.



245
246
247
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 245

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.



269
270
271
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 269

def portability_advance_carrier
    @properties['portability_advance_carrier']
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. 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. We can’t guarantee the exact date and time, as this depends on the losing carrier



227
228
229
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 227

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.

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



239
240
241
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 239

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.

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



233
234
235
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 233

def target_port_in_time_range_start
    @properties['target_port_in_time_range_start']
end

#to_s ⇒ Object

Provide a user friendly representation



309
310
311
312
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 309

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



209
210
211
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 209

def url
    @properties['url']
end