recurly 4.78.0 → 4.79.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/CHANGELOG.md +11 -0
- data/GETTING_STARTED.md +1 -1
- data/lib/recurly/client/operations.rb +2 -1
- data/lib/recurly/version.rb +1 -1
- data/openapi/api.yaml +40 -35
- 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: f0fb876c8cbd40a156f4310de6b1d487b25fa6ed4c62a2c9fa1d9ca840778a53
|
|
4
|
+
data.tar.gz: eba465034a710896c9d5bd07e700179daec60d27777a8b598663205ac3b09180
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ef08fd4dbfc0db459a37b39cb4bfe1c6f4d7809790bd691898a8dbf7a626514635b08d46bbe6e856e344c418e1f553a03c41073be32ca5ba658b4e67d05adee5
|
|
7
|
+
data.tar.gz: f943115c6c99058415884189dc3e7ea452ad8c51dc21d9b5bb88327f5587c4f188dc8a2d74393281b7ee5b9e2b00368f41f5332d8eb07018fe6c45cba996b538
|
data/.bumpversion.cfg
CHANGED
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,16 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [4.79.0](https://github.com/recurly/recurly-client-ruby/tree/4.79.0) (2026-06-18)
|
|
4
|
+
|
|
5
|
+
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.78.0...4.79.0)
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
**Merged Pull Requests**
|
|
9
|
+
|
|
10
|
+
- Generated Latest Changes for v2021-02-25 [#960](https://github.com/recurly/recurly-client-ruby/pull/960) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
3
14
|
## [4.78.0](https://github.com/recurly/recurly-client-ruby/tree/4.78.0) (2026-06-16)
|
|
4
15
|
|
|
5
16
|
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.77.0...4.78.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.79'
|
|
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.
|
|
@@ -231,6 +231,7 @@ module Recurly
|
|
|
231
231
|
#
|
|
232
232
|
# @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+.
|
|
233
233
|
# @param params [Hash] Optional query string parameters:
|
|
234
|
+
# :redact [Boolean] Permanently removes all personally identifiable information (PII) from this account after it has been deactivated, to fulfill a data subject's right to erasure under GDPR and similar privacy regulations (e.g. CCPA). Cannot be undone.
|
|
234
235
|
#
|
|
235
236
|
# @return [Resources::Account] An account.
|
|
236
237
|
# @example
|
|
@@ -4877,7 +4878,7 @@ module Recurly
|
|
|
4877
4878
|
# - When no state is provided, subscriptions with active or canceled states will be returned.
|
|
4878
4879
|
#
|
|
4879
4880
|
#
|
|
4880
|
-
# @return [Pager<Resources::
|
|
4881
|
+
# @return [Pager<Resources::Entitlement>] A list of the entitlements granted to an account.
|
|
4881
4882
|
#
|
|
4882
4883
|
def list_entitlements(account_id:, **options)
|
|
4883
4884
|
path = interpolate_path("/accounts/{account_id}/entitlements", account_id: account_id)
|
data/lib/recurly/version.rb
CHANGED
data/openapi/api.yaml
CHANGED
|
@@ -515,7 +515,7 @@ paths:
|
|
|
515
515
|
end
|
|
516
516
|
- lang: Java
|
|
517
517
|
source: |
|
|
518
|
-
|
|
518
|
+
ListSitesParams params = new ListSitesParams();
|
|
519
519
|
params.setLimit(200); // Pull 200 records at a time
|
|
520
520
|
final Pager<Site> sites = client.listSites(params);
|
|
521
521
|
|
|
@@ -737,7 +737,7 @@ paths:
|
|
|
737
737
|
end
|
|
738
738
|
- lang: Java
|
|
739
739
|
source: |
|
|
740
|
-
|
|
740
|
+
ListAccountsParams params = new ListAccountsParams();
|
|
741
741
|
params.setLimit(200); // Pull 200 records at a time
|
|
742
742
|
Pager<Account> accounts = client.listAccounts(params);
|
|
743
743
|
|
|
@@ -1301,6 +1301,15 @@ paths:
|
|
|
1301
1301
|
and cancels any active subscriptions (canceled subscriptions will remain active
|
|
1302
1302
|
until the end of the current billing cycle before expiring). We recommend
|
|
1303
1303
|
closing accounts only when all business is concluded with a customer.
|
|
1304
|
+
parameters:
|
|
1305
|
+
- in: query
|
|
1306
|
+
name: redact
|
|
1307
|
+
schema:
|
|
1308
|
+
type: boolean
|
|
1309
|
+
description: Permanently removes all personally identifiable information (PII)
|
|
1310
|
+
from this account after it has been deactivated, to fulfill a data subject's
|
|
1311
|
+
right to erasure under GDPR and similar privacy regulations (e.g. CCPA).
|
|
1312
|
+
Cannot be undone.
|
|
1304
1313
|
responses:
|
|
1305
1314
|
'200':
|
|
1306
1315
|
description: An account.
|
|
@@ -2999,8 +3008,7 @@ paths:
|
|
|
2999
3008
|
end
|
|
3000
3009
|
- lang: Java
|
|
3001
3010
|
source: |
|
|
3002
|
-
|
|
3003
|
-
params.setLimit(200); // Pull 200 records at a time
|
|
3011
|
+
ListAccountCouponRedemptionsParams params = new ListAccountCouponRedemptionsParams();
|
|
3004
3012
|
final Pager<CouponRedemption> redemptions = client.listAccountCouponRedemptions(accountId, params);
|
|
3005
3013
|
|
|
3006
3014
|
for (CouponRedemption redemption : redemptions) {
|
|
@@ -3498,7 +3506,7 @@ paths:
|
|
|
3498
3506
|
end
|
|
3499
3507
|
- lang: Java
|
|
3500
3508
|
source: |
|
|
3501
|
-
|
|
3509
|
+
ListAccountCreditPaymentsParams params = new ListAccountCreditPaymentsParams();
|
|
3502
3510
|
params.setLimit(200); // Pull 200 records at a time
|
|
3503
3511
|
Pager<CreditPayment> payments = client.listAccountCreditPayments(accountId, params);
|
|
3504
3512
|
|
|
@@ -3840,7 +3848,7 @@ paths:
|
|
|
3840
3848
|
end
|
|
3841
3849
|
- lang: Java
|
|
3842
3850
|
source: |
|
|
3843
|
-
|
|
3851
|
+
ListAccountInvoicesParams params = new ListAccountInvoicesParams();
|
|
3844
3852
|
params.setLimit(200); // Pull 200 records at a time
|
|
3845
3853
|
final Pager<Invoice> invoices = client.listAccountInvoices(accountId, params);
|
|
3846
3854
|
|
|
@@ -4284,7 +4292,7 @@ paths:
|
|
|
4284
4292
|
end
|
|
4285
4293
|
- lang: Java
|
|
4286
4294
|
source: |
|
|
4287
|
-
|
|
4295
|
+
ListAccountLineItemsParams params = new ListAccountLineItemsParams();
|
|
4288
4296
|
params.setLimit(200); // Pull 200 records at a time
|
|
4289
4297
|
final Pager<LineItem> lineItems = client.listAccountLineItems(accountId, params);
|
|
4290
4298
|
|
|
@@ -4543,8 +4551,7 @@ paths:
|
|
|
4543
4551
|
end
|
|
4544
4552
|
- lang: Java
|
|
4545
4553
|
source: |
|
|
4546
|
-
|
|
4547
|
-
params.setLimit(200); // Pull 200 records at a time
|
|
4554
|
+
ListAccountNotesParams params = new ListAccountNotesParams();
|
|
4548
4555
|
final Pager<AccountNote> notes = client.listAccountNotes(accountId, params);
|
|
4549
4556
|
|
|
4550
4557
|
for (AccountNote note : notes) {
|
|
@@ -4828,7 +4835,7 @@ paths:
|
|
|
4828
4835
|
end
|
|
4829
4836
|
- lang: Java
|
|
4830
4837
|
source: |
|
|
4831
|
-
|
|
4838
|
+
ListShippingAddressesParams params = new ListShippingAddressesParams();
|
|
4832
4839
|
params.setLimit(200); // Pull 200 records at a time
|
|
4833
4840
|
final Pager<ShippingAddress> addresses = client.listShippingAddresses(accountId, params);
|
|
4834
4841
|
|
|
@@ -5517,7 +5524,7 @@ paths:
|
|
|
5517
5524
|
end
|
|
5518
5525
|
- lang: Java
|
|
5519
5526
|
source: |
|
|
5520
|
-
|
|
5527
|
+
ListAccountSubscriptionsParams params = new ListAccountSubscriptionsParams();
|
|
5521
5528
|
params.setLimit(200); // Pull 200 records at a time
|
|
5522
5529
|
final Pager<Subscription> subscriptions = client.listAccountSubscriptions(accountId, params);
|
|
5523
5530
|
|
|
@@ -5623,7 +5630,7 @@ paths:
|
|
|
5623
5630
|
end
|
|
5624
5631
|
- lang: Java
|
|
5625
5632
|
source: |
|
|
5626
|
-
|
|
5633
|
+
ListAccountTransactionsParams params = new ListAccountTransactionsParams();
|
|
5627
5634
|
params.setLimit(200); // Pull 200 records at a time
|
|
5628
5635
|
final Pager<Transaction> transactions = client.listAccountTransactions(accountId, params);
|
|
5629
5636
|
|
|
@@ -5806,7 +5813,7 @@ paths:
|
|
|
5806
5813
|
end
|
|
5807
5814
|
- lang: Java
|
|
5808
5815
|
source: |
|
|
5809
|
-
|
|
5816
|
+
ListAccountAcquisitionParams params = new ListAccountAcquisitionParams();
|
|
5810
5817
|
params.setLimit(200); // Pull 200 records at a time
|
|
5811
5818
|
final Pager<AccountAcquisition> acquisitions = client.listAccountAcquisition(params);
|
|
5812
5819
|
|
|
@@ -5909,7 +5916,7 @@ paths:
|
|
|
5909
5916
|
end
|
|
5910
5917
|
- lang: Java
|
|
5911
5918
|
source: |
|
|
5912
|
-
|
|
5919
|
+
ListCouponsParams params = new ListCouponsParams();
|
|
5913
5920
|
params.setLimit(200); // Pull 200 records at a time
|
|
5914
5921
|
final Pager<Coupon> coupons = client.listCoupons(params);
|
|
5915
5922
|
|
|
@@ -6757,7 +6764,7 @@ paths:
|
|
|
6757
6764
|
end
|
|
6758
6765
|
- lang: Java
|
|
6759
6766
|
source: |
|
|
6760
|
-
|
|
6767
|
+
ListCreditPaymentsParams params = new ListCreditPaymentsParams();
|
|
6761
6768
|
params.setLimit(200); // Pull 200 records at a time
|
|
6762
6769
|
final Pager<CreditPayment> payments = client.listCreditPayments(params);
|
|
6763
6770
|
|
|
@@ -6893,7 +6900,7 @@ paths:
|
|
|
6893
6900
|
end
|
|
6894
6901
|
- lang: Java
|
|
6895
6902
|
source: |
|
|
6896
|
-
|
|
6903
|
+
ListCustomFieldDefinitionsParams params = new ListCustomFieldDefinitionsParams();
|
|
6897
6904
|
params.setLimit(200); // Pull 200 records at a time
|
|
6898
6905
|
final Pager<CustomFieldDefinition> fields = client.listCustomFieldDefinitions(params);
|
|
6899
6906
|
|
|
@@ -7303,7 +7310,7 @@ paths:
|
|
|
7303
7310
|
end
|
|
7304
7311
|
- lang: Java
|
|
7305
7312
|
source: |
|
|
7306
|
-
|
|
7313
|
+
ListItemsParams params = new ListItemsParams();
|
|
7307
7314
|
params.setLimit(200); // Pull 200 records at a time
|
|
7308
7315
|
Pager<Item> items = client.listItems(params);
|
|
7309
7316
|
|
|
@@ -8810,7 +8817,7 @@ paths:
|
|
|
8810
8817
|
end
|
|
8811
8818
|
- lang: Java
|
|
8812
8819
|
source: |
|
|
8813
|
-
|
|
8820
|
+
ListInvoicesParams params = new ListInvoicesParams();
|
|
8814
8821
|
params.setLimit(200); // Pull 200 records at a time
|
|
8815
8822
|
final Pager<Invoice> invoices = client.listInvoices(params);
|
|
8816
8823
|
|
|
@@ -10128,7 +10135,7 @@ paths:
|
|
|
10128
10135
|
end
|
|
10129
10136
|
- lang: Java
|
|
10130
10137
|
source: |
|
|
10131
|
-
|
|
10138
|
+
ListInvoiceLineItemsParams params = new ListInvoiceLineItemsParams();
|
|
10132
10139
|
params.setLimit(200);
|
|
10133
10140
|
Pager<LineItem> lineItems = client.listInvoiceLineItems(invoiceId, params);
|
|
10134
10141
|
|
|
@@ -10222,8 +10229,7 @@ paths:
|
|
|
10222
10229
|
end
|
|
10223
10230
|
- lang: Java
|
|
10224
10231
|
source: |
|
|
10225
|
-
|
|
10226
|
-
params.setLimit(200); // Pull 200 records at a time
|
|
10232
|
+
ListInvoiceCouponRedemptionsParams params = new ListInvoiceCouponRedemptionsParams();
|
|
10227
10233
|
final Pager<CouponRedemption> redemptions = client.listInvoiceCouponRedemptions(invoiceId, params);
|
|
10228
10234
|
|
|
10229
10235
|
for (CouponRedemption redemption : redemptions) {
|
|
@@ -10635,7 +10641,7 @@ paths:
|
|
|
10635
10641
|
end
|
|
10636
10642
|
- lang: Java
|
|
10637
10643
|
source: |
|
|
10638
|
-
|
|
10644
|
+
ListLineItemsParams params = new ListLineItemsParams();
|
|
10639
10645
|
params.setLimit(200); // Pull 200 records at a time
|
|
10640
10646
|
final Pager<LineItem> lineItems = client.listLineItems(params);
|
|
10641
10647
|
|
|
@@ -10972,7 +10978,7 @@ paths:
|
|
|
10972
10978
|
end
|
|
10973
10979
|
- lang: Java
|
|
10974
10980
|
source: |
|
|
10975
|
-
|
|
10981
|
+
ListPlansParams params = new ListPlansParams();
|
|
10976
10982
|
params.setLimit(200); // Pull 200 records at a time
|
|
10977
10983
|
final Pager<Plan> plans = client.listPlans(params);
|
|
10978
10984
|
|
|
@@ -11641,7 +11647,7 @@ paths:
|
|
|
11641
11647
|
end
|
|
11642
11648
|
- lang: Java
|
|
11643
11649
|
source: |
|
|
11644
|
-
|
|
11650
|
+
ListPlanAddOnsParams params = new ListPlanAddOnsParams();
|
|
11645
11651
|
params.setLimit(200); // Pull 200 records at a time
|
|
11646
11652
|
final Pager<AddOn> addOns = client.listPlanAddOns(planId, params);
|
|
11647
11653
|
|
|
@@ -12371,7 +12377,7 @@ paths:
|
|
|
12371
12377
|
end
|
|
12372
12378
|
- lang: Java
|
|
12373
12379
|
source: |
|
|
12374
|
-
|
|
12380
|
+
ListAddOnsParams params = new ListAddOnsParams();
|
|
12375
12381
|
params.setLimit(200); // Pull 200 records at a time
|
|
12376
12382
|
final Pager<AddOn> addOns = client.listAddOns(params);
|
|
12377
12383
|
|
|
@@ -12588,7 +12594,7 @@ paths:
|
|
|
12588
12594
|
end
|
|
12589
12595
|
- lang: Java
|
|
12590
12596
|
source: |
|
|
12591
|
-
|
|
12597
|
+
ListShippingMethodsParams params = new ListShippingMethodsParams();
|
|
12592
12598
|
params.setLimit(200); // Pull 200 records at a time
|
|
12593
12599
|
final Pager<ShippingMethod> shippingMethods = client.listShippingMethods(params);
|
|
12594
12600
|
|
|
@@ -12837,7 +12843,7 @@ paths:
|
|
|
12837
12843
|
end
|
|
12838
12844
|
- lang: Java
|
|
12839
12845
|
source: |
|
|
12840
|
-
|
|
12846
|
+
ListSubscriptionsParams params = new ListSubscriptionsParams();
|
|
12841
12847
|
params.setLimit(200); // Pull 200 records at a time
|
|
12842
12848
|
final Pager<Subscription> subscriptions = client.listSubscriptions(params);
|
|
12843
12849
|
|
|
@@ -13430,7 +13436,7 @@ paths:
|
|
|
13430
13436
|
- lang: Java
|
|
13431
13437
|
source: |
|
|
13432
13438
|
try {
|
|
13433
|
-
|
|
13439
|
+
TerminateSubscriptionParams queryParams = new TerminateSubscriptionParams();
|
|
13434
13440
|
queryParams.setRefund(Constants.RefundType.NONE); // "full" for a full refund, "partial" for prorated refund
|
|
13435
13441
|
client.terminateSubscription(subscriptionId, queryParams);
|
|
13436
13442
|
System.out.println("Terminated Subscription: " + subscriptionId);
|
|
@@ -14718,7 +14724,7 @@ paths:
|
|
|
14718
14724
|
end
|
|
14719
14725
|
- lang: Java
|
|
14720
14726
|
source: |
|
|
14721
|
-
|
|
14727
|
+
ListSubscriptionInvoicesParams params = new ListSubscriptionInvoicesParams();
|
|
14722
14728
|
params.setLimit(200); // Pull 200 records at a time
|
|
14723
14729
|
final Pager<Invoice> invoices = client.listSubscriptionInvoices(subscriptionId, params);
|
|
14724
14730
|
|
|
@@ -14824,7 +14830,7 @@ paths:
|
|
|
14824
14830
|
end
|
|
14825
14831
|
- lang: Java
|
|
14826
14832
|
source: |
|
|
14827
|
-
|
|
14833
|
+
ListSubscriptionLineItemsParams params = new ListSubscriptionLineItemsParams();
|
|
14828
14834
|
params.setLimit(200); // Pull 200 records at a time
|
|
14829
14835
|
final Pager<LineItem> lineItems = client.listSubscriptionLineItems(subscriptionId, params);
|
|
14830
14836
|
|
|
@@ -14922,8 +14928,7 @@ paths:
|
|
|
14922
14928
|
end
|
|
14923
14929
|
- lang: Java
|
|
14924
14930
|
source: |
|
|
14925
|
-
|
|
14926
|
-
params.setLimit(200); // Pull 200 records at a time
|
|
14931
|
+
ListSubscriptionCouponRedemptionsParams params = new ListSubscriptionCouponRedemptionsParams();
|
|
14927
14932
|
final Pager<CouponRedemption> redemptions = client.listSubscriptionCouponRedemptions(subscriptionId, params);
|
|
14928
14933
|
|
|
14929
14934
|
for (CouponRedemption redemption : redemptions) {
|
|
@@ -15293,7 +15298,7 @@ paths:
|
|
|
15293
15298
|
end
|
|
15294
15299
|
- lang: Java
|
|
15295
15300
|
source: |
|
|
15296
|
-
|
|
15301
|
+
ListTransactionsParams params = new ListTransactionsParams();
|
|
15297
15302
|
params.setLimit(200); // Pull 200 records at a time
|
|
15298
15303
|
final Pager<Transaction> transactions = client.listTransactions(params);
|
|
15299
15304
|
|
|
@@ -16935,7 +16940,7 @@ paths:
|
|
|
16935
16940
|
content:
|
|
16936
16941
|
application/json:
|
|
16937
16942
|
schema:
|
|
16938
|
-
"$ref": "#/components/schemas/
|
|
16943
|
+
"$ref": "#/components/schemas/EntitlementList"
|
|
16939
16944
|
'404':
|
|
16940
16945
|
description: Incorrect site or account ID.
|
|
16941
16946
|
content:
|
|
@@ -25994,7 +25999,7 @@ components:
|
|
|
25994
25999
|
maxItems: 200
|
|
25995
26000
|
items:
|
|
25996
26001
|
"$ref": "#/components/schemas/Plan"
|
|
25997
|
-
|
|
26002
|
+
EntitlementList:
|
|
25998
26003
|
type: object
|
|
25999
26004
|
description: A list of privileges granted to a customer through the purchase
|
|
26000
26005
|
of a plan or item.
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: recurly
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 4.
|
|
4
|
+
version: 4.79.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Recurly
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-06-
|
|
11
|
+
date: 2026-06-18 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: base64
|
|
@@ -398,7 +398,7 @@ metadata:
|
|
|
398
398
|
changelog_uri: https://github.com/recurly/recurly-client-ruby/blob/master/CHANGELOG.md
|
|
399
399
|
documentation_uri: https://recurly.github.io/recurly-client-ruby/
|
|
400
400
|
homepage_uri: https://github.com/recurly/recurly-client-ruby
|
|
401
|
-
source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.
|
|
401
|
+
source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.79.0
|
|
402
402
|
post_install_message:
|
|
403
403
|
rdoc_options: []
|
|
404
404
|
require_paths:
|