Class: Twilio::REST::Preview::BulkExports::ExportContext::DayList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/bulk_exports/export/day.rb

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Instance Method Summary collapse

Constructor Details

#initialize(version, resource_type: nil) ⇒ DayList

Initialize the DayList

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The type of communication – Messages, Calls



22
23
24
25
26
27
28
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export/day.rb', line 22

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

  # Path Solution
  @solution = {resource_type: resource_type}
  @uri = "/Exports/#{@solution[:resource_type]}/Days"
end

Instance Method Details

#each ⇒ Object

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



81
82
83
84
85
86
87
88
89
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export/day.rb', line 81

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of DayInstance



119
120
121
122
123
124
125
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export/day.rb', line 119

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

#list(next_token: :unset, previous_token: :unset, limit: nil, page_size: nil) ⇒ Array

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

Parameters:

  • next_token (String) (defaults to: :unset) —

    The next_token

  • previous_token (String) (defaults to: :unset) —

    The previous_token

  • 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



43
44
45
46
47
48
49
50
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export/day.rb', line 43

def list(next_token: :unset, previous_token: :unset, limit: nil, page_size: nil)
  self.stream(
      next_token: next_token,
      previous_token: previous_token,
      limit: limit,
      page_size: page_size
  ).entries
end

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

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

Parameters:

  • next_token (String) (defaults to: :unset) —

    The next_token

  • previous_token (String) (defaults to: :unset) —

    The previous_token

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



100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export/day.rb', line 100

def page(next_token: :unset, previous_token: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'NextToken' => next_token,
      'PreviousToken' => previous_token,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

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

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

#stream(next_token: :unset, previous_token: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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

Parameters:

  • next_token (String) (defaults to: :unset) —

    The next_token

  • previous_token (String) (defaults to: :unset) —

    The previous_token

  • 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



65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export/day.rb', line 65

def stream(next_token: :unset, previous_token: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      next_token: next_token,
      previous_token: previous_token,
      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



129
130
131
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export/day.rb', line 129

def to_s
  '#<Twilio.Preview.BulkExports.DayList>'
end