recurly 3.29.0 → 4.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (108) 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 +13 -0
  6. data/CHANGELOG.md +202 -380
  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 +778 -662
  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 -14
  17. data/lib/recurly/requests/account_purchase.rb +2 -14
  18. data/lib/recurly/requests/account_update.rb +0 -12
  19. data/lib/recurly/requests/add_on_create.rb +4 -4
  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 -13
  23. data/lib/recurly/requests/billing_info_create.rb +3 -47
  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 -5
  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 -10
  30. data/lib/recurly/requests/line_item_refund.rb +0 -4
  31. data/lib/recurly/requests/plan_create.rb +0 -16
  32. data/lib/recurly/requests/plan_pricing.rb +1 -5
  33. data/lib/recurly/requests/plan_update.rb +0 -12
  34. data/lib/recurly/requests/pricing.rb +0 -4
  35. data/lib/recurly/requests/purchase_create.rb +1 -1
  36. data/lib/recurly/requests/shipping_address_create.rb +1 -5
  37. data/lib/recurly/requests/shipping_address_update.rb +1 -5
  38. data/lib/recurly/requests/subscription_add_on_create.rb +8 -4
  39. data/lib/recurly/requests/subscription_add_on_tier.rb +5 -1
  40. data/lib/recurly/requests/subscription_add_on_update.rb +6 -2
  41. data/lib/recurly/requests/subscription_change_create.rb +1 -13
  42. data/lib/recurly/requests/subscription_create.rb +5 -13
  43. data/lib/recurly/requests/subscription_pause.rb +1 -1
  44. data/lib/recurly/requests/subscription_purchase.rb +2 -10
  45. data/lib/recurly/requests/subscription_update.rb +1 -5
  46. data/lib/recurly/requests/tier.rb +2 -2
  47. data/lib/recurly/requests/{plan_ramp_pricing.rb → tier_pricing.rb} +6 -2
  48. data/lib/recurly/requests/usage_create.rb +1 -1
  49. data/lib/recurly/resources/account.rb +0 -12
  50. data/lib/recurly/resources/account_balance_amount.rb +0 -8
  51. data/lib/recurly/resources/account_mini.rb +0 -4
  52. data/lib/recurly/resources/add_on.rb +1 -1
  53. data/lib/recurly/resources/add_on_pricing.rb +5 -5
  54. data/lib/recurly/resources/address.rb +1 -13
  55. data/lib/recurly/resources/address_with_name.rb +46 -0
  56. data/lib/recurly/resources/billing_info.rb +1 -5
  57. data/lib/recurly/resources/billing_info_updated_by.rb +1 -1
  58. data/lib/recurly/resources/coupon.rb +5 -17
  59. data/lib/recurly/resources/custom_field_definition.rb +1 -1
  60. data/lib/recurly/resources/invoice.rb +8 -12
  61. data/lib/recurly/resources/invoice_address.rb +1 -5
  62. data/lib/recurly/resources/line_item.rb +7 -23
  63. data/lib/recurly/resources/payment_method.rb +0 -12
  64. data/lib/recurly/resources/plan.rb +1 -17
  65. data/lib/recurly/resources/plan_pricing.rb +1 -5
  66. data/lib/recurly/resources/pricing.rb +0 -4
  67. data/lib/recurly/resources/shipping_address.rb +1 -5
  68. data/lib/recurly/resources/subscription.rb +0 -12
  69. data/lib/recurly/resources/subscription_add_on.rb +6 -2
  70. data/lib/recurly/resources/subscription_add_on_tier.rb +5 -1
  71. data/lib/recurly/resources/subscription_change.rb +0 -16
  72. data/lib/recurly/resources/tax_info.rb +3 -7
  73. data/lib/recurly/resources/tier.rb +2 -2
  74. data/lib/recurly/resources/{plan_ramp_pricing.rb → tier_pricing.rb} +6 -2
  75. data/lib/recurly/resources/transaction.rb +3 -7
  76. data/lib/recurly/resources/unique_coupon_code_params.rb +26 -0
  77. data/lib/recurly/resources/usage.rb +6 -2
  78. data/lib/recurly/version.rb +1 -1
  79. data/openapi/api.yaml +2028 -3132
  80. data/scripts/build +2 -2
  81. data/scripts/bump +11 -0
  82. data/scripts/changelog +14 -0
  83. data/scripts/format +2 -2
  84. data/scripts/prepare-release +29 -43
  85. data/scripts/release +20 -5
  86. metadata +17 -33
  87. data/.changelog_config.yaml +0 -11
  88. data/.github/workflows/ci.yml +0 -29
  89. data/.github/workflows/pr-review.yml +0 -27
  90. data/CODE_OF_CONDUCT.md +0 -130
  91. data/lib/recurly/errors/network_errors.rb +0 -10
  92. data/lib/recurly/requests/billing_info_verify.rb +0 -14
  93. data/lib/recurly/requests/dunning_campaigns_bulk_update.rb +0 -18
  94. data/lib/recurly/requests/gateway_attributes.rb +0 -14
  95. data/lib/recurly/requests/plan_ramp_interval.rb +0 -18
  96. data/lib/recurly/requests/subscription_change_billing_info_create.rb +0 -14
  97. data/lib/recurly/requests/subscription_ramp_interval.rb +0 -18
  98. data/lib/recurly/resources/dunning_campaign.rb +0 -50
  99. data/lib/recurly/resources/dunning_campaigns_bulk_update_response.rb +0 -18
  100. data/lib/recurly/resources/dunning_cycle.rb +0 -58
  101. data/lib/recurly/resources/dunning_interval.rb +0 -18
  102. data/lib/recurly/resources/gateway_attributes.rb +0 -14
  103. data/lib/recurly/resources/line_item_list.rb +0 -26
  104. data/lib/recurly/resources/plan_ramp_interval.rb +0 -18
  105. data/lib/recurly/resources/subscription_change_billing_info.rb +0 -14
  106. data/lib/recurly/resources/subscription_change_preview.rb +0 -90
  107. data/lib/recurly/resources/subscription_ramp_interval_response.rb +0 -30
  108. data/lib/recurly/resources/tax_detail.rb +0 -38
@@ -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
@@ -127,7 +137,6 @@ module Recurly
127
137
  # code: account_code,
128
138
  # first_name: "Benjamin",
129
139
  # last_name: "Du Monde",
130
- # preferred_time_zone: "America/Chicago",
131
140
  # acquisition: {
132
141
  # campaign: "podcast-marketing",
133
142
  # channel: "social_media",
@@ -165,10 +174,11 @@ module Recurly
165
174
 
166
175
  # Fetch an account
167
176
  #
168
- # {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}
169
178
  #
170
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+.
171
- # @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+.
172
182
  #
173
183
  # @return [Resources::Account] An account.
174
184
  # @example
@@ -186,13 +196,14 @@ module Recurly
186
196
  get(path, **options)
187
197
  end
188
198
 
189
- # Modify an account
199
+ # Update an account
190
200
  #
191
- # {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}
192
202
  #
193
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+.
194
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}
195
- # @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+.
196
207
  #
197
208
  # @return [Resources::Account] An account.
198
209
  # @example
@@ -219,10 +230,11 @@ module Recurly
219
230
 
220
231
  # Deactivate an account
221
232
  #
222
- # {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}
223
234
  #
224
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+.
225
- # @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+.
226
238
  #
227
239
  # @return [Resources::Account] An account.
228
240
  # @example
@@ -242,10 +254,11 @@ module Recurly
242
254
 
243
255
  # Fetch an account's acquisition data
244
256
  #
245
- # {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}
246
258
  #
247
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+.
248
- # @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+.
249
262
  #
250
263
  # @return [Resources::AccountAcquisition] An account's acquisition data.
251
264
  # @example
@@ -265,11 +278,12 @@ module Recurly
265
278
 
266
279
  # Update an account's acquisition data
267
280
  #
268
- # {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}
269
282
  #
270
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+.
271
- # @param body [Requests::AccountAcquisitionUpdatable] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AccountAcquisitionUpdatable}
272
- # @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+.
273
287
  #
274
288
  # @return [Resources::AccountAcquisition] An account's updated acquisition data.
275
289
  # @example
@@ -296,15 +310,16 @@ module Recurly
296
310
  #
297
311
  def update_account_acquisition(account_id:, body:, **options)
298
312
  path = interpolate_path("/accounts/{account_id}/acquisition", account_id: account_id)
299
- put(path, body, Requests::AccountAcquisitionUpdatable, **options)
313
+ put(path, body, Requests::AccountAcquisitionUpdate, **options)
300
314
  end
301
315
 
302
316
  # Remove an account's acquisition data
303
317
  #
304
- # {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}
305
319
  #
306
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+.
307
- # @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+.
308
323
  #
309
324
  # @return [Resources::Empty] Acquisition data was succesfully deleted.
310
325
  # @example
@@ -324,10 +339,11 @@ module Recurly
324
339
 
325
340
  # Reactivate an inactive account
326
341
  #
327
- # {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}
328
343
  #
329
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+.
330
- # @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+.
331
347
  #
332
348
  # @return [Resources::Account] An account.
333
349
  # @example
@@ -347,10 +363,11 @@ module Recurly
347
363
 
348
364
  # Fetch an account's balance and past due status
349
365
  #
350
- # {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}
351
367
  #
352
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+.
353
- # @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+.
354
371
  #
355
372
  # @return [Resources::AccountBalance] An account's balance.
356
373
  # @example
@@ -370,10 +387,11 @@ module Recurly
370
387
 
371
388
  # Fetch an account's billing information
372
389
  #
373
- # {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}
374
391
  #
375
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+.
376
- # @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+.
377
395
  #
378
396
  # @return [Resources::BillingInfo] An account's billing information.
379
397
  # @example
@@ -393,11 +411,12 @@ module Recurly
393
411
 
394
412
  # Set an account's billing information
395
413
  #
396
- # {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}
397
415
  #
398
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+.
399
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}
400
- # @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+.
401
420
  #
402
421
  # @return [Resources::BillingInfo] Updated billing information.
403
422
  # @example
@@ -424,10 +443,11 @@ module Recurly
424
443
 
425
444
  # Remove an account's billing information
426
445
  #
427
- # {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}
428
447
  #
429
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+.
430
- # @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+.
431
451
  #
432
452
  # @return [Resources::Empty] Billing information deleted
433
453
  # @example
@@ -445,36 +465,13 @@ module Recurly
445
465
  delete(path, **options)
446
466
  end
447
467
 
448
- # Verify an account's credit card billing information
449
- #
450
- # {https://developers.recurly.com/api/v2019-10-10#operation/verify_billing_info verify_billing_info api documentation}
451
- #
452
- # @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+.
453
- # @param body [Requests::BillingInfoVerify] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoVerify}
454
- # @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+.
455
- #
456
- # @return [Resources::Transaction] Transaction information from verify.
457
- # @example
458
- # begin
459
- # transaction = @client.verify_billing_info(account_id: account_id)
460
- # puts "Got Transaction #{transaction}"
461
- # rescue Recurly::Errors::NotFoundError
462
- # # If the resource was not found, you may want to alert the user or
463
- # # just return nil
464
- # puts "Resource Not Found"
465
- # end
466
- #
467
- def verify_billing_info(account_id:, **options)
468
- path = interpolate_path("/accounts/{account_id}/billing_info/verify", account_id: account_id)
469
- post(path, options[:body], Requests::BillingInfoVerify, **options)
470
- end
471
-
472
468
  # Get the list of billing information associated with an account
473
469
  #
474
- # {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}
475
471
  #
476
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+.
477
- # @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
478
475
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
479
476
  #
480
477
  # *Important notes:*
@@ -486,17 +483,17 @@ module Recurly
486
483
  # * Records are returned in an arbitrary order. Since results are all
487
484
  # returned at once you can sort the records yourself.
488
485
  #
489
- # @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
490
487
  # order. In descending order updated records will move behind the cursor and could
491
488
  # prevent some records from being returned.
492
489
  #
493
- # @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+.
494
491
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
495
492
  #
496
- # @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+.
497
494
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
498
495
  #
499
- # @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+.
500
497
  #
501
498
  # @return [Pager<Resources::BillingInfo>] A list of the the billing information for an account's
502
499
  #
@@ -505,13 +502,14 @@ module Recurly
505
502
  pager(path, **options)
506
503
  end
507
504
 
508
- # Add new billing information on an account
505
+ # Set an account's billing information when the wallet feature is enabled
509
506
  #
510
- # {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}
511
508
  #
512
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+.
513
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}
514
- # @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+.
515
513
  #
516
514
  # @return [Resources::BillingInfo] Updated billing information.
517
515
  #
@@ -522,11 +520,12 @@ module Recurly
522
520
 
523
521
  # Fetch a billing info
524
522
  #
525
- # {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}
526
524
  #
527
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+.
528
- # @param billing_info_id [String] Billing Info ID. Can ONLY be used for sites utilizing the Wallet feature.
529
- # @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+.
530
529
  #
531
530
  # @return [Resources::BillingInfo] A billing info.
532
531
  #
@@ -537,12 +536,13 @@ module Recurly
537
536
 
538
537
  # Update an account's billing information
539
538
  #
540
- # {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}
541
540
  #
542
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+.
543
- # @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.
544
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}
545
- # @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+.
546
546
  #
547
547
  # @return [Resources::BillingInfo] Updated billing information.
548
548
  #
@@ -553,11 +553,12 @@ module Recurly
553
553
 
554
554
  # Remove an account's billing information
555
555
  #
556
- # {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}
557
557
  #
558
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+.
559
- # @param billing_info_id [String] Billing Info ID. Can ONLY be used for sites utilizing the Wallet feature.
560
- # @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+.
561
562
  #
562
563
  # @return [Resources::Empty] Billing information deleted
563
564
  #
@@ -566,12 +567,13 @@ module Recurly
566
567
  delete(path, **options)
567
568
  end
568
569
 
569
- # List the coupon redemptions for an account
570
+ # Show the coupon redemptions for an account
570
571
  #
571
- # {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}
572
573
  #
573
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+.
574
- # @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
575
577
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
576
578
  #
577
579
  # *Important notes:*
@@ -583,24 +585,27 @@ module Recurly
583
585
  # * Records are returned in an arbitrary order. Since results are all
584
586
  # returned at once you can sort the records yourself.
585
587
  #
586
- # @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
587
589
  # order. In descending order updated records will move behind the cursor and could
588
590
  # prevent some records from being returned.
589
591
  #
590
- # @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+.
591
593
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
592
594
  #
593
- # @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+.
594
596
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
595
597
  #
596
- # @param state [String] Filter by state.
597
- # @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+.
598
600
  #
599
601
  # @return [Pager<Resources::CouponRedemption>] A list of the the coupon redemptions on an account.
600
602
  # @example
603
+ # params = {
604
+ # limit: 200
605
+ # }
601
606
  # redemptions = @client.list_account_coupon_redemptions(
602
607
  # account_id: account_id,
603
- # limit: 200
608
+ # params: params
604
609
  # )
605
610
  # redemptions.each do |redemption|
606
611
  # puts "CouponRedemption: #{redemption.id}"
@@ -611,36 +616,37 @@ module Recurly
611
616
  pager(path, **options)
612
617
  end
613
618
 
614
- # Fetch the coupon redemption that is active on an account
619
+ # Show the coupon redemptions that are active on an account
615
620
  #
616
- # {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}
617
622
  #
618
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+.
619
- # @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+.
620
626
  #
621
- # @return [Resources::CouponRedemption] An active coupon redemption on an account.
627
+ # @return [Pager<Resources::CouponRedemption>] Active coupon redemptions on an account.
622
628
  # @example
623
- # begin
624
- # redemption = @client.get_active_coupon_redemption(account_id: account_id)
625
- # puts "Got CouponRedemption #{redemption}"
626
- # rescue Recurly::Errors::NotFoundError
627
- # # If the resource was not found, you may want to alert the user or
628
- # # just return nil
629
- # 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}"
630
635
  # end
631
636
  #
632
- def get_active_coupon_redemption(account_id:, **options)
637
+ def list_active_coupon_redemptions(account_id:, **options)
633
638
  path = interpolate_path("/accounts/{account_id}/coupon_redemptions/active", account_id: account_id)
634
- get(path, **options)
639
+ pager(path, **options)
635
640
  end
636
641
 
637
642
  # Generate an active coupon redemption on an account or subscription
638
643
  #
639
- # {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}
640
645
  #
641
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+.
642
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}
643
- # @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+.
644
650
  #
645
651
  # @return [Resources::CouponRedemption] Returns the new coupon redemption.
646
652
  # @example
@@ -667,10 +673,11 @@ module Recurly
667
673
 
668
674
  # Delete the active coupon redemption from an account
669
675
  #
670
- # {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}
671
677
  #
672
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+.
673
- # @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+.
674
681
  #
675
682
  # @return [Resources::CouponRedemption] Coupon redemption deleted.
676
683
  # @example
@@ -690,28 +697,32 @@ module Recurly
690
697
 
691
698
  # List an account's credit payments
692
699
  #
693
- # {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}
694
701
  #
695
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+.
696
- # @param limit [Integer] Limit number of records 1-200.
697
- # @param order [String] Sort order.
698
- # @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
699
707
  # order. In descending order updated records will move behind the cursor and could
700
708
  # prevent some records from being returned.
701
709
  #
702
- # @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+.
703
711
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
704
712
  #
705
- # @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+.
706
714
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
707
715
  #
708
- # @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+.
709
717
  #
710
718
  # @return [Pager<Resources::CreditPayment>] A list of the account's credit payments.
711
719
  # @example
720
+ # params = {
721
+ # limit: 200
722
+ # }
712
723
  # payments = @client.list_account_credit_payments(
713
724
  # account_id: account_id,
714
- # limit: 200
725
+ # params: params
715
726
  # )
716
727
  # payments.each do |payment|
717
728
  # puts "CreditPayment: #{payment.id}"
@@ -724,10 +735,11 @@ module Recurly
724
735
 
725
736
  # List an account's invoices
726
737
  #
727
- # {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}
728
739
  #
729
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+.
730
- # @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
731
743
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
732
744
  #
733
745
  # *Important notes:*
@@ -739,32 +751,34 @@ module Recurly
739
751
  # * Records are returned in an arbitrary order. Since results are all
740
752
  # returned at once you can sort the records yourself.
741
753
  #
742
- # @param state [String] Invoice state.
743
- # @param limit [Integer] Limit number of records 1-200.
744
- # @param order [String] Sort order.
745
- # @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
746
757
  # order. In descending order updated records will move behind the cursor and could
747
758
  # prevent some records from being returned.
748
759
  #
749
- # @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+.
750
761
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
751
762
  #
752
- # @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+.
753
764
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
754
765
  #
755
- # @param type [String] Filter by type when:
766
+ # :type [String] Filter by type when:
756
767
  # - +type=charge+, only charge invoices will be returned.
757
768
  # - +type=credit+, only credit invoices will be returned.
758
769
  # - +type=non-legacy+, only charge and credit invoices will be returned.
759
770
  # - +type=legacy+, only legacy invoices will be returned.
760
771
  #
761
- # @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+.
762
773
  #
763
774
  # @return [Pager<Resources::Invoice>] A list of the account's invoices.
764
775
  # @example
776
+ # params = {
777
+ # limit: 200
778
+ # }
765
779
  # invoices = @client.list_account_invoices(
766
780
  # account_id: account_id,
767
- # limit: 200
781
+ # params: params
768
782
  # )
769
783
  # invoices.each do |invoice|
770
784
  # puts "Invoice: #{invoice.number}"
@@ -777,11 +791,12 @@ module Recurly
777
791
 
778
792
  # Create an invoice for pending line items
779
793
  #
780
- # {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}
781
795
  #
782
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+.
783
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}
784
- # @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+.
785
800
  #
786
801
  # @return [Resources::InvoiceCollection] Returns the new invoices.
787
802
  # @example
@@ -808,11 +823,12 @@ module Recurly
808
823
 
809
824
  # Preview new invoice for pending line items
810
825
  #
811
- # {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}
812
827
  #
813
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+.
814
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}
815
- # @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+.
816
832
  #
817
833
  # @return [Resources::InvoiceCollection] Returns the invoice previews.
818
834
  # @example
@@ -839,10 +855,11 @@ module Recurly
839
855
 
840
856
  # List an account's line items
841
857
  #
842
- # {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}
843
859
  #
844
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+.
845
- # @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
846
863
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
847
864
  #
848
865
  # *Important notes:*
@@ -854,28 +871,31 @@ module Recurly
854
871
  # * Records are returned in an arbitrary order. Since results are all
855
872
  # returned at once you can sort the records yourself.
856
873
  #
857
- # @param limit [Integer] Limit number of records 1-200.
858
- # @param order [String] Sort order.
859
- # @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
860
877
  # order. In descending order updated records will move behind the cursor and could
861
878
  # prevent some records from being returned.
862
879
  #
863
- # @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+.
864
881
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
865
882
  #
866
- # @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+.
867
884
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
868
885
  #
869
- # @param original [String] Filter by original field.
870
- # @param state [String] Filter by state field.
871
- # @param type [String] Filter by type field.
872
- # @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+.
873
890
  #
874
891
  # @return [Pager<Resources::LineItem>] A list of the account's line items.
875
892
  # @example
893
+ # params = {
894
+ # limit: 200
895
+ # }
876
896
  # line_items = @client.list_account_line_items(
877
897
  # account_id: account_id,
878
- # limit: 200
898
+ # params: params
879
899
  # )
880
900
  # line_items.each do |line_item|
881
901
  # puts "LineItem: #{line_item.id}"
@@ -888,11 +908,12 @@ module Recurly
888
908
 
889
909
  # Create a new line item for the account
890
910
  #
891
- # {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}
892
912
  #
893
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+.
894
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}
895
- # @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+.
896
917
  #
897
918
  # @return [Resources::LineItem] Returns the new line item.
898
919
  # @example
@@ -918,12 +939,13 @@ module Recurly
918
939
  post(path, body, Requests::LineItemCreate, **options)
919
940
  end
920
941
 
921
- # List an account's notes
942
+ # Fetch a list of an account's notes
922
943
  #
923
- # {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}
924
945
  #
925
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+.
926
- # @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
927
949
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
928
950
  #
929
951
  # *Important notes:*
@@ -935,11 +957,14 @@ module Recurly
935
957
  # * Records are returned in an arbitrary order. Since results are all
936
958
  # returned at once you can sort the records yourself.
937
959
  #
938
- # @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+.
939
961
  #
940
962
  # @return [Pager<Resources::AccountNote>] A list of an account's notes.
941
963
  # @example
942
- # 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)
943
968
  # account_notes.each do |note|
944
969
  # puts "AccountNote: #{note.message}"
945
970
  # end
@@ -951,11 +976,12 @@ module Recurly
951
976
 
952
977
  # Fetch an account note
953
978
  #
954
- # {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}
955
980
  #
956
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+.
957
982
  # @param account_note_id [String] Account Note ID.
958
- # @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+.
959
985
  #
960
986
  # @return [Resources::AccountNote] An account note.
961
987
  # @example
@@ -978,10 +1004,11 @@ module Recurly
978
1004
 
979
1005
  # Fetch a list of an account's shipping addresses
980
1006
  #
981
- # {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}
982
1008
  #
983
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+.
984
- # @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
985
1012
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
986
1013
  #
987
1014
  # *Important notes:*
@@ -993,25 +1020,28 @@ module Recurly
993
1020
  # * Records are returned in an arbitrary order. Since results are all
994
1021
  # returned at once you can sort the records yourself.
995
1022
  #
996
- # @param limit [Integer] Limit number of records 1-200.
997
- # @param order [String] Sort order.
998
- # @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
999
1026
  # order. In descending order updated records will move behind the cursor and could
1000
1027
  # prevent some records from being returned.
1001
1028
  #
1002
- # @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+.
1003
1030
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1004
1031
  #
1005
- # @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+.
1006
1033
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1007
1034
  #
1008
- # @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+.
1009
1036
  #
1010
1037
  # @return [Pager<Resources::ShippingAddress>] A list of an account's shipping addresses.
1011
1038
  # @example
1039
+ # params = {
1040
+ # limit: 200
1041
+ # }
1012
1042
  # shipping_addresses = @client.list_shipping_addresses(
1013
1043
  # account_id: account_id,
1014
- # limit: 200
1044
+ # params: params
1015
1045
  # )
1016
1046
  # shipping_addresses.each do |addr|
1017
1047
  # puts "ShippingAddress: #{addr.nickname} - #{addr.street1}"
@@ -1024,11 +1054,12 @@ module Recurly
1024
1054
 
1025
1055
  # Create a new shipping address for the account
1026
1056
  #
1027
- # {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}
1028
1058
  #
1029
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+.
1030
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}
1031
- # @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+.
1032
1063
  #
1033
1064
  # @return [Resources::ShippingAddress] Returns the new shipping address.
1034
1065
  # @example
@@ -1058,11 +1089,12 @@ module Recurly
1058
1089
 
1059
1090
  # Fetch an account's shipping address
1060
1091
  #
1061
- # {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}
1062
1093
  #
1063
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+.
1064
1095
  # @param shipping_address_id [String] Shipping Address ID.
1065
- # @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+.
1066
1098
  #
1067
1099
  # @return [Resources::ShippingAddress] A shipping address.
1068
1100
  # @example
@@ -1085,12 +1117,13 @@ module Recurly
1085
1117
 
1086
1118
  # Update an account's shipping address
1087
1119
  #
1088
- # {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}
1089
1121
  #
1090
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+.
1091
1123
  # @param shipping_address_id [String] Shipping Address ID.
1092
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}
1093
- # @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+.
1094
1127
  #
1095
1128
  # @return [Resources::ShippingAddress] The updated shipping address.
1096
1129
  # @example
@@ -1119,11 +1152,12 @@ module Recurly
1119
1152
 
1120
1153
  # Remove an account's shipping address
1121
1154
  #
1122
- # {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}
1123
1156
  #
1124
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+.
1125
1158
  # @param shipping_address_id [String] Shipping Address ID.
1126
- # @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+.
1127
1161
  #
1128
1162
  # @return [Resources::Empty] Shipping address deleted.
1129
1163
  # @example
@@ -1146,10 +1180,11 @@ module Recurly
1146
1180
 
1147
1181
  # List an account's subscriptions
1148
1182
  #
1149
- # {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}
1150
1184
  #
1151
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+.
1152
- # @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
1153
1188
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
1154
1189
  #
1155
1190
  # *Important notes:*
@@ -1161,31 +1196,34 @@ module Recurly
1161
1196
  # * Records are returned in an arbitrary order. Since results are all
1162
1197
  # returned at once you can sort the records yourself.
1163
1198
  #
1164
- # @param limit [Integer] Limit number of records 1-200.
1165
- # @param order [String] Sort order.
1166
- # @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
1167
1202
  # order. In descending order updated records will move behind the cursor and could
1168
1203
  # prevent some records from being returned.
1169
1204
  #
1170
- # @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+.
1171
1206
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1172
1207
  #
1173
- # @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+.
1174
1209
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1175
1210
  #
1176
- # @param state [String] Filter by state.
1211
+ # :state [String] Filter by state.
1177
1212
  #
1178
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.
1179
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.
1180
1215
  # - When +state=live+, only subscriptions that are in an active, canceled, or future state or are in trial will be returned.
1181
1216
  #
1182
- # @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+.
1183
1218
  #
1184
1219
  # @return [Pager<Resources::Subscription>] A list of the account's subscriptions.
1185
1220
  # @example
1221
+ # params = {
1222
+ # limit: 200
1223
+ # }
1186
1224
  # subscriptions = @client.list_account_subscriptions(
1187
1225
  # account_id: account_id,
1188
- # limit: 200
1226
+ # params: params
1189
1227
  # )
1190
1228
  # subscriptions.each do |subscription|
1191
1229
  # puts "Subscription: #{subscription.uuid}"
@@ -1198,10 +1236,11 @@ module Recurly
1198
1236
 
1199
1237
  # List an account's transactions
1200
1238
  #
1201
- # {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}
1202
1240
  #
1203
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+.
1204
- # @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
1205
1244
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
1206
1245
  #
1207
1246
  # *Important notes:*
@@ -1213,27 +1252,30 @@ module Recurly
1213
1252
  # * Records are returned in an arbitrary order. Since results are all
1214
1253
  # returned at once you can sort the records yourself.
1215
1254
  #
1216
- # @param limit [Integer] Limit number of records 1-200.
1217
- # @param order [String] Sort order.
1218
- # @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
1219
1258
  # order. In descending order updated records will move behind the cursor and could
1220
1259
  # prevent some records from being returned.
1221
1260
  #
1222
- # @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+.
1223
1262
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1224
1263
  #
1225
- # @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+.
1226
1265
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1227
1266
  #
1228
- # @param type [String] Filter by type field. The value +payment+ will return both +purchase+ and +capture+ transactions.
1229
- # @param success [String] Filter by success field.
1230
- # @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+.
1231
1270
  #
1232
1271
  # @return [Pager<Resources::Transaction>] A list of the account's transactions.
1233
1272
  # @example
1273
+ # params = {
1274
+ # limit: 200
1275
+ # }
1234
1276
  # transactions = @client.list_account_transactions(
1235
1277
  # account_id: account_id,
1236
- # limit: 200
1278
+ # params: params
1237
1279
  # )
1238
1280
  # transactions.each do |transaction|
1239
1281
  # puts "Transaction: #{transaction.uuid}"
@@ -1246,10 +1288,11 @@ module Recurly
1246
1288
 
1247
1289
  # List an account's child accounts
1248
1290
  #
1249
- # {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}
1250
1292
  #
1251
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+.
1252
- # @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
1253
1296
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
1254
1297
  #
1255
1298
  # *Important notes:*
@@ -1261,30 +1304,33 @@ module Recurly
1261
1304
  # * Records are returned in an arbitrary order. Since results are all
1262
1305
  # returned at once you can sort the records yourself.
1263
1306
  #
1264
- # @param limit [Integer] Limit number of records 1-200.
1265
- # @param order [String] Sort order.
1266
- # @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
1267
1310
  # order. In descending order updated records will move behind the cursor and could
1268
1311
  # prevent some records from being returned.
1269
1312
  #
1270
- # @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+.
1271
1314
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1272
1315
  #
1273
- # @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+.
1274
1317
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1275
1318
  #
1276
- # @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.
1277
- # @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+,
1278
1321
  # +canceled+, or +future+ state.
1279
1322
  #
1280
- # @param past_due [String] Filter for accounts with an invoice in the +past_due+ state.
1281
- # @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+.
1282
1325
  #
1283
1326
  # @return [Pager<Resources::Account>] A list of an account's child accounts.
1284
1327
  # @example
1328
+ # params = {
1329
+ # limit: 200
1330
+ # }
1285
1331
  # child_accounts = @client.list_child_accounts(
1286
1332
  # account_id: account_id,
1287
- # limit: 200
1333
+ # params: params
1288
1334
  # )
1289
1335
  # child_accounts.each do |child|
1290
1336
  # puts "Account: #{child.code}"
@@ -1297,9 +1343,10 @@ module Recurly
1297
1343
 
1298
1344
  # List a site's account acquisition data
1299
1345
  #
1300
- # {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}
1301
1347
  #
1302
- # @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
1303
1350
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
1304
1351
  #
1305
1352
  # *Important notes:*
@@ -1311,23 +1358,26 @@ module Recurly
1311
1358
  # * Records are returned in an arbitrary order. Since results are all
1312
1359
  # returned at once you can sort the records yourself.
1313
1360
  #
1314
- # @param limit [Integer] Limit number of records 1-200.
1315
- # @param order [String] Sort order.
1316
- # @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
1317
1364
  # order. In descending order updated records will move behind the cursor and could
1318
1365
  # prevent some records from being returned.
1319
1366
  #
1320
- # @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+.
1321
1368
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1322
1369
  #
1323
- # @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+.
1324
1371
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1325
1372
  #
1326
- # @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+.
1327
1374
  #
1328
1375
  # @return [Pager<Resources::AccountAcquisition>] A list of the site's account acquisition data.
1329
1376
  # @example
1330
- # acquisitions = @client.list_account_acquisition(limit: 200)
1377
+ # params = {
1378
+ # limit: 200
1379
+ # }
1380
+ # acquisitions = @client.list_account_acquisition(params: params)
1331
1381
  # acquisitions.each do |acquisition|
1332
1382
  # puts "AccountAcquisition: #{acquisition.cost}"
1333
1383
  # end
@@ -1339,9 +1389,10 @@ module Recurly
1339
1389
 
1340
1390
  # List a site's coupons
1341
1391
  #
1342
- # {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}
1343
1393
  #
1344
- # @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
1345
1396
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
1346
1397
  #
1347
1398
  # *Important notes:*
@@ -1353,23 +1404,26 @@ module Recurly
1353
1404
  # * Records are returned in an arbitrary order. Since results are all
1354
1405
  # returned at once you can sort the records yourself.
1355
1406
  #
1356
- # @param limit [Integer] Limit number of records 1-200.
1357
- # @param order [String] Sort order.
1358
- # @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
1359
1410
  # order. In descending order updated records will move behind the cursor and could
1360
1411
  # prevent some records from being returned.
1361
1412
  #
1362
- # @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+.
1363
1414
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1364
1415
  #
1365
- # @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+.
1366
1417
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1367
1418
  #
1368
- # @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+.
1369
1420
  #
1370
1421
  # @return [Pager<Resources::Coupon>] A list of the site's coupons.
1371
1422
  # @example
1372
- # coupons = @client.list_coupons(limit: 200)
1423
+ # params = {
1424
+ # limit: 200
1425
+ # }
1426
+ # coupons = @client.list_coupons(params: params)
1373
1427
  # coupons.each do |coupon|
1374
1428
  # puts "coupon: #{coupon.code}"
1375
1429
  # end
@@ -1381,10 +1435,11 @@ module Recurly
1381
1435
 
1382
1436
  # Create a new coupon
1383
1437
  #
1384
- # {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}
1385
1439
  #
1386
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}
1387
- # @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+.
1388
1443
  #
1389
1444
  # @return [Resources::Coupon] A new coupon.
1390
1445
  # @example
@@ -1417,10 +1472,11 @@ module Recurly
1417
1472
 
1418
1473
  # Fetch a coupon
1419
1474
  #
1420
- # {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}
1421
1476
  #
1422
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+.
1423
- # @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+.
1424
1480
  #
1425
1481
  # @return [Resources::Coupon] A coupon.
1426
1482
  # @example
@@ -1440,11 +1496,12 @@ module Recurly
1440
1496
 
1441
1497
  # Update an active coupon
1442
1498
  #
1443
- # {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}
1444
1500
  #
1445
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+.
1446
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}
1447
- # @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+.
1448
1505
  #
1449
1506
  # @return [Resources::Coupon] The updated coupon.
1450
1507
  # @example
@@ -1467,10 +1524,11 @@ module Recurly
1467
1524
 
1468
1525
  # Expire a coupon
1469
1526
  #
1470
- # {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}
1471
1528
  #
1472
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+.
1473
- # @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+.
1474
1532
  #
1475
1533
  # @return [Resources::Coupon] The expired Coupon
1476
1534
  # @example
@@ -1488,26 +1546,32 @@ module Recurly
1488
1546
  delete(path, **options)
1489
1547
  end
1490
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
+
1491
1565
  # Restore an inactive coupon
1492
1566
  #
1493
- # {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}
1494
1568
  #
1495
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+.
1496
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}
1497
- # @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+.
1498
1573
  #
1499
1574
  # @return [Resources::Coupon] The restored coupon.
1500
- # @example
1501
- # begin
1502
- # coupon = @client.restore_coupon(coupon_id: coupon_id, body: {
1503
- # name: "New Coupon Name"
1504
- # })
1505
- # puts "Restored coupon #{coupon}"
1506
- # rescue Recurly::Errors::NotFoundError
1507
- # # If the resource was not found, you may want to alert the user or
1508
- # # just return nil
1509
- # puts "Resource Not Found"
1510
- # end
1511
1575
  #
1512
1576
  def restore_coupon(coupon_id:, body:, **options)
1513
1577
  path = interpolate_path("/coupons/{coupon_id}/restore", coupon_id: coupon_id)
@@ -1516,10 +1580,11 @@ module Recurly
1516
1580
 
1517
1581
  # List unique coupon codes associated with a bulk coupon
1518
1582
  #
1519
- # {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}
1520
1584
  #
1521
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+.
1522
- # @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
1523
1588
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
1524
1589
  #
1525
1590
  # *Important notes:*
@@ -1531,19 +1596,19 @@ module Recurly
1531
1596
  # * Records are returned in an arbitrary order. Since results are all
1532
1597
  # returned at once you can sort the records yourself.
1533
1598
  #
1534
- # @param limit [Integer] Limit number of records 1-200.
1535
- # @param order [String] Sort order.
1536
- # @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
1537
1602
  # order. In descending order updated records will move behind the cursor and could
1538
1603
  # prevent some records from being returned.
1539
1604
  #
1540
- # @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+.
1541
1606
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1542
1607
  #
1543
- # @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+.
1544
1609
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1545
1610
  #
1546
- # @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+.
1547
1612
  #
1548
1613
  # @return [Pager<Resources::UniqueCouponCode>] A list of unique coupon codes that were generated
1549
1614
  #
@@ -1554,25 +1619,29 @@ module Recurly
1554
1619
 
1555
1620
  # List a site's credit payments
1556
1621
  #
1557
- # {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}
1558
1623
  #
1559
- # @param limit [Integer] Limit number of records 1-200.
1560
- # @param order [String] Sort order.
1561
- # @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
1562
1628
  # order. In descending order updated records will move behind the cursor and could
1563
1629
  # prevent some records from being returned.
1564
1630
  #
1565
- # @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+.
1566
1632
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1567
1633
  #
1568
- # @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+.
1569
1635
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1570
1636
  #
1571
- # @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+.
1572
1638
  #
1573
1639
  # @return [Pager<Resources::CreditPayment>] A list of the site's credit payments.
1574
1640
  # @example
1575
- # payments = @client.list_credit_payments(limit: 200)
1641
+ # params = {
1642
+ # limit: 200
1643
+ # }
1644
+ # payments = @client.list_credit_payments(params: params)
1576
1645
  # payments.each do |payment|
1577
1646
  # puts "CreditPayment: #{payment.id}"
1578
1647
  # end
@@ -1584,10 +1653,11 @@ module Recurly
1584
1653
 
1585
1654
  # Fetch a credit payment
1586
1655
  #
1587
- # {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}
1588
1657
  #
1589
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+.
1590
- # @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+.
1591
1661
  #
1592
1662
  # @return [Resources::CreditPayment] A credit payment.
1593
1663
  #
@@ -1598,9 +1668,10 @@ module Recurly
1598
1668
 
1599
1669
  # List a site's custom field definitions
1600
1670
  #
1601
- # {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}
1602
1672
  #
1603
- # @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
1604
1675
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
1605
1676
  #
1606
1677
  # *Important notes:*
@@ -1612,24 +1683,27 @@ module Recurly
1612
1683
  # * Records are returned in an arbitrary order. Since results are all
1613
1684
  # returned at once you can sort the records yourself.
1614
1685
  #
1615
- # @param limit [Integer] Limit number of records 1-200.
1616
- # @param order [String] Sort order.
1617
- # @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
1618
1689
  # order. In descending order updated records will move behind the cursor and could
1619
1690
  # prevent some records from being returned.
1620
1691
  #
1621
- # @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+.
1622
1693
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1623
1694
  #
1624
- # @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+.
1625
1696
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1626
1697
  #
1627
- # @param related_type [String] Filter by related type.
1628
- # @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+.
1629
1700
  #
1630
1701
  # @return [Pager<Resources::CustomFieldDefinition>] A list of the site's custom field definitions.
1631
1702
  # @example
1632
- # 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)
1633
1707
  # custom_fields.each do |field|
1634
1708
  # puts "CustomFieldDefinition: #{field.name}"
1635
1709
  # end
@@ -1641,10 +1715,11 @@ module Recurly
1641
1715
 
1642
1716
  # Fetch an custom field definition
1643
1717
  #
1644
- # {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}
1645
1719
  #
1646
1720
  # @param custom_field_definition_id [String] Custom Field Definition ID
1647
- # @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+.
1648
1723
  #
1649
1724
  # @return [Resources::CustomFieldDefinition] An custom field definition.
1650
1725
  # @example
@@ -1666,9 +1741,10 @@ module Recurly
1666
1741
 
1667
1742
  # List a site's items
1668
1743
  #
1669
- # {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}
1670
1745
  #
1671
- # @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
1672
1748
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
1673
1749
  #
1674
1750
  # *Important notes:*
@@ -1680,24 +1756,27 @@ module Recurly
1680
1756
  # * Records are returned in an arbitrary order. Since results are all
1681
1757
  # returned at once you can sort the records yourself.
1682
1758
  #
1683
- # @param limit [Integer] Limit number of records 1-200.
1684
- # @param order [String] Sort order.
1685
- # @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
1686
1762
  # order. In descending order updated records will move behind the cursor and could
1687
1763
  # prevent some records from being returned.
1688
1764
  #
1689
- # @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+.
1690
1766
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1691
1767
  #
1692
- # @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+.
1693
1769
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1694
1770
  #
1695
- # @param state [String] Filter by state.
1696
- # @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+.
1697
1773
  #
1698
1774
  # @return [Pager<Resources::Item>] A list of the site's items.
1699
1775
  # @example
1700
- # items = @client.list_items(limit: 200)
1776
+ # params = {
1777
+ # limit: 200
1778
+ # }
1779
+ # items = @client.list_items(params: params)
1701
1780
  # items.each do |item|
1702
1781
  # puts "Item: #{item.code}"
1703
1782
  # end
@@ -1709,10 +1788,11 @@ module Recurly
1709
1788
 
1710
1789
  # Create a new item
1711
1790
  #
1712
- # {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}
1713
1792
  #
1714
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}
1715
- # @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+.
1716
1796
  #
1717
1797
  # @return [Resources::Item] A new item.
1718
1798
  # @example
@@ -1744,10 +1824,11 @@ module Recurly
1744
1824
 
1745
1825
  # Fetch an item
1746
1826
  #
1747
- # {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}
1748
1828
  #
1749
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+.
1750
- # @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+.
1751
1832
  #
1752
1833
  # @return [Resources::Item] An item.
1753
1834
  # @example
@@ -1767,11 +1848,12 @@ module Recurly
1767
1848
 
1768
1849
  # Update an active item
1769
1850
  #
1770
- # {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}
1771
1852
  #
1772
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+.
1773
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}
1774
- # @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+.
1775
1857
  #
1776
1858
  # @return [Resources::Item] The updated item.
1777
1859
  # @example
@@ -1798,10 +1880,11 @@ module Recurly
1798
1880
 
1799
1881
  # Deactivate an item
1800
1882
  #
1801
- # {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}
1802
1884
  #
1803
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+.
1804
- # @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+.
1805
1888
  #
1806
1889
  # @return [Resources::Item] An item.
1807
1890
  # @example
@@ -1821,10 +1904,11 @@ module Recurly
1821
1904
 
1822
1905
  # Reactivate an inactive item
1823
1906
  #
1824
- # {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}
1825
1908
  #
1826
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+.
1827
- # @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+.
1828
1912
  #
1829
1913
  # @return [Resources::Item] An item.
1830
1914
  # @example
@@ -1844,9 +1928,10 @@ module Recurly
1844
1928
 
1845
1929
  # List a site's measured units
1846
1930
  #
1847
- # {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}
1848
1932
  #
1849
- # @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
1850
1935
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
1851
1936
  #
1852
1937
  # *Important notes:*
@@ -1858,20 +1943,20 @@ module Recurly
1858
1943
  # * Records are returned in an arbitrary order. Since results are all
1859
1944
  # returned at once you can sort the records yourself.
1860
1945
  #
1861
- # @param limit [Integer] Limit number of records 1-200.
1862
- # @param order [String] Sort order.
1863
- # @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
1864
1949
  # order. In descending order updated records will move behind the cursor and could
1865
1950
  # prevent some records from being returned.
1866
1951
  #
1867
- # @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+.
1868
1953
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1869
1954
  #
1870
- # @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+.
1871
1956
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1872
1957
  #
1873
- # @param state [String] Filter by state.
1874
- # @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+.
1875
1960
  #
1876
1961
  # @return [Pager<Resources::MeasuredUnit>] A list of the site's measured units.
1877
1962
  #
@@ -1882,10 +1967,11 @@ module Recurly
1882
1967
 
1883
1968
  # Create a new measured unit
1884
1969
  #
1885
- # {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}
1886
1971
  #
1887
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}
1888
- # @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+.
1889
1975
  #
1890
1976
  # @return [Resources::MeasuredUnit] A new measured unit.
1891
1977
  #
@@ -1896,10 +1982,11 @@ module Recurly
1896
1982
 
1897
1983
  # Fetch a measured unit
1898
1984
  #
1899
- # {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}
1900
1986
  #
1901
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+.
1902
- # @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+.
1903
1990
  #
1904
1991
  # @return [Resources::MeasuredUnit] An item.
1905
1992
  #
@@ -1910,11 +1997,12 @@ module Recurly
1910
1997
 
1911
1998
  # Update a measured unit
1912
1999
  #
1913
- # {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}
1914
2001
  #
1915
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+.
1916
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}
1917
- # @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+.
1918
2006
  #
1919
2007
  # @return [Resources::MeasuredUnit] The updated measured_unit.
1920
2008
  #
@@ -1925,10 +2013,11 @@ module Recurly
1925
2013
 
1926
2014
  # Remove a measured unit
1927
2015
  #
1928
- # {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}
1929
2017
  #
1930
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+.
1931
- # @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+.
1932
2021
  #
1933
2022
  # @return [Resources::MeasuredUnit] A measured unit.
1934
2023
  #
@@ -1939,9 +2028,10 @@ module Recurly
1939
2028
 
1940
2029
  # List a site's invoices
1941
2030
  #
1942
- # {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}
1943
2032
  #
1944
- # @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
1945
2035
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
1946
2036
  #
1947
2037
  # *Important notes:*
@@ -1953,30 +2043,32 @@ module Recurly
1953
2043
  # * Records are returned in an arbitrary order. Since results are all
1954
2044
  # returned at once you can sort the records yourself.
1955
2045
  #
1956
- # @param state [String] Invoice state.
1957
- # @param limit [Integer] Limit number of records 1-200.
1958
- # @param order [String] Sort order.
1959
- # @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
1960
2049
  # order. In descending order updated records will move behind the cursor and could
1961
2050
  # prevent some records from being returned.
1962
2051
  #
1963
- # @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+.
1964
2053
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1965
2054
  #
1966
- # @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+.
1967
2056
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1968
2057
  #
1969
- # @param type [String] Filter by type when:
2058
+ # :type [String] Filter by type when:
1970
2059
  # - +type=charge+, only charge invoices will be returned.
1971
2060
  # - +type=credit+, only credit invoices will be returned.
1972
2061
  # - +type=non-legacy+, only charge and credit invoices will be returned.
1973
2062
  # - +type=legacy+, only legacy invoices will be returned.
1974
2063
  #
1975
- # @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+.
1976
2065
  #
1977
2066
  # @return [Pager<Resources::Invoice>] A list of the site's invoices.
1978
2067
  # @example
1979
- # invoices = @client.list_invoices(limit: 200)
2068
+ # params = {
2069
+ # limit: 200
2070
+ # }
2071
+ # invoices = @client.list_invoices(params: params)
1980
2072
  # invoices.each do |invoice|
1981
2073
  # puts "Invoice: #{invoice.number}"
1982
2074
  # end
@@ -1988,10 +2080,11 @@ module Recurly
1988
2080
 
1989
2081
  # Fetch an invoice
1990
2082
  #
1991
- # {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}
1992
2084
  #
1993
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+.
1994
- # @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+.
1995
2088
  #
1996
2089
  # @return [Resources::Invoice] An invoice.
1997
2090
  # @example
@@ -2011,11 +2104,12 @@ module Recurly
2011
2104
 
2012
2105
  # Update an invoice
2013
2106
  #
2014
- # {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}
2015
2108
  #
2016
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+.
2017
- # @param body [Requests::InvoiceUpdatable] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceUpdatable}
2018
- # @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+.
2019
2113
  #
2020
2114
  # @return [Resources::Invoice] An invoice.
2021
2115
  # @example
@@ -2024,7 +2118,7 @@ module Recurly
2024
2118
  # customer_notes: "New Notes",
2025
2119
  # terms_and_conditions: "New Terms and Conditions"
2026
2120
  # }
2027
- # invoice = @client.put_invoice(invoice_id: invoice_id, body: invoice_update)
2121
+ # invoice = @client.update_invoice(invoice_id: invoice_id, body: invoice_update)
2028
2122
  # puts "Updated invoice #{invoice}"
2029
2123
  # rescue Recurly::Errors::NotFoundError
2030
2124
  # # If the resource was not found, you may want to alert the user or
@@ -2032,17 +2126,18 @@ module Recurly
2032
2126
  # puts "Resource Not Found"
2033
2127
  # end
2034
2128
  #
2035
- def put_invoice(invoice_id:, body:, **options)
2129
+ def update_invoice(invoice_id:, body:, **options)
2036
2130
  path = interpolate_path("/invoices/{invoice_id}", invoice_id: invoice_id)
2037
- put(path, body, Requests::InvoiceUpdatable, **options)
2131
+ put(path, body, Requests::InvoiceUpdate, **options)
2038
2132
  end
2039
2133
 
2040
2134
  # Fetch an invoice as a PDF
2041
2135
  #
2042
- # {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}
2043
2137
  #
2044
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+.
2045
- # @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+.
2046
2141
  #
2047
2142
  # @return [Resources::BinaryFile] An invoice as a PDF.
2048
2143
  # @example
@@ -2063,36 +2158,14 @@ module Recurly
2063
2158
  get(path, **options)
2064
2159
  end
2065
2160
 
2066
- # Apply available credit to a pending or past due charge invoice
2067
- #
2068
- # {https://developers.recurly.com/api/v2019-10-10#operation/apply_credit_balance apply_credit_balance api documentation}
2069
- #
2070
- # @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+.
2071
- # @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+.
2072
- #
2073
- # @return [Resources::Invoice] The updated invoice.
2074
- # @example
2075
- # begin
2076
- # invoice = @client.apply_credit_balance(invoice_id: invoice_id)
2077
- # puts "Applied credit balance to invoice #{invoice}"
2078
- # rescue Recurly::Errors::NotFoundError
2079
- # # If the resource was not found, you may want to alert the user or
2080
- # # just return nil
2081
- # puts "Resource Not Found"
2082
- # end
2083
- #
2084
- def apply_credit_balance(invoice_id:, **options)
2085
- path = interpolate_path("/invoices/{invoice_id}/apply_credit_balance", invoice_id: invoice_id)
2086
- put(path, **options)
2087
- end
2088
-
2089
2161
  # Collect a pending or past due, automatic invoice
2090
2162
  #
2091
- # {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}
2092
2164
  #
2093
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+.
2094
- # @param body [Requests::InvoiceCollect] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceCollect}
2095
- # @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+.
2096
2169
  #
2097
2170
  # @return [Resources::Invoice] The updated invoice.
2098
2171
  # @example
@@ -2112,15 +2185,16 @@ module Recurly
2112
2185
 
2113
2186
  # Mark an open invoice as failed
2114
2187
  #
2115
- # {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}
2116
2189
  #
2117
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+.
2118
- # @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+.
2119
2193
  #
2120
2194
  # @return [Resources::Invoice] The updated invoice.
2121
2195
  # @example
2122
2196
  # begin
2123
- # invoice = @client.fail_invoice(invoice_id: invoice_id)
2197
+ # invoice = @client.mark_invoice_failed(invoice_id: invoice_id)
2124
2198
  # puts "Failed invoice #{invoice}"
2125
2199
  # rescue Recurly::Errors::NotFoundError
2126
2200
  # # If the resource was not found, you may want to alert the user or
@@ -2128,17 +2202,18 @@ module Recurly
2128
2202
  # puts "Resource Not Found"
2129
2203
  # end
2130
2204
  #
2131
- def fail_invoice(invoice_id:, **options)
2205
+ def mark_invoice_failed(invoice_id:, **options)
2132
2206
  path = interpolate_path("/invoices/{invoice_id}/mark_failed", invoice_id: invoice_id)
2133
2207
  put(path, **options)
2134
2208
  end
2135
2209
 
2136
2210
  # Mark an open invoice as successful
2137
2211
  #
2138
- # {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}
2139
2213
  #
2140
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+.
2141
- # @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+.
2142
2217
  #
2143
2218
  # @return [Resources::Invoice] The updated invoice.
2144
2219
  # @example
@@ -2158,10 +2233,11 @@ module Recurly
2158
2233
 
2159
2234
  # Reopen a closed, manual invoice
2160
2235
  #
2161
- # {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}
2162
2237
  #
2163
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+.
2164
- # @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+.
2165
2241
  #
2166
2242
  # @return [Resources::Invoice] The updated invoice.
2167
2243
  # @example
@@ -2181,10 +2257,11 @@ module Recurly
2181
2257
 
2182
2258
  # Void a credit invoice.
2183
2259
  #
2184
- # {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}
2185
2261
  #
2186
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+.
2187
- # @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+.
2188
2265
  #
2189
2266
  # @return [Resources::Invoice] The updated invoice.
2190
2267
  # @example
@@ -2204,11 +2281,12 @@ module Recurly
2204
2281
 
2205
2282
  # Record an external payment for a manual invoices.
2206
2283
  #
2207
- # {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}
2208
2285
  #
2209
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+.
2210
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}
2211
- # @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+.
2212
2290
  #
2213
2291
  # @return [Resources::Transaction] The recorded transaction.
2214
2292
  #
@@ -2219,10 +2297,11 @@ module Recurly
2219
2297
 
2220
2298
  # List an invoice's line items
2221
2299
  #
2222
- # {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}
2223
2301
  #
2224
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+.
2225
- # @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
2226
2305
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
2227
2306
  #
2228
2307
  # *Important notes:*
@@ -2234,28 +2313,31 @@ module Recurly
2234
2313
  # * Records are returned in an arbitrary order. Since results are all
2235
2314
  # returned at once you can sort the records yourself.
2236
2315
  #
2237
- # @param limit [Integer] Limit number of records 1-200.
2238
- # @param order [String] Sort order.
2239
- # @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
2240
2319
  # order. In descending order updated records will move behind the cursor and could
2241
2320
  # prevent some records from being returned.
2242
2321
  #
2243
- # @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+.
2244
2323
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2245
2324
  #
2246
- # @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+.
2247
2326
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2248
2327
  #
2249
- # @param original [String] Filter by original field.
2250
- # @param state [String] Filter by state field.
2251
- # @param type [String] Filter by type field.
2252
- # @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+.
2253
2332
  #
2254
2333
  # @return [Pager<Resources::LineItem>] A list of the invoice's line items.
2255
2334
  # @example
2335
+ # params = {
2336
+ # limit: 200
2337
+ # }
2256
2338
  # line_items = @client.list_invoice_line_items(
2257
2339
  # invoice_id: invoice_id,
2258
- # limit: 200
2340
+ # params: params
2259
2341
  # )
2260
2342
  # line_items.each do |line_item|
2261
2343
  # puts "Line Item: #{line_item.id}"
@@ -2266,12 +2348,13 @@ module Recurly
2266
2348
  pager(path, **options)
2267
2349
  end
2268
2350
 
2269
- # List the coupon redemptions applied to an invoice
2351
+ # Show the coupon redemptions applied to an invoice
2270
2352
  #
2271
- # {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}
2272
2354
  #
2273
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+.
2274
- # @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
2275
2358
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
2276
2359
  #
2277
2360
  # *Important notes:*
@@ -2283,23 +2366,26 @@ module Recurly
2283
2366
  # * Records are returned in an arbitrary order. Since results are all
2284
2367
  # returned at once you can sort the records yourself.
2285
2368
  #
2286
- # @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
2287
2370
  # order. In descending order updated records will move behind the cursor and could
2288
2371
  # prevent some records from being returned.
2289
2372
  #
2290
- # @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+.
2291
2374
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2292
2375
  #
2293
- # @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+.
2294
2377
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2295
2378
  #
2296
- # @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+.
2297
2380
  #
2298
2381
  # @return [Pager<Resources::CouponRedemption>] A list of the the coupon redemptions associated with the invoice.
2299
2382
  # @example
2383
+ # params = {
2384
+ # limit: 200
2385
+ # }
2300
2386
  # coupon_redemptions = @client.list_invoice_coupon_redemptions(
2301
2387
  # invoice_id: invoice_id,
2302
- # limit: 200
2388
+ # params: params
2303
2389
  # )
2304
2390
  # coupon_redemptions.each do |redemption|
2305
2391
  # puts "CouponRedemption: #{redemption.id}"
@@ -2312,16 +2398,20 @@ module Recurly
2312
2398
 
2313
2399
  # List an invoice's related credit or charge invoices
2314
2400
  #
2315
- # {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}
2316
2402
  #
2317
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+.
2318
- # @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+.
2319
2406
  #
2320
2407
  # @return [Pager<Resources::Invoice>] A list of the credit or charge invoices associated with the invoice.
2321
2408
  # @example
2409
+ # params = {
2410
+ # limit: 200
2411
+ # }
2322
2412
  # invoices = @client.list_related_invoices(
2323
2413
  # invoice_id: invoice_id,
2324
- # limit: 200
2414
+ # params: params
2325
2415
  # )
2326
2416
  # invoices.each do |invoice|
2327
2417
  # puts "Invoice: #{invoice.number}"
@@ -2334,11 +2424,12 @@ module Recurly
2334
2424
 
2335
2425
  # Refund an invoice
2336
2426
  #
2337
- # {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}
2338
2428
  #
2339
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+.
2340
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}
2341
- # @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+.
2342
2433
  #
2343
2434
  # @return [Resources::Invoice] Returns the new credit invoice.
2344
2435
  # @example
@@ -2365,9 +2456,10 @@ module Recurly
2365
2456
 
2366
2457
  # List a site's line items
2367
2458
  #
2368
- # {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}
2369
2460
  #
2370
- # @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
2371
2463
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
2372
2464
  #
2373
2465
  # *Important notes:*
@@ -2379,27 +2471,30 @@ module Recurly
2379
2471
  # * Records are returned in an arbitrary order. Since results are all
2380
2472
  # returned at once you can sort the records yourself.
2381
2473
  #
2382
- # @param limit [Integer] Limit number of records 1-200.
2383
- # @param order [String] Sort order.
2384
- # @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
2385
2477
  # order. In descending order updated records will move behind the cursor and could
2386
2478
  # prevent some records from being returned.
2387
2479
  #
2388
- # @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+.
2389
2481
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2390
2482
  #
2391
- # @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+.
2392
2484
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2393
2485
  #
2394
- # @param original [String] Filter by original field.
2395
- # @param state [String] Filter by state field.
2396
- # @param type [String] Filter by type field.
2397
- # @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+.
2398
2490
  #
2399
2491
  # @return [Pager<Resources::LineItem>] A list of the site's line items.
2400
2492
  # @example
2401
- # line_items = @client.list_line_items(
2493
+ # params = {
2402
2494
  # limit: 200
2495
+ # }
2496
+ # line_items = @client.list_line_items(
2497
+ # params: params
2403
2498
  # )
2404
2499
  # line_items.each do |line_item|
2405
2500
  # puts "LineItem: #{line_item.id}"
@@ -2412,10 +2507,11 @@ module Recurly
2412
2507
 
2413
2508
  # Fetch a line item
2414
2509
  #
2415
- # {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}
2416
2511
  #
2417
2512
  # @param line_item_id [String] Line Item ID.
2418
- # @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+.
2419
2515
  #
2420
2516
  # @return [Resources::LineItem] A line item.
2421
2517
  # @example
@@ -2435,10 +2531,11 @@ module Recurly
2435
2531
 
2436
2532
  # Delete an uninvoiced line item
2437
2533
  #
2438
- # {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}
2439
2535
  #
2440
2536
  # @param line_item_id [String] Line Item ID.
2441
- # @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+.
2442
2539
  #
2443
2540
  # @return [Resources::Empty] Line item deleted.
2444
2541
  # @example
@@ -2460,9 +2557,10 @@ module Recurly
2460
2557
 
2461
2558
  # List a site's plans
2462
2559
  #
2463
- # {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}
2464
2561
  #
2465
- # @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
2466
2564
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
2467
2565
  #
2468
2566
  # *Important notes:*
@@ -2474,24 +2572,27 @@ module Recurly
2474
2572
  # * Records are returned in an arbitrary order. Since results are all
2475
2573
  # returned at once you can sort the records yourself.
2476
2574
  #
2477
- # @param limit [Integer] Limit number of records 1-200.
2478
- # @param order [String] Sort order.
2479
- # @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
2480
2578
  # order. In descending order updated records will move behind the cursor and could
2481
2579
  # prevent some records from being returned.
2482
2580
  #
2483
- # @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+.
2484
2582
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2485
2583
  #
2486
- # @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+.
2487
2585
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2488
2586
  #
2489
- # @param state [String] Filter by state.
2490
- # @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+.
2491
2589
  #
2492
2590
  # @return [Pager<Resources::Plan>] A list of plans.
2493
2591
  # @example
2494
- # plans = @client.list_plans(limit: 200)
2592
+ # params = {
2593
+ # limit: 200
2594
+ # }
2595
+ # plans = @client.list_plans(params: params)
2495
2596
  # plans.each do |plan|
2496
2597
  # puts "Plan: #{plan.code}"
2497
2598
  # end
@@ -2503,10 +2604,11 @@ module Recurly
2503
2604
 
2504
2605
  # Create a plan
2505
2606
  #
2506
- # {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}
2507
2608
  #
2508
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}
2509
- # @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+.
2510
2612
  #
2511
2613
  # @return [Resources::Plan] A plan.
2512
2614
  # @example
@@ -2543,10 +2645,11 @@ module Recurly
2543
2645
 
2544
2646
  # Fetch a plan
2545
2647
  #
2546
- # {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}
2547
2649
  #
2548
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+.
2549
- # @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+.
2550
2653
  #
2551
2654
  # @return [Resources::Plan] A plan.
2552
2655
  # @example
@@ -2566,11 +2669,12 @@ module Recurly
2566
2669
 
2567
2670
  # Update a plan
2568
2671
  #
2569
- # {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}
2570
2673
  #
2571
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+.
2572
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}
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+.
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+.
2574
2678
  #
2575
2679
  # @return [Resources::Plan] A plan.
2576
2680
  # @example
@@ -2593,10 +2697,11 @@ module Recurly
2593
2697
 
2594
2698
  # Remove a plan
2595
2699
  #
2596
- # {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}
2597
2701
  #
2598
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+.
2599
- # @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+.
2600
2705
  #
2601
2706
  # @return [Resources::Plan] Plan deleted
2602
2707
  # @example
@@ -2616,10 +2721,11 @@ module Recurly
2616
2721
 
2617
2722
  # List a plan's add-ons
2618
2723
  #
2619
- # {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}
2620
2725
  #
2621
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+.
2622
- # @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
2623
2729
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
2624
2730
  #
2625
2731
  # *Important notes:*
@@ -2631,26 +2737,29 @@ module Recurly
2631
2737
  # * Records are returned in an arbitrary order. Since results are all
2632
2738
  # returned at once you can sort the records yourself.
2633
2739
  #
2634
- # @param limit [Integer] Limit number of records 1-200.
2635
- # @param order [String] Sort order.
2636
- # @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
2637
2743
  # order. In descending order updated records will move behind the cursor and could
2638
2744
  # prevent some records from being returned.
2639
2745
  #
2640
- # @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+.
2641
2747
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2642
2748
  #
2643
- # @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+.
2644
2750
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2645
2751
  #
2646
- # @param state [String] Filter by state.
2647
- # @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+.
2648
2754
  #
2649
2755
  # @return [Pager<Resources::AddOn>] A list of add-ons.
2650
2756
  # @example
2757
+ # params = {
2758
+ # limit: 200
2759
+ # }
2651
2760
  # add_ons = @client.list_plan_add_ons(
2652
2761
  # plan_id: plan_id,
2653
- # limit: 200
2762
+ # params: params
2654
2763
  # )
2655
2764
  # add_ons.each do |add_on|
2656
2765
  # puts "AddOn: #{add_on.code}"
@@ -2663,11 +2772,12 @@ module Recurly
2663
2772
 
2664
2773
  # Create an add-on
2665
2774
  #
2666
- # {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}
2667
2776
  #
2668
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+.
2669
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}
2670
- # @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+.
2671
2781
  #
2672
2782
  # @return [Resources::AddOn] An add-on.
2673
2783
  # @example
@@ -2698,11 +2808,12 @@ module Recurly
2698
2808
 
2699
2809
  # Fetch a plan's add-on
2700
2810
  #
2701
- # {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}
2702
2812
  #
2703
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+.
2704
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+.
2705
- # @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+.
2706
2817
  #
2707
2818
  # @return [Resources::AddOn] An add-on.
2708
2819
  # @example
@@ -2724,12 +2835,13 @@ module Recurly
2724
2835
 
2725
2836
  # Update an add-on
2726
2837
  #
2727
- # {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}
2728
2839
  #
2729
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+.
2730
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+.
2731
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}
2732
- # @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+.
2733
2845
  #
2734
2846
  # @return [Resources::AddOn] An add-on.
2735
2847
  # @example
@@ -2756,11 +2868,12 @@ module Recurly
2756
2868
 
2757
2869
  # Remove an add-on
2758
2870
  #
2759
- # {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}
2760
2872
  #
2761
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+.
2762
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+.
2763
- # @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+.
2764
2877
  #
2765
2878
  # @return [Resources::AddOn] Add-on deleted
2766
2879
  # @example
@@ -2783,9 +2896,10 @@ module Recurly
2783
2896
 
2784
2897
  # List a site's add-ons
2785
2898
  #
2786
- # {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}
2787
2900
  #
2788
- # @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
2789
2903
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
2790
2904
  #
2791
2905
  # *Important notes:*
@@ -2797,25 +2911,28 @@ module Recurly
2797
2911
  # * Records are returned in an arbitrary order. Since results are all
2798
2912
  # returned at once you can sort the records yourself.
2799
2913
  #
2800
- # @param limit [Integer] Limit number of records 1-200.
2801
- # @param order [String] Sort order.
2802
- # @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
2803
2917
  # order. In descending order updated records will move behind the cursor and could
2804
2918
  # prevent some records from being returned.
2805
2919
  #
2806
- # @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+.
2807
2921
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2808
2922
  #
2809
- # @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+.
2810
2924
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2811
2925
  #
2812
- # @param state [String] Filter by state.
2813
- # @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+.
2814
2928
  #
2815
2929
  # @return [Pager<Resources::AddOn>] A list of add-ons.
2816
2930
  # @example
2817
- # add_ons = @client.list_add_ons(
2931
+ # params = {
2818
2932
  # limit: 200
2933
+ # }
2934
+ # add_ons = @client.list_add_ons(
2935
+ # params: params
2819
2936
  # )
2820
2937
  # add_ons.each do |add_on|
2821
2938
  # puts "AddOn: #{add_on.code}"
@@ -2828,10 +2945,11 @@ module Recurly
2828
2945
 
2829
2946
  # Fetch an add-on
2830
2947
  #
2831
- # {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}
2832
2949
  #
2833
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+.
2834
- # @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+.
2835
2953
  #
2836
2954
  # @return [Resources::AddOn] An add-on.
2837
2955
  # @example
@@ -2851,9 +2969,10 @@ module Recurly
2851
2969
 
2852
2970
  # List a site's shipping methods
2853
2971
  #
2854
- # {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}
2855
2973
  #
2856
- # @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
2857
2976
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
2858
2977
  #
2859
2978
  # *Important notes:*
@@ -2865,24 +2984,27 @@ module Recurly
2865
2984
  # * Records are returned in an arbitrary order. Since results are all
2866
2985
  # returned at once you can sort the records yourself.
2867
2986
  #
2868
- # @param limit [Integer] Limit number of records 1-200.
2869
- # @param order [String] Sort order.
2870
- # @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
2871
2990
  # order. In descending order updated records will move behind the cursor and could
2872
2991
  # prevent some records from being returned.
2873
2992
  #
2874
- # @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+.
2875
2994
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2876
2995
  #
2877
- # @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+.
2878
2997
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2879
2998
  #
2880
- # @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+.
2881
3000
  #
2882
3001
  # @return [Pager<Resources::ShippingMethod>] A list of the site's shipping methods.
2883
3002
  # @example
2884
- # shipping_methods = @client.list_shipping_methods(
3003
+ # params = {
2885
3004
  # limit: 200
3005
+ # }
3006
+ # shipping_methods = @client.list_shipping_methods(
3007
+ # params: params
2886
3008
  # )
2887
3009
  # shipping_methods.each do |shipping_method|
2888
3010
  # puts "Shipping Method: #{shipping_method.code}"
@@ -2895,10 +3017,11 @@ module Recurly
2895
3017
 
2896
3018
  # Create a new shipping method
2897
3019
  #
2898
- # {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}
2899
3021
  #
2900
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}
2901
- # @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+.
2902
3025
  #
2903
3026
  # @return [Resources::ShippingMethod] A new shipping method.
2904
3027
  #
@@ -2909,25 +3032,27 @@ module Recurly
2909
3032
 
2910
3033
  # Fetch a shipping method
2911
3034
  #
2912
- # {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}
2913
3036
  #
2914
- # @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+.
2915
- # @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+.
2916
3040
  #
2917
3041
  # @return [Resources::ShippingMethod] A shipping method.
2918
3042
  #
2919
- def get_shipping_method(id:, **options)
2920
- 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)
2921
3045
  get(path, **options)
2922
3046
  end
2923
3047
 
2924
3048
  # Update an active Shipping Method
2925
3049
  #
2926
- # {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}
2927
3051
  #
2928
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+.
2929
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}
2930
- # @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+.
2931
3056
  #
2932
3057
  # @return [Resources::ShippingMethod] The updated shipping method.
2933
3058
  #
@@ -2938,10 +3063,11 @@ module Recurly
2938
3063
 
2939
3064
  # Deactivate a shipping method
2940
3065
  #
2941
- # {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}
2942
3067
  #
2943
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+.
2944
- # @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+.
2945
3071
  #
2946
3072
  # @return [Resources::ShippingMethod] A shipping method.
2947
3073
  #
@@ -2952,9 +3078,10 @@ module Recurly
2952
3078
 
2953
3079
  # List a site's subscriptions
2954
3080
  #
2955
- # {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}
2956
3082
  #
2957
- # @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
2958
3085
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
2959
3086
  #
2960
3087
  # *Important notes:*
@@ -2966,29 +3093,32 @@ module Recurly
2966
3093
  # * Records are returned in an arbitrary order. Since results are all
2967
3094
  # returned at once you can sort the records yourself.
2968
3095
  #
2969
- # @param limit [Integer] Limit number of records 1-200.
2970
- # @param order [String] Sort order.
2971
- # @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
2972
3099
  # order. In descending order updated records will move behind the cursor and could
2973
3100
  # prevent some records from being returned.
2974
3101
  #
2975
- # @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+.
2976
3103
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2977
3104
  #
2978
- # @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+.
2979
3106
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2980
3107
  #
2981
- # @param state [String] Filter by state.
3108
+ # :state [String] Filter by state.
2982
3109
  #
2983
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.
2984
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.
2985
3112
  # - When +state=live+, only subscriptions that are in an active, canceled, or future state or are in trial will be returned.
2986
3113
  #
2987
- # @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+.
2988
3115
  #
2989
3116
  # @return [Pager<Resources::Subscription>] A list of the site's subscriptions.
2990
3117
  # @example
2991
- # subscriptions = @client.list_subscriptions(limit: 200)
3118
+ # params = {
3119
+ # limit: 200
3120
+ # }
3121
+ # subscriptions = @client.list_subscriptions(params: params)
2992
3122
  # subscriptions.each do |subscription|
2993
3123
  # puts "Subscription: #{subscription.uuid}"
2994
3124
  # end
@@ -3000,10 +3130,11 @@ module Recurly
3000
3130
 
3001
3131
  # Create a new subscription
3002
3132
  #
3003
- # {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}
3004
3134
  #
3005
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}
3006
- # @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+.
3007
3138
  #
3008
3139
  # @return [Resources::Subscription] A subscription.
3009
3140
  # @example
@@ -3011,7 +3142,8 @@ module Recurly
3011
3142
  # subscription_create = {
3012
3143
  # plan_code: plan_code,
3013
3144
  # currency: "USD",
3014
- # # This can be an existing account or a new account
3145
+ # # This can be an existing account or
3146
+ # # a new acocunt
3015
3147
  # account: {
3016
3148
  # code: account_code,
3017
3149
  # }
@@ -3033,10 +3165,11 @@ module Recurly
3033
3165
 
3034
3166
  # Fetch a subscription
3035
3167
  #
3036
- # {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}
3037
3169
  #
3038
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+.
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+.
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+.
3040
3173
  #
3041
3174
  # @return [Resources::Subscription] A subscription.
3042
3175
  # @example
@@ -3056,13 +3189,14 @@ module Recurly
3056
3189
  get(path, **options)
3057
3190
  end
3058
3191
 
3059
- # Modify a subscription
3192
+ # Update a subscription
3060
3193
  #
3061
- # {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}
3062
3195
  #
3063
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+.
3064
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}
3065
- # @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+.
3066
3200
  #
3067
3201
  # @return [Resources::Subscription] A subscription.
3068
3202
  # @example
@@ -3071,7 +3205,7 @@ module Recurly
3071
3205
  # customer_notes: "New Notes",
3072
3206
  # terms_and_conditions: "New ToC"
3073
3207
  # }
3074
- # subscription = @client.modify_subscription(
3208
+ # subscription = @client.update_subscription(
3075
3209
  # subscription_id: subscription_id,
3076
3210
  # body: subscription_update
3077
3211
  # )
@@ -3082,17 +3216,18 @@ module Recurly
3082
3216
  # puts "ValidationError: #{e.recurly_error.params}"
3083
3217
  # end
3084
3218
  #
3085
- def modify_subscription(subscription_id:, body:, **options)
3219
+ def update_subscription(subscription_id:, body:, **options)
3086
3220
  path = interpolate_path("/subscriptions/{subscription_id}", subscription_id: subscription_id)
3087
3221
  put(path, body, Requests::SubscriptionUpdate, **options)
3088
3222
  end
3089
3223
 
3090
3224
  # Terminate a subscription
3091
3225
  #
3092
- # {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}
3093
3227
  #
3094
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+.
3095
- # @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:
3096
3231
  #
3097
3232
  # * +full+ - Performs a full refund of the last invoice for the current subscription term.
3098
3233
  # * +partial+ - Prorates a refund based on the amount of time remaining in the current bill cycle.
@@ -3102,8 +3237,8 @@ module Recurly
3102
3237
  #
3103
3238
  # You may also terminate a subscription with no refund and then manually refund specific invoices.
3104
3239
  #
3105
- # @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.
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+.
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+.
3107
3242
  #
3108
3243
  # @return [Resources::Subscription] An expired subscription.
3109
3244
  # @example
@@ -3125,11 +3260,12 @@ module Recurly
3125
3260
 
3126
3261
  # Cancel a subscription
3127
3262
  #
3128
- # {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}
3129
3264
  #
3130
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+.
3131
- # @param body [Requests::SubscriptionCancel] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionCancel}
3132
- # @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+.
3133
3269
  #
3134
3270
  # @return [Resources::Subscription] A canceled or failed subscription.
3135
3271
  # @example
@@ -3151,10 +3287,11 @@ module Recurly
3151
3287
 
3152
3288
  # Reactivate a canceled subscription
3153
3289
  #
3154
- # {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}
3155
3291
  #
3156
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+.
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+.
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+.
3158
3295
  #
3159
3296
  # @return [Resources::Subscription] An active subscription.
3160
3297
  # @example
@@ -3176,11 +3313,12 @@ module Recurly
3176
3313
 
3177
3314
  # Pause subscription
3178
3315
  #
3179
- # {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}
3180
3317
  #
3181
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+.
3182
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}
3183
- # @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+.
3184
3322
  #
3185
3323
  # @return [Resources::Subscription] A subscription.
3186
3324
  # @example
@@ -3206,10 +3344,11 @@ module Recurly
3206
3344
 
3207
3345
  # Resume subscription
3208
3346
  #
3209
- # {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}
3210
3348
  #
3211
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+.
3212
- # @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+.
3213
3352
  #
3214
3353
  # @return [Resources::Subscription] A subscription.
3215
3354
  # @example
@@ -3231,10 +3370,11 @@ module Recurly
3231
3370
 
3232
3371
  # Convert trial subscription
3233
3372
  #
3234
- # {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}
3235
3374
  #
3236
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+.
3237
- # @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+.
3238
3378
  #
3239
3379
  # @return [Resources::Subscription] A subscription.
3240
3380
  #
@@ -3243,25 +3383,13 @@ module Recurly
3243
3383
  put(path, **options)
3244
3384
  end
3245
3385
 
3246
- # Fetch a preview of a subscription's renewal invoice(s)
3247
- #
3248
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_preview_renewal get_preview_renewal api documentation}
3249
- #
3250
- # @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+.
3251
- #
3252
- # @return [Resources::InvoiceCollection] A preview of the subscription's renewal invoice(s).
3253
- #
3254
- def get_preview_renewal(subscription_id:)
3255
- path = interpolate_path("/subscriptions/{subscription_id}/preview_renewal", subscription_id: subscription_id)
3256
- get(path)
3257
- end
3258
-
3259
3386
  # Fetch a subscription's pending change
3260
3387
  #
3261
- # {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}
3262
3389
  #
3263
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+.
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+.
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+.
3265
3393
  #
3266
3394
  # @return [Resources::SubscriptionChange] A subscription's pending change.
3267
3395
  # @example
@@ -3283,11 +3411,12 @@ module Recurly
3283
3411
 
3284
3412
  # Create a new subscription change
3285
3413
  #
3286
- # {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}
3287
3415
  #
3288
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+.
3289
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}
3290
- # @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+.
3291
3420
  #
3292
3421
  # @return [Resources::SubscriptionChange] A subscription change.
3293
3422
  # @example
@@ -3314,10 +3443,11 @@ module Recurly
3314
3443
 
3315
3444
  # Delete the pending subscription change
3316
3445
  #
3317
- # {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}
3318
3447
  #
3319
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+.
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+.
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+.
3321
3451
  #
3322
3452
  # @return [Resources::Empty] Subscription change was deleted.
3323
3453
  # @example
@@ -3339,13 +3469,14 @@ module Recurly
3339
3469
 
3340
3470
  # Preview a new subscription change
3341
3471
  #
3342
- # {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}
3343
3473
  #
3344
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+.
3345
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}
3346
- # @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+.
3347
3478
  #
3348
- # @return [Resources::SubscriptionChangePreview] A subscription change.
3479
+ # @return [Resources::SubscriptionChange] A subscription change.
3349
3480
  #
3350
3481
  def preview_subscription_change(subscription_id:, body:, **options)
3351
3482
  path = interpolate_path("/subscriptions/{subscription_id}/change/preview", subscription_id: subscription_id)
@@ -3354,10 +3485,11 @@ module Recurly
3354
3485
 
3355
3486
  # List a subscription's invoices
3356
3487
  #
3357
- # {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}
3358
3489
  #
3359
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+.
3360
- # @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
3361
3493
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
3362
3494
  #
3363
3495
  # *Important notes:*
@@ -3369,32 +3501,34 @@ module Recurly
3369
3501
  # * Records are returned in an arbitrary order. Since results are all
3370
3502
  # returned at once you can sort the records yourself.
3371
3503
  #
3372
- # @param state [String] Invoice state.
3373
- # @param limit [Integer] Limit number of records 1-200.
3374
- # @param order [String] Sort order.
3375
- # @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
3376
3507
  # order. In descending order updated records will move behind the cursor and could
3377
3508
  # prevent some records from being returned.
3378
3509
  #
3379
- # @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+.
3380
3511
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
3381
3512
  #
3382
- # @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+.
3383
3514
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
3384
3515
  #
3385
- # @param type [String] Filter by type when:
3516
+ # :type [String] Filter by type when:
3386
3517
  # - +type=charge+, only charge invoices will be returned.
3387
3518
  # - +type=credit+, only credit invoices will be returned.
3388
3519
  # - +type=non-legacy+, only charge and credit invoices will be returned.
3389
3520
  # - +type=legacy+, only legacy invoices will be returned.
3390
3521
  #
3391
- # @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+.
3392
3523
  #
3393
3524
  # @return [Pager<Resources::Invoice>] A list of the subscription's invoices.
3394
3525
  # @example
3526
+ # params = {
3527
+ # limit: 200
3528
+ # }
3395
3529
  # invoices = @client.list_subscription_invoices(
3396
3530
  # subscription_id: subscription_id,
3397
- # limit: 200
3531
+ # params: params
3398
3532
  # )
3399
3533
  # invoices.each do |invoice|
3400
3534
  # puts "Invoice: #{invoice.number}"
@@ -3407,10 +3541,11 @@ module Recurly
3407
3541
 
3408
3542
  # List a subscription's line items
3409
3543
  #
3410
- # {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}
3411
3545
  #
3412
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+.
3413
- # @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
3414
3549
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
3415
3550
  #
3416
3551
  # *Important notes:*
@@ -3422,28 +3557,31 @@ module Recurly
3422
3557
  # * Records are returned in an arbitrary order. Since results are all
3423
3558
  # returned at once you can sort the records yourself.
3424
3559
  #
3425
- # @param limit [Integer] Limit number of records 1-200.
3426
- # @param order [String] Sort order.
3427
- # @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
3428
3563
  # order. In descending order updated records will move behind the cursor and could
3429
3564
  # prevent some records from being returned.
3430
3565
  #
3431
- # @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+.
3432
3567
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
3433
3568
  #
3434
- # @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+.
3435
3570
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
3436
3571
  #
3437
- # @param original [String] Filter by original field.
3438
- # @param state [String] Filter by state field.
3439
- # @param type [String] Filter by type field.
3440
- # @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+.
3441
3576
  #
3442
3577
  # @return [Pager<Resources::LineItem>] A list of the subscription's line items.
3443
3578
  # @example
3579
+ # params = {
3580
+ # limit: 200
3581
+ # }
3444
3582
  # line_items = @client.list_subscription_line_items(
3445
3583
  # subscription_id: subscription_id,
3446
- # limit: 200
3584
+ # params: params
3447
3585
  # )
3448
3586
  # line_items.each do |line_item|
3449
3587
  # puts "LineItem: #{line_item.id}"
@@ -3454,12 +3592,13 @@ module Recurly
3454
3592
  pager(path, **options)
3455
3593
  end
3456
3594
 
3457
- # List the coupon redemptions for a subscription
3595
+ # Show the coupon redemptions for a subscription
3458
3596
  #
3459
- # {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}
3460
3598
  #
3461
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+.
3462
- # @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
3463
3602
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
3464
3603
  #
3465
3604
  # *Important notes:*
@@ -3471,23 +3610,26 @@ module Recurly
3471
3610
  # * Records are returned in an arbitrary order. Since results are all
3472
3611
  # returned at once you can sort the records yourself.
3473
3612
  #
3474
- # @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
3475
3614
  # order. In descending order updated records will move behind the cursor and could
3476
3615
  # prevent some records from being returned.
3477
3616
  #
3478
- # @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+.
3479
3618
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
3480
3619
  #
3481
- # @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+.
3482
3621
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
3483
3622
  #
3484
- # @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+.
3485
3624
  #
3486
3625
  # @return [Pager<Resources::CouponRedemption>] A list of the the coupon redemptions on a subscription.
3487
3626
  # @example
3627
+ # params = {
3628
+ # limit: 200
3629
+ # }
3488
3630
  # coupon_redemptions = @client.list_subscription_coupon_redemptions(
3489
3631
  # subscription_id: subscription_id,
3490
- # limit: 200
3632
+ # params: params
3491
3633
  # )
3492
3634
  # coupon_redemptions.each do |redemption|
3493
3635
  # puts "CouponRedemption: #{redemption.id}"
@@ -3500,11 +3642,12 @@ module Recurly
3500
3642
 
3501
3643
  # List a subscription add-on's usage records
3502
3644
  #
3503
- # {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}
3504
3646
  #
3505
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+.
3506
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+.
3507
- # @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
3508
3651
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
3509
3652
  #
3510
3653
  # *Important notes:*
@@ -3516,20 +3659,20 @@ module Recurly
3516
3659
  # * Records are returned in an arbitrary order. Since results are all
3517
3660
  # returned at once you can sort the records yourself.
3518
3661
  #
3519
- # @param limit [Integer] Limit number of records 1-200.
3520
- # @param order [String] Sort order.
3521
- # @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
3522
3665
  # order. In descending order updated records will move behind the cursor and could
3523
3666
  # prevent some records from being returned.
3524
3667
  #
3525
- # @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+.
3526
3669
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
3527
3670
  #
3528
- # @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+.
3529
3672
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
3530
3673
  #
3531
- # @param billing_status [String] Filter by usage record's billing status
3532
- # @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+.
3533
3676
  #
3534
3677
  # @return [Pager<Resources::Usage>] A list of the subscription add-on's usage records.
3535
3678
  #
@@ -3540,12 +3683,13 @@ module Recurly
3540
3683
 
3541
3684
  # Log a usage record on this subscription add-on
3542
3685
  #
3543
- # {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}
3544
3687
  #
3545
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+.
3546
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+.
3547
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}
3548
- # @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+.
3549
3693
  #
3550
3694
  # @return [Resources::Usage] The created usage record.
3551
3695
  #
@@ -3556,10 +3700,11 @@ module Recurly
3556
3700
 
3557
3701
  # Get a usage record
3558
3702
  #
3559
- # {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}
3560
3704
  #
3561
3705
  # @param usage_id [String] Usage Record ID.
3562
- # @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+.
3563
3708
  #
3564
3709
  # @return [Resources::Usage] The usage record.
3565
3710
  #
@@ -3570,11 +3715,12 @@ module Recurly
3570
3715
 
3571
3716
  # Update a usage record
3572
3717
  #
3573
- # {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}
3574
3719
  #
3575
3720
  # @param usage_id [String] Usage Record ID.
3576
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}
3577
- # @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+.
3578
3724
  #
3579
3725
  # @return [Resources::Usage] The updated usage record.
3580
3726
  #
@@ -3585,10 +3731,11 @@ module Recurly
3585
3731
 
3586
3732
  # Delete a usage record.
3587
3733
  #
3588
- # {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}
3589
3735
  #
3590
3736
  # @param usage_id [String] Usage Record ID.
3591
- # @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+.
3592
3739
  #
3593
3740
  # @return [Resources::Empty] Usage was successfully deleted.
3594
3741
  #
@@ -3599,9 +3746,10 @@ module Recurly
3599
3746
 
3600
3747
  # List a site's transactions
3601
3748
  #
3602
- # {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}
3603
3750
  #
3604
- # @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
3605
3753
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
3606
3754
  #
3607
3755
  # *Important notes:*
@@ -3613,25 +3761,28 @@ module Recurly
3613
3761
  # * Records are returned in an arbitrary order. Since results are all
3614
3762
  # returned at once you can sort the records yourself.
3615
3763
  #
3616
- # @param limit [Integer] Limit number of records 1-200.
3617
- # @param order [String] Sort order.
3618
- # @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
3619
3767
  # order. In descending order updated records will move behind the cursor and could
3620
3768
  # prevent some records from being returned.
3621
3769
  #
3622
- # @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+.
3623
3771
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
3624
3772
  #
3625
- # @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+.
3626
3774
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
3627
3775
  #
3628
- # @param type [String] Filter by type field. The value +payment+ will return both +purchase+ and +capture+ transactions.
3629
- # @param success [String] Filter by success field.
3630
- # @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+.
3631
3779
  #
3632
3780
  # @return [Pager<Resources::Transaction>] A list of the site's transactions.
3633
3781
  # @example
3634
- # transactions = @client.list_transactions(limit: 200)
3782
+ # params = {
3783
+ # limit: 200
3784
+ # }
3785
+ # transactions = @client.list_transactions(params: params)
3635
3786
  # transactions.each do |transaction|
3636
3787
  # puts "Transaction: #{transaction.uuid}"
3637
3788
  # end
@@ -3643,10 +3794,11 @@ module Recurly
3643
3794
 
3644
3795
  # Fetch a transaction
3645
3796
  #
3646
- # {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}
3647
3798
  #
3648
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+.
3649
- # @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+.
3650
3802
  #
3651
3803
  # @return [Resources::Transaction] A transaction.
3652
3804
  # @example
@@ -3666,10 +3818,11 @@ module Recurly
3666
3818
 
3667
3819
  # Fetch a unique coupon code
3668
3820
  #
3669
- # {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}
3670
3822
  #
3671
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+.
3672
- # @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+.
3673
3826
  #
3674
3827
  # @return [Resources::UniqueCouponCode] A unique coupon code.
3675
3828
  #
@@ -3680,10 +3833,11 @@ module Recurly
3680
3833
 
3681
3834
  # Deactivate a unique coupon code
3682
3835
  #
3683
- # {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}
3684
3837
  #
3685
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+.
3686
- # @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+.
3687
3841
  #
3688
3842
  # @return [Resources::UniqueCouponCode] A unique coupon code.
3689
3843
  #
@@ -3694,10 +3848,11 @@ module Recurly
3694
3848
 
3695
3849
  # Restore a unique coupon code
3696
3850
  #
3697
- # {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}
3698
3852
  #
3699
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+.
3700
- # @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+.
3701
3856
  #
3702
3857
  # @return [Resources::UniqueCouponCode] A unique coupon code.
3703
3858
  #
@@ -3708,10 +3863,11 @@ module Recurly
3708
3863
 
3709
3864
  # Create a new purchase
3710
3865
  #
3711
- # {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}
3712
3867
  #
3713
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}
3714
- # @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+.
3715
3871
  #
3716
3872
  # @return [Resources::InvoiceCollection] Returns the new invoices
3717
3873
  # @example
@@ -3748,10 +3904,11 @@ module Recurly
3748
3904
 
3749
3905
  # Preview a new purchase
3750
3906
  #
3751
- # {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}
3752
3908
  #
3753
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}
3754
- # @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+.
3755
3912
  #
3756
3913
  # @return [Resources::InvoiceCollection] Returns preview of the new invoices
3757
3914
  # @example
@@ -3788,9 +3945,10 @@ module Recurly
3788
3945
 
3789
3946
  # List the dates that have an available export to download.
3790
3947
  #
3791
- # {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}
3792
3949
  #
3793
- # @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+.
3794
3952
  #
3795
3953
  # @return [Resources::ExportDates] Returns a list of dates.
3796
3954
  # @example
@@ -3812,10 +3970,11 @@ module Recurly
3812
3970
 
3813
3971
  # List of the export files that are available to download.
3814
3972
  #
3815
- # {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}
3816
3974
  #
3817
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.
3818
- # @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+.
3819
3978
  #
3820
3979
  # @return [Resources::ExportFiles] Returns a list of export files to download.
3821
3980
  # @example
@@ -3834,48 +3993,5 @@ module Recurly
3834
3993
  path = interpolate_path("/export_dates/{export_date}/export_files", export_date: export_date)
3835
3994
  get(path, **options)
3836
3995
  end
3837
-
3838
- # List the dunning campaigns for a site
3839
- #
3840
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_dunning_campaigns list_dunning_campaigns api documentation}
3841
- #
3842
- # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
3843
- # order. In descending order updated records will move behind the cursor and could
3844
- # prevent some records from being returned.
3845
- #
3846
- #
3847
- # @return [Pager<Resources::DunningCampaign>] A list of the the dunning_campaigns on an account.
3848
- #
3849
- def list_dunning_campaigns(**options)
3850
- path = "/dunning_campaigns"
3851
- pager(path, **options)
3852
- end
3853
-
3854
- # Fetch a dunning campaign
3855
- #
3856
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_dunning_campaign get_dunning_campaign api documentation}
3857
- #
3858
- # @param dunning_campaign_id [String] Dunning Campaign ID, e.g. +e28zov4fw0v2+.
3859
- #
3860
- # @return [Resources::DunningCampaign] Settings for a dunning campaign.
3861
- #
3862
- def get_dunning_campaign(dunning_campaign_id:)
3863
- path = interpolate_path("/dunning_campaigns/{dunning_campaign_id}", dunning_campaign_id: dunning_campaign_id)
3864
- get(path)
3865
- end
3866
-
3867
- # Assign a dunning campaign to multiple plans
3868
- #
3869
- # {https://developers.recurly.com/api/v2019-10-10#operation/put_dunning_campaign_bulk_update put_dunning_campaign_bulk_update api documentation}
3870
- #
3871
- # @param dunning_campaign_id [String] Dunning Campaign ID, e.g. +e28zov4fw0v2+.
3872
- # @param body [Requests::DunningCampaignsBulkUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::DunningCampaignsBulkUpdate}
3873
- #
3874
- # @return [Resources::DunningCampaignsBulkUpdateResponse] A list of updated plans.
3875
- #
3876
- def put_dunning_campaign_bulk_update(dunning_campaign_id:, body:)
3877
- path = interpolate_path("/dunning_campaigns/{dunning_campaign_id}/bulk_update", dunning_campaign_id: dunning_campaign_id)
3878
- put(path, body, Requests::DunningCampaignsBulkUpdate)
3879
- end
3880
3996
  end
3881
3997
  end