recurly 3.0.0 → 3.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (34) hide show
  1. checksums.yaml +4 -4
  2. data/.bumpversion.cfg +1 -1
  3. data/.github/ISSUE_TEMPLATE/bug-report.md +30 -0
  4. data/.github/ISSUE_TEMPLATE/question-or-other.md +10 -0
  5. data/.yardopts +1 -2
  6. data/GETTING_STARTED.md +13 -20
  7. data/README.md +4 -13
  8. data/lib/recurly/client.rb +9 -1
  9. data/lib/recurly/client/operations.rb +298 -173
  10. data/lib/recurly/http.rb +3 -1
  11. data/lib/recurly/requests/account_create.rb +4 -0
  12. data/lib/recurly/requests/account_purchase.rb +4 -0
  13. data/lib/recurly/requests/account_update.rb +4 -0
  14. data/lib/recurly/requests/billing_info_create.rb +8 -0
  15. data/lib/recurly/requests/invoice_collect.rb +18 -0
  16. data/lib/recurly/requests/item_create.rb +50 -0
  17. data/lib/recurly/requests/item_update.rb +50 -0
  18. data/lib/recurly/requests/line_item_create.rb +21 -5
  19. data/lib/recurly/requests/pricing.rb +18 -0
  20. data/lib/recurly/requests/purchase_create.rb +4 -0
  21. data/lib/recurly/requests/subscription_cancel.rb +14 -0
  22. data/lib/recurly/requests/subscription_change_create.rb +5 -1
  23. data/lib/recurly/requests/subscription_create.rb +4 -0
  24. data/lib/recurly/requests/subscription_update.rb +1 -1
  25. data/lib/recurly/resources/binary_file.rb +14 -0
  26. data/lib/recurly/resources/item.rb +74 -0
  27. data/lib/recurly/resources/line_item.rb +13 -1
  28. data/lib/recurly/resources/pricing.rb +18 -0
  29. data/lib/recurly/resources/transaction.rb +1 -1
  30. data/lib/recurly/resources/transaction_error.rb +8 -0
  31. data/lib/recurly/schema/file_parser.rb +13 -0
  32. data/lib/recurly/version.rb +1 -1
  33. data/openapi/api.yaml +15083 -0
  34. metadata +15 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 22a128d84f15a6887446e5f7791f3d6b91d67cec94641198ff3a4317c73a17a5
4
- data.tar.gz: 71ac80f190a092f50cc8e9b2f7d8ab9eb5a91aa0528cacccbce642e488ef9616
3
+ metadata.gz: a76c9513385e08cb04253173cc0c8f538932869b39829c3e98411d732f0f70e9
4
+ data.tar.gz: 05dec3ca31574b8751233ee4453b6373693ee6d9665be6bd345e0c86c08b4431
5
5
  SHA512:
6
- metadata.gz: ba861fa4d8f40dcc52e3cd4f2b7484aeaf90d5364deaccdf4e9e5894ee15cfdf98c3f05042d7916dd492278244a986fdfb547837214354eab3fc6c1678eb168b
7
- data.tar.gz: bf1733bd81f4250afa91841f1e352bb884378c4edfb47bab62857c18d0ba40c74d7e1fdebbdacfc2a4289c31a895c675427d181688840e71a7da5e14a1997b01
6
+ metadata.gz: f40a8e96f42034d6c80a44ff93d2f23833b10f4973b3cbc6164af426fa48eeccf6b098b29f3c616fe1b7202cec6947103f7a9034f10e934b8eacb359ce427ff6
7
+ data.tar.gz: 51d6f0e13deb6f1f84de2d5d74900b3ec1b9843d447134cecfc4b6ab263da4ad0a6f1d78ae5984fd9faff74cf227975e0251cbae640baa2401d630a9faa3fd8e
@@ -1,5 +1,5 @@
1
1
  [bumpversion]
2
- current_version = 3.0.0
2
+ current_version = 3.1.0
3
3
  parse = (?P<major>\d+)
4
4
  \.(?P<minor>\d+)
5
5
  \.(?P<patch>\d+)
@@ -0,0 +1,30 @@
1
+ ---
2
+ name: Bug Report
3
+ about: Create a report to help us improve
4
+ title: ''
5
+ labels: bug?
6
+ assignees: ''
7
+
8
+ ---
9
+
10
+ _Warning_: Github issues are not an official support channel for Recurly. If you have an urgent request we suggest you contact us through an official channel: support@recurly.com or https://recurly.zendesk.com
11
+
12
+ **Describe the bug**
13
+
14
+ A clear and concise description of what the bug is.
15
+
16
+ **To Reproduce**
17
+
18
+ Steps to reproduce the behavior.
19
+
20
+ If possible, please provide example code which we can run to reproduce the bug.
21
+ The faster we can reproduce the bug, the faster we can help you.
22
+
23
+ **Expected behavior**
24
+
25
+ A clear and concise description of what you expected to happen.
26
+
27
+ **Your Environment**
28
+
29
+ - Which version of this library are you using?
30
+ - Which version of ruby are you using?
@@ -0,0 +1,10 @@
1
+ ---
2
+ name: Question or Other
3
+ about: A question or feature request
4
+ title: ''
5
+ labels: question
6
+ assignees: ''
7
+
8
+ ---
9
+
10
+ _Warning_: Github issues are not an official support channel for Recurly. If you have an urgent request we suggest you contact us through an official channel: support@recurly.com or https://recurly.zendesk.com
data/.yardopts CHANGED
@@ -1,3 +1,2 @@
1
1
  --readme GETTING_STARTED.md
2
- -
3
- GETTING_STARTED.md
2
+ - GETTING_STARTED.md
@@ -1,27 +1,20 @@
1
- # Recurly
1
+ This repository houses the official ruby client for Recurly's V3 API.
2
2
 
3
- ## Getting Started
4
-
5
- ### Installing
3
+ # Installing
6
4
 
7
5
  In your Gemfile, add `recurly` as a dependency.
8
6
 
9
7
  ```ruby
10
- gem 'recurly', '~> 3.0'
8
+ gem 'recurly', '~> 3.1'
11
9
  ```
12
10
 
13
11
  > *Note*: We try to follow [semantic versioning](https://semver.org/) and will only apply breaking changes to major versions.
14
12
 
15
- ### Creating a client
16
-
17
- Client instances are now explicitly created and referenced as opposed to V2's use of global, statically
18
- initialized clients.
19
-
20
- This makes multithreaded environments simpler and provides one location where every
21
- operation can be found (rather than having them spread out among classes).
13
+ # Creating a client
22
14
 
23
- `Recurly::Client#new` initializes a new client. It only requires an API key which can be obtained on
24
- the [API Credentials Page](https://app.recurly.com/go/integrations/api_keys).
15
+ A client represents a connection to the Recurly servers. Every call
16
+ to the server exists as a method on this class. To initialize, you only need the private API key
17
+ which can be obtained on the [API Credentials Page](https://app.recurly.com/go/integrations/api_keys).
25
18
 
26
19
  ```ruby
27
20
  API_KEY = '83749879bbde395b5fe0cc1a5abf8e5'
@@ -48,14 +41,14 @@ client = Recurly::Client.new(api_key: API_KEY2)
48
41
  sub = client.get_subscription(subscription_id: 'abcd7890')
49
42
  ```
50
43
 
51
- ### Operations
44
+ # Operations
52
45
 
53
46
  The {Recurly::Client} contains every `operation` you can perform on the site as a list of methods. Each method is documented explaining
54
47
  the types and descriptions for each input and return type. You can view all available operations by looking at the `Instance Methods Summary` list
55
48
  on the {Recurly::Client} documentation page. Clicking a method will give you detailed information about its inputs and returns. Take the `create_account`
56
49
  operation as an example: {Recurly::Client#create_account}.
57
50
 
58
- ### Pagination
51
+ # Pagination
59
52
 
60
53
  Pagination is done by the class {Recurly::Pager}. All `list_*` methods on the client return an instance of this class.
61
54
  The pager has an `each` method which accepts a block for each object in the entire list. Each page is fetched automatically
@@ -117,7 +110,7 @@ end
117
110
  We recommend keeping the default for most cases but increasing the limit if you are planning on iterating through many pages of items (e.g. all transactions in your site).
118
111
 
119
112
 
120
- ### Creating Resources
113
+ # Creating Resources
121
114
 
122
115
  Currently, resources are created by passing in a `body` keyword argument in the form of a `Hash`.
123
116
  This Hash must follow the schema of the documented request type. For example, the `create_plan` operation
@@ -145,7 +138,7 @@ plan_data = {
145
138
  plan = client.create_plan(body: plan_data)
146
139
  ```
147
140
 
148
- ### Error Handling
141
+ # Error Handling
149
142
 
150
143
  This library currently throws 2 types of exceptions. {Recurly::Errors::APIError} and {Recurly::Errors::NetworkError}. See these 2 files for the types of exceptions you can catch:
151
144
 
@@ -189,7 +182,7 @@ rescue Recurly::Errors::NetworkError => ex
189
182
  end
190
183
  ```
191
184
 
192
- ### HTTP Metadata
185
+ # HTTP Metadata
193
186
 
194
187
  Sometimes you might want to get some additional information about the underlying HTTP request and response. Instead of
195
188
  returning this information directly and forcing the programmer to unwrap it, we inject this metadata into the top level
@@ -224,7 +217,7 @@ rescue Recurly::Errors::NotFoundError => e
224
217
  end
225
218
  ```
226
219
 
227
- ### Webhooks
220
+ # Webhooks
228
221
 
229
222
  Recurly can send webhooks to any publicly accessible server.
230
223
  When an event in Recurly triggers a webhook (e.g., an account is opened),
data/README.md CHANGED
@@ -3,21 +3,12 @@
3
3
  This repository houses the official ruby client for Recurly's V3 API.
4
4
 
5
5
  > *Note*:
6
- > If you were looking for the V2 client, see the [master branch](https://github.com/recurly/recurly-client-ruby/tree/master).
6
+ > If you were looking for the V2 client, see the [v2 branch](https://github.com/recurly/recurly-client-ruby/tree/v2).
7
7
 
8
- ## Getting Started
8
+ ## Reference Documentation
9
9
 
10
- ### Documentation
10
+ Getting Started Guide and reference tdocumentation can be found on [rubydoc.info](https://www.rubydoc.info/github/recurly/recurly-client-ruby/).
11
11
 
12
- > *Note*:
13
- > Until rubydoc.info respects our `.yardopts` file, see documentation [here](GETTING_STARTED.md).
14
-
15
- Ruby documentation and the getting started instructions can be found
16
- on rubydoc.info: [https://www.rubydoc.info/github/recurly/recurly-client-ruby/](https://www.rubydoc.info/github/recurly/recurly-client-ruby/).
17
-
18
- Documentation for the HTTP API and example code can be found
19
- [on our Developer Portal](https://developers.recurly.com/api/v2019-10-10/).
20
-
21
- ### Contributing
12
+ ## Contributing
22
13
 
23
14
  Please see our [Contributing Guide](CONTRIBUTING.md).
@@ -2,6 +2,7 @@ require "faraday"
2
2
  require "logger"
3
3
  require "erb"
4
4
  require_relative "./schema/json_parser"
5
+ require_relative "./schema/file_parser"
5
6
  require_relative "./client/adapter"
6
7
 
7
8
  module Recurly
@@ -9,6 +10,9 @@ module Recurly
9
10
  require_relative "./client/operations"
10
11
 
11
12
  BASE_URL = "https://v3.recurly.com/"
13
+ BINARY_TYPES = [
14
+ "application/pdf",
15
+ ]
12
16
 
13
17
  # Initialize a client. It requires an API key.
14
18
  #
@@ -122,7 +126,11 @@ module Recurly
122
126
  response = HTTP::Response.new(faraday_resp, request)
123
127
  raise_api_error!(response) unless (200...300).include?(response.status)
124
128
  resource = if response.body
125
- JSONParser.parse(self, response.body)
129
+ if BINARY_TYPES.include?(response.content_type)
130
+ FileParser.parse(response.body)
131
+ else
132
+ JSONParser.parse(self, response.body)
133
+ end
126
134
  else
127
135
  Resources::Empty.new
128
136
  end
@@ -46,7 +46,7 @@ module Recurly
46
46
  #
47
47
  # {https://developers.recurly.com/api/v2019-10-10#operation/get_site get_site api documenation}
48
48
  #
49
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
49
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
50
50
  # @return [Resources::Site] A site.
51
51
  def get_site(site_id:)
52
52
  path = interpolate_path("/sites/{site_id}", site_id: site_id)
@@ -86,7 +86,7 @@ module Recurly
86
86
  # +canceled+, or +future+ state.
87
87
  #
88
88
  # @param past_due [String] Filter for accounts with an invoice in the +past_due+ state.
89
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
89
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
90
90
  # @return [Pager<Resources::Account>] A list of the site's accounts.
91
91
  # @example
92
92
  # accounts = @client.list_accounts(limit: 200)
@@ -104,7 +104,7 @@ module Recurly
104
104
  # {https://developers.recurly.com/api/v2019-10-10#operation/create_account create_account api documenation}
105
105
  #
106
106
  # @param body [Requests::AccountCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AccountCreate}
107
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
107
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
108
108
  # @return [Resources::Account] An account.
109
109
  # @example
110
110
  # begin
@@ -151,8 +151,8 @@ module Recurly
151
151
  #
152
152
  # {https://developers.recurly.com/api/v2019-10-10#operation/get_account get_account api documenation}
153
153
  #
154
- # @param account_id [String] Account ID or code (use prefix: +code-+, e.g. +code-bob+).
155
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
154
+ # @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+.
155
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
156
156
  # @return [Resources::Account] An account.
157
157
  # @example
158
158
  # begin
@@ -173,9 +173,9 @@ module Recurly
173
173
  #
174
174
  # {https://developers.recurly.com/api/v2019-10-10#operation/update_account update_account api documenation}
175
175
  #
176
- # @param account_id [String] Account ID or code (use prefix: +code-+, e.g. +code-bob+).
176
+ # @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+.
177
177
  # @param body [Requests::AccountUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AccountUpdate}
178
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
178
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
179
179
  # @return [Resources::Account] An account.
180
180
  # @example
181
181
  # begin
@@ -203,8 +203,8 @@ module Recurly
203
203
  #
204
204
  # {https://developers.recurly.com/api/v2019-10-10#operation/deactivate_account deactivate_account api documenation}
205
205
  #
206
- # @param account_id [String] Account ID or code (use prefix: +code-+, e.g. +code-bob+).
207
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
206
+ # @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+.
207
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
208
208
  # @return [Resources::Account] An account.
209
209
  # @example
210
210
  # begin
@@ -225,8 +225,8 @@ module Recurly
225
225
  #
226
226
  # {https://developers.recurly.com/api/v2019-10-10#operation/get_account_acquisition get_account_acquisition api documenation}
227
227
  #
228
- # @param account_id [String] Account ID or code (use prefix: +code-+, e.g. +code-bob+).
229
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
228
+ # @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+.
229
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
230
230
  # @return [Resources::AccountAcquisition] An account's acquisition data.
231
231
  # @example
232
232
  # begin
@@ -247,9 +247,9 @@ module Recurly
247
247
  #
248
248
  # {https://developers.recurly.com/api/v2019-10-10#operation/update_account_acquisition update_account_acquisition api documenation}
249
249
  #
250
- # @param account_id [String] Account ID or code (use prefix: +code-+, e.g. +code-bob+).
250
+ # @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+.
251
251
  # @param body [Requests::AccountAcquisitionUpdatable] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AccountAcquisitionUpdatable}
252
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
252
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
253
253
  # @return [Resources::AccountAcquisition] An account's updated acquisition data.
254
254
  def update_account_acquisition(account_id:, body:, **options)
255
255
  path = interpolate_path("/accounts/{account_id}/acquisition", account_id: account_id)
@@ -260,8 +260,8 @@ module Recurly
260
260
  #
261
261
  # {https://developers.recurly.com/api/v2019-10-10#operation/remove_account_acquisition remove_account_acquisition api documenation}
262
262
  #
263
- # @param account_id [String] Account ID or code (use prefix: +code-+, e.g. +code-bob+).
264
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
263
+ # @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+.
264
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
265
265
  # @return [Empty] Acquisition data was succesfully deleted.
266
266
  # @example
267
267
  # begin
@@ -282,8 +282,8 @@ module Recurly
282
282
  #
283
283
  # {https://developers.recurly.com/api/v2019-10-10#operation/reactivate_account reactivate_account api documenation}
284
284
  #
285
- # @param account_id [String] Account ID or code (use prefix: +code-+, e.g. +code-bob+).
286
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
285
+ # @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+.
286
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
287
287
  # @return [Resources::Account] An account.
288
288
  # @example
289
289
  # begin
@@ -304,8 +304,8 @@ module Recurly
304
304
  #
305
305
  # {https://developers.recurly.com/api/v2019-10-10#operation/get_account_balance get_account_balance api documenation}
306
306
  #
307
- # @param account_id [String] Account ID or code (use prefix: +code-+, e.g. +code-bob+).
308
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
307
+ # @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+.
308
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
309
309
  # @return [Resources::AccountBalance] An account's balance.
310
310
  # @example
311
311
  # begin
@@ -326,8 +326,8 @@ module Recurly
326
326
  #
327
327
  # {https://developers.recurly.com/api/v2019-10-10#operation/get_billing_info get_billing_info api documenation}
328
328
  #
329
- # @param account_id [String] Account ID or code (use prefix: +code-+, e.g. +code-bob+).
330
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
329
+ # @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+.
331
331
  # @return [Resources::BillingInfo] An account's billing information.
332
332
  # @example
333
333
  # begin
@@ -348,9 +348,9 @@ module Recurly
348
348
  #
349
349
  # {https://developers.recurly.com/api/v2019-10-10#operation/update_billing_info update_billing_info api documenation}
350
350
  #
351
- # @param account_id [String] Account ID or code (use prefix: +code-+, e.g. +code-bob+).
351
+ # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
352
352
  # @param body [Requests::BillingInfoCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoCreate}
353
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
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+.
354
354
  # @return [Resources::BillingInfo] Updated billing information.
355
355
  # @example
356
356
  # begin
@@ -378,8 +378,8 @@ module Recurly
378
378
  #
379
379
  # {https://developers.recurly.com/api/v2019-10-10#operation/remove_billing_info remove_billing_info api documenation}
380
380
  #
381
- # @param account_id [String] Account ID or code (use prefix: +code-+, e.g. +code-bob+).
382
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
381
+ # @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+.
382
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
383
383
  # @return [Empty] Billing information deleted
384
384
  # @example
385
385
  # begin
@@ -400,7 +400,7 @@ module Recurly
400
400
  #
401
401
  # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_coupon_redemptions list_account_coupon_redemptions api documenation}
402
402
  #
403
- # @param account_id [String] Account ID or code (use prefix: +code-+, e.g. +code-bob+).
403
+ # @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+.
404
404
  # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
405
405
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
406
406
  #
@@ -423,7 +423,7 @@ module Recurly
423
423
  # @param end_time [DateTime] Filter by end_time when +sort=created_at+ or +sort=updated_at+.
424
424
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
425
425
  #
426
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
426
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
427
427
  # @return [Pager<Resources::CouponRedemption>] A list of the the coupon redemptions on an account.
428
428
  # @example
429
429
  # redemptions = @client.list_account_coupon_redemptions(
@@ -443,8 +443,8 @@ module Recurly
443
443
  #
444
444
  # {https://developers.recurly.com/api/v2019-10-10#operation/get_active_coupon_redemption get_active_coupon_redemption api documenation}
445
445
  #
446
- # @param account_id [String] Account ID or code (use prefix: +code-+, e.g. +code-bob+).
447
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
446
+ # @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+.
447
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
448
448
  # @return [Resources::CouponRedemption] An active coupon redemption on an account.
449
449
  # @example
450
450
  # begin
@@ -465,9 +465,9 @@ module Recurly
465
465
  #
466
466
  # {https://developers.recurly.com/api/v2019-10-10#operation/create_coupon_redemption create_coupon_redemption api documenation}
467
467
  #
468
- # @param account_id [String] Account ID or code (use prefix: +code-+, e.g. +code-bob+).
468
+ # @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+.
469
469
  # @param body [Requests::CouponRedemptionCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponRedemptionCreate}
470
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
470
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
471
471
  # @return [Resources::CouponRedemption] Returns the new coupon redemption.
472
472
  # @example
473
473
  # begin
@@ -495,8 +495,8 @@ module Recurly
495
495
  #
496
496
  # {https://developers.recurly.com/api/v2019-10-10#operation/remove_coupon_redemption remove_coupon_redemption api documenation}
497
497
  #
498
- # @param account_id [String] Account ID or code (use prefix: +code-+, e.g. +code-bob+).
499
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
498
+ # @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+.
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+.
500
500
  # @return [Resources::CouponRedemption] Coupon redemption deleted.
501
501
  # @example
502
502
  # begin
@@ -517,7 +517,7 @@ module Recurly
517
517
  #
518
518
  # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_credit_payments list_account_credit_payments api documenation}
519
519
  #
520
- # @param account_id [String] Account ID or code (use prefix: +code-+, e.g. +code-bob+).
520
+ # @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+.
521
521
  # @param limit [Integer] Limit number of records 1-200.
522
522
  # @param order [String] Sort order.
523
523
  # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
@@ -530,7 +530,7 @@ module Recurly
530
530
  # @param end_time [DateTime] Filter by end_time when +sort=created_at+ or +sort=updated_at+.
531
531
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
532
532
  #
533
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
533
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
534
534
  # @return [Pager<Resources::CreditPayment>] A list of the account's credit payments.
535
535
  # @example
536
536
  # payments = @client.list_account_credit_payments(
@@ -550,7 +550,7 @@ module Recurly
550
550
  #
551
551
  # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_invoices list_account_invoices api documenation}
552
552
  #
553
- # @param account_id [String] Account ID or code (use prefix: +code-+, e.g. +code-bob+).
553
+ # @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+.
554
554
  # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
555
555
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
556
556
  #
@@ -581,7 +581,7 @@ module Recurly
581
581
  # - +type=non-legacy+, only charge and credit invoices will be returned.
582
582
  # - +type=legacy+, only legacy invoices will be returned.
583
583
  #
584
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
584
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
585
585
  # @return [Pager<Resources::Invoice>] A list of the account's invoices.
586
586
  # @example
587
587
  # invoices = @client.list_account_invoices(
@@ -601,9 +601,9 @@ module Recurly
601
601
  #
602
602
  # {https://developers.recurly.com/api/v2019-10-10#operation/create_invoice create_invoice api documenation}
603
603
  #
604
- # @param account_id [String] Account ID or code (use prefix: +code-+, e.g. +code-bob+).
604
+ # @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+.
605
605
  # @param body [Requests::InvoiceCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceCreate}
606
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
606
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
607
607
  # @return [Resources::InvoiceCollection] Returns the new invoices.
608
608
  # @example
609
609
  # begin
@@ -631,9 +631,9 @@ module Recurly
631
631
  #
632
632
  # {https://developers.recurly.com/api/v2019-10-10#operation/preview_invoice preview_invoice api documenation}
633
633
  #
634
- # @param account_id [String] Account ID or code (use prefix: +code-+, e.g. +code-bob+).
634
+ # @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+.
635
635
  # @param body [Requests::InvoiceCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceCreate}
636
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
636
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
637
637
  # @return [Resources::InvoiceCollection] Returns the invoice previews.
638
638
  # @example
639
639
  # begin
@@ -661,7 +661,7 @@ module Recurly
661
661
  #
662
662
  # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_line_items list_account_line_items api documenation}
663
663
  #
664
- # @param account_id [String] Account ID or code (use prefix: +code-+, e.g. +code-bob+).
664
+ # @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+.
665
665
  # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
666
666
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
667
667
  #
@@ -689,7 +689,7 @@ module Recurly
689
689
  # @param original [String] Filter by original field.
690
690
  # @param state [String] Filter by state field.
691
691
  # @param type [String] Filter by type field.
692
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
692
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
693
693
  # @return [Pager<Resources::LineItem>] A list of the account's line items.
694
694
  # @example
695
695
  # line_items = @client.list_account_line_items(
@@ -709,9 +709,9 @@ module Recurly
709
709
  #
710
710
  # {https://developers.recurly.com/api/v2019-10-10#operation/create_line_item create_line_item api documenation}
711
711
  #
712
- # @param account_id [String] Account ID or code (use prefix: +code-+, e.g. +code-bob+).
712
+ # @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+.
713
713
  # @param body [Requests::LineItemCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::LineItemCreate}
714
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
714
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
715
715
  # @return [Resources::LineItem] Returns the new line item.
716
716
  # @example
717
717
  # begin
@@ -740,7 +740,7 @@ module Recurly
740
740
  #
741
741
  # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_notes list_account_notes api documenation}
742
742
  #
743
- # @param account_id [String] Account ID or code (use prefix: +code-+, e.g. +code-bob+).
743
+ # @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+.
744
744
  # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
745
745
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
746
746
  #
@@ -753,7 +753,7 @@ module Recurly
753
753
  # * Records are returned in an arbitrary order. Since results are all
754
754
  # returned at once you can sort the records yourself.
755
755
  #
756
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
756
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
757
757
  # @return [Pager<Resources::AccountNote>] A list of an account's notes.
758
758
  # @example
759
759
  # account_notes = @client.list_account_notes(account_id: account_id, limit: 200)
@@ -770,9 +770,9 @@ module Recurly
770
770
  #
771
771
  # {https://developers.recurly.com/api/v2019-10-10#operation/get_account_note get_account_note api documenation}
772
772
  #
773
- # @param account_id [String] Account ID or code (use prefix: +code-+, e.g. +code-bob+).
773
+ # @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+.
774
774
  # @param account_note_id [String] Account Note ID.
775
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
775
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
776
776
  # @return [Resources::AccountNote] An account note.
777
777
  # @example
778
778
  # begin
@@ -796,7 +796,7 @@ module Recurly
796
796
  #
797
797
  # {https://developers.recurly.com/api/v2019-10-10#operation/list_shipping_addresses list_shipping_addresses api documenation}
798
798
  #
799
- # @param account_id [String] Account ID or code (use prefix: +code-+, e.g. +code-bob+).
799
+ # @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+.
800
800
  # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
801
801
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
802
802
  #
@@ -821,7 +821,7 @@ module Recurly
821
821
  # @param end_time [DateTime] Filter by end_time when +sort=created_at+ or +sort=updated_at+.
822
822
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
823
823
  #
824
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
824
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
825
825
  # @return [Pager<Resources::ShippingAddress>] A list of an account's shipping addresses.
826
826
  # @example
827
827
  # shipping_addresses = @client.list_shipping_addresses(
@@ -841,9 +841,9 @@ module Recurly
841
841
  #
842
842
  # {https://developers.recurly.com/api/v2019-10-10#operation/create_shipping_address create_shipping_address api documenation}
843
843
  #
844
- # @param account_id [String] Account ID or code (use prefix: +code-+, e.g. +code-bob+).
844
+ # @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
845
  # @param body [Requests::ShippingAddressCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ShippingAddressCreate}
846
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
846
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
847
847
  # @return [Resources::ShippingAddress] Returns the new shipping address.
848
848
  def create_shipping_address(account_id:, body:, **options)
849
849
  path = interpolate_path("/accounts/{account_id}/shipping_addresses", account_id: account_id)
@@ -854,9 +854,9 @@ module Recurly
854
854
  #
855
855
  # {https://developers.recurly.com/api/v2019-10-10#operation/get_shipping_address get_shipping_address api documenation}
856
856
  #
857
- # @param account_id [String] Account ID or code (use prefix: +code-+, e.g. +code-bob+).
857
+ # @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+.
858
858
  # @param shipping_address_id [String] Shipping Address ID.
859
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
859
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
860
860
  # @return [Resources::ShippingAddress] A shipping address.
861
861
  # @example
862
862
  # begin
@@ -880,10 +880,10 @@ module Recurly
880
880
  #
881
881
  # {https://developers.recurly.com/api/v2019-10-10#operation/update_shipping_address update_shipping_address api documenation}
882
882
  #
883
- # @param account_id [String] Account ID or code (use prefix: +code-+, e.g. +code-bob+).
883
+ # @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+.
884
884
  # @param shipping_address_id [String] Shipping Address ID.
885
885
  # @param body [Requests::ShippingAddressUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ShippingAddressUpdate}
886
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
886
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
887
887
  # @return [Resources::ShippingAddress] The updated shipping address.
888
888
  # @example
889
889
  # begin
@@ -913,9 +913,9 @@ module Recurly
913
913
  #
914
914
  # {https://developers.recurly.com/api/v2019-10-10#operation/remove_shipping_address remove_shipping_address api documenation}
915
915
  #
916
- # @param account_id [String] Account ID or code (use prefix: +code-+, e.g. +code-bob+).
916
+ # @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+.
917
917
  # @param shipping_address_id [String] Shipping Address ID.
918
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
918
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
919
919
  # @return [Empty] Shipping address deleted.
920
920
  # @example
921
921
  # begin
@@ -939,7 +939,7 @@ module Recurly
939
939
  #
940
940
  # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_subscriptions list_account_subscriptions api documenation}
941
941
  #
942
- # @param account_id [String] Account ID or code (use prefix: +code-+, e.g. +code-bob+).
942
+ # @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+.
943
943
  # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
944
944
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
945
945
  #
@@ -970,7 +970,7 @@ module Recurly
970
970
  # - 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.
971
971
  # - When +state=live+, only subscriptions that are in an active, canceled, or future state or are in trial will be returned.
972
972
  #
973
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
973
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
974
974
  # @return [Pager<Resources::Subscription>] A list of the account's subscriptions.
975
975
  # @example
976
976
  # subscriptions = @client.list_account_subscriptions(
@@ -990,7 +990,7 @@ module Recurly
990
990
  #
991
991
  # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_transactions list_account_transactions api documenation}
992
992
  #
993
- # @param account_id [String] Account ID or code (use prefix: +code-+, e.g. +code-bob+).
993
+ # @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+.
994
994
  # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
995
995
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
996
996
  #
@@ -1017,7 +1017,7 @@ module Recurly
1017
1017
  #
1018
1018
  # @param type [String] Filter by type field. The value +payment+ will return both +purchase+ and +capture+ transactions.
1019
1019
  # @param success [String] Filter by success field.
1020
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
1020
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1021
1021
  # @return [Pager<Resources::Transaction>] A list of the account's transactions.
1022
1022
  # @example
1023
1023
  # transactions = @client.list_account_transactions(
@@ -1037,7 +1037,7 @@ module Recurly
1037
1037
  #
1038
1038
  # {https://developers.recurly.com/api/v2019-10-10#operation/list_child_accounts list_child_accounts api documenation}
1039
1039
  #
1040
- # @param account_id [String] Account ID or code (use prefix: +code-+, e.g. +code-bob+).
1040
+ # @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+.
1041
1041
  # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
1042
1042
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
1043
1043
  #
@@ -1067,7 +1067,7 @@ module Recurly
1067
1067
  # +canceled+, or +future+ state.
1068
1068
  #
1069
1069
  # @param past_due [String] Filter for accounts with an invoice in the +past_due+ state.
1070
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
1070
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1071
1071
  # @return [Pager<Resources::Account>] A list of an account's child accounts.
1072
1072
  # @example
1073
1073
  # child_accounts = @client.list_child_accounts(
@@ -1111,7 +1111,7 @@ module Recurly
1111
1111
  # @param end_time [DateTime] Filter by end_time when +sort=created_at+ or +sort=updated_at+.
1112
1112
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1113
1113
  #
1114
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
1114
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1115
1115
  # @return [Pager<Resources::AccountAcquisition>] A list of the site's account acquisition data.
1116
1116
  # @example
1117
1117
  # acquisitions = @client.list_account_acquisition(limit: 200)
@@ -1152,7 +1152,7 @@ module Recurly
1152
1152
  # @param end_time [DateTime] Filter by end_time when +sort=created_at+ or +sort=updated_at+.
1153
1153
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1154
1154
  #
1155
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
1155
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1156
1156
  # @return [Pager<Resources::Coupon>] A list of the site's coupons.
1157
1157
  # @example
1158
1158
  # coupons = @client.list_coupons(limit: 200)
@@ -1170,7 +1170,7 @@ module Recurly
1170
1170
  # {https://developers.recurly.com/api/v2019-10-10#operation/create_coupon create_coupon api documenation}
1171
1171
  #
1172
1172
  # @param body [Requests::CouponCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponCreate}
1173
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
1173
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1174
1174
  # @return [Resources::Coupon] A new coupon.
1175
1175
  # @example
1176
1176
  # begin
@@ -1204,8 +1204,8 @@ module Recurly
1204
1204
  #
1205
1205
  # {https://developers.recurly.com/api/v2019-10-10#operation/get_coupon get_coupon api documenation}
1206
1206
  #
1207
- # @param coupon_id [String] Coupon ID or code (use prefix: +code-+, e.g. +code-10off+).
1208
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
1207
+ # @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+.
1208
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1209
1209
  # @return [Resources::Coupon] A coupon.
1210
1210
  # @example
1211
1211
  # begin
@@ -1226,9 +1226,9 @@ module Recurly
1226
1226
  #
1227
1227
  # {https://developers.recurly.com/api/v2019-10-10#operation/update_coupon update_coupon api documenation}
1228
1228
  #
1229
- # @param coupon_id [String] Coupon ID or code (use prefix: +code-+, e.g. +code-10off+).
1229
+ # @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+.
1230
1230
  # @param body [Requests::CouponUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponUpdate}
1231
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
1231
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1232
1232
  # @return [Resources::Coupon] The updated coupon.
1233
1233
  def update_coupon(coupon_id:, body:, **options)
1234
1234
  path = interpolate_path("/coupons/{coupon_id}", coupon_id: coupon_id)
@@ -1239,7 +1239,7 @@ module Recurly
1239
1239
  #
1240
1240
  # {https://developers.recurly.com/api/v2019-10-10#operation/list_unique_coupon_codes list_unique_coupon_codes api documenation}
1241
1241
  #
1242
- # @param coupon_id [String] Coupon ID or code (use prefix: +code-+, e.g. +code-10off+).
1242
+ # @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+.
1243
1243
  # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
1244
1244
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
1245
1245
  #
@@ -1264,7 +1264,7 @@ module Recurly
1264
1264
  # @param end_time [DateTime] Filter by end_time when +sort=created_at+ or +sort=updated_at+.
1265
1265
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1266
1266
  #
1267
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
1267
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1268
1268
  # @return [Pager<Resources::UniqueCouponCode>] A list of unique coupon codes that were generated
1269
1269
  def list_unique_coupon_codes(coupon_id:, **options)
1270
1270
  path = interpolate_path("/coupons/{coupon_id}/unique_coupon_codes", coupon_id: coupon_id)
@@ -1287,7 +1287,7 @@ module Recurly
1287
1287
  # @param end_time [DateTime] Filter by end_time when +sort=created_at+ or +sort=updated_at+.
1288
1288
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1289
1289
  #
1290
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
1290
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1291
1291
  # @return [Pager<Resources::CreditPayment>] A list of the site's credit payments.
1292
1292
  # @example
1293
1293
  # payments = @client.list_credit_payments(limit: 200)
@@ -1304,8 +1304,8 @@ module Recurly
1304
1304
  #
1305
1305
  # {https://developers.recurly.com/api/v2019-10-10#operation/get_credit_payment get_credit_payment api documenation}
1306
1306
  #
1307
- # @param credit_payment_id [String] Credit Payment ID or UUID (use prefix: +uuid-+, e.g. +uuid-123457890+).
1308
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
1307
+ # @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+.
1308
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1309
1309
  # @return [Resources::CreditPayment] A credit payment.
1310
1310
  def get_credit_payment(credit_payment_id:, **options)
1311
1311
  path = interpolate_path("/credit_payments/{credit_payment_id}", credit_payment_id: credit_payment_id)
@@ -1340,7 +1340,8 @@ module Recurly
1340
1340
  # @param end_time [DateTime] Filter by end_time when +sort=created_at+ or +sort=updated_at+.
1341
1341
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1342
1342
  #
1343
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
1343
+ # @param related_type [String] Filter by related type.
1344
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1344
1345
  # @return [Pager<Resources::CustomFieldDefinition>] A list of the site's custom field definitions.
1345
1346
  # @example
1346
1347
  # custom_fields = @client.list_custom_field_definitions(limit: 200)
@@ -1358,13 +1359,110 @@ module Recurly
1358
1359
  # {https://developers.recurly.com/api/v2019-10-10#operation/get_custom_field_definition get_custom_field_definition api documenation}
1359
1360
  #
1360
1361
  # @param custom_field_definition_id [String] Custom Field Definition ID
1361
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
1362
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1362
1363
  # @return [Resources::CustomFieldDefinition] An custom field definition.
1363
1364
  def get_custom_field_definition(custom_field_definition_id:, **options)
1364
1365
  path = interpolate_path("/custom_field_definitions/{custom_field_definition_id}", custom_field_definition_id: custom_field_definition_id)
1365
1366
  get(path, **options)
1366
1367
  end
1367
1368
 
1369
+ # List a site's items
1370
+ #
1371
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_items list_items api documenation}
1372
+ #
1373
+ # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
1374
+ # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
1375
+ #
1376
+ # *Important notes:*
1377
+ #
1378
+ # * The +ids+ parameter cannot be used with any other ordering or filtering
1379
+ # parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
1380
+ # * Invalid or unknown IDs will be ignored, so you should check that the
1381
+ # results correspond to your request.
1382
+ # * Records are returned in an arbitrary order. Since results are all
1383
+ # returned at once you can sort the records yourself.
1384
+ #
1385
+ # @param limit [Integer] Limit number of records 1-200.
1386
+ # @param order [String] Sort order.
1387
+ # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
1388
+ # order. In descending order updated records will move behind the cursor and could
1389
+ # prevent some records from being returned.
1390
+ #
1391
+ # @param begin_time [DateTime] Filter by begin_time when +sort=created_at+ or +sort=updated_at+.
1392
+ # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1393
+ #
1394
+ # @param end_time [DateTime] Filter by end_time when +sort=created_at+ or +sort=updated_at+.
1395
+ # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1396
+ #
1397
+ # @param state [String] Filter by state.
1398
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1399
+ # @return [Pager<Resources::Item>] A list of the site's items.
1400
+ def list_items(**options)
1401
+ path = interpolate_path("/items")
1402
+ pager(path, **options)
1403
+ end
1404
+
1405
+ # Create a new item
1406
+ #
1407
+ # {https://developers.recurly.com/api/v2019-10-10#operation/create_item create_item api documenation}
1408
+ #
1409
+ # @param body [Requests::ItemCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ItemCreate}
1410
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1411
+ # @return [Resources::Item] A new item.
1412
+ def create_item(body:, **options)
1413
+ path = interpolate_path("/items")
1414
+ post(path, body, Requests::ItemCreate, **options)
1415
+ end
1416
+
1417
+ # Fetch an item
1418
+ #
1419
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_item get_item api documenation}
1420
+ #
1421
+ # @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+.
1422
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1423
+ # @return [Resources::Item] An item.
1424
+ def get_item(item_id:, **options)
1425
+ path = interpolate_path("/items/{item_id}", item_id: item_id)
1426
+ get(path, **options)
1427
+ end
1428
+
1429
+ # Update an active item
1430
+ #
1431
+ # {https://developers.recurly.com/api/v2019-10-10#operation/update_item update_item api documenation}
1432
+ #
1433
+ # @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+.
1434
+ # @param body [Requests::ItemUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ItemUpdate}
1435
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1436
+ # @return [Resources::Item] The updated item.
1437
+ def update_item(item_id:, body:, **options)
1438
+ path = interpolate_path("/items/{item_id}", item_id: item_id)
1439
+ put(path, body, Requests::ItemUpdate, **options)
1440
+ end
1441
+
1442
+ # Deactivate an item
1443
+ #
1444
+ # {https://developers.recurly.com/api/v2019-10-10#operation/deactivate_item deactivate_item api documenation}
1445
+ #
1446
+ # @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+.
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+.
1448
+ # @return [Resources::Item] An item.
1449
+ def deactivate_item(item_id:, **options)
1450
+ path = interpolate_path("/items/{item_id}", item_id: item_id)
1451
+ delete(path, **options)
1452
+ end
1453
+
1454
+ # Reactivate an inactive item
1455
+ #
1456
+ # {https://developers.recurly.com/api/v2019-10-10#operation/reactivate_item reactivate_item api documenation}
1457
+ #
1458
+ # @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+.
1459
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1460
+ # @return [Resources::Item] An item.
1461
+ def reactivate_item(item_id:, **options)
1462
+ path = interpolate_path("/items/{item_id}/reactivate", item_id: item_id)
1463
+ put(path, **options)
1464
+ end
1465
+
1368
1466
  # List a site's invoices
1369
1467
  #
1370
1468
  # {https://developers.recurly.com/api/v2019-10-10#operation/list_invoices list_invoices api documenation}
@@ -1399,7 +1497,7 @@ module Recurly
1399
1497
  # - +type=non-legacy+, only charge and credit invoices will be returned.
1400
1498
  # - +type=legacy+, only legacy invoices will be returned.
1401
1499
  #
1402
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
1500
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1403
1501
  # @return [Pager<Resources::Invoice>] A list of the site's invoices.
1404
1502
  # @example
1405
1503
  # invoices = @client.list_invoices(limit: 200)
@@ -1416,8 +1514,8 @@ module Recurly
1416
1514
  #
1417
1515
  # {https://developers.recurly.com/api/v2019-10-10#operation/get_invoice get_invoice api documenation}
1418
1516
  #
1419
- # @param invoice_id [String] Invoice ID or number (use prefix: +number-+, e.g. +number-1000+).
1420
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
1517
+ # @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+.
1518
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1421
1519
  # @return [Resources::Invoice] An invoice.
1422
1520
  # @example
1423
1521
  # begin
@@ -1438,21 +1536,47 @@ module Recurly
1438
1536
  #
1439
1537
  # {https://developers.recurly.com/api/v2019-10-10#operation/put_invoice put_invoice api documenation}
1440
1538
  #
1441
- # @param invoice_id [String] Invoice ID or number (use prefix: +number-+, e.g. +number-1000+).
1539
+ # @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+.
1442
1540
  # @param body [Requests::InvoiceUpdatable] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceUpdatable}
1443
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
1541
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1444
1542
  # @return [Resources::Invoice] An invoice.
1445
1543
  def put_invoice(invoice_id:, body:, **options)
1446
1544
  path = interpolate_path("/invoices/{invoice_id}", invoice_id: invoice_id)
1447
1545
  put(path, body, Requests::InvoiceUpdatable, **options)
1448
1546
  end
1449
1547
 
1548
+ # Fetch an invoice as a PDF
1549
+ #
1550
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_invoice_pdf get_invoice_pdf api documenation}
1551
+ #
1552
+ # @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+.
1553
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1554
+ # @return [Resources::BinaryFile] An invoice as a PDF.
1555
+ # @example
1556
+ # begin
1557
+ # invoice = @client.get_invoice_pdf(invoice_id: invoice_id)
1558
+ # puts "Got invoice #{invoice}"
1559
+ # filename = "#{download_directory}/rubyinvoice-#{invoice_id}.pdf"
1560
+ # IO.write(filename, invoice.data)
1561
+ # puts "Saved Invoice PDF to #{filename}"
1562
+ # rescue Recurly::Errors::NotFoundError
1563
+ # # If the resource was not found, you may want to alert the user or
1564
+ # # just return nil
1565
+ # puts "Resource Not Found"
1566
+ # end
1567
+ #
1568
+ def get_invoice_pdf(invoice_id:, **options)
1569
+ path = interpolate_path("/invoices/{invoice_id}.pdf", invoice_id: invoice_id)
1570
+ get(path, **options)
1571
+ end
1572
+
1450
1573
  # Collect a pending or past due, automatic invoice
1451
1574
  #
1452
1575
  # {https://developers.recurly.com/api/v2019-10-10#operation/collect_invoice collect_invoice api documenation}
1453
1576
  #
1454
- # @param invoice_id [String] Invoice ID or number (use prefix: +number-+, e.g. +number-1000+).
1455
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
1577
+ # @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+.
1578
+ # @param body [Requests::InvoiceCollect] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceCollect}
1579
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1456
1580
  # @return [Resources::Invoice] The updated invoice.
1457
1581
  # @example
1458
1582
  # begin
@@ -1466,15 +1590,15 @@ module Recurly
1466
1590
  #
1467
1591
  def collect_invoice(invoice_id:, **options)
1468
1592
  path = interpolate_path("/invoices/{invoice_id}/collect", invoice_id: invoice_id)
1469
- put(path, **options)
1593
+ put(path, options[:body], Requests::InvoiceCollect, **options)
1470
1594
  end
1471
1595
 
1472
1596
  # Mark an open invoice as failed
1473
1597
  #
1474
1598
  # {https://developers.recurly.com/api/v2019-10-10#operation/fail_invoice fail_invoice api documenation}
1475
1599
  #
1476
- # @param invoice_id [String] Invoice ID or number (use prefix: +number-+, e.g. +number-1000+).
1477
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
1600
+ # @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+.
1601
+ # @param site_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
1602
  # @return [Resources::Invoice] The updated invoice.
1479
1603
  # @example
1480
1604
  # begin
@@ -1495,8 +1619,8 @@ module Recurly
1495
1619
  #
1496
1620
  # {https://developers.recurly.com/api/v2019-10-10#operation/mark_invoice_successful mark_invoice_successful api documenation}
1497
1621
  #
1498
- # @param invoice_id [String] Invoice ID or number (use prefix: +number-+, e.g. +number-1000+).
1499
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
1622
+ # @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+.
1623
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1500
1624
  # @return [Resources::Invoice] The updated invoice.
1501
1625
  # @example
1502
1626
  # begin
@@ -1517,8 +1641,8 @@ module Recurly
1517
1641
  #
1518
1642
  # {https://developers.recurly.com/api/v2019-10-10#operation/reopen_invoice reopen_invoice api documenation}
1519
1643
  #
1520
- # @param invoice_id [String] Invoice ID or number (use prefix: +number-+, e.g. +number-1000+).
1521
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
1644
+ # @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+.
1645
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1522
1646
  # @return [Resources::Invoice] The updated invoice.
1523
1647
  # @example
1524
1648
  # begin
@@ -1539,8 +1663,8 @@ module Recurly
1539
1663
  #
1540
1664
  # {https://developers.recurly.com/api/v2019-10-10#operation/void_invoice void_invoice api documenation}
1541
1665
  #
1542
- # @param invoice_id [String] Invoice ID or number (use prefix: +number-+, e.g. +number-1000+).
1543
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
1666
+ # @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+.
1667
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1544
1668
  # @return [Resources::Invoice] The updated invoice.
1545
1669
  def void_invoice(invoice_id:, **options)
1546
1670
  path = interpolate_path("/invoices/{invoice_id}/void", invoice_id: invoice_id)
@@ -1551,7 +1675,7 @@ module Recurly
1551
1675
  #
1552
1676
  # {https://developers.recurly.com/api/v2019-10-10#operation/list_invoice_line_items list_invoice_line_items api documenation}
1553
1677
  #
1554
- # @param invoice_id [String] Invoice ID or number (use prefix: +number-+, e.g. +number-1000+).
1678
+ # @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+.
1555
1679
  # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
1556
1680
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
1557
1681
  #
@@ -1579,7 +1703,7 @@ module Recurly
1579
1703
  # @param original [String] Filter by original field.
1580
1704
  # @param state [String] Filter by state field.
1581
1705
  # @param type [String] Filter by type field.
1582
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
1706
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1583
1707
  # @return [Pager<Resources::LineItem>] A list of the invoice's line items.
1584
1708
  def list_invoice_line_items(invoice_id:, **options)
1585
1709
  path = interpolate_path("/invoices/{invoice_id}/line_items", invoice_id: invoice_id)
@@ -1590,7 +1714,7 @@ module Recurly
1590
1714
  #
1591
1715
  # {https://developers.recurly.com/api/v2019-10-10#operation/list_invoice_coupon_redemptions list_invoice_coupon_redemptions api documenation}
1592
1716
  #
1593
- # @param invoice_id [String] Invoice ID or number (use prefix: +number-+, e.g. +number-1000+).
1717
+ # @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+.
1594
1718
  # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
1595
1719
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
1596
1720
  #
@@ -1613,7 +1737,7 @@ module Recurly
1613
1737
  # @param end_time [DateTime] Filter by end_time when +sort=created_at+ or +sort=updated_at+.
1614
1738
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1615
1739
  #
1616
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
1740
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1617
1741
  # @return [Pager<Resources::CouponRedemption>] A list of the the coupon redemptions associated with the invoice.
1618
1742
  # @example
1619
1743
  # coupon_redemptions = @client.list_invoice_coupon_redemptions(
@@ -1633,8 +1757,8 @@ module Recurly
1633
1757
  #
1634
1758
  # {https://developers.recurly.com/api/v2019-10-10#operation/list_related_invoices list_related_invoices api documenation}
1635
1759
  #
1636
- # @param invoice_id [String] Invoice ID or number (use prefix: +number-+, e.g. +number-1000+).
1637
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
1760
+ # @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+.
1761
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1638
1762
  # @return [Pager<Resources::Invoice>] A list of the credit or charge invoices associated with the invoice.
1639
1763
  def list_related_invoices(invoice_id:, **options)
1640
1764
  path = interpolate_path("/invoices/{invoice_id}/related_invoices", invoice_id: invoice_id)
@@ -1645,9 +1769,9 @@ module Recurly
1645
1769
  #
1646
1770
  # {https://developers.recurly.com/api/v2019-10-10#operation/refund_invoice refund_invoice api documenation}
1647
1771
  #
1648
- # @param invoice_id [String] Invoice ID or number (use prefix: +number-+, e.g. +number-1000+).
1772
+ # @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+.
1649
1773
  # @param body [Requests::InvoiceRefund] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceRefund}
1650
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
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+.
1651
1775
  # @return [Resources::Invoice] Returns the new credit invoice.
1652
1776
  # @example
1653
1777
  # begin
@@ -1702,7 +1826,7 @@ module Recurly
1702
1826
  # @param original [String] Filter by original field.
1703
1827
  # @param state [String] Filter by state field.
1704
1828
  # @param type [String] Filter by type field.
1705
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
1829
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1706
1830
  # @return [Pager<Resources::LineItem>] A list of the site's line items.
1707
1831
  def list_line_items(**options)
1708
1832
  path = interpolate_path("/line_items")
@@ -1714,7 +1838,7 @@ module Recurly
1714
1838
  # {https://developers.recurly.com/api/v2019-10-10#operation/get_line_item get_line_item api documenation}
1715
1839
  #
1716
1840
  # @param line_item_id [String] Line Item ID.
1717
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
1841
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1718
1842
  # @return [Resources::LineItem] A line item.
1719
1843
  # @example
1720
1844
  # begin
@@ -1736,7 +1860,7 @@ module Recurly
1736
1860
  # {https://developers.recurly.com/api/v2019-10-10#operation/remove_line_item remove_line_item api documenation}
1737
1861
  #
1738
1862
  # @param line_item_id [String] Line Item ID.
1739
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
1863
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1740
1864
  # @return [Empty] Line item deleted.
1741
1865
  # @example
1742
1866
  # begin
@@ -1784,7 +1908,7 @@ module Recurly
1784
1908
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1785
1909
  #
1786
1910
  # @param state [String] Filter by state.
1787
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
1911
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1788
1912
  # @return [Pager<Resources::Plan>] A list of plans.
1789
1913
  # @example
1790
1914
  # plans = @client.list_plans(limit: 200)
@@ -1802,7 +1926,7 @@ module Recurly
1802
1926
  # {https://developers.recurly.com/api/v2019-10-10#operation/create_plan create_plan api documenation}
1803
1927
  #
1804
1928
  # @param body [Requests::PlanCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PlanCreate}
1805
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
1929
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1806
1930
  # @return [Resources::Plan] A plan.
1807
1931
  # @example
1808
1932
  # begin
@@ -1840,8 +1964,8 @@ module Recurly
1840
1964
  #
1841
1965
  # {https://developers.recurly.com/api/v2019-10-10#operation/get_plan get_plan api documenation}
1842
1966
  #
1843
- # @param plan_id [String] Plan ID or code (use prefix: +code-+, e.g. +code-gold+).
1844
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
1967
+ # @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+.
1968
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1845
1969
  # @return [Resources::Plan] A plan.
1846
1970
  # @example
1847
1971
  # begin
@@ -1862,9 +1986,9 @@ module Recurly
1862
1986
  #
1863
1987
  # {https://developers.recurly.com/api/v2019-10-10#operation/update_plan update_plan api documenation}
1864
1988
  #
1865
- # @param plan_id [String] Plan ID or code (use prefix: +code-+, e.g. +code-gold+).
1989
+ # @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+.
1866
1990
  # @param body [Requests::PlanUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PlanUpdate}
1867
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
1991
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1868
1992
  # @return [Resources::Plan] A plan.
1869
1993
  def update_plan(plan_id:, body:, **options)
1870
1994
  path = interpolate_path("/plans/{plan_id}", plan_id: plan_id)
@@ -1875,8 +1999,8 @@ module Recurly
1875
1999
  #
1876
2000
  # {https://developers.recurly.com/api/v2019-10-10#operation/remove_plan remove_plan api documenation}
1877
2001
  #
1878
- # @param plan_id [String] Plan ID or code (use prefix: +code-+, e.g. +code-gold+).
1879
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
2002
+ # @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+.
2003
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1880
2004
  # @return [Resources::Plan] Plan deleted
1881
2005
  def remove_plan(plan_id:, **options)
1882
2006
  path = interpolate_path("/plans/{plan_id}", plan_id: plan_id)
@@ -1887,7 +2011,7 @@ module Recurly
1887
2011
  #
1888
2012
  # {https://developers.recurly.com/api/v2019-10-10#operation/list_plan_add_ons list_plan_add_ons api documenation}
1889
2013
  #
1890
- # @param plan_id [String] Plan ID or code (use prefix: +code-+, e.g. +code-gold+).
2014
+ # @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+.
1891
2015
  # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
1892
2016
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
1893
2017
  #
@@ -1913,7 +2037,7 @@ module Recurly
1913
2037
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1914
2038
  #
1915
2039
  # @param state [String] Filter by state.
1916
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
2040
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1917
2041
  # @return [Pager<Resources::AddOn>] A list of add-ons.
1918
2042
  # @example
1919
2043
  # add_ons = @client.list_plan_add_ons(
@@ -1933,9 +2057,9 @@ module Recurly
1933
2057
  #
1934
2058
  # {https://developers.recurly.com/api/v2019-10-10#operation/create_plan_add_on create_plan_add_on api documenation}
1935
2059
  #
1936
- # @param plan_id [String] Plan ID or code (use prefix: +code-+, e.g. +code-gold+).
2060
+ # @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+.
1937
2061
  # @param body [Requests::AddOnCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AddOnCreate}
1938
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
2062
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1939
2063
  # @return [Resources::AddOn] An add-on.
1940
2064
  def create_plan_add_on(plan_id:, body:, **options)
1941
2065
  path = interpolate_path("/plans/{plan_id}/add_ons", plan_id: plan_id)
@@ -1946,9 +2070,9 @@ module Recurly
1946
2070
  #
1947
2071
  # {https://developers.recurly.com/api/v2019-10-10#operation/get_plan_add_on get_plan_add_on api documenation}
1948
2072
  #
1949
- # @param plan_id [String] Plan ID or code (use prefix: +code-+, e.g. +code-gold+).
1950
- # @param add_on_id [String] Add-on ID or code (use prefix: +code-+, e.g. +code-gold+).
1951
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
2073
+ # @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+.
2074
+ # @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+.
2075
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1952
2076
  # @return [Resources::AddOn] An add-on.
1953
2077
  # @example
1954
2078
  # begin
@@ -1971,10 +2095,10 @@ module Recurly
1971
2095
  #
1972
2096
  # {https://developers.recurly.com/api/v2019-10-10#operation/update_plan_add_on update_plan_add_on api documenation}
1973
2097
  #
1974
- # @param plan_id [String] Plan ID or code (use prefix: +code-+, e.g. +code-gold+).
1975
- # @param add_on_id [String] Add-on ID or code (use prefix: +code-+, e.g. +code-gold+).
2098
+ # @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+.
2099
+ # @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+.
1976
2100
  # @param body [Requests::AddOnUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AddOnUpdate}
1977
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
2101
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1978
2102
  # @return [Resources::AddOn] An add-on.
1979
2103
  def update_plan_add_on(plan_id:, add_on_id:, body:, **options)
1980
2104
  path = interpolate_path("/plans/{plan_id}/add_ons/{add_on_id}", plan_id: plan_id, add_on_id: add_on_id)
@@ -1985,9 +2109,9 @@ module Recurly
1985
2109
  #
1986
2110
  # {https://developers.recurly.com/api/v2019-10-10#operation/remove_plan_add_on remove_plan_add_on api documenation}
1987
2111
  #
1988
- # @param plan_id [String] Plan ID or code (use prefix: +code-+, e.g. +code-gold+).
1989
- # @param add_on_id [String] Add-on ID or code (use prefix: +code-+, e.g. +code-gold+).
1990
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
2112
+ # @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+.
2113
+ # @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+.
2114
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
1991
2115
  # @return [Resources::AddOn] Add-on deleted
1992
2116
  def remove_plan_add_on(plan_id:, add_on_id:, **options)
1993
2117
  path = interpolate_path("/plans/{plan_id}/add_ons/{add_on_id}", plan_id: plan_id, add_on_id: add_on_id)
@@ -2023,7 +2147,7 @@ module Recurly
2023
2147
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2024
2148
  #
2025
2149
  # @param state [String] Filter by state.
2026
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
2150
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2027
2151
  # @return [Pager<Resources::AddOn>] A list of add-ons.
2028
2152
  def list_add_ons(**options)
2029
2153
  path = interpolate_path("/add_ons")
@@ -2034,8 +2158,8 @@ module Recurly
2034
2158
  #
2035
2159
  # {https://developers.recurly.com/api/v2019-10-10#operation/get_add_on get_add_on api documenation}
2036
2160
  #
2037
- # @param add_on_id [String] Add-on ID or code (use prefix: +code-+, e.g. +code-gold+).
2038
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
2161
+ # @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+.
2162
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2039
2163
  # @return [Resources::AddOn] An add-on.
2040
2164
  def get_add_on(add_on_id:, **options)
2041
2165
  path = interpolate_path("/add_ons/{add_on_id}", add_on_id: add_on_id)
@@ -2070,7 +2194,7 @@ module Recurly
2070
2194
  # @param end_time [DateTime] Filter by end_time when +sort=created_at+ or +sort=updated_at+.
2071
2195
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2072
2196
  #
2073
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
2197
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2074
2198
  # @return [Pager<Resources::ShippingMethod>] A list of the site's shipping methods.
2075
2199
  def list_shipping_methods(**options)
2076
2200
  path = interpolate_path("/shipping_methods")
@@ -2081,8 +2205,8 @@ module Recurly
2081
2205
  #
2082
2206
  # {https://developers.recurly.com/api/v2019-10-10#operation/get_shipping_method get_shipping_method api documenation}
2083
2207
  #
2084
- # @param id [String] Shipping Method ID or code (use prefix: +code-+, e.g. +code-usps_2-day+).
2085
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
2208
+ # @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+.
2209
+ # @param site_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
2210
  # @return [Resources::ShippingMethod] A shipping_method.
2087
2211
  def get_shipping_method(id:, **options)
2088
2212
  path = interpolate_path("/shipping_methods/{id}", id: id)
@@ -2123,7 +2247,7 @@ module Recurly
2123
2247
  # - 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.
2124
2248
  # - When +state=live+, only subscriptions that are in an active, canceled, or future state or are in trial will be returned.
2125
2249
  #
2126
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
2250
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2127
2251
  # @return [Pager<Resources::Subscription>] A list of the site's subscriptions.
2128
2252
  # @example
2129
2253
  # subscriptions = @client.list_subscriptions(limit: 200)
@@ -2141,7 +2265,7 @@ module Recurly
2141
2265
  # {https://developers.recurly.com/api/v2019-10-10#operation/create_subscription create_subscription api documenation}
2142
2266
  #
2143
2267
  # @param body [Requests::SubscriptionCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionCreate}
2144
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
2268
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2145
2269
  # @return [Resources::Subscription] A subscription.
2146
2270
  # @example
2147
2271
  # begin
@@ -2173,8 +2297,8 @@ module Recurly
2173
2297
  #
2174
2298
  # {https://developers.recurly.com/api/v2019-10-10#operation/get_subscription get_subscription api documenation}
2175
2299
  #
2176
- # @param subscription_id [String] Subscription ID or UUID (use prefix: +uuid-+, e.g. +uuid-123457890+).
2177
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
2300
+ # @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+.
2301
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2178
2302
  # @return [Resources::Subscription] A subscription.
2179
2303
  # @example
2180
2304
  # begin
@@ -2197,9 +2321,9 @@ module Recurly
2197
2321
  #
2198
2322
  # {https://developers.recurly.com/api/v2019-10-10#operation/modify_subscription modify_subscription api documenation}
2199
2323
  #
2200
- # @param subscription_id [String] Subscription ID or UUID (use prefix: +uuid-+, e.g. +uuid-123457890+).
2324
+ # @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+.
2201
2325
  # @param body [Requests::SubscriptionUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionUpdate}
2202
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
2326
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2203
2327
  # @return [Resources::Subscription] A subscription.
2204
2328
  # @example
2205
2329
  # begin
@@ -2227,7 +2351,7 @@ module Recurly
2227
2351
  #
2228
2352
  # {https://developers.recurly.com/api/v2019-10-10#operation/terminate_subscription terminate_subscription api documenation}
2229
2353
  #
2230
- # @param subscription_id [String] Subscription ID or UUID (use prefix: +uuid-+, e.g. +uuid-123457890+).
2354
+ # @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+.
2231
2355
  # @param refund [String] The type of refund to perform:
2232
2356
  #
2233
2357
  # * +full+ - Performs a full refund of the last invoice for the current subscription term.
@@ -2238,7 +2362,7 @@ module Recurly
2238
2362
  #
2239
2363
  # You may also terminate a subscription with no refund and then manually refund specific invoices.
2240
2364
  #
2241
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
2365
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2242
2366
  # @return [Resources::Subscription] An expired subscription.
2243
2367
  # @example
2244
2368
  # begin
@@ -2261,8 +2385,9 @@ module Recurly
2261
2385
  #
2262
2386
  # {https://developers.recurly.com/api/v2019-10-10#operation/cancel_subscription cancel_subscription api documenation}
2263
2387
  #
2264
- # @param subscription_id [String] Subscription ID or UUID (use prefix: +uuid-+, e.g. +uuid-123457890+).
2265
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
2388
+ # @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+.
2389
+ # @param body [Requests::SubscriptionCancel] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionCancel}
2390
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2266
2391
  # @return [Resources::Subscription] A canceled or failed subscription.
2267
2392
  # @example
2268
2393
  # begin
@@ -2278,15 +2403,15 @@ module Recurly
2278
2403
  #
2279
2404
  def cancel_subscription(subscription_id:, **options)
2280
2405
  path = interpolate_path("/subscriptions/{subscription_id}/cancel", subscription_id: subscription_id)
2281
- put(path, **options)
2406
+ put(path, options[:body], Requests::SubscriptionCancel, **options)
2282
2407
  end
2283
2408
 
2284
2409
  # Reactivate a canceled subscription
2285
2410
  #
2286
2411
  # {https://developers.recurly.com/api/v2019-10-10#operation/reactivate_subscription reactivate_subscription api documenation}
2287
2412
  #
2288
- # @param subscription_id [String] Subscription ID or UUID (use prefix: +uuid-+, e.g. +uuid-123457890+).
2289
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
2413
+ # @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+.
2414
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2290
2415
  # @return [Resources::Subscription] An active subscription.
2291
2416
  # @example
2292
2417
  # begin
@@ -2309,9 +2434,9 @@ module Recurly
2309
2434
  #
2310
2435
  # {https://developers.recurly.com/api/v2019-10-10#operation/pause_subscription pause_subscription api documenation}
2311
2436
  #
2312
- # @param subscription_id [String] Subscription ID or UUID (use prefix: +uuid-+, e.g. +uuid-123457890+).
2437
+ # @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+.
2313
2438
  # @param body [Requests::SubscriptionPause] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionPause}
2314
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
2439
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2315
2440
  # @return [Resources::Subscription] A subscription.
2316
2441
  # @example
2317
2442
  # begin
@@ -2338,8 +2463,8 @@ module Recurly
2338
2463
  #
2339
2464
  # {https://developers.recurly.com/api/v2019-10-10#operation/resume_subscription resume_subscription api documenation}
2340
2465
  #
2341
- # @param subscription_id [String] Subscription ID or UUID (use prefix: +uuid-+, e.g. +uuid-123457890+).
2342
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
2466
+ # @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+.
2467
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2343
2468
  # @return [Resources::Subscription] A subscription.
2344
2469
  # @example
2345
2470
  # begin
@@ -2362,8 +2487,8 @@ module Recurly
2362
2487
  #
2363
2488
  # {https://developers.recurly.com/api/v2019-10-10#operation/get_subscription_change get_subscription_change api documenation}
2364
2489
  #
2365
- # @param subscription_id [String] Subscription ID or UUID (use prefix: +uuid-+, e.g. +uuid-123457890+).
2366
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
2490
+ # @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+.
2491
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2367
2492
  # @return [Resources::SubscriptionChange] A subscription's pending change.
2368
2493
  # @example
2369
2494
  # begin
@@ -2386,9 +2511,9 @@ module Recurly
2386
2511
  #
2387
2512
  # {https://developers.recurly.com/api/v2019-10-10#operation/create_subscription_change create_subscription_change api documenation}
2388
2513
  #
2389
- # @param subscription_id [String] Subscription ID or UUID (use prefix: +uuid-+, e.g. +uuid-123457890+).
2514
+ # @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+.
2390
2515
  # @param body [Requests::SubscriptionChangeCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionChangeCreate}
2391
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
2516
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2392
2517
  # @return [Resources::SubscriptionChange] A subscription change.
2393
2518
  # @example
2394
2519
  # begin
@@ -2416,8 +2541,8 @@ module Recurly
2416
2541
  #
2417
2542
  # {https://developers.recurly.com/api/v2019-10-10#operation/remove_subscription_change remove_subscription_change api documenation}
2418
2543
  #
2419
- # @param subscription_id [String] Subscription ID or UUID (use prefix: +uuid-+, e.g. +uuid-123457890+).
2420
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
2544
+ # @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+.
2545
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2421
2546
  # @return [Empty] Subscription change was deleted.
2422
2547
  # @example
2423
2548
  # begin
@@ -2440,7 +2565,7 @@ module Recurly
2440
2565
  #
2441
2566
  # {https://developers.recurly.com/api/v2019-10-10#operation/list_subscription_invoices list_subscription_invoices api documenation}
2442
2567
  #
2443
- # @param subscription_id [String] Subscription ID or UUID (use prefix: +uuid-+, e.g. +uuid-123457890+).
2568
+ # @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+.
2444
2569
  # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
2445
2570
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
2446
2571
  #
@@ -2471,7 +2596,7 @@ module Recurly
2471
2596
  # - +type=non-legacy+, only charge and credit invoices will be returned.
2472
2597
  # - +type=legacy+, only legacy invoices will be returned.
2473
2598
  #
2474
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
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+.
2475
2600
  # @return [Pager<Resources::Invoice>] A list of the subscription's invoices.
2476
2601
  # @example
2477
2602
  # invoices = @client.list_subscription_invoices(
@@ -2491,7 +2616,7 @@ module Recurly
2491
2616
  #
2492
2617
  # {https://developers.recurly.com/api/v2019-10-10#operation/list_subscription_line_items list_subscription_line_items api documenation}
2493
2618
  #
2494
- # @param subscription_id [String] Subscription ID or UUID (use prefix: +uuid-+, e.g. +uuid-123457890+).
2619
+ # @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+.
2495
2620
  # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
2496
2621
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
2497
2622
  #
@@ -2519,7 +2644,7 @@ module Recurly
2519
2644
  # @param original [String] Filter by original field.
2520
2645
  # @param state [String] Filter by state field.
2521
2646
  # @param type [String] Filter by type field.
2522
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
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+.
2523
2648
  # @return [Pager<Resources::LineItem>] A list of the subscription's line items.
2524
2649
  # @example
2525
2650
  # line_items = @client.list_subscription_line_items(
@@ -2539,7 +2664,7 @@ module Recurly
2539
2664
  #
2540
2665
  # {https://developers.recurly.com/api/v2019-10-10#operation/list_subscription_coupon_redemptions list_subscription_coupon_redemptions api documenation}
2541
2666
  #
2542
- # @param subscription_id [String] Subscription ID or UUID (use prefix: +uuid-+, e.g. +uuid-123457890+).
2667
+ # @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+.
2543
2668
  # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
2544
2669
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
2545
2670
  #
@@ -2562,7 +2687,7 @@ module Recurly
2562
2687
  # @param end_time [DateTime] Filter by end_time when +sort=created_at+ or +sort=updated_at+.
2563
2688
  # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2564
2689
  #
2565
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
2690
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2566
2691
  # @return [Pager<Resources::CouponRedemption>] A list of the the coupon redemptions on a subscription.
2567
2692
  # @example
2568
2693
  # coupon_redemptions = @client.list_subscription_coupon_redemptions(
@@ -2608,7 +2733,7 @@ module Recurly
2608
2733
  #
2609
2734
  # @param type [String] Filter by type field. The value +payment+ will return both +purchase+ and +capture+ transactions.
2610
2735
  # @param success [String] Filter by success field.
2611
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
2736
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2612
2737
  # @return [Pager<Resources::Transaction>] A list of the site's transactions.
2613
2738
  # @example
2614
2739
  # transactions = @client.list_transactions(limit: 200)
@@ -2625,8 +2750,8 @@ module Recurly
2625
2750
  #
2626
2751
  # {https://developers.recurly.com/api/v2019-10-10#operation/get_transaction get_transaction api documenation}
2627
2752
  #
2628
- # @param transaction_id [String] Transaction ID or UUID (use prefix: +uuid-+, e.g. +uuid-123457890+).
2629
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
2753
+ # @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+.
2754
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2630
2755
  # @return [Resources::Transaction] A transaction.
2631
2756
  # @example
2632
2757
  # begin
@@ -2647,8 +2772,8 @@ module Recurly
2647
2772
  #
2648
2773
  # {https://developers.recurly.com/api/v2019-10-10#operation/get_unique_coupon_code get_unique_coupon_code api documenation}
2649
2774
  #
2650
- # @param unique_coupon_code_id [String] Unique Coupon Code ID or code (use prefix: +code-+, e.g. +code-abc-8dh2-def+).
2651
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
2775
+ # @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+.
2776
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2652
2777
  # @return [Resources::UniqueCouponCode] A unique coupon code.
2653
2778
  def get_unique_coupon_code(unique_coupon_code_id:, **options)
2654
2779
  path = interpolate_path("/unique_coupon_codes/{unique_coupon_code_id}", unique_coupon_code_id: unique_coupon_code_id)
@@ -2659,8 +2784,8 @@ module Recurly
2659
2784
  #
2660
2785
  # {https://developers.recurly.com/api/v2019-10-10#operation/deactivate_unique_coupon_code deactivate_unique_coupon_code api documenation}
2661
2786
  #
2662
- # @param unique_coupon_code_id [String] Unique Coupon Code ID or code (use prefix: +code-+, e.g. +code-abc-8dh2-def+).
2663
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
2787
+ # @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+.
2788
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2664
2789
  # @return [Resources::UniqueCouponCode] A unique coupon code.
2665
2790
  def deactivate_unique_coupon_code(unique_coupon_code_id:, **options)
2666
2791
  path = interpolate_path("/unique_coupon_codes/{unique_coupon_code_id}", unique_coupon_code_id: unique_coupon_code_id)
@@ -2671,8 +2796,8 @@ module Recurly
2671
2796
  #
2672
2797
  # {https://developers.recurly.com/api/v2019-10-10#operation/reactivate_unique_coupon_code reactivate_unique_coupon_code api documenation}
2673
2798
  #
2674
- # @param unique_coupon_code_id [String] Unique Coupon Code ID or code (use prefix: +code-+, e.g. +code-abc-8dh2-def+).
2675
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
2799
+ # @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+.
2800
+ # @param site_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
2801
  # @return [Resources::UniqueCouponCode] A unique coupon code.
2677
2802
  def reactivate_unique_coupon_code(unique_coupon_code_id:, **options)
2678
2803
  path = interpolate_path("/unique_coupon_codes/{unique_coupon_code_id}/restore", unique_coupon_code_id: unique_coupon_code_id)
@@ -2684,7 +2809,7 @@ module Recurly
2684
2809
  # {https://developers.recurly.com/api/v2019-10-10#operation/create_purchase create_purchase api documenation}
2685
2810
  #
2686
2811
  # @param body [Requests::PurchaseCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PurchaseCreate}
2687
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
2812
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2688
2813
  # @return [Resources::InvoiceCollection] Returns the new invoices
2689
2814
  # @example
2690
2815
  # begin
@@ -2723,7 +2848,7 @@ module Recurly
2723
2848
  # {https://developers.recurly.com/api/v2019-10-10#operation/preview_purchase preview_purchase api documenation}
2724
2849
  #
2725
2850
  # @param body [Requests::PurchaseCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PurchaseCreate}
2726
- # @param site_id [String] Site ID or subdomain (use prefix: +subdomain-+, e.g. +subdomain-recurly+).
2851
+ # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
2727
2852
  # @return [Resources::InvoiceCollection] Returns preview of the new invoices
2728
2853
  # @example
2729
2854
  # begin