recurly 4.66.0 → 4.68.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 +22 -0
- data/GETTING_STARTED.md +1 -1
- data/lib/recurly/client/operations.rb +30 -0
- data/lib/recurly/requests/account_create.rb +4 -0
- data/lib/recurly/requests/account_note_create.rb +14 -0
- data/lib/recurly/requests/account_purchase.rb +4 -0
- data/lib/recurly/requests/account_update.rb +4 -0
- data/lib/recurly/requests/add_on_create.rb +4 -0
- data/lib/recurly/requests/add_on_update.rb +4 -0
- data/lib/recurly/requests/item_create.rb +4 -0
- data/lib/recurly/requests/item_update.rb +4 -0
- data/lib/recurly/requests/line_item_create.rb +4 -0
- data/lib/recurly/requests/plan_create.rb +4 -0
- data/lib/recurly/requests/plan_update.rb +4 -0
- data/lib/recurly/requests/subscription_create.rb +4 -0
- data/lib/recurly/requests/subscription_create_proration_settings.rb +14 -0
- data/lib/recurly/requests/subscription_purchase.rb +4 -0
- data/lib/recurly/resources/account.rb +4 -0
- data/lib/recurly/resources/add_on.rb +4 -0
- data/lib/recurly/resources/item.rb +4 -0
- data/lib/recurly/resources/line_item.rb +4 -0
- data/lib/recurly/resources/plan.rb +4 -0
- data/lib/recurly/version.rb +1 -1
- data/openapi/api.yaml +220 -6
- metadata +5 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: a0d429a15aec46da2541e4cbe69e6337c784da776d9a2fbc6ead1650244369b5
|
4
|
+
data.tar.gz: a479b2fddc061febd419f56b8d724f00f2e63412f09f77eaa5db2148f0c69b37
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: cdf453d690916bd021ef230e219d395731f7b211cd962713ac4d0bb28ee0a9f37607a021c0f0875301edebabefd01e0f48b4fdf295b7f17086f6767cbb23f8fb
|
7
|
+
data.tar.gz: d96900af9065cad77090c1f69faf96eae57c2f51af0f40da1384f8560feb63bb7fb18acccc22a032c5250e746738e1fd012e1d2c1e222045ed625ab56c62e211
|
data/.bumpversion.cfg
CHANGED
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,27 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## [4.68.0](https://github.com/recurly/recurly-client-ruby/tree/4.68.0) (2025-10-09)
|
4
|
+
|
5
|
+
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.67.0...4.68.0)
|
6
|
+
|
7
|
+
|
8
|
+
**Merged Pull Requests**
|
9
|
+
|
10
|
+
- Generated Latest Changes for v2021-02-25 [#936](https://github.com/recurly/recurly-client-ruby/pull/936) ([recurly-integrations](https://github.com/recurly-integrations))
|
11
|
+
|
12
|
+
|
13
|
+
|
14
|
+
## [4.67.0](https://github.com/recurly/recurly-client-ruby/tree/4.67.0) (2025-08-13)
|
15
|
+
|
16
|
+
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.66.0...4.67.0)
|
17
|
+
|
18
|
+
|
19
|
+
**Merged Pull Requests**
|
20
|
+
|
21
|
+
- Generated Latest Changes for v2021-02-25 [#934](https://github.com/recurly/recurly-client-ruby/pull/934) ([recurly-integrations](https://github.com/recurly-integrations))
|
22
|
+
|
23
|
+
|
24
|
+
|
3
25
|
## [4.66.0](https://github.com/recurly/recurly-client-ruby/tree/4.66.0) (2025-07-22)
|
4
26
|
|
5
27
|
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.65.0...4.66.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.68'
|
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.
|
@@ -1113,6 +1113,21 @@ module Recurly
|
|
1113
1113
|
pager(path, **options)
|
1114
1114
|
end
|
1115
1115
|
|
1116
|
+
# Create an account note
|
1117
|
+
#
|
1118
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/create_account_note create_account_note api documentation}
|
1119
|
+
#
|
1120
|
+
# @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+.
|
1121
|
+
# @param body [Requests::AccountNoteCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AccountNoteCreate}
|
1122
|
+
# @param params [Hash] Optional query string parameters:
|
1123
|
+
#
|
1124
|
+
# @return [Resources::AccountNote] An account note.
|
1125
|
+
#
|
1126
|
+
def create_account_note(account_id:, body:, **options)
|
1127
|
+
path = interpolate_path("/accounts/{account_id}/notes", account_id: account_id)
|
1128
|
+
post(path, body, Requests::AccountNoteCreate, **options)
|
1129
|
+
end
|
1130
|
+
|
1116
1131
|
# Fetch an account note
|
1117
1132
|
#
|
1118
1133
|
# {https://developers.recurly.com/api/v2021-02-25#operation/get_account_note get_account_note api documentation}
|
@@ -1140,6 +1155,21 @@ module Recurly
|
|
1140
1155
|
get(path, **options)
|
1141
1156
|
end
|
1142
1157
|
|
1158
|
+
# Delete an account note
|
1159
|
+
#
|
1160
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/remove_account_note remove_account_note api documentation}
|
1161
|
+
#
|
1162
|
+
# @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+.
|
1163
|
+
# @param account_note_id [String] Account Note ID.
|
1164
|
+
# @param params [Hash] Optional query string parameters:
|
1165
|
+
#
|
1166
|
+
# @return [Resources::Empty] Account note deleted.
|
1167
|
+
#
|
1168
|
+
def remove_account_note(account_id:, account_note_id:, **options)
|
1169
|
+
path = interpolate_path("/accounts/{account_id}/notes/{account_note_id}", account_id: account_id, account_note_id: account_note_id)
|
1170
|
+
delete(path, **options)
|
1171
|
+
end
|
1172
|
+
|
1143
1173
|
# Fetch a list of an account's shipping addresses
|
1144
1174
|
#
|
1145
1175
|
# {https://developers.recurly.com/api/v2021-02-25#operation/list_shipping_addresses list_shipping_addresses api documentation}
|
@@ -14,6 +14,10 @@ module Recurly
|
|
14
14
|
# @return [Address]
|
15
15
|
define_attribute :address, :Address
|
16
16
|
|
17
|
+
# @!attribute bill_date
|
18
|
+
# @return [DateTime] The preferred billing date for the account. This date will be used as the billing date for when activating new subscriptions on the account.
|
19
|
+
define_attribute :bill_date, DateTime
|
20
|
+
|
17
21
|
# @!attribute bill_to
|
18
22
|
# @return [String] An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.
|
19
23
|
define_attribute :bill_to, String
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# This file is automatically created by Recurly's OpenAPI generation process
|
2
|
+
# and thus any edits you make by hand will be lost. If you wish to make a
|
3
|
+
# change to this file, please create a Github issue explaining the changes you
|
4
|
+
# need and we will usher them to the appropriate places.
|
5
|
+
module Recurly
|
6
|
+
module Requests
|
7
|
+
class AccountNoteCreate < Request
|
8
|
+
|
9
|
+
# @!attribute message
|
10
|
+
# @return [String] The content of the account note.
|
11
|
+
define_attribute :message, String
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
@@ -14,6 +14,10 @@ module Recurly
|
|
14
14
|
# @return [Address]
|
15
15
|
define_attribute :address, :Address
|
16
16
|
|
17
|
+
# @!attribute bill_date
|
18
|
+
# @return [DateTime] The preferred billing date for the account. This date will be used as the billing date for when activating new subscriptions on the account.
|
19
|
+
define_attribute :bill_date, DateTime
|
20
|
+
|
17
21
|
# @!attribute bill_to
|
18
22
|
# @return [String] An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.
|
19
23
|
define_attribute :bill_to, String
|
@@ -10,6 +10,10 @@ module Recurly
|
|
10
10
|
# @return [Address]
|
11
11
|
define_attribute :address, :Address
|
12
12
|
|
13
|
+
# @!attribute bill_date
|
14
|
+
# @return [DateTime] The preferred billing date for the account. This date will be used as the billing date for when activating new subscriptions on the account.
|
15
|
+
define_attribute :bill_date, DateTime
|
16
|
+
|
13
17
|
# @!attribute bill_to
|
14
18
|
# @return [String] An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.
|
15
19
|
define_attribute :bill_to, String
|
@@ -38,6 +38,10 @@ module Recurly
|
|
38
38
|
# @return [Boolean] Determines if the quantity field is displayed on the hosted pages for the add-on.
|
39
39
|
define_attribute :display_quantity, :Boolean
|
40
40
|
|
41
|
+
# @!attribute harmonized_system_code
|
42
|
+
# @return [String] The Harmonized System (HS) code is an internationally standardized system of names and numbers to classify traded products. The HS code, sometimes called Commodity Code, is used by customs authorities around the world to identify products when assessing duties and taxes. The HS code may also be referred to as the tariff code or customs code. Values should contain only digits and decimals.
|
43
|
+
define_attribute :harmonized_system_code, String
|
44
|
+
|
41
45
|
# @!attribute item_code
|
42
46
|
# @return [String] Unique code to identify an item. Available when the `Credit Invoices` feature is enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
|
43
47
|
define_attribute :item_code, String
|
@@ -34,6 +34,10 @@ module Recurly
|
|
34
34
|
# @return [Boolean] Determines if the quantity field is displayed on the hosted pages for the add-on.
|
35
35
|
define_attribute :display_quantity, :Boolean
|
36
36
|
|
37
|
+
# @!attribute harmonized_system_code
|
38
|
+
# @return [String] The Harmonized System (HS) code is an internationally standardized system of names and numbers to classify traded products. The HS code, sometimes called Commodity Code, is used by customs authorities around the world to identify products when assessing duties and taxes. The HS code may also be referred to as the tariff code or customs code. Values should contain only digits and decimals.
|
39
|
+
define_attribute :harmonized_system_code, String
|
40
|
+
|
37
41
|
# @!attribute id
|
38
42
|
# @return [String] Add-on ID
|
39
43
|
define_attribute :id, String
|
@@ -38,6 +38,10 @@ module Recurly
|
|
38
38
|
# @return [String] Optional, stock keeping unit to link the item to other inventory systems.
|
39
39
|
define_attribute :external_sku, String
|
40
40
|
|
41
|
+
# @!attribute harmonized_system_code
|
42
|
+
# @return [String] The Harmonized System (HS) code is an internationally standardized system of names and numbers to classify traded products. The HS code, sometimes called Commodity Code, is used by customs authorities around the world to identify products when assessing duties and taxes. The HS code may also be referred to as the tariff code or customs code. Values should contain only digits and decimals.
|
43
|
+
define_attribute :harmonized_system_code, String
|
44
|
+
|
41
45
|
# @!attribute liability_gl_account_id
|
42
46
|
# @return [String] The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.
|
43
47
|
define_attribute :liability_gl_account_id, String
|
@@ -38,6 +38,10 @@ module Recurly
|
|
38
38
|
# @return [String] Optional, stock keeping unit to link the item to other inventory systems.
|
39
39
|
define_attribute :external_sku, String
|
40
40
|
|
41
|
+
# @!attribute harmonized_system_code
|
42
|
+
# @return [String] The Harmonized System (HS) code is an internationally standardized system of names and numbers to classify traded products. The HS code, sometimes called Commodity Code, is used by customs authorities around the world to identify products when assessing duties and taxes. The HS code may also be referred to as the tariff code or customs code. Values should contain only digits and decimals.
|
43
|
+
define_attribute :harmonized_system_code, String
|
44
|
+
|
41
45
|
# @!attribute liability_gl_account_id
|
42
46
|
# @return [String] The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.
|
43
47
|
define_attribute :liability_gl_account_id, String
|
@@ -42,6 +42,10 @@ module Recurly
|
|
42
42
|
# @return [DateTime] If this date is provided, it indicates the end of a time range.
|
43
43
|
define_attribute :end_date, DateTime
|
44
44
|
|
45
|
+
# @!attribute harmonized_system_code
|
46
|
+
# @return [String] The Harmonized System (HS) code is an internationally standardized system of names and numbers to classify traded products. The HS code, sometimes called Commodity Code, is used by customs authorities around the world to identify products when assessing duties and taxes. The HS code may also be referred to as the tariff code or customs code. Values should contain only digits and decimals. If `item_code`/`item_id` is part of the request then `harmonized_system_code` must be absent.
|
47
|
+
define_attribute :harmonized_system_code, String
|
48
|
+
|
45
49
|
# @!attribute item_code
|
46
50
|
# @return [String] Unique code to identify an item. Available when the Credit Invoices feature is enabled.
|
47
51
|
define_attribute :item_code, String
|
@@ -50,6 +50,10 @@ module Recurly
|
|
50
50
|
# @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
|
51
51
|
define_attribute :dunning_campaign_id, String
|
52
52
|
|
53
|
+
# @!attribute harmonized_system_code
|
54
|
+
# @return [String] The Harmonized System (HS) code is an internationally standardized system of names and numbers to classify traded products. The HS code, sometimes called Commodity Code, is used by customs authorities around the world to identify products when assessing duties and taxes. The HS code may also be referred to as the tariff code or customs code. Values should contain only digits and decimals.
|
55
|
+
define_attribute :harmonized_system_code, String
|
56
|
+
|
53
57
|
# @!attribute hosted_pages
|
54
58
|
# @return [PlanHostedPages] Hosted pages settings
|
55
59
|
define_attribute :hosted_pages, :PlanHostedPages
|
@@ -46,6 +46,10 @@ module Recurly
|
|
46
46
|
# @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
|
47
47
|
define_attribute :dunning_campaign_id, String
|
48
48
|
|
49
|
+
# @!attribute harmonized_system_code
|
50
|
+
# @return [String] The Harmonized System (HS) code is an internationally standardized system of names and numbers to classify traded products. The HS code, sometimes called Commodity Code, is used by customs authorities around the world to identify products when assessing duties and taxes. The HS code may also be referred to as the tariff code or customs code. Values should contain only digits and decimals.
|
51
|
+
define_attribute :harmonized_system_code, String
|
52
|
+
|
49
53
|
# @!attribute hosted_pages
|
50
54
|
# @return [PlanHostedPages] Hosted pages settings
|
51
55
|
define_attribute :hosted_pages, :PlanHostedPages
|
@@ -94,6 +94,10 @@ module Recurly
|
|
94
94
|
# @return [String] The price segment ID, e.g. `e28zov4fw0v2`.
|
95
95
|
define_attribute :price_segment_id, String
|
96
96
|
|
97
|
+
# @!attribute proration_settings
|
98
|
+
# @return [SubscriptionCreateProrationSettings] Allows you to control how any resulting charges will be calculated and prorated.
|
99
|
+
define_attribute :proration_settings, :SubscriptionCreateProrationSettings
|
100
|
+
|
97
101
|
# @!attribute quantity
|
98
102
|
# @return [Integer] Optionally override the default quantity of 1.
|
99
103
|
define_attribute :quantity, Integer
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# This file is automatically created by Recurly's OpenAPI generation process
|
2
|
+
# and thus any edits you make by hand will be lost. If you wish to make a
|
3
|
+
# change to this file, please create a Github issue explaining the changes you
|
4
|
+
# need and we will usher them to the appropriate places.
|
5
|
+
module Recurly
|
6
|
+
module Requests
|
7
|
+
class SubscriptionCreateProrationSettings < Request
|
8
|
+
|
9
|
+
# @!attribute charge
|
10
|
+
# @return [String] Determines how the amount charged is determined for this change
|
11
|
+
define_attribute :charge, String
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
@@ -38,6 +38,10 @@ module Recurly
|
|
38
38
|
# @return [String] The price segment ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For requests, the code can also be used. Use prefix `code-`, e.g. `code-gold`.
|
39
39
|
define_attribute :price_segment_id, String
|
40
40
|
|
41
|
+
# @!attribute proration_settings
|
42
|
+
# @return [SubscriptionCreateProrationSettings] Allows you to control how any resulting charges will be calculated and prorated.
|
43
|
+
define_attribute :proration_settings, :SubscriptionCreateProrationSettings
|
44
|
+
|
41
45
|
# @!attribute quantity
|
42
46
|
# @return [Integer] Optionally override the default quantity of 1.
|
43
47
|
define_attribute :quantity, Integer
|
@@ -10,6 +10,10 @@ module Recurly
|
|
10
10
|
# @return [Address]
|
11
11
|
define_attribute :address, :Address
|
12
12
|
|
13
|
+
# @!attribute bill_date
|
14
|
+
# @return [DateTime] The preferred billing date for the account. This date will be used as the billing date for when activating new subscriptions on the account.
|
15
|
+
define_attribute :bill_date, DateTime
|
16
|
+
|
13
17
|
# @!attribute bill_to
|
14
18
|
# @return [String] An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.
|
15
19
|
define_attribute :bill_to, String
|
@@ -50,6 +50,10 @@ module Recurly
|
|
50
50
|
# @return [String] Optional, stock keeping unit to link the item to other inventory systems.
|
51
51
|
define_attribute :external_sku, String
|
52
52
|
|
53
|
+
# @!attribute harmonized_system_code
|
54
|
+
# @return [String] The Harmonized System (HS) code is an internationally standardized system of names and numbers to classify traded products. The HS code, sometimes called Commodity Code, is used by customs authorities around the world to identify products when assessing duties and taxes. The HS code may also be referred to as the tariff code or customs code. Values should contain only digits and decimals.
|
55
|
+
define_attribute :harmonized_system_code, String
|
56
|
+
|
53
57
|
# @!attribute id
|
54
58
|
# @return [String] Add-on ID
|
55
59
|
define_attribute :id, String
|
@@ -46,6 +46,10 @@ module Recurly
|
|
46
46
|
# @return [String] Optional, stock keeping unit to link the item to other inventory systems.
|
47
47
|
define_attribute :external_sku, String
|
48
48
|
|
49
|
+
# @!attribute harmonized_system_code
|
50
|
+
# @return [String] The Harmonized System (HS) code is an internationally standardized system of names and numbers to classify traded products. The HS code, sometimes called Commodity Code, is used by customs authorities around the world to identify products when assessing duties and taxes. The HS code may also be referred to as the tariff code or customs code. Values should contain only digits and decimals.
|
51
|
+
define_attribute :harmonized_system_code, String
|
52
|
+
|
49
53
|
# @!attribute id
|
50
54
|
# @return [String] Item ID
|
51
55
|
define_attribute :id, String
|
@@ -78,6 +78,10 @@ module Recurly
|
|
78
78
|
# @return [String] Optional Stock Keeping Unit assigned to an item. Available when the Credit Invoices feature is enabled.
|
79
79
|
define_attribute :external_sku, String
|
80
80
|
|
81
|
+
# @!attribute harmonized_system_code
|
82
|
+
# @return [String] The Harmonized System (HS) code is an internationally standardized system of names and numbers to classify traded products. The HS code, sometimes called Commodity Code, is used by customs authorities around the world to identify products when assessing duties and taxes. The HS code may also be referred to as the tariff code or customs code. Values should contain only digits and decimals.
|
83
|
+
define_attribute :harmonized_system_code, String
|
84
|
+
|
81
85
|
# @!attribute id
|
82
86
|
# @return [String] Line item ID
|
83
87
|
define_attribute :id, String
|
@@ -54,6 +54,10 @@ module Recurly
|
|
54
54
|
# @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
|
55
55
|
define_attribute :dunning_campaign_id, String
|
56
56
|
|
57
|
+
# @!attribute harmonized_system_code
|
58
|
+
# @return [String] The Harmonized System (HS) code is an internationally standardized system of names and numbers to classify traded products. The HS code, sometimes called Commodity Code, is used by customs authorities around the world to identify products when assessing duties and taxes. The HS code may also be referred to as the tariff code or customs code. Values should contain only digits and decimals.
|
59
|
+
define_attribute :harmonized_system_code, String
|
60
|
+
|
57
61
|
# @!attribute hosted_pages
|
58
62
|
# @return [PlanHostedPages] Hosted pages settings
|
59
63
|
define_attribute :hosted_pages, :PlanHostedPages
|
data/lib/recurly/version.rb
CHANGED
data/openapi/api.yaml
CHANGED
@@ -4462,6 +4462,51 @@ paths:
|
|
4462
4462
|
accountNotes.Fetch()\n\tif e, ok := err.(*recurly.Error); ok {\n\t\tfmt.Printf(\"Failed
|
4463
4463
|
to retrieve next page: %v\", e)\n\t\tbreak\n\t}\n\tfor i, note := range
|
4464
4464
|
accountNotes.Data() {\n\t\tfmt.Printf(\"Account Note %3d: %s\\n\",\n\t\t\ti,\n\t\t\tnote.Id,\n\t\t)\n\t}\n}"
|
4465
|
+
post:
|
4466
|
+
tags:
|
4467
|
+
- note
|
4468
|
+
operationId: create_account_note
|
4469
|
+
summary: Create an account note
|
4470
|
+
parameters:
|
4471
|
+
- "$ref": "#/components/parameters/account_id"
|
4472
|
+
requestBody:
|
4473
|
+
content:
|
4474
|
+
application/json:
|
4475
|
+
schema:
|
4476
|
+
"$ref": "#/components/schemas/AccountNoteCreate"
|
4477
|
+
required: true
|
4478
|
+
responses:
|
4479
|
+
'201':
|
4480
|
+
description: An account note.
|
4481
|
+
content:
|
4482
|
+
application/json:
|
4483
|
+
schema:
|
4484
|
+
"$ref": "#/components/schemas/AccountNote"
|
4485
|
+
'400':
|
4486
|
+
description: Bad request; perhaps missing or invalid parameters.
|
4487
|
+
content:
|
4488
|
+
application/json:
|
4489
|
+
schema:
|
4490
|
+
"$ref": "#/components/schemas/Error"
|
4491
|
+
'404':
|
4492
|
+
description: Incorrect site or account ID.
|
4493
|
+
content:
|
4494
|
+
application/json:
|
4495
|
+
schema:
|
4496
|
+
"$ref": "#/components/schemas/Error"
|
4497
|
+
'422':
|
4498
|
+
description: A validation error.
|
4499
|
+
content:
|
4500
|
+
application/json:
|
4501
|
+
schema:
|
4502
|
+
"$ref": "#/components/schemas/Error"
|
4503
|
+
default:
|
4504
|
+
description: Unexpected error.
|
4505
|
+
content:
|
4506
|
+
application/json:
|
4507
|
+
schema:
|
4508
|
+
"$ref": "#/components/schemas/Error"
|
4509
|
+
x-code-samples: []
|
4465
4510
|
"/accounts/{account_id}/notes/{account_note_id}":
|
4466
4511
|
get:
|
4467
4512
|
tags:
|
@@ -4470,12 +4515,7 @@ paths:
|
|
4470
4515
|
summary: Fetch an account note
|
4471
4516
|
parameters:
|
4472
4517
|
- "$ref": "#/components/parameters/account_id"
|
4473
|
-
-
|
4474
|
-
in: path
|
4475
|
-
description: Account Note ID.
|
4476
|
-
required: true
|
4477
|
-
schema:
|
4478
|
-
type: string
|
4518
|
+
- "$ref": "#/components/parameters/account_note_id"
|
4479
4519
|
responses:
|
4480
4520
|
'200':
|
4481
4521
|
description: An account note.
|
@@ -4588,6 +4628,30 @@ paths:
|
|
4588
4628
|
{\n\t\tfmt.Printf(\"Resource not found: %v\", e)\n\t\treturn nil, err\n\t}\n\tfmt.Printf(\"Unexpected
|
4589
4629
|
Recurly error: %v\", e)\n\treturn nil, err\n}\nfmt.Printf(\"Fetched Account
|
4590
4630
|
Note: %v\", accountNote)"
|
4631
|
+
delete:
|
4632
|
+
tags:
|
4633
|
+
- note
|
4634
|
+
operationId: remove_account_note
|
4635
|
+
summary: Delete an account note
|
4636
|
+
parameters:
|
4637
|
+
- "$ref": "#/components/parameters/account_id"
|
4638
|
+
- "$ref": "#/components/parameters/account_note_id"
|
4639
|
+
responses:
|
4640
|
+
'204':
|
4641
|
+
description: Account note deleted.
|
4642
|
+
'404':
|
4643
|
+
description: Incorrect site, account or note ID.
|
4644
|
+
content:
|
4645
|
+
application/json:
|
4646
|
+
schema:
|
4647
|
+
"$ref": "#/components/schemas/Error"
|
4648
|
+
default:
|
4649
|
+
description: Unexpected error.
|
4650
|
+
content:
|
4651
|
+
application/json:
|
4652
|
+
schema:
|
4653
|
+
"$ref": "#/components/schemas/Error"
|
4654
|
+
x-code-samples: []
|
4591
4655
|
"/accounts/{account_id}/shipping_addresses":
|
4592
4656
|
get:
|
4593
4657
|
tags:
|
@@ -16941,6 +17005,13 @@ components:
|
|
16941
17005
|
required: true
|
16942
17006
|
schema:
|
16943
17007
|
type: string
|
17008
|
+
account_note_id:
|
17009
|
+
name: account_note_id
|
17010
|
+
in: path
|
17011
|
+
description: Account Note ID.
|
17012
|
+
required: true
|
17013
|
+
schema:
|
17014
|
+
type: string
|
16944
17015
|
add_on_id:
|
16945
17016
|
name: add_on_id
|
16946
17017
|
in: path
|
@@ -18046,6 +18117,13 @@ components:
|
|
18046
18117
|
description: The Avalara AvaTax value that can be passed to identify the
|
18047
18118
|
customer type for tax purposes. The range of values can be A - R (more
|
18048
18119
|
info at Avalara). Value is case-sensitive.
|
18120
|
+
bill_date:
|
18121
|
+
type: string
|
18122
|
+
title: Bill Date
|
18123
|
+
format: date-time
|
18124
|
+
description: The preferred billing date for the account. This date will
|
18125
|
+
be used as the billing date for when activating new subscriptions on the
|
18126
|
+
account.
|
18049
18127
|
AccountResponse:
|
18050
18128
|
type: object
|
18051
18129
|
properties:
|
@@ -18152,6 +18230,13 @@ components:
|
|
18152
18230
|
description: The Avalara AvaTax value that can be passed to identify the
|
18153
18231
|
customer type for tax purposes. The range of values can be A - R (more
|
18154
18232
|
info at Avalara). Value is case-sensitive.
|
18233
|
+
bill_date:
|
18234
|
+
title: Bill Date
|
18235
|
+
type: string
|
18236
|
+
format: date-time
|
18237
|
+
description: The preferred billing date for the account. This date will
|
18238
|
+
be used as the billing date for when activating new subscriptions on the
|
18239
|
+
account.
|
18155
18240
|
AccountNote:
|
18156
18241
|
type: object
|
18157
18242
|
required:
|
@@ -18175,6 +18260,14 @@ components:
|
|
18175
18260
|
type: string
|
18176
18261
|
format: date-time
|
18177
18262
|
readOnly: true
|
18263
|
+
AccountNoteCreate:
|
18264
|
+
type: object
|
18265
|
+
required:
|
18266
|
+
- message
|
18267
|
+
properties:
|
18268
|
+
message:
|
18269
|
+
type: string
|
18270
|
+
description: The content of the account note.
|
18178
18271
|
AccountMini:
|
18179
18272
|
type: object
|
18180
18273
|
title: Account mini details
|
@@ -18488,6 +18581,17 @@ components:
|
|
18488
18581
|
offering you can also choose to instead use simple values of `unknown`,
|
18489
18582
|
`physical`, or `digital` tax codes. If `item_code`/`item_id` is part of
|
18490
18583
|
the request then `tax_code` must be absent.
|
18584
|
+
harmonized_system_code:
|
18585
|
+
type: string
|
18586
|
+
title: Harmonized System code
|
18587
|
+
description: The Harmonized System (HS) code is an internationally standardized
|
18588
|
+
system of names and numbers to classify traded products. The HS code,
|
18589
|
+
sometimes called Commodity Code, is used by customs authorities around
|
18590
|
+
the world to identify products when assessing duties and taxes. The HS
|
18591
|
+
code may also be referred to as the tariff code or customs code. Values
|
18592
|
+
should contain only digits and decimals.
|
18593
|
+
pattern: "^\\d+(\\.\\d+)*$"
|
18594
|
+
maxLength: 25
|
18491
18595
|
display_quantity:
|
18492
18596
|
type: boolean
|
18493
18597
|
title: Display quantity?
|
@@ -18710,6 +18814,17 @@ components:
|
|
18710
18814
|
offering you can also choose to instead use simple values of `unknown`,
|
18711
18815
|
`physical`, or `digital` tax codes. If `item_code`/`item_id` is part of
|
18712
18816
|
the request then `tax_code` must be absent.
|
18817
|
+
harmonized_system_code:
|
18818
|
+
type: string
|
18819
|
+
title: Harmonized System code
|
18820
|
+
description: The Harmonized System (HS) code is an internationally standardized
|
18821
|
+
system of names and numbers to classify traded products. The HS code,
|
18822
|
+
sometimes called Commodity Code, is used by customs authorities around
|
18823
|
+
the world to identify products when assessing duties and taxes. The HS
|
18824
|
+
code may also be referred to as the tariff code or customs code. Values
|
18825
|
+
should contain only digits and decimals.
|
18826
|
+
pattern: "^\\d+(\\.\\d+)*$"
|
18827
|
+
maxLength: 25
|
18713
18828
|
currencies:
|
18714
18829
|
type: array
|
18715
18830
|
title: Add-on pricing
|
@@ -18865,6 +18980,17 @@ components:
|
|
18865
18980
|
offering you can also choose to instead use simple values of `unknown`,
|
18866
18981
|
`physical`, or `digital` tax codes. If an `Item` is associated to the
|
18867
18982
|
`AddOn` then `tax_code` must be absent.
|
18983
|
+
harmonized_system_code:
|
18984
|
+
type: string
|
18985
|
+
title: Harmonized System code
|
18986
|
+
description: The Harmonized System (HS) code is an internationally standardized
|
18987
|
+
system of names and numbers to classify traded products. The HS code,
|
18988
|
+
sometimes called Commodity Code, is used by customs authorities around
|
18989
|
+
the world to identify products when assessing duties and taxes. The HS
|
18990
|
+
code may also be referred to as the tariff code or customs code. Values
|
18991
|
+
should contain only digits and decimals.
|
18992
|
+
pattern: "^\\d+(\\.\\d+)*$"
|
18993
|
+
maxLength: 25
|
18868
18994
|
display_quantity:
|
18869
18995
|
type: boolean
|
18870
18996
|
title: Display quantity?
|
@@ -20207,6 +20333,17 @@ components:
|
|
20207
20333
|
codes using any of these tax integrations. For Recurly's In-the-Box tax
|
20208
20334
|
offering you can also choose to instead use simple values of `unknown`,
|
20209
20335
|
`physical`, or `digital` tax codes.
|
20336
|
+
harmonized_system_code:
|
20337
|
+
type: string
|
20338
|
+
title: Harmonized System code
|
20339
|
+
description: The Harmonized System (HS) code is an internationally standardized
|
20340
|
+
system of names and numbers to classify traded products. The HS code,
|
20341
|
+
sometimes called Commodity Code, is used by customs authorities around
|
20342
|
+
the world to identify products when assessing duties and taxes. The HS
|
20343
|
+
code may also be referred to as the tariff code or customs code. Values
|
20344
|
+
should contain only digits and decimals.
|
20345
|
+
pattern: "^\\d+(\\.\\d+)*$"
|
20346
|
+
maxLength: 25
|
20210
20347
|
tax_exempt:
|
20211
20348
|
type: boolean
|
20212
20349
|
title: Tax exempt?
|
@@ -20317,6 +20454,17 @@ components:
|
|
20317
20454
|
codes using any of these tax integrations. For Recurly's In-the-Box tax
|
20318
20455
|
offering you can also choose to instead use simple values of `unknown`,
|
20319
20456
|
`physical`, or `digital` tax codes.
|
20457
|
+
harmonized_system_code:
|
20458
|
+
type: string
|
20459
|
+
title: Harmonized System code
|
20460
|
+
description: The Harmonized System (HS) code is an internationally standardized
|
20461
|
+
system of names and numbers to classify traded products. The HS code,
|
20462
|
+
sometimes called Commodity Code, is used by customs authorities around
|
20463
|
+
the world to identify products when assessing duties and taxes. The HS
|
20464
|
+
code may also be referred to as the tariff code or customs code. Values
|
20465
|
+
should contain only digits and decimals.
|
20466
|
+
pattern: "^\\d+(\\.\\d+)*$"
|
20467
|
+
maxLength: 25
|
20320
20468
|
tax_exempt:
|
20321
20469
|
type: boolean
|
20322
20470
|
title: Tax exempt?
|
@@ -20415,6 +20563,17 @@ components:
|
|
20415
20563
|
codes using any of these tax integrations. For Recurly's In-the-Box tax
|
20416
20564
|
offering you can also choose to instead use simple values of `unknown`,
|
20417
20565
|
`physical`, or `digital` tax codes.
|
20566
|
+
harmonized_system_code:
|
20567
|
+
type: string
|
20568
|
+
title: Harmonized System Code
|
20569
|
+
description: The Harmonized System (HS) code is an internationally standardized
|
20570
|
+
system of names and numbers to classify traded products. The HS code,
|
20571
|
+
sometimes called Commodity Code, is used by customs authorities around
|
20572
|
+
the world to identify products when assessing duties and taxes. The HS
|
20573
|
+
code may also be referred to as the tariff code or customs code. Values
|
20574
|
+
should contain only digits and decimals.
|
20575
|
+
pattern: "^\\d+(\\.\\d+)*$"
|
20576
|
+
maxLength: 25
|
20418
20577
|
tax_exempt:
|
20419
20578
|
type: boolean
|
20420
20579
|
title: Tax exempt?
|
@@ -21310,6 +21469,17 @@ components:
|
|
21310
21469
|
codes using any of these tax integrations. For Recurly's In-the-Box tax
|
21311
21470
|
offering you can also choose to instead use simple values of `unknown`,
|
21312
21471
|
`physical`, or `digital` tax codes.
|
21472
|
+
harmonized_system_code:
|
21473
|
+
type: string
|
21474
|
+
title: Harmonized System Code
|
21475
|
+
description: The Harmonized System (HS) code is an internationally standardized
|
21476
|
+
system of names and numbers to classify traded products. The HS code,
|
21477
|
+
sometimes called Commodity Code, is used by customs authorities around
|
21478
|
+
the world to identify products when assessing duties and taxes. The HS
|
21479
|
+
code may also be referred to as the tariff code or customs code. Values
|
21480
|
+
should contain only digits and decimals.
|
21481
|
+
maxLength: 25
|
21482
|
+
pattern: "^\\d+(\\.\\d+)*$"
|
21313
21483
|
tax_info:
|
21314
21484
|
"$ref": "#/components/schemas/TaxInfo"
|
21315
21485
|
origin_tax_address_source:
|
@@ -21554,6 +21724,18 @@ components:
|
|
21554
21724
|
codes using any of these tax integrations. For Recurly's In-the-Box tax
|
21555
21725
|
offering you can also choose to instead use simple values of `unknown`,
|
21556
21726
|
`physical`, or `digital` tax codes.
|
21727
|
+
harmonized_system_code:
|
21728
|
+
type: string
|
21729
|
+
title: Harmonized System Code
|
21730
|
+
description: The Harmonized System (HS) code is an internationally standardized
|
21731
|
+
system of names and numbers to classify traded products. The HS code,
|
21732
|
+
sometimes called Commodity Code, is used by customs authorities around
|
21733
|
+
the world to identify products when assessing duties and taxes. The HS
|
21734
|
+
code may also be referred to as the tariff code or customs code. Values
|
21735
|
+
should contain only digits and decimals. If `item_code`/`item_id` is part
|
21736
|
+
of the request then `harmonized_system_code` must be absent.
|
21737
|
+
maxLength: 25
|
21738
|
+
pattern: "^\\d+(\\.\\d+)*$"
|
21557
21739
|
product_code:
|
21558
21740
|
type: string
|
21559
21741
|
title: Product code
|
@@ -21749,6 +21931,17 @@ components:
|
|
21749
21931
|
codes using any of these tax integrations. For Recurly's In-the-Box tax
|
21750
21932
|
offering you can also choose to instead use simple values of `unknown`,
|
21751
21933
|
`physical`, or `digital` tax codes.
|
21934
|
+
harmonized_system_code:
|
21935
|
+
type: string
|
21936
|
+
title: Harmonized System Code
|
21937
|
+
description: The Harmonized System (HS) code is an internationally standardized
|
21938
|
+
system of names and numbers to classify traded products. The HS code,
|
21939
|
+
sometimes called Commodity Code, is used by customs authorities around
|
21940
|
+
the world to identify products when assessing duties and taxes. The HS
|
21941
|
+
code may also be referred to as the tariff code or customs code. Values
|
21942
|
+
should contain only digits and decimals.
|
21943
|
+
maxLength: 25
|
21944
|
+
pattern: "^\\d+(\\.\\d+)*$"
|
21752
21945
|
tax_exempt:
|
21753
21946
|
type: boolean
|
21754
21947
|
title: Tax exempt?
|
@@ -22182,6 +22375,22 @@ components:
|
|
22182
22375
|
- full_amount
|
22183
22376
|
- prorated_amount
|
22184
22377
|
- none
|
22378
|
+
SubscriptionCreateProrationSettings:
|
22379
|
+
type: object
|
22380
|
+
title: Proration Settings
|
22381
|
+
description: Allows you to control how any resulting charges will be calculated
|
22382
|
+
and prorated.
|
22383
|
+
properties:
|
22384
|
+
charge:
|
22385
|
+
"$ref": "#/components/schemas/SubscriptionCreateProrationSettingsChargeEnum"
|
22386
|
+
SubscriptionCreateProrationSettingsChargeEnum:
|
22387
|
+
type: string
|
22388
|
+
title: Charge
|
22389
|
+
description: Determines how the amount charged is determined for this change
|
22390
|
+
default: prorated_amount
|
22391
|
+
enum:
|
22392
|
+
- full_amount
|
22393
|
+
- prorated_amount
|
22185
22394
|
Settings:
|
22186
22395
|
type: object
|
22187
22396
|
properties:
|
@@ -23787,6 +23996,8 @@ components:
|
|
23787
23996
|
second limit on creating subscriptions. Should only be used when creating
|
23788
23997
|
subscriptions in bulk from the API.
|
23789
23998
|
default: false
|
23999
|
+
proration_settings:
|
24000
|
+
"$ref": "#/components/schemas/SubscriptionCreateProrationSettings"
|
23790
24001
|
required:
|
23791
24002
|
- plan_code
|
23792
24003
|
- currency
|
@@ -23898,6 +24109,8 @@ components:
|
|
23898
24109
|
second limit on creating subscriptions. Should only be used when creating
|
23899
24110
|
subscriptions in bulk from the API.
|
23900
24111
|
default: false
|
24112
|
+
proration_settings:
|
24113
|
+
"$ref": "#/components/schemas/SubscriptionCreateProrationSettings"
|
23901
24114
|
required:
|
23902
24115
|
- plan_code
|
23903
24116
|
SubscriptionUpdate:
|
@@ -27032,6 +27245,7 @@ components:
|
|
27032
27245
|
- eft
|
27033
27246
|
- gateway_token
|
27034
27247
|
- google_pay
|
27248
|
+
- google_pay_device_pan
|
27035
27249
|
- iban_bank_account
|
27036
27250
|
- money_order
|
27037
27251
|
- other
|
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.68.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Recurly
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2025-
|
11
|
+
date: 2025-10-09 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: base64
|
@@ -167,6 +167,7 @@ files:
|
|
167
167
|
- lib/recurly/requests/account_acquisition_update.rb
|
168
168
|
- lib/recurly/requests/account_create.rb
|
169
169
|
- lib/recurly/requests/account_external_subscription.rb
|
170
|
+
- lib/recurly/requests/account_note_create.rb
|
170
171
|
- lib/recurly/requests/account_purchase.rb
|
171
172
|
- lib/recurly/requests/account_reference.rb
|
172
173
|
- lib/recurly/requests/account_update.rb
|
@@ -244,6 +245,7 @@ files:
|
|
244
245
|
- lib/recurly/requests/subscription_change_create.rb
|
245
246
|
- lib/recurly/requests/subscription_change_shipping_create.rb
|
246
247
|
- lib/recurly/requests/subscription_create.rb
|
248
|
+
- lib/recurly/requests/subscription_create_proration_settings.rb
|
247
249
|
- lib/recurly/requests/subscription_pause.rb
|
248
250
|
- lib/recurly/requests/subscription_purchase.rb
|
249
251
|
- lib/recurly/requests/subscription_ramp_interval.rb
|
@@ -384,7 +386,7 @@ metadata:
|
|
384
386
|
changelog_uri: https://github.com/recurly/recurly-client-ruby/blob/master/CHANGELOG.md
|
385
387
|
documentation_uri: https://recurly.github.io/recurly-client-ruby/
|
386
388
|
homepage_uri: https://github.com/recurly/recurly-client-ruby
|
387
|
-
source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.
|
389
|
+
source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.68.0
|
388
390
|
post_install_message:
|
389
391
|
rdoc_options: []
|
390
392
|
require_paths:
|