Class: Twilio::REST::Api::V2010::AccountContext::ShortCodeContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/short_code.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid, sid) ⇒ ShortCodeContext

Initialize the ShortCodeContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • account_sid (String) —

    The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the ShortCode resource(s) to update.

  • sid (String) —

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



178
179
180
181
182
183
184
185
186
187
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 178

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

    # Path Solution
    @solution = { account_sid: , sid: sid,  }
    @uri = "/Accounts/#{@solution[:account_sid]}/SMS/ShortCodes/#{@solution[:sid]}.json"

    
end

Instance Method Details

#fetch ⇒ ShortCodeInstance

Fetch the ShortCodeInstance

Returns:



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 191

def fetch

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

#fetch_with_metadata ⇒ ShortCodeInstance

Fetch the ShortCodeInstanceMetadata

Returns:



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

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    short_code_instance = ShortCodeInstance.new(
        @version,
        response.body,
        account_sid: @solution[:account_sid],
        sid: @solution[:sid],
    )
    ShortCodeInstanceMetadata.new(
        @version,
        short_code_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



334
335
336
337
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 334

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

#to_s ⇒ Object

Provide a user friendly representation



327
328
329
330
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 327

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

#update(friendly_name: :unset, api_version: :unset, sms_url: :unset, sms_method: :unset, sms_fallback_url: :unset, sms_fallback_method: :unset) ⇒ ShortCodeInstance

Update the ShortCodeInstance

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    A descriptive string that you created to describe this resource. It can be up to 64 characters long. By default, the FriendlyName is the short code.

  • api_version (String) (defaults to: :unset) —

    The API version to use to start a new TwiML session. Can be: 2010-04-01 or 2008-08-01.

  • sms_url (String) (defaults to: :unset) —

    The URL we should call when receiving an incoming SMS message to this short code.

  • sms_method (String) (defaults to: :unset) —

    The HTTP method we should use when calling the sms_url. Can be: GET or POST.

  • sms_fallback_url (String) (defaults to: :unset) —

    The URL that we should call if an error occurs while retrieving or executing the TwiML from sms_url.

  • sms_fallback_method (String) (defaults to: :unset) —

    The HTTP method that we should use to call the sms_fallback_url. Can be: GET or POST.

Returns:



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 243

def update(
    friendly_name: :unset, 
    api_version: :unset, 
    sms_url: :unset, 
    sms_method: :unset, 
    sms_fallback_url: :unset, 
    sms_fallback_method: :unset
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
        'ApiVersion' => api_version,
        'SmsUrl' => sms_url,
        'SmsMethod' => sms_method,
        'SmsFallbackUrl' => sms_fallback_url,
        'SmsFallbackMethod' => sms_fallback_method,
    })

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

#update_with_metadata(friendly_name: :unset, api_version: :unset, sms_url: :unset, sms_method: :unset, sms_fallback_url: :unset, sms_fallback_method: :unset) ⇒ ShortCodeInstance

Update the ShortCodeInstanceMetadata

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    A descriptive string that you created to describe this resource. It can be up to 64 characters long. By default, the FriendlyName is the short code.

  • api_version (String) (defaults to: :unset) —

    The API version to use to start a new TwiML session. Can be: 2010-04-01 or 2008-08-01.

  • sms_url (String) (defaults to: :unset) —

    The URL we should call when receiving an incoming SMS message to this short code.

  • sms_method (String) (defaults to: :unset) —

    The HTTP method we should use when calling the sms_url. Can be: GET or POST.

  • sms_fallback_url (String) (defaults to: :unset) —

    The URL that we should call if an error occurs while retrieving or executing the TwiML from sms_url.

  • sms_fallback_method (String) (defaults to: :unset) —

    The HTTP method that we should use to call the sms_fallback_url. Can be: GET or POST.

Returns:



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 285

def update_with_metadata(
  friendly_name: :unset, 
  api_version: :unset, 
  sms_url: :unset, 
  sms_method: :unset, 
  sms_fallback_url: :unset, 
  sms_fallback_method: :unset
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
        'ApiVersion' => api_version,
        'SmsUrl' => sms_url,
        'SmsMethod' => sms_method,
        'SmsFallbackUrl' => sms_fallback_url,
        'SmsFallbackMethod' => sms_fallback_method,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
    short_code_instance = ShortCodeInstance.new(
        @version,
        response.body,
        account_sid: @solution[:account_sid],
        sid: @solution[:sid],
    )
    ShortCodeInstanceMetadata.new(
        @version,
        short_code_instance,
        response.headers,
        response.status_code
    )
end