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.



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 153

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



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

def 
    @properties['account_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:



181
182
183
184
185
186
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 181

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

#date_created ⇒ Time

Returns:

  • (Time) 


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

def date_created
    @properties['date_created']
end

#delete ⇒ Boolean

Delete the PortingPortInInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

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.



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

def documents
    @properties['documents']
end

#fetch ⇒ PortingPortInInstance

Fetch the PortingPortInInstance

Returns:



271
272
273
274
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 271

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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.



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

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.



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

def notification_emails
    @properties['notification_emails']
end

#phone_numbers ⇒ Array<Hash>

Returns:

  • (Array<Hash>) 


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

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.



190
191
192
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 190

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.



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

def port_in_request_status
    @properties['port_in_request_status']
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. (This value is only available for custom porting customers.).

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. (This value is only available for custom porting customers.)



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

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’. (This value is only available for custom porting customers.).

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’. (This value is only available for custom porting customers.)



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

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’. (This value is only available for custom porting customers.).

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’. (This value is only available for custom porting customers.)



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

def target_port_in_time_range_start
    @properties['target_port_in_time_range_start']
end

#to_s ⇒ Object

Provide a user friendly representation



278
279
280
281
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb', line 278

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



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

def url
    @properties['url']
end