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/api/rest/account) that created the OutgoingCallerId resource to fetch.

  • sid (String) —

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



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

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

Deletes the OutgoingCallerIdInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



234
235
236
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 234

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

#fetch ⇒ OutgoingCallerIdInstance

Fetch a OutgoingCallerIdInstance

Returns:



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

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  OutgoingCallerIdInstance.new(
      @version,
      payload,
      account_sid: @solution[:account_sid],
      sid: @solution[:sid],
  )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



247
248
249
250
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 247

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

#to_s ⇒ Object

Provide a user friendly representation



240
241
242
243
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 240

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:



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

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

  payload = @version.update(
      'POST',
      @uri,
      data: data,
  )

  OutgoingCallerIdInstance.new(
      @version,
      payload,
      account_sid: @solution[:account_sid],
      sid: @solution[:sid],
  )
end