recurly 4.73.0 → 4.74.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 +60 -0
- data/lib/recurly/requests/credit_application_policy.rb +4 -0
- data/lib/recurly/requests/invoice_create.rb +1 -1
- data/lib/recurly/requests/purchase_create.rb +1 -1
- data/lib/recurly/requests/subscription_create.rb +1 -1
- data/lib/recurly/requests/subscription_purchase.rb +1 -1
- data/lib/recurly/requests/subscription_update.rb +1 -1
- data/lib/recurly/resources/coupon_redemption.rb +4 -0
- data/lib/recurly/resources/credit_application_policy.rb +4 -0
- data/lib/recurly/resources/invoice_collection.rb +4 -0
- data/lib/recurly/resources/subscription.rb +1 -1
- data/lib/recurly/version.rb +1 -1
- data/openapi/api.yaml +180 -1
- metadata +3 -4
- data/.github/workflows/codeql.yml +0 -66
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 102506b8750880c90ece0a8be6fcf079413029f395d698f426cd0fa2442fb0d2
|
|
4
|
+
data.tar.gz: b41e85114dd87196be6bbe912fdcc824faa0b7f3303fe8c276ca1f5af5a801bb
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 38e68a485325b060e98cce456d7ebc917947194740d188bb122afc2816b90bbc54016a79bc560a4f09f9fde8eb1f8a3945a6a470b0fd32b5fe304519355aeab3
|
|
7
|
+
data.tar.gz: d79a02707dac98ab6fc36d8b6950abcab4369d04c91f4772d94246b8cefa54ce880b16f1aaa5a80e290404173de0e869d1a84cb1a0b622618ba121008df8b867
|
data/.bumpversion.cfg
CHANGED
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,16 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [4.74.0](https://github.com/recurly/recurly-client-ruby/tree/4.74.0) (2026-02-06)
|
|
4
|
+
|
|
5
|
+
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.73.0...4.74.0)
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
**Merged Pull Requests**
|
|
9
|
+
|
|
10
|
+
- Generated Latest Changes for v2021-02-25 [#947](https://github.com/recurly/recurly-client-ruby/pull/947) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
3
14
|
## [4.73.0](https://github.com/recurly/recurly-client-ruby/tree/4.73.0) (2025-12-12)
|
|
4
15
|
|
|
5
16
|
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.72.0...4.73.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.74'
|
|
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.
|
|
@@ -745,6 +745,36 @@ module Recurly
|
|
|
745
745
|
delete(path, **options)
|
|
746
746
|
end
|
|
747
747
|
|
|
748
|
+
# Show the coupon redemption
|
|
749
|
+
#
|
|
750
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_coupon_redemption get_coupon_redemption api documentation}
|
|
751
|
+
#
|
|
752
|
+
# @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+.
|
|
753
|
+
# @param coupon_redemption_id [String] Coupon Redemption ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
|
|
754
|
+
# @param params [Hash] Optional query string parameters:
|
|
755
|
+
#
|
|
756
|
+
# @return [Resources::CouponRedemption] A coupon redemption.
|
|
757
|
+
#
|
|
758
|
+
def get_coupon_redemption(account_id:, coupon_redemption_id:, **options)
|
|
759
|
+
path = interpolate_path("/accounts/{account_id}/coupon_redemptions/{coupon_redemption_id}", account_id: account_id, coupon_redemption_id: coupon_redemption_id)
|
|
760
|
+
get(path, **options)
|
|
761
|
+
end
|
|
762
|
+
|
|
763
|
+
# Delete the coupon redemption
|
|
764
|
+
#
|
|
765
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/remove_coupon_redemption_by_id remove_coupon_redemption_by_id api documentation}
|
|
766
|
+
#
|
|
767
|
+
# @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+.
|
|
768
|
+
# @param coupon_redemption_id [String] Coupon Redemption ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
|
|
769
|
+
# @param params [Hash] Optional query string parameters:
|
|
770
|
+
#
|
|
771
|
+
# @return [Resources::CouponRedemption] Coupon redemption deleted.
|
|
772
|
+
#
|
|
773
|
+
def remove_coupon_redemption_by_id(account_id:, coupon_redemption_id:, **options)
|
|
774
|
+
path = interpolate_path("/accounts/{account_id}/coupon_redemptions/{coupon_redemption_id}", account_id: account_id, coupon_redemption_id: coupon_redemption_id)
|
|
775
|
+
delete(path, **options)
|
|
776
|
+
end
|
|
777
|
+
|
|
748
778
|
# List an account's credit payments
|
|
749
779
|
#
|
|
750
780
|
# {https://developers.recurly.com/api/v2021-02-25#operation/list_account_credit_payments list_account_credit_payments api documentation}
|
|
@@ -4194,6 +4224,36 @@ module Recurly
|
|
|
4194
4224
|
pager(path, **options)
|
|
4195
4225
|
end
|
|
4196
4226
|
|
|
4227
|
+
# Show the coupon redemption for a subscription
|
|
4228
|
+
#
|
|
4229
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_subscription_coupon_redemption get_subscription_coupon_redemption api documentation}
|
|
4230
|
+
#
|
|
4231
|
+
# @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+.
|
|
4232
|
+
# @param coupon_redemption_id [String] Coupon Redemption ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
|
|
4233
|
+
# @param params [Hash] Optional query string parameters:
|
|
4234
|
+
#
|
|
4235
|
+
# @return [Resources::CouponRedemption] The coupon redemption on a subscription.
|
|
4236
|
+
#
|
|
4237
|
+
def get_subscription_coupon_redemption(subscription_id:, coupon_redemption_id:, **options)
|
|
4238
|
+
path = interpolate_path("/subscriptions/{subscription_id}/coupon_redemptions/{coupon_redemption_id}", subscription_id: subscription_id, coupon_redemption_id: coupon_redemption_id)
|
|
4239
|
+
get(path, **options)
|
|
4240
|
+
end
|
|
4241
|
+
|
|
4242
|
+
# Delete the coupon redemption from a subscription
|
|
4243
|
+
#
|
|
4244
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/remove_subscription_coupon_redemption remove_subscription_coupon_redemption api documentation}
|
|
4245
|
+
#
|
|
4246
|
+
# @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+.
|
|
4247
|
+
# @param coupon_redemption_id [String] Coupon Redemption ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
|
|
4248
|
+
# @param params [Hash] Optional query string parameters:
|
|
4249
|
+
#
|
|
4250
|
+
# @return [Resources::CouponRedemption] Coupon redemption deleted.
|
|
4251
|
+
#
|
|
4252
|
+
def remove_subscription_coupon_redemption(subscription_id:, coupon_redemption_id:, **options)
|
|
4253
|
+
path = interpolate_path("/subscriptions/{subscription_id}/coupon_redemptions/{coupon_redemption_id}", subscription_id: subscription_id, coupon_redemption_id: coupon_redemption_id)
|
|
4254
|
+
delete(path, **options)
|
|
4255
|
+
end
|
|
4256
|
+
|
|
4197
4257
|
# List a subscription add-on's usage records
|
|
4198
4258
|
#
|
|
4199
4259
|
# {https://developers.recurly.com/api/v2021-02-25#operation/list_usage list_usage api documentation}
|
|
@@ -6,6 +6,10 @@ module Recurly
|
|
|
6
6
|
module Requests
|
|
7
7
|
class CreditApplicationPolicy < Request
|
|
8
8
|
|
|
9
|
+
# @!attribute allowed_origins
|
|
10
|
+
# @return [Array[String]] Optional array of credit invoice origin types to allow when mode is `all`. If not specified when mode is `all`, credits from all origins are applied. Only valid when mode is `all`.
|
|
11
|
+
define_attribute :allowed_origins, Array, { :item_type => String }
|
|
12
|
+
|
|
9
13
|
# @!attribute mode
|
|
10
14
|
# @return [String] Determines which credit invoices are applied to invoices: - `all`: All available credit invoices are applied (default) - `none`: No credit invoices are applied automatically
|
|
11
15
|
define_attribute :mode, String
|
|
@@ -23,7 +23,7 @@ module Recurly
|
|
|
23
23
|
define_attribute :collection_method, String
|
|
24
24
|
|
|
25
25
|
# @!attribute credit_application_policy
|
|
26
|
-
# @return [CreditApplicationPolicy] Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior.
|
|
26
|
+
# @return [CreditApplicationPolicy] Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior. When mode is `all`, the optional `allowed_origins` array can restrict which credit invoice origins are applied.
|
|
27
27
|
define_attribute :credit_application_policy, :CreditApplicationPolicy
|
|
28
28
|
|
|
29
29
|
# @!attribute credit_customer_notes
|
|
@@ -31,7 +31,7 @@ module Recurly
|
|
|
31
31
|
define_attribute :coupon_codes, Array, { :item_type => String }
|
|
32
32
|
|
|
33
33
|
# @!attribute credit_application_policy_override
|
|
34
|
-
# @return [CreditApplicationPolicy] Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior.
|
|
34
|
+
# @return [CreditApplicationPolicy] Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior. When mode is `all`, the optional `allowed_origins` array can restrict which credit invoice origins are applied.
|
|
35
35
|
define_attribute :credit_application_policy_override, :CreditApplicationPolicy
|
|
36
36
|
|
|
37
37
|
# @!attribute credit_customer_notes
|
|
@@ -43,7 +43,7 @@ module Recurly
|
|
|
43
43
|
define_attribute :coupon_codes, Array, { :item_type => String }
|
|
44
44
|
|
|
45
45
|
# @!attribute credit_application_policy
|
|
46
|
-
# @return [CreditApplicationPolicy] Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior.
|
|
46
|
+
# @return [CreditApplicationPolicy] Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior. When mode is `all`, the optional `allowed_origins` array can restrict which credit invoice origins are applied.
|
|
47
47
|
define_attribute :credit_application_policy, :CreditApplicationPolicy
|
|
48
48
|
|
|
49
49
|
# @!attribute credit_customer_notes
|
|
@@ -19,7 +19,7 @@ module Recurly
|
|
|
19
19
|
define_attribute :bulk, :Boolean
|
|
20
20
|
|
|
21
21
|
# @!attribute credit_application_policy
|
|
22
|
-
# @return [CreditApplicationPolicy] Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior.
|
|
22
|
+
# @return [CreditApplicationPolicy] Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior. When mode is `all`, the optional `allowed_origins` array can restrict which credit invoice origins are applied.
|
|
23
23
|
define_attribute :credit_application_policy, :CreditApplicationPolicy
|
|
24
24
|
|
|
25
25
|
# @!attribute custom_fields
|
|
@@ -19,7 +19,7 @@ module Recurly
|
|
|
19
19
|
define_attribute :collection_method, String
|
|
20
20
|
|
|
21
21
|
# @!attribute credit_application_policy
|
|
22
|
-
# @return [CreditApplicationPolicy] Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior.
|
|
22
|
+
# @return [CreditApplicationPolicy] Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior. When mode is `all`, the optional `allowed_origins` array can restrict which credit invoice origins are applied.
|
|
23
23
|
define_attribute :credit_application_policy, :CreditApplicationPolicy
|
|
24
24
|
|
|
25
25
|
# @!attribute custom_fields
|
|
@@ -49,6 +49,10 @@ module Recurly
|
|
|
49
49
|
# @!attribute updated_at
|
|
50
50
|
# @return [DateTime] Last updated at
|
|
51
51
|
define_attribute :updated_at, DateTime
|
|
52
|
+
|
|
53
|
+
# @!attribute uuid
|
|
54
|
+
# @return [String] The UUID is useful for matching data with the CSV exports and building URLs into Recurly's UI.
|
|
55
|
+
define_attribute :uuid, String
|
|
52
56
|
end
|
|
53
57
|
end
|
|
54
58
|
end
|
|
@@ -6,6 +6,10 @@ module Recurly
|
|
|
6
6
|
module Resources
|
|
7
7
|
class CreditApplicationPolicy < Resource
|
|
8
8
|
|
|
9
|
+
# @!attribute allowed_origins
|
|
10
|
+
# @return [Array[String]] Optional array of credit invoice origin types to allow when mode is `all`. If not specified when mode is `all`, credits from all origins are applied. Only valid when mode is `all`.
|
|
11
|
+
define_attribute :allowed_origins, Array, { :item_type => String }
|
|
12
|
+
|
|
9
13
|
# @!attribute mode
|
|
10
14
|
# @return [String] Determines which credit invoices are applied to invoices: - `all`: All available credit invoices are applied (default) - `none`: No credit invoices are applied automatically
|
|
11
15
|
define_attribute :mode, String
|
|
@@ -17,6 +17,10 @@ module Recurly
|
|
|
17
17
|
# @!attribute object
|
|
18
18
|
# @return [String] Object type
|
|
19
19
|
define_attribute :object, String
|
|
20
|
+
|
|
21
|
+
# @!attribute verification_transactions
|
|
22
|
+
# @return [Array[Transaction]] Verification transactions (used for free trial payment method validation)
|
|
23
|
+
define_attribute :verification_transactions, Array, { :item_type => :Transaction }
|
|
20
24
|
end
|
|
21
25
|
end
|
|
22
26
|
end
|
|
@@ -67,7 +67,7 @@ module Recurly
|
|
|
67
67
|
define_attribute :created_at, DateTime
|
|
68
68
|
|
|
69
69
|
# @!attribute credit_application_policy
|
|
70
|
-
# @return [CreditApplicationPolicy] Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior.
|
|
70
|
+
# @return [CreditApplicationPolicy] Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior. When mode is `all`, the optional `allowed_origins` array can restrict which credit invoice origins are applied.
|
|
71
71
|
define_attribute :credit_application_policy, :CreditApplicationPolicy
|
|
72
72
|
|
|
73
73
|
# @!attribute currency
|
data/lib/recurly/version.rb
CHANGED
data/openapi/api.yaml
CHANGED
|
@@ -3312,6 +3312,70 @@ paths:
|
|
|
3312
3312
|
{\n\t\tfmt.Printf(\"Resource not found: %v\", e)\n\t\treturn nil, err\n\t}\n\tfmt.Printf(\"Unexpected
|
|
3313
3313
|
Recurly error: %v\", e)\n\treturn nil, err\n}\n\nfmt.Printf(\"Removed Coupon
|
|
3314
3314
|
Redemption: %v\", couponRedemption.Id)"
|
|
3315
|
+
"/accounts/{account_id}/coupon_redemptions/{coupon_redemption_id}":
|
|
3316
|
+
get:
|
|
3317
|
+
tags:
|
|
3318
|
+
- coupon_redemption
|
|
3319
|
+
operationId: get_coupon_redemption
|
|
3320
|
+
summary: Show the coupon redemption
|
|
3321
|
+
parameters:
|
|
3322
|
+
- "$ref": "#/components/parameters/account_id"
|
|
3323
|
+
- "$ref": "#/components/parameters/coupon_redemption_id"
|
|
3324
|
+
responses:
|
|
3325
|
+
'200':
|
|
3326
|
+
description: A coupon redemption.
|
|
3327
|
+
content:
|
|
3328
|
+
application/json:
|
|
3329
|
+
schema:
|
|
3330
|
+
"$ref": "#/components/schemas/CouponRedemption"
|
|
3331
|
+
'404':
|
|
3332
|
+
description: Incorrect site, account ID, or coupon redemption ID.
|
|
3333
|
+
content:
|
|
3334
|
+
application/json:
|
|
3335
|
+
schema:
|
|
3336
|
+
"$ref": "#/components/schemas/Error"
|
|
3337
|
+
default:
|
|
3338
|
+
description: Unexpected error.
|
|
3339
|
+
content:
|
|
3340
|
+
application/json:
|
|
3341
|
+
schema:
|
|
3342
|
+
"$ref": "#/components/schemas/Error"
|
|
3343
|
+
x-code-samples: []
|
|
3344
|
+
delete:
|
|
3345
|
+
tags:
|
|
3346
|
+
- coupon_redemption
|
|
3347
|
+
operationId: remove_coupon_redemption_by_id
|
|
3348
|
+
summary: Delete the coupon redemption
|
|
3349
|
+
description: Deactivate the coupon redemption on an account.
|
|
3350
|
+
parameters:
|
|
3351
|
+
- "$ref": "#/components/parameters/account_id"
|
|
3352
|
+
- "$ref": "#/components/parameters/coupon_redemption_id"
|
|
3353
|
+
responses:
|
|
3354
|
+
'200':
|
|
3355
|
+
description: Coupon redemption deleted.
|
|
3356
|
+
content:
|
|
3357
|
+
application/json:
|
|
3358
|
+
schema:
|
|
3359
|
+
"$ref": "#/components/schemas/CouponRedemption"
|
|
3360
|
+
'404':
|
|
3361
|
+
description: Incorrect site, account ID, or coupon redemption ID.
|
|
3362
|
+
content:
|
|
3363
|
+
application/json:
|
|
3364
|
+
schema:
|
|
3365
|
+
"$ref": "#/components/schemas/Error"
|
|
3366
|
+
'422':
|
|
3367
|
+
description: The coupon redemption is already expired or inactive.
|
|
3368
|
+
content:
|
|
3369
|
+
application/json:
|
|
3370
|
+
schema:
|
|
3371
|
+
"$ref": "#/components/schemas/Error"
|
|
3372
|
+
default:
|
|
3373
|
+
description: Unexpected error.
|
|
3374
|
+
content:
|
|
3375
|
+
application/json:
|
|
3376
|
+
schema:
|
|
3377
|
+
"$ref": "#/components/schemas/Error"
|
|
3378
|
+
x-code-samples: []
|
|
3315
3379
|
"/accounts/{account_id}/credit_payments":
|
|
3316
3380
|
get:
|
|
3317
3381
|
tags:
|
|
@@ -14749,6 +14813,70 @@ paths:
|
|
|
14749
14813
|
e, ok := err.(*recurly.Error); ok {\n\t\tfmt.Printf(\"Failed to retrieve
|
|
14750
14814
|
next page: %v\", e)\n\t\tbreak\n\t}\n\tfor i, redemption := range subCouponRedemptions.Data()
|
|
14751
14815
|
{\n\t\tfmt.Printf(\"Subscription Coupon Redemption %3d: %s\\n\",\n\t\t\ti,\n\t\t\tredemption.Id,\n\t\t)\n\t}\n}"
|
|
14816
|
+
"/subscriptions/{subscription_id}/coupon_redemptions/{coupon_redemption_id}":
|
|
14817
|
+
get:
|
|
14818
|
+
tags:
|
|
14819
|
+
- coupon_redemption
|
|
14820
|
+
operationId: get_subscription_coupon_redemption
|
|
14821
|
+
summary: Show the coupon redemption for a subscription
|
|
14822
|
+
parameters:
|
|
14823
|
+
- "$ref": "#/components/parameters/subscription_id"
|
|
14824
|
+
- "$ref": "#/components/parameters/coupon_redemption_id"
|
|
14825
|
+
responses:
|
|
14826
|
+
'200':
|
|
14827
|
+
description: The coupon redemption on a subscription.
|
|
14828
|
+
content:
|
|
14829
|
+
application/json:
|
|
14830
|
+
schema:
|
|
14831
|
+
"$ref": "#/components/schemas/CouponRedemption"
|
|
14832
|
+
'404':
|
|
14833
|
+
description: Incorrect site, subscription ID, or coupon redemption ID.
|
|
14834
|
+
content:
|
|
14835
|
+
application/json:
|
|
14836
|
+
schema:
|
|
14837
|
+
"$ref": "#/components/schemas/Error"
|
|
14838
|
+
default:
|
|
14839
|
+
description: Unexpected error.
|
|
14840
|
+
content:
|
|
14841
|
+
application/json:
|
|
14842
|
+
schema:
|
|
14843
|
+
"$ref": "#/components/schemas/Error"
|
|
14844
|
+
x-code-samples: []
|
|
14845
|
+
delete:
|
|
14846
|
+
tags:
|
|
14847
|
+
- coupon_redemption
|
|
14848
|
+
operationId: remove_subscription_coupon_redemption
|
|
14849
|
+
summary: Delete the coupon redemption from a subscription
|
|
14850
|
+
description: Deactivate the coupon redemption on a subscription.
|
|
14851
|
+
parameters:
|
|
14852
|
+
- "$ref": "#/components/parameters/subscription_id"
|
|
14853
|
+
- "$ref": "#/components/parameters/coupon_redemption_id"
|
|
14854
|
+
responses:
|
|
14855
|
+
'200':
|
|
14856
|
+
description: Coupon redemption deleted.
|
|
14857
|
+
content:
|
|
14858
|
+
application/json:
|
|
14859
|
+
schema:
|
|
14860
|
+
"$ref": "#/components/schemas/CouponRedemption"
|
|
14861
|
+
'404':
|
|
14862
|
+
description: Incorrect site, subscription ID, or coupon redemption ID.
|
|
14863
|
+
content:
|
|
14864
|
+
application/json:
|
|
14865
|
+
schema:
|
|
14866
|
+
"$ref": "#/components/schemas/Error"
|
|
14867
|
+
'422':
|
|
14868
|
+
description: The coupon redemption is already expired or inactive.
|
|
14869
|
+
content:
|
|
14870
|
+
application/json:
|
|
14871
|
+
schema:
|
|
14872
|
+
"$ref": "#/components/schemas/Error"
|
|
14873
|
+
default:
|
|
14874
|
+
description: Unexpected error.
|
|
14875
|
+
content:
|
|
14876
|
+
application/json:
|
|
14877
|
+
schema:
|
|
14878
|
+
"$ref": "#/components/schemas/Error"
|
|
14879
|
+
x-code-samples: []
|
|
14752
14880
|
"/subscriptions/{subscription_id}/add_ons/{add_on_id}/usage":
|
|
14753
14881
|
get:
|
|
14754
14882
|
tags:
|
|
@@ -17051,6 +17179,14 @@ components:
|
|
|
17051
17179
|
required: true
|
|
17052
17180
|
schema:
|
|
17053
17181
|
type: string
|
|
17182
|
+
coupon_redemption_id:
|
|
17183
|
+
name: coupon_redemption_id
|
|
17184
|
+
in: path
|
|
17185
|
+
description: Coupon Redemption ID or UUID. For ID no prefix is used e.g. `e28zov4fw0v2`.
|
|
17186
|
+
For UUID use prefix `uuid-`, e.g. `uuid-123457890`.
|
|
17187
|
+
required: true
|
|
17188
|
+
schema:
|
|
17189
|
+
type: string
|
|
17054
17190
|
credit_payment_id:
|
|
17055
17191
|
name: credit_payment_id
|
|
17056
17192
|
in: path
|
|
@@ -19754,6 +19890,13 @@ components:
|
|
|
19754
19890
|
title: Object type
|
|
19755
19891
|
description: Will always be `coupon`.
|
|
19756
19892
|
readOnly: true
|
|
19893
|
+
uuid:
|
|
19894
|
+
type: string
|
|
19895
|
+
title: Recurly UUID
|
|
19896
|
+
description: The UUID is useful for matching data with the CSV exports and
|
|
19897
|
+
building URLs into Recurly's UI.
|
|
19898
|
+
maxLength: 32
|
|
19899
|
+
readOnly: true
|
|
19757
19900
|
account:
|
|
19758
19901
|
type: object
|
|
19759
19902
|
title: Account
|
|
@@ -20974,6 +21117,13 @@ components:
|
|
|
20974
21117
|
title: Credit invoices
|
|
20975
21118
|
items:
|
|
20976
21119
|
"$ref": "#/components/schemas/Invoice"
|
|
21120
|
+
verification_transactions:
|
|
21121
|
+
type: array
|
|
21122
|
+
title: Verification transactions
|
|
21123
|
+
description: Verification transactions (used for free trial payment method
|
|
21124
|
+
validation)
|
|
21125
|
+
items:
|
|
21126
|
+
"$ref": "#/components/schemas/Transaction"
|
|
20977
21127
|
InvoiceUpdate:
|
|
20978
21128
|
type: object
|
|
20979
21129
|
properties:
|
|
@@ -27104,10 +27254,20 @@ components:
|
|
|
27104
27254
|
title: Credit Application Policy
|
|
27105
27255
|
description: |
|
|
27106
27256
|
Controls whether credit invoices are automatically applied to new invoices.
|
|
27107
|
-
The `mode` field determines the application behavior.
|
|
27257
|
+
The `mode` field determines the application behavior. When mode is `all`,
|
|
27258
|
+
the optional `allowed_origins` array can restrict which credit invoice origins
|
|
27259
|
+
are applied.
|
|
27108
27260
|
properties:
|
|
27109
27261
|
mode:
|
|
27110
27262
|
"$ref": "#/components/schemas/CreditApplicationModeEnum"
|
|
27263
|
+
allowed_origins:
|
|
27264
|
+
type: array
|
|
27265
|
+
description: |
|
|
27266
|
+
Optional array of credit invoice origin types to allow when mode is `all`.
|
|
27267
|
+
If not specified when mode is `all`, credits from all origins are applied.
|
|
27268
|
+
Only valid when mode is `all`.
|
|
27269
|
+
items:
|
|
27270
|
+
"$ref": "#/components/schemas/CreditApplicationAllowedOriginTypeEnum"
|
|
27111
27271
|
required:
|
|
27112
27272
|
- mode
|
|
27113
27273
|
CreditApplicationModeEnum:
|
|
@@ -27121,6 +27281,25 @@ components:
|
|
|
27121
27281
|
- all
|
|
27122
27282
|
- none
|
|
27123
27283
|
default: all
|
|
27284
|
+
CreditApplicationAllowedOriginTypeEnum:
|
|
27285
|
+
type: string
|
|
27286
|
+
title: Credit Application Allowed Origin Type
|
|
27287
|
+
description: The origin type of a credit invoice that can be allowed in a credit
|
|
27288
|
+
application policy
|
|
27289
|
+
enum:
|
|
27290
|
+
- line_item_refund
|
|
27291
|
+
- open_amount_refund
|
|
27292
|
+
- immediate_change
|
|
27293
|
+
- termination
|
|
27294
|
+
- credit
|
|
27295
|
+
- write_off
|
|
27296
|
+
- refund
|
|
27297
|
+
- external_refund
|
|
27298
|
+
- carryforward_credit
|
|
27299
|
+
- usage_correction
|
|
27300
|
+
- prepayment
|
|
27301
|
+
- gift_card
|
|
27302
|
+
- carryforward_gift_credit
|
|
27124
27303
|
InvoiceRefundTypeEnum:
|
|
27125
27304
|
type: string
|
|
27126
27305
|
enum:
|
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.74.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Recurly
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2026-02-06 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: base64
|
|
@@ -135,7 +135,6 @@ files:
|
|
|
135
135
|
- ".github/ISSUE_TEMPLATE/question-or-other.md"
|
|
136
136
|
- ".github/codeql/codeql-config.yml"
|
|
137
137
|
- ".github/workflows/ci.yml"
|
|
138
|
-
- ".github/workflows/codeql.yml"
|
|
139
138
|
- ".github/workflows/docs.yml"
|
|
140
139
|
- ".github/workflows/pr-review.yml"
|
|
141
140
|
- ".gitignore"
|
|
@@ -389,7 +388,7 @@ metadata:
|
|
|
389
388
|
changelog_uri: https://github.com/recurly/recurly-client-ruby/blob/master/CHANGELOG.md
|
|
390
389
|
documentation_uri: https://recurly.github.io/recurly-client-ruby/
|
|
391
390
|
homepage_uri: https://github.com/recurly/recurly-client-ruby
|
|
392
|
-
source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.
|
|
391
|
+
source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.74.0
|
|
393
392
|
post_install_message:
|
|
394
393
|
rdoc_options: []
|
|
395
394
|
require_paths:
|
|
@@ -1,66 +0,0 @@
|
|
|
1
|
-
# Managed by Security
|
|
2
|
-
name: "Security check - CodeQL"
|
|
3
|
-
|
|
4
|
-
on:
|
|
5
|
-
pull_request:
|
|
6
|
-
workflow_dispatch:
|
|
7
|
-
push:
|
|
8
|
-
branches:
|
|
9
|
-
- staging
|
|
10
|
-
- main
|
|
11
|
-
- master
|
|
12
|
-
|
|
13
|
-
jobs:
|
|
14
|
-
analyze:
|
|
15
|
-
name: Analyze
|
|
16
|
-
runs-on: ubuntu-latest
|
|
17
|
-
permissions:
|
|
18
|
-
actions: read
|
|
19
|
-
contents: read
|
|
20
|
-
security-events: write
|
|
21
|
-
|
|
22
|
-
strategy:
|
|
23
|
-
fail-fast: false
|
|
24
|
-
matrix:
|
|
25
|
-
language: [ 'ruby', 'javascript' ]
|
|
26
|
-
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
|
|
27
|
-
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
|
|
28
|
-
|
|
29
|
-
steps:
|
|
30
|
-
- name: Checkout repository
|
|
31
|
-
uses: actions/checkout@v3
|
|
32
|
-
|
|
33
|
-
# Initializes the CodeQL tools for scanning.
|
|
34
|
-
- name: Initialize CodeQL
|
|
35
|
-
uses: github/codeql-action/init@v2
|
|
36
|
-
with:
|
|
37
|
-
languages: ${{ matrix.language }}
|
|
38
|
-
config-file: ./.github/codeql/codeql-config.yml
|
|
39
|
-
# If you wish to specify custom queries, you can do so here or in a config file.
|
|
40
|
-
# By default, queries listed here will override any specified in a config file.
|
|
41
|
-
# Prefix the list here with "+" to use these queries and those in the config file.
|
|
42
|
-
|
|
43
|
-
# Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
|
|
44
|
-
queries: + security-and-quality
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
# Autobuild attempts to build any compiled languages (C/C++, C#, Go, or Java).
|
|
48
|
-
# If this step fails, then you should remove it and run the build manually (see below)
|
|
49
|
-
- name: Autobuild
|
|
50
|
-
uses: github/codeql-action/autobuild@v2
|
|
51
|
-
|
|
52
|
-
# ℹ️ Command-line programs to run using the OS shell.
|
|
53
|
-
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
|
|
54
|
-
|
|
55
|
-
# If the Autobuild fails above, remove it and uncomment the following three lines.
|
|
56
|
-
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
|
|
57
|
-
|
|
58
|
-
# - run: |
|
|
59
|
-
# echo "Run, Build Application using script"
|
|
60
|
-
# ./location_of_script_within_repo/buildscript.sh
|
|
61
|
-
|
|
62
|
-
- name: Perform CodeQL Analysis
|
|
63
|
-
uses: github/codeql-action/analyze@v2
|
|
64
|
-
continue-on-error: true
|
|
65
|
-
with:
|
|
66
|
-
category: "/language:${{matrix.language}}"
|