recurly 3.10.0 → 3.11.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.bumpversion.cfg +1 -2
- data/CHANGELOG.md +14 -2
- data/GETTING_STARTED.md +1 -1
- data/lib/recurly/client/operations.rb +12 -0
- data/lib/recurly/requests/add_on_create.rb +8 -0
- data/lib/recurly/requests/add_on_update.rb +8 -0
- data/lib/recurly/requests/item_create.rb +8 -0
- data/lib/recurly/requests/item_update.rb +8 -0
- data/lib/recurly/requests/line_item_create.rb +8 -0
- data/lib/recurly/requests/plan_create.rb +8 -0
- data/lib/recurly/requests/plan_update.rb +8 -0
- data/lib/recurly/requests/shipping_purchase.rb +1 -1
- data/lib/recurly/requests/subscription_change_create.rb +1 -1
- data/lib/recurly/resources/add_on.rb +8 -0
- data/lib/recurly/resources/item.rb +8 -0
- data/lib/recurly/resources/line_item.rb +8 -0
- data/lib/recurly/resources/plan.rb +8 -0
- data/lib/recurly/version.rb +1 -1
- data/openapi/api.yaml +191 -6
- metadata +6 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d7c4b3b9b2cedb2d4a270b6389398aee741897f30a51cfd00eae35746a3a7aeb
|
4
|
+
data.tar.gz: ce7e3f717867391e5fe8166e20b99e245860e49cc771776162b2907849e0782f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 536849cb9480c6aedee06f854acef1a3c7da72c24fddf80adefcd58e55cdbcc743b96fd20f8cda811813d946f5d77078801595903345ed58405b54f0884ba86a
|
7
|
+
data.tar.gz: 926318d0ce21e23ecaadb98a9b6ad1e4403bce42bfcc7cbb09847643ba0080832612edbfe6df7edc1c98af71ca282cb7580abf00d20a32f05b1353b852cb85b1
|
data/.bumpversion.cfg
CHANGED
@@ -1,5 +1,5 @@
|
|
1
1
|
[bumpversion]
|
2
|
-
current_version = 3.
|
2
|
+
current_version = 3.11.0
|
3
3
|
parse = (?P<major>\d+)
|
4
4
|
\.(?P<minor>\d+)
|
5
5
|
\.(?P<patch>\d+)
|
@@ -13,4 +13,3 @@ serialize =
|
|
13
13
|
[bumpversion:file:GETTING_STARTED.md]
|
14
14
|
parse = (?P<major>\d+)\.(?P<minor>\d+)
|
15
15
|
serialize = {major}.{minor}
|
16
|
-
|
data/CHANGELOG.md
CHANGED
@@ -1,8 +1,20 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
-
## [3.
|
3
|
+
## [3.11.0](https://github.com/recurly/recurly-client-ruby/tree/HEAD)
|
4
4
|
|
5
|
-
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.
|
5
|
+
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.10.0...HEAD)
|
6
|
+
|
7
|
+
**Implemented enhancements:**
|
8
|
+
|
9
|
+
- Fri Aug 21 16:17:28 UTC 2020 Upgrade API version v2019-10-10 [\#629](https://github.com/recurly/recurly-client-ruby/pull/629) ([douglasmiller](https://github.com/douglasmiller))
|
10
|
+
|
11
|
+
**Merged pull requests:**
|
12
|
+
|
13
|
+
- Release 3.11.0 [\#630](https://github.com/recurly/recurly-client-ruby/pull/630) ([douglasmiller](https://github.com/douglasmiller))
|
14
|
+
|
15
|
+
## [3.10.0](https://github.com/recurly/recurly-client-ruby/tree/3.10.0) (2020-07-31)
|
16
|
+
|
17
|
+
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.9.0...3.10.0)
|
6
18
|
|
7
19
|
**Implemented enhancements:**
|
8
20
|
|
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', '~> 3.
|
8
|
+
gem 'recurly', '~> 3.11'
|
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.
|
@@ -3316,6 +3316,18 @@ module Recurly
|
|
3316
3316
|
#
|
3317
3317
|
# @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
3318
|
# @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+.
|
3319
|
+
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
3320
|
+
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
|
3321
|
+
#
|
3322
|
+
# *Important notes:*
|
3323
|
+
#
|
3324
|
+
# * The +ids+ parameter cannot be used with any other ordering or filtering
|
3325
|
+
# parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
|
3326
|
+
# * Invalid or unknown IDs will be ignored, so you should check that the
|
3327
|
+
# results correspond to your request.
|
3328
|
+
# * Records are returned in an arbitrary order. Since results are all
|
3329
|
+
# returned at once you can sort the records yourself.
|
3330
|
+
#
|
3319
3331
|
# @param limit [Integer] Limit number of records 1-200.
|
3320
3332
|
# @param order [String] Sort order.
|
3321
3333
|
# @param sort [String] Sort field. You *really* only want to sort by +usage_timestamp+ in ascending
|
@@ -14,6 +14,14 @@ module Recurly
|
|
14
14
|
# @return [String] Whether the add-on type is fixed, or usage-based.
|
15
15
|
define_attribute :add_on_type, String
|
16
16
|
|
17
|
+
# @!attribute avalara_service_type
|
18
|
+
# @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the add-on is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types. If an `Item` is associated to the `AddOn`, then the `avalara_service_type` must be absent.
|
19
|
+
define_attribute :avalara_service_type, Integer
|
20
|
+
|
21
|
+
# @!attribute avalara_transaction_type
|
22
|
+
# @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the add-on is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types. If an `Item` is associated to the `AddOn`, then the `avalara_transaction_type` must be absent.
|
23
|
+
define_attribute :avalara_transaction_type, Integer
|
24
|
+
|
17
25
|
# @!attribute code
|
18
26
|
# @return [String] The unique identifier for the add-on within its plan. If `item_code`/`item_id` is part of the request then `code` must be absent. If `item_code`/`item_id` is not present `code` is required.
|
19
27
|
define_attribute :code, String
|
@@ -10,6 +10,14 @@ module Recurly
|
|
10
10
|
# @return [String] Accounting code for invoice line items for this add-on. If no value is provided, it defaults to add-on's code. If an `Item` is associated to the `AddOn` then `accounting code` must be absent.
|
11
11
|
define_attribute :accounting_code, String
|
12
12
|
|
13
|
+
# @!attribute avalara_service_type
|
14
|
+
# @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the add-on is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types. If an `Item` is associated to the `AddOn`, then the `avalara_service_type` must be absent.
|
15
|
+
define_attribute :avalara_service_type, Integer
|
16
|
+
|
17
|
+
# @!attribute avalara_transaction_type
|
18
|
+
# @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the add-on is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types. If an `Item` is associated to the `AddOn`, then the `avalara_transaction_type` must be absent.
|
19
|
+
define_attribute :avalara_transaction_type, Integer
|
20
|
+
|
13
21
|
# @!attribute code
|
14
22
|
# @return [String] The unique identifier for the add-on within its plan. If an `Item` is associated to the `AddOn` then `code` must be absent.
|
15
23
|
define_attribute :code, String
|
@@ -10,6 +10,14 @@ module Recurly
|
|
10
10
|
# @return [String] Accounting code for invoice line items.
|
11
11
|
define_attribute :accounting_code, String
|
12
12
|
|
13
|
+
# @!attribute avalara_service_type
|
14
|
+
# @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the item is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
|
15
|
+
define_attribute :avalara_service_type, Integer
|
16
|
+
|
17
|
+
# @!attribute avalara_transaction_type
|
18
|
+
# @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the item is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
|
19
|
+
define_attribute :avalara_transaction_type, Integer
|
20
|
+
|
13
21
|
# @!attribute code
|
14
22
|
# @return [String] Unique code to identify the item.
|
15
23
|
define_attribute :code, String
|
@@ -10,6 +10,14 @@ module Recurly
|
|
10
10
|
# @return [String] Accounting code for invoice line items.
|
11
11
|
define_attribute :accounting_code, String
|
12
12
|
|
13
|
+
# @!attribute avalara_service_type
|
14
|
+
# @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the item is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
|
15
|
+
define_attribute :avalara_service_type, Integer
|
16
|
+
|
17
|
+
# @!attribute avalara_transaction_type
|
18
|
+
# @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the item is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
|
19
|
+
define_attribute :avalara_transaction_type, Integer
|
20
|
+
|
13
21
|
# @!attribute code
|
14
22
|
# @return [String] Unique code to identify the item.
|
15
23
|
define_attribute :code, String
|
@@ -10,6 +10,14 @@ module Recurly
|
|
10
10
|
# @return [String] Accounting Code for the `LineItem`. If `item_code`/`item_id` is part of the request then `accounting_code` must be absent.
|
11
11
|
define_attribute :accounting_code, String
|
12
12
|
|
13
|
+
# @!attribute avalara_service_type
|
14
|
+
# @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the line item is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types. If an `Item` is associated to the `LineItem`, then the `avalara_service_type` must be absent.
|
15
|
+
define_attribute :avalara_service_type, Integer
|
16
|
+
|
17
|
+
# @!attribute avalara_transaction_type
|
18
|
+
# @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the line item is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types. If an `Item` is associated to the `LineItem`, then the `avalara_transaction_type` must be absent.
|
19
|
+
define_attribute :avalara_transaction_type, Integer
|
20
|
+
|
13
21
|
# @!attribute credit_reason_code
|
14
22
|
# @return [String] The reason the credit was given when line item is `type=credit`. When the Credit Invoices feature is enabled, the value can be set and will default to `general`. When the Credit Invoices feature is not enabled, the value will always be `null`.
|
15
23
|
define_attribute :credit_reason_code, String
|
@@ -22,6 +22,14 @@ module Recurly
|
|
22
22
|
# @return [Boolean] Subscriptions will automatically inherit this value once they are active. If `auto_renew` is `true`, then a subscription will automatically renew its term at renewal. If `auto_renew` is `false`, then a subscription will expire at the end of its term. `auto_renew` can be overridden on the subscription record itself.
|
23
23
|
define_attribute :auto_renew, :Boolean
|
24
24
|
|
25
|
+
# @!attribute avalara_service_type
|
26
|
+
# @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the plan is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
|
27
|
+
define_attribute :avalara_service_type, Integer
|
28
|
+
|
29
|
+
# @!attribute avalara_transaction_type
|
30
|
+
# @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the plan is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
|
31
|
+
define_attribute :avalara_transaction_type, Integer
|
32
|
+
|
25
33
|
# @!attribute code
|
26
34
|
# @return [String] Unique code to identify the plan. This is used in Hosted Payment Page URLs and in the invoice exports.
|
27
35
|
define_attribute :code, String
|
@@ -22,6 +22,14 @@ module Recurly
|
|
22
22
|
# @return [Boolean] Subscriptions will automatically inherit this value once they are active. If `auto_renew` is `true`, then a subscription will automatically renew its term at renewal. If `auto_renew` is `false`, then a subscription will expire at the end of its term. `auto_renew` can be overridden on the subscription record itself.
|
23
23
|
define_attribute :auto_renew, :Boolean
|
24
24
|
|
25
|
+
# @!attribute avalara_service_type
|
26
|
+
# @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the plan is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
|
27
|
+
define_attribute :avalara_service_type, Integer
|
28
|
+
|
29
|
+
# @!attribute avalara_transaction_type
|
30
|
+
# @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the plan is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
|
31
|
+
define_attribute :avalara_transaction_type, Integer
|
32
|
+
|
25
33
|
# @!attribute code
|
26
34
|
# @return [String] Unique code to identify the plan. This is used in Hosted Payment Page URLs and in the invoice exports.
|
27
35
|
define_attribute :code, String
|
@@ -11,7 +11,7 @@ module Recurly
|
|
11
11
|
define_attribute :address, :ShippingAddressCreate
|
12
12
|
|
13
13
|
# @!attribute address_id
|
14
|
-
# @return [String] Assign a shipping address from the account's existing shipping addresses. If this and `
|
14
|
+
# @return [String] Assign a shipping address from the account's existing shipping addresses. If this and `address` are both present, `address` will take precedence.
|
15
15
|
define_attribute :address_id, String
|
16
16
|
|
17
17
|
# @!attribute fees
|
@@ -7,7 +7,7 @@ module Recurly
|
|
7
7
|
class SubscriptionChangeCreate < Request
|
8
8
|
|
9
9
|
# @!attribute add_ons
|
10
|
-
# @return [Array[SubscriptionAddOnUpdate]] If you provide a value for this field it will replace any existing add-ons. So, when adding or modifying an add-on, you need to include the existing subscription add-ons. Unchanged add-ons can be included just using the subscription add-on's ID: `{"id": "abc123"}`. If a subscription add-on's `code` is supplied without the `id`, `{"code": "def456"}`, the subscription add-on attributes will be set to the current values of the plan add-on unless provided in the request. - If an `id` is passed, any attributes not passed in will pull from the existing subscription add-on - If a `code` is passed, any attributes not passed in will pull from the current values of the plan add-on - Attributes passed in as part of the request will override either of the above scenarios
|
10
|
+
# @return [Array[SubscriptionAddOnUpdate]] If this value is omitted your existing add-ons will be removed. If you provide a value for this field it will replace any existing add-ons. So, when adding or modifying an add-on, you need to include the existing subscription add-ons. Unchanged add-ons can be included just using the subscription add-on's ID: `{"id": "abc123"}`. If a subscription add-on's `code` is supplied without the `id`, `{"code": "def456"}`, the subscription add-on attributes will be set to the current values of the plan add-on unless provided in the request. - If an `id` is passed, any attributes not passed in will pull from the existing subscription add-on - If a `code` is passed, any attributes not passed in will pull from the current values of the plan add-on - Attributes passed in as part of the request will override either of the above scenarios
|
11
11
|
define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOnUpdate }
|
12
12
|
|
13
13
|
# @!attribute collection_method
|
@@ -14,6 +14,14 @@ module Recurly
|
|
14
14
|
# @return [String] Whether the add-on type is fixed, or usage-based.
|
15
15
|
define_attribute :add_on_type, String
|
16
16
|
|
17
|
+
# @!attribute avalara_service_type
|
18
|
+
# @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the add-on is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
|
19
|
+
define_attribute :avalara_service_type, Integer
|
20
|
+
|
21
|
+
# @!attribute avalara_transaction_type
|
22
|
+
# @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the add-on is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
|
23
|
+
define_attribute :avalara_transaction_type, Integer
|
24
|
+
|
17
25
|
# @!attribute code
|
18
26
|
# @return [String] The unique identifier for the add-on within its plan.
|
19
27
|
define_attribute :code, String
|
@@ -10,6 +10,14 @@ module Recurly
|
|
10
10
|
# @return [String] Accounting code for invoice line items.
|
11
11
|
define_attribute :accounting_code, String
|
12
12
|
|
13
|
+
# @!attribute avalara_service_type
|
14
|
+
# @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the item is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
|
15
|
+
define_attribute :avalara_service_type, Integer
|
16
|
+
|
17
|
+
# @!attribute avalara_transaction_type
|
18
|
+
# @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the item is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
|
19
|
+
define_attribute :avalara_transaction_type, Integer
|
20
|
+
|
13
21
|
# @!attribute code
|
14
22
|
# @return [String] Unique code to identify the item.
|
15
23
|
define_attribute :code, String
|
@@ -26,6 +26,14 @@ module Recurly
|
|
26
26
|
# @return [Float] `(quantity * unit_amount) - (discount + tax)`
|
27
27
|
define_attribute :amount, Float
|
28
28
|
|
29
|
+
# @!attribute avalara_service_type
|
30
|
+
# @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the line item is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
|
31
|
+
define_attribute :avalara_service_type, Integer
|
32
|
+
|
33
|
+
# @!attribute avalara_transaction_type
|
34
|
+
# @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the line item is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
|
35
|
+
define_attribute :avalara_transaction_type, Integer
|
36
|
+
|
29
37
|
# @!attribute created_at
|
30
38
|
# @return [DateTime] When the line item was created.
|
31
39
|
define_attribute :created_at, DateTime
|
@@ -18,6 +18,14 @@ module Recurly
|
|
18
18
|
# @return [Boolean] Subscriptions will automatically inherit this value once they are active. If `auto_renew` is `true`, then a subscription will automatically renew its term at renewal. If `auto_renew` is `false`, then a subscription will expire at the end of its term. `auto_renew` can be overridden on the subscription record itself.
|
19
19
|
define_attribute :auto_renew, :Boolean
|
20
20
|
|
21
|
+
# @!attribute avalara_service_type
|
22
|
+
# @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the plan is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
|
23
|
+
define_attribute :avalara_service_type, Integer
|
24
|
+
|
25
|
+
# @!attribute avalara_transaction_type
|
26
|
+
# @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the plan is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
|
27
|
+
define_attribute :avalara_transaction_type, Integer
|
28
|
+
|
21
29
|
# @!attribute code
|
22
30
|
# @return [String] Unique code to identify the plan. This is used in Hosted Payment Page URLs and in the invoice exports.
|
23
31
|
define_attribute :code, String
|
data/lib/recurly/version.rb
CHANGED
data/openapi/api.yaml
CHANGED
@@ -12650,6 +12650,7 @@ paths:
|
|
12650
12650
|
- "$ref": "#/components/parameters/site_id"
|
12651
12651
|
- "$ref": "#/components/parameters/subscription_id"
|
12652
12652
|
- "$ref": "#/components/parameters/add_on_id"
|
12653
|
+
- "$ref": "#/components/parameters/ids"
|
12653
12654
|
- "$ref": "#/components/parameters/limit"
|
12654
12655
|
- "$ref": "#/components/parameters/order"
|
12655
12656
|
- "$ref": "#/components/parameters/usage_sort_dates"
|
@@ -14962,6 +14963,22 @@ components:
|
|
14962
14963
|
- evenly
|
14963
14964
|
- at_range_end
|
14964
14965
|
- at_range_start
|
14966
|
+
avalara_transaction_type:
|
14967
|
+
type: integer
|
14968
|
+
title: Avalara Transaction Type
|
14969
|
+
description: Used by Avalara for Communications taxes. The transaction type
|
14970
|
+
in combination with the service type describe how the add-on is taxed.
|
14971
|
+
Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
|
14972
|
+
for more available t/s types.
|
14973
|
+
minimum: 0
|
14974
|
+
avalara_service_type:
|
14975
|
+
type: integer
|
14976
|
+
title: Avalara Service Type
|
14977
|
+
description: Used by Avalara for Communications taxes. The transaction type
|
14978
|
+
in combination with the service type describe how the add-on is taxed.
|
14979
|
+
Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
|
14980
|
+
for more available t/s types.
|
14981
|
+
minimum: 0
|
14965
14982
|
tax_code:
|
14966
14983
|
type: string
|
14967
14984
|
title: Tax code
|
@@ -15153,6 +15170,24 @@ components:
|
|
15153
15170
|
be included when a subscription is created through the Recurly UI. However,
|
15154
15171
|
the add-on will not be included when a subscription is created through
|
15155
15172
|
the API.
|
15173
|
+
avalara_transaction_type:
|
15174
|
+
type: integer
|
15175
|
+
title: Avalara Transaction Type
|
15176
|
+
description: Used by Avalara for Communications taxes. The transaction type
|
15177
|
+
in combination with the service type describe how the add-on is taxed.
|
15178
|
+
Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
|
15179
|
+
for more available t/s types. If an `Item` is associated to the `AddOn`,
|
15180
|
+
then the `avalara_transaction_type` must be absent.
|
15181
|
+
minimum: 0
|
15182
|
+
avalara_service_type:
|
15183
|
+
type: integer
|
15184
|
+
title: Avalara Service Type
|
15185
|
+
description: Used by Avalara for Communications taxes. The transaction type
|
15186
|
+
in combination with the service type describe how the add-on is taxed.
|
15187
|
+
Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
|
15188
|
+
for more available t/s types. If an `Item` is associated to the `AddOn`,
|
15189
|
+
then the `avalara_service_type` must be absent.
|
15190
|
+
minimum: 0
|
15156
15191
|
tax_code:
|
15157
15192
|
type: string
|
15158
15193
|
title: Tax code
|
@@ -15266,6 +15301,24 @@ components:
|
|
15266
15301
|
- evenly
|
15267
15302
|
- at_range_end
|
15268
15303
|
- at_range_start
|
15304
|
+
avalara_transaction_type:
|
15305
|
+
type: integer
|
15306
|
+
title: Avalara Transaction Type
|
15307
|
+
description: Used by Avalara for Communications taxes. The transaction type
|
15308
|
+
in combination with the service type describe how the add-on is taxed.
|
15309
|
+
Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
|
15310
|
+
for more available t/s types. If an `Item` is associated to the `AddOn`,
|
15311
|
+
then the `avalara_transaction_type` must be absent.
|
15312
|
+
minimum: 0
|
15313
|
+
avalara_service_type:
|
15314
|
+
type: integer
|
15315
|
+
title: Avalara Service Type
|
15316
|
+
description: Used by Avalara for Communications taxes. The transaction type
|
15317
|
+
in combination with the service type describe how the add-on is taxed.
|
15318
|
+
Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
|
15319
|
+
for more available t/s types. If an `Item` is associated to the `AddOn`,
|
15320
|
+
then the `avalara_service_type` must be absent.
|
15321
|
+
minimum: 0
|
15269
15322
|
tax_code:
|
15270
15323
|
type: string
|
15271
15324
|
title: Tax code
|
@@ -16320,6 +16373,22 @@ components:
|
|
16320
16373
|
- evenly
|
16321
16374
|
- at_range_end
|
16322
16375
|
- at_range_start
|
16376
|
+
avalara_transaction_type:
|
16377
|
+
type: integer
|
16378
|
+
title: Avalara Transaction Type
|
16379
|
+
description: Used by Avalara for Communications taxes. The transaction type
|
16380
|
+
in combination with the service type describe how the item is taxed. Refer
|
16381
|
+
to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
|
16382
|
+
for more available t/s types.
|
16383
|
+
minimum: 0
|
16384
|
+
avalara_service_type:
|
16385
|
+
type: integer
|
16386
|
+
title: Avalara Service Type
|
16387
|
+
description: Used by Avalara for Communications taxes. The transaction type
|
16388
|
+
in combination with the service type describe how the item is taxed. Refer
|
16389
|
+
to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
|
16390
|
+
for more available t/s types.
|
16391
|
+
minimum: 0
|
16323
16392
|
tax_code:
|
16324
16393
|
type: string
|
16325
16394
|
title: Tax code
|
@@ -16393,6 +16462,22 @@ components:
|
|
16393
16462
|
- evenly
|
16394
16463
|
- at_range_end
|
16395
16464
|
- at_range_start
|
16465
|
+
avalara_transaction_type:
|
16466
|
+
type: integer
|
16467
|
+
title: Avalara Transaction Type
|
16468
|
+
description: Used by Avalara for Communications taxes. The transaction type
|
16469
|
+
in combination with the service type describe how the item is taxed. Refer
|
16470
|
+
to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
|
16471
|
+
for more available t/s types.
|
16472
|
+
minimum: 0
|
16473
|
+
avalara_service_type:
|
16474
|
+
type: integer
|
16475
|
+
title: Avalara Service Type
|
16476
|
+
description: Used by Avalara for Communications taxes. The transaction type
|
16477
|
+
in combination with the service type describe how the item is taxed. Refer
|
16478
|
+
to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
|
16479
|
+
for more available t/s types.
|
16480
|
+
minimum: 0
|
16396
16481
|
tax_code:
|
16397
16482
|
type: string
|
16398
16483
|
title: Tax code
|
@@ -16454,6 +16539,22 @@ components:
|
|
16454
16539
|
- evenly
|
16455
16540
|
- at_range_end
|
16456
16541
|
- at_range_start
|
16542
|
+
avalara_transaction_type:
|
16543
|
+
type: integer
|
16544
|
+
title: Avalara Transaction Type
|
16545
|
+
description: Used by Avalara for Communications taxes. The transaction type
|
16546
|
+
in combination with the service type describe how the item is taxed. Refer
|
16547
|
+
to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
|
16548
|
+
for more available t/s types.
|
16549
|
+
minimum: 0
|
16550
|
+
avalara_service_type:
|
16551
|
+
type: integer
|
16552
|
+
title: Avalara Service Type
|
16553
|
+
description: Used by Avalara for Communications taxes. The transaction type
|
16554
|
+
in combination with the service type describe how the item is taxed. Refer
|
16555
|
+
to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
|
16556
|
+
for more available t/s types.
|
16557
|
+
minimum: 0
|
16457
16558
|
tax_code:
|
16458
16559
|
type: string
|
16459
16560
|
title: Tax code
|
@@ -17254,6 +17355,22 @@ components:
|
|
17254
17355
|
If not defined, then defaults to the Plan and Site settings. This attribute
|
17255
17356
|
does not work for credits (negative line items). Credits are always applied
|
17256
17357
|
post-tax. Pre-tax discounts should use the Coupons feature."
|
17358
|
+
avalara_transaction_type:
|
17359
|
+
type: integer
|
17360
|
+
title: Avalara Transaction Type
|
17361
|
+
description: Used by Avalara for Communications taxes. The transaction type
|
17362
|
+
in combination with the service type describe how the line item is taxed.
|
17363
|
+
Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
|
17364
|
+
for more available t/s types.
|
17365
|
+
minimum: 0
|
17366
|
+
avalara_service_type:
|
17367
|
+
type: integer
|
17368
|
+
title: Avalara Service Type
|
17369
|
+
description: Used by Avalara for Communications taxes. The transaction type
|
17370
|
+
in combination with the service type describe how the line item is taxed.
|
17371
|
+
Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
|
17372
|
+
for more available t/s types.
|
17373
|
+
minimum: 0
|
17257
17374
|
tax_code:
|
17258
17375
|
type: string
|
17259
17376
|
title: Tax code
|
@@ -17419,6 +17536,24 @@ components:
|
|
17419
17536
|
If not defined, then defaults to the Plan and Site settings. This attribute
|
17420
17537
|
does not work for credits (negative line items). Credits are always applied
|
17421
17538
|
post-tax. Pre-tax discounts should use the Coupons feature."
|
17539
|
+
avalara_transaction_type:
|
17540
|
+
type: integer
|
17541
|
+
title: Avalara Transaction Type
|
17542
|
+
description: Used by Avalara for Communications taxes. The transaction type
|
17543
|
+
in combination with the service type describe how the line item is taxed.
|
17544
|
+
Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
|
17545
|
+
for more available t/s types. If an `Item` is associated to the `LineItem`,
|
17546
|
+
then the `avalara_transaction_type` must be absent.
|
17547
|
+
minimum: 0
|
17548
|
+
avalara_service_type:
|
17549
|
+
type: integer
|
17550
|
+
title: Avalara Service Type
|
17551
|
+
description: Used by Avalara for Communications taxes. The transaction type
|
17552
|
+
in combination with the service type describe how the line item is taxed.
|
17553
|
+
Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
|
17554
|
+
for more available t/s types. If an `Item` is associated to the `LineItem`,
|
17555
|
+
then the `avalara_service_type` must be absent.
|
17556
|
+
minimum: 0
|
17422
17557
|
tax_code:
|
17423
17558
|
type: string
|
17424
17559
|
title: Tax code
|
@@ -17607,6 +17742,22 @@ components:
|
|
17607
17742
|
fee. If no value is provided, it defaults to plan's accounting code.
|
17608
17743
|
pattern: "/^[a-z0-9_+-]+$/"
|
17609
17744
|
maxLength: 20
|
17745
|
+
avalara_transaction_type:
|
17746
|
+
type: integer
|
17747
|
+
title: Avalara Transaction Type
|
17748
|
+
description: Used by Avalara for Communications taxes. The transaction type
|
17749
|
+
in combination with the service type describe how the plan is taxed. Refer
|
17750
|
+
to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
|
17751
|
+
for more available t/s types.
|
17752
|
+
minimum: 0
|
17753
|
+
avalara_service_type:
|
17754
|
+
type: integer
|
17755
|
+
title: Avalara Service Type
|
17756
|
+
description: Used by Avalara for Communications taxes. The transaction type
|
17757
|
+
in combination with the service type describe how the plan is taxed. Refer
|
17758
|
+
to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
|
17759
|
+
for more available t/s types.
|
17760
|
+
minimum: 0
|
17610
17761
|
tax_code:
|
17611
17762
|
type: string
|
17612
17763
|
title: Tax code
|
@@ -17755,6 +17906,22 @@ components:
|
|
17755
17906
|
fee. If no value is provided, it defaults to plan's accounting code.
|
17756
17907
|
pattern: "/^[a-z0-9_+-]+$/"
|
17757
17908
|
maxLength: 20
|
17909
|
+
avalara_transaction_type:
|
17910
|
+
type: integer
|
17911
|
+
title: Avalara Transaction Type
|
17912
|
+
description: Used by Avalara for Communications taxes. The transaction type
|
17913
|
+
in combination with the service type describe how the plan is taxed. Refer
|
17914
|
+
to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
|
17915
|
+
for more available t/s types.
|
17916
|
+
minimum: 0
|
17917
|
+
avalara_service_type:
|
17918
|
+
type: integer
|
17919
|
+
title: Avalara Service Type
|
17920
|
+
description: Used by Avalara for Communications taxes. The transaction type
|
17921
|
+
in combination with the service type describe how the plan is taxed. Refer
|
17922
|
+
to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
|
17923
|
+
for more available t/s types.
|
17924
|
+
minimum: 0
|
17758
17925
|
tax_code:
|
17759
17926
|
type: string
|
17760
17927
|
title: Tax code
|
@@ -17934,6 +18101,22 @@ components:
|
|
17934
18101
|
fee. If no value is provided, it defaults to plan's accounting code.
|
17935
18102
|
pattern: "/^[a-z0-9_+-]+$/"
|
17936
18103
|
maxLength: 20
|
18104
|
+
avalara_transaction_type:
|
18105
|
+
type: integer
|
18106
|
+
title: Avalara Transaction Type
|
18107
|
+
description: Used by Avalara for Communications taxes. The transaction type
|
18108
|
+
in combination with the service type describe how the plan is taxed. Refer
|
18109
|
+
to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
|
18110
|
+
for more available t/s types.
|
18111
|
+
minimum: 0
|
18112
|
+
avalara_service_type:
|
18113
|
+
type: integer
|
18114
|
+
title: Avalara Service Type
|
18115
|
+
description: Used by Avalara for Communications taxes. The transaction type
|
18116
|
+
in combination with the service type describe how the plan is taxed. Refer
|
18117
|
+
to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
|
18118
|
+
for more available t/s types.
|
18119
|
+
minimum: 0
|
17937
18120
|
tax_code:
|
17938
18121
|
type: string
|
17939
18122
|
title: Tax code
|
@@ -19055,10 +19238,11 @@ components:
|
|
19055
19238
|
type: array
|
19056
19239
|
title: Add-ons
|
19057
19240
|
description: |
|
19058
|
-
If
|
19059
|
-
existing add-ons. So, when adding or
|
19060
|
-
include the existing subscription add-ons.
|
19061
|
-
just using the subscription add-on's ID:
|
19241
|
+
If this value is omitted your existing add-ons will be removed. If you provide
|
19242
|
+
a value for this field it will replace any existing add-ons. So, when adding or
|
19243
|
+
modifying an add-on, you need to include the existing subscription add-ons.
|
19244
|
+
Unchanged add-ons can be included just using the subscription add-on's ID:
|
19245
|
+
`{"id": "abc123"}`.
|
19062
19246
|
|
19063
19247
|
If a subscription add-on's `code` is supplied without the `id`,
|
19064
19248
|
`{"code": "def456"}`, the subscription add-on attributes will be set to the
|
@@ -20119,8 +20303,8 @@ components:
|
|
20119
20303
|
type: string
|
20120
20304
|
title: Shipping address ID
|
20121
20305
|
description: Assign a shipping address from the account's existing shipping
|
20122
|
-
addresses. If this and `
|
20123
|
-
|
20306
|
+
addresses. If this and `address` are both present, `address` will
|
20307
|
+
take precedence.
|
20124
20308
|
maxLength: 13
|
20125
20309
|
address:
|
20126
20310
|
"$ref": "#/components/schemas/ShippingAddressCreate"
|
@@ -20312,6 +20496,7 @@ components:
|
|
20312
20496
|
title: Category
|
20313
20497
|
enum:
|
20314
20498
|
- 3d_secure_required
|
20499
|
+
- 3d_secure_action_required
|
20315
20500
|
- amazon
|
20316
20501
|
- api_error
|
20317
20502
|
- approved
|
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: 3.
|
4
|
+
version: 3.11.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Recurly
|
8
|
-
autorequire:
|
8
|
+
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-
|
11
|
+
date: 2020-08-21 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: bundler
|
@@ -289,8 +289,8 @@ metadata:
|
|
289
289
|
changelog_uri: https://github.com/recurly/recurly-client-ruby/blob/master/CHANGELOG.md
|
290
290
|
documentation_uri: https://recurly.github.io/recurly-client-ruby/
|
291
291
|
homepage_uri: https://github.com/recurly/recurly-client-ruby
|
292
|
-
source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/3.
|
293
|
-
post_install_message:
|
292
|
+
source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/3.11.0
|
293
|
+
post_install_message:
|
294
294
|
rdoc_options: []
|
295
295
|
require_paths:
|
296
296
|
- lib
|
@@ -306,7 +306,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
306
306
|
version: '0'
|
307
307
|
requirements: []
|
308
308
|
rubygems_version: 3.0.3
|
309
|
-
signing_key:
|
309
|
+
signing_key:
|
310
310
|
specification_version: 4
|
311
311
|
summary: The ruby client for Recurly's V3 API
|
312
312
|
test_files: []
|