Class: Twilio::REST::Numbers::V2::RegulatoryComplianceList::BundleList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ BundleList

Initialize the BundleList



19
20
21
22
23
24
25
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 19

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/RegulatoryCompliance/Bundles"
end

Instance Method Details

#create(friendly_name: nil, email: nil, status_callback: :unset, regulation_sid: :unset, iso_country: :unset, end_user_type: :unset, number_type: :unset) ⇒ BundleInstance

Create the BundleInstance



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 46

def create(friendly_name: nil, email: nil, status_callback: :unset, regulation_sid: :unset, iso_country: :unset, end_user_type: :unset, number_type: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'Email' => email,
      'StatusCallback' => status_callback,
      'RegulationSid' => regulation_sid,
      'IsoCountry' => iso_country,
      'EndUserType' => end_user_type,
      'NumberType' => number_type,
  })

  payload = @version.create('POST', @uri, data: data)

  BundleInstance.new(@version, payload, )
end

#each ⇒ Object

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



173
174
175
176
177
178
179
180
181
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 173

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



241
242
243
244
245
246
247
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 241

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

#list(status: :unset, friendly_name: :unset, regulation_sid: :unset, iso_country: :unset, number_type: :unset, has_valid_until_date: :unset, sort_by: :unset, sort_direction: :unset, valid_until_date_before: :unset, valid_until_date: :unset, valid_until_date_after: :unset, limit: nil, page_size: nil) ⇒ Array

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



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 96

def list(status: :unset, friendly_name: :unset, regulation_sid: :unset, iso_country: :unset, number_type: :unset, has_valid_until_date: :unset, sort_by: :unset, sort_direction: :unset, valid_until_date_before: :unset, valid_until_date: :unset, valid_until_date_after: :unset, limit: nil, page_size: nil)
  self.stream(
      status: status,
      friendly_name: friendly_name,
      regulation_sid: regulation_sid,
      iso_country: iso_country,
      number_type: number_type,
      has_valid_until_date: has_valid_until_date,
      sort_by: sort_by,
      sort_direction: sort_direction,
      valid_until_date_before: valid_until_date_before,
      valid_until_date: valid_until_date,
      valid_until_date_after: valid_until_date_after,
      limit: limit,
      page_size: page_size
  ).entries
end

#page(status: :unset, friendly_name: :unset, regulation_sid: :unset, iso_country: :unset, number_type: :unset, has_valid_until_date: :unset, sort_by: :unset, sort_direction: :unset, valid_until_date_before: :unset, valid_until_date: :unset, valid_until_date_after: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 213

def page(status: :unset, friendly_name: :unset, regulation_sid: :unset, iso_country: :unset, number_type: :unset, has_valid_until_date: :unset, sort_by: :unset, sort_direction: :unset, valid_until_date_before: :unset, valid_until_date: :unset, valid_until_date_after: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'Status' => status,
      'FriendlyName' => friendly_name,
      'RegulationSid' => regulation_sid,
      'IsoCountry' => iso_country,
      'NumberType' => number_type,
      'HasValidUntilDate' => has_valid_until_date,
      'SortBy' => sort_by,
      'SortDirection' => sort_direction,
      'ValidUntilDate<' => Twilio.serialize_iso8601_datetime(valid_until_date_before),
      'ValidUntilDate' => Twilio.serialize_iso8601_datetime(valid_until_date),
      'ValidUntilDate>' => Twilio.serialize_iso8601_datetime(valid_until_date_after),
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

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

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

#stream(status: :unset, friendly_name: :unset, regulation_sid: :unset, iso_country: :unset, number_type: :unset, has_valid_until_date: :unset, sort_by: :unset, sort_direction: :unset, valid_until_date_before: :unset, valid_until_date: :unset, valid_until_date_after: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 148

def stream(status: :unset, friendly_name: :unset, regulation_sid: :unset, iso_country: :unset, number_type: :unset, has_valid_until_date: :unset, sort_by: :unset, sort_direction: :unset, valid_until_date_before: :unset, valid_until_date: :unset, valid_until_date_after: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      status: status,
      friendly_name: friendly_name,
      regulation_sid: regulation_sid,
      iso_country: iso_country,
      number_type: number_type,
      has_valid_until_date: has_valid_until_date,
      sort_by: sort_by,
      sort_direction: sort_direction,
      valid_until_date_before: valid_until_date_before,
      valid_until_date: valid_until_date,
      valid_until_date_after: valid_until_date_after,
      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



251
252
253
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 251

def to_s
  '#<Twilio.Numbers.V2.BundleList>'
end