Class: Twilio::REST::Trusthub::V1::EndUserList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ EndUserList

Initialize the EndUserList



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

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

Instance Method Details

#create(friendly_name: nil, type: nil, attributes: :unset) ⇒ EndUserInstance

Create the EndUserInstance



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 40

def create(
    friendly_name: nil, 
    type: nil, 
    attributes: :unset
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
        'Type' => type,
        'Attributes' => Twilio.serialize_object(attributes),
    })

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

#create_with_metadata(friendly_name: nil, type: nil, attributes: :unset) ⇒ EndUserInstance

Create the EndUserInstanceMetadata



71
72
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
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 71

def create_with_metadata(
  friendly_name: nil, 
  type: nil, 
  attributes: :unset
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
        'Type' => type,
        'Attributes' => Twilio.serialize_object(attributes),
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    end_user_instance = EndUserInstance.new(
        @version,
        response.body,
    )
    EndUserInstanceMetadata.new(
        @version,
        end_user_instance,
        response.headers,
        response.status_code
    )
end

#each ⇒ Object

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



167
168
169
170
171
172
173
174
175
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 167

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



204
205
206
207
208
209
210
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 204

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

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

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



114
115
116
117
118
119
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 114

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 EndUserPageMetadata records from the API as a list.



150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 150

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)

    EndUserPageMetadata.new(@version, response, @solution, limits[:limit])
end

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

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



184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 184

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)

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



132
133
134
135
136
137
138
139
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 132

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



215
216
217
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 215

def to_s
    '#<Twilio.Trusthub.V1.EndUserList>'
end