Class: Twilio::REST::Wireless::V1::UsageRecordList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ UsageRecordList

Initialize the UsageRecordList



25
26
27
28
29
30
31
 
# File 'lib/twilio-ruby/rest/wireless/v1/usage_record.rb', line 25

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

Instance Method Details

#each ⇒ Object

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



87
88
89
90
91
92
93
94
95
 
# File 'lib/twilio-ruby/rest/wireless/v1/usage_record.rb', line 87

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



131
132
133
134
135
136
137
 
# File 'lib/twilio-ruby/rest/wireless/v1/usage_record.rb', line 131

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

#list(end_: :unset, start: :unset, granularity: :unset, limit: nil, page_size: nil) ⇒ Array

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



47
48
49
50
51
52
53
54
55
 
# File 'lib/twilio-ruby/rest/wireless/v1/usage_record.rb', line 47

def list(end_: :unset, start: :unset, granularity: :unset, limit: nil, page_size: nil)
    self.stream(
        end_: end_,
        start: start,
        granularity: granularity,
        limit: limit,
        page_size: page_size
    ).entries
end

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

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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/twilio-ruby/rest/wireless/v1/usage_record.rb', line 107

def page(end_: :unset, start: :unset, granularity: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
    params = Twilio::Values.of({
        
        'End' =>  Twilio.serialize_iso8601_datetime(end_),
        
        'Start' =>  Twilio.serialize_iso8601_datetime(start),
        
        'Granularity' => granularity,
        
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })

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

    UsageRecordPage.new(@version, response, @solution)
end

#stream(end_: :unset, start: :unset, granularity: :unset, 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.



71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/twilio-ruby/rest/wireless/v1/usage_record.rb', line 71

def stream(end_: :unset, start: :unset, granularity: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        end_: end_,
        start: start,
        granularity: granularity,
        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



142
143
144
 
# File 'lib/twilio-ruby/rest/wireless/v1/usage_record.rb', line 142

def to_s
    '#<Twilio.Wireless.V1.UsageRecordList>'
end