twilio-ruby 7.10.0 → 7.10.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -51,6 +51,9 @@ module Twilio
51
51
  # @param [Boolean] subscriber_opt_in A boolean that specifies whether campaign has Subscriber Optin or not.
52
52
  # @param [Boolean] age_gated A boolean that specifies whether campaign is age gated or not.
53
53
  # @param [Boolean] direct_lending A boolean that specifies whether campaign allows direct lending or not.
54
+ # @param [String] privacy_policy_url The URL of the privacy policy for the campaign.
55
+ # @param [String] terms_and_conditions_url The URL of the terms and conditions for the campaign.
56
+ # @param [String] x_twilio_api_version The version of the Messaging API to use for this request
54
57
  # @return [UsAppToPersonInstance] Created UsAppToPersonInstance
55
58
  def create(
56
59
  brand_registration_sid: nil,
@@ -68,7 +71,10 @@ module Twilio
68
71
  help_keywords: :unset,
69
72
  subscriber_opt_in: :unset,
70
73
  age_gated: :unset,
71
- direct_lending: :unset
74
+ direct_lending: :unset,
75
+ privacy_policy_url: :unset,
76
+ terms_and_conditions_url: :unset,
77
+ x_twilio_api_version: :unset
72
78
  )
73
79
 
74
80
  data = Twilio::Values.of({
@@ -88,9 +94,11 @@ module Twilio
88
94
  'SubscriberOptIn' => subscriber_opt_in,
89
95
  'AgeGated' => age_gated,
90
96
  'DirectLending' => direct_lending,
97
+ 'PrivacyPolicyUrl' => privacy_policy_url,
98
+ 'TermsAndConditionsUrl' => terms_and_conditions_url,
91
99
  })
92
100
 
93
- headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
101
+ headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'X-Twilio-Api-Version' => x_twilio_api_version, })
94
102
 
95
103
 
96
104
 
@@ -122,6 +130,9 @@ module Twilio
122
130
  # @param [Boolean] subscriber_opt_in A boolean that specifies whether campaign has Subscriber Optin or not.
123
131
  # @param [Boolean] age_gated A boolean that specifies whether campaign is age gated or not.
124
132
  # @param [Boolean] direct_lending A boolean that specifies whether campaign allows direct lending or not.
133
+ # @param [String] privacy_policy_url The URL of the privacy policy for the campaign.
134
+ # @param [String] terms_and_conditions_url The URL of the terms and conditions for the campaign.
135
+ # @param [String] x_twilio_api_version The version of the Messaging API to use for this request
125
136
  # @return [UsAppToPersonInstance] Created UsAppToPersonInstance
126
137
  def create_with_metadata(
127
138
  brand_registration_sid: nil,
@@ -139,7 +150,10 @@ module Twilio
139
150
  help_keywords: :unset,
140
151
  subscriber_opt_in: :unset,
141
152
  age_gated: :unset,
142
- direct_lending: :unset
153
+ direct_lending: :unset,
154
+ privacy_policy_url: :unset,
155
+ terms_and_conditions_url: :unset,
156
+ x_twilio_api_version: :unset
143
157
  )
144
158
 
145
159
  data = Twilio::Values.of({
@@ -159,9 +173,11 @@ module Twilio
159
173
  'SubscriberOptIn' => subscriber_opt_in,
160
174
  'AgeGated' => age_gated,
161
175
  'DirectLending' => direct_lending,
176
+ 'PrivacyPolicyUrl' => privacy_policy_url,
177
+ 'TermsAndConditionsUrl' => terms_and_conditions_url,
162
178
  })
163
179
 
164
- headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
180
+ headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'X-Twilio-Api-Version' => x_twilio_api_version, })
165
181
 
166
182
 
167
183
 
@@ -186,6 +202,7 @@ module Twilio
186
202
  # Lists UsAppToPersonInstance records from the API as a list.
187
203
  # Unlike stream(), this operation is eager and will load `limit` records into
188
204
  # memory before returning.
205
+ # @param [String] x_twilio_api_version The version of the Messaging API to use for this request
189
206
  # @param [Integer] limit Upper limit for the number of records to return. stream()
190
207
  # guarantees to never return more than limit. Default is no limit
191
208
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -193,8 +210,9 @@ module Twilio
193
210
  # but a limit is defined, stream() will attempt to read the limit with the most
194
211
  # efficient page size, i.e. min(limit, 1000)
195
212
  # @return [Array] Array of up to limit results
196
- def list(limit: nil, page_size: nil)
213
+ def list(x_twilio_api_version: :unset, limit: nil, page_size: nil)
197
214
  self.stream(
215
+ x_twilio_api_version: x_twilio_api_version,
198
216
  limit: limit,
199
217
  page_size: page_size
200
218
  ).entries
@@ -204,6 +222,7 @@ module Twilio
204
222
  # Streams Instance records from the API as an Enumerable.
205
223
  # This operation lazily loads records as efficiently as possible until the limit
206
224
  # is reached.
225
+ # @param [String] x_twilio_api_version The version of the Messaging API to use for this request
207
226
  # @param [Integer] limit Upper limit for the number of records to return. stream()
208
227
  # guarantees to never return more than limit. Default is no limit
209
228
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -211,10 +230,11 @@ module Twilio
211
230
  # but a limit is defined, stream() will attempt to read the limit with the most
212
231
  # efficient page size, i.e. min(limit, 1000)
213
232
  # @return [Enumerable] Enumerable that will yield up to limit results
214
- def stream(limit: nil, page_size: nil)
233
+ def stream(x_twilio_api_version: :unset, limit: nil, page_size: nil)
215
234
  limits = @version.read_limits(limit, page_size)
216
235
 
217
236
  page = self.page(
237
+ x_twilio_api_version: x_twilio_api_version,
218
238
  page_size: limits[:page_size], )
219
239
 
220
240
  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
@@ -222,6 +242,7 @@ module Twilio
222
242
 
223
243
  ##
224
244
  # Lists UsAppToPersonPageMetadata records from the API as a list.
245
+ # @param [String] x_twilio_api_version The version of the Messaging API to use for this request
225
246
  # @param [Integer] limit Upper limit for the number of records to return. stream()
226
247
  # guarantees to never return more than limit. Default is no limit
227
248
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -229,9 +250,10 @@ module Twilio
229
250
  # but a limit is defined, stream() will attempt to read the limit with the most
230
251
  # efficient page size, i.e. min(limit, 1000)
231
252
  # @return [Array] Array of up to limit results
232
- def list_with_metadata(limit: nil, page_size: nil)
253
+ def list_with_metadata(x_twilio_api_version: :unset, limit: nil, page_size: nil)
233
254
  limits = @version.read_limits(limit, page_size)
234
255
  params = Twilio::Values.of({
256
+ 'X-Twilio-Api-Version' => x_twilio_api_version,
235
257
 
236
258
  'PageSize' => limits[:page_size],
237
259
  });
@@ -259,12 +281,14 @@ module Twilio
259
281
  ##
260
282
  # Retrieve a single page of UsAppToPersonInstance records from the API.
261
283
  # Request is executed immediately.
284
+ # @param [String] x_twilio_api_version The version of the Messaging API to use for this request
262
285
  # @param [String] page_token PageToken provided by the API
263
286
  # @param [Integer] page_number Page Number, this value is simply for client state
264
287
  # @param [Integer] page_size Number of records to return, defaults to 50
265
288
  # @return [Page] Page of UsAppToPersonInstance
266
- def page(page_token: :unset, page_number: :unset,page_size: :unset)
289
+ def page(x_twilio_api_version: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
267
290
  params = Twilio::Values.of({
291
+ 'X-Twilio-Api-Version' => x_twilio_api_version,
268
292
  'PageToken' => page_token,
269
293
  'Page' => page_number,
270
294
  'PageSize' => page_size,
@@ -351,10 +375,13 @@ module Twilio
351
375
 
352
376
  ##
353
377
  # Fetch the UsAppToPersonInstance
378
+ # @param [String] x_twilio_api_version The version of the Messaging API to use for this request
354
379
  # @return [UsAppToPersonInstance] Fetched UsAppToPersonInstance
355
- def fetch
380
+ def fetch(
381
+ x_twilio_api_version: :unset
382
+ )
356
383
 
357
- headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
384
+ headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'X-Twilio-Api-Version' => x_twilio_api_version, })
358
385
 
359
386
 
360
387
 
@@ -371,10 +398,13 @@ module Twilio
371
398
 
372
399
  ##
373
400
  # Fetch the UsAppToPersonInstanceMetadata
401
+ # @param [String] x_twilio_api_version The version of the Messaging API to use for this request
374
402
  # @return [UsAppToPersonInstance] Fetched UsAppToPersonInstance
375
- def fetch_with_metadata
403
+ def fetch_with_metadata(
404
+ x_twilio_api_version: :unset
405
+ )
376
406
 
377
- headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
407
+ headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'X-Twilio-Api-Version' => x_twilio_api_version, })
378
408
 
379
409
 
380
410
 
@@ -404,6 +434,9 @@ module Twilio
404
434
  # @param [String] description A short description of what this SMS campaign does. Min length: 40 characters. Max length: 4096 characters.
405
435
  # @param [Boolean] age_gated A boolean that specifies whether campaign requires age gate for federally legal content.
406
436
  # @param [Boolean] direct_lending A boolean that specifies whether campaign allows direct lending or not.
437
+ # @param [String] privacy_policy_url The URL of the privacy policy for the campaign.
438
+ # @param [String] terms_and_conditions_url The URL of the terms and conditions for the campaign.
439
+ # @param [String] x_twilio_api_version The version of the Messaging API to use for this request
407
440
  # @return [UsAppToPersonInstance] Updated UsAppToPersonInstance
408
441
  def update(
409
442
  has_embedded_links: nil,
@@ -412,7 +445,10 @@ module Twilio
412
445
  message_flow: nil,
413
446
  description: nil,
414
447
  age_gated: nil,
415
- direct_lending: nil
448
+ direct_lending: nil,
449
+ privacy_policy_url: :unset,
450
+ terms_and_conditions_url: :unset,
451
+ x_twilio_api_version: :unset
416
452
  )
417
453
 
418
454
  data = Twilio::Values.of({
@@ -423,9 +459,11 @@ module Twilio
423
459
  'Description' => description,
424
460
  'AgeGated' => age_gated,
425
461
  'DirectLending' => direct_lending,
462
+ 'PrivacyPolicyUrl' => privacy_policy_url,
463
+ 'TermsAndConditionsUrl' => terms_and_conditions_url,
426
464
  })
427
465
 
428
- headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
466
+ headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'X-Twilio-Api-Version' => x_twilio_api_version, })
429
467
 
430
468
 
431
469
 
@@ -449,6 +487,9 @@ module Twilio
449
487
  # @param [String] description A short description of what this SMS campaign does. Min length: 40 characters. Max length: 4096 characters.
450
488
  # @param [Boolean] age_gated A boolean that specifies whether campaign requires age gate for federally legal content.
451
489
  # @param [Boolean] direct_lending A boolean that specifies whether campaign allows direct lending or not.
490
+ # @param [String] privacy_policy_url The URL of the privacy policy for the campaign.
491
+ # @param [String] terms_and_conditions_url The URL of the terms and conditions for the campaign.
492
+ # @param [String] x_twilio_api_version The version of the Messaging API to use for this request
452
493
  # @return [UsAppToPersonInstance] Updated UsAppToPersonInstance
453
494
  def update_with_metadata(
454
495
  has_embedded_links: nil,
@@ -457,7 +498,10 @@ module Twilio
457
498
  message_flow: nil,
458
499
  description: nil,
459
500
  age_gated: nil,
460
- direct_lending: nil
501
+ direct_lending: nil,
502
+ privacy_policy_url: :unset,
503
+ terms_and_conditions_url: :unset,
504
+ x_twilio_api_version: :unset
461
505
  )
462
506
 
463
507
  data = Twilio::Values.of({
@@ -468,9 +512,11 @@ module Twilio
468
512
  'Description' => description,
469
513
  'AgeGated' => age_gated,
470
514
  'DirectLending' => direct_lending,
515
+ 'PrivacyPolicyUrl' => privacy_policy_url,
516
+ 'TermsAndConditionsUrl' => terms_and_conditions_url,
471
517
  })
472
518
 
473
- headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
519
+ headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'X-Twilio-Api-Version' => x_twilio_api_version, })
474
520
 
475
521
 
476
522
 
@@ -687,6 +733,8 @@ module Twilio
687
733
  'url' => payload['url'],
688
734
  'mock' => payload['mock'],
689
735
  'errors' => payload['errors'],
736
+ 'privacy_policy_url' => payload['privacy_policy_url'],
737
+ 'terms_and_conditions_url' => payload['terms_and_conditions_url'],
690
738
  }
691
739
 
692
740
  # Context
@@ -873,6 +921,18 @@ module Twilio
873
921
  @properties['errors']
874
922
  end
875
923
 
924
+ ##
925
+ # @return [String] The URL of the privacy policy for the campaign.
926
+ def privacy_policy_url
927
+ @properties['privacy_policy_url']
928
+ end
929
+
930
+ ##
931
+ # @return [String] The URL of the terms and conditions for the campaign.
932
+ def terms_and_conditions_url
933
+ @properties['terms_and_conditions_url']
934
+ end
935
+
876
936
  ##
877
937
  # Delete the UsAppToPersonInstance
878
938
  # @return [Boolean] True if delete succeeds, false otherwise
@@ -883,10 +943,15 @@ module Twilio
883
943
 
884
944
  ##
885
945
  # Fetch the UsAppToPersonInstance
946
+ # @param [String] x_twilio_api_version The version of the Messaging API to use for this request
886
947
  # @return [UsAppToPersonInstance] Fetched UsAppToPersonInstance
887
- def fetch
948
+ def fetch(
949
+ x_twilio_api_version: :unset
950
+ )
888
951
 
889
- context.fetch
952
+ context.fetch(
953
+ x_twilio_api_version: x_twilio_api_version,
954
+ )
890
955
  end
891
956
 
892
957
  ##
@@ -898,6 +963,9 @@ module Twilio
898
963
  # @param [String] description A short description of what this SMS campaign does. Min length: 40 characters. Max length: 4096 characters.
899
964
  # @param [Boolean] age_gated A boolean that specifies whether campaign requires age gate for federally legal content.
900
965
  # @param [Boolean] direct_lending A boolean that specifies whether campaign allows direct lending or not.
966
+ # @param [String] privacy_policy_url The URL of the privacy policy for the campaign.
967
+ # @param [String] terms_and_conditions_url The URL of the terms and conditions for the campaign.
968
+ # @param [String] x_twilio_api_version The version of the Messaging API to use for this request
901
969
  # @return [UsAppToPersonInstance] Updated UsAppToPersonInstance
902
970
  def update(
903
971
  has_embedded_links: nil,
@@ -906,7 +974,10 @@ module Twilio
906
974
  message_flow: nil,
907
975
  description: nil,
908
976
  age_gated: nil,
909
- direct_lending: nil
977
+ direct_lending: nil,
978
+ privacy_policy_url: :unset,
979
+ terms_and_conditions_url: :unset,
980
+ x_twilio_api_version: :unset
910
981
  )
911
982
 
912
983
  context.update(
@@ -917,6 +988,9 @@ module Twilio
917
988
  description: description,
918
989
  age_gated: age_gated,
919
990
  direct_lending: direct_lending,
991
+ privacy_policy_url: privacy_policy_url,
992
+ terms_and_conditions_url: terms_and_conditions_url,
993
+ x_twilio_api_version: x_twilio_api_version,
920
994
  )
921
995
  end
922
996
 
@@ -36,7 +36,7 @@ module Twilio
36
36
  # @param [String] business_name The name of the business or organization using the Tollfree number.
37
37
  # @param [String] business_website The website of the business or organization using the Tollfree number.
38
38
  # @param [String] notification_email The email address to receive the notification about the verification result. .
39
- # @param [Array[String]] use_case_categories The category of the use case for the Tollfree Number. List as many are applicable..
39
+ # @param [Array[String]] use_case_categories The category of the use case for the Tollfree Number. List as many as are applicable.
40
40
  # @param [String] use_case_summary Use this to further explain how messaging is used by the business or organization.
41
41
  # @param [String] production_message_sample An example of message content, i.e. a sample message.
42
42
  # @param [Array[String]] opt_in_image_urls Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL.
@@ -56,10 +56,10 @@ module Twilio
56
56
  # @param [String] business_contact_email The email address of the contact for the business or organization using the Tollfree number.
57
57
  # @param [String] business_contact_phone The E.164 formatted phone number of the contact for the business or organization using the Tollfree number.
58
58
  # @param [String] external_reference_id An optional external reference ID supplied by customer and echoed back on status retrieval.
59
- # @param [String] business_registration_number A legally recognized business registration number
60
- # @param [String] business_registration_authority The organizational authority for business registrations
61
- # @param [String] business_registration_country Country business is registered in
62
- # @param [String] business_type The type of business, valid values are PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, SOLE_PROPRIETOR, GOVERNMENT
59
+ # @param [String] business_registration_number A legally recognized business registration number. Required for all business types except SOLE_PROPRIETOR.
60
+ # @param [BusinessRegistrationAuthority] business_registration_authority
61
+ # @param [String] business_registration_country The country where the business is registered. Required for all business types except SOLE_PROPRIETOR.
62
+ # @param [BusinessType] business_type
63
63
  # @param [String] business_registration_phone_number The E.164 formatted number associated with the business.
64
64
  # @param [String] doing_business_as Trade name, sub entity, or downstream business name of business being submitted for verification
65
65
  # @param [String] opt_in_confirmation_message The confirmation message sent to users when they opt in to receive messages.
@@ -169,7 +169,7 @@ module Twilio
169
169
  # @param [String] business_name The name of the business or organization using the Tollfree number.
170
170
  # @param [String] business_website The website of the business or organization using the Tollfree number.
171
171
  # @param [String] notification_email The email address to receive the notification about the verification result. .
172
- # @param [Array[String]] use_case_categories The category of the use case for the Tollfree Number. List as many are applicable..
172
+ # @param [Array[String]] use_case_categories The category of the use case for the Tollfree Number. List as many as are applicable.
173
173
  # @param [String] use_case_summary Use this to further explain how messaging is used by the business or organization.
174
174
  # @param [String] production_message_sample An example of message content, i.e. a sample message.
175
175
  # @param [Array[String]] opt_in_image_urls Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL.
@@ -189,10 +189,10 @@ module Twilio
189
189
  # @param [String] business_contact_email The email address of the contact for the business or organization using the Tollfree number.
190
190
  # @param [String] business_contact_phone The E.164 formatted phone number of the contact for the business or organization using the Tollfree number.
191
191
  # @param [String] external_reference_id An optional external reference ID supplied by customer and echoed back on status retrieval.
192
- # @param [String] business_registration_number A legally recognized business registration number
193
- # @param [String] business_registration_authority The organizational authority for business registrations
194
- # @param [String] business_registration_country Country business is registered in
195
- # @param [String] business_type The type of business, valid values are PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, SOLE_PROPRIETOR, GOVERNMENT
192
+ # @param [String] business_registration_number A legally recognized business registration number. Required for all business types except SOLE_PROPRIETOR.
193
+ # @param [BusinessRegistrationAuthority] business_registration_authority
194
+ # @param [String] business_registration_country The country where the business is registered. Required for all business types except SOLE_PROPRIETOR.
195
+ # @param [BusinessType] business_type
196
196
  # @param [String] business_registration_phone_number The E.164 formatted number associated with the business.
197
197
  # @param [String] doing_business_as Trade name, sub entity, or downstream business name of business being submitted for verification
198
198
  # @param [String] opt_in_confirmation_message The confirmation message sent to users when they opt in to receive messages.
@@ -561,7 +561,7 @@ module Twilio
561
561
  # @param [String] business_name The name of the business or organization using the Tollfree number.
562
562
  # @param [String] business_website The website of the business or organization using the Tollfree number.
563
563
  # @param [String] notification_email The email address to receive the notification about the verification result. .
564
- # @param [Array[String]] use_case_categories The category of the use case for the Tollfree Number. List as many are applicable..
564
+ # @param [Array[String]] use_case_categories The category of the use case for the Tollfree Number. List as many as are applicable.
565
565
  # @param [String] use_case_summary Use this to further explain how messaging is used by the business or organization.
566
566
  # @param [String] production_message_sample An example of message content, i.e. a sample message.
567
567
  # @param [Array[String]] opt_in_image_urls Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL.
@@ -579,10 +579,10 @@ module Twilio
579
579
  # @param [String] business_contact_email The email address of the contact for the business or organization using the Tollfree number.
580
580
  # @param [String] business_contact_phone The E.164 formatted phone number of the contact for the business or organization using the Tollfree number.
581
581
  # @param [String] edit_reason Describe why the verification is being edited. If the verification was rejected because of a technical issue, such as the website being down, and the issue has been resolved this parameter should be set to something similar to 'Website fixed'.
582
- # @param [String] business_registration_number A legaly recognized business registration number
583
- # @param [String] business_registration_authority The organizational authority for business registrations
582
+ # @param [String] business_registration_number A legally recognized business registration number
583
+ # @param [BusinessRegistrationAuthority] business_registration_authority
584
584
  # @param [String] business_registration_country Country business is registered in
585
- # @param [String] business_type The type of business, valid values are PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, SOLE_PROPRIETOR, GOVERNMENT
585
+ # @param [BusinessType] business_type
586
586
  # @param [String] business_registration_phone_number The E.164 formatted number associated with the business.
587
587
  # @param [String] doing_business_as Trade name, sub entity, or downstream business name of business being submitted for verification
588
588
  # @param [String] opt_in_confirmation_message The confirmation message sent to users when they opt in to receive messages.
@@ -689,7 +689,7 @@ module Twilio
689
689
  # @param [String] business_name The name of the business or organization using the Tollfree number.
690
690
  # @param [String] business_website The website of the business or organization using the Tollfree number.
691
691
  # @param [String] notification_email The email address to receive the notification about the verification result. .
692
- # @param [Array[String]] use_case_categories The category of the use case for the Tollfree Number. List as many are applicable..
692
+ # @param [Array[String]] use_case_categories The category of the use case for the Tollfree Number. List as many as are applicable.
693
693
  # @param [String] use_case_summary Use this to further explain how messaging is used by the business or organization.
694
694
  # @param [String] production_message_sample An example of message content, i.e. a sample message.
695
695
  # @param [Array[String]] opt_in_image_urls Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL.
@@ -707,10 +707,10 @@ module Twilio
707
707
  # @param [String] business_contact_email The email address of the contact for the business or organization using the Tollfree number.
708
708
  # @param [String] business_contact_phone The E.164 formatted phone number of the contact for the business or organization using the Tollfree number.
709
709
  # @param [String] edit_reason Describe why the verification is being edited. If the verification was rejected because of a technical issue, such as the website being down, and the issue has been resolved this parameter should be set to something similar to 'Website fixed'.
710
- # @param [String] business_registration_number A legaly recognized business registration number
711
- # @param [String] business_registration_authority The organizational authority for business registrations
710
+ # @param [String] business_registration_number A legally recognized business registration number
711
+ # @param [BusinessRegistrationAuthority] business_registration_authority
712
712
  # @param [String] business_registration_country Country business is registered in
713
- # @param [String] business_type The type of business, valid values are PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, SOLE_PROPRIETOR, GOVERNMENT
713
+ # @param [BusinessType] business_type
714
714
  # @param [String] business_registration_phone_number The E.164 formatted number associated with the business.
715
715
  # @param [String] doing_business_as Trade name, sub entity, or downstream business name of business being submitted for verification
716
716
  # @param [String] opt_in_confirmation_message The confirmation message sent to users when they opt in to receive messages.
@@ -1178,7 +1178,7 @@ module Twilio
1178
1178
  end
1179
1179
 
1180
1180
  ##
1181
- # @return [Array<String>] The category of the use case for the Tollfree Number. List as many are applicable..
1181
+ # @return [Array<String>] The category of the use case for the Tollfree Number. List as many as are applicable.
1182
1182
  def use_case_categories
1183
1183
  @properties['use_case_categories']
1184
1184
  end
@@ -1274,7 +1274,7 @@ module Twilio
1274
1274
  end
1275
1275
 
1276
1276
  ##
1277
- # @return [String] The organizational authority for business registrations
1277
+ # @return [BusinessRegistrationAuthority]
1278
1278
  def business_registration_authority
1279
1279
  @properties['business_registration_authority']
1280
1280
  end
@@ -1286,7 +1286,7 @@ module Twilio
1286
1286
  end
1287
1287
 
1288
1288
  ##
1289
- # @return [String] The type of business, valid values are PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, SOLE_PROPRIETOR, GOVERNMENT
1289
+ # @return [BusinessType]
1290
1290
  def business_type
1291
1291
  @properties['business_type']
1292
1292
  end
@@ -1396,7 +1396,7 @@ module Twilio
1396
1396
  # @param [String] business_name The name of the business or organization using the Tollfree number.
1397
1397
  # @param [String] business_website The website of the business or organization using the Tollfree number.
1398
1398
  # @param [String] notification_email The email address to receive the notification about the verification result. .
1399
- # @param [Array[String]] use_case_categories The category of the use case for the Tollfree Number. List as many are applicable..
1399
+ # @param [Array[String]] use_case_categories The category of the use case for the Tollfree Number. List as many as are applicable.
1400
1400
  # @param [String] use_case_summary Use this to further explain how messaging is used by the business or organization.
1401
1401
  # @param [String] production_message_sample An example of message content, i.e. a sample message.
1402
1402
  # @param [Array[String]] opt_in_image_urls Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL.
@@ -1414,10 +1414,10 @@ module Twilio
1414
1414
  # @param [String] business_contact_email The email address of the contact for the business or organization using the Tollfree number.
1415
1415
  # @param [String] business_contact_phone The E.164 formatted phone number of the contact for the business or organization using the Tollfree number.
1416
1416
  # @param [String] edit_reason Describe why the verification is being edited. If the verification was rejected because of a technical issue, such as the website being down, and the issue has been resolved this parameter should be set to something similar to 'Website fixed'.
1417
- # @param [String] business_registration_number A legaly recognized business registration number
1418
- # @param [String] business_registration_authority The organizational authority for business registrations
1417
+ # @param [String] business_registration_number A legally recognized business registration number
1418
+ # @param [BusinessRegistrationAuthority] business_registration_authority
1419
1419
  # @param [String] business_registration_country Country business is registered in
1420
- # @param [String] business_type The type of business, valid values are PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, SOLE_PROPRIETOR, GOVERNMENT
1420
+ # @param [BusinessType] business_type
1421
1421
  # @param [String] business_registration_phone_number The E.164 formatted number associated with the business.
1422
1422
  # @param [String] doing_business_as Trade name, sub entity, or downstream business name of business being submitted for verification
1423
1423
  # @param [String] opt_in_confirmation_message The confirmation message sent to users when they opt in to receive messages.
@@ -29,7 +29,7 @@ module Twilio
29
29
  # @param [privacy_url]: [String] The privacy URL of the sender. Must be a publicly accessible HTTP or HTTPS URI associated with the sender.
30
30
  # @param [terms_of_service_url]: [String] The terms of service URL of the sender.
31
31
  # @param [accent_color]: [String] The color theme of the sender. Must be in hex format and have at least a 4:5:1 contrast ratio against white.
32
- # @param [vertical]: [String] The vertical of the sender. Allowed values are: - `Automotive` - `Beauty, Spa and Salon` - `Clothing and Apparel` - `Education` - `Entertainment` - `Event Planning and Service` - `Finance and Banking` - `Food and Grocery` - `Public Service` - `Hotel and Lodging` - `Medical and Health` - `Non-profit` - `Professional Services` - `Shopping and Retail` - `Travel and Transportation` - `Restaurant` - `Other`
32
+ # @param [vertical]: [String] The vertical of the sender. Allowed values are: - `Alcohol` - `Automotive` - `Beauty, Spa and Salon` - `Clothing and Apparel` - `Education` - `Entertainment` - `Event Planning and Service` - `Finance and Banking` - `Food and Grocery` - `Hotel and Lodging` - `Matrimony Service` - `Medical and Health` - `Non-profit` - `Online Gambling` - `OTC Drugs` - `Other` - `Physical Gambling` - `Professional Services` - `Public Service` - `Restaurant` - `Shopping and Retail` - `Travel and Transportation`
33
33
  # @param [websites]: [Hash] The websites of the sender.
34
34
  # @param [emails]: [Hash] The emails of the sender.
35
35
  # @param [phone_numbers]: [Hash] The phone numbers of the sender.
@@ -206,7 +206,7 @@ module Twilio
206
206
  # @param [privacy_url]: [String] The privacy URL of the sender. Must be a publicly accessible HTTP or HTTPS URI associated with the sender.
207
207
  # @param [terms_of_service_url]: [String] The terms of service URL of the sender.
208
208
  # @param [accent_color]: [String] The color theme of the sender. Must be in hex format and have at least a 4:5:1 contrast ratio against white.
209
- # @param [vertical]: [String] The vertical of the sender. Allowed values are: - `Automotive` - `Beauty, Spa and Salon` - `Clothing and Apparel` - `Education` - `Entertainment` - `Event Planning and Service` - `Finance and Banking` - `Food and Grocery` - `Public Service` - `Hotel and Lodging` - `Medical and Health` - `Non-profit` - `Professional Services` - `Shopping and Retail` - `Travel and Transportation` - `Restaurant` - `Other`
209
+ # @param [vertical]: [String] The vertical of the sender. Allowed values are: - `Alcohol` - `Automotive` - `Beauty, Spa and Salon` - `Clothing and Apparel` - `Education` - `Entertainment` - `Event Planning and Service` - `Finance and Banking` - `Food and Grocery` - `Hotel and Lodging` - `Matrimony Service` - `Medical and Health` - `Non-profit` - `Online Gambling` - `OTC Drugs` - `Other` - `Physical Gambling` - `Professional Services` - `Public Service` - `Restaurant` - `Shopping and Retail` - `Travel and Transportation`
210
210
  # @param [websites]: [Hash] The websites of the sender.
211
211
  # @param [emails]: [Hash] The emails of the sender.
212
212
  # @param [phone_numbers]: [Hash] The phone numbers of the sender.
@@ -137,10 +137,12 @@ module Twilio
137
137
  # Unlike stream(), this operation is eager and will load `limit` records into
138
138
  # memory before returning.
139
139
  # @param [Status] status The verification status of the Bundle resource. Please refer to [Bundle Statuses](https://www.twilio.com/docs/phone-numbers/regulatory/api/bundles#bundle-statuses) for more details.
140
+ # @param [String] bundle_sids A comma-separated list of Bundle SIDs to filter the results (maximum 20). Each Bundle SID must match `^BU[0-9a-fA-F]{32}$`.
140
141
  # @param [String] friendly_name The string that you assigned to describe the resource. The column can contain 255 variable characters.
141
142
  # @param [String] regulation_sid The unique string of a [Regulation resource](https://www.twilio.com/docs/phone-numbers/regulatory/api/regulations) that is associated to the Bundle resource.
142
143
  # @param [String] iso_country The 2-digit [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Bundle's phone number country ownership request.
143
144
  # @param [String] number_type The type of phone number of the Bundle's ownership request. Can be `local`, `mobile`, `national`, or `toll-free`.
145
+ # @param [String] end_user_type The end user type of the regulation of the Bundle. Can be `business` or `individual`.
144
146
  # @param [Boolean] has_valid_until_date Indicates that the Bundle is a valid Bundle until a specified expiration date.
145
147
  # @param [SortBy] sort_by Can be `valid-until` or `date-updated`. Defaults to `date-created`.
146
148
  # @param [SortDirection] sort_direction Default is `DESC`. Can be `ASC` or `DESC`.
@@ -154,13 +156,15 @@ module Twilio
154
156
  # but a limit is defined, stream() will attempt to read the limit with the most
155
157
  # efficient page size, i.e. min(limit, 1000)
156
158
  # @return [Array] Array of up to limit results
157
- 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: :unset, valid_until_date_before: :unset, valid_until_date_after: :unset, limit: nil, page_size: nil)
159
+ def list(status: :unset, bundle_sids: :unset, friendly_name: :unset, regulation_sid: :unset, iso_country: :unset, number_type: :unset, end_user_type: :unset, has_valid_until_date: :unset, sort_by: :unset, sort_direction: :unset, valid_until_date: :unset, valid_until_date_before: :unset, valid_until_date_after: :unset, limit: nil, page_size: nil)
158
160
  self.stream(
159
161
  status: status,
162
+ bundle_sids: bundle_sids,
160
163
  friendly_name: friendly_name,
161
164
  regulation_sid: regulation_sid,
162
165
  iso_country: iso_country,
163
166
  number_type: number_type,
167
+ end_user_type: end_user_type,
164
168
  has_valid_until_date: has_valid_until_date,
165
169
  sort_by: sort_by,
166
170
  sort_direction: sort_direction,
@@ -177,10 +181,12 @@ module Twilio
177
181
  # This operation lazily loads records as efficiently as possible until the limit
178
182
  # is reached.
179
183
  # @param [Status] status The verification status of the Bundle resource. Please refer to [Bundle Statuses](https://www.twilio.com/docs/phone-numbers/regulatory/api/bundles#bundle-statuses) for more details.
184
+ # @param [String] bundle_sids A comma-separated list of Bundle SIDs to filter the results (maximum 20). Each Bundle SID must match `^BU[0-9a-fA-F]{32}$`.
180
185
  # @param [String] friendly_name The string that you assigned to describe the resource. The column can contain 255 variable characters.
181
186
  # @param [String] regulation_sid The unique string of a [Regulation resource](https://www.twilio.com/docs/phone-numbers/regulatory/api/regulations) that is associated to the Bundle resource.
182
187
  # @param [String] iso_country The 2-digit [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Bundle's phone number country ownership request.
183
188
  # @param [String] number_type The type of phone number of the Bundle's ownership request. Can be `local`, `mobile`, `national`, or `toll-free`.
189
+ # @param [String] end_user_type The end user type of the regulation of the Bundle. Can be `business` or `individual`.
184
190
  # @param [Boolean] has_valid_until_date Indicates that the Bundle is a valid Bundle until a specified expiration date.
185
191
  # @param [SortBy] sort_by Can be `valid-until` or `date-updated`. Defaults to `date-created`.
186
192
  # @param [SortDirection] sort_direction Default is `DESC`. Can be `ASC` or `DESC`.
@@ -194,15 +200,17 @@ module Twilio
194
200
  # but a limit is defined, stream() will attempt to read the limit with the most
195
201
  # efficient page size, i.e. min(limit, 1000)
196
202
  # @return [Enumerable] Enumerable that will yield up to limit results
197
- 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: :unset, valid_until_date_before: :unset, valid_until_date_after: :unset, limit: nil, page_size: nil)
203
+ def stream(status: :unset, bundle_sids: :unset, friendly_name: :unset, regulation_sid: :unset, iso_country: :unset, number_type: :unset, end_user_type: :unset, has_valid_until_date: :unset, sort_by: :unset, sort_direction: :unset, valid_until_date: :unset, valid_until_date_before: :unset, valid_until_date_after: :unset, limit: nil, page_size: nil)
198
204
  limits = @version.read_limits(limit, page_size)
199
205
 
200
206
  page = self.page(
201
207
  status: status,
208
+ bundle_sids: bundle_sids,
202
209
  friendly_name: friendly_name,
203
210
  regulation_sid: regulation_sid,
204
211
  iso_country: iso_country,
205
212
  number_type: number_type,
213
+ end_user_type: end_user_type,
206
214
  has_valid_until_date: has_valid_until_date,
207
215
  sort_by: sort_by,
208
216
  sort_direction: sort_direction,
@@ -217,10 +225,12 @@ module Twilio
217
225
  ##
218
226
  # Lists BundlePageMetadata records from the API as a list.
219
227
  # @param [Status] status The verification status of the Bundle resource. Please refer to [Bundle Statuses](https://www.twilio.com/docs/phone-numbers/regulatory/api/bundles#bundle-statuses) for more details.
228
+ # @param [String] bundle_sids A comma-separated list of Bundle SIDs to filter the results (maximum 20). Each Bundle SID must match `^BU[0-9a-fA-F]{32}$`.
220
229
  # @param [String] friendly_name The string that you assigned to describe the resource. The column can contain 255 variable characters.
221
230
  # @param [String] regulation_sid The unique string of a [Regulation resource](https://www.twilio.com/docs/phone-numbers/regulatory/api/regulations) that is associated to the Bundle resource.
222
231
  # @param [String] iso_country The 2-digit [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Bundle's phone number country ownership request.
223
232
  # @param [String] number_type The type of phone number of the Bundle's ownership request. Can be `local`, `mobile`, `national`, or `toll-free`.
233
+ # @param [String] end_user_type The end user type of the regulation of the Bundle. Can be `business` or `individual`.
224
234
  # @param [Boolean] has_valid_until_date Indicates that the Bundle is a valid Bundle until a specified expiration date.
225
235
  # @param [SortBy] sort_by Can be `valid-until` or `date-updated`. Defaults to `date-created`.
226
236
  # @param [SortDirection] sort_direction Default is `DESC`. Can be `ASC` or `DESC`.
@@ -234,14 +244,16 @@ module Twilio
234
244
  # but a limit is defined, stream() will attempt to read the limit with the most
235
245
  # efficient page size, i.e. min(limit, 1000)
236
246
  # @return [Array] Array of up to limit results
237
- def list_with_metadata(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: :unset, valid_until_date_before: :unset, valid_until_date_after: :unset, limit: nil, page_size: nil)
247
+ def list_with_metadata(status: :unset, bundle_sids: :unset, friendly_name: :unset, regulation_sid: :unset, iso_country: :unset, number_type: :unset, end_user_type: :unset, has_valid_until_date: :unset, sort_by: :unset, sort_direction: :unset, valid_until_date: :unset, valid_until_date_before: :unset, valid_until_date_after: :unset, limit: nil, page_size: nil)
238
248
  limits = @version.read_limits(limit, page_size)
239
249
  params = Twilio::Values.of({
240
250
  'Status' => status,
251
+ 'BundleSids' => bundle_sids,
241
252
  'FriendlyName' => friendly_name,
242
253
  'RegulationSid' => regulation_sid,
243
254
  'IsoCountry' => iso_country,
244
255
  'NumberType' => number_type,
256
+ 'EndUserType' => end_user_type,
245
257
  'HasValidUntilDate' => has_valid_until_date,
246
258
  'SortBy' => sort_by,
247
259
  'SortDirection' => sort_direction,
@@ -276,10 +288,12 @@ module Twilio
276
288
  # Retrieve a single page of BundleInstance records from the API.
277
289
  # Request is executed immediately.
278
290
  # @param [Status] status The verification status of the Bundle resource. Please refer to [Bundle Statuses](https://www.twilio.com/docs/phone-numbers/regulatory/api/bundles#bundle-statuses) for more details.
291
+ # @param [String] bundle_sids A comma-separated list of Bundle SIDs to filter the results (maximum 20). Each Bundle SID must match `^BU[0-9a-fA-F]{32}$`.
279
292
  # @param [String] friendly_name The string that you assigned to describe the resource. The column can contain 255 variable characters.
280
293
  # @param [String] regulation_sid The unique string of a [Regulation resource](https://www.twilio.com/docs/phone-numbers/regulatory/api/regulations) that is associated to the Bundle resource.
281
294
  # @param [String] iso_country The 2-digit [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Bundle's phone number country ownership request.
282
295
  # @param [String] number_type The type of phone number of the Bundle's ownership request. Can be `local`, `mobile`, `national`, or `toll-free`.
296
+ # @param [String] end_user_type The end user type of the regulation of the Bundle. Can be `business` or `individual`.
283
297
  # @param [Boolean] has_valid_until_date Indicates that the Bundle is a valid Bundle until a specified expiration date.
284
298
  # @param [SortBy] sort_by Can be `valid-until` or `date-updated`. Defaults to `date-created`.
285
299
  # @param [SortDirection] sort_direction Default is `DESC`. Can be `ASC` or `DESC`.
@@ -290,13 +304,15 @@ module Twilio
290
304
  # @param [Integer] page_number Page Number, this value is simply for client state
291
305
  # @param [Integer] page_size Number of records to return, defaults to 50
292
306
  # @return [Page] Page of BundleInstance
293
- 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: :unset, valid_until_date_before: :unset, valid_until_date_after: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
307
+ def page(status: :unset, bundle_sids: :unset, friendly_name: :unset, regulation_sid: :unset, iso_country: :unset, number_type: :unset, end_user_type: :unset, has_valid_until_date: :unset, sort_by: :unset, sort_direction: :unset, valid_until_date: :unset, valid_until_date_before: :unset, valid_until_date_after: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
294
308
  params = Twilio::Values.of({
295
309
  'Status' => status,
310
+ 'BundleSids' => bundle_sids,
296
311
  'FriendlyName' => friendly_name,
297
312
  'RegulationSid' => regulation_sid,
298
313
  'IsoCountry' => iso_country,
299
314
  'NumberType' => number_type,
315
+ 'EndUserType' => end_user_type,
300
316
  'HasValidUntilDate' => has_valid_until_date,
301
317
  'SortBy' => sort_by,
302
318
  'SortDirection' => sort_direction,