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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil) ⇒ CredentialListList

Initialize the CredentialListList



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

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

Instance Method Details

#create(friendly_name: nil) ⇒ CredentialListInstance

Create the CredentialListInstance



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb', line 39

def create(
    friendly_name: nil
)

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

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

#each ⇒ Object

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



98
99
100
101
102
103
104
105
106
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb', line 98

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 CredentialListInstance records from the API. Request is executed immediately.



132
133
134
135
136
137
138
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb', line 132

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

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

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



67
68
69
70
71
72
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb', line 67

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 CredentialListInstance records from the API. Request is executed immediately.



115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb', line 115

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)

    CredentialListPage.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.



85
86
87
88
89
90
91
92
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb', line 85

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



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

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