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

Inherits:
ListResource
  • 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: nil, credential_list_sid: nil) ⇒ CredentialList

Initialize the CredentialList



30
31
32
33
34
35
36
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 30

def initialize(version, account_sid: nil, credential_list_sid: nil)
    super(version)
    # Path Solution
    @solution = { account_sid: , credential_list_sid: credential_list_sid }
    @uri = "/Accounts/#{@solution[:account_sid]}/SIP/CredentialLists/#{@solution[:credential_list_sid]}/Credentials.json"
    
end

Instance Method Details

#create(username: nil, password: nil) ⇒ CredentialInstance

Create the CredentialInstance



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 42

def create(
    username: nil, 
    password: nil
)

    data = Twilio::Values.of({
        'Username' => username,
        'Password' => password,
    })

    
    payload = @version.create('POST', @uri, data: data)
    CredentialInstance.new(
        @version,
        payload,
        account_sid: @solution[:account_sid],
        credential_list_sid: @solution[:credential_list_sid],
    )
end

#each ⇒ Object

When passed a block, yields CredentialInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



105
106
107
108
109
110
111
112
113
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 105

def each
    limits = @version.read_limits

    page = self.page(page_size: limits[:page_size], )

    @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of CredentialInstance records from the API. Request is executed immediately.



139
140
141
142
143
144
145
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 139

def get_page(target_url)
    response = @version.domain.request(
        'GET',
        target_url
    )
CredentialPage.new(@version, response, @solution)
end

#list(limit: nil, page_size: nil) ⇒ Array

Lists CredentialInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.



74
75
76
77
78
79
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 74

def list(limit: nil, page_size: nil)
    self.stream(
        limit: limit,
        page_size: page_size
    ).entries
end

#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of CredentialInstance records from the API. Request is executed immediately.



122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 122

def page(page_token: :unset, page_number: :unset, page_size: :unset)
    params = Twilio::Values.of({
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })

    response = @version.page('GET', @uri, params: params)

    CredentialPage.new(@version, response, @solution)
end

#stream(limit: nil, page_size: nil) ⇒ Enumerable

Streams Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.



92
93
94
95
96
97
98
99
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 92

def stream(limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        page_size: limits[:page_size], )

    @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



150
151
152
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 150

def to_s
    '#<Twilio.Api.V2010.CredentialList>'
end