Class: Twilio::REST::Numbers::V1::PortingPortInFetchInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the PortingPortInFetchInstance

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

  • sid (String) —

    The SID of the Call resource to fetch.



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in_fetch.rb', line 126

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

    # 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 The Account SID that the numbers will be added to after they are ported into Twilio.

Returns:

  • (String) —

    The Account SID that the numbers will be added to after they are ported into Twilio.



174
175
176
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in_fetch.rb', line 174

def 
    @properties['account_sid']
end

#context ⇒ PortingPortInFetchContext

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

Returns:



153
154
155
156
157
158
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in_fetch.rb', line 153

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

#documents ⇒ Array<String>

Returns The list of documents SID referencing a utility bills.

Returns:

  • (Array<String>) —

    The list of documents SID referencing a utility bills



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

def documents
    @properties['documents']
end

#fetch ⇒ PortingPortInFetchInstance

Fetch the PortingPortInFetchInstance

Returns:



229
230
231
232
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in_fetch.rb', line 229

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#losing_carrier_information ⇒ Hash

Returns The information for the losing carrier.

Returns:

  • (Hash) —

    The information for the losing carrier.



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

def losing_carrier_information
    @properties['losing_carrier_information']
end

#notification_emails ⇒ Array<String>

Returns List of emails for getting notifications about the LOA signing process. Allowed Max 10 emails.

Returns:

  • (Array<String>) —

    List of emails for getting notifications about the LOA signing process. Allowed Max 10 emails.



180
181
182
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in_fetch.rb', line 180

def notification_emails
    @properties['notification_emails']
end

#phone_numbers ⇒ Array<Hash>

Returns The list of phone numbers to Port in. Phone numbers are in E.164 format (e.g. +16175551212).

Returns:

  • (Array<Hash>) —

    The list of phone numbers to Port in. Phone numbers are in E.164 format (e.g. +16175551212).



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

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.



162
163
164
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in_fetch.rb', line 162

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.



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

def port_in_request_status
    @properties['port_in_request_status']
end

#target_port_in_date ⇒ Date

Returns Minimum number of days in the future (at least 2 days) needs to be established with the Ops team for validation.

Returns:

  • (Date) —

    Minimum number of days in the future (at least 2 days) needs to be established with the Ops team for validation.



186
187
188
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in_fetch.rb', line 186

def target_port_in_date
    @properties['target_port_in_date']
end

#target_port_in_time_range_end ⇒ String

Returns Maximum hour in the future needs to be established with the Ops team for validation.

Returns:

  • (String) —

    Maximum hour in the future needs to be established with the Ops team for validation.



198
199
200
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in_fetch.rb', line 198

def target_port_in_time_range_end
    @properties['target_port_in_time_range_end']
end

#target_port_in_time_range_start ⇒ String

Returns Minimum hour in the future needs to be established with the Ops team for validation.

Returns:

  • (String) —

    Minimum hour in the future needs to be established with the Ops team for validation.



192
193
194
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in_fetch.rb', line 192

def target_port_in_time_range_start
    @properties['target_port_in_time_range_start']
end

#to_s ⇒ Object

Provide a user friendly representation



236
237
238
239
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in_fetch.rb', line 236

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

#url ⇒ String

Returns The URL of this Port In request.

Returns:

  • (String) —

    The URL of this Port In request



168
169
170
 
# File 'lib/twilio-ruby/rest/numbers/v1/porting_port_in_fetch.rb', line 168

def url
    @properties['url']
end