Class: Twilio::REST::Api::V2010::AccountContext::SipList::CredentialListContext::CredentialContext

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

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid, credential_list_sid, sid) ⇒ CredentialContext

Initialize the CredentialContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • account_sid (String) —

    The unique id of the Account that is responsible for this resource.

  • credential_list_sid (String) —

    The unique id that identifies the credential list that contains the desired credential.

  • sid (String) —

    The unique id that identifies the resource to fetch.



193
194
195
196
197
198
199
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 193

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

  # Path Solution
  @solution = {account_sid: , credential_list_sid: credential_list_sid, sid: sid, }
  @uri = "/Accounts/#{@solution[:account_sid]}/SIP/CredentialLists/#{@solution[:credential_list_sid]}/Credentials/#{@solution[:sid]}.json"
end

Instance Method Details

#delete ⇒ Boolean

Deletes the CredentialInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



249
250
251
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 249

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

#fetch ⇒ CredentialInstance

Fetch a CredentialInstance

Returns:



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

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

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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



262
263
264
265
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 262

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

#to_s ⇒ Object

Provide a user friendly representation



255
256
257
258
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 255

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

#update(password: :unset) ⇒ CredentialInstance

Update the CredentialInstance

Parameters:

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

    The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg ‘IWasAtSignal2018`)

Returns:



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 228

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

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

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