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

Parameters:

  • version (Version) —

    Version that contains the resource



30
31
32
33
34
35
36
37
 
# 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

Parameters:

  • username (String) (defaults to: nil) —

    The username that will be passed when authenticating SIP requests. The username should be sent in response to Twilio’s challenge of the initial INVITE. It can be up to 32 characters long.

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

    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:



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

def create(
    username: nil, 
    password: nil
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    CredentialInstance.new(
        @version,
        payload,
        account_sid: @solution[:account_sid],
        credential_list_sid: @solution[:credential_list_sid],
    )
end

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

Create the CredentialInstanceMetadata

Parameters:

  • username (String) (defaults to: nil) —

    The username that will be passed when authenticating SIP requests. The username should be sent in response to Twilio’s challenge of the initial INVITE. It can be up to 32 characters long.

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

    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:



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 73

def create_with_metadata(
  username: nil, 
  password: nil
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    credential_instance = CredentialInstance.new(
        @version,
        response.body,
        account_sid: @solution[:account_sid],
        credential_list_sid: @solution[:credential_list_sid],
    )
    CredentialInstanceMetadata.new(
        @version,
        credential_instance,
        response.headers,
        response.status_code
    )
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.



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

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of CredentialInstance



206
207
208
209
210
211
212
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 206

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.

Parameters:

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



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

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

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

Lists CredentialPageMetadata records from the API as a list.

Parameters:

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 152

def list_with_metadata(limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

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

    CredentialPageMetadata.new(@version, response, @solution, limits[:limit])
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.

Parameters:

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

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of CredentialInstance



186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 186

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

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

    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.

Parameters:

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



134
135
136
137
138
139
140
141
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 134

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



217
218
219
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 217

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