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



156
157
158
159
160
161
162
163
164
165
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb', line 156

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) 


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

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

#delete ⇒ Boolean

Delete the CredentialListInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



169
170
171
172
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb', line 169

def delete

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

#fetch ⇒ CredentialListInstance

Fetch the CredentialListInstance

Returns:



177
178
179
180
181
182
183
184
185
186
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb', line 177

def fetch

    payload = @version.fetch('GET', @uri)
    CredentialListInstance.new(
        @version,
        payload,
        account_sid: @solution[:account_sid],
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



238
239
240
241
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb', line 238

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

#to_s ⇒ Object

Provide a user friendly representation



231
232
233
234
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb', line 231

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:



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

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