recurly 4.0.0 → 4.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.bumpversion.cfg +1 -1
- data/.changelog_config.yaml +11 -0
- data/.github/workflows/docs.yml +1 -1
- data/.travis.yml +1 -0
- data/CHANGELOG.md +63 -312
- data/CODE_OF_CONDUCT.md +130 -0
- data/CONTRIBUTING.md +4 -0
- data/GETTING_STARTED.md +1 -1
- data/README.md +3 -0
- data/lib/recurly/client.rb +23 -14
- data/lib/recurly/client/operations.rb +50 -154
- data/lib/recurly/errors.rb +1 -0
- data/lib/recurly/errors/network_errors.rb +7 -0
- data/lib/recurly/pager.rb +2 -2
- data/lib/recurly/requests/add_on_create.rb +2 -2
- data/lib/recurly/requests/add_on_update.rb +2 -2
- data/lib/recurly/requests/billing_info_create.rb +5 -1
- data/lib/recurly/requests/billing_info_verify.rb +14 -0
- data/lib/recurly/requests/subscription_add_on_tier.rb +6 -2
- data/lib/recurly/requests/subscription_purchase.rb +1 -1
- data/lib/recurly/requests/tier.rb +5 -1
- data/lib/recurly/resources/billing_info.rb +5 -1
- data/lib/recurly/resources/invoice.rb +1 -1
- data/lib/recurly/resources/subscription_add_on_tier.rb +6 -2
- data/lib/recurly/resources/subscription_change.rb +4 -0
- data/lib/recurly/resources/subscription_change_billing_info.rb +14 -0
- data/lib/recurly/resources/tax_detail.rb +26 -0
- data/lib/recurly/resources/tax_info.rb +4 -0
- data/lib/recurly/resources/tier.rb +5 -1
- data/lib/recurly/resources/transaction.rb +4 -0
- data/lib/recurly/version.rb +1 -1
- data/openapi/api.yaml +297 -232
- data/scripts/build +2 -2
- data/scripts/format +2 -2
- data/scripts/prepare-release +43 -29
- data/scripts/release +5 -20
- metadata +12 -9
- data/.github_changelog_generator +0 -8
- data/scripts/bump +0 -11
- data/scripts/changelog +0 -14
data/CONTRIBUTING.md
CHANGED
@@ -7,6 +7,10 @@ however, we may not get to these right away. Although we try to be quick, our pr
|
|
7
7
|
writing code. If you want a timely response (especially if you have an emergency), we recommend
|
8
8
|
you contact our [official support team](https://support.recurly.com/).
|
9
9
|
|
10
|
+
## Code of Conduct
|
11
|
+
|
12
|
+
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
|
13
|
+
|
10
14
|
#### Table Of Contents
|
11
15
|
|
12
16
|
* [I don't want to read this whole thing, I just have a question!!!](#i-dont-want-to-read-this-whole-thing-i-just-have-a-question)
|
data/GETTING_STARTED.md
CHANGED
@@ -5,7 +5,7 @@ This repository houses the official ruby client for Recurly's V3 API.
|
|
5
5
|
In your Gemfile, add `recurly` as a dependency.
|
6
6
|
|
7
7
|
```ruby
|
8
|
-
gem 'recurly', '~> 4.
|
8
|
+
gem 'recurly', '~> 4.4'
|
9
9
|
```
|
10
10
|
|
11
11
|
> *Note*: We try to follow [semantic versioning](https://semver.org/) and will only apply breaking changes to major versions.
|
data/README.md
CHANGED
@@ -1,5 +1,8 @@
|
|
1
1
|
# Recurly
|
2
2
|
|
3
|
+
[![Rubygems](https://img.shields.io/static/v1?label=rubygems&message=recurly&color=purple)](https://rubygems.org/gems/recurly)
|
4
|
+
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
|
5
|
+
|
3
6
|
This repository houses the official ruby client for Recurly's V3 API.
|
4
7
|
|
5
8
|
> *Note*:
|
data/lib/recurly/client.rb
CHANGED
@@ -55,6 +55,8 @@ module Recurly
|
|
55
55
|
# @param api_key [String] The private API key
|
56
56
|
# @param logger [Logger] A logger to use. Defaults to creating a new STDOUT logger with level WARN.
|
57
57
|
def initialize(api_key:, logger: nil)
|
58
|
+
raise ArgumentError, "'api_key' must be set to a non-nil value" if api_key.nil?
|
59
|
+
|
58
60
|
set_api_key(api_key)
|
59
61
|
|
60
62
|
if logger.nil?
|
@@ -96,7 +98,7 @@ module Recurly
|
|
96
98
|
end
|
97
99
|
|
98
100
|
def head(path, **options)
|
99
|
-
validate_options!(options)
|
101
|
+
validate_options!(**options)
|
100
102
|
request = Net::HTTP::Head.new build_url(path, options)
|
101
103
|
set_headers(request, options[:headers])
|
102
104
|
http_response = run_request(request, options)
|
@@ -104,26 +106,28 @@ module Recurly
|
|
104
106
|
end
|
105
107
|
|
106
108
|
def get(path, **options)
|
107
|
-
validate_options!(options)
|
109
|
+
validate_options!(**options)
|
108
110
|
request = Net::HTTP::Get.new build_url(path, options)
|
109
111
|
set_headers(request, options[:headers])
|
110
112
|
http_response = run_request(request, options)
|
111
113
|
handle_response! request, http_response
|
112
114
|
end
|
113
115
|
|
114
|
-
def post(path, request_data, request_class, **options)
|
115
|
-
validate_options!(options)
|
116
|
-
request_class.new(request_data).validate!
|
116
|
+
def post(path, request_data = nil, request_class = nil, **options)
|
117
|
+
validate_options!(**options)
|
117
118
|
request = Net::HTTP::Post.new build_url(path, options)
|
118
119
|
request.set_content_type(JSON_CONTENT_TYPE)
|
119
120
|
set_headers(request, options[:headers])
|
120
|
-
|
121
|
+
if request_data
|
122
|
+
request_class.new(request_data).validate!
|
123
|
+
request.body = JSON.dump(request_data)
|
124
|
+
end
|
121
125
|
http_response = run_request(request, options)
|
122
126
|
handle_response! request, http_response
|
123
127
|
end
|
124
128
|
|
125
129
|
def put(path, request_data = nil, request_class = nil, **options)
|
126
|
-
validate_options!(options)
|
130
|
+
validate_options!(**options)
|
127
131
|
request = Net::HTTP::Put.new build_url(path, options)
|
128
132
|
request.set_content_type(JSON_CONTENT_TYPE)
|
129
133
|
set_headers(request, options[:headers])
|
@@ -137,7 +141,7 @@ module Recurly
|
|
137
141
|
end
|
138
142
|
|
139
143
|
def delete(path, **options)
|
140
|
-
validate_options!(options)
|
144
|
+
validate_options!(**options)
|
141
145
|
request = Net::HTTP::Delete.new build_url(path, options)
|
142
146
|
set_headers(request, options[:headers])
|
143
147
|
http_response = run_request(request, options)
|
@@ -205,7 +209,7 @@ module Recurly
|
|
205
209
|
end
|
206
210
|
|
207
211
|
raise Recurly::Errors::ConnectionFailedError, "Failed to connect to Recurly: #{ex.message}"
|
208
|
-
rescue
|
212
|
+
rescue Timeout::Error
|
209
213
|
raise Recurly::Errors::TimeoutError, "Request timed out"
|
210
214
|
rescue OpenSSL::SSL::SSLError => ex
|
211
215
|
raise Recurly::Errors::SSLError, ex.message
|
@@ -264,8 +268,13 @@ module Recurly
|
|
264
268
|
def raise_api_error!(http_response, response)
|
265
269
|
if response.content_type.include?(JSON_CONTENT_TYPE)
|
266
270
|
error = JSONParser.parse(self, response.body)
|
267
|
-
|
268
|
-
|
271
|
+
begin
|
272
|
+
error_class = Errors::APIError.error_class(error.type)
|
273
|
+
raise error_class.new(error.message, response, error)
|
274
|
+
rescue NameError
|
275
|
+
error_class = Errors::APIError.from_response(http_response)
|
276
|
+
raise error_class.new("Unknown Error", response, error)
|
277
|
+
end
|
269
278
|
end
|
270
279
|
|
271
280
|
error_class = Errors::APIError.from_response(http_response)
|
@@ -316,7 +325,7 @@ module Recurly
|
|
316
325
|
end
|
317
326
|
|
318
327
|
def interpolate_path(path, **options)
|
319
|
-
validate_path_parameters!(options)
|
328
|
+
validate_path_parameters!(**options)
|
320
329
|
options.each do |k, v|
|
321
330
|
# We need to encode the values for the url
|
322
331
|
options[k] = ERB::Util.url_encode(v.to_s)
|
@@ -326,7 +335,7 @@ module Recurly
|
|
326
335
|
end
|
327
336
|
|
328
337
|
def set_api_key(api_key)
|
329
|
-
@api_key = api_key
|
338
|
+
@api_key = api_key.to_s
|
330
339
|
end
|
331
340
|
|
332
341
|
def build_url(path, options)
|
@@ -348,7 +357,7 @@ module Recurly
|
|
348
357
|
end.to_h
|
349
358
|
end
|
350
359
|
|
351
|
-
def scope_by_site(path,
|
360
|
+
def scope_by_site(path, options)
|
352
361
|
if site = site_id || options[:site_id]
|
353
362
|
# Ensure that we are only including the site_id once because the Pager operations
|
354
363
|
# will use the cursor returned from the API which may already have these components
|
@@ -105,7 +105,6 @@ module Recurly
|
|
105
105
|
# +canceled+, or +future+ state.
|
106
106
|
#
|
107
107
|
# :past_due [String] Filter for accounts with an invoice in the +past_due+ state.
|
108
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
109
108
|
#
|
110
109
|
# @return [Pager<Resources::Account>] A list of the site's accounts.
|
111
110
|
# @example
|
@@ -118,7 +117,7 @@ module Recurly
|
|
118
117
|
# end
|
119
118
|
#
|
120
119
|
def list_accounts(**options)
|
121
|
-
path =
|
120
|
+
path = "/accounts"
|
122
121
|
pager(path, **options)
|
123
122
|
end
|
124
123
|
|
@@ -128,7 +127,6 @@ module Recurly
|
|
128
127
|
#
|
129
128
|
# @param body [Requests::AccountCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AccountCreate}
|
130
129
|
# @param params [Hash] Optional query string parameters:
|
131
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
132
130
|
#
|
133
131
|
# @return [Resources::Account] An account.
|
134
132
|
# @example
|
@@ -168,7 +166,7 @@ module Recurly
|
|
168
166
|
# end
|
169
167
|
#
|
170
168
|
def create_account(body:, **options)
|
171
|
-
path =
|
169
|
+
path = "/accounts"
|
172
170
|
post(path, body, Requests::AccountCreate, **options)
|
173
171
|
end
|
174
172
|
|
@@ -178,7 +176,6 @@ module Recurly
|
|
178
176
|
#
|
179
177
|
# @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+.
|
180
178
|
# @param params [Hash] Optional query string parameters:
|
181
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
182
179
|
#
|
183
180
|
# @return [Resources::Account] An account.
|
184
181
|
# @example
|
@@ -203,7 +200,6 @@ module Recurly
|
|
203
200
|
# @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+.
|
204
201
|
# @param body [Requests::AccountUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AccountUpdate}
|
205
202
|
# @param params [Hash] Optional query string parameters:
|
206
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
207
203
|
#
|
208
204
|
# @return [Resources::Account] An account.
|
209
205
|
# @example
|
@@ -234,7 +230,6 @@ module Recurly
|
|
234
230
|
#
|
235
231
|
# @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+.
|
236
232
|
# @param params [Hash] Optional query string parameters:
|
237
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
238
233
|
#
|
239
234
|
# @return [Resources::Account] An account.
|
240
235
|
# @example
|
@@ -258,7 +253,6 @@ module Recurly
|
|
258
253
|
#
|
259
254
|
# @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+.
|
260
255
|
# @param params [Hash] Optional query string parameters:
|
261
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
262
256
|
#
|
263
257
|
# @return [Resources::AccountAcquisition] An account's acquisition data.
|
264
258
|
# @example
|
@@ -283,7 +277,6 @@ module Recurly
|
|
283
277
|
# @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+.
|
284
278
|
# @param body [Requests::AccountAcquisitionUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AccountAcquisitionUpdate}
|
285
279
|
# @param params [Hash] Optional query string parameters:
|
286
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
287
280
|
#
|
288
281
|
# @return [Resources::AccountAcquisition] An account's updated acquisition data.
|
289
282
|
# @example
|
@@ -319,7 +312,6 @@ module Recurly
|
|
319
312
|
#
|
320
313
|
# @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+.
|
321
314
|
# @param params [Hash] Optional query string parameters:
|
322
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
323
315
|
#
|
324
316
|
# @return [Resources::Empty] Acquisition data was succesfully deleted.
|
325
317
|
# @example
|
@@ -343,7 +335,6 @@ module Recurly
|
|
343
335
|
#
|
344
336
|
# @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+.
|
345
337
|
# @param params [Hash] Optional query string parameters:
|
346
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
347
338
|
#
|
348
339
|
# @return [Resources::Account] An account.
|
349
340
|
# @example
|
@@ -367,7 +358,6 @@ module Recurly
|
|
367
358
|
#
|
368
359
|
# @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+.
|
369
360
|
# @param params [Hash] Optional query string parameters:
|
370
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
371
361
|
#
|
372
362
|
# @return [Resources::AccountBalance] An account's balance.
|
373
363
|
# @example
|
@@ -391,7 +381,6 @@ module Recurly
|
|
391
381
|
#
|
392
382
|
# @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+.
|
393
383
|
# @param params [Hash] Optional query string parameters:
|
394
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
395
384
|
#
|
396
385
|
# @return [Resources::BillingInfo] An account's billing information.
|
397
386
|
# @example
|
@@ -416,7 +405,6 @@ module Recurly
|
|
416
405
|
# @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+.
|
417
406
|
# @param body [Requests::BillingInfoCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoCreate}
|
418
407
|
# @param params [Hash] Optional query string parameters:
|
419
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
420
408
|
#
|
421
409
|
# @return [Resources::BillingInfo] Updated billing information.
|
422
410
|
# @example
|
@@ -447,7 +435,6 @@ module Recurly
|
|
447
435
|
#
|
448
436
|
# @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+.
|
449
437
|
# @param params [Hash] Optional query string parameters:
|
450
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
451
438
|
#
|
452
439
|
# @return [Resources::Empty] Billing information deleted
|
453
440
|
# @example
|
@@ -465,6 +452,30 @@ module Recurly
|
|
465
452
|
delete(path, **options)
|
466
453
|
end
|
467
454
|
|
455
|
+
# Verify an account's credit card billing information
|
456
|
+
#
|
457
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/verify_billing_info verify_billing_info api documenation}
|
458
|
+
#
|
459
|
+
# @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+.
|
460
|
+
# @param params [Hash] Optional query string parameters:
|
461
|
+
# :body [Requests::BillingInfoVerify] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoVerify}
|
462
|
+
#
|
463
|
+
# @return [Resources::Transaction] Transaction information from verify.
|
464
|
+
# @example
|
465
|
+
# begin
|
466
|
+
# transaction = @client.verify_billing_info(account_id: account_id)
|
467
|
+
# puts "Got Transaction #{transaction}"
|
468
|
+
# rescue Recurly::Errors::NotFoundError
|
469
|
+
# # If the resource was not found, you may want to alert the user or
|
470
|
+
# # just return nil
|
471
|
+
# puts "Resource Not Found"
|
472
|
+
# end
|
473
|
+
#
|
474
|
+
def verify_billing_info(account_id:, **options)
|
475
|
+
path = interpolate_path("/accounts/{account_id}/billing_info/verify", account_id: account_id)
|
476
|
+
post(path, options[:body], Requests::BillingInfoVerify, **options)
|
477
|
+
end
|
478
|
+
|
468
479
|
# Get the list of billing information associated with an account
|
469
480
|
#
|
470
481
|
# {https://developers.recurly.com/api/v2021-02-25#operation/list_billing_infos list_billing_infos api documenation}
|
@@ -493,7 +504,6 @@ module Recurly
|
|
493
504
|
# :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
|
494
505
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
495
506
|
#
|
496
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
497
507
|
#
|
498
508
|
# @return [Pager<Resources::BillingInfo>] A list of the the billing information for an account's
|
499
509
|
#
|
@@ -502,14 +512,13 @@ module Recurly
|
|
502
512
|
pager(path, **options)
|
503
513
|
end
|
504
514
|
|
505
|
-
#
|
515
|
+
# Add new billing information on an account
|
506
516
|
#
|
507
517
|
# {https://developers.recurly.com/api/v2021-02-25#operation/create_billing_info create_billing_info api documenation}
|
508
518
|
#
|
509
519
|
# @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+.
|
510
520
|
# @param body [Requests::BillingInfoCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoCreate}
|
511
521
|
# @param params [Hash] Optional query string parameters:
|
512
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
513
522
|
#
|
514
523
|
# @return [Resources::BillingInfo] Updated billing information.
|
515
524
|
#
|
@@ -525,7 +534,6 @@ module Recurly
|
|
525
534
|
# @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+.
|
526
535
|
# @param billing_info_id [String] Billing Info ID.
|
527
536
|
# @param params [Hash] Optional query string parameters:
|
528
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
529
537
|
#
|
530
538
|
# @return [Resources::BillingInfo] A billing info.
|
531
539
|
#
|
@@ -542,7 +550,6 @@ module Recurly
|
|
542
550
|
# @param billing_info_id [String] Billing Info ID.
|
543
551
|
# @param body [Requests::BillingInfoCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoCreate}
|
544
552
|
# @param params [Hash] Optional query string parameters:
|
545
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
546
553
|
#
|
547
554
|
# @return [Resources::BillingInfo] Updated billing information.
|
548
555
|
#
|
@@ -558,7 +565,6 @@ module Recurly
|
|
558
565
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
559
566
|
# @param billing_info_id [String] Billing Info ID.
|
560
567
|
# @param params [Hash] Optional query string parameters:
|
561
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
562
568
|
#
|
563
569
|
# @return [Resources::Empty] Billing information deleted
|
564
570
|
#
|
@@ -596,7 +602,6 @@ module Recurly
|
|
596
602
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
597
603
|
#
|
598
604
|
# :state [String] Filter by state.
|
599
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
600
605
|
#
|
601
606
|
# @return [Pager<Resources::CouponRedemption>] A list of the the coupon redemptions on an account.
|
602
607
|
# @example
|
@@ -622,7 +627,6 @@ module Recurly
|
|
622
627
|
#
|
623
628
|
# @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+.
|
624
629
|
# @param params [Hash] Optional query string parameters:
|
625
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
626
630
|
#
|
627
631
|
# @return [Pager<Resources::CouponRedemption>] Active coupon redemptions on an account.
|
628
632
|
# @example
|
@@ -646,7 +650,6 @@ module Recurly
|
|
646
650
|
# @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+.
|
647
651
|
# @param body [Requests::CouponRedemptionCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponRedemptionCreate}
|
648
652
|
# @param params [Hash] Optional query string parameters:
|
649
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
650
653
|
#
|
651
654
|
# @return [Resources::CouponRedemption] Returns the new coupon redemption.
|
652
655
|
# @example
|
@@ -677,7 +680,6 @@ module Recurly
|
|
677
680
|
#
|
678
681
|
# @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+.
|
679
682
|
# @param params [Hash] Optional query string parameters:
|
680
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
681
683
|
#
|
682
684
|
# @return [Resources::CouponRedemption] Coupon redemption deleted.
|
683
685
|
# @example
|
@@ -713,7 +715,6 @@ module Recurly
|
|
713
715
|
# :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
|
714
716
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
715
717
|
#
|
716
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
717
718
|
#
|
718
719
|
# @return [Pager<Resources::CreditPayment>] A list of the account's credit payments.
|
719
720
|
# @example
|
@@ -769,7 +770,6 @@ module Recurly
|
|
769
770
|
# - +type=non-legacy+, only charge and credit invoices will be returned.
|
770
771
|
# - +type=legacy+, only legacy invoices will be returned.
|
771
772
|
#
|
772
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
773
773
|
#
|
774
774
|
# @return [Pager<Resources::Invoice>] A list of the account's invoices.
|
775
775
|
# @example
|
@@ -796,7 +796,6 @@ module Recurly
|
|
796
796
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
797
797
|
# @param body [Requests::InvoiceCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceCreate}
|
798
798
|
# @param params [Hash] Optional query string parameters:
|
799
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
800
799
|
#
|
801
800
|
# @return [Resources::InvoiceCollection] Returns the new invoices.
|
802
801
|
# @example
|
@@ -828,7 +827,6 @@ module Recurly
|
|
828
827
|
# @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+.
|
829
828
|
# @param body [Requests::InvoiceCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceCreate}
|
830
829
|
# @param params [Hash] Optional query string parameters:
|
831
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
832
830
|
#
|
833
831
|
# @return [Resources::InvoiceCollection] Returns the invoice previews.
|
834
832
|
# @example
|
@@ -886,7 +884,6 @@ module Recurly
|
|
886
884
|
# :original [String] Filter by original field.
|
887
885
|
# :state [String] Filter by state field.
|
888
886
|
# :type [String] Filter by type field.
|
889
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
890
887
|
#
|
891
888
|
# @return [Pager<Resources::LineItem>] A list of the account's line items.
|
892
889
|
# @example
|
@@ -913,7 +910,6 @@ module Recurly
|
|
913
910
|
# @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+.
|
914
911
|
# @param body [Requests::LineItemCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::LineItemCreate}
|
915
912
|
# @param params [Hash] Optional query string parameters:
|
916
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
917
913
|
#
|
918
914
|
# @return [Resources::LineItem] Returns the new line item.
|
919
915
|
# @example
|
@@ -957,7 +953,6 @@ module Recurly
|
|
957
953
|
# * Records are returned in an arbitrary order. Since results are all
|
958
954
|
# returned at once you can sort the records yourself.
|
959
955
|
#
|
960
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
961
956
|
#
|
962
957
|
# @return [Pager<Resources::AccountNote>] A list of an account's notes.
|
963
958
|
# @example
|
@@ -981,7 +976,6 @@ module Recurly
|
|
981
976
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
982
977
|
# @param account_note_id [String] Account Note ID.
|
983
978
|
# @param params [Hash] Optional query string parameters:
|
984
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
985
979
|
#
|
986
980
|
# @return [Resources::AccountNote] An account note.
|
987
981
|
# @example
|
@@ -1032,7 +1026,6 @@ module Recurly
|
|
1032
1026
|
# :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
|
1033
1027
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
1034
1028
|
#
|
1035
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
1036
1029
|
#
|
1037
1030
|
# @return [Pager<Resources::ShippingAddress>] A list of an account's shipping addresses.
|
1038
1031
|
# @example
|
@@ -1059,7 +1052,6 @@ module Recurly
|
|
1059
1052
|
# @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+.
|
1060
1053
|
# @param body [Requests::ShippingAddressCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ShippingAddressCreate}
|
1061
1054
|
# @param params [Hash] Optional query string parameters:
|
1062
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
1063
1055
|
#
|
1064
1056
|
# @return [Resources::ShippingAddress] Returns the new shipping address.
|
1065
1057
|
# @example
|
@@ -1094,7 +1086,6 @@ module Recurly
|
|
1094
1086
|
# @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+.
|
1095
1087
|
# @param shipping_address_id [String] Shipping Address ID.
|
1096
1088
|
# @param params [Hash] Optional query string parameters:
|
1097
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
1098
1089
|
#
|
1099
1090
|
# @return [Resources::ShippingAddress] A shipping address.
|
1100
1091
|
# @example
|
@@ -1123,7 +1114,6 @@ module Recurly
|
|
1123
1114
|
# @param shipping_address_id [String] Shipping Address ID.
|
1124
1115
|
# @param body [Requests::ShippingAddressUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ShippingAddressUpdate}
|
1125
1116
|
# @param params [Hash] Optional query string parameters:
|
1126
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
1127
1117
|
#
|
1128
1118
|
# @return [Resources::ShippingAddress] The updated shipping address.
|
1129
1119
|
# @example
|
@@ -1157,7 +1147,6 @@ module Recurly
|
|
1157
1147
|
# @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+.
|
1158
1148
|
# @param shipping_address_id [String] Shipping Address ID.
|
1159
1149
|
# @param params [Hash] Optional query string parameters:
|
1160
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
1161
1150
|
#
|
1162
1151
|
# @return [Resources::Empty] Shipping address deleted.
|
1163
1152
|
# @example
|
@@ -1214,7 +1203,6 @@ module Recurly
|
|
1214
1203
|
# - 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.
|
1215
1204
|
# - When +state=live+, only subscriptions that are in an active, canceled, or future state or are in trial will be returned.
|
1216
1205
|
#
|
1217
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
1218
1206
|
#
|
1219
1207
|
# @return [Pager<Resources::Subscription>] A list of the account's subscriptions.
|
1220
1208
|
# @example
|
@@ -1266,7 +1254,6 @@ module Recurly
|
|
1266
1254
|
#
|
1267
1255
|
# :type [String] Filter by type field. The value +payment+ will return both +purchase+ and +capture+ transactions.
|
1268
1256
|
# :success [String] Filter by success field.
|
1269
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
1270
1257
|
#
|
1271
1258
|
# @return [Pager<Resources::Transaction>] A list of the account's transactions.
|
1272
1259
|
# @example
|
@@ -1321,7 +1308,6 @@ module Recurly
|
|
1321
1308
|
# +canceled+, or +future+ state.
|
1322
1309
|
#
|
1323
1310
|
# :past_due [String] Filter for accounts with an invoice in the +past_due+ state.
|
1324
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
1325
1311
|
#
|
1326
1312
|
# @return [Pager<Resources::Account>] A list of an account's child accounts.
|
1327
1313
|
# @example
|
@@ -1370,7 +1356,6 @@ module Recurly
|
|
1370
1356
|
# :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
|
1371
1357
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
1372
1358
|
#
|
1373
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
1374
1359
|
#
|
1375
1360
|
# @return [Pager<Resources::AccountAcquisition>] A list of the site's account acquisition data.
|
1376
1361
|
# @example
|
@@ -1383,7 +1368,7 @@ module Recurly
|
|
1383
1368
|
# end
|
1384
1369
|
#
|
1385
1370
|
def list_account_acquisition(**options)
|
1386
|
-
path =
|
1371
|
+
path = "/acquisitions"
|
1387
1372
|
pager(path, **options)
|
1388
1373
|
end
|
1389
1374
|
|
@@ -1416,7 +1401,6 @@ module Recurly
|
|
1416
1401
|
# :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
|
1417
1402
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
1418
1403
|
#
|
1419
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
1420
1404
|
#
|
1421
1405
|
# @return [Pager<Resources::Coupon>] A list of the site's coupons.
|
1422
1406
|
# @example
|
@@ -1429,7 +1413,7 @@ module Recurly
|
|
1429
1413
|
# end
|
1430
1414
|
#
|
1431
1415
|
def list_coupons(**options)
|
1432
|
-
path =
|
1416
|
+
path = "/coupons"
|
1433
1417
|
pager(path, **options)
|
1434
1418
|
end
|
1435
1419
|
|
@@ -1439,7 +1423,6 @@ module Recurly
|
|
1439
1423
|
#
|
1440
1424
|
# @param body [Requests::CouponCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponCreate}
|
1441
1425
|
# @param params [Hash] Optional query string parameters:
|
1442
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
1443
1426
|
#
|
1444
1427
|
# @return [Resources::Coupon] A new coupon.
|
1445
1428
|
# @example
|
@@ -1466,7 +1449,7 @@ module Recurly
|
|
1466
1449
|
# end
|
1467
1450
|
#
|
1468
1451
|
def create_coupon(body:, **options)
|
1469
|
-
path =
|
1452
|
+
path = "/coupons"
|
1470
1453
|
post(path, body, Requests::CouponCreate, **options)
|
1471
1454
|
end
|
1472
1455
|
|
@@ -1476,7 +1459,6 @@ module Recurly
|
|
1476
1459
|
#
|
1477
1460
|
# @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+.
|
1478
1461
|
# @param params [Hash] Optional query string parameters:
|
1479
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
1480
1462
|
#
|
1481
1463
|
# @return [Resources::Coupon] A coupon.
|
1482
1464
|
# @example
|
@@ -1501,7 +1483,6 @@ module Recurly
|
|
1501
1483
|
# @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+.
|
1502
1484
|
# @param body [Requests::CouponUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponUpdate}
|
1503
1485
|
# @param params [Hash] Optional query string parameters:
|
1504
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
1505
1486
|
#
|
1506
1487
|
# @return [Resources::Coupon] The updated coupon.
|
1507
1488
|
# @example
|
@@ -1528,7 +1509,6 @@ module Recurly
|
|
1528
1509
|
#
|
1529
1510
|
# @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+.
|
1530
1511
|
# @param params [Hash] Optional query string parameters:
|
1531
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
1532
1512
|
#
|
1533
1513
|
# @return [Resources::Coupon] The expired Coupon
|
1534
1514
|
# @example
|
@@ -1553,7 +1533,6 @@ module Recurly
|
|
1553
1533
|
# @param coupon_id [String] Coupon ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-10off+.
|
1554
1534
|
# @param body [Requests::CouponBulkCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponBulkCreate}
|
1555
1535
|
# @param params [Hash] Optional query string parameters:
|
1556
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
1557
1536
|
#
|
1558
1537
|
# @return [Resources::UniqueCouponCodeParams] A set of parameters that can be passed to the `list_unique_coupon_codes` endpoint to obtain only the newly generated `UniqueCouponCodes`.
|
1559
1538
|
#
|
@@ -1569,7 +1548,6 @@ module Recurly
|
|
1569
1548
|
# @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+.
|
1570
1549
|
# @param body [Requests::CouponUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponUpdate}
|
1571
1550
|
# @param params [Hash] Optional query string parameters:
|
1572
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
1573
1551
|
#
|
1574
1552
|
# @return [Resources::Coupon] The restored coupon.
|
1575
1553
|
#
|
@@ -1608,7 +1586,6 @@ module Recurly
|
|
1608
1586
|
# :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
|
1609
1587
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
1610
1588
|
#
|
1611
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
1612
1589
|
#
|
1613
1590
|
# @return [Pager<Resources::UniqueCouponCode>] A list of unique coupon codes that were generated
|
1614
1591
|
#
|
@@ -1634,7 +1611,6 @@ module Recurly
|
|
1634
1611
|
# :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
|
1635
1612
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
1636
1613
|
#
|
1637
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
1638
1614
|
#
|
1639
1615
|
# @return [Pager<Resources::CreditPayment>] A list of the site's credit payments.
|
1640
1616
|
# @example
|
@@ -1647,7 +1623,7 @@ module Recurly
|
|
1647
1623
|
# end
|
1648
1624
|
#
|
1649
1625
|
def list_credit_payments(**options)
|
1650
|
-
path =
|
1626
|
+
path = "/credit_payments"
|
1651
1627
|
pager(path, **options)
|
1652
1628
|
end
|
1653
1629
|
|
@@ -1657,7 +1633,6 @@ module Recurly
|
|
1657
1633
|
#
|
1658
1634
|
# @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+.
|
1659
1635
|
# @param params [Hash] Optional query string parameters:
|
1660
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
1661
1636
|
#
|
1662
1637
|
# @return [Resources::CreditPayment] A credit payment.
|
1663
1638
|
#
|
@@ -1696,7 +1671,6 @@ module Recurly
|
|
1696
1671
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
1697
1672
|
#
|
1698
1673
|
# :related_type [String] Filter by related type.
|
1699
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
1700
1674
|
#
|
1701
1675
|
# @return [Pager<Resources::CustomFieldDefinition>] A list of the site's custom field definitions.
|
1702
1676
|
# @example
|
@@ -1709,7 +1683,7 @@ module Recurly
|
|
1709
1683
|
# end
|
1710
1684
|
#
|
1711
1685
|
def list_custom_field_definitions(**options)
|
1712
|
-
path =
|
1686
|
+
path = "/custom_field_definitions"
|
1713
1687
|
pager(path, **options)
|
1714
1688
|
end
|
1715
1689
|
|
@@ -1719,7 +1693,6 @@ module Recurly
|
|
1719
1693
|
#
|
1720
1694
|
# @param custom_field_definition_id [String] Custom Field Definition ID
|
1721
1695
|
# @param params [Hash] Optional query string parameters:
|
1722
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
1723
1696
|
#
|
1724
1697
|
# @return [Resources::CustomFieldDefinition] An custom field definition.
|
1725
1698
|
# @example
|
@@ -1769,7 +1742,6 @@ module Recurly
|
|
1769
1742
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
1770
1743
|
#
|
1771
1744
|
# :state [String] Filter by state.
|
1772
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
1773
1745
|
#
|
1774
1746
|
# @return [Pager<Resources::Item>] A list of the site's items.
|
1775
1747
|
# @example
|
@@ -1782,7 +1754,7 @@ module Recurly
|
|
1782
1754
|
# end
|
1783
1755
|
#
|
1784
1756
|
def list_items(**options)
|
1785
|
-
path =
|
1757
|
+
path = "/items"
|
1786
1758
|
pager(path, **options)
|
1787
1759
|
end
|
1788
1760
|
|
@@ -1792,7 +1764,6 @@ module Recurly
|
|
1792
1764
|
#
|
1793
1765
|
# @param body [Requests::ItemCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ItemCreate}
|
1794
1766
|
# @param params [Hash] Optional query string parameters:
|
1795
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
1796
1767
|
#
|
1797
1768
|
# @return [Resources::Item] A new item.
|
1798
1769
|
# @example
|
@@ -1818,7 +1789,7 @@ module Recurly
|
|
1818
1789
|
# end
|
1819
1790
|
#
|
1820
1791
|
def create_item(body:, **options)
|
1821
|
-
path =
|
1792
|
+
path = "/items"
|
1822
1793
|
post(path, body, Requests::ItemCreate, **options)
|
1823
1794
|
end
|
1824
1795
|
|
@@ -1828,7 +1799,6 @@ module Recurly
|
|
1828
1799
|
#
|
1829
1800
|
# @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+.
|
1830
1801
|
# @param params [Hash] Optional query string parameters:
|
1831
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
1832
1802
|
#
|
1833
1803
|
# @return [Resources::Item] An item.
|
1834
1804
|
# @example
|
@@ -1853,7 +1823,6 @@ module Recurly
|
|
1853
1823
|
# @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+.
|
1854
1824
|
# @param body [Requests::ItemUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ItemUpdate}
|
1855
1825
|
# @param params [Hash] Optional query string parameters:
|
1856
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
1857
1826
|
#
|
1858
1827
|
# @return [Resources::Item] The updated item.
|
1859
1828
|
# @example
|
@@ -1884,7 +1853,6 @@ module Recurly
|
|
1884
1853
|
#
|
1885
1854
|
# @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+.
|
1886
1855
|
# @param params [Hash] Optional query string parameters:
|
1887
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
1888
1856
|
#
|
1889
1857
|
# @return [Resources::Item] An item.
|
1890
1858
|
# @example
|
@@ -1908,7 +1876,6 @@ module Recurly
|
|
1908
1876
|
#
|
1909
1877
|
# @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+.
|
1910
1878
|
# @param params [Hash] Optional query string parameters:
|
1911
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
1912
1879
|
#
|
1913
1880
|
# @return [Resources::Item] An item.
|
1914
1881
|
# @example
|
@@ -1956,12 +1923,11 @@ module Recurly
|
|
1956
1923
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
1957
1924
|
#
|
1958
1925
|
# :state [String] Filter by state.
|
1959
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
1960
1926
|
#
|
1961
1927
|
# @return [Pager<Resources::MeasuredUnit>] A list of the site's measured units.
|
1962
1928
|
#
|
1963
1929
|
def list_measured_unit(**options)
|
1964
|
-
path =
|
1930
|
+
path = "/measured_units"
|
1965
1931
|
pager(path, **options)
|
1966
1932
|
end
|
1967
1933
|
|
@@ -1971,12 +1937,11 @@ module Recurly
|
|
1971
1937
|
#
|
1972
1938
|
# @param body [Requests::MeasuredUnitCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::MeasuredUnitCreate}
|
1973
1939
|
# @param params [Hash] Optional query string parameters:
|
1974
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
1975
1940
|
#
|
1976
1941
|
# @return [Resources::MeasuredUnit] A new measured unit.
|
1977
1942
|
#
|
1978
1943
|
def create_measured_unit(body:, **options)
|
1979
|
-
path =
|
1944
|
+
path = "/measured_units"
|
1980
1945
|
post(path, body, Requests::MeasuredUnitCreate, **options)
|
1981
1946
|
end
|
1982
1947
|
|
@@ -1986,7 +1951,6 @@ module Recurly
|
|
1986
1951
|
#
|
1987
1952
|
# @param measured_unit_id [String] Measured unit ID or name. For ID no prefix is used e.g. +e28zov4fw0v2+. For name use prefix +name-+, e.g. +name-Storage+.
|
1988
1953
|
# @param params [Hash] Optional query string parameters:
|
1989
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
1990
1954
|
#
|
1991
1955
|
# @return [Resources::MeasuredUnit] An item.
|
1992
1956
|
#
|
@@ -2002,7 +1966,6 @@ module Recurly
|
|
2002
1966
|
# @param measured_unit_id [String] Measured unit ID or name. For ID no prefix is used e.g. +e28zov4fw0v2+. For name use prefix +name-+, e.g. +name-Storage+.
|
2003
1967
|
# @param body [Requests::MeasuredUnitUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::MeasuredUnitUpdate}
|
2004
1968
|
# @param params [Hash] Optional query string parameters:
|
2005
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2006
1969
|
#
|
2007
1970
|
# @return [Resources::MeasuredUnit] The updated measured_unit.
|
2008
1971
|
#
|
@@ -2017,7 +1980,6 @@ module Recurly
|
|
2017
1980
|
#
|
2018
1981
|
# @param measured_unit_id [String] Measured unit ID or name. For ID no prefix is used e.g. +e28zov4fw0v2+. For name use prefix +name-+, e.g. +name-Storage+.
|
2019
1982
|
# @param params [Hash] Optional query string parameters:
|
2020
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2021
1983
|
#
|
2022
1984
|
# @return [Resources::MeasuredUnit] A measured unit.
|
2023
1985
|
#
|
@@ -2061,7 +2023,6 @@ module Recurly
|
|
2061
2023
|
# - +type=non-legacy+, only charge and credit invoices will be returned.
|
2062
2024
|
# - +type=legacy+, only legacy invoices will be returned.
|
2063
2025
|
#
|
2064
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2065
2026
|
#
|
2066
2027
|
# @return [Pager<Resources::Invoice>] A list of the site's invoices.
|
2067
2028
|
# @example
|
@@ -2074,7 +2035,7 @@ module Recurly
|
|
2074
2035
|
# end
|
2075
2036
|
#
|
2076
2037
|
def list_invoices(**options)
|
2077
|
-
path =
|
2038
|
+
path = "/invoices"
|
2078
2039
|
pager(path, **options)
|
2079
2040
|
end
|
2080
2041
|
|
@@ -2084,7 +2045,6 @@ module Recurly
|
|
2084
2045
|
#
|
2085
2046
|
# @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+.
|
2086
2047
|
# @param params [Hash] Optional query string parameters:
|
2087
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2088
2048
|
#
|
2089
2049
|
# @return [Resources::Invoice] An invoice.
|
2090
2050
|
# @example
|
@@ -2109,7 +2069,6 @@ module Recurly
|
|
2109
2069
|
# @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+.
|
2110
2070
|
# @param body [Requests::InvoiceUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceUpdate}
|
2111
2071
|
# @param params [Hash] Optional query string parameters:
|
2112
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2113
2072
|
#
|
2114
2073
|
# @return [Resources::Invoice] An invoice.
|
2115
2074
|
# @example
|
@@ -2137,7 +2096,6 @@ module Recurly
|
|
2137
2096
|
#
|
2138
2097
|
# @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+.
|
2139
2098
|
# @param params [Hash] Optional query string parameters:
|
2140
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2141
2099
|
#
|
2142
2100
|
# @return [Resources::BinaryFile] An invoice as a PDF.
|
2143
2101
|
# @example
|
@@ -2165,7 +2123,6 @@ module Recurly
|
|
2165
2123
|
# @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+.
|
2166
2124
|
# @param params [Hash] Optional query string parameters:
|
2167
2125
|
# :body [Requests::InvoiceCollect] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceCollect}
|
2168
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2169
2126
|
#
|
2170
2127
|
# @return [Resources::Invoice] The updated invoice.
|
2171
2128
|
# @example
|
@@ -2189,7 +2146,6 @@ module Recurly
|
|
2189
2146
|
#
|
2190
2147
|
# @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+.
|
2191
2148
|
# @param params [Hash] Optional query string parameters:
|
2192
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2193
2149
|
#
|
2194
2150
|
# @return [Resources::Invoice] The updated invoice.
|
2195
2151
|
# @example
|
@@ -2213,7 +2169,6 @@ module Recurly
|
|
2213
2169
|
#
|
2214
2170
|
# @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+.
|
2215
2171
|
# @param params [Hash] Optional query string parameters:
|
2216
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2217
2172
|
#
|
2218
2173
|
# @return [Resources::Invoice] The updated invoice.
|
2219
2174
|
# @example
|
@@ -2237,7 +2192,6 @@ module Recurly
|
|
2237
2192
|
#
|
2238
2193
|
# @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+.
|
2239
2194
|
# @param params [Hash] Optional query string parameters:
|
2240
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2241
2195
|
#
|
2242
2196
|
# @return [Resources::Invoice] The updated invoice.
|
2243
2197
|
# @example
|
@@ -2261,7 +2215,6 @@ module Recurly
|
|
2261
2215
|
#
|
2262
2216
|
# @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+.
|
2263
2217
|
# @param params [Hash] Optional query string parameters:
|
2264
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2265
2218
|
#
|
2266
2219
|
# @return [Resources::Invoice] The updated invoice.
|
2267
2220
|
# @example
|
@@ -2286,7 +2239,6 @@ module Recurly
|
|
2286
2239
|
# @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+.
|
2287
2240
|
# @param body [Requests::ExternalTransaction] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ExternalTransaction}
|
2288
2241
|
# @param params [Hash] Optional query string parameters:
|
2289
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2290
2242
|
#
|
2291
2243
|
# @return [Resources::Transaction] The recorded transaction.
|
2292
2244
|
#
|
@@ -2328,7 +2280,6 @@ module Recurly
|
|
2328
2280
|
# :original [String] Filter by original field.
|
2329
2281
|
# :state [String] Filter by state field.
|
2330
2282
|
# :type [String] Filter by type field.
|
2331
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2332
2283
|
#
|
2333
2284
|
# @return [Pager<Resources::LineItem>] A list of the invoice's line items.
|
2334
2285
|
# @example
|
@@ -2376,7 +2327,6 @@ module Recurly
|
|
2376
2327
|
# :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
|
2377
2328
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
2378
2329
|
#
|
2379
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2380
2330
|
#
|
2381
2331
|
# @return [Pager<Resources::CouponRedemption>] A list of the the coupon redemptions associated with the invoice.
|
2382
2332
|
# @example
|
@@ -2402,7 +2352,6 @@ module Recurly
|
|
2402
2352
|
#
|
2403
2353
|
# @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+.
|
2404
2354
|
# @param params [Hash] Optional query string parameters:
|
2405
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2406
2355
|
#
|
2407
2356
|
# @return [Pager<Resources::Invoice>] A list of the credit or charge invoices associated with the invoice.
|
2408
2357
|
# @example
|
@@ -2429,7 +2378,6 @@ module Recurly
|
|
2429
2378
|
# @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+.
|
2430
2379
|
# @param body [Requests::InvoiceRefund] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceRefund}
|
2431
2380
|
# @param params [Hash] Optional query string parameters:
|
2432
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2433
2381
|
#
|
2434
2382
|
# @return [Resources::Invoice] Returns the new credit invoice.
|
2435
2383
|
# @example
|
@@ -2486,7 +2434,6 @@ module Recurly
|
|
2486
2434
|
# :original [String] Filter by original field.
|
2487
2435
|
# :state [String] Filter by state field.
|
2488
2436
|
# :type [String] Filter by type field.
|
2489
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2490
2437
|
#
|
2491
2438
|
# @return [Pager<Resources::LineItem>] A list of the site's line items.
|
2492
2439
|
# @example
|
@@ -2501,7 +2448,7 @@ module Recurly
|
|
2501
2448
|
# end
|
2502
2449
|
#
|
2503
2450
|
def list_line_items(**options)
|
2504
|
-
path =
|
2451
|
+
path = "/line_items"
|
2505
2452
|
pager(path, **options)
|
2506
2453
|
end
|
2507
2454
|
|
@@ -2511,7 +2458,6 @@ module Recurly
|
|
2511
2458
|
#
|
2512
2459
|
# @param line_item_id [String] Line Item ID.
|
2513
2460
|
# @param params [Hash] Optional query string parameters:
|
2514
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2515
2461
|
#
|
2516
2462
|
# @return [Resources::LineItem] A line item.
|
2517
2463
|
# @example
|
@@ -2535,7 +2481,6 @@ module Recurly
|
|
2535
2481
|
#
|
2536
2482
|
# @param line_item_id [String] Line Item ID.
|
2537
2483
|
# @param params [Hash] Optional query string parameters:
|
2538
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2539
2484
|
#
|
2540
2485
|
# @return [Resources::Empty] Line item deleted.
|
2541
2486
|
# @example
|
@@ -2585,7 +2530,6 @@ module Recurly
|
|
2585
2530
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
2586
2531
|
#
|
2587
2532
|
# :state [String] Filter by state.
|
2588
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2589
2533
|
#
|
2590
2534
|
# @return [Pager<Resources::Plan>] A list of plans.
|
2591
2535
|
# @example
|
@@ -2598,7 +2542,7 @@ module Recurly
|
|
2598
2542
|
# end
|
2599
2543
|
#
|
2600
2544
|
def list_plans(**options)
|
2601
|
-
path =
|
2545
|
+
path = "/plans"
|
2602
2546
|
pager(path, **options)
|
2603
2547
|
end
|
2604
2548
|
|
@@ -2608,7 +2552,6 @@ module Recurly
|
|
2608
2552
|
#
|
2609
2553
|
# @param body [Requests::PlanCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PlanCreate}
|
2610
2554
|
# @param params [Hash] Optional query string parameters:
|
2611
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2612
2555
|
#
|
2613
2556
|
# @return [Resources::Plan] A plan.
|
2614
2557
|
# @example
|
@@ -2639,7 +2582,7 @@ module Recurly
|
|
2639
2582
|
# end
|
2640
2583
|
#
|
2641
2584
|
def create_plan(body:, **options)
|
2642
|
-
path =
|
2585
|
+
path = "/plans"
|
2643
2586
|
post(path, body, Requests::PlanCreate, **options)
|
2644
2587
|
end
|
2645
2588
|
|
@@ -2649,7 +2592,6 @@ module Recurly
|
|
2649
2592
|
#
|
2650
2593
|
# @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+.
|
2651
2594
|
# @param params [Hash] Optional query string parameters:
|
2652
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2653
2595
|
#
|
2654
2596
|
# @return [Resources::Plan] A plan.
|
2655
2597
|
# @example
|
@@ -2674,7 +2616,6 @@ module Recurly
|
|
2674
2616
|
# @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+.
|
2675
2617
|
# @param body [Requests::PlanUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PlanUpdate}
|
2676
2618
|
# @param params [Hash] Optional query string parameters:
|
2677
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2678
2619
|
#
|
2679
2620
|
# @return [Resources::Plan] A plan.
|
2680
2621
|
# @example
|
@@ -2701,7 +2642,6 @@ module Recurly
|
|
2701
2642
|
#
|
2702
2643
|
# @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+.
|
2703
2644
|
# @param params [Hash] Optional query string parameters:
|
2704
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2705
2645
|
#
|
2706
2646
|
# @return [Resources::Plan] Plan deleted
|
2707
2647
|
# @example
|
@@ -2750,7 +2690,6 @@ module Recurly
|
|
2750
2690
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
2751
2691
|
#
|
2752
2692
|
# :state [String] Filter by state.
|
2753
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2754
2693
|
#
|
2755
2694
|
# @return [Pager<Resources::AddOn>] A list of add-ons.
|
2756
2695
|
# @example
|
@@ -2777,7 +2716,6 @@ module Recurly
|
|
2777
2716
|
# @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+.
|
2778
2717
|
# @param body [Requests::AddOnCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AddOnCreate}
|
2779
2718
|
# @param params [Hash] Optional query string parameters:
|
2780
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2781
2719
|
#
|
2782
2720
|
# @return [Resources::AddOn] An add-on.
|
2783
2721
|
# @example
|
@@ -2813,7 +2751,6 @@ module Recurly
|
|
2813
2751
|
# @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+.
|
2814
2752
|
# @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+.
|
2815
2753
|
# @param params [Hash] Optional query string parameters:
|
2816
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2817
2754
|
#
|
2818
2755
|
# @return [Resources::AddOn] An add-on.
|
2819
2756
|
# @example
|
@@ -2841,7 +2778,6 @@ module Recurly
|
|
2841
2778
|
# @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+.
|
2842
2779
|
# @param body [Requests::AddOnUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AddOnUpdate}
|
2843
2780
|
# @param params [Hash] Optional query string parameters:
|
2844
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2845
2781
|
#
|
2846
2782
|
# @return [Resources::AddOn] An add-on.
|
2847
2783
|
# @example
|
@@ -2873,7 +2809,6 @@ module Recurly
|
|
2873
2809
|
# @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+.
|
2874
2810
|
# @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+.
|
2875
2811
|
# @param params [Hash] Optional query string parameters:
|
2876
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2877
2812
|
#
|
2878
2813
|
# @return [Resources::AddOn] Add-on deleted
|
2879
2814
|
# @example
|
@@ -2924,7 +2859,6 @@ module Recurly
|
|
2924
2859
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
2925
2860
|
#
|
2926
2861
|
# :state [String] Filter by state.
|
2927
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2928
2862
|
#
|
2929
2863
|
# @return [Pager<Resources::AddOn>] A list of add-ons.
|
2930
2864
|
# @example
|
@@ -2939,7 +2873,7 @@ module Recurly
|
|
2939
2873
|
# end
|
2940
2874
|
#
|
2941
2875
|
def list_add_ons(**options)
|
2942
|
-
path =
|
2876
|
+
path = "/add_ons"
|
2943
2877
|
pager(path, **options)
|
2944
2878
|
end
|
2945
2879
|
|
@@ -2949,7 +2883,6 @@ module Recurly
|
|
2949
2883
|
#
|
2950
2884
|
# @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+.
|
2951
2885
|
# @param params [Hash] Optional query string parameters:
|
2952
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2953
2886
|
#
|
2954
2887
|
# @return [Resources::AddOn] An add-on.
|
2955
2888
|
# @example
|
@@ -2996,7 +2929,6 @@ module Recurly
|
|
2996
2929
|
# :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
|
2997
2930
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
2998
2931
|
#
|
2999
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3000
2932
|
#
|
3001
2933
|
# @return [Pager<Resources::ShippingMethod>] A list of the site's shipping methods.
|
3002
2934
|
# @example
|
@@ -3011,7 +2943,7 @@ module Recurly
|
|
3011
2943
|
# end
|
3012
2944
|
#
|
3013
2945
|
def list_shipping_methods(**options)
|
3014
|
-
path =
|
2946
|
+
path = "/shipping_methods"
|
3015
2947
|
pager(path, **options)
|
3016
2948
|
end
|
3017
2949
|
|
@@ -3021,12 +2953,11 @@ module Recurly
|
|
3021
2953
|
#
|
3022
2954
|
# @param body [Requests::ShippingMethodCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ShippingMethodCreate}
|
3023
2955
|
# @param params [Hash] Optional query string parameters:
|
3024
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3025
2956
|
#
|
3026
2957
|
# @return [Resources::ShippingMethod] A new shipping method.
|
3027
2958
|
#
|
3028
2959
|
def create_shipping_method(body:, **options)
|
3029
|
-
path =
|
2960
|
+
path = "/shipping_methods"
|
3030
2961
|
post(path, body, Requests::ShippingMethodCreate, **options)
|
3031
2962
|
end
|
3032
2963
|
|
@@ -3036,7 +2967,6 @@ module Recurly
|
|
3036
2967
|
#
|
3037
2968
|
# @param shipping_method_id [String] Shipping Method ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-usps_2-day+.
|
3038
2969
|
# @param params [Hash] Optional query string parameters:
|
3039
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3040
2970
|
#
|
3041
2971
|
# @return [Resources::ShippingMethod] A shipping method.
|
3042
2972
|
#
|
@@ -3052,7 +2982,6 @@ module Recurly
|
|
3052
2982
|
# @param shipping_method_id [String] Shipping Method ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-usps_2-day+.
|
3053
2983
|
# @param body [Requests::ShippingMethodUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ShippingMethodUpdate}
|
3054
2984
|
# @param params [Hash] Optional query string parameters:
|
3055
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3056
2985
|
#
|
3057
2986
|
# @return [Resources::ShippingMethod] The updated shipping method.
|
3058
2987
|
#
|
@@ -3067,7 +2996,6 @@ module Recurly
|
|
3067
2996
|
#
|
3068
2997
|
# @param shipping_method_id [String] Shipping Method ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-usps_2-day+.
|
3069
2998
|
# @param params [Hash] Optional query string parameters:
|
3070
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3071
2999
|
#
|
3072
3000
|
# @return [Resources::ShippingMethod] A shipping method.
|
3073
3001
|
#
|
@@ -3111,7 +3039,6 @@ module Recurly
|
|
3111
3039
|
# - 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.
|
3112
3040
|
# - When +state=live+, only subscriptions that are in an active, canceled, or future state or are in trial will be returned.
|
3113
3041
|
#
|
3114
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3115
3042
|
#
|
3116
3043
|
# @return [Pager<Resources::Subscription>] A list of the site's subscriptions.
|
3117
3044
|
# @example
|
@@ -3124,7 +3051,7 @@ module Recurly
|
|
3124
3051
|
# end
|
3125
3052
|
#
|
3126
3053
|
def list_subscriptions(**options)
|
3127
|
-
path =
|
3054
|
+
path = "/subscriptions"
|
3128
3055
|
pager(path, **options)
|
3129
3056
|
end
|
3130
3057
|
|
@@ -3134,7 +3061,6 @@ module Recurly
|
|
3134
3061
|
#
|
3135
3062
|
# @param body [Requests::SubscriptionCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionCreate}
|
3136
3063
|
# @param params [Hash] Optional query string parameters:
|
3137
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3138
3064
|
#
|
3139
3065
|
# @return [Resources::Subscription] A subscription.
|
3140
3066
|
# @example
|
@@ -3142,8 +3068,7 @@ module Recurly
|
|
3142
3068
|
# subscription_create = {
|
3143
3069
|
# plan_code: plan_code,
|
3144
3070
|
# currency: "USD",
|
3145
|
-
# # This can be an existing account or
|
3146
|
-
# # a new acocunt
|
3071
|
+
# # This can be an existing account or a new account
|
3147
3072
|
# account: {
|
3148
3073
|
# code: account_code,
|
3149
3074
|
# }
|
@@ -3159,7 +3084,7 @@ module Recurly
|
|
3159
3084
|
# end
|
3160
3085
|
#
|
3161
3086
|
def create_subscription(body:, **options)
|
3162
|
-
path =
|
3087
|
+
path = "/subscriptions"
|
3163
3088
|
post(path, body, Requests::SubscriptionCreate, **options)
|
3164
3089
|
end
|
3165
3090
|
|
@@ -3169,7 +3094,6 @@ module Recurly
|
|
3169
3094
|
#
|
3170
3095
|
# @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+.
|
3171
3096
|
# @param params [Hash] Optional query string parameters:
|
3172
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3173
3097
|
#
|
3174
3098
|
# @return [Resources::Subscription] A subscription.
|
3175
3099
|
# @example
|
@@ -3196,7 +3120,6 @@ module Recurly
|
|
3196
3120
|
# @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+.
|
3197
3121
|
# @param body [Requests::SubscriptionUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionUpdate}
|
3198
3122
|
# @param params [Hash] Optional query string parameters:
|
3199
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3200
3123
|
#
|
3201
3124
|
# @return [Resources::Subscription] A subscription.
|
3202
3125
|
# @example
|
@@ -3238,7 +3161,6 @@ module Recurly
|
|
3238
3161
|
# You may also terminate a subscription with no refund and then manually refund specific invoices.
|
3239
3162
|
#
|
3240
3163
|
# :charge [Boolean] Applicable only if the subscription has usage based add-ons and unbilled usage logged for the current billing cycle. If true, current billing cycle unbilled usage is billed on the final invoice. If false, Recurly will create a negative usage record for current billing cycle usage that will zero out the final invoice line items.
|
3241
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3242
3164
|
#
|
3243
3165
|
# @return [Resources::Subscription] An expired subscription.
|
3244
3166
|
# @example
|
@@ -3265,7 +3187,6 @@ module Recurly
|
|
3265
3187
|
# @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+.
|
3266
3188
|
# @param params [Hash] Optional query string parameters:
|
3267
3189
|
# :body [Requests::SubscriptionCancel] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionCancel}
|
3268
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3269
3190
|
#
|
3270
3191
|
# @return [Resources::Subscription] A canceled or failed subscription.
|
3271
3192
|
# @example
|
@@ -3291,7 +3212,6 @@ module Recurly
|
|
3291
3212
|
#
|
3292
3213
|
# @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+.
|
3293
3214
|
# @param params [Hash] Optional query string parameters:
|
3294
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3295
3215
|
#
|
3296
3216
|
# @return [Resources::Subscription] An active subscription.
|
3297
3217
|
# @example
|
@@ -3318,7 +3238,6 @@ module Recurly
|
|
3318
3238
|
# @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
|
3319
3239
|
# @param body [Requests::SubscriptionPause] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionPause}
|
3320
3240
|
# @param params [Hash] Optional query string parameters:
|
3321
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3322
3241
|
#
|
3323
3242
|
# @return [Resources::Subscription] A subscription.
|
3324
3243
|
# @example
|
@@ -3348,7 +3267,6 @@ module Recurly
|
|
3348
3267
|
#
|
3349
3268
|
# @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+.
|
3350
3269
|
# @param params [Hash] Optional query string parameters:
|
3351
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3352
3270
|
#
|
3353
3271
|
# @return [Resources::Subscription] A subscription.
|
3354
3272
|
# @example
|
@@ -3374,7 +3292,6 @@ module Recurly
|
|
3374
3292
|
#
|
3375
3293
|
# @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+.
|
3376
3294
|
# @param params [Hash] Optional query string parameters:
|
3377
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3378
3295
|
#
|
3379
3296
|
# @return [Resources::Subscription] A subscription.
|
3380
3297
|
#
|
@@ -3389,7 +3306,6 @@ module Recurly
|
|
3389
3306
|
#
|
3390
3307
|
# @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+.
|
3391
3308
|
# @param params [Hash] Optional query string parameters:
|
3392
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3393
3309
|
#
|
3394
3310
|
# @return [Resources::SubscriptionChange] A subscription's pending change.
|
3395
3311
|
# @example
|
@@ -3416,7 +3332,6 @@ module Recurly
|
|
3416
3332
|
# @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+.
|
3417
3333
|
# @param body [Requests::SubscriptionChangeCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionChangeCreate}
|
3418
3334
|
# @param params [Hash] Optional query string parameters:
|
3419
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3420
3335
|
#
|
3421
3336
|
# @return [Resources::SubscriptionChange] A subscription change.
|
3422
3337
|
# @example
|
@@ -3447,7 +3362,6 @@ module Recurly
|
|
3447
3362
|
#
|
3448
3363
|
# @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+.
|
3449
3364
|
# @param params [Hash] Optional query string parameters:
|
3450
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3451
3365
|
#
|
3452
3366
|
# @return [Resources::Empty] Subscription change was deleted.
|
3453
3367
|
# @example
|
@@ -3474,7 +3388,6 @@ module Recurly
|
|
3474
3388
|
# @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+.
|
3475
3389
|
# @param body [Requests::SubscriptionChangeCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionChangeCreate}
|
3476
3390
|
# @param params [Hash] Optional query string parameters:
|
3477
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3478
3391
|
#
|
3479
3392
|
# @return [Resources::SubscriptionChange] A subscription change.
|
3480
3393
|
#
|
@@ -3519,7 +3432,6 @@ module Recurly
|
|
3519
3432
|
# - +type=non-legacy+, only charge and credit invoices will be returned.
|
3520
3433
|
# - +type=legacy+, only legacy invoices will be returned.
|
3521
3434
|
#
|
3522
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3523
3435
|
#
|
3524
3436
|
# @return [Pager<Resources::Invoice>] A list of the subscription's invoices.
|
3525
3437
|
# @example
|
@@ -3572,7 +3484,6 @@ module Recurly
|
|
3572
3484
|
# :original [String] Filter by original field.
|
3573
3485
|
# :state [String] Filter by state field.
|
3574
3486
|
# :type [String] Filter by type field.
|
3575
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3576
3487
|
#
|
3577
3488
|
# @return [Pager<Resources::LineItem>] A list of the subscription's line items.
|
3578
3489
|
# @example
|
@@ -3620,7 +3531,6 @@ module Recurly
|
|
3620
3531
|
# :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
|
3621
3532
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
3622
3533
|
#
|
3623
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3624
3534
|
#
|
3625
3535
|
# @return [Pager<Resources::CouponRedemption>] A list of the the coupon redemptions on a subscription.
|
3626
3536
|
# @example
|
@@ -3672,7 +3582,6 @@ module Recurly
|
|
3672
3582
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
3673
3583
|
#
|
3674
3584
|
# :billing_status [String] Filter by usage record's billing status
|
3675
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3676
3585
|
#
|
3677
3586
|
# @return [Pager<Resources::Usage>] A list of the subscription add-on's usage records.
|
3678
3587
|
#
|
@@ -3689,7 +3598,6 @@ module Recurly
|
|
3689
3598
|
# @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+.
|
3690
3599
|
# @param body [Requests::UsageCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::UsageCreate}
|
3691
3600
|
# @param params [Hash] Optional query string parameters:
|
3692
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3693
3601
|
#
|
3694
3602
|
# @return [Resources::Usage] The created usage record.
|
3695
3603
|
#
|
@@ -3704,7 +3612,6 @@ module Recurly
|
|
3704
3612
|
#
|
3705
3613
|
# @param usage_id [String] Usage Record ID.
|
3706
3614
|
# @param params [Hash] Optional query string parameters:
|
3707
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3708
3615
|
#
|
3709
3616
|
# @return [Resources::Usage] The usage record.
|
3710
3617
|
#
|
@@ -3720,7 +3627,6 @@ module Recurly
|
|
3720
3627
|
# @param usage_id [String] Usage Record ID.
|
3721
3628
|
# @param body [Requests::UsageCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::UsageCreate}
|
3722
3629
|
# @param params [Hash] Optional query string parameters:
|
3723
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3724
3630
|
#
|
3725
3631
|
# @return [Resources::Usage] The updated usage record.
|
3726
3632
|
#
|
@@ -3735,7 +3641,6 @@ module Recurly
|
|
3735
3641
|
#
|
3736
3642
|
# @param usage_id [String] Usage Record ID.
|
3737
3643
|
# @param params [Hash] Optional query string parameters:
|
3738
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3739
3644
|
#
|
3740
3645
|
# @return [Resources::Empty] Usage was successfully deleted.
|
3741
3646
|
#
|
@@ -3775,7 +3680,6 @@ module Recurly
|
|
3775
3680
|
#
|
3776
3681
|
# :type [String] Filter by type field. The value +payment+ will return both +purchase+ and +capture+ transactions.
|
3777
3682
|
# :success [String] Filter by success field.
|
3778
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3779
3683
|
#
|
3780
3684
|
# @return [Pager<Resources::Transaction>] A list of the site's transactions.
|
3781
3685
|
# @example
|
@@ -3788,7 +3692,7 @@ module Recurly
|
|
3788
3692
|
# end
|
3789
3693
|
#
|
3790
3694
|
def list_transactions(**options)
|
3791
|
-
path =
|
3695
|
+
path = "/transactions"
|
3792
3696
|
pager(path, **options)
|
3793
3697
|
end
|
3794
3698
|
|
@@ -3798,7 +3702,6 @@ module Recurly
|
|
3798
3702
|
#
|
3799
3703
|
# @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+.
|
3800
3704
|
# @param params [Hash] Optional query string parameters:
|
3801
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3802
3705
|
#
|
3803
3706
|
# @return [Resources::Transaction] A transaction.
|
3804
3707
|
# @example
|
@@ -3822,7 +3725,6 @@ module Recurly
|
|
3822
3725
|
#
|
3823
3726
|
# @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+.
|
3824
3727
|
# @param params [Hash] Optional query string parameters:
|
3825
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3826
3728
|
#
|
3827
3729
|
# @return [Resources::UniqueCouponCode] A unique coupon code.
|
3828
3730
|
#
|
@@ -3837,7 +3739,6 @@ module Recurly
|
|
3837
3739
|
#
|
3838
3740
|
# @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+.
|
3839
3741
|
# @param params [Hash] Optional query string parameters:
|
3840
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3841
3742
|
#
|
3842
3743
|
# @return [Resources::UniqueCouponCode] A unique coupon code.
|
3843
3744
|
#
|
@@ -3852,7 +3753,6 @@ module Recurly
|
|
3852
3753
|
#
|
3853
3754
|
# @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+.
|
3854
3755
|
# @param params [Hash] Optional query string parameters:
|
3855
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3856
3756
|
#
|
3857
3757
|
# @return [Resources::UniqueCouponCode] A unique coupon code.
|
3858
3758
|
#
|
@@ -3867,7 +3767,6 @@ module Recurly
|
|
3867
3767
|
#
|
3868
3768
|
# @param body [Requests::PurchaseCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PurchaseCreate}
|
3869
3769
|
# @param params [Hash] Optional query string parameters:
|
3870
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3871
3770
|
#
|
3872
3771
|
# @return [Resources::InvoiceCollection] Returns the new invoices
|
3873
3772
|
# @example
|
@@ -3898,7 +3797,7 @@ module Recurly
|
|
3898
3797
|
# end
|
3899
3798
|
#
|
3900
3799
|
def create_purchase(body:, **options)
|
3901
|
-
path =
|
3800
|
+
path = "/purchases"
|
3902
3801
|
post(path, body, Requests::PurchaseCreate, **options)
|
3903
3802
|
end
|
3904
3803
|
|
@@ -3908,7 +3807,6 @@ module Recurly
|
|
3908
3807
|
#
|
3909
3808
|
# @param body [Requests::PurchaseCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PurchaseCreate}
|
3910
3809
|
# @param params [Hash] Optional query string parameters:
|
3911
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3912
3810
|
#
|
3913
3811
|
# @return [Resources::InvoiceCollection] Returns preview of the new invoices
|
3914
3812
|
# @example
|
@@ -3939,7 +3837,7 @@ module Recurly
|
|
3939
3837
|
# end
|
3940
3838
|
#
|
3941
3839
|
def preview_purchase(body:, **options)
|
3942
|
-
path =
|
3840
|
+
path = "/purchases/preview"
|
3943
3841
|
post(path, body, Requests::PurchaseCreate, **options)
|
3944
3842
|
end
|
3945
3843
|
|
@@ -3948,7 +3846,6 @@ module Recurly
|
|
3948
3846
|
# {https://developers.recurly.com/api/v2021-02-25#operation/get_export_dates get_export_dates api documenation}
|
3949
3847
|
#
|
3950
3848
|
# @param params [Hash] Optional query string parameters:
|
3951
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3952
3849
|
#
|
3953
3850
|
# @return [Resources::ExportDates] Returns a list of dates.
|
3954
3851
|
# @example
|
@@ -3964,7 +3861,7 @@ module Recurly
|
|
3964
3861
|
# end
|
3965
3862
|
#
|
3966
3863
|
def get_export_dates(**options)
|
3967
|
-
path =
|
3864
|
+
path = "/export_dates"
|
3968
3865
|
get(path, **options)
|
3969
3866
|
end
|
3970
3867
|
|
@@ -3974,7 +3871,6 @@ module Recurly
|
|
3974
3871
|
#
|
3975
3872
|
# @param export_date [String] Date for which to get a list of available automated export files. Date must be in YYYY-MM-DD format.
|
3976
3873
|
# @param params [Hash] Optional query string parameters:
|
3977
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3978
3874
|
#
|
3979
3875
|
# @return [Resources::ExportFiles] Returns a list of export files to download.
|
3980
3876
|
# @example
|