recurly 4.1.0 → 4.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.bumpversion.cfg +1 -1
- data/.github/workflows/docs.yml +1 -1
- data/CHANGELOG.md +11 -0
- data/GETTING_STARTED.md +1 -1
- data/lib/recurly/client/operations.rb +24 -151
- data/lib/recurly/requests/subscription_add_on_tier.rb +6 -2
- data/lib/recurly/resources/subscription_add_on_tier.rb +6 -2
- data/lib/recurly/version.rb +1 -1
- data/openapi/api.yaml +11 -133
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 86a12242c76e7a5797ceb93597b6042871b5b6b27d6fd8f5dd193ae2ef198a59
|
4
|
+
data.tar.gz: 3f254d1aec8ee0f487c701e3db0835feae00878bbd4342b38d1fb5f7e46a9bf0
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4998b18d4434ea368beb5d145e531ba593b694782fb76a43f14b9735fb55f70780e5b92978ec951cea9e4b8ffa38675bb1228c7d099a29771bc8c56aa1d96693
|
7
|
+
data.tar.gz: bcb489bdb2ef9f1f7abdbe0d321ab7d42343dae8df66aac610eb652de005c829c90193126c782b4dc5604cf4ae0e8632b0e262e172124c95d84c7f914b3558d7
|
data/.bumpversion.cfg
CHANGED
data/.github/workflows/docs.yml
CHANGED
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,16 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## [4.2.0](https://github.com/recurly/recurly-client-ruby/tree/4.2.0) (2021-04-21)
|
4
|
+
|
5
|
+
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.1.0...4.2.0)
|
6
|
+
|
7
|
+
|
8
|
+
**Merged Pull Requests**
|
9
|
+
|
10
|
+
- Generated Latest Changes for v2021-02-25 [#695](https://github.com/recurly/recurly-client-ruby/pull/695) ([recurly-integrations](https://github.com/recurly-integrations))
|
11
|
+
|
12
|
+
|
13
|
+
|
3
14
|
## [4.1.0](https://github.com/recurly/recurly-client-ruby/tree/4.1.0) (2021-04-14)
|
4
15
|
|
5
16
|
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.0.1...4.1.0)
|
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.2'
|
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.
|
@@ -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
|
@@ -493,7 +480,6 @@ module Recurly
|
|
493
480
|
# :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
|
494
481
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
495
482
|
#
|
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
483
|
#
|
498
484
|
# @return [Pager<Resources::BillingInfo>] A list of the the billing information for an account's
|
499
485
|
#
|
@@ -509,7 +495,6 @@ module Recurly
|
|
509
495
|
# @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
496
|
# @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
497
|
# @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
498
|
#
|
514
499
|
# @return [Resources::BillingInfo] Updated billing information.
|
515
500
|
#
|
@@ -525,7 +510,6 @@ module Recurly
|
|
525
510
|
# @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
511
|
# @param billing_info_id [String] Billing Info ID.
|
527
512
|
# @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
513
|
#
|
530
514
|
# @return [Resources::BillingInfo] A billing info.
|
531
515
|
#
|
@@ -542,7 +526,6 @@ module Recurly
|
|
542
526
|
# @param billing_info_id [String] Billing Info ID.
|
543
527
|
# @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
528
|
# @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
529
|
#
|
547
530
|
# @return [Resources::BillingInfo] Updated billing information.
|
548
531
|
#
|
@@ -558,7 +541,6 @@ module Recurly
|
|
558
541
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
559
542
|
# @param billing_info_id [String] Billing Info ID.
|
560
543
|
# @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
544
|
#
|
563
545
|
# @return [Resources::Empty] Billing information deleted
|
564
546
|
#
|
@@ -596,7 +578,6 @@ module Recurly
|
|
596
578
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
597
579
|
#
|
598
580
|
# :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
581
|
#
|
601
582
|
# @return [Pager<Resources::CouponRedemption>] A list of the the coupon redemptions on an account.
|
602
583
|
# @example
|
@@ -622,7 +603,6 @@ module Recurly
|
|
622
603
|
#
|
623
604
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
624
605
|
# @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
606
|
#
|
627
607
|
# @return [Pager<Resources::CouponRedemption>] Active coupon redemptions on an account.
|
628
608
|
# @example
|
@@ -646,7 +626,6 @@ module Recurly
|
|
646
626
|
# @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
627
|
# @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
628
|
# @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
629
|
#
|
651
630
|
# @return [Resources::CouponRedemption] Returns the new coupon redemption.
|
652
631
|
# @example
|
@@ -677,7 +656,6 @@ module Recurly
|
|
677
656
|
#
|
678
657
|
# @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
658
|
# @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
659
|
#
|
682
660
|
# @return [Resources::CouponRedemption] Coupon redemption deleted.
|
683
661
|
# @example
|
@@ -713,7 +691,6 @@ module Recurly
|
|
713
691
|
# :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
|
714
692
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
715
693
|
#
|
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
694
|
#
|
718
695
|
# @return [Pager<Resources::CreditPayment>] A list of the account's credit payments.
|
719
696
|
# @example
|
@@ -769,7 +746,6 @@ module Recurly
|
|
769
746
|
# - +type=non-legacy+, only charge and credit invoices will be returned.
|
770
747
|
# - +type=legacy+, only legacy invoices will be returned.
|
771
748
|
#
|
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
749
|
#
|
774
750
|
# @return [Pager<Resources::Invoice>] A list of the account's invoices.
|
775
751
|
# @example
|
@@ -796,7 +772,6 @@ module Recurly
|
|
796
772
|
# @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
773
|
# @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
774
|
# @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
775
|
#
|
801
776
|
# @return [Resources::InvoiceCollection] Returns the new invoices.
|
802
777
|
# @example
|
@@ -828,7 +803,6 @@ module Recurly
|
|
828
803
|
# @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
804
|
# @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
805
|
# @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
806
|
#
|
833
807
|
# @return [Resources::InvoiceCollection] Returns the invoice previews.
|
834
808
|
# @example
|
@@ -886,7 +860,6 @@ module Recurly
|
|
886
860
|
# :original [String] Filter by original field.
|
887
861
|
# :state [String] Filter by state field.
|
888
862
|
# :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
863
|
#
|
891
864
|
# @return [Pager<Resources::LineItem>] A list of the account's line items.
|
892
865
|
# @example
|
@@ -913,7 +886,6 @@ module Recurly
|
|
913
886
|
# @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
887
|
# @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
888
|
# @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
889
|
#
|
918
890
|
# @return [Resources::LineItem] Returns the new line item.
|
919
891
|
# @example
|
@@ -957,7 +929,6 @@ module Recurly
|
|
957
929
|
# * Records are returned in an arbitrary order. Since results are all
|
958
930
|
# returned at once you can sort the records yourself.
|
959
931
|
#
|
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
932
|
#
|
962
933
|
# @return [Pager<Resources::AccountNote>] A list of an account's notes.
|
963
934
|
# @example
|
@@ -981,7 +952,6 @@ module Recurly
|
|
981
952
|
# @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
953
|
# @param account_note_id [String] Account Note ID.
|
983
954
|
# @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
955
|
#
|
986
956
|
# @return [Resources::AccountNote] An account note.
|
987
957
|
# @example
|
@@ -1032,7 +1002,6 @@ module Recurly
|
|
1032
1002
|
# :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
|
1033
1003
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
1034
1004
|
#
|
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
1005
|
#
|
1037
1006
|
# @return [Pager<Resources::ShippingAddress>] A list of an account's shipping addresses.
|
1038
1007
|
# @example
|
@@ -1059,7 +1028,6 @@ module Recurly
|
|
1059
1028
|
# @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
1029
|
# @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
1030
|
# @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
1031
|
#
|
1064
1032
|
# @return [Resources::ShippingAddress] Returns the new shipping address.
|
1065
1033
|
# @example
|
@@ -1094,7 +1062,6 @@ module Recurly
|
|
1094
1062
|
# @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
1063
|
# @param shipping_address_id [String] Shipping Address ID.
|
1096
1064
|
# @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
1065
|
#
|
1099
1066
|
# @return [Resources::ShippingAddress] A shipping address.
|
1100
1067
|
# @example
|
@@ -1123,7 +1090,6 @@ module Recurly
|
|
1123
1090
|
# @param shipping_address_id [String] Shipping Address ID.
|
1124
1091
|
# @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
1092
|
# @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
1093
|
#
|
1128
1094
|
# @return [Resources::ShippingAddress] The updated shipping address.
|
1129
1095
|
# @example
|
@@ -1157,7 +1123,6 @@ module Recurly
|
|
1157
1123
|
# @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
1124
|
# @param shipping_address_id [String] Shipping Address ID.
|
1159
1125
|
# @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
1126
|
#
|
1162
1127
|
# @return [Resources::Empty] Shipping address deleted.
|
1163
1128
|
# @example
|
@@ -1214,7 +1179,6 @@ module Recurly
|
|
1214
1179
|
# - 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
1180
|
# - When +state=live+, only subscriptions that are in an active, canceled, or future state or are in trial will be returned.
|
1216
1181
|
#
|
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
1182
|
#
|
1219
1183
|
# @return [Pager<Resources::Subscription>] A list of the account's subscriptions.
|
1220
1184
|
# @example
|
@@ -1266,7 +1230,6 @@ module Recurly
|
|
1266
1230
|
#
|
1267
1231
|
# :type [String] Filter by type field. The value +payment+ will return both +purchase+ and +capture+ transactions.
|
1268
1232
|
# :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
1233
|
#
|
1271
1234
|
# @return [Pager<Resources::Transaction>] A list of the account's transactions.
|
1272
1235
|
# @example
|
@@ -1321,7 +1284,6 @@ module Recurly
|
|
1321
1284
|
# +canceled+, or +future+ state.
|
1322
1285
|
#
|
1323
1286
|
# :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
1287
|
#
|
1326
1288
|
# @return [Pager<Resources::Account>] A list of an account's child accounts.
|
1327
1289
|
# @example
|
@@ -1370,7 +1332,6 @@ module Recurly
|
|
1370
1332
|
# :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
|
1371
1333
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
1372
1334
|
#
|
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
1335
|
#
|
1375
1336
|
# @return [Pager<Resources::AccountAcquisition>] A list of the site's account acquisition data.
|
1376
1337
|
# @example
|
@@ -1383,7 +1344,7 @@ module Recurly
|
|
1383
1344
|
# end
|
1384
1345
|
#
|
1385
1346
|
def list_account_acquisition(**options)
|
1386
|
-
path =
|
1347
|
+
path = "/acquisitions"
|
1387
1348
|
pager(path, **options)
|
1388
1349
|
end
|
1389
1350
|
|
@@ -1416,7 +1377,6 @@ module Recurly
|
|
1416
1377
|
# :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
|
1417
1378
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
1418
1379
|
#
|
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
1380
|
#
|
1421
1381
|
# @return [Pager<Resources::Coupon>] A list of the site's coupons.
|
1422
1382
|
# @example
|
@@ -1429,7 +1389,7 @@ module Recurly
|
|
1429
1389
|
# end
|
1430
1390
|
#
|
1431
1391
|
def list_coupons(**options)
|
1432
|
-
path =
|
1392
|
+
path = "/coupons"
|
1433
1393
|
pager(path, **options)
|
1434
1394
|
end
|
1435
1395
|
|
@@ -1439,7 +1399,6 @@ module Recurly
|
|
1439
1399
|
#
|
1440
1400
|
# @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
1401
|
# @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
1402
|
#
|
1444
1403
|
# @return [Resources::Coupon] A new coupon.
|
1445
1404
|
# @example
|
@@ -1466,7 +1425,7 @@ module Recurly
|
|
1466
1425
|
# end
|
1467
1426
|
#
|
1468
1427
|
def create_coupon(body:, **options)
|
1469
|
-
path =
|
1428
|
+
path = "/coupons"
|
1470
1429
|
post(path, body, Requests::CouponCreate, **options)
|
1471
1430
|
end
|
1472
1431
|
|
@@ -1476,7 +1435,6 @@ module Recurly
|
|
1476
1435
|
#
|
1477
1436
|
# @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
1437
|
# @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
1438
|
#
|
1481
1439
|
# @return [Resources::Coupon] A coupon.
|
1482
1440
|
# @example
|
@@ -1501,7 +1459,6 @@ module Recurly
|
|
1501
1459
|
# @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
1460
|
# @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
1461
|
# @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
1462
|
#
|
1506
1463
|
# @return [Resources::Coupon] The updated coupon.
|
1507
1464
|
# @example
|
@@ -1528,7 +1485,6 @@ module Recurly
|
|
1528
1485
|
#
|
1529
1486
|
# @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
1487
|
# @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
1488
|
#
|
1533
1489
|
# @return [Resources::Coupon] The expired Coupon
|
1534
1490
|
# @example
|
@@ -1553,7 +1509,6 @@ module Recurly
|
|
1553
1509
|
# @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
1510
|
# @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
1511
|
# @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
1512
|
#
|
1558
1513
|
# @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
1514
|
#
|
@@ -1569,7 +1524,6 @@ module Recurly
|
|
1569
1524
|
# @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
1525
|
# @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
1526
|
# @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
1527
|
#
|
1574
1528
|
# @return [Resources::Coupon] The restored coupon.
|
1575
1529
|
#
|
@@ -1608,7 +1562,6 @@ module Recurly
|
|
1608
1562
|
# :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
|
1609
1563
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
1610
1564
|
#
|
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
1565
|
#
|
1613
1566
|
# @return [Pager<Resources::UniqueCouponCode>] A list of unique coupon codes that were generated
|
1614
1567
|
#
|
@@ -1634,7 +1587,6 @@ module Recurly
|
|
1634
1587
|
# :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
|
1635
1588
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
1636
1589
|
#
|
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
1590
|
#
|
1639
1591
|
# @return [Pager<Resources::CreditPayment>] A list of the site's credit payments.
|
1640
1592
|
# @example
|
@@ -1647,7 +1599,7 @@ module Recurly
|
|
1647
1599
|
# end
|
1648
1600
|
#
|
1649
1601
|
def list_credit_payments(**options)
|
1650
|
-
path =
|
1602
|
+
path = "/credit_payments"
|
1651
1603
|
pager(path, **options)
|
1652
1604
|
end
|
1653
1605
|
|
@@ -1657,7 +1609,6 @@ module Recurly
|
|
1657
1609
|
#
|
1658
1610
|
# @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
1611
|
# @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
1612
|
#
|
1662
1613
|
# @return [Resources::CreditPayment] A credit payment.
|
1663
1614
|
#
|
@@ -1696,7 +1647,6 @@ module Recurly
|
|
1696
1647
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
1697
1648
|
#
|
1698
1649
|
# :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
1650
|
#
|
1701
1651
|
# @return [Pager<Resources::CustomFieldDefinition>] A list of the site's custom field definitions.
|
1702
1652
|
# @example
|
@@ -1709,7 +1659,7 @@ module Recurly
|
|
1709
1659
|
# end
|
1710
1660
|
#
|
1711
1661
|
def list_custom_field_definitions(**options)
|
1712
|
-
path =
|
1662
|
+
path = "/custom_field_definitions"
|
1713
1663
|
pager(path, **options)
|
1714
1664
|
end
|
1715
1665
|
|
@@ -1719,7 +1669,6 @@ module Recurly
|
|
1719
1669
|
#
|
1720
1670
|
# @param custom_field_definition_id [String] Custom Field Definition ID
|
1721
1671
|
# @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
1672
|
#
|
1724
1673
|
# @return [Resources::CustomFieldDefinition] An custom field definition.
|
1725
1674
|
# @example
|
@@ -1769,7 +1718,6 @@ module Recurly
|
|
1769
1718
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
1770
1719
|
#
|
1771
1720
|
# :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
1721
|
#
|
1774
1722
|
# @return [Pager<Resources::Item>] A list of the site's items.
|
1775
1723
|
# @example
|
@@ -1782,7 +1730,7 @@ module Recurly
|
|
1782
1730
|
# end
|
1783
1731
|
#
|
1784
1732
|
def list_items(**options)
|
1785
|
-
path =
|
1733
|
+
path = "/items"
|
1786
1734
|
pager(path, **options)
|
1787
1735
|
end
|
1788
1736
|
|
@@ -1792,7 +1740,6 @@ module Recurly
|
|
1792
1740
|
#
|
1793
1741
|
# @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
1742
|
# @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
1743
|
#
|
1797
1744
|
# @return [Resources::Item] A new item.
|
1798
1745
|
# @example
|
@@ -1818,7 +1765,7 @@ module Recurly
|
|
1818
1765
|
# end
|
1819
1766
|
#
|
1820
1767
|
def create_item(body:, **options)
|
1821
|
-
path =
|
1768
|
+
path = "/items"
|
1822
1769
|
post(path, body, Requests::ItemCreate, **options)
|
1823
1770
|
end
|
1824
1771
|
|
@@ -1828,7 +1775,6 @@ module Recurly
|
|
1828
1775
|
#
|
1829
1776
|
# @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
1777
|
# @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
1778
|
#
|
1833
1779
|
# @return [Resources::Item] An item.
|
1834
1780
|
# @example
|
@@ -1853,7 +1799,6 @@ module Recurly
|
|
1853
1799
|
# @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
1800
|
# @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
1801
|
# @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
1802
|
#
|
1858
1803
|
# @return [Resources::Item] The updated item.
|
1859
1804
|
# @example
|
@@ -1884,7 +1829,6 @@ module Recurly
|
|
1884
1829
|
#
|
1885
1830
|
# @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
1831
|
# @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
1832
|
#
|
1889
1833
|
# @return [Resources::Item] An item.
|
1890
1834
|
# @example
|
@@ -1908,7 +1852,6 @@ module Recurly
|
|
1908
1852
|
#
|
1909
1853
|
# @param item_id [String] Item ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-red+.
|
1910
1854
|
# @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
1855
|
#
|
1913
1856
|
# @return [Resources::Item] An item.
|
1914
1857
|
# @example
|
@@ -1956,12 +1899,11 @@ module Recurly
|
|
1956
1899
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
1957
1900
|
#
|
1958
1901
|
# :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
1902
|
#
|
1961
1903
|
# @return [Pager<Resources::MeasuredUnit>] A list of the site's measured units.
|
1962
1904
|
#
|
1963
1905
|
def list_measured_unit(**options)
|
1964
|
-
path =
|
1906
|
+
path = "/measured_units"
|
1965
1907
|
pager(path, **options)
|
1966
1908
|
end
|
1967
1909
|
|
@@ -1971,12 +1913,11 @@ module Recurly
|
|
1971
1913
|
#
|
1972
1914
|
# @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
1915
|
# @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
1916
|
#
|
1976
1917
|
# @return [Resources::MeasuredUnit] A new measured unit.
|
1977
1918
|
#
|
1978
1919
|
def create_measured_unit(body:, **options)
|
1979
|
-
path =
|
1920
|
+
path = "/measured_units"
|
1980
1921
|
post(path, body, Requests::MeasuredUnitCreate, **options)
|
1981
1922
|
end
|
1982
1923
|
|
@@ -1986,7 +1927,6 @@ module Recurly
|
|
1986
1927
|
#
|
1987
1928
|
# @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
1929
|
# @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
1930
|
#
|
1991
1931
|
# @return [Resources::MeasuredUnit] An item.
|
1992
1932
|
#
|
@@ -2002,7 +1942,6 @@ module Recurly
|
|
2002
1942
|
# @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
1943
|
# @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
1944
|
# @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
1945
|
#
|
2007
1946
|
# @return [Resources::MeasuredUnit] The updated measured_unit.
|
2008
1947
|
#
|
@@ -2017,7 +1956,6 @@ module Recurly
|
|
2017
1956
|
#
|
2018
1957
|
# @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
1958
|
# @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
1959
|
#
|
2022
1960
|
# @return [Resources::MeasuredUnit] A measured unit.
|
2023
1961
|
#
|
@@ -2061,7 +1999,6 @@ module Recurly
|
|
2061
1999
|
# - +type=non-legacy+, only charge and credit invoices will be returned.
|
2062
2000
|
# - +type=legacy+, only legacy invoices will be returned.
|
2063
2001
|
#
|
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
2002
|
#
|
2066
2003
|
# @return [Pager<Resources::Invoice>] A list of the site's invoices.
|
2067
2004
|
# @example
|
@@ -2074,7 +2011,7 @@ module Recurly
|
|
2074
2011
|
# end
|
2075
2012
|
#
|
2076
2013
|
def list_invoices(**options)
|
2077
|
-
path =
|
2014
|
+
path = "/invoices"
|
2078
2015
|
pager(path, **options)
|
2079
2016
|
end
|
2080
2017
|
|
@@ -2084,7 +2021,6 @@ module Recurly
|
|
2084
2021
|
#
|
2085
2022
|
# @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
2023
|
# @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
2024
|
#
|
2089
2025
|
# @return [Resources::Invoice] An invoice.
|
2090
2026
|
# @example
|
@@ -2109,7 +2045,6 @@ module Recurly
|
|
2109
2045
|
# @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
2046
|
# @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
2047
|
# @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
2048
|
#
|
2114
2049
|
# @return [Resources::Invoice] An invoice.
|
2115
2050
|
# @example
|
@@ -2137,7 +2072,6 @@ module Recurly
|
|
2137
2072
|
#
|
2138
2073
|
# @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
2074
|
# @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
2075
|
#
|
2142
2076
|
# @return [Resources::BinaryFile] An invoice as a PDF.
|
2143
2077
|
# @example
|
@@ -2165,7 +2099,6 @@ module Recurly
|
|
2165
2099
|
# @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
2100
|
# @param params [Hash] Optional query string parameters:
|
2167
2101
|
# :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
2102
|
#
|
2170
2103
|
# @return [Resources::Invoice] The updated invoice.
|
2171
2104
|
# @example
|
@@ -2189,7 +2122,6 @@ module Recurly
|
|
2189
2122
|
#
|
2190
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+.
|
2191
2124
|
# @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
2125
|
#
|
2194
2126
|
# @return [Resources::Invoice] The updated invoice.
|
2195
2127
|
# @example
|
@@ -2213,7 +2145,6 @@ module Recurly
|
|
2213
2145
|
#
|
2214
2146
|
# @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
2147
|
# @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
2148
|
#
|
2218
2149
|
# @return [Resources::Invoice] The updated invoice.
|
2219
2150
|
# @example
|
@@ -2237,7 +2168,6 @@ module Recurly
|
|
2237
2168
|
#
|
2238
2169
|
# @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
2170
|
# @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
2171
|
#
|
2242
2172
|
# @return [Resources::Invoice] The updated invoice.
|
2243
2173
|
# @example
|
@@ -2261,7 +2191,6 @@ module Recurly
|
|
2261
2191
|
#
|
2262
2192
|
# @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
2193
|
# @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
2194
|
#
|
2266
2195
|
# @return [Resources::Invoice] The updated invoice.
|
2267
2196
|
# @example
|
@@ -2286,7 +2215,6 @@ module Recurly
|
|
2286
2215
|
# @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
2216
|
# @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
2217
|
# @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
2218
|
#
|
2291
2219
|
# @return [Resources::Transaction] The recorded transaction.
|
2292
2220
|
#
|
@@ -2328,7 +2256,6 @@ module Recurly
|
|
2328
2256
|
# :original [String] Filter by original field.
|
2329
2257
|
# :state [String] Filter by state field.
|
2330
2258
|
# :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
2259
|
#
|
2333
2260
|
# @return [Pager<Resources::LineItem>] A list of the invoice's line items.
|
2334
2261
|
# @example
|
@@ -2376,7 +2303,6 @@ module Recurly
|
|
2376
2303
|
# :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
|
2377
2304
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
2378
2305
|
#
|
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
2306
|
#
|
2381
2307
|
# @return [Pager<Resources::CouponRedemption>] A list of the the coupon redemptions associated with the invoice.
|
2382
2308
|
# @example
|
@@ -2402,7 +2328,6 @@ module Recurly
|
|
2402
2328
|
#
|
2403
2329
|
# @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
2330
|
# @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
2331
|
#
|
2407
2332
|
# @return [Pager<Resources::Invoice>] A list of the credit or charge invoices associated with the invoice.
|
2408
2333
|
# @example
|
@@ -2429,7 +2354,6 @@ module Recurly
|
|
2429
2354
|
# @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
2355
|
# @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
2356
|
# @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
2357
|
#
|
2434
2358
|
# @return [Resources::Invoice] Returns the new credit invoice.
|
2435
2359
|
# @example
|
@@ -2486,7 +2410,6 @@ module Recurly
|
|
2486
2410
|
# :original [String] Filter by original field.
|
2487
2411
|
# :state [String] Filter by state field.
|
2488
2412
|
# :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
2413
|
#
|
2491
2414
|
# @return [Pager<Resources::LineItem>] A list of the site's line items.
|
2492
2415
|
# @example
|
@@ -2501,7 +2424,7 @@ module Recurly
|
|
2501
2424
|
# end
|
2502
2425
|
#
|
2503
2426
|
def list_line_items(**options)
|
2504
|
-
path =
|
2427
|
+
path = "/line_items"
|
2505
2428
|
pager(path, **options)
|
2506
2429
|
end
|
2507
2430
|
|
@@ -2511,7 +2434,6 @@ module Recurly
|
|
2511
2434
|
#
|
2512
2435
|
# @param line_item_id [String] Line Item ID.
|
2513
2436
|
# @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
2437
|
#
|
2516
2438
|
# @return [Resources::LineItem] A line item.
|
2517
2439
|
# @example
|
@@ -2535,7 +2457,6 @@ module Recurly
|
|
2535
2457
|
#
|
2536
2458
|
# @param line_item_id [String] Line Item ID.
|
2537
2459
|
# @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
2460
|
#
|
2540
2461
|
# @return [Resources::Empty] Line item deleted.
|
2541
2462
|
# @example
|
@@ -2585,7 +2506,6 @@ module Recurly
|
|
2585
2506
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
2586
2507
|
#
|
2587
2508
|
# :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
2509
|
#
|
2590
2510
|
# @return [Pager<Resources::Plan>] A list of plans.
|
2591
2511
|
# @example
|
@@ -2598,7 +2518,7 @@ module Recurly
|
|
2598
2518
|
# end
|
2599
2519
|
#
|
2600
2520
|
def list_plans(**options)
|
2601
|
-
path =
|
2521
|
+
path = "/plans"
|
2602
2522
|
pager(path, **options)
|
2603
2523
|
end
|
2604
2524
|
|
@@ -2608,7 +2528,6 @@ module Recurly
|
|
2608
2528
|
#
|
2609
2529
|
# @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
2530
|
# @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
2531
|
#
|
2613
2532
|
# @return [Resources::Plan] A plan.
|
2614
2533
|
# @example
|
@@ -2639,7 +2558,7 @@ module Recurly
|
|
2639
2558
|
# end
|
2640
2559
|
#
|
2641
2560
|
def create_plan(body:, **options)
|
2642
|
-
path =
|
2561
|
+
path = "/plans"
|
2643
2562
|
post(path, body, Requests::PlanCreate, **options)
|
2644
2563
|
end
|
2645
2564
|
|
@@ -2649,7 +2568,6 @@ module Recurly
|
|
2649
2568
|
#
|
2650
2569
|
# @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
2570
|
# @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
2571
|
#
|
2654
2572
|
# @return [Resources::Plan] A plan.
|
2655
2573
|
# @example
|
@@ -2674,7 +2592,6 @@ module Recurly
|
|
2674
2592
|
# @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
2593
|
# @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
2594
|
# @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
2595
|
#
|
2679
2596
|
# @return [Resources::Plan] A plan.
|
2680
2597
|
# @example
|
@@ -2701,7 +2618,6 @@ module Recurly
|
|
2701
2618
|
#
|
2702
2619
|
# @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
2620
|
# @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
2621
|
#
|
2706
2622
|
# @return [Resources::Plan] Plan deleted
|
2707
2623
|
# @example
|
@@ -2750,7 +2666,6 @@ module Recurly
|
|
2750
2666
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
2751
2667
|
#
|
2752
2668
|
# :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
2669
|
#
|
2755
2670
|
# @return [Pager<Resources::AddOn>] A list of add-ons.
|
2756
2671
|
# @example
|
@@ -2777,7 +2692,6 @@ module Recurly
|
|
2777
2692
|
# @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
2693
|
# @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
2694
|
# @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
2695
|
#
|
2782
2696
|
# @return [Resources::AddOn] An add-on.
|
2783
2697
|
# @example
|
@@ -2813,7 +2727,6 @@ module Recurly
|
|
2813
2727
|
# @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
2728
|
# @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
2729
|
# @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
2730
|
#
|
2818
2731
|
# @return [Resources::AddOn] An add-on.
|
2819
2732
|
# @example
|
@@ -2841,7 +2754,6 @@ module Recurly
|
|
2841
2754
|
# @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
2755
|
# @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
2756
|
# @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
2757
|
#
|
2846
2758
|
# @return [Resources::AddOn] An add-on.
|
2847
2759
|
# @example
|
@@ -2873,7 +2785,6 @@ module Recurly
|
|
2873
2785
|
# @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
2786
|
# @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
2787
|
# @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
2788
|
#
|
2878
2789
|
# @return [Resources::AddOn] Add-on deleted
|
2879
2790
|
# @example
|
@@ -2924,7 +2835,6 @@ module Recurly
|
|
2924
2835
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
2925
2836
|
#
|
2926
2837
|
# :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
2838
|
#
|
2929
2839
|
# @return [Pager<Resources::AddOn>] A list of add-ons.
|
2930
2840
|
# @example
|
@@ -2939,7 +2849,7 @@ module Recurly
|
|
2939
2849
|
# end
|
2940
2850
|
#
|
2941
2851
|
def list_add_ons(**options)
|
2942
|
-
path =
|
2852
|
+
path = "/add_ons"
|
2943
2853
|
pager(path, **options)
|
2944
2854
|
end
|
2945
2855
|
|
@@ -2949,7 +2859,6 @@ module Recurly
|
|
2949
2859
|
#
|
2950
2860
|
# @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
2861
|
# @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
2862
|
#
|
2954
2863
|
# @return [Resources::AddOn] An add-on.
|
2955
2864
|
# @example
|
@@ -2996,7 +2905,6 @@ module Recurly
|
|
2996
2905
|
# :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
|
2997
2906
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
2998
2907
|
#
|
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
2908
|
#
|
3001
2909
|
# @return [Pager<Resources::ShippingMethod>] A list of the site's shipping methods.
|
3002
2910
|
# @example
|
@@ -3011,7 +2919,7 @@ module Recurly
|
|
3011
2919
|
# end
|
3012
2920
|
#
|
3013
2921
|
def list_shipping_methods(**options)
|
3014
|
-
path =
|
2922
|
+
path = "/shipping_methods"
|
3015
2923
|
pager(path, **options)
|
3016
2924
|
end
|
3017
2925
|
|
@@ -3021,12 +2929,11 @@ module Recurly
|
|
3021
2929
|
#
|
3022
2930
|
# @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
2931
|
# @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
2932
|
#
|
3026
2933
|
# @return [Resources::ShippingMethod] A new shipping method.
|
3027
2934
|
#
|
3028
2935
|
def create_shipping_method(body:, **options)
|
3029
|
-
path =
|
2936
|
+
path = "/shipping_methods"
|
3030
2937
|
post(path, body, Requests::ShippingMethodCreate, **options)
|
3031
2938
|
end
|
3032
2939
|
|
@@ -3036,7 +2943,6 @@ module Recurly
|
|
3036
2943
|
#
|
3037
2944
|
# @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
2945
|
# @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
2946
|
#
|
3041
2947
|
# @return [Resources::ShippingMethod] A shipping method.
|
3042
2948
|
#
|
@@ -3052,7 +2958,6 @@ module Recurly
|
|
3052
2958
|
# @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
2959
|
# @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
2960
|
# @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
2961
|
#
|
3057
2962
|
# @return [Resources::ShippingMethod] The updated shipping method.
|
3058
2963
|
#
|
@@ -3067,7 +2972,6 @@ module Recurly
|
|
3067
2972
|
#
|
3068
2973
|
# @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
2974
|
# @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
2975
|
#
|
3072
2976
|
# @return [Resources::ShippingMethod] A shipping method.
|
3073
2977
|
#
|
@@ -3111,7 +3015,6 @@ module Recurly
|
|
3111
3015
|
# - 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
3016
|
# - When +state=live+, only subscriptions that are in an active, canceled, or future state or are in trial will be returned.
|
3113
3017
|
#
|
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
3018
|
#
|
3116
3019
|
# @return [Pager<Resources::Subscription>] A list of the site's subscriptions.
|
3117
3020
|
# @example
|
@@ -3124,7 +3027,7 @@ module Recurly
|
|
3124
3027
|
# end
|
3125
3028
|
#
|
3126
3029
|
def list_subscriptions(**options)
|
3127
|
-
path =
|
3030
|
+
path = "/subscriptions"
|
3128
3031
|
pager(path, **options)
|
3129
3032
|
end
|
3130
3033
|
|
@@ -3134,7 +3037,6 @@ module Recurly
|
|
3134
3037
|
#
|
3135
3038
|
# @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
3039
|
# @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
3040
|
#
|
3139
3041
|
# @return [Resources::Subscription] A subscription.
|
3140
3042
|
# @example
|
@@ -3158,7 +3060,7 @@ module Recurly
|
|
3158
3060
|
# end
|
3159
3061
|
#
|
3160
3062
|
def create_subscription(body:, **options)
|
3161
|
-
path =
|
3063
|
+
path = "/subscriptions"
|
3162
3064
|
post(path, body, Requests::SubscriptionCreate, **options)
|
3163
3065
|
end
|
3164
3066
|
|
@@ -3168,7 +3070,6 @@ module Recurly
|
|
3168
3070
|
#
|
3169
3071
|
# @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+.
|
3170
3072
|
# @param params [Hash] Optional query string parameters:
|
3171
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3172
3073
|
#
|
3173
3074
|
# @return [Resources::Subscription] A subscription.
|
3174
3075
|
# @example
|
@@ -3195,7 +3096,6 @@ module Recurly
|
|
3195
3096
|
# @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+.
|
3196
3097
|
# @param body [Requests::SubscriptionUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionUpdate}
|
3197
3098
|
# @param params [Hash] Optional query string parameters:
|
3198
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3199
3099
|
#
|
3200
3100
|
# @return [Resources::Subscription] A subscription.
|
3201
3101
|
# @example
|
@@ -3237,7 +3137,6 @@ module Recurly
|
|
3237
3137
|
# You may also terminate a subscription with no refund and then manually refund specific invoices.
|
3238
3138
|
#
|
3239
3139
|
# :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.
|
3240
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3241
3140
|
#
|
3242
3141
|
# @return [Resources::Subscription] An expired subscription.
|
3243
3142
|
# @example
|
@@ -3264,7 +3163,6 @@ module Recurly
|
|
3264
3163
|
# @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+.
|
3265
3164
|
# @param params [Hash] Optional query string parameters:
|
3266
3165
|
# :body [Requests::SubscriptionCancel] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionCancel}
|
3267
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3268
3166
|
#
|
3269
3167
|
# @return [Resources::Subscription] A canceled or failed subscription.
|
3270
3168
|
# @example
|
@@ -3290,7 +3188,6 @@ module Recurly
|
|
3290
3188
|
#
|
3291
3189
|
# @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+.
|
3292
3190
|
# @param params [Hash] Optional query string parameters:
|
3293
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3294
3191
|
#
|
3295
3192
|
# @return [Resources::Subscription] An active subscription.
|
3296
3193
|
# @example
|
@@ -3317,7 +3214,6 @@ module Recurly
|
|
3317
3214
|
# @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+.
|
3318
3215
|
# @param body [Requests::SubscriptionPause] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionPause}
|
3319
3216
|
# @param params [Hash] Optional query string parameters:
|
3320
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3321
3217
|
#
|
3322
3218
|
# @return [Resources::Subscription] A subscription.
|
3323
3219
|
# @example
|
@@ -3347,7 +3243,6 @@ module Recurly
|
|
3347
3243
|
#
|
3348
3244
|
# @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+.
|
3349
3245
|
# @param params [Hash] Optional query string parameters:
|
3350
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3351
3246
|
#
|
3352
3247
|
# @return [Resources::Subscription] A subscription.
|
3353
3248
|
# @example
|
@@ -3373,7 +3268,6 @@ module Recurly
|
|
3373
3268
|
#
|
3374
3269
|
# @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+.
|
3375
3270
|
# @param params [Hash] Optional query string parameters:
|
3376
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3377
3271
|
#
|
3378
3272
|
# @return [Resources::Subscription] A subscription.
|
3379
3273
|
#
|
@@ -3388,7 +3282,6 @@ module Recurly
|
|
3388
3282
|
#
|
3389
3283
|
# @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+.
|
3390
3284
|
# @param params [Hash] Optional query string parameters:
|
3391
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3392
3285
|
#
|
3393
3286
|
# @return [Resources::SubscriptionChange] A subscription's pending change.
|
3394
3287
|
# @example
|
@@ -3415,7 +3308,6 @@ module Recurly
|
|
3415
3308
|
# @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+.
|
3416
3309
|
# @param body [Requests::SubscriptionChangeCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionChangeCreate}
|
3417
3310
|
# @param params [Hash] Optional query string parameters:
|
3418
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3419
3311
|
#
|
3420
3312
|
# @return [Resources::SubscriptionChange] A subscription change.
|
3421
3313
|
# @example
|
@@ -3446,7 +3338,6 @@ module Recurly
|
|
3446
3338
|
#
|
3447
3339
|
# @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+.
|
3448
3340
|
# @param params [Hash] Optional query string parameters:
|
3449
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3450
3341
|
#
|
3451
3342
|
# @return [Resources::Empty] Subscription change was deleted.
|
3452
3343
|
# @example
|
@@ -3473,7 +3364,6 @@ module Recurly
|
|
3473
3364
|
# @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+.
|
3474
3365
|
# @param body [Requests::SubscriptionChangeCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionChangeCreate}
|
3475
3366
|
# @param params [Hash] Optional query string parameters:
|
3476
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3477
3367
|
#
|
3478
3368
|
# @return [Resources::SubscriptionChange] A subscription change.
|
3479
3369
|
#
|
@@ -3518,7 +3408,6 @@ module Recurly
|
|
3518
3408
|
# - +type=non-legacy+, only charge and credit invoices will be returned.
|
3519
3409
|
# - +type=legacy+, only legacy invoices will be returned.
|
3520
3410
|
#
|
3521
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3522
3411
|
#
|
3523
3412
|
# @return [Pager<Resources::Invoice>] A list of the subscription's invoices.
|
3524
3413
|
# @example
|
@@ -3571,7 +3460,6 @@ module Recurly
|
|
3571
3460
|
# :original [String] Filter by original field.
|
3572
3461
|
# :state [String] Filter by state field.
|
3573
3462
|
# :type [String] Filter by type field.
|
3574
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3575
3463
|
#
|
3576
3464
|
# @return [Pager<Resources::LineItem>] A list of the subscription's line items.
|
3577
3465
|
# @example
|
@@ -3619,7 +3507,6 @@ module Recurly
|
|
3619
3507
|
# :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
|
3620
3508
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
3621
3509
|
#
|
3622
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3623
3510
|
#
|
3624
3511
|
# @return [Pager<Resources::CouponRedemption>] A list of the the coupon redemptions on a subscription.
|
3625
3512
|
# @example
|
@@ -3671,7 +3558,6 @@ module Recurly
|
|
3671
3558
|
# *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
|
3672
3559
|
#
|
3673
3560
|
# :billing_status [String] Filter by usage record's billing status
|
3674
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3675
3561
|
#
|
3676
3562
|
# @return [Pager<Resources::Usage>] A list of the subscription add-on's usage records.
|
3677
3563
|
#
|
@@ -3688,7 +3574,6 @@ module Recurly
|
|
3688
3574
|
# @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+.
|
3689
3575
|
# @param body [Requests::UsageCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::UsageCreate}
|
3690
3576
|
# @param params [Hash] Optional query string parameters:
|
3691
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3692
3577
|
#
|
3693
3578
|
# @return [Resources::Usage] The created usage record.
|
3694
3579
|
#
|
@@ -3703,7 +3588,6 @@ module Recurly
|
|
3703
3588
|
#
|
3704
3589
|
# @param usage_id [String] Usage Record ID.
|
3705
3590
|
# @param params [Hash] Optional query string parameters:
|
3706
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3707
3591
|
#
|
3708
3592
|
# @return [Resources::Usage] The usage record.
|
3709
3593
|
#
|
@@ -3719,7 +3603,6 @@ module Recurly
|
|
3719
3603
|
# @param usage_id [String] Usage Record ID.
|
3720
3604
|
# @param body [Requests::UsageCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::UsageCreate}
|
3721
3605
|
# @param params [Hash] Optional query string parameters:
|
3722
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3723
3606
|
#
|
3724
3607
|
# @return [Resources::Usage] The updated usage record.
|
3725
3608
|
#
|
@@ -3734,7 +3617,6 @@ module Recurly
|
|
3734
3617
|
#
|
3735
3618
|
# @param usage_id [String] Usage Record ID.
|
3736
3619
|
# @param params [Hash] Optional query string parameters:
|
3737
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3738
3620
|
#
|
3739
3621
|
# @return [Resources::Empty] Usage was successfully deleted.
|
3740
3622
|
#
|
@@ -3774,7 +3656,6 @@ module Recurly
|
|
3774
3656
|
#
|
3775
3657
|
# :type [String] Filter by type field. The value +payment+ will return both +purchase+ and +capture+ transactions.
|
3776
3658
|
# :success [String] Filter by success field.
|
3777
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3778
3659
|
#
|
3779
3660
|
# @return [Pager<Resources::Transaction>] A list of the site's transactions.
|
3780
3661
|
# @example
|
@@ -3787,7 +3668,7 @@ module Recurly
|
|
3787
3668
|
# end
|
3788
3669
|
#
|
3789
3670
|
def list_transactions(**options)
|
3790
|
-
path =
|
3671
|
+
path = "/transactions"
|
3791
3672
|
pager(path, **options)
|
3792
3673
|
end
|
3793
3674
|
|
@@ -3797,7 +3678,6 @@ module Recurly
|
|
3797
3678
|
#
|
3798
3679
|
# @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+.
|
3799
3680
|
# @param params [Hash] Optional query string parameters:
|
3800
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3801
3681
|
#
|
3802
3682
|
# @return [Resources::Transaction] A transaction.
|
3803
3683
|
# @example
|
@@ -3821,7 +3701,6 @@ module Recurly
|
|
3821
3701
|
#
|
3822
3702
|
# @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+.
|
3823
3703
|
# @param params [Hash] Optional query string parameters:
|
3824
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3825
3704
|
#
|
3826
3705
|
# @return [Resources::UniqueCouponCode] A unique coupon code.
|
3827
3706
|
#
|
@@ -3836,7 +3715,6 @@ module Recurly
|
|
3836
3715
|
#
|
3837
3716
|
# @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+.
|
3838
3717
|
# @param params [Hash] Optional query string parameters:
|
3839
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3840
3718
|
#
|
3841
3719
|
# @return [Resources::UniqueCouponCode] A unique coupon code.
|
3842
3720
|
#
|
@@ -3851,7 +3729,6 @@ module Recurly
|
|
3851
3729
|
#
|
3852
3730
|
# @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+.
|
3853
3731
|
# @param params [Hash] Optional query string parameters:
|
3854
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3855
3732
|
#
|
3856
3733
|
# @return [Resources::UniqueCouponCode] A unique coupon code.
|
3857
3734
|
#
|
@@ -3866,7 +3743,6 @@ module Recurly
|
|
3866
3743
|
#
|
3867
3744
|
# @param body [Requests::PurchaseCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PurchaseCreate}
|
3868
3745
|
# @param params [Hash] Optional query string parameters:
|
3869
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3870
3746
|
#
|
3871
3747
|
# @return [Resources::InvoiceCollection] Returns the new invoices
|
3872
3748
|
# @example
|
@@ -3897,7 +3773,7 @@ module Recurly
|
|
3897
3773
|
# end
|
3898
3774
|
#
|
3899
3775
|
def create_purchase(body:, **options)
|
3900
|
-
path =
|
3776
|
+
path = "/purchases"
|
3901
3777
|
post(path, body, Requests::PurchaseCreate, **options)
|
3902
3778
|
end
|
3903
3779
|
|
@@ -3907,7 +3783,6 @@ module Recurly
|
|
3907
3783
|
#
|
3908
3784
|
# @param body [Requests::PurchaseCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PurchaseCreate}
|
3909
3785
|
# @param params [Hash] Optional query string parameters:
|
3910
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3911
3786
|
#
|
3912
3787
|
# @return [Resources::InvoiceCollection] Returns preview of the new invoices
|
3913
3788
|
# @example
|
@@ -3938,7 +3813,7 @@ module Recurly
|
|
3938
3813
|
# end
|
3939
3814
|
#
|
3940
3815
|
def preview_purchase(body:, **options)
|
3941
|
-
path =
|
3816
|
+
path = "/purchases/preview"
|
3942
3817
|
post(path, body, Requests::PurchaseCreate, **options)
|
3943
3818
|
end
|
3944
3819
|
|
@@ -3947,7 +3822,6 @@ module Recurly
|
|
3947
3822
|
# {https://developers.recurly.com/api/v2021-02-25#operation/get_export_dates get_export_dates api documenation}
|
3948
3823
|
#
|
3949
3824
|
# @param params [Hash] Optional query string parameters:
|
3950
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3951
3825
|
#
|
3952
3826
|
# @return [Resources::ExportDates] Returns a list of dates.
|
3953
3827
|
# @example
|
@@ -3963,7 +3837,7 @@ module Recurly
|
|
3963
3837
|
# end
|
3964
3838
|
#
|
3965
3839
|
def get_export_dates(**options)
|
3966
|
-
path =
|
3840
|
+
path = "/export_dates"
|
3967
3841
|
get(path, **options)
|
3968
3842
|
end
|
3969
3843
|
|
@@ -3973,7 +3847,6 @@ module Recurly
|
|
3973
3847
|
#
|
3974
3848
|
# @param export_date [String] Date for which to get a list of available automated export files. Date must be in YYYY-MM-DD format.
|
3975
3849
|
# @param params [Hash] Optional query string parameters:
|
3976
|
-
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3977
3850
|
#
|
3978
3851
|
# @return [Resources::ExportFiles] Returns a list of export files to download.
|
3979
3852
|
# @example
|