Class: Twilio::REST::Proxy::V1::ServiceContext::ShortCodeContext

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

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, sid) ⇒ ShortCodeContext

Initialize the ShortCodeContext

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 resource to update.

  • sid (String) —

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



165
166
167
168
169
170
171
172
173
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 165

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

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

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the ShortCodeInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



177
178
179
180
181
182
183
184
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 177

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    @version.delete('DELETE', @uri, headers: headers)
end

#fetch ⇒ ShortCodeInstance

Fetch the ShortCodeInstance

Returns:



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 189

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    ShortCodeInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



243
244
245
246
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 243

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

#to_s ⇒ Object

Provide a user friendly representation



236
237
238
239
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 236

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

#update(is_reserved: :unset) ⇒ ShortCodeInstance

Update the ShortCodeInstance

Parameters:

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

    Whether the short code 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:



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/short_code.rb', line 210

def update(
    is_reserved: :unset
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.update('POST', @uri, data: data, headers: headers)
    ShortCodeInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        sid: @solution[:sid],
    )
end