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

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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version, sim_sid: nil) ⇒ UsageRecordList

Initialize the UsageRecordList

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The sim_sid



20
21
22
23
24
25
26
27
28
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/usage_record.rb', line 20

def initialize(version, sim_sid: nil)
  super(version)

  # Path Solution
  @solution = {
      sim_sid: sim_sid
  }
  @uri = "/Sims/#{@solution[:sim_sid]}/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.



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

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of UsageRecordInstance



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

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.

Parameters:

  • end_ (Time) (defaults to: :unset) —

    The end

  • start (Time) (defaults to: :unset) —

    The start

  • granularity (usage_record.Granularity) (defaults to: :unset) —

    The granularity

  • 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



44
45
46
47
48
49
50
51
52
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/usage_record.rb', line 44

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.

Parameters:

  • end_ (Time) (defaults to: :unset) —

    The end

  • start (Time) (defaults to: :unset) —

    The start

  • granularity (usage_record.Granularity) (defaults to: :unset) —

    The granularity

  • 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 UsageRecordInstance



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/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
  )
  UsageRecordPage.new(@version, response, @solution)
end

#stream(end_: :unset, start: :unset, granularity: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams UsageRecordInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • end_ (Time) (defaults to: :unset) —

    The end

  • start (Time) (defaults to: :unset) —

    The start

  • granularity (usage_record.Granularity) (defaults to: :unset) —

    The granularity

  • 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



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

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



139
140
141
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/usage_record.rb', line 139

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