Class: Twilio::REST::Api::V2010::AccountContext::ConferenceList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/conference.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil) ⇒ ConferenceList

Initialize the ConferenceList

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The SID of the Account that created this Conference resource.


22
23
24
25
26
27
28
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 22

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

  # Path Solution
  @solution = {account_sid: }
  @uri = "/Accounts/#{@solution[:account_sid]}/Conferences.json"
end

Instance Method Details

#each ⇒ Object

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


109
110
111
112
113
114
115
116
117
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 109

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of ConferenceInstance


161
162
163
164
165
166
167
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 161

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

#list(date_created_before: :unset, date_created: :unset, date_created_after: :unset, date_updated_before: :unset, date_updated: :unset, date_updated_after: :unset, friendly_name: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Array

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

Parameters:

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

    The `YYYY-MM-DD` value of the resources to read

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

    The `YYYY-MM-DD` value of the resources to read

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

    The `YYYY-MM-DD` value of the resources to read

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

    The `YYYY-MM-DD` value of the resources to read

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

    The `YYYY-MM-DD` value of the resources to read

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

    The `YYYY-MM-DD` value of the resources to read

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

    The string that identifies the Conference resources to read.

  • status (conference.Status) (defaults to: :unset) —

    The status of the resources to read. Can be: `init`, `in-progress`, or `completed`.

  • 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


51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 51

def list(date_created_before: :unset, date_created: :unset, date_created_after: :unset, date_updated_before: :unset, date_updated: :unset, date_updated_after: :unset, friendly_name: :unset, status: :unset, limit: nil, page_size: nil)
  self.stream(
      date_created_before: date_created_before,
      date_created: date_created,
      date_created_after: date_created_after,
      date_updated_before: date_updated_before,
      date_updated: date_updated,
      date_updated_after: date_updated_after,
      friendly_name: friendly_name,
      status: status,
      limit: limit,
      page_size: page_size
  ).entries
end

#page(date_created_before: :unset, date_created: :unset, date_created_after: :unset, date_updated_before: :unset, date_updated: :unset, date_updated_after: :unset, friendly_name: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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

Parameters:

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

    The `YYYY-MM-DD` value of the resources to read

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

    The `YYYY-MM-DD` value of the resources to read

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

    The `YYYY-MM-DD` value of the resources to read

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

    The `YYYY-MM-DD` value of the resources to read

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

    The `YYYY-MM-DD` value of the resources to read

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

    The `YYYY-MM-DD` value of the resources to read

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

    The string that identifies the Conference resources to read.

  • status (conference.Status) (defaults to: :unset) —

    The status of the resources to read. Can be: `init`, `in-progress`, or `completed`.

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


136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 136

def page(date_created_before: :unset, date_created: :unset, date_created_after: :unset, date_updated_before: :unset, date_updated: :unset, date_updated_after: :unset, friendly_name: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'DateCreated<' => Twilio.serialize_iso8601_date(date_created_before),
      'DateCreated' => Twilio.serialize_iso8601_date(date_created),
      'DateCreated>' => Twilio.serialize_iso8601_date(date_created_after),
      'DateUpdated<' => Twilio.serialize_iso8601_date(date_updated_before),
      'DateUpdated' => Twilio.serialize_iso8601_date(date_updated),
      'DateUpdated>' => Twilio.serialize_iso8601_date(date_updated_after),
      'FriendlyName' => friendly_name,
      'Status' => status,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

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

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

#stream(date_created_before: :unset, date_created: :unset, date_created_after: :unset, date_updated_before: :unset, date_updated: :unset, date_updated_after: :unset, friendly_name: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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

Parameters:

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

    The `YYYY-MM-DD` value of the resources to read

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

    The `YYYY-MM-DD` value of the resources to read

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

    The `YYYY-MM-DD` value of the resources to read

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

    The `YYYY-MM-DD` value of the resources to read

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

    The `YYYY-MM-DD` value of the resources to read

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

    The `YYYY-MM-DD` value of the resources to read

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

    The string that identifies the Conference resources to read.

  • status (conference.Status) (defaults to: :unset) —

    The status of the resources to read. Can be: `init`, `in-progress`, or `completed`.

  • 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


87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 87

def stream(date_created_before: :unset, date_created: :unset, date_created_after: :unset, date_updated_before: :unset, date_updated: :unset, date_updated_after: :unset, friendly_name: :unset, status: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      date_created_before: date_created_before,
      date_created: date_created,
      date_created_after: date_created_after,
      date_updated_before: date_updated_before,
      date_updated: date_updated,
      date_updated_after: date_updated_after,
      friendly_name: friendly_name,
      status: status,
      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


171
172
173
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 171

def to_s
  '#<Twilio.Api.V2010.ConferenceList>'
end