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

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

Defined Under Namespace

Classes: CredentialContext, CredentialInstance, CredentialList, CredentialPage

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid, sid) ⇒ CredentialListContext

Initialize the CredentialListContext

Parameters:

  • version (Version)

    Version that contains the resource

  • account_sid (String)

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

  • sid (String)

    The credential list Sid that uniquely identifies this resource


168
169
170
171
172
173
174
175
176
177
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb', line 168

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

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

  # Dependents
  @credentials = nil
end

Instance Method Details

#credentials(sid = :unset) ⇒ CredentialList, CredentialContext

Access the credentials

Returns:

Raises:

  • (ArgumentError)

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

def credentials(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return CredentialContext.new(@version, @solution[:account_sid], @solution[:sid], sid, )
  end

  unless @credentials
    @credentials = CredentialList.new(
        @version,
        account_sid: @solution[:account_sid],
        credential_list_sid: @solution[:sid],
    )
  end

  @credentials
end

#deleteBoolean

Delete the CredentialListInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


214
215
216
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb', line 214

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

#fetchCredentialListInstance

Fetch the CredentialListInstance

Returns:


182
183
184
185
186
187
188
189
190
191
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb', line 182

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

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

#inspectObject

Provide a detailed, user friendly representation


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

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

#to_sObject

Provide a user friendly representation


242
243
244
245
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb', line 242

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

#update(friendly_name: nil) ⇒ CredentialListInstance

Update the CredentialListInstance

Parameters:

  • friendly_name (String) (defaults to: nil)

    A human readable descriptive text for a CredentialList, up to 64 characters long.

Returns:


198
199
200
201
202
203
204
205
206
207
208
209
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb', line 198

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

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

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