Class: Twilio::REST::Api::V2010::AccountContext::OutgoingCallerIdContext

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

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid, sid) ⇒ OutgoingCallerIdContext

Initialize the OutgoingCallerIdContext

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 OutgoingCallerId resources to update.

  • sid (String) —

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



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

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

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

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the OutgoingCallerIdInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



191
192
193
194
195
196
197
198
199
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 191

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    

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

#delete_with_metadata ⇒ Boolean

Delete the OutgoingCallerIdInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 204

def delete_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
      response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
      outgoingCallerId_instance = OutgoingCallerIdInstance.new(
          @version,
          response.body,
          account_sid: @solution[:account_sid],
          sid: @solution[:sid],
      )
      OutgoingCallerIdInstanceMetadata.new(@version, outgoingCallerId_instance, response.headers, response.status_code)
end

#fetch ⇒ OutgoingCallerIdInstance

Fetch the OutgoingCallerIdInstance

Returns:



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 223

def fetch

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

#fetch_with_metadata ⇒ OutgoingCallerIdInstance

Fetch the OutgoingCallerIdInstanceMetadata

Returns:



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 243

def fetch_with_metadata

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



336
337
338
339
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 336

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

#to_s ⇒ Object

Provide a user friendly representation



329
330
331
332
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 329

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

#update(friendly_name: :unset) ⇒ OutgoingCallerIdInstance

Update the OutgoingCallerIdInstance

Parameters:

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

    A descriptive string that you create to describe the resource. It can be up to 64 characters long.

Returns:



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 270

def update(
    friendly_name: :unset
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
    })

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

#update_with_metadata(friendly_name: :unset) ⇒ OutgoingCallerIdInstance

Update the OutgoingCallerIdInstanceMetadata

Parameters:

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

    A descriptive string that you create to describe the resource. It can be up to 64 characters long.

Returns:



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
323
324
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 297

def update_with_metadata(
  friendly_name: :unset
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
    })

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