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
 
# 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



43
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
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/credential.rb', line 43

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

    
    payload = @version.create('POST', @uri, data: data)
    CredentialInstance.new(
        @version,
        payload,
    )
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.



114
115
116
117
118
119
120
121
122
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/credential.rb', line 114

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.



148
149
150
151
152
153
154
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/credential.rb', line 148

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.



83
84
85
86
87
88
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/credential.rb', line 83

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.



131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/credential.rb', line 131

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.



101
102
103
104
105
106
107
108
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/credential.rb', line 101

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



159
160
161
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/credential.rb', line 159

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