recurly 3.19.0 → 4.0.0

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.
Files changed (96) hide show
  1. checksums.yaml +4 -4
  2. data/.bumpversion.cfg +1 -1
  3. data/.github/workflows/docs.yml +1 -1
  4. data/.github_changelog_generator +8 -0
  5. data/.travis.yml +0 -3
  6. data/CHANGELOG.md +202 -268
  7. data/CONTRIBUTING.md +0 -4
  8. data/GETTING_STARTED.md +20 -17
  9. data/README.md +0 -3
  10. data/lib/recurly/client/operations.rb +774 -630
  11. data/lib/recurly/client.rb +44 -28
  12. data/lib/recurly/errors/api_errors.rb +3 -2
  13. data/lib/recurly/errors.rb +5 -23
  14. data/lib/recurly/pager.rb +5 -15
  15. data/lib/recurly/requests/{account_acquisition_updatable.rb → account_acquisition_update.rb} +1 -1
  16. data/lib/recurly/requests/account_create.rb +2 -6
  17. data/lib/recurly/requests/account_purchase.rb +2 -6
  18. data/lib/recurly/requests/account_update.rb +0 -4
  19. data/lib/recurly/requests/add_on_create.rb +2 -2
  20. data/lib/recurly/requests/add_on_pricing.rb +5 -5
  21. data/lib/recurly/requests/add_on_update.rb +2 -2
  22. data/lib/recurly/requests/address.rb +1 -9
  23. data/lib/recurly/requests/billing_info_create.rb +2 -30
  24. data/lib/recurly/requests/coupon_create.rb +1 -1
  25. data/lib/recurly/requests/external_transaction.rb +1 -1
  26. data/lib/recurly/requests/invoice_address.rb +1 -1
  27. data/lib/recurly/requests/invoice_collect.rb +1 -1
  28. data/lib/recurly/requests/{invoice_updatable.rb → invoice_update.rb} +1 -1
  29. data/lib/recurly/requests/line_item_create.rb +2 -6
  30. data/lib/recurly/requests/plan_create.rb +0 -4
  31. data/lib/recurly/requests/plan_pricing.rb +0 -4
  32. data/lib/recurly/requests/plan_update.rb +0 -4
  33. data/lib/recurly/requests/pricing.rb +0 -4
  34. data/lib/recurly/requests/purchase_create.rb +1 -1
  35. data/lib/recurly/requests/shipping_address_create.rb +1 -1
  36. data/lib/recurly/requests/shipping_address_update.rb +1 -1
  37. data/lib/recurly/requests/subscription_add_on_create.rb +6 -2
  38. data/lib/recurly/requests/subscription_add_on_tier.rb +5 -1
  39. data/lib/recurly/requests/subscription_add_on_update.rb +6 -2
  40. data/lib/recurly/requests/subscription_change_create.rb +1 -9
  41. data/lib/recurly/requests/subscription_create.rb +5 -9
  42. data/lib/recurly/requests/subscription_pause.rb +1 -1
  43. data/lib/recurly/requests/subscription_purchase.rb +2 -6
  44. data/lib/recurly/requests/subscription_update.rb +1 -5
  45. data/lib/recurly/requests/tier.rb +2 -2
  46. data/lib/recurly/requests/tier_pricing.rb +22 -0
  47. data/lib/recurly/resources/account.rb +0 -4
  48. data/lib/recurly/resources/account_mini.rb +0 -4
  49. data/lib/recurly/resources/add_on.rb +1 -1
  50. data/lib/recurly/resources/add_on_pricing.rb +5 -5
  51. data/lib/recurly/resources/address.rb +1 -9
  52. data/lib/recurly/resources/address_with_name.rb +46 -0
  53. data/lib/recurly/resources/billing_info.rb +1 -5
  54. data/lib/recurly/resources/billing_info_updated_by.rb +1 -1
  55. data/lib/recurly/resources/coupon.rb +5 -17
  56. data/lib/recurly/resources/invoice.rb +7 -7
  57. data/lib/recurly/resources/invoice_address.rb +1 -1
  58. data/lib/recurly/resources/line_item.rb +7 -7
  59. data/lib/recurly/resources/payment_method.rb +0 -4
  60. data/lib/recurly/resources/plan.rb +1 -5
  61. data/lib/recurly/resources/plan_pricing.rb +0 -4
  62. data/lib/recurly/resources/pricing.rb +0 -4
  63. data/lib/recurly/resources/shipping_address.rb +1 -1
  64. data/lib/recurly/resources/subscription.rb +0 -4
  65. data/lib/recurly/resources/subscription_add_on.rb +6 -2
  66. data/lib/recurly/resources/subscription_add_on_tier.rb +5 -1
  67. data/lib/recurly/resources/subscription_change.rb +0 -12
  68. data/lib/recurly/resources/tax_info.rb +0 -4
  69. data/lib/recurly/resources/tier.rb +2 -2
  70. data/lib/recurly/resources/tier_pricing.rb +22 -0
  71. data/lib/recurly/resources/transaction.rb +3 -7
  72. data/lib/recurly/resources/unique_coupon_code_params.rb +26 -0
  73. data/lib/recurly/resources/usage.rb +5 -1
  74. data/lib/recurly/version.rb +1 -1
  75. data/openapi/api.yaml +1949 -2573
  76. data/scripts/build +2 -2
  77. data/scripts/bump +11 -0
  78. data/scripts/changelog +14 -0
  79. data/scripts/format +2 -2
  80. data/scripts/prepare-release +29 -43
  81. data/scripts/release +20 -5
  82. metadata +15 -22
  83. data/.changelog_config.yaml +0 -11
  84. data/CODE_OF_CONDUCT.md +0 -130
  85. data/lib/recurly/errors/network_errors.rb +0 -10
  86. data/lib/recurly/requests/billing_info_verify.rb +0 -14
  87. data/lib/recurly/requests/dunning_campaigns_bulk_update.rb +0 -18
  88. data/lib/recurly/requests/subscription_change_billing_info_create.rb +0 -14
  89. data/lib/recurly/resources/dunning_campaign.rb +0 -50
  90. data/lib/recurly/resources/dunning_campaigns_bulk_update_response.rb +0 -18
  91. data/lib/recurly/resources/dunning_cycle.rb +0 -58
  92. data/lib/recurly/resources/dunning_interval.rb +0 -18
  93. data/lib/recurly/resources/line_item_list.rb +0 -26
  94. data/lib/recurly/resources/subscription_change_billing_info.rb +0 -14
  95. data/lib/recurly/resources/subscription_change_preview.rb +0 -86
  96. data/lib/recurly/resources/tax_detail.rb +0 -26
@@ -5,14 +5,15 @@
5
5
  module Recurly
6
6
  class Client
7
7
  def api_version
8
- "v2019-10-10"
8
+ "v2021-02-25"
9
9
  end
10
10
 
11
11
  # List sites
12
12
  #
13
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_sites list_sites api documentation}
13
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_sites list_sites api documenation}
14
14
  #
15
- # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
15
+ # @param params [Hash] Optional query string parameters:
16
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
16
17
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
17
18
  #
18
19
  # *Important notes:*
@@ -24,17 +25,20 @@ module Recurly
24
25
  # * Records are returned in an arbitrary order. Since results are all
25
26
  # returned at once you can sort the records yourself.
26
27
  #
27
- # @param limit [Integer] Limit number of records 1-200.
28
- # @param order [String] Sort order.
29
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
28
+ # :limit [Integer] Limit number of records 1-200.
29
+ # :order [String] Sort order.
30
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
30
31
  # order. In descending order updated records will move behind the cursor and could
31
32
  # prevent some records from being returned.
32
33
  #
33
- # @param state [String] Filter by state.
34
+ # :state [String] Filter by state.
34
35
  #
35
36
  # @return [Pager<Resources::Site>] A list of sites.
36
37
  # @example
37
- # sites = @client.list_sites(limit: 200)
38
+ # params = {
39
+ # limit: 200
40
+ # }
41
+ # sites = @client.list_sites(params: params)
38
42
  # sites.each do |site|
39
43
  # puts "Site: #{site.subdomain}"
40
44
  # end
@@ -46,9 +50,10 @@ module Recurly
46
50
 
47
51
  # Fetch a site
48
52
  #
49
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_site get_site api documentation}
53
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_site get_site api documenation}
50
54
  #
51
55
  # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
56
+ # @param params [Hash] Optional query string parameters:
52
57
  #
53
58
  # @return [Resources::Site] A site.
54
59
  # @example
@@ -61,16 +66,17 @@ module Recurly
61
66
  # puts "Resource Not Found"
62
67
  # end
63
68
  #
64
- def get_site(site_id:)
69
+ def get_site(site_id:, **options)
65
70
  path = interpolate_path("/sites/{site_id}", site_id: site_id)
66
- get(path)
71
+ get(path, **options)
67
72
  end
68
73
 
69
74
  # List a site's accounts
70
75
  #
71
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_accounts list_accounts api documentation}
76
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_accounts list_accounts api documenation}
72
77
  #
73
- # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
78
+ # @param params [Hash] Optional query string parameters:
79
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
74
80
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
75
81
  #
76
82
  # *Important notes:*
@@ -82,28 +88,31 @@ module Recurly
82
88
  # * Records are returned in an arbitrary order. Since results are all
83
89
  # returned at once you can sort the records yourself.
84
90
  #
85
- # @param limit [Integer] Limit number of records 1-200.
86
- # @param order [String] Sort order.
87
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
91
+ # :limit [Integer] Limit number of records 1-200.
92
+ # :order [String] Sort order.
93
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
88
94
  # order. In descending order updated records will move behind the cursor and could
89
95
  # prevent some records from being returned.
90
96
  #
91
- # @param begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
97
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
92
98
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
93
99
  #
94
- # @param end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
100
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
95
101
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
96
102
  #
97
- # @param email [String] Filter for accounts with this exact email address. A blank value will return accounts with both +null+ and +""+ email addresses. Note that multiple accounts can share one email address.
98
- # @param subscriber [Boolean] Filter for accounts with or without a subscription in the +active+,
103
+ # :email [String] Filter for accounts with this exact email address. A blank value will return accounts with both +null+ and +""+ email addresses. Note that multiple accounts can share one email address.
104
+ # :subscriber [Boolean] Filter for accounts with or without a subscription in the +active+,
99
105
  # +canceled+, or +future+ state.
100
106
  #
101
- # @param past_due [String] Filter for accounts with an invoice in the +past_due+ state.
102
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
107
+ # :past_due [String] Filter for accounts with an invoice in the +past_due+ state.
108
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
103
109
  #
104
110
  # @return [Pager<Resources::Account>] A list of the site's accounts.
105
111
  # @example
106
- # accounts = @client.list_accounts(limit: 200)
112
+ # params = {
113
+ # limit: 200
114
+ # }
115
+ # accounts = @client.list_accounts(params: params)
107
116
  # accounts.each do |account|
108
117
  # puts "Account: #{account.code}"
109
118
  # end
@@ -115,10 +124,11 @@ module Recurly
115
124
 
116
125
  # Create an account
117
126
  #
118
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_account create_account api documentation}
127
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_account create_account api documenation}
119
128
  #
120
129
  # @param body [Requests::AccountCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AccountCreate}
121
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
130
+ # @param params [Hash] Optional query string parameters:
131
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
122
132
  #
123
133
  # @return [Resources::Account] An account.
124
134
  # @example
@@ -164,10 +174,11 @@ module Recurly
164
174
 
165
175
  # Fetch an account
166
176
  #
167
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_account get_account api documentation}
177
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_account get_account api documenation}
168
178
  #
169
179
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
170
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
180
+ # @param params [Hash] Optional query string parameters:
181
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
171
182
  #
172
183
  # @return [Resources::Account] An account.
173
184
  # @example
@@ -185,13 +196,14 @@ module Recurly
185
196
  get(path, **options)
186
197
  end
187
198
 
188
- # Modify an account
199
+ # Update an account
189
200
  #
190
- # {https://developers.recurly.com/api/v2019-10-10#operation/update_account update_account api documentation}
201
+ # {https://developers.recurly.com/api/v2021-02-25#operation/update_account update_account api documenation}
191
202
  #
192
203
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
193
204
  # @param body [Requests::AccountUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AccountUpdate}
194
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
205
+ # @param params [Hash] Optional query string parameters:
206
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
195
207
  #
196
208
  # @return [Resources::Account] An account.
197
209
  # @example
@@ -218,10 +230,11 @@ module Recurly
218
230
 
219
231
  # Deactivate an account
220
232
  #
221
- # {https://developers.recurly.com/api/v2019-10-10#operation/deactivate_account deactivate_account api documentation}
233
+ # {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_account deactivate_account api documenation}
222
234
  #
223
235
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
224
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
236
+ # @param params [Hash] Optional query string parameters:
237
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
225
238
  #
226
239
  # @return [Resources::Account] An account.
227
240
  # @example
@@ -241,10 +254,11 @@ module Recurly
241
254
 
242
255
  # Fetch an account's acquisition data
243
256
  #
244
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_account_acquisition get_account_acquisition api documentation}
257
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_account_acquisition get_account_acquisition api documenation}
245
258
  #
246
259
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
247
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
260
+ # @param params [Hash] Optional query string parameters:
261
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
248
262
  #
249
263
  # @return [Resources::AccountAcquisition] An account's acquisition data.
250
264
  # @example
@@ -264,11 +278,12 @@ module Recurly
264
278
 
265
279
  # Update an account's acquisition data
266
280
  #
267
- # {https://developers.recurly.com/api/v2019-10-10#operation/update_account_acquisition update_account_acquisition api documentation}
281
+ # {https://developers.recurly.com/api/v2021-02-25#operation/update_account_acquisition update_account_acquisition api documenation}
268
282
  #
269
283
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
270
- # @param body [Requests::AccountAcquisitionUpdatable] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AccountAcquisitionUpdatable}
271
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
284
+ # @param body [Requests::AccountAcquisitionUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AccountAcquisitionUpdate}
285
+ # @param params [Hash] Optional query string parameters:
286
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
272
287
  #
273
288
  # @return [Resources::AccountAcquisition] An account's updated acquisition data.
274
289
  # @example
@@ -295,15 +310,16 @@ module Recurly
295
310
  #
296
311
  def update_account_acquisition(account_id:, body:, **options)
297
312
  path = interpolate_path("/accounts/{account_id}/acquisition", account_id: account_id)
298
- put(path, body, Requests::AccountAcquisitionUpdatable, **options)
313
+ put(path, body, Requests::AccountAcquisitionUpdate, **options)
299
314
  end
300
315
 
301
316
  # Remove an account's acquisition data
302
317
  #
303
- # {https://developers.recurly.com/api/v2019-10-10#operation/remove_account_acquisition remove_account_acquisition api documentation}
318
+ # {https://developers.recurly.com/api/v2021-02-25#operation/remove_account_acquisition remove_account_acquisition api documenation}
304
319
  #
305
320
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
306
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
321
+ # @param params [Hash] Optional query string parameters:
322
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
307
323
  #
308
324
  # @return [Resources::Empty] Acquisition data was succesfully deleted.
309
325
  # @example
@@ -323,10 +339,11 @@ module Recurly
323
339
 
324
340
  # Reactivate an inactive account
325
341
  #
326
- # {https://developers.recurly.com/api/v2019-10-10#operation/reactivate_account reactivate_account api documentation}
342
+ # {https://developers.recurly.com/api/v2021-02-25#operation/reactivate_account reactivate_account api documenation}
327
343
  #
328
344
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
329
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
345
+ # @param params [Hash] Optional query string parameters:
346
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
330
347
  #
331
348
  # @return [Resources::Account] An account.
332
349
  # @example
@@ -346,10 +363,11 @@ module Recurly
346
363
 
347
364
  # Fetch an account's balance and past due status
348
365
  #
349
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_account_balance get_account_balance api documentation}
366
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_account_balance get_account_balance api documenation}
350
367
  #
351
368
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
352
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
369
+ # @param params [Hash] Optional query string parameters:
370
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
353
371
  #
354
372
  # @return [Resources::AccountBalance] An account's balance.
355
373
  # @example
@@ -369,10 +387,11 @@ module Recurly
369
387
 
370
388
  # Fetch an account's billing information
371
389
  #
372
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_billing_info get_billing_info api documentation}
390
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_billing_info get_billing_info api documenation}
373
391
  #
374
392
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
375
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
393
+ # @param params [Hash] Optional query string parameters:
394
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
376
395
  #
377
396
  # @return [Resources::BillingInfo] An account's billing information.
378
397
  # @example
@@ -392,11 +411,12 @@ module Recurly
392
411
 
393
412
  # Set an account's billing information
394
413
  #
395
- # {https://developers.recurly.com/api/v2019-10-10#operation/update_billing_info update_billing_info api documentation}
414
+ # {https://developers.recurly.com/api/v2021-02-25#operation/update_billing_info update_billing_info api documenation}
396
415
  #
397
416
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
398
417
  # @param body [Requests::BillingInfoCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoCreate}
399
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
418
+ # @param params [Hash] Optional query string parameters:
419
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
400
420
  #
401
421
  # @return [Resources::BillingInfo] Updated billing information.
402
422
  # @example
@@ -423,10 +443,11 @@ module Recurly
423
443
 
424
444
  # Remove an account's billing information
425
445
  #
426
- # {https://developers.recurly.com/api/v2019-10-10#operation/remove_billing_info remove_billing_info api documentation}
446
+ # {https://developers.recurly.com/api/v2021-02-25#operation/remove_billing_info remove_billing_info api documenation}
427
447
  #
428
448
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
429
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
449
+ # @param params [Hash] Optional query string parameters:
450
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
430
451
  #
431
452
  # @return [Resources::Empty] Billing information deleted
432
453
  # @example
@@ -444,36 +465,13 @@ module Recurly
444
465
  delete(path, **options)
445
466
  end
446
467
 
447
- # Verify an account's credit card billing information
448
- #
449
- # {https://developers.recurly.com/api/v2019-10-10#operation/verify_billing_info verify_billing_info api documentation}
450
- #
451
- # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
452
- # @param body [Requests::BillingInfoVerify] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoVerify}
453
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
454
- #
455
- # @return [Resources::Transaction] Transaction information from verify.
456
- # @example
457
- # begin
458
- # transaction = @client.verify_billing_info(account_id: account_id)
459
- # puts "Got Transaction #{transaction}"
460
- # rescue Recurly::Errors::NotFoundError
461
- # # If the resource was not found, you may want to alert the user or
462
- # # just return nil
463
- # puts "Resource Not Found"
464
- # end
465
- #
466
- def verify_billing_info(account_id:, **options)
467
- path = interpolate_path("/accounts/{account_id}/billing_info/verify", account_id: account_id)
468
- post(path, options[:body], Requests::BillingInfoVerify, **options)
469
- end
470
-
471
468
  # Get the list of billing information associated with an account
472
469
  #
473
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_billing_infos list_billing_infos api documentation}
470
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_billing_infos list_billing_infos api documenation}
474
471
  #
475
472
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
476
- # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
473
+ # @param params [Hash] Optional query string parameters:
474
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
477
475
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
478
476
  #
479
477
  # *Important notes:*
@@ -485,17 +483,17 @@ module Recurly
485
483
  # * Records are returned in an arbitrary order. Since results are all
486
484
  # returned at once you can sort the records yourself.
487
485
  #
488
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
486
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
489
487
  # order. In descending order updated records will move behind the cursor and could
490
488
  # prevent some records from being returned.
491
489
  #
492
- # @param begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
490
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
493
491
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
494
492
  #
495
- # @param end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
493
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
496
494
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
497
495
  #
498
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
496
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
499
497
  #
500
498
  # @return [Pager<Resources::BillingInfo>] A list of the the billing information for an account's
501
499
  #
@@ -504,13 +502,14 @@ module Recurly
504
502
  pager(path, **options)
505
503
  end
506
504
 
507
- # Add new billing information on an account
505
+ # Set an account's billing information when the wallet feature is enabled
508
506
  #
509
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_billing_info create_billing_info api documentation}
507
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_billing_info create_billing_info api documenation}
510
508
  #
511
509
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
512
510
  # @param body [Requests::BillingInfoCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoCreate}
513
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
511
+ # @param params [Hash] Optional query string parameters:
512
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
514
513
  #
515
514
  # @return [Resources::BillingInfo] Updated billing information.
516
515
  #
@@ -521,11 +520,12 @@ module Recurly
521
520
 
522
521
  # Fetch a billing info
523
522
  #
524
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_a_billing_info get_a_billing_info api documentation}
523
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_a_billing_info get_a_billing_info api documenation}
525
524
  #
526
525
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
527
- # @param billing_info_id [String] Billing Info ID. Can ONLY be used for sites utilizing the Wallet feature.
528
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
526
+ # @param billing_info_id [String] Billing Info ID.
527
+ # @param params [Hash] Optional query string parameters:
528
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
529
529
  #
530
530
  # @return [Resources::BillingInfo] A billing info.
531
531
  #
@@ -536,12 +536,13 @@ module Recurly
536
536
 
537
537
  # Update an account's billing information
538
538
  #
539
- # {https://developers.recurly.com/api/v2019-10-10#operation/update_a_billing_info update_a_billing_info api documentation}
539
+ # {https://developers.recurly.com/api/v2021-02-25#operation/update_a_billing_info update_a_billing_info api documenation}
540
540
  #
541
541
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
542
- # @param billing_info_id [String] Billing Info ID. Can ONLY be used for sites utilizing the Wallet feature.
542
+ # @param billing_info_id [String] Billing Info ID.
543
543
  # @param body [Requests::BillingInfoCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoCreate}
544
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
544
+ # @param params [Hash] Optional query string parameters:
545
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
545
546
  #
546
547
  # @return [Resources::BillingInfo] Updated billing information.
547
548
  #
@@ -552,11 +553,12 @@ module Recurly
552
553
 
553
554
  # Remove an account's billing information
554
555
  #
555
- # {https://developers.recurly.com/api/v2019-10-10#operation/remove_a_billing_info remove_a_billing_info api documentation}
556
+ # {https://developers.recurly.com/api/v2021-02-25#operation/remove_a_billing_info remove_a_billing_info api documenation}
556
557
  #
557
558
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
558
- # @param billing_info_id [String] Billing Info ID. Can ONLY be used for sites utilizing the Wallet feature.
559
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
559
+ # @param billing_info_id [String] Billing Info ID.
560
+ # @param params [Hash] Optional query string parameters:
561
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
560
562
  #
561
563
  # @return [Resources::Empty] Billing information deleted
562
564
  #
@@ -567,10 +569,11 @@ module Recurly
567
569
 
568
570
  # Show the coupon redemptions for an account
569
571
  #
570
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_coupon_redemptions list_account_coupon_redemptions api documentation}
572
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_coupon_redemptions list_account_coupon_redemptions api documenation}
571
573
  #
572
574
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
573
- # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
575
+ # @param params [Hash] Optional query string parameters:
576
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
574
577
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
575
578
  #
576
579
  # *Important notes:*
@@ -582,24 +585,27 @@ module Recurly
582
585
  # * Records are returned in an arbitrary order. Since results are all
583
586
  # returned at once you can sort the records yourself.
584
587
  #
585
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
588
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
586
589
  # order. In descending order updated records will move behind the cursor and could
587
590
  # prevent some records from being returned.
588
591
  #
589
- # @param begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
592
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
590
593
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
591
594
  #
592
- # @param end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
595
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
593
596
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
594
597
  #
595
- # @param state [String] Filter by state.
596
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
598
+ # :state [String] Filter by state.
599
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
597
600
  #
598
601
  # @return [Pager<Resources::CouponRedemption>] A list of the the coupon redemptions on an account.
599
602
  # @example
603
+ # params = {
604
+ # limit: 200
605
+ # }
600
606
  # redemptions = @client.list_account_coupon_redemptions(
601
607
  # account_id: account_id,
602
- # limit: 200
608
+ # params: params
603
609
  # )
604
610
  # redemptions.each do |redemption|
605
611
  # puts "CouponRedemption: #{redemption.id}"
@@ -610,36 +616,37 @@ module Recurly
610
616
  pager(path, **options)
611
617
  end
612
618
 
613
- # Show the coupon redemption that is active on an account
619
+ # Show the coupon redemptions that are active on an account
614
620
  #
615
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_active_coupon_redemption get_active_coupon_redemption api documentation}
621
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_active_coupon_redemptions list_active_coupon_redemptions api documenation}
616
622
  #
617
623
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
618
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
624
+ # @param params [Hash] Optional query string parameters:
625
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
619
626
  #
620
- # @return [Resources::CouponRedemption] An active coupon redemption on an account.
627
+ # @return [Pager<Resources::CouponRedemption>] Active coupon redemptions on an account.
621
628
  # @example
622
- # begin
623
- # redemption = @client.get_active_coupon_redemption(account_id: account_id)
624
- # puts "Got CouponRedemption #{redemption}"
625
- # rescue Recurly::Errors::NotFoundError
626
- # # If the resource was not found, you may want to alert the user or
627
- # # just return nil
628
- # puts "Resource Not Found"
629
+ # params = {
630
+ # limit: 200
631
+ # }
632
+ # redemptions = @client.list_active_coupon_redemptions(account_id: account_id, params: params)
633
+ # redemptions.each do |redemption|
634
+ # puts "Redemption: #{redemption.id}"
629
635
  # end
630
636
  #
631
- def get_active_coupon_redemption(account_id:, **options)
637
+ def list_active_coupon_redemptions(account_id:, **options)
632
638
  path = interpolate_path("/accounts/{account_id}/coupon_redemptions/active", account_id: account_id)
633
- get(path, **options)
639
+ pager(path, **options)
634
640
  end
635
641
 
636
642
  # Generate an active coupon redemption on an account or subscription
637
643
  #
638
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_coupon_redemption create_coupon_redemption api documentation}
644
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_coupon_redemption create_coupon_redemption api documenation}
639
645
  #
640
646
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
641
647
  # @param body [Requests::CouponRedemptionCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponRedemptionCreate}
642
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
648
+ # @param params [Hash] Optional query string parameters:
649
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
643
650
  #
644
651
  # @return [Resources::CouponRedemption] Returns the new coupon redemption.
645
652
  # @example
@@ -666,10 +673,11 @@ module Recurly
666
673
 
667
674
  # Delete the active coupon redemption from an account
668
675
  #
669
- # {https://developers.recurly.com/api/v2019-10-10#operation/remove_coupon_redemption remove_coupon_redemption api documentation}
676
+ # {https://developers.recurly.com/api/v2021-02-25#operation/remove_coupon_redemption remove_coupon_redemption api documenation}
670
677
  #
671
678
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
672
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
679
+ # @param params [Hash] Optional query string parameters:
680
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
673
681
  #
674
682
  # @return [Resources::CouponRedemption] Coupon redemption deleted.
675
683
  # @example
@@ -689,28 +697,32 @@ module Recurly
689
697
 
690
698
  # List an account's credit payments
691
699
  #
692
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_credit_payments list_account_credit_payments api documentation}
700
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_credit_payments list_account_credit_payments api documenation}
693
701
  #
694
702
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
695
- # @param limit [Integer] Limit number of records 1-200.
696
- # @param order [String] Sort order.
697
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
703
+ # @param params [Hash] Optional query string parameters:
704
+ # :limit [Integer] Limit number of records 1-200.
705
+ # :order [String] Sort order.
706
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
698
707
  # order. In descending order updated records will move behind the cursor and could
699
708
  # prevent some records from being returned.
700
709
  #
701
- # @param begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
710
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
702
711
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
703
712
  #
704
- # @param end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
713
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
705
714
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
706
715
  #
707
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
716
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
708
717
  #
709
718
  # @return [Pager<Resources::CreditPayment>] A list of the account's credit payments.
710
719
  # @example
720
+ # params = {
721
+ # limit: 200
722
+ # }
711
723
  # payments = @client.list_account_credit_payments(
712
724
  # account_id: account_id,
713
- # limit: 200
725
+ # params: params
714
726
  # )
715
727
  # payments.each do |payment|
716
728
  # puts "CreditPayment: #{payment.id}"
@@ -723,10 +735,11 @@ module Recurly
723
735
 
724
736
  # List an account's invoices
725
737
  #
726
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_invoices list_account_invoices api documentation}
738
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_invoices list_account_invoices api documenation}
727
739
  #
728
740
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
729
- # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
741
+ # @param params [Hash] Optional query string parameters:
742
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
730
743
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
731
744
  #
732
745
  # *Important notes:*
@@ -738,31 +751,34 @@ module Recurly
738
751
  # * Records are returned in an arbitrary order. Since results are all
739
752
  # returned at once you can sort the records yourself.
740
753
  #
741
- # @param limit [Integer] Limit number of records 1-200.
742
- # @param order [String] Sort order.
743
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
754
+ # :limit [Integer] Limit number of records 1-200.
755
+ # :order [String] Sort order.
756
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
744
757
  # order. In descending order updated records will move behind the cursor and could
745
758
  # prevent some records from being returned.
746
759
  #
747
- # @param begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
760
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
748
761
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
749
762
  #
750
- # @param end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
763
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
751
764
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
752
765
  #
753
- # @param type [String] Filter by type when:
766
+ # :type [String] Filter by type when:
754
767
  # - +type=charge+, only charge invoices will be returned.
755
768
  # - +type=credit+, only credit invoices will be returned.
756
769
  # - +type=non-legacy+, only charge and credit invoices will be returned.
757
770
  # - +type=legacy+, only legacy invoices will be returned.
758
771
  #
759
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
772
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
760
773
  #
761
774
  # @return [Pager<Resources::Invoice>] A list of the account's invoices.
762
775
  # @example
776
+ # params = {
777
+ # limit: 200
778
+ # }
763
779
  # invoices = @client.list_account_invoices(
764
780
  # account_id: account_id,
765
- # limit: 200
781
+ # params: params
766
782
  # )
767
783
  # invoices.each do |invoice|
768
784
  # puts "Invoice: #{invoice.number}"
@@ -775,11 +791,12 @@ module Recurly
775
791
 
776
792
  # Create an invoice for pending line items
777
793
  #
778
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_invoice create_invoice api documentation}
794
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_invoice create_invoice api documenation}
779
795
  #
780
796
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
781
797
  # @param body [Requests::InvoiceCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceCreate}
782
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
798
+ # @param params [Hash] Optional query string parameters:
799
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
783
800
  #
784
801
  # @return [Resources::InvoiceCollection] Returns the new invoices.
785
802
  # @example
@@ -806,11 +823,12 @@ module Recurly
806
823
 
807
824
  # Preview new invoice for pending line items
808
825
  #
809
- # {https://developers.recurly.com/api/v2019-10-10#operation/preview_invoice preview_invoice api documentation}
826
+ # {https://developers.recurly.com/api/v2021-02-25#operation/preview_invoice preview_invoice api documenation}
810
827
  #
811
828
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
812
829
  # @param body [Requests::InvoiceCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceCreate}
813
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
830
+ # @param params [Hash] Optional query string parameters:
831
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
814
832
  #
815
833
  # @return [Resources::InvoiceCollection] Returns the invoice previews.
816
834
  # @example
@@ -837,10 +855,11 @@ module Recurly
837
855
 
838
856
  # List an account's line items
839
857
  #
840
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_line_items list_account_line_items api documentation}
858
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_line_items list_account_line_items api documenation}
841
859
  #
842
860
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
843
- # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
861
+ # @param params [Hash] Optional query string parameters:
862
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
844
863
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
845
864
  #
846
865
  # *Important notes:*
@@ -852,28 +871,31 @@ module Recurly
852
871
  # * Records are returned in an arbitrary order. Since results are all
853
872
  # returned at once you can sort the records yourself.
854
873
  #
855
- # @param limit [Integer] Limit number of records 1-200.
856
- # @param order [String] Sort order.
857
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
874
+ # :limit [Integer] Limit number of records 1-200.
875
+ # :order [String] Sort order.
876
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
858
877
  # order. In descending order updated records will move behind the cursor and could
859
878
  # prevent some records from being returned.
860
879
  #
861
- # @param begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
880
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
862
881
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
863
882
  #
864
- # @param end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
883
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
865
884
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
866
885
  #
867
- # @param original [String] Filter by original field.
868
- # @param state [String] Filter by state field.
869
- # @param type [String] Filter by type field.
870
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
886
+ # :original [String] Filter by original field.
887
+ # :state [String] Filter by state field.
888
+ # :type [String] Filter by type field.
889
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
871
890
  #
872
891
  # @return [Pager<Resources::LineItem>] A list of the account's line items.
873
892
  # @example
893
+ # params = {
894
+ # limit: 200
895
+ # }
874
896
  # line_items = @client.list_account_line_items(
875
897
  # account_id: account_id,
876
- # limit: 200
898
+ # params: params
877
899
  # )
878
900
  # line_items.each do |line_item|
879
901
  # puts "LineItem: #{line_item.id}"
@@ -886,11 +908,12 @@ module Recurly
886
908
 
887
909
  # Create a new line item for the account
888
910
  #
889
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_line_item create_line_item api documentation}
911
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_line_item create_line_item api documenation}
890
912
  #
891
913
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
892
914
  # @param body [Requests::LineItemCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::LineItemCreate}
893
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
915
+ # @param params [Hash] Optional query string parameters:
916
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
894
917
  #
895
918
  # @return [Resources::LineItem] Returns the new line item.
896
919
  # @example
@@ -918,10 +941,11 @@ module Recurly
918
941
 
919
942
  # Fetch a list of an account's notes
920
943
  #
921
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_notes list_account_notes api documentation}
944
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_notes list_account_notes api documenation}
922
945
  #
923
946
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
924
- # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
947
+ # @param params [Hash] Optional query string parameters:
948
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
925
949
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
926
950
  #
927
951
  # *Important notes:*
@@ -933,11 +957,14 @@ module Recurly
933
957
  # * Records are returned in an arbitrary order. Since results are all
934
958
  # returned at once you can sort the records yourself.
935
959
  #
936
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
960
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
937
961
  #
938
962
  # @return [Pager<Resources::AccountNote>] A list of an account's notes.
939
963
  # @example
940
- # account_notes = @client.list_account_notes(account_id: account_id, limit: 200)
964
+ # params = {
965
+ # limit: 200
966
+ # }
967
+ # account_notes = @client.list_account_notes(account_id: account_id, params: params)
941
968
  # account_notes.each do |note|
942
969
  # puts "AccountNote: #{note.message}"
943
970
  # end
@@ -949,11 +976,12 @@ module Recurly
949
976
 
950
977
  # Fetch an account note
951
978
  #
952
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_account_note get_account_note api documentation}
979
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_account_note get_account_note api documenation}
953
980
  #
954
981
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
955
982
  # @param account_note_id [String] Account Note ID.
956
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
983
+ # @param params [Hash] Optional query string parameters:
984
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
957
985
  #
958
986
  # @return [Resources::AccountNote] An account note.
959
987
  # @example
@@ -976,10 +1004,11 @@ module Recurly
976
1004
 
977
1005
  # Fetch a list of an account's shipping addresses
978
1006
  #
979
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_shipping_addresses list_shipping_addresses api documentation}
1007
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_shipping_addresses list_shipping_addresses api documenation}
980
1008
  #
981
1009
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
982
- # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
1010
+ # @param params [Hash] Optional query string parameters:
1011
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
983
1012
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
984
1013
  #
985
1014
  # *Important notes:*
@@ -991,25 +1020,28 @@ module Recurly
991
1020
  # * Records are returned in an arbitrary order. Since results are all
992
1021
  # returned at once you can sort the records yourself.
993
1022
  #
994
- # @param limit [Integer] Limit number of records 1-200.
995
- # @param order [String] Sort order.
996
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
1023
+ # :limit [Integer] Limit number of records 1-200.
1024
+ # :order [String] Sort order.
1025
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
997
1026
  # order. In descending order updated records will move behind the cursor and could
998
1027
  # prevent some records from being returned.
999
1028
  #
1000
- # @param begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
1029
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
1001
1030
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1002
1031
  #
1003
- # @param end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
1032
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
1004
1033
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1005
1034
  #
1006
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1035
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1007
1036
  #
1008
1037
  # @return [Pager<Resources::ShippingAddress>] A list of an account's shipping addresses.
1009
1038
  # @example
1039
+ # params = {
1040
+ # limit: 200
1041
+ # }
1010
1042
  # shipping_addresses = @client.list_shipping_addresses(
1011
1043
  # account_id: account_id,
1012
- # limit: 200
1044
+ # params: params
1013
1045
  # )
1014
1046
  # shipping_addresses.each do |addr|
1015
1047
  # puts "ShippingAddress: #{addr.nickname} - #{addr.street1}"
@@ -1022,11 +1054,12 @@ module Recurly
1022
1054
 
1023
1055
  # Create a new shipping address for the account
1024
1056
  #
1025
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_shipping_address create_shipping_address api documentation}
1057
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_shipping_address create_shipping_address api documenation}
1026
1058
  #
1027
1059
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
1028
1060
  # @param body [Requests::ShippingAddressCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ShippingAddressCreate}
1029
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1061
+ # @param params [Hash] Optional query string parameters:
1062
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1030
1063
  #
1031
1064
  # @return [Resources::ShippingAddress] Returns the new shipping address.
1032
1065
  # @example
@@ -1056,11 +1089,12 @@ module Recurly
1056
1089
 
1057
1090
  # Fetch an account's shipping address
1058
1091
  #
1059
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_shipping_address get_shipping_address api documentation}
1092
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_shipping_address get_shipping_address api documenation}
1060
1093
  #
1061
1094
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
1062
1095
  # @param shipping_address_id [String] Shipping Address ID.
1063
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1096
+ # @param params [Hash] Optional query string parameters:
1097
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1064
1098
  #
1065
1099
  # @return [Resources::ShippingAddress] A shipping address.
1066
1100
  # @example
@@ -1083,12 +1117,13 @@ module Recurly
1083
1117
 
1084
1118
  # Update an account's shipping address
1085
1119
  #
1086
- # {https://developers.recurly.com/api/v2019-10-10#operation/update_shipping_address update_shipping_address api documentation}
1120
+ # {https://developers.recurly.com/api/v2021-02-25#operation/update_shipping_address update_shipping_address api documenation}
1087
1121
  #
1088
1122
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
1089
1123
  # @param shipping_address_id [String] Shipping Address ID.
1090
1124
  # @param body [Requests::ShippingAddressUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ShippingAddressUpdate}
1091
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1125
+ # @param params [Hash] Optional query string parameters:
1126
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1092
1127
  #
1093
1128
  # @return [Resources::ShippingAddress] The updated shipping address.
1094
1129
  # @example
@@ -1117,11 +1152,12 @@ module Recurly
1117
1152
 
1118
1153
  # Remove an account's shipping address
1119
1154
  #
1120
- # {https://developers.recurly.com/api/v2019-10-10#operation/remove_shipping_address remove_shipping_address api documentation}
1155
+ # {https://developers.recurly.com/api/v2021-02-25#operation/remove_shipping_address remove_shipping_address api documenation}
1121
1156
  #
1122
1157
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
1123
1158
  # @param shipping_address_id [String] Shipping Address ID.
1124
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1159
+ # @param params [Hash] Optional query string parameters:
1160
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1125
1161
  #
1126
1162
  # @return [Resources::Empty] Shipping address deleted.
1127
1163
  # @example
@@ -1144,10 +1180,11 @@ module Recurly
1144
1180
 
1145
1181
  # List an account's subscriptions
1146
1182
  #
1147
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_subscriptions list_account_subscriptions api documentation}
1183
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_subscriptions list_account_subscriptions api documenation}
1148
1184
  #
1149
1185
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
1150
- # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
1186
+ # @param params [Hash] Optional query string parameters:
1187
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
1151
1188
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
1152
1189
  #
1153
1190
  # *Important notes:*
@@ -1159,31 +1196,34 @@ module Recurly
1159
1196
  # * Records are returned in an arbitrary order. Since results are all
1160
1197
  # returned at once you can sort the records yourself.
1161
1198
  #
1162
- # @param limit [Integer] Limit number of records 1-200.
1163
- # @param order [String] Sort order.
1164
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
1199
+ # :limit [Integer] Limit number of records 1-200.
1200
+ # :order [String] Sort order.
1201
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
1165
1202
  # order. In descending order updated records will move behind the cursor and could
1166
1203
  # prevent some records from being returned.
1167
1204
  #
1168
- # @param begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
1205
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
1169
1206
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1170
1207
  #
1171
- # @param end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
1208
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
1172
1209
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1173
1210
  #
1174
- # @param state [String] Filter by state.
1211
+ # :state [String] Filter by state.
1175
1212
  #
1176
1213
  # - When +state=active+, +state=canceled+, +state=expired+, or +state=future+, subscriptions with states that match the query and only those subscriptions will be returned.
1177
1214
  # - When +state=in_trial+, only subscriptions that have a trial_started_at date earlier than now and a trial_ends_at date later than now will be returned.
1178
1215
  # - When +state=live+, only subscriptions that are in an active, canceled, or future state or are in trial will be returned.
1179
1216
  #
1180
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1217
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1181
1218
  #
1182
1219
  # @return [Pager<Resources::Subscription>] A list of the account's subscriptions.
1183
1220
  # @example
1221
+ # params = {
1222
+ # limit: 200
1223
+ # }
1184
1224
  # subscriptions = @client.list_account_subscriptions(
1185
1225
  # account_id: account_id,
1186
- # limit: 200
1226
+ # params: params
1187
1227
  # )
1188
1228
  # subscriptions.each do |subscription|
1189
1229
  # puts "Subscription: #{subscription.uuid}"
@@ -1196,10 +1236,11 @@ module Recurly
1196
1236
 
1197
1237
  # List an account's transactions
1198
1238
  #
1199
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_transactions list_account_transactions api documentation}
1239
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_transactions list_account_transactions api documenation}
1200
1240
  #
1201
1241
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
1202
- # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
1242
+ # @param params [Hash] Optional query string parameters:
1243
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
1203
1244
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
1204
1245
  #
1205
1246
  # *Important notes:*
@@ -1211,27 +1252,30 @@ module Recurly
1211
1252
  # * Records are returned in an arbitrary order. Since results are all
1212
1253
  # returned at once you can sort the records yourself.
1213
1254
  #
1214
- # @param limit [Integer] Limit number of records 1-200.
1215
- # @param order [String] Sort order.
1216
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
1255
+ # :limit [Integer] Limit number of records 1-200.
1256
+ # :order [String] Sort order.
1257
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
1217
1258
  # order. In descending order updated records will move behind the cursor and could
1218
1259
  # prevent some records from being returned.
1219
1260
  #
1220
- # @param begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
1261
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
1221
1262
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1222
1263
  #
1223
- # @param end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
1264
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
1224
1265
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1225
1266
  #
1226
- # @param type [String] Filter by type field. The value +payment+ will return both +purchase+ and +capture+ transactions.
1227
- # @param success [String] Filter by success field.
1228
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1267
+ # :type [String] Filter by type field. The value +payment+ will return both +purchase+ and +capture+ transactions.
1268
+ # :success [String] Filter by success field.
1269
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1229
1270
  #
1230
1271
  # @return [Pager<Resources::Transaction>] A list of the account's transactions.
1231
1272
  # @example
1273
+ # params = {
1274
+ # limit: 200
1275
+ # }
1232
1276
  # transactions = @client.list_account_transactions(
1233
1277
  # account_id: account_id,
1234
- # limit: 200
1278
+ # params: params
1235
1279
  # )
1236
1280
  # transactions.each do |transaction|
1237
1281
  # puts "Transaction: #{transaction.uuid}"
@@ -1244,10 +1288,11 @@ module Recurly
1244
1288
 
1245
1289
  # List an account's child accounts
1246
1290
  #
1247
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_child_accounts list_child_accounts api documentation}
1291
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_child_accounts list_child_accounts api documenation}
1248
1292
  #
1249
1293
  # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
1250
- # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
1294
+ # @param params [Hash] Optional query string parameters:
1295
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
1251
1296
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
1252
1297
  #
1253
1298
  # *Important notes:*
@@ -1259,30 +1304,33 @@ module Recurly
1259
1304
  # * Records are returned in an arbitrary order. Since results are all
1260
1305
  # returned at once you can sort the records yourself.
1261
1306
  #
1262
- # @param limit [Integer] Limit number of records 1-200.
1263
- # @param order [String] Sort order.
1264
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
1307
+ # :limit [Integer] Limit number of records 1-200.
1308
+ # :order [String] Sort order.
1309
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
1265
1310
  # order. In descending order updated records will move behind the cursor and could
1266
1311
  # prevent some records from being returned.
1267
1312
  #
1268
- # @param begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
1313
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
1269
1314
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1270
1315
  #
1271
- # @param end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
1316
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
1272
1317
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1273
1318
  #
1274
- # @param email [String] Filter for accounts with this exact email address. A blank value will return accounts with both +null+ and +""+ email addresses. Note that multiple accounts can share one email address.
1275
- # @param subscriber [Boolean] Filter for accounts with or without a subscription in the +active+,
1319
+ # :email [String] Filter for accounts with this exact email address. A blank value will return accounts with both +null+ and +""+ email addresses. Note that multiple accounts can share one email address.
1320
+ # :subscriber [Boolean] Filter for accounts with or without a subscription in the +active+,
1276
1321
  # +canceled+, or +future+ state.
1277
1322
  #
1278
- # @param past_due [String] Filter for accounts with an invoice in the +past_due+ state.
1279
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1323
+ # :past_due [String] Filter for accounts with an invoice in the +past_due+ state.
1324
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1280
1325
  #
1281
1326
  # @return [Pager<Resources::Account>] A list of an account's child accounts.
1282
1327
  # @example
1328
+ # params = {
1329
+ # limit: 200
1330
+ # }
1283
1331
  # child_accounts = @client.list_child_accounts(
1284
1332
  # account_id: account_id,
1285
- # limit: 200
1333
+ # params: params
1286
1334
  # )
1287
1335
  # child_accounts.each do |child|
1288
1336
  # puts "Account: #{child.code}"
@@ -1295,9 +1343,10 @@ module Recurly
1295
1343
 
1296
1344
  # List a site's account acquisition data
1297
1345
  #
1298
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_acquisition list_account_acquisition api documentation}
1346
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_acquisition list_account_acquisition api documenation}
1299
1347
  #
1300
- # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
1348
+ # @param params [Hash] Optional query string parameters:
1349
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
1301
1350
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
1302
1351
  #
1303
1352
  # *Important notes:*
@@ -1309,23 +1358,26 @@ module Recurly
1309
1358
  # * Records are returned in an arbitrary order. Since results are all
1310
1359
  # returned at once you can sort the records yourself.
1311
1360
  #
1312
- # @param limit [Integer] Limit number of records 1-200.
1313
- # @param order [String] Sort order.
1314
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
1361
+ # :limit [Integer] Limit number of records 1-200.
1362
+ # :order [String] Sort order.
1363
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
1315
1364
  # order. In descending order updated records will move behind the cursor and could
1316
1365
  # prevent some records from being returned.
1317
1366
  #
1318
- # @param begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
1367
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
1319
1368
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1320
1369
  #
1321
- # @param end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
1370
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
1322
1371
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1323
1372
  #
1324
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1373
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1325
1374
  #
1326
1375
  # @return [Pager<Resources::AccountAcquisition>] A list of the site's account acquisition data.
1327
1376
  # @example
1328
- # acquisitions = @client.list_account_acquisition(limit: 200)
1377
+ # params = {
1378
+ # limit: 200
1379
+ # }
1380
+ # acquisitions = @client.list_account_acquisition(params: params)
1329
1381
  # acquisitions.each do |acquisition|
1330
1382
  # puts "AccountAcquisition: #{acquisition.cost}"
1331
1383
  # end
@@ -1337,9 +1389,10 @@ module Recurly
1337
1389
 
1338
1390
  # List a site's coupons
1339
1391
  #
1340
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_coupons list_coupons api documentation}
1392
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_coupons list_coupons api documenation}
1341
1393
  #
1342
- # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
1394
+ # @param params [Hash] Optional query string parameters:
1395
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
1343
1396
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
1344
1397
  #
1345
1398
  # *Important notes:*
@@ -1351,23 +1404,26 @@ module Recurly
1351
1404
  # * Records are returned in an arbitrary order. Since results are all
1352
1405
  # returned at once you can sort the records yourself.
1353
1406
  #
1354
- # @param limit [Integer] Limit number of records 1-200.
1355
- # @param order [String] Sort order.
1356
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
1407
+ # :limit [Integer] Limit number of records 1-200.
1408
+ # :order [String] Sort order.
1409
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
1357
1410
  # order. In descending order updated records will move behind the cursor and could
1358
1411
  # prevent some records from being returned.
1359
1412
  #
1360
- # @param begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
1413
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
1361
1414
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1362
1415
  #
1363
- # @param end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
1416
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
1364
1417
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1365
1418
  #
1366
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1419
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1367
1420
  #
1368
1421
  # @return [Pager<Resources::Coupon>] A list of the site's coupons.
1369
1422
  # @example
1370
- # coupons = @client.list_coupons(limit: 200)
1423
+ # params = {
1424
+ # limit: 200
1425
+ # }
1426
+ # coupons = @client.list_coupons(params: params)
1371
1427
  # coupons.each do |coupon|
1372
1428
  # puts "coupon: #{coupon.code}"
1373
1429
  # end
@@ -1379,10 +1435,11 @@ module Recurly
1379
1435
 
1380
1436
  # Create a new coupon
1381
1437
  #
1382
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_coupon create_coupon api documentation}
1438
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_coupon create_coupon api documenation}
1383
1439
  #
1384
1440
  # @param body [Requests::CouponCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponCreate}
1385
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1441
+ # @param params [Hash] Optional query string parameters:
1442
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1386
1443
  #
1387
1444
  # @return [Resources::Coupon] A new coupon.
1388
1445
  # @example
@@ -1415,10 +1472,11 @@ module Recurly
1415
1472
 
1416
1473
  # Fetch a coupon
1417
1474
  #
1418
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_coupon get_coupon api documentation}
1475
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_coupon get_coupon api documenation}
1419
1476
  #
1420
1477
  # @param coupon_id [String] Coupon ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-10off+.
1421
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1478
+ # @param params [Hash] Optional query string parameters:
1479
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1422
1480
  #
1423
1481
  # @return [Resources::Coupon] A coupon.
1424
1482
  # @example
@@ -1438,11 +1496,12 @@ module Recurly
1438
1496
 
1439
1497
  # Update an active coupon
1440
1498
  #
1441
- # {https://developers.recurly.com/api/v2019-10-10#operation/update_coupon update_coupon api documentation}
1499
+ # {https://developers.recurly.com/api/v2021-02-25#operation/update_coupon update_coupon api documenation}
1442
1500
  #
1443
1501
  # @param coupon_id [String] Coupon ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-10off+.
1444
1502
  # @param body [Requests::CouponUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponUpdate}
1445
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1503
+ # @param params [Hash] Optional query string parameters:
1504
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1446
1505
  #
1447
1506
  # @return [Resources::Coupon] The updated coupon.
1448
1507
  # @example
@@ -1465,10 +1524,11 @@ module Recurly
1465
1524
 
1466
1525
  # Expire a coupon
1467
1526
  #
1468
- # {https://developers.recurly.com/api/v2019-10-10#operation/deactivate_coupon deactivate_coupon api documentation}
1527
+ # {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_coupon deactivate_coupon api documenation}
1469
1528
  #
1470
1529
  # @param coupon_id [String] Coupon ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-10off+.
1471
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1530
+ # @param params [Hash] Optional query string parameters:
1531
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1472
1532
  #
1473
1533
  # @return [Resources::Coupon] The expired Coupon
1474
1534
  # @example
@@ -1486,26 +1546,32 @@ module Recurly
1486
1546
  delete(path, **options)
1487
1547
  end
1488
1548
 
1549
+ # Generate unique coupon codes
1550
+ #
1551
+ # {https://developers.recurly.com/api/v2021-02-25#operation/generate_unique_coupon_codes generate_unique_coupon_codes api documenation}
1552
+ #
1553
+ # @param coupon_id [String] Coupon ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-10off+.
1554
+ # @param body [Requests::CouponBulkCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponBulkCreate}
1555
+ # @param params [Hash] Optional query string parameters:
1556
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1557
+ #
1558
+ # @return [Resources::UniqueCouponCodeParams] A set of parameters that can be passed to the `list_unique_coupon_codes` endpoint to obtain only the newly generated `UniqueCouponCodes`.
1559
+ #
1560
+ def generate_unique_coupon_codes(coupon_id:, body:, **options)
1561
+ path = interpolate_path("/coupons/{coupon_id}/generate", coupon_id: coupon_id)
1562
+ post(path, body, Requests::CouponBulkCreate, **options)
1563
+ end
1564
+
1489
1565
  # Restore an inactive coupon
1490
1566
  #
1491
- # {https://developers.recurly.com/api/v2019-10-10#operation/restore_coupon restore_coupon api documentation}
1567
+ # {https://developers.recurly.com/api/v2021-02-25#operation/restore_coupon restore_coupon api documenation}
1492
1568
  #
1493
1569
  # @param coupon_id [String] Coupon ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-10off+.
1494
1570
  # @param body [Requests::CouponUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponUpdate}
1495
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1571
+ # @param params [Hash] Optional query string parameters:
1572
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1496
1573
  #
1497
1574
  # @return [Resources::Coupon] The restored coupon.
1498
- # @example
1499
- # begin
1500
- # coupon = @client.restore_coupon(coupon_id: coupon_id, body: {
1501
- # name: "New Coupon Name"
1502
- # })
1503
- # puts "Restored coupon #{coupon}"
1504
- # rescue Recurly::Errors::NotFoundError
1505
- # # If the resource was not found, you may want to alert the user or
1506
- # # just return nil
1507
- # puts "Resource Not Found"
1508
- # end
1509
1575
  #
1510
1576
  def restore_coupon(coupon_id:, body:, **options)
1511
1577
  path = interpolate_path("/coupons/{coupon_id}/restore", coupon_id: coupon_id)
@@ -1514,10 +1580,11 @@ module Recurly
1514
1580
 
1515
1581
  # List unique coupon codes associated with a bulk coupon
1516
1582
  #
1517
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_unique_coupon_codes list_unique_coupon_codes api documentation}
1583
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_unique_coupon_codes list_unique_coupon_codes api documenation}
1518
1584
  #
1519
1585
  # @param coupon_id [String] Coupon ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-10off+.
1520
- # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
1586
+ # @param params [Hash] Optional query string parameters:
1587
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
1521
1588
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
1522
1589
  #
1523
1590
  # *Important notes:*
@@ -1529,19 +1596,19 @@ module Recurly
1529
1596
  # * Records are returned in an arbitrary order. Since results are all
1530
1597
  # returned at once you can sort the records yourself.
1531
1598
  #
1532
- # @param limit [Integer] Limit number of records 1-200.
1533
- # @param order [String] Sort order.
1534
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
1599
+ # :limit [Integer] Limit number of records 1-200.
1600
+ # :order [String] Sort order.
1601
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
1535
1602
  # order. In descending order updated records will move behind the cursor and could
1536
1603
  # prevent some records from being returned.
1537
1604
  #
1538
- # @param begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
1605
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
1539
1606
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1540
1607
  #
1541
- # @param end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
1608
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
1542
1609
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1543
1610
  #
1544
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1611
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1545
1612
  #
1546
1613
  # @return [Pager<Resources::UniqueCouponCode>] A list of unique coupon codes that were generated
1547
1614
  #
@@ -1552,25 +1619,29 @@ module Recurly
1552
1619
 
1553
1620
  # List a site's credit payments
1554
1621
  #
1555
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_credit_payments list_credit_payments api documentation}
1622
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_credit_payments list_credit_payments api documenation}
1556
1623
  #
1557
- # @param limit [Integer] Limit number of records 1-200.
1558
- # @param order [String] Sort order.
1559
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
1624
+ # @param params [Hash] Optional query string parameters:
1625
+ # :limit [Integer] Limit number of records 1-200.
1626
+ # :order [String] Sort order.
1627
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
1560
1628
  # order. In descending order updated records will move behind the cursor and could
1561
1629
  # prevent some records from being returned.
1562
1630
  #
1563
- # @param begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
1631
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
1564
1632
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1565
1633
  #
1566
- # @param end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
1634
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
1567
1635
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1568
1636
  #
1569
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1637
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1570
1638
  #
1571
1639
  # @return [Pager<Resources::CreditPayment>] A list of the site's credit payments.
1572
1640
  # @example
1573
- # payments = @client.list_credit_payments(limit: 200)
1641
+ # params = {
1642
+ # limit: 200
1643
+ # }
1644
+ # payments = @client.list_credit_payments(params: params)
1574
1645
  # payments.each do |payment|
1575
1646
  # puts "CreditPayment: #{payment.id}"
1576
1647
  # end
@@ -1582,10 +1653,11 @@ module Recurly
1582
1653
 
1583
1654
  # Fetch a credit payment
1584
1655
  #
1585
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_credit_payment get_credit_payment api documentation}
1656
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_credit_payment get_credit_payment api documenation}
1586
1657
  #
1587
1658
  # @param credit_payment_id [String] Credit Payment ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
1588
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1659
+ # @param params [Hash] Optional query string parameters:
1660
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1589
1661
  #
1590
1662
  # @return [Resources::CreditPayment] A credit payment.
1591
1663
  #
@@ -1596,9 +1668,10 @@ module Recurly
1596
1668
 
1597
1669
  # List a site's custom field definitions
1598
1670
  #
1599
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_custom_field_definitions list_custom_field_definitions api documentation}
1671
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_custom_field_definitions list_custom_field_definitions api documenation}
1600
1672
  #
1601
- # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
1673
+ # @param params [Hash] Optional query string parameters:
1674
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
1602
1675
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
1603
1676
  #
1604
1677
  # *Important notes:*
@@ -1610,24 +1683,27 @@ module Recurly
1610
1683
  # * Records are returned in an arbitrary order. Since results are all
1611
1684
  # returned at once you can sort the records yourself.
1612
1685
  #
1613
- # @param limit [Integer] Limit number of records 1-200.
1614
- # @param order [String] Sort order.
1615
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
1686
+ # :limit [Integer] Limit number of records 1-200.
1687
+ # :order [String] Sort order.
1688
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
1616
1689
  # order. In descending order updated records will move behind the cursor and could
1617
1690
  # prevent some records from being returned.
1618
1691
  #
1619
- # @param begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
1692
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
1620
1693
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1621
1694
  #
1622
- # @param end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
1695
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
1623
1696
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1624
1697
  #
1625
- # @param related_type [String] Filter by related type.
1626
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1698
+ # :related_type [String] Filter by related type.
1699
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1627
1700
  #
1628
1701
  # @return [Pager<Resources::CustomFieldDefinition>] A list of the site's custom field definitions.
1629
1702
  # @example
1630
- # custom_fields = @client.list_custom_field_definitions(limit: 200)
1703
+ # params = {
1704
+ # limit: 200
1705
+ # }
1706
+ # custom_fields = @client.list_custom_field_definitions(params: params)
1631
1707
  # custom_fields.each do |field|
1632
1708
  # puts "CustomFieldDefinition: #{field.name}"
1633
1709
  # end
@@ -1639,10 +1715,11 @@ module Recurly
1639
1715
 
1640
1716
  # Fetch an custom field definition
1641
1717
  #
1642
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_custom_field_definition get_custom_field_definition api documentation}
1718
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_custom_field_definition get_custom_field_definition api documenation}
1643
1719
  #
1644
1720
  # @param custom_field_definition_id [String] Custom Field Definition ID
1645
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1721
+ # @param params [Hash] Optional query string parameters:
1722
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1646
1723
  #
1647
1724
  # @return [Resources::CustomFieldDefinition] An custom field definition.
1648
1725
  # @example
@@ -1664,9 +1741,10 @@ module Recurly
1664
1741
 
1665
1742
  # List a site's items
1666
1743
  #
1667
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_items list_items api documentation}
1744
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_items list_items api documenation}
1668
1745
  #
1669
- # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
1746
+ # @param params [Hash] Optional query string parameters:
1747
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
1670
1748
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
1671
1749
  #
1672
1750
  # *Important notes:*
@@ -1678,24 +1756,27 @@ module Recurly
1678
1756
  # * Records are returned in an arbitrary order. Since results are all
1679
1757
  # returned at once you can sort the records yourself.
1680
1758
  #
1681
- # @param limit [Integer] Limit number of records 1-200.
1682
- # @param order [String] Sort order.
1683
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
1759
+ # :limit [Integer] Limit number of records 1-200.
1760
+ # :order [String] Sort order.
1761
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
1684
1762
  # order. In descending order updated records will move behind the cursor and could
1685
1763
  # prevent some records from being returned.
1686
1764
  #
1687
- # @param begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
1765
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
1688
1766
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1689
1767
  #
1690
- # @param end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
1768
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
1691
1769
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1692
1770
  #
1693
- # @param state [String] Filter by state.
1694
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1771
+ # :state [String] Filter by state.
1772
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1695
1773
  #
1696
1774
  # @return [Pager<Resources::Item>] A list of the site's items.
1697
1775
  # @example
1698
- # items = @client.list_items(limit: 200)
1776
+ # params = {
1777
+ # limit: 200
1778
+ # }
1779
+ # items = @client.list_items(params: params)
1699
1780
  # items.each do |item|
1700
1781
  # puts "Item: #{item.code}"
1701
1782
  # end
@@ -1707,10 +1788,11 @@ module Recurly
1707
1788
 
1708
1789
  # Create a new item
1709
1790
  #
1710
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_item create_item api documentation}
1791
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_item create_item api documenation}
1711
1792
  #
1712
1793
  # @param body [Requests::ItemCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ItemCreate}
1713
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1794
+ # @param params [Hash] Optional query string parameters:
1795
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1714
1796
  #
1715
1797
  # @return [Resources::Item] A new item.
1716
1798
  # @example
@@ -1742,10 +1824,11 @@ module Recurly
1742
1824
 
1743
1825
  # Fetch an item
1744
1826
  #
1745
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_item get_item api documentation}
1827
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_item get_item api documenation}
1746
1828
  #
1747
1829
  # @param item_id [String] Item ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-red+.
1748
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1830
+ # @param params [Hash] Optional query string parameters:
1831
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1749
1832
  #
1750
1833
  # @return [Resources::Item] An item.
1751
1834
  # @example
@@ -1765,11 +1848,12 @@ module Recurly
1765
1848
 
1766
1849
  # Update an active item
1767
1850
  #
1768
- # {https://developers.recurly.com/api/v2019-10-10#operation/update_item update_item api documentation}
1851
+ # {https://developers.recurly.com/api/v2021-02-25#operation/update_item update_item api documenation}
1769
1852
  #
1770
1853
  # @param item_id [String] Item ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-red+.
1771
1854
  # @param body [Requests::ItemUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ItemUpdate}
1772
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1855
+ # @param params [Hash] Optional query string parameters:
1856
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1773
1857
  #
1774
1858
  # @return [Resources::Item] The updated item.
1775
1859
  # @example
@@ -1796,10 +1880,11 @@ module Recurly
1796
1880
 
1797
1881
  # Deactivate an item
1798
1882
  #
1799
- # {https://developers.recurly.com/api/v2019-10-10#operation/deactivate_item deactivate_item api documentation}
1883
+ # {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_item deactivate_item api documenation}
1800
1884
  #
1801
1885
  # @param item_id [String] Item ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-red+.
1802
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1886
+ # @param params [Hash] Optional query string parameters:
1887
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1803
1888
  #
1804
1889
  # @return [Resources::Item] An item.
1805
1890
  # @example
@@ -1819,10 +1904,11 @@ module Recurly
1819
1904
 
1820
1905
  # Reactivate an inactive item
1821
1906
  #
1822
- # {https://developers.recurly.com/api/v2019-10-10#operation/reactivate_item reactivate_item api documentation}
1907
+ # {https://developers.recurly.com/api/v2021-02-25#operation/reactivate_item reactivate_item api documenation}
1823
1908
  #
1824
1909
  # @param item_id [String] Item ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-red+.
1825
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1910
+ # @param params [Hash] Optional query string parameters:
1911
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1826
1912
  #
1827
1913
  # @return [Resources::Item] An item.
1828
1914
  # @example
@@ -1842,9 +1928,10 @@ module Recurly
1842
1928
 
1843
1929
  # List a site's measured units
1844
1930
  #
1845
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_measured_unit list_measured_unit api documentation}
1931
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_measured_unit list_measured_unit api documenation}
1846
1932
  #
1847
- # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
1933
+ # @param params [Hash] Optional query string parameters:
1934
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
1848
1935
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
1849
1936
  #
1850
1937
  # *Important notes:*
@@ -1856,20 +1943,20 @@ module Recurly
1856
1943
  # * Records are returned in an arbitrary order. Since results are all
1857
1944
  # returned at once you can sort the records yourself.
1858
1945
  #
1859
- # @param limit [Integer] Limit number of records 1-200.
1860
- # @param order [String] Sort order.
1861
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
1946
+ # :limit [Integer] Limit number of records 1-200.
1947
+ # :order [String] Sort order.
1948
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
1862
1949
  # order. In descending order updated records will move behind the cursor and could
1863
1950
  # prevent some records from being returned.
1864
1951
  #
1865
- # @param begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
1952
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
1866
1953
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1867
1954
  #
1868
- # @param end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
1955
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
1869
1956
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1870
1957
  #
1871
- # @param state [String] Filter by state.
1872
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1958
+ # :state [String] Filter by state.
1959
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1873
1960
  #
1874
1961
  # @return [Pager<Resources::MeasuredUnit>] A list of the site's measured units.
1875
1962
  #
@@ -1880,10 +1967,11 @@ module Recurly
1880
1967
 
1881
1968
  # Create a new measured unit
1882
1969
  #
1883
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_measured_unit create_measured_unit api documentation}
1970
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_measured_unit create_measured_unit api documenation}
1884
1971
  #
1885
1972
  # @param body [Requests::MeasuredUnitCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::MeasuredUnitCreate}
1886
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1973
+ # @param params [Hash] Optional query string parameters:
1974
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1887
1975
  #
1888
1976
  # @return [Resources::MeasuredUnit] A new measured unit.
1889
1977
  #
@@ -1894,10 +1982,11 @@ module Recurly
1894
1982
 
1895
1983
  # Fetch a measured unit
1896
1984
  #
1897
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_measured_unit get_measured_unit api documentation}
1985
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_measured_unit get_measured_unit api documenation}
1898
1986
  #
1899
1987
  # @param measured_unit_id [String] Measured unit ID or name. For ID no prefix is used e.g. +e28zov4fw0v2+. For name use prefix +name-+, e.g. +name-Storage+.
1900
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1988
+ # @param params [Hash] Optional query string parameters:
1989
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1901
1990
  #
1902
1991
  # @return [Resources::MeasuredUnit] An item.
1903
1992
  #
@@ -1908,11 +1997,12 @@ module Recurly
1908
1997
 
1909
1998
  # Update a measured unit
1910
1999
  #
1911
- # {https://developers.recurly.com/api/v2019-10-10#operation/update_measured_unit update_measured_unit api documentation}
2000
+ # {https://developers.recurly.com/api/v2021-02-25#operation/update_measured_unit update_measured_unit api documenation}
1912
2001
  #
1913
2002
  # @param measured_unit_id [String] Measured unit ID or name. For ID no prefix is used e.g. +e28zov4fw0v2+. For name use prefix +name-+, e.g. +name-Storage+.
1914
2003
  # @param body [Requests::MeasuredUnitUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::MeasuredUnitUpdate}
1915
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2004
+ # @param params [Hash] Optional query string parameters:
2005
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1916
2006
  #
1917
2007
  # @return [Resources::MeasuredUnit] The updated measured_unit.
1918
2008
  #
@@ -1923,10 +2013,11 @@ module Recurly
1923
2013
 
1924
2014
  # Remove a measured unit
1925
2015
  #
1926
- # {https://developers.recurly.com/api/v2019-10-10#operation/remove_measured_unit remove_measured_unit api documentation}
2016
+ # {https://developers.recurly.com/api/v2021-02-25#operation/remove_measured_unit remove_measured_unit api documenation}
1927
2017
  #
1928
2018
  # @param measured_unit_id [String] Measured unit ID or name. For ID no prefix is used e.g. +e28zov4fw0v2+. For name use prefix +name-+, e.g. +name-Storage+.
1929
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2019
+ # @param params [Hash] Optional query string parameters:
2020
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1930
2021
  #
1931
2022
  # @return [Resources::MeasuredUnit] A measured unit.
1932
2023
  #
@@ -1937,9 +2028,10 @@ module Recurly
1937
2028
 
1938
2029
  # List a site's invoices
1939
2030
  #
1940
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_invoices list_invoices api documentation}
2031
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_invoices list_invoices api documenation}
1941
2032
  #
1942
- # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
2033
+ # @param params [Hash] Optional query string parameters:
2034
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
1943
2035
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
1944
2036
  #
1945
2037
  # *Important notes:*
@@ -1951,29 +2043,32 @@ module Recurly
1951
2043
  # * Records are returned in an arbitrary order. Since results are all
1952
2044
  # returned at once you can sort the records yourself.
1953
2045
  #
1954
- # @param limit [Integer] Limit number of records 1-200.
1955
- # @param order [String] Sort order.
1956
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
2046
+ # :limit [Integer] Limit number of records 1-200.
2047
+ # :order [String] Sort order.
2048
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
1957
2049
  # order. In descending order updated records will move behind the cursor and could
1958
2050
  # prevent some records from being returned.
1959
2051
  #
1960
- # @param begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
2052
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
1961
2053
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1962
2054
  #
1963
- # @param end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
2055
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
1964
2056
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1965
2057
  #
1966
- # @param type [String] Filter by type when:
2058
+ # :type [String] Filter by type when:
1967
2059
  # - +type=charge+, only charge invoices will be returned.
1968
2060
  # - +type=credit+, only credit invoices will be returned.
1969
2061
  # - +type=non-legacy+, only charge and credit invoices will be returned.
1970
2062
  # - +type=legacy+, only legacy invoices will be returned.
1971
2063
  #
1972
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2064
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1973
2065
  #
1974
2066
  # @return [Pager<Resources::Invoice>] A list of the site's invoices.
1975
2067
  # @example
1976
- # invoices = @client.list_invoices(limit: 200)
2068
+ # params = {
2069
+ # limit: 200
2070
+ # }
2071
+ # invoices = @client.list_invoices(params: params)
1977
2072
  # invoices.each do |invoice|
1978
2073
  # puts "Invoice: #{invoice.number}"
1979
2074
  # end
@@ -1985,10 +2080,11 @@ module Recurly
1985
2080
 
1986
2081
  # Fetch an invoice
1987
2082
  #
1988
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_invoice get_invoice api documentation}
2083
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_invoice get_invoice api documenation}
1989
2084
  #
1990
2085
  # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
1991
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2086
+ # @param params [Hash] Optional query string parameters:
2087
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1992
2088
  #
1993
2089
  # @return [Resources::Invoice] An invoice.
1994
2090
  # @example
@@ -2008,11 +2104,12 @@ module Recurly
2008
2104
 
2009
2105
  # Update an invoice
2010
2106
  #
2011
- # {https://developers.recurly.com/api/v2019-10-10#operation/put_invoice put_invoice api documentation}
2107
+ # {https://developers.recurly.com/api/v2021-02-25#operation/update_invoice update_invoice api documenation}
2012
2108
  #
2013
2109
  # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
2014
- # @param body [Requests::InvoiceUpdatable] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceUpdatable}
2015
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2110
+ # @param body [Requests::InvoiceUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceUpdate}
2111
+ # @param params [Hash] Optional query string parameters:
2112
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2016
2113
  #
2017
2114
  # @return [Resources::Invoice] An invoice.
2018
2115
  # @example
@@ -2021,7 +2118,7 @@ module Recurly
2021
2118
  # customer_notes: "New Notes",
2022
2119
  # terms_and_conditions: "New Terms and Conditions"
2023
2120
  # }
2024
- # invoice = @client.put_invoice(invoice_id: invoice_id, body: invoice_update)
2121
+ # invoice = @client.update_invoice(invoice_id: invoice_id, body: invoice_update)
2025
2122
  # puts "Updated invoice #{invoice}"
2026
2123
  # rescue Recurly::Errors::NotFoundError
2027
2124
  # # If the resource was not found, you may want to alert the user or
@@ -2029,17 +2126,18 @@ module Recurly
2029
2126
  # puts "Resource Not Found"
2030
2127
  # end
2031
2128
  #
2032
- def put_invoice(invoice_id:, body:, **options)
2129
+ def update_invoice(invoice_id:, body:, **options)
2033
2130
  path = interpolate_path("/invoices/{invoice_id}", invoice_id: invoice_id)
2034
- put(path, body, Requests::InvoiceUpdatable, **options)
2131
+ put(path, body, Requests::InvoiceUpdate, **options)
2035
2132
  end
2036
2133
 
2037
2134
  # Fetch an invoice as a PDF
2038
2135
  #
2039
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_invoice_pdf get_invoice_pdf api documentation}
2136
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_invoice_pdf get_invoice_pdf api documenation}
2040
2137
  #
2041
2138
  # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
2042
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2139
+ # @param params [Hash] Optional query string parameters:
2140
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2043
2141
  #
2044
2142
  # @return [Resources::BinaryFile] An invoice as a PDF.
2045
2143
  # @example
@@ -2062,11 +2160,12 @@ module Recurly
2062
2160
 
2063
2161
  # Collect a pending or past due, automatic invoice
2064
2162
  #
2065
- # {https://developers.recurly.com/api/v2019-10-10#operation/collect_invoice collect_invoice api documentation}
2163
+ # {https://developers.recurly.com/api/v2021-02-25#operation/collect_invoice collect_invoice api documenation}
2066
2164
  #
2067
2165
  # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
2068
- # @param body [Requests::InvoiceCollect] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceCollect}
2069
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2166
+ # @param params [Hash] Optional query string parameters:
2167
+ # :body [Requests::InvoiceCollect] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceCollect}
2168
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2070
2169
  #
2071
2170
  # @return [Resources::Invoice] The updated invoice.
2072
2171
  # @example
@@ -2086,15 +2185,16 @@ module Recurly
2086
2185
 
2087
2186
  # Mark an open invoice as failed
2088
2187
  #
2089
- # {https://developers.recurly.com/api/v2019-10-10#operation/fail_invoice fail_invoice api documentation}
2188
+ # {https://developers.recurly.com/api/v2021-02-25#operation/mark_invoice_failed mark_invoice_failed api documenation}
2090
2189
  #
2091
2190
  # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
2092
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2191
+ # @param params [Hash] Optional query string parameters:
2192
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2093
2193
  #
2094
2194
  # @return [Resources::Invoice] The updated invoice.
2095
2195
  # @example
2096
2196
  # begin
2097
- # invoice = @client.fail_invoice(invoice_id: invoice_id)
2197
+ # invoice = @client.mark_invoice_failed(invoice_id: invoice_id)
2098
2198
  # puts "Failed invoice #{invoice}"
2099
2199
  # rescue Recurly::Errors::NotFoundError
2100
2200
  # # If the resource was not found, you may want to alert the user or
@@ -2102,17 +2202,18 @@ module Recurly
2102
2202
  # puts "Resource Not Found"
2103
2203
  # end
2104
2204
  #
2105
- def fail_invoice(invoice_id:, **options)
2205
+ def mark_invoice_failed(invoice_id:, **options)
2106
2206
  path = interpolate_path("/invoices/{invoice_id}/mark_failed", invoice_id: invoice_id)
2107
2207
  put(path, **options)
2108
2208
  end
2109
2209
 
2110
2210
  # Mark an open invoice as successful
2111
2211
  #
2112
- # {https://developers.recurly.com/api/v2019-10-10#operation/mark_invoice_successful mark_invoice_successful api documentation}
2212
+ # {https://developers.recurly.com/api/v2021-02-25#operation/mark_invoice_successful mark_invoice_successful api documenation}
2113
2213
  #
2114
2214
  # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
2115
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2215
+ # @param params [Hash] Optional query string parameters:
2216
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2116
2217
  #
2117
2218
  # @return [Resources::Invoice] The updated invoice.
2118
2219
  # @example
@@ -2132,10 +2233,11 @@ module Recurly
2132
2233
 
2133
2234
  # Reopen a closed, manual invoice
2134
2235
  #
2135
- # {https://developers.recurly.com/api/v2019-10-10#operation/reopen_invoice reopen_invoice api documentation}
2236
+ # {https://developers.recurly.com/api/v2021-02-25#operation/reopen_invoice reopen_invoice api documenation}
2136
2237
  #
2137
2238
  # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
2138
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2239
+ # @param params [Hash] Optional query string parameters:
2240
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2139
2241
  #
2140
2242
  # @return [Resources::Invoice] The updated invoice.
2141
2243
  # @example
@@ -2155,10 +2257,11 @@ module Recurly
2155
2257
 
2156
2258
  # Void a credit invoice.
2157
2259
  #
2158
- # {https://developers.recurly.com/api/v2019-10-10#operation/void_invoice void_invoice api documentation}
2260
+ # {https://developers.recurly.com/api/v2021-02-25#operation/void_invoice void_invoice api documenation}
2159
2261
  #
2160
2262
  # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
2161
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2263
+ # @param params [Hash] Optional query string parameters:
2264
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2162
2265
  #
2163
2266
  # @return [Resources::Invoice] The updated invoice.
2164
2267
  # @example
@@ -2178,11 +2281,12 @@ module Recurly
2178
2281
 
2179
2282
  # Record an external payment for a manual invoices.
2180
2283
  #
2181
- # {https://developers.recurly.com/api/v2019-10-10#operation/record_external_transaction record_external_transaction api documentation}
2284
+ # {https://developers.recurly.com/api/v2021-02-25#operation/record_external_transaction record_external_transaction api documenation}
2182
2285
  #
2183
2286
  # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
2184
2287
  # @param body [Requests::ExternalTransaction] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ExternalTransaction}
2185
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2288
+ # @param params [Hash] Optional query string parameters:
2289
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2186
2290
  #
2187
2291
  # @return [Resources::Transaction] The recorded transaction.
2188
2292
  #
@@ -2193,10 +2297,11 @@ module Recurly
2193
2297
 
2194
2298
  # List an invoice's line items
2195
2299
  #
2196
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_invoice_line_items list_invoice_line_items api documentation}
2300
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_invoice_line_items list_invoice_line_items api documenation}
2197
2301
  #
2198
2302
  # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
2199
- # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
2303
+ # @param params [Hash] Optional query string parameters:
2304
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
2200
2305
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
2201
2306
  #
2202
2307
  # *Important notes:*
@@ -2208,28 +2313,31 @@ module Recurly
2208
2313
  # * Records are returned in an arbitrary order. Since results are all
2209
2314
  # returned at once you can sort the records yourself.
2210
2315
  #
2211
- # @param limit [Integer] Limit number of records 1-200.
2212
- # @param order [String] Sort order.
2213
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
2316
+ # :limit [Integer] Limit number of records 1-200.
2317
+ # :order [String] Sort order.
2318
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
2214
2319
  # order. In descending order updated records will move behind the cursor and could
2215
2320
  # prevent some records from being returned.
2216
2321
  #
2217
- # @param begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
2322
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
2218
2323
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2219
2324
  #
2220
- # @param end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
2325
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
2221
2326
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2222
2327
  #
2223
- # @param original [String] Filter by original field.
2224
- # @param state [String] Filter by state field.
2225
- # @param type [String] Filter by type field.
2226
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2328
+ # :original [String] Filter by original field.
2329
+ # :state [String] Filter by state field.
2330
+ # :type [String] Filter by type field.
2331
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2227
2332
  #
2228
2333
  # @return [Pager<Resources::LineItem>] A list of the invoice's line items.
2229
2334
  # @example
2335
+ # params = {
2336
+ # limit: 200
2337
+ # }
2230
2338
  # line_items = @client.list_invoice_line_items(
2231
2339
  # invoice_id: invoice_id,
2232
- # limit: 200
2340
+ # params: params
2233
2341
  # )
2234
2342
  # line_items.each do |line_item|
2235
2343
  # puts "Line Item: #{line_item.id}"
@@ -2242,10 +2350,11 @@ module Recurly
2242
2350
 
2243
2351
  # Show the coupon redemptions applied to an invoice
2244
2352
  #
2245
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_invoice_coupon_redemptions list_invoice_coupon_redemptions api documentation}
2353
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_invoice_coupon_redemptions list_invoice_coupon_redemptions api documenation}
2246
2354
  #
2247
2355
  # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
2248
- # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
2356
+ # @param params [Hash] Optional query string parameters:
2357
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
2249
2358
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
2250
2359
  #
2251
2360
  # *Important notes:*
@@ -2257,23 +2366,26 @@ module Recurly
2257
2366
  # * Records are returned in an arbitrary order. Since results are all
2258
2367
  # returned at once you can sort the records yourself.
2259
2368
  #
2260
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
2369
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
2261
2370
  # order. In descending order updated records will move behind the cursor and could
2262
2371
  # prevent some records from being returned.
2263
2372
  #
2264
- # @param begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
2373
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
2265
2374
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2266
2375
  #
2267
- # @param end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
2376
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
2268
2377
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2269
2378
  #
2270
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2379
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2271
2380
  #
2272
2381
  # @return [Pager<Resources::CouponRedemption>] A list of the the coupon redemptions associated with the invoice.
2273
2382
  # @example
2383
+ # params = {
2384
+ # limit: 200
2385
+ # }
2274
2386
  # coupon_redemptions = @client.list_invoice_coupon_redemptions(
2275
2387
  # invoice_id: invoice_id,
2276
- # limit: 200
2388
+ # params: params
2277
2389
  # )
2278
2390
  # coupon_redemptions.each do |redemption|
2279
2391
  # puts "CouponRedemption: #{redemption.id}"
@@ -2286,16 +2398,20 @@ module Recurly
2286
2398
 
2287
2399
  # List an invoice's related credit or charge invoices
2288
2400
  #
2289
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_related_invoices list_related_invoices api documentation}
2401
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_related_invoices list_related_invoices api documenation}
2290
2402
  #
2291
2403
  # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
2292
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2404
+ # @param params [Hash] Optional query string parameters:
2405
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2293
2406
  #
2294
2407
  # @return [Pager<Resources::Invoice>] A list of the credit or charge invoices associated with the invoice.
2295
2408
  # @example
2409
+ # params = {
2410
+ # limit: 200
2411
+ # }
2296
2412
  # invoices = @client.list_related_invoices(
2297
2413
  # invoice_id: invoice_id,
2298
- # limit: 200
2414
+ # params: params
2299
2415
  # )
2300
2416
  # invoices.each do |invoice|
2301
2417
  # puts "Invoice: #{invoice.number}"
@@ -2308,11 +2424,12 @@ module Recurly
2308
2424
 
2309
2425
  # Refund an invoice
2310
2426
  #
2311
- # {https://developers.recurly.com/api/v2019-10-10#operation/refund_invoice refund_invoice api documentation}
2427
+ # {https://developers.recurly.com/api/v2021-02-25#operation/refund_invoice refund_invoice api documenation}
2312
2428
  #
2313
2429
  # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
2314
2430
  # @param body [Requests::InvoiceRefund] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceRefund}
2315
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2431
+ # @param params [Hash] Optional query string parameters:
2432
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2316
2433
  #
2317
2434
  # @return [Resources::Invoice] Returns the new credit invoice.
2318
2435
  # @example
@@ -2339,9 +2456,10 @@ module Recurly
2339
2456
 
2340
2457
  # List a site's line items
2341
2458
  #
2342
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_line_items list_line_items api documentation}
2459
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_line_items list_line_items api documenation}
2343
2460
  #
2344
- # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
2461
+ # @param params [Hash] Optional query string parameters:
2462
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
2345
2463
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
2346
2464
  #
2347
2465
  # *Important notes:*
@@ -2353,27 +2471,30 @@ module Recurly
2353
2471
  # * Records are returned in an arbitrary order. Since results are all
2354
2472
  # returned at once you can sort the records yourself.
2355
2473
  #
2356
- # @param limit [Integer] Limit number of records 1-200.
2357
- # @param order [String] Sort order.
2358
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
2474
+ # :limit [Integer] Limit number of records 1-200.
2475
+ # :order [String] Sort order.
2476
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
2359
2477
  # order. In descending order updated records will move behind the cursor and could
2360
2478
  # prevent some records from being returned.
2361
2479
  #
2362
- # @param begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
2480
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
2363
2481
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2364
2482
  #
2365
- # @param end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
2483
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
2366
2484
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2367
2485
  #
2368
- # @param original [String] Filter by original field.
2369
- # @param state [String] Filter by state field.
2370
- # @param type [String] Filter by type field.
2371
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2486
+ # :original [String] Filter by original field.
2487
+ # :state [String] Filter by state field.
2488
+ # :type [String] Filter by type field.
2489
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2372
2490
  #
2373
2491
  # @return [Pager<Resources::LineItem>] A list of the site's line items.
2374
2492
  # @example
2375
- # line_items = @client.list_line_items(
2493
+ # params = {
2376
2494
  # limit: 200
2495
+ # }
2496
+ # line_items = @client.list_line_items(
2497
+ # params: params
2377
2498
  # )
2378
2499
  # line_items.each do |line_item|
2379
2500
  # puts "LineItem: #{line_item.id}"
@@ -2386,10 +2507,11 @@ module Recurly
2386
2507
 
2387
2508
  # Fetch a line item
2388
2509
  #
2389
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_line_item get_line_item api documentation}
2510
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_line_item get_line_item api documenation}
2390
2511
  #
2391
2512
  # @param line_item_id [String] Line Item ID.
2392
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2513
+ # @param params [Hash] Optional query string parameters:
2514
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2393
2515
  #
2394
2516
  # @return [Resources::LineItem] A line item.
2395
2517
  # @example
@@ -2409,10 +2531,11 @@ module Recurly
2409
2531
 
2410
2532
  # Delete an uninvoiced line item
2411
2533
  #
2412
- # {https://developers.recurly.com/api/v2019-10-10#operation/remove_line_item remove_line_item api documentation}
2534
+ # {https://developers.recurly.com/api/v2021-02-25#operation/remove_line_item remove_line_item api documenation}
2413
2535
  #
2414
2536
  # @param line_item_id [String] Line Item ID.
2415
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2537
+ # @param params [Hash] Optional query string parameters:
2538
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2416
2539
  #
2417
2540
  # @return [Resources::Empty] Line item deleted.
2418
2541
  # @example
@@ -2434,9 +2557,10 @@ module Recurly
2434
2557
 
2435
2558
  # List a site's plans
2436
2559
  #
2437
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_plans list_plans api documentation}
2560
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_plans list_plans api documenation}
2438
2561
  #
2439
- # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
2562
+ # @param params [Hash] Optional query string parameters:
2563
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
2440
2564
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
2441
2565
  #
2442
2566
  # *Important notes:*
@@ -2448,24 +2572,27 @@ module Recurly
2448
2572
  # * Records are returned in an arbitrary order. Since results are all
2449
2573
  # returned at once you can sort the records yourself.
2450
2574
  #
2451
- # @param limit [Integer] Limit number of records 1-200.
2452
- # @param order [String] Sort order.
2453
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
2575
+ # :limit [Integer] Limit number of records 1-200.
2576
+ # :order [String] Sort order.
2577
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
2454
2578
  # order. In descending order updated records will move behind the cursor and could
2455
2579
  # prevent some records from being returned.
2456
2580
  #
2457
- # @param begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
2581
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
2458
2582
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2459
2583
  #
2460
- # @param end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
2584
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
2461
2585
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2462
2586
  #
2463
- # @param state [String] Filter by state.
2464
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2587
+ # :state [String] Filter by state.
2588
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2465
2589
  #
2466
2590
  # @return [Pager<Resources::Plan>] A list of plans.
2467
2591
  # @example
2468
- # plans = @client.list_plans(limit: 200)
2592
+ # params = {
2593
+ # limit: 200
2594
+ # }
2595
+ # plans = @client.list_plans(params: params)
2469
2596
  # plans.each do |plan|
2470
2597
  # puts "Plan: #{plan.code}"
2471
2598
  # end
@@ -2477,10 +2604,11 @@ module Recurly
2477
2604
 
2478
2605
  # Create a plan
2479
2606
  #
2480
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_plan create_plan api documentation}
2607
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_plan create_plan api documenation}
2481
2608
  #
2482
2609
  # @param body [Requests::PlanCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PlanCreate}
2483
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2610
+ # @param params [Hash] Optional query string parameters:
2611
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2484
2612
  #
2485
2613
  # @return [Resources::Plan] A plan.
2486
2614
  # @example
@@ -2517,10 +2645,11 @@ module Recurly
2517
2645
 
2518
2646
  # Fetch a plan
2519
2647
  #
2520
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_plan get_plan api documentation}
2648
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_plan get_plan api documenation}
2521
2649
  #
2522
2650
  # @param plan_id [String] Plan ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
2523
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2651
+ # @param params [Hash] Optional query string parameters:
2652
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2524
2653
  #
2525
2654
  # @return [Resources::Plan] A plan.
2526
2655
  # @example
@@ -2540,11 +2669,12 @@ module Recurly
2540
2669
 
2541
2670
  # Update a plan
2542
2671
  #
2543
- # {https://developers.recurly.com/api/v2019-10-10#operation/update_plan update_plan api documentation}
2672
+ # {https://developers.recurly.com/api/v2021-02-25#operation/update_plan update_plan api documenation}
2544
2673
  #
2545
2674
  # @param plan_id [String] Plan ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
2546
2675
  # @param body [Requests::PlanUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PlanUpdate}
2547
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2676
+ # @param params [Hash] Optional query string parameters:
2677
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2548
2678
  #
2549
2679
  # @return [Resources::Plan] A plan.
2550
2680
  # @example
@@ -2567,10 +2697,11 @@ module Recurly
2567
2697
 
2568
2698
  # Remove a plan
2569
2699
  #
2570
- # {https://developers.recurly.com/api/v2019-10-10#operation/remove_plan remove_plan api documentation}
2700
+ # {https://developers.recurly.com/api/v2021-02-25#operation/remove_plan remove_plan api documenation}
2571
2701
  #
2572
2702
  # @param plan_id [String] Plan ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
2573
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2703
+ # @param params [Hash] Optional query string parameters:
2704
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2574
2705
  #
2575
2706
  # @return [Resources::Plan] Plan deleted
2576
2707
  # @example
@@ -2590,10 +2721,11 @@ module Recurly
2590
2721
 
2591
2722
  # List a plan's add-ons
2592
2723
  #
2593
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_plan_add_ons list_plan_add_ons api documentation}
2724
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_plan_add_ons list_plan_add_ons api documenation}
2594
2725
  #
2595
2726
  # @param plan_id [String] Plan ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
2596
- # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
2727
+ # @param params [Hash] Optional query string parameters:
2728
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
2597
2729
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
2598
2730
  #
2599
2731
  # *Important notes:*
@@ -2605,26 +2737,29 @@ module Recurly
2605
2737
  # * Records are returned in an arbitrary order. Since results are all
2606
2738
  # returned at once you can sort the records yourself.
2607
2739
  #
2608
- # @param limit [Integer] Limit number of records 1-200.
2609
- # @param order [String] Sort order.
2610
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
2740
+ # :limit [Integer] Limit number of records 1-200.
2741
+ # :order [String] Sort order.
2742
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
2611
2743
  # order. In descending order updated records will move behind the cursor and could
2612
2744
  # prevent some records from being returned.
2613
2745
  #
2614
- # @param begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
2746
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
2615
2747
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2616
2748
  #
2617
- # @param end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
2749
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
2618
2750
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2619
2751
  #
2620
- # @param state [String] Filter by state.
2621
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2752
+ # :state [String] Filter by state.
2753
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2622
2754
  #
2623
2755
  # @return [Pager<Resources::AddOn>] A list of add-ons.
2624
2756
  # @example
2757
+ # params = {
2758
+ # limit: 200
2759
+ # }
2625
2760
  # add_ons = @client.list_plan_add_ons(
2626
2761
  # plan_id: plan_id,
2627
- # limit: 200
2762
+ # params: params
2628
2763
  # )
2629
2764
  # add_ons.each do |add_on|
2630
2765
  # puts "AddOn: #{add_on.code}"
@@ -2637,11 +2772,12 @@ module Recurly
2637
2772
 
2638
2773
  # Create an add-on
2639
2774
  #
2640
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_plan_add_on create_plan_add_on api documentation}
2775
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_plan_add_on create_plan_add_on api documenation}
2641
2776
  #
2642
2777
  # @param plan_id [String] Plan ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
2643
2778
  # @param body [Requests::AddOnCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AddOnCreate}
2644
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2779
+ # @param params [Hash] Optional query string parameters:
2780
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2645
2781
  #
2646
2782
  # @return [Resources::AddOn] An add-on.
2647
2783
  # @example
@@ -2672,11 +2808,12 @@ module Recurly
2672
2808
 
2673
2809
  # Fetch a plan's add-on
2674
2810
  #
2675
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_plan_add_on get_plan_add_on api documentation}
2811
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_plan_add_on get_plan_add_on api documenation}
2676
2812
  #
2677
2813
  # @param plan_id [String] Plan ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
2678
2814
  # @param add_on_id [String] Add-on ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
2679
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2815
+ # @param params [Hash] Optional query string parameters:
2816
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2680
2817
  #
2681
2818
  # @return [Resources::AddOn] An add-on.
2682
2819
  # @example
@@ -2698,12 +2835,13 @@ module Recurly
2698
2835
 
2699
2836
  # Update an add-on
2700
2837
  #
2701
- # {https://developers.recurly.com/api/v2019-10-10#operation/update_plan_add_on update_plan_add_on api documentation}
2838
+ # {https://developers.recurly.com/api/v2021-02-25#operation/update_plan_add_on update_plan_add_on api documenation}
2702
2839
  #
2703
2840
  # @param plan_id [String] Plan ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
2704
2841
  # @param add_on_id [String] Add-on ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
2705
2842
  # @param body [Requests::AddOnUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AddOnUpdate}
2706
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2843
+ # @param params [Hash] Optional query string parameters:
2844
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2707
2845
  #
2708
2846
  # @return [Resources::AddOn] An add-on.
2709
2847
  # @example
@@ -2730,11 +2868,12 @@ module Recurly
2730
2868
 
2731
2869
  # Remove an add-on
2732
2870
  #
2733
- # {https://developers.recurly.com/api/v2019-10-10#operation/remove_plan_add_on remove_plan_add_on api documentation}
2871
+ # {https://developers.recurly.com/api/v2021-02-25#operation/remove_plan_add_on remove_plan_add_on api documenation}
2734
2872
  #
2735
2873
  # @param plan_id [String] Plan ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
2736
2874
  # @param add_on_id [String] Add-on ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
2737
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2875
+ # @param params [Hash] Optional query string parameters:
2876
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2738
2877
  #
2739
2878
  # @return [Resources::AddOn] Add-on deleted
2740
2879
  # @example
@@ -2757,9 +2896,10 @@ module Recurly
2757
2896
 
2758
2897
  # List a site's add-ons
2759
2898
  #
2760
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_add_ons list_add_ons api documentation}
2899
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_add_ons list_add_ons api documenation}
2761
2900
  #
2762
- # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
2901
+ # @param params [Hash] Optional query string parameters:
2902
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
2763
2903
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
2764
2904
  #
2765
2905
  # *Important notes:*
@@ -2771,25 +2911,28 @@ module Recurly
2771
2911
  # * Records are returned in an arbitrary order. Since results are all
2772
2912
  # returned at once you can sort the records yourself.
2773
2913
  #
2774
- # @param limit [Integer] Limit number of records 1-200.
2775
- # @param order [String] Sort order.
2776
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
2914
+ # :limit [Integer] Limit number of records 1-200.
2915
+ # :order [String] Sort order.
2916
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
2777
2917
  # order. In descending order updated records will move behind the cursor and could
2778
2918
  # prevent some records from being returned.
2779
2919
  #
2780
- # @param begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
2920
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
2781
2921
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2782
2922
  #
2783
- # @param end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
2923
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
2784
2924
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2785
2925
  #
2786
- # @param state [String] Filter by state.
2787
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2926
+ # :state [String] Filter by state.
2927
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2788
2928
  #
2789
2929
  # @return [Pager<Resources::AddOn>] A list of add-ons.
2790
2930
  # @example
2791
- # add_ons = @client.list_add_ons(
2931
+ # params = {
2792
2932
  # limit: 200
2933
+ # }
2934
+ # add_ons = @client.list_add_ons(
2935
+ # params: params
2793
2936
  # )
2794
2937
  # add_ons.each do |add_on|
2795
2938
  # puts "AddOn: #{add_on.code}"
@@ -2802,10 +2945,11 @@ module Recurly
2802
2945
 
2803
2946
  # Fetch an add-on
2804
2947
  #
2805
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_add_on get_add_on api documentation}
2948
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_add_on get_add_on api documenation}
2806
2949
  #
2807
2950
  # @param add_on_id [String] Add-on ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
2808
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2951
+ # @param params [Hash] Optional query string parameters:
2952
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2809
2953
  #
2810
2954
  # @return [Resources::AddOn] An add-on.
2811
2955
  # @example
@@ -2825,9 +2969,10 @@ module Recurly
2825
2969
 
2826
2970
  # List a site's shipping methods
2827
2971
  #
2828
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_shipping_methods list_shipping_methods api documentation}
2972
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_shipping_methods list_shipping_methods api documenation}
2829
2973
  #
2830
- # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
2974
+ # @param params [Hash] Optional query string parameters:
2975
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
2831
2976
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
2832
2977
  #
2833
2978
  # *Important notes:*
@@ -2839,24 +2984,27 @@ module Recurly
2839
2984
  # * Records are returned in an arbitrary order. Since results are all
2840
2985
  # returned at once you can sort the records yourself.
2841
2986
  #
2842
- # @param limit [Integer] Limit number of records 1-200.
2843
- # @param order [String] Sort order.
2844
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
2987
+ # :limit [Integer] Limit number of records 1-200.
2988
+ # :order [String] Sort order.
2989
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
2845
2990
  # order. In descending order updated records will move behind the cursor and could
2846
2991
  # prevent some records from being returned.
2847
2992
  #
2848
- # @param begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
2993
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
2849
2994
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2850
2995
  #
2851
- # @param end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
2996
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
2852
2997
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2853
2998
  #
2854
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2999
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2855
3000
  #
2856
3001
  # @return [Pager<Resources::ShippingMethod>] A list of the site's shipping methods.
2857
3002
  # @example
2858
- # shipping_methods = @client.list_shipping_methods(
3003
+ # params = {
2859
3004
  # limit: 200
3005
+ # }
3006
+ # shipping_methods = @client.list_shipping_methods(
3007
+ # params: params
2860
3008
  # )
2861
3009
  # shipping_methods.each do |shipping_method|
2862
3010
  # puts "Shipping Method: #{shipping_method.code}"
@@ -2869,10 +3017,11 @@ module Recurly
2869
3017
 
2870
3018
  # Create a new shipping method
2871
3019
  #
2872
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_shipping_method create_shipping_method api documentation}
3020
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_shipping_method create_shipping_method api documenation}
2873
3021
  #
2874
3022
  # @param body [Requests::ShippingMethodCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ShippingMethodCreate}
2875
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3023
+ # @param params [Hash] Optional query string parameters:
3024
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2876
3025
  #
2877
3026
  # @return [Resources::ShippingMethod] A new shipping method.
2878
3027
  #
@@ -2883,25 +3032,27 @@ module Recurly
2883
3032
 
2884
3033
  # Fetch a shipping method
2885
3034
  #
2886
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_shipping_method get_shipping_method api documentation}
3035
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_shipping_method get_shipping_method api documenation}
2887
3036
  #
2888
- # @param id [String] Shipping Method ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-usps_2-day+.
2889
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3037
+ # @param shipping_method_id [String] Shipping Method ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-usps_2-day+.
3038
+ # @param params [Hash] Optional query string parameters:
3039
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2890
3040
  #
2891
3041
  # @return [Resources::ShippingMethod] A shipping method.
2892
3042
  #
2893
- def get_shipping_method(id:, **options)
2894
- path = interpolate_path("/shipping_methods/{id}", id: id)
3043
+ def get_shipping_method(shipping_method_id:, **options)
3044
+ path = interpolate_path("/shipping_methods/{shipping_method_id}", shipping_method_id: shipping_method_id)
2895
3045
  get(path, **options)
2896
3046
  end
2897
3047
 
2898
3048
  # Update an active Shipping Method
2899
3049
  #
2900
- # {https://developers.recurly.com/api/v2019-10-10#operation/update_shipping_method update_shipping_method api documentation}
3050
+ # {https://developers.recurly.com/api/v2021-02-25#operation/update_shipping_method update_shipping_method api documenation}
2901
3051
  #
2902
3052
  # @param shipping_method_id [String] Shipping Method ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-usps_2-day+.
2903
3053
  # @param body [Requests::ShippingMethodUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ShippingMethodUpdate}
2904
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3054
+ # @param params [Hash] Optional query string parameters:
3055
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2905
3056
  #
2906
3057
  # @return [Resources::ShippingMethod] The updated shipping method.
2907
3058
  #
@@ -2912,10 +3063,11 @@ module Recurly
2912
3063
 
2913
3064
  # Deactivate a shipping method
2914
3065
  #
2915
- # {https://developers.recurly.com/api/v2019-10-10#operation/deactivate_shipping_method deactivate_shipping_method api documentation}
3066
+ # {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_shipping_method deactivate_shipping_method api documenation}
2916
3067
  #
2917
3068
  # @param shipping_method_id [String] Shipping Method ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-usps_2-day+.
2918
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3069
+ # @param params [Hash] Optional query string parameters:
3070
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2919
3071
  #
2920
3072
  # @return [Resources::ShippingMethod] A shipping method.
2921
3073
  #
@@ -2926,9 +3078,10 @@ module Recurly
2926
3078
 
2927
3079
  # List a site's subscriptions
2928
3080
  #
2929
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_subscriptions list_subscriptions api documentation}
3081
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_subscriptions list_subscriptions api documenation}
2930
3082
  #
2931
- # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
3083
+ # @param params [Hash] Optional query string parameters:
3084
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
2932
3085
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
2933
3086
  #
2934
3087
  # *Important notes:*
@@ -2940,29 +3093,32 @@ module Recurly
2940
3093
  # * Records are returned in an arbitrary order. Since results are all
2941
3094
  # returned at once you can sort the records yourself.
2942
3095
  #
2943
- # @param limit [Integer] Limit number of records 1-200.
2944
- # @param order [String] Sort order.
2945
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
3096
+ # :limit [Integer] Limit number of records 1-200.
3097
+ # :order [String] Sort order.
3098
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
2946
3099
  # order. In descending order updated records will move behind the cursor and could
2947
3100
  # prevent some records from being returned.
2948
3101
  #
2949
- # @param begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
3102
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
2950
3103
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2951
3104
  #
2952
- # @param end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
3105
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
2953
3106
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2954
3107
  #
2955
- # @param state [String] Filter by state.
3108
+ # :state [String] Filter by state.
2956
3109
  #
2957
3110
  # - When +state=active+, +state=canceled+, +state=expired+, or +state=future+, subscriptions with states that match the query and only those subscriptions will be returned.
2958
3111
  # - When +state=in_trial+, only subscriptions that have a trial_started_at date earlier than now and a trial_ends_at date later than now will be returned.
2959
3112
  # - When +state=live+, only subscriptions that are in an active, canceled, or future state or are in trial will be returned.
2960
3113
  #
2961
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3114
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2962
3115
  #
2963
3116
  # @return [Pager<Resources::Subscription>] A list of the site's subscriptions.
2964
3117
  # @example
2965
- # subscriptions = @client.list_subscriptions(limit: 200)
3118
+ # params = {
3119
+ # limit: 200
3120
+ # }
3121
+ # subscriptions = @client.list_subscriptions(params: params)
2966
3122
  # subscriptions.each do |subscription|
2967
3123
  # puts "Subscription: #{subscription.uuid}"
2968
3124
  # end
@@ -2974,10 +3130,11 @@ module Recurly
2974
3130
 
2975
3131
  # Create a new subscription
2976
3132
  #
2977
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_subscription create_subscription api documentation}
3133
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_subscription create_subscription api documenation}
2978
3134
  #
2979
3135
  # @param body [Requests::SubscriptionCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionCreate}
2980
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3136
+ # @param params [Hash] Optional query string parameters:
3137
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2981
3138
  #
2982
3139
  # @return [Resources::Subscription] A subscription.
2983
3140
  # @example
@@ -2985,7 +3142,8 @@ module Recurly
2985
3142
  # subscription_create = {
2986
3143
  # plan_code: plan_code,
2987
3144
  # currency: "USD",
2988
- # # This can be an existing account or a new account
3145
+ # # This can be an existing account or
3146
+ # # a new acocunt
2989
3147
  # account: {
2990
3148
  # code: account_code,
2991
3149
  # }
@@ -3007,10 +3165,11 @@ module Recurly
3007
3165
 
3008
3166
  # Fetch a subscription
3009
3167
  #
3010
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_subscription get_subscription api documentation}
3168
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_subscription get_subscription api documenation}
3011
3169
  #
3012
3170
  # @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
3013
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3171
+ # @param params [Hash] Optional query string parameters:
3172
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3014
3173
  #
3015
3174
  # @return [Resources::Subscription] A subscription.
3016
3175
  # @example
@@ -3030,13 +3189,14 @@ module Recurly
3030
3189
  get(path, **options)
3031
3190
  end
3032
3191
 
3033
- # Modify a subscription
3192
+ # Update a subscription
3034
3193
  #
3035
- # {https://developers.recurly.com/api/v2019-10-10#operation/modify_subscription modify_subscription api documentation}
3194
+ # {https://developers.recurly.com/api/v2021-02-25#operation/update_subscription update_subscription api documenation}
3036
3195
  #
3037
3196
  # @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
3038
3197
  # @param body [Requests::SubscriptionUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionUpdate}
3039
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3198
+ # @param params [Hash] Optional query string parameters:
3199
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3040
3200
  #
3041
3201
  # @return [Resources::Subscription] A subscription.
3042
3202
  # @example
@@ -3045,7 +3205,7 @@ module Recurly
3045
3205
  # customer_notes: "New Notes",
3046
3206
  # terms_and_conditions: "New ToC"
3047
3207
  # }
3048
- # subscription = @client.modify_subscription(
3208
+ # subscription = @client.update_subscription(
3049
3209
  # subscription_id: subscription_id,
3050
3210
  # body: subscription_update
3051
3211
  # )
@@ -3056,17 +3216,18 @@ module Recurly
3056
3216
  # puts "ValidationError: #{e.recurly_error.params}"
3057
3217
  # end
3058
3218
  #
3059
- def modify_subscription(subscription_id:, body:, **options)
3219
+ def update_subscription(subscription_id:, body:, **options)
3060
3220
  path = interpolate_path("/subscriptions/{subscription_id}", subscription_id: subscription_id)
3061
3221
  put(path, body, Requests::SubscriptionUpdate, **options)
3062
3222
  end
3063
3223
 
3064
3224
  # Terminate a subscription
3065
3225
  #
3066
- # {https://developers.recurly.com/api/v2019-10-10#operation/terminate_subscription terminate_subscription api documentation}
3226
+ # {https://developers.recurly.com/api/v2021-02-25#operation/terminate_subscription terminate_subscription api documenation}
3067
3227
  #
3068
3228
  # @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
3069
- # @param refund [String] The type of refund to perform:
3229
+ # @param params [Hash] Optional query string parameters:
3230
+ # :refund [String] The type of refund to perform:
3070
3231
  #
3071
3232
  # * +full+ - Performs a full refund of the last invoice for the current subscription term.
3072
3233
  # * +partial+ - Prorates a refund based on the amount of time remaining in the current bill cycle.
@@ -3076,8 +3237,8 @@ module Recurly
3076
3237
  #
3077
3238
  # You may also terminate a subscription with no refund and then manually refund specific invoices.
3078
3239
  #
3079
- # @param charge [Boolean] Applicable only if the subscription has usage based add-ons and unbilled usage logged for the current billing cycle. If true, current billing cycle unbilled usage is billed on the final invoice. If false, Recurly will create a negative usage record for current billing cycle usage that will zero out the final invoice line items.
3080
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3240
+ # :charge [Boolean] Applicable only if the subscription has usage based add-ons and unbilled usage logged for the current billing cycle. If true, current billing cycle unbilled usage is billed on the final invoice. If false, Recurly will create a negative usage record for current billing cycle usage that will zero out the final invoice line items.
3241
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3081
3242
  #
3082
3243
  # @return [Resources::Subscription] An expired subscription.
3083
3244
  # @example
@@ -3099,11 +3260,12 @@ module Recurly
3099
3260
 
3100
3261
  # Cancel a subscription
3101
3262
  #
3102
- # {https://developers.recurly.com/api/v2019-10-10#operation/cancel_subscription cancel_subscription api documentation}
3263
+ # {https://developers.recurly.com/api/v2021-02-25#operation/cancel_subscription cancel_subscription api documenation}
3103
3264
  #
3104
3265
  # @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
3105
- # @param body [Requests::SubscriptionCancel] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionCancel}
3106
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3266
+ # @param params [Hash] Optional query string parameters:
3267
+ # :body [Requests::SubscriptionCancel] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionCancel}
3268
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3107
3269
  #
3108
3270
  # @return [Resources::Subscription] A canceled or failed subscription.
3109
3271
  # @example
@@ -3125,10 +3287,11 @@ module Recurly
3125
3287
 
3126
3288
  # Reactivate a canceled subscription
3127
3289
  #
3128
- # {https://developers.recurly.com/api/v2019-10-10#operation/reactivate_subscription reactivate_subscription api documentation}
3290
+ # {https://developers.recurly.com/api/v2021-02-25#operation/reactivate_subscription reactivate_subscription api documenation}
3129
3291
  #
3130
3292
  # @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
3131
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3293
+ # @param params [Hash] Optional query string parameters:
3294
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3132
3295
  #
3133
3296
  # @return [Resources::Subscription] An active subscription.
3134
3297
  # @example
@@ -3150,11 +3313,12 @@ module Recurly
3150
3313
 
3151
3314
  # Pause subscription
3152
3315
  #
3153
- # {https://developers.recurly.com/api/v2019-10-10#operation/pause_subscription pause_subscription api documentation}
3316
+ # {https://developers.recurly.com/api/v2021-02-25#operation/pause_subscription pause_subscription api documenation}
3154
3317
  #
3155
3318
  # @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
3156
3319
  # @param body [Requests::SubscriptionPause] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionPause}
3157
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3320
+ # @param params [Hash] Optional query string parameters:
3321
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3158
3322
  #
3159
3323
  # @return [Resources::Subscription] A subscription.
3160
3324
  # @example
@@ -3180,10 +3344,11 @@ module Recurly
3180
3344
 
3181
3345
  # Resume subscription
3182
3346
  #
3183
- # {https://developers.recurly.com/api/v2019-10-10#operation/resume_subscription resume_subscription api documentation}
3347
+ # {https://developers.recurly.com/api/v2021-02-25#operation/resume_subscription resume_subscription api documenation}
3184
3348
  #
3185
3349
  # @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
3186
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3350
+ # @param params [Hash] Optional query string parameters:
3351
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3187
3352
  #
3188
3353
  # @return [Resources::Subscription] A subscription.
3189
3354
  # @example
@@ -3205,10 +3370,11 @@ module Recurly
3205
3370
 
3206
3371
  # Convert trial subscription
3207
3372
  #
3208
- # {https://developers.recurly.com/api/v2019-10-10#operation/convert_trial convert_trial api documentation}
3373
+ # {https://developers.recurly.com/api/v2021-02-25#operation/convert_trial convert_trial api documenation}
3209
3374
  #
3210
3375
  # @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
3211
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3376
+ # @param params [Hash] Optional query string parameters:
3377
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3212
3378
  #
3213
3379
  # @return [Resources::Subscription] A subscription.
3214
3380
  #
@@ -3217,25 +3383,13 @@ module Recurly
3217
3383
  put(path, **options)
3218
3384
  end
3219
3385
 
3220
- # Fetch a preview of a subscription's renewal invoice(s)
3221
- #
3222
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_preview_renewal get_preview_renewal api documentation}
3223
- #
3224
- # @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
3225
- #
3226
- # @return [Resources::InvoiceCollection] A preview of the subscription's renewal invoice(s).
3227
- #
3228
- def get_preview_renewal(subscription_id:)
3229
- path = interpolate_path("/subscriptions/{subscription_id}/preview_renewal", subscription_id: subscription_id)
3230
- get(path)
3231
- end
3232
-
3233
3386
  # Fetch a subscription's pending change
3234
3387
  #
3235
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_subscription_change get_subscription_change api documentation}
3388
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_subscription_change get_subscription_change api documenation}
3236
3389
  #
3237
3390
  # @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
3238
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3391
+ # @param params [Hash] Optional query string parameters:
3392
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3239
3393
  #
3240
3394
  # @return [Resources::SubscriptionChange] A subscription's pending change.
3241
3395
  # @example
@@ -3257,11 +3411,12 @@ module Recurly
3257
3411
 
3258
3412
  # Create a new subscription change
3259
3413
  #
3260
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_subscription_change create_subscription_change api documentation}
3414
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_subscription_change create_subscription_change api documenation}
3261
3415
  #
3262
3416
  # @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
3263
3417
  # @param body [Requests::SubscriptionChangeCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionChangeCreate}
3264
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3418
+ # @param params [Hash] Optional query string parameters:
3419
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3265
3420
  #
3266
3421
  # @return [Resources::SubscriptionChange] A subscription change.
3267
3422
  # @example
@@ -3288,10 +3443,11 @@ module Recurly
3288
3443
 
3289
3444
  # Delete the pending subscription change
3290
3445
  #
3291
- # {https://developers.recurly.com/api/v2019-10-10#operation/remove_subscription_change remove_subscription_change api documentation}
3446
+ # {https://developers.recurly.com/api/v2021-02-25#operation/remove_subscription_change remove_subscription_change api documenation}
3292
3447
  #
3293
3448
  # @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
3294
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3449
+ # @param params [Hash] Optional query string parameters:
3450
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3295
3451
  #
3296
3452
  # @return [Resources::Empty] Subscription change was deleted.
3297
3453
  # @example
@@ -3313,13 +3469,14 @@ module Recurly
3313
3469
 
3314
3470
  # Preview a new subscription change
3315
3471
  #
3316
- # {https://developers.recurly.com/api/v2019-10-10#operation/preview_subscription_change preview_subscription_change api documentation}
3472
+ # {https://developers.recurly.com/api/v2021-02-25#operation/preview_subscription_change preview_subscription_change api documenation}
3317
3473
  #
3318
3474
  # @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
3319
3475
  # @param body [Requests::SubscriptionChangeCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionChangeCreate}
3320
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3476
+ # @param params [Hash] Optional query string parameters:
3477
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3321
3478
  #
3322
- # @return [Resources::SubscriptionChangePreview] A subscription change.
3479
+ # @return [Resources::SubscriptionChange] A subscription change.
3323
3480
  #
3324
3481
  def preview_subscription_change(subscription_id:, body:, **options)
3325
3482
  path = interpolate_path("/subscriptions/{subscription_id}/change/preview", subscription_id: subscription_id)
@@ -3328,10 +3485,11 @@ module Recurly
3328
3485
 
3329
3486
  # List a subscription's invoices
3330
3487
  #
3331
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_subscription_invoices list_subscription_invoices api documentation}
3488
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_subscription_invoices list_subscription_invoices api documenation}
3332
3489
  #
3333
3490
  # @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
3334
- # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
3491
+ # @param params [Hash] Optional query string parameters:
3492
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
3335
3493
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
3336
3494
  #
3337
3495
  # *Important notes:*
@@ -3343,31 +3501,34 @@ module Recurly
3343
3501
  # * Records are returned in an arbitrary order. Since results are all
3344
3502
  # returned at once you can sort the records yourself.
3345
3503
  #
3346
- # @param limit [Integer] Limit number of records 1-200.
3347
- # @param order [String] Sort order.
3348
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
3504
+ # :limit [Integer] Limit number of records 1-200.
3505
+ # :order [String] Sort order.
3506
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
3349
3507
  # order. In descending order updated records will move behind the cursor and could
3350
3508
  # prevent some records from being returned.
3351
3509
  #
3352
- # @param begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
3510
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
3353
3511
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
3354
3512
  #
3355
- # @param end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
3513
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
3356
3514
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
3357
3515
  #
3358
- # @param type [String] Filter by type when:
3516
+ # :type [String] Filter by type when:
3359
3517
  # - +type=charge+, only charge invoices will be returned.
3360
3518
  # - +type=credit+, only credit invoices will be returned.
3361
3519
  # - +type=non-legacy+, only charge and credit invoices will be returned.
3362
3520
  # - +type=legacy+, only legacy invoices will be returned.
3363
3521
  #
3364
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3522
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3365
3523
  #
3366
3524
  # @return [Pager<Resources::Invoice>] A list of the subscription's invoices.
3367
3525
  # @example
3526
+ # params = {
3527
+ # limit: 200
3528
+ # }
3368
3529
  # invoices = @client.list_subscription_invoices(
3369
3530
  # subscription_id: subscription_id,
3370
- # limit: 200
3531
+ # params: params
3371
3532
  # )
3372
3533
  # invoices.each do |invoice|
3373
3534
  # puts "Invoice: #{invoice.number}"
@@ -3380,10 +3541,11 @@ module Recurly
3380
3541
 
3381
3542
  # List a subscription's line items
3382
3543
  #
3383
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_subscription_line_items list_subscription_line_items api documentation}
3544
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_subscription_line_items list_subscription_line_items api documenation}
3384
3545
  #
3385
3546
  # @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
3386
- # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
3547
+ # @param params [Hash] Optional query string parameters:
3548
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
3387
3549
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
3388
3550
  #
3389
3551
  # *Important notes:*
@@ -3395,28 +3557,31 @@ module Recurly
3395
3557
  # * Records are returned in an arbitrary order. Since results are all
3396
3558
  # returned at once you can sort the records yourself.
3397
3559
  #
3398
- # @param limit [Integer] Limit number of records 1-200.
3399
- # @param order [String] Sort order.
3400
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
3560
+ # :limit [Integer] Limit number of records 1-200.
3561
+ # :order [String] Sort order.
3562
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
3401
3563
  # order. In descending order updated records will move behind the cursor and could
3402
3564
  # prevent some records from being returned.
3403
3565
  #
3404
- # @param begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
3566
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
3405
3567
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
3406
3568
  #
3407
- # @param end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
3569
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
3408
3570
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
3409
3571
  #
3410
- # @param original [String] Filter by original field.
3411
- # @param state [String] Filter by state field.
3412
- # @param type [String] Filter by type field.
3413
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3572
+ # :original [String] Filter by original field.
3573
+ # :state [String] Filter by state field.
3574
+ # :type [String] Filter by type field.
3575
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3414
3576
  #
3415
3577
  # @return [Pager<Resources::LineItem>] A list of the subscription's line items.
3416
3578
  # @example
3579
+ # params = {
3580
+ # limit: 200
3581
+ # }
3417
3582
  # line_items = @client.list_subscription_line_items(
3418
3583
  # subscription_id: subscription_id,
3419
- # limit: 200
3584
+ # params: params
3420
3585
  # )
3421
3586
  # line_items.each do |line_item|
3422
3587
  # puts "LineItem: #{line_item.id}"
@@ -3429,10 +3594,11 @@ module Recurly
3429
3594
 
3430
3595
  # Show the coupon redemptions for a subscription
3431
3596
  #
3432
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_subscription_coupon_redemptions list_subscription_coupon_redemptions api documentation}
3597
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_subscription_coupon_redemptions list_subscription_coupon_redemptions api documenation}
3433
3598
  #
3434
3599
  # @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
3435
- # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
3600
+ # @param params [Hash] Optional query string parameters:
3601
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
3436
3602
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
3437
3603
  #
3438
3604
  # *Important notes:*
@@ -3444,23 +3610,26 @@ module Recurly
3444
3610
  # * Records are returned in an arbitrary order. Since results are all
3445
3611
  # returned at once you can sort the records yourself.
3446
3612
  #
3447
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
3613
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
3448
3614
  # order. In descending order updated records will move behind the cursor and could
3449
3615
  # prevent some records from being returned.
3450
3616
  #
3451
- # @param begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
3617
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
3452
3618
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
3453
3619
  #
3454
- # @param end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
3620
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
3455
3621
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
3456
3622
  #
3457
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3623
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3458
3624
  #
3459
3625
  # @return [Pager<Resources::CouponRedemption>] A list of the the coupon redemptions on a subscription.
3460
3626
  # @example
3627
+ # params = {
3628
+ # limit: 200
3629
+ # }
3461
3630
  # coupon_redemptions = @client.list_subscription_coupon_redemptions(
3462
3631
  # subscription_id: subscription_id,
3463
- # limit: 200
3632
+ # params: params
3464
3633
  # )
3465
3634
  # coupon_redemptions.each do |redemption|
3466
3635
  # puts "CouponRedemption: #{redemption.id}"
@@ -3473,11 +3642,12 @@ module Recurly
3473
3642
 
3474
3643
  # List a subscription add-on's usage records
3475
3644
  #
3476
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_usage list_usage api documentation}
3645
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_usage list_usage api documenation}
3477
3646
  #
3478
3647
  # @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
3479
3648
  # @param add_on_id [String] Add-on ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
3480
- # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
3649
+ # @param params [Hash] Optional query string parameters:
3650
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
3481
3651
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
3482
3652
  #
3483
3653
  # *Important notes:*
@@ -3489,20 +3659,20 @@ module Recurly
3489
3659
  # * Records are returned in an arbitrary order. Since results are all
3490
3660
  # returned at once you can sort the records yourself.
3491
3661
  #
3492
- # @param limit [Integer] Limit number of records 1-200.
3493
- # @param order [String] Sort order.
3494
- # @param sort [String] Sort field. You *really* only want to sort by +usage_timestamp+ in ascending
3662
+ # :limit [Integer] Limit number of records 1-200.
3663
+ # :order [String] Sort order.
3664
+ # :sort [String] Sort field. You *really* only want to sort by +usage_timestamp+ in ascending
3495
3665
  # order. In descending order updated records will move behind the cursor and could
3496
3666
  # prevent some records from being returned.
3497
3667
  #
3498
- # @param begin_time [DateTime] Inclusively filter by begin_time when +sort=usage_timestamp+ or +sort=recorded_timestamp+.
3668
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=usage_timestamp+ or +sort=recorded_timestamp+.
3499
3669
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
3500
3670
  #
3501
- # @param end_time [DateTime] Inclusively filter by end_time when +sort=usage_timestamp+ or +sort=recorded_timestamp+.
3671
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=usage_timestamp+ or +sort=recorded_timestamp+.
3502
3672
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
3503
3673
  #
3504
- # @param billing_status [String] Filter by usage record's billing status
3505
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3674
+ # :billing_status [String] Filter by usage record's billing status
3675
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3506
3676
  #
3507
3677
  # @return [Pager<Resources::Usage>] A list of the subscription add-on's usage records.
3508
3678
  #
@@ -3513,12 +3683,13 @@ module Recurly
3513
3683
 
3514
3684
  # Log a usage record on this subscription add-on
3515
3685
  #
3516
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_usage create_usage api documentation}
3686
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_usage create_usage api documenation}
3517
3687
  #
3518
3688
  # @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
3519
3689
  # @param add_on_id [String] Add-on ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
3520
3690
  # @param body [Requests::UsageCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::UsageCreate}
3521
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3691
+ # @param params [Hash] Optional query string parameters:
3692
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3522
3693
  #
3523
3694
  # @return [Resources::Usage] The created usage record.
3524
3695
  #
@@ -3529,10 +3700,11 @@ module Recurly
3529
3700
 
3530
3701
  # Get a usage record
3531
3702
  #
3532
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_usage get_usage api documentation}
3703
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_usage get_usage api documenation}
3533
3704
  #
3534
3705
  # @param usage_id [String] Usage Record ID.
3535
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3706
+ # @param params [Hash] Optional query string parameters:
3707
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3536
3708
  #
3537
3709
  # @return [Resources::Usage] The usage record.
3538
3710
  #
@@ -3543,11 +3715,12 @@ module Recurly
3543
3715
 
3544
3716
  # Update a usage record
3545
3717
  #
3546
- # {https://developers.recurly.com/api/v2019-10-10#operation/update_usage update_usage api documentation}
3718
+ # {https://developers.recurly.com/api/v2021-02-25#operation/update_usage update_usage api documenation}
3547
3719
  #
3548
3720
  # @param usage_id [String] Usage Record ID.
3549
3721
  # @param body [Requests::UsageCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::UsageCreate}
3550
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3722
+ # @param params [Hash] Optional query string parameters:
3723
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3551
3724
  #
3552
3725
  # @return [Resources::Usage] The updated usage record.
3553
3726
  #
@@ -3558,10 +3731,11 @@ module Recurly
3558
3731
 
3559
3732
  # Delete a usage record.
3560
3733
  #
3561
- # {https://developers.recurly.com/api/v2019-10-10#operation/remove_usage remove_usage api documentation}
3734
+ # {https://developers.recurly.com/api/v2021-02-25#operation/remove_usage remove_usage api documenation}
3562
3735
  #
3563
3736
  # @param usage_id [String] Usage Record ID.
3564
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3737
+ # @param params [Hash] Optional query string parameters:
3738
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3565
3739
  #
3566
3740
  # @return [Resources::Empty] Usage was successfully deleted.
3567
3741
  #
@@ -3572,9 +3746,10 @@ module Recurly
3572
3746
 
3573
3747
  # List a site's transactions
3574
3748
  #
3575
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_transactions list_transactions api documentation}
3749
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_transactions list_transactions api documenation}
3576
3750
  #
3577
- # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
3751
+ # @param params [Hash] Optional query string parameters:
3752
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
3578
3753
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
3579
3754
  #
3580
3755
  # *Important notes:*
@@ -3586,25 +3761,28 @@ module Recurly
3586
3761
  # * Records are returned in an arbitrary order. Since results are all
3587
3762
  # returned at once you can sort the records yourself.
3588
3763
  #
3589
- # @param limit [Integer] Limit number of records 1-200.
3590
- # @param order [String] Sort order.
3591
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
3764
+ # :limit [Integer] Limit number of records 1-200.
3765
+ # :order [String] Sort order.
3766
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
3592
3767
  # order. In descending order updated records will move behind the cursor and could
3593
3768
  # prevent some records from being returned.
3594
3769
  #
3595
- # @param begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
3770
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
3596
3771
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
3597
3772
  #
3598
- # @param end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
3773
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
3599
3774
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
3600
3775
  #
3601
- # @param type [String] Filter by type field. The value +payment+ will return both +purchase+ and +capture+ transactions.
3602
- # @param success [String] Filter by success field.
3603
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3776
+ # :type [String] Filter by type field. The value +payment+ will return both +purchase+ and +capture+ transactions.
3777
+ # :success [String] Filter by success field.
3778
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3604
3779
  #
3605
3780
  # @return [Pager<Resources::Transaction>] A list of the site's transactions.
3606
3781
  # @example
3607
- # transactions = @client.list_transactions(limit: 200)
3782
+ # params = {
3783
+ # limit: 200
3784
+ # }
3785
+ # transactions = @client.list_transactions(params: params)
3608
3786
  # transactions.each do |transaction|
3609
3787
  # puts "Transaction: #{transaction.uuid}"
3610
3788
  # end
@@ -3616,10 +3794,11 @@ module Recurly
3616
3794
 
3617
3795
  # Fetch a transaction
3618
3796
  #
3619
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_transaction get_transaction api documentation}
3797
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_transaction get_transaction api documenation}
3620
3798
  #
3621
3799
  # @param transaction_id [String] Transaction ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
3622
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3800
+ # @param params [Hash] Optional query string parameters:
3801
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3623
3802
  #
3624
3803
  # @return [Resources::Transaction] A transaction.
3625
3804
  # @example
@@ -3639,10 +3818,11 @@ module Recurly
3639
3818
 
3640
3819
  # Fetch a unique coupon code
3641
3820
  #
3642
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_unique_coupon_code get_unique_coupon_code api documentation}
3821
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_unique_coupon_code get_unique_coupon_code api documenation}
3643
3822
  #
3644
3823
  # @param unique_coupon_code_id [String] Unique Coupon Code ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-abc-8dh2-def+.
3645
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3824
+ # @param params [Hash] Optional query string parameters:
3825
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3646
3826
  #
3647
3827
  # @return [Resources::UniqueCouponCode] A unique coupon code.
3648
3828
  #
@@ -3653,10 +3833,11 @@ module Recurly
3653
3833
 
3654
3834
  # Deactivate a unique coupon code
3655
3835
  #
3656
- # {https://developers.recurly.com/api/v2019-10-10#operation/deactivate_unique_coupon_code deactivate_unique_coupon_code api documentation}
3836
+ # {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_unique_coupon_code deactivate_unique_coupon_code api documenation}
3657
3837
  #
3658
3838
  # @param unique_coupon_code_id [String] Unique Coupon Code ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-abc-8dh2-def+.
3659
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3839
+ # @param params [Hash] Optional query string parameters:
3840
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3660
3841
  #
3661
3842
  # @return [Resources::UniqueCouponCode] A unique coupon code.
3662
3843
  #
@@ -3667,10 +3848,11 @@ module Recurly
3667
3848
 
3668
3849
  # Restore a unique coupon code
3669
3850
  #
3670
- # {https://developers.recurly.com/api/v2019-10-10#operation/reactivate_unique_coupon_code reactivate_unique_coupon_code api documentation}
3851
+ # {https://developers.recurly.com/api/v2021-02-25#operation/reactivate_unique_coupon_code reactivate_unique_coupon_code api documenation}
3671
3852
  #
3672
3853
  # @param unique_coupon_code_id [String] Unique Coupon Code ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-abc-8dh2-def+.
3673
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3854
+ # @param params [Hash] Optional query string parameters:
3855
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3674
3856
  #
3675
3857
  # @return [Resources::UniqueCouponCode] A unique coupon code.
3676
3858
  #
@@ -3681,10 +3863,11 @@ module Recurly
3681
3863
 
3682
3864
  # Create a new purchase
3683
3865
  #
3684
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_purchase create_purchase api documentation}
3866
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_purchase create_purchase api documenation}
3685
3867
  #
3686
3868
  # @param body [Requests::PurchaseCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PurchaseCreate}
3687
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3869
+ # @param params [Hash] Optional query string parameters:
3870
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3688
3871
  #
3689
3872
  # @return [Resources::InvoiceCollection] Returns the new invoices
3690
3873
  # @example
@@ -3721,10 +3904,11 @@ module Recurly
3721
3904
 
3722
3905
  # Preview a new purchase
3723
3906
  #
3724
- # {https://developers.recurly.com/api/v2019-10-10#operation/preview_purchase preview_purchase api documentation}
3907
+ # {https://developers.recurly.com/api/v2021-02-25#operation/preview_purchase preview_purchase api documenation}
3725
3908
  #
3726
3909
  # @param body [Requests::PurchaseCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PurchaseCreate}
3727
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3910
+ # @param params [Hash] Optional query string parameters:
3911
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3728
3912
  #
3729
3913
  # @return [Resources::InvoiceCollection] Returns preview of the new invoices
3730
3914
  # @example
@@ -3761,9 +3945,10 @@ module Recurly
3761
3945
 
3762
3946
  # List the dates that have an available export to download.
3763
3947
  #
3764
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_export_dates get_export_dates api documentation}
3948
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_export_dates get_export_dates api documenation}
3765
3949
  #
3766
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3950
+ # @param params [Hash] Optional query string parameters:
3951
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3767
3952
  #
3768
3953
  # @return [Resources::ExportDates] Returns a list of dates.
3769
3954
  # @example
@@ -3785,10 +3970,11 @@ module Recurly
3785
3970
 
3786
3971
  # List of the export files that are available to download.
3787
3972
  #
3788
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_export_files get_export_files api documentation}
3973
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_export_files get_export_files api documenation}
3789
3974
  #
3790
3975
  # @param export_date [String] Date for which to get a list of available automated export files. Date must be in YYYY-MM-DD format.
3791
- # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3976
+ # @param params [Hash] Optional query string parameters:
3977
+ # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
3792
3978
  #
3793
3979
  # @return [Resources::ExportFiles] Returns a list of export files to download.
3794
3980
  # @example
@@ -3807,47 +3993,5 @@ module Recurly
3807
3993
  path = interpolate_path("/export_dates/{export_date}/export_files", export_date: export_date)
3808
3994
  get(path, **options)
3809
3995
  end
3810
-
3811
- # Show the dunning campaigns for a site
3812
- #
3813
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_dunning_campaigns list_dunning_campaigns api documentation}
3814
- #
3815
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
3816
- # order. In descending order updated records will move behind the cursor and could
3817
- # prevent some records from being returned.
3818
- #
3819
- #
3820
- # @return [Pager<Resources::DunningCampaign>] A list of the the dunning_campaigns on an account.
3821
- #
3822
- def list_dunning_campaigns(**options)
3823
- path = "/dunning_campaigns"
3824
- pager(path, **options)
3825
- end
3826
-
3827
- # Show the settings for a dunning campaign
3828
- #
3829
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_dunning_campaign get_dunning_campaign api documentation}
3830
- #
3831
- # @param dunning_campaign_id [String] Dunning Campaign ID, e.g. +e28zov4fw0v2+.
3832
- #
3833
- # @return [Resources::DunningCampaign] Settings for a dunning campaign.
3834
- #
3835
- def get_dunning_campaign(dunning_campaign_id:)
3836
- path = interpolate_path("/dunning_campaigns/{dunning_campaign_id}", dunning_campaign_id: dunning_campaign_id)
3837
- get(path)
3838
- end
3839
-
3840
- # Assign a dunning campaign to multiple plans
3841
- #
3842
- # {https://developers.recurly.com/api/v2019-10-10#operation/put_dunning_campaign_bulk_update put_dunning_campaign_bulk_update api documentation}
3843
- #
3844
- # @param body [Requests::DunningCampaignsBulkUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::DunningCampaignsBulkUpdate}
3845
- #
3846
- # @return [Resources::DunningCampaignsBulkUpdateResponse] A list of updated plans.
3847
- #
3848
- def put_dunning_campaign_bulk_update(body:)
3849
- path = "/dunning_campaigns/{dunning_campaign_id}/bulk_update"
3850
- put(path, body, Requests::DunningCampaignsBulkUpdate)
3851
- end
3852
3996
  end
3853
3997
  end