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 account_sid

  • sid (String) —

    The outgoing-caller-id Sid that uniquely identifies this resource



176
177
178
179
180
181
182
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 176

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



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

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

#fetch ⇒ OutgoingCallerIdInstance

Fetch a OutgoingCallerIdInstance

Returns:



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

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

#to_s ⇒ Object

Provide a user friendly representation



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

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 human readable description of the caller ID

Returns:



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 208

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