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 that created the OutgoingCallerId resource to fetch.

  • sid (String) —

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


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

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


222
223
224
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 222

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

#fetch ⇒ OutgoingCallerIdInstance

Fetch the OutgoingCallerIdInstance

Returns:


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

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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation


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

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

#to_s ⇒ Object

Provide a user friendly representation


228
229
230
231
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 228

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:


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

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