Class: Twilio::REST::IpMessaging::V1::CredentialList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/ip_messaging/v1/credential.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ CredentialList

Initialize the CredentialList



26
27
28
29
30
31
32
33
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/credential.rb', line 26

def initialize(version)
    super(version)
    
    # Path Solution
    @solution = {  }
    @uri = "/Credentials"
    
end

Instance Method Details

#create(type: nil, friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset) ⇒ CredentialInstance

Create the CredentialInstance



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/credential.rb', line 44

def create(
    type: nil, 
    friendly_name: :unset, 
    certificate: :unset, 
    private_key: :unset, 
    sandbox: :unset, 
    api_key: :unset, 
    secret: :unset
)

    data = Twilio::Values.of({
        'Type' => type,
        'FriendlyName' => friendly_name,
        'Certificate' => certificate,
        'PrivateKey' => private_key,
        'Sandbox' => sandbox,
        'ApiKey' => api_key,
        'Secret' => secret,
    })

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

#create_with_metadata(type: nil, friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset) ⇒ CredentialInstance

Create the CredentialInstanceMetadata



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/credential.rb', line 87

def create_with_metadata(
  type: nil, 
  friendly_name: :unset, 
  certificate: :unset, 
  private_key: :unset, 
  sandbox: :unset, 
  api_key: :unset, 
  secret: :unset
)

    data = Twilio::Values.of({
        'Type' => type,
        'FriendlyName' => friendly_name,
        'Certificate' => certificate,
        'PrivateKey' => private_key,
        'Sandbox' => sandbox,
        'ApiKey' => api_key,
        'Secret' => secret,
    })

    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,
    )
    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.



191
192
193
194
195
196
197
198
199
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/credential.rb', line 191

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.



228
229
230
231
232
233
234
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/credential.rb', line 228

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.



138
139
140
141
142
143
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/credential.rb', line 138

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.



174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/credential.rb', line 174

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.



208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/credential.rb', line 208

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.



156
157
158
159
160
161
162
163
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/credential.rb', line 156

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



239
240
241
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/credential.rb', line 239

def to_s
    '#<Twilio.IpMessaging.V1.CredentialList>'
end