Class: Twilio::REST::Proxy::V1::ServiceContext::PhoneNumberContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, sid) ⇒ PhoneNumberContext

Initialize the PhoneNumberContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) —

    The SID of the parent [Service](www.twilio.com/docs/proxy/api/service) of the PhoneNumber resource to update.

  • sid (String) —

    The Twilio-provided string that uniquely identifies the PhoneNumber resource to update.



163
164
165
166
167
168
169
170
171
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 163

def initialize(version, service_sid, sid)
    super(version)

    # Path Solution
    @solution = { service_sid: service_sid, sid: sid,  }
    @uri = "/Services/#{@solution[:service_sid]}/PhoneNumbers/#{@solution[:sid]}"

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the PhoneNumberInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



175
176
177
178
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 175

def delete

    @version.delete('DELETE', @uri)
end

#fetch ⇒ PhoneNumberInstance

Fetch the PhoneNumberInstance

Returns:



183
184
185
186
187
188
189
190
191
192
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 183

def fetch

    payload = @version.fetch('GET', @uri)
    PhoneNumberInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



225
226
227
228
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 225

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Proxy.V1.PhoneNumberContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



218
219
220
221
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 218

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Proxy.V1.PhoneNumberContext #{context}>"
end

#update(is_reserved: :unset) ⇒ PhoneNumberInstance

Update the PhoneNumberInstance

Parameters:

  • is_reserved (Boolean) (defaults to: :unset) —

    Whether the phone number should be reserved and not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](www.twilio.com/docs/proxy/reserved-phone-numbers) for more information.

Returns:



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 198

def update(
    is_reserved: :unset
)

    data = Twilio::Values.of({
        'IsReserved' => is_reserved,
    })

    payload = @version.update('POST', @uri, data: data)
    PhoneNumberInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        sid: @solution[:sid],
    )
end