recurly 4.26.0 → 4.27.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 -1
- data/CHANGELOG.md +11 -0
- data/GETTING_STARTED.md +1 -1
- data/lib/recurly/client/operations.rb +9 -0
- data/lib/recurly/requests/account_create.rb +4 -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 +1 -1
- data/lib/recurly/requests/add_on_update.rb +1 -1
- data/lib/recurly/requests/subscription_add_on_create.rb +1 -1
- data/lib/recurly/requests/subscription_add_on_update.rb +1 -1
- data/lib/recurly/resources/account.rb +4 -0
- data/lib/recurly/resources/add_on.rb +1 -1
- data/lib/recurly/resources/invoice.rb +1 -1
- data/lib/recurly/resources/subscription_add_on.rb +1 -1
- data/lib/recurly/resources/usage.rb +1 -1
- data/lib/recurly/version.rb +1 -1
- data/openapi/api.yaml +132 -19
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 640a24b929e9682d7617c76acc1a64e15e7ffab1911caf2c451d87a66879636b
|
4
|
+
data.tar.gz: 3f8a5c5064c8e7171dc6e6b0ff7159c4da7bb6e483795053455a0cd46024525e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: add90da54e5859f423bb14382674297aab1cd4807e3238c31bb7b8edc23ee2c963efa0acdeae40a4943678960d375c1d19dfea7666c753b422e54782c5cc1d7f
|
7
|
+
data.tar.gz: 116106098e2251a1cf36031e2f15e51853052ffe7ec5da674a441a1b231ae3b81327cb00264d7cab48e43b4c925ae21c39b7d979c89e3082e39208b263d29e0f
|
data/.bumpversion.cfg
CHANGED
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,16 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## [4.27.0](https://github.com/recurly/recurly-client-ruby/tree/4.27.0) (2023-01-11)
|
4
|
+
|
5
|
+
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.26.0...4.27.0)
|
6
|
+
|
7
|
+
|
8
|
+
**Merged Pull Requests**
|
9
|
+
|
10
|
+
- Generated Latest Changes for v2021-02-25 (Account Preferred Time Zone) [#816](https://github.com/recurly/recurly-client-ruby/pull/816) ([douglasmiller](https://github.com/douglasmiller))
|
11
|
+
|
12
|
+
|
13
|
+
|
3
14
|
## [4.26.0](https://github.com/recurly/recurly-client-ruby/tree/4.26.0) (2022-11-17)
|
4
15
|
|
5
16
|
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.25.0...4.26.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.27'
|
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.
|
@@ -2245,6 +2245,15 @@ module Recurly
|
|
2245
2245
|
# :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
2246
2246
|
#
|
2247
2247
|
# @return [Resources::Invoice] The updated invoice.
|
2248
|
+
# @example
|
2249
|
+
# begin
|
2250
|
+
# invoice = @client.apply_credit_balance(invoice_id: invoice_id)
|
2251
|
+
# puts "Applied credit balance to invoice #{invoice}"
|
2252
|
+
# rescue Recurly::Errors::NotFoundError
|
2253
|
+
# # If the resource was not found, you may want to alert the user or
|
2254
|
+
# # just return nil
|
2255
|
+
# puts "Resource Not Found"
|
2256
|
+
# end
|
2248
2257
|
#
|
2249
2258
|
def apply_credit_balance(invoice_id:, **options)
|
2250
2259
|
path = interpolate_path("/invoices/{invoice_id}/apply_credit_balance", invoice_id: invoice_id)
|
@@ -74,6 +74,10 @@ module Recurly
|
|
74
74
|
# @return [String] Used to determine the language and locale of emails sent on behalf of the merchant to the customer. The list of locales is restricted to those the merchant has enabled on the site.
|
75
75
|
define_attribute :preferred_locale, String
|
76
76
|
|
77
|
+
# @!attribute preferred_time_zone
|
78
|
+
# @return [String] Used to determine the time zone of emails sent on behalf of the merchant to the customer. Must be a [supported IANA time zone name](https://docs.recurly.com/docs/email-time-zones-and-time-stamps#supported-api-iana-time-zone-names)
|
79
|
+
define_attribute :preferred_time_zone, String
|
80
|
+
|
77
81
|
# @!attribute shipping_addresses
|
78
82
|
# @return [Array[ShippingAddressCreate]]
|
79
83
|
define_attribute :shipping_addresses, Array, { :item_type => :ShippingAddressCreate }
|
@@ -78,6 +78,10 @@ module Recurly
|
|
78
78
|
# @return [String] Used to determine the language and locale of emails sent on behalf of the merchant to the customer. The list of locales is restricted to those the merchant has enabled on the site.
|
79
79
|
define_attribute :preferred_locale, String
|
80
80
|
|
81
|
+
# @!attribute preferred_time_zone
|
82
|
+
# @return [String] Used to determine the time zone of emails sent on behalf of the merchant to the customer. Must be a [supported IANA time zone name](https://docs.recurly.com/docs/email-time-zones-and-time-stamps#supported-api-iana-time-zone-names)
|
83
|
+
define_attribute :preferred_time_zone, String
|
84
|
+
|
81
85
|
# @!attribute tax_exempt
|
82
86
|
# @return [Boolean] The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.
|
83
87
|
define_attribute :tax_exempt, :Boolean
|
@@ -66,6 +66,10 @@ module Recurly
|
|
66
66
|
# @return [String] Used to determine the language and locale of emails sent on behalf of the merchant to the customer. The list of locales is restricted to those the merchant has enabled on the site.
|
67
67
|
define_attribute :preferred_locale, String
|
68
68
|
|
69
|
+
# @!attribute preferred_time_zone
|
70
|
+
# @return [String] Used to determine the time zone of emails sent on behalf of the merchant to the customer. Must be a [supported IANA time zone name](https://docs.recurly.com/docs/email-time-zones-and-time-stamps#supported-api-iana-time-zone-names)
|
71
|
+
define_attribute :preferred_time_zone, String
|
72
|
+
|
69
73
|
# @!attribute tax_exempt
|
70
74
|
# @return [Boolean] The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.
|
71
75
|
define_attribute :tax_exempt, :Boolean
|
@@ -63,7 +63,7 @@ module Recurly
|
|
63
63
|
define_attribute :optional, :Boolean
|
64
64
|
|
65
65
|
# @!attribute percentage_tiers
|
66
|
-
# @return [Array[PercentageTiersByCurrency]] Array of objects which must have at least one set of tiers per currency and the currency code. The tier_type must be `volume` or `tiered`, if not, it must be absent. There must be one tier without an `ending_amount` value which represents the final tier.
|
66
|
+
# @return [Array[PercentageTiersByCurrency]] Array of objects which must have at least one set of tiers per currency and the currency code. The tier_type must be `volume` or `tiered`, if not, it must be absent. There must be one tier without an `ending_amount` value which represents the final tier. This feature is currently in development and requires approval and enablement, please contact support.
|
67
67
|
define_attribute :percentage_tiers, Array, { :item_type => :PercentageTiersByCurrency }
|
68
68
|
|
69
69
|
# @!attribute plan_id
|
@@ -55,7 +55,7 @@ module Recurly
|
|
55
55
|
define_attribute :optional, :Boolean
|
56
56
|
|
57
57
|
# @!attribute percentage_tiers
|
58
|
-
# @return [Array[PercentageTiersByCurrency]] `percentage_tiers` is an array of objects, which must have the set of tiers per currency and the currency code. The tier_type must be `volume` or `tiered`, if not, it must be absent. There must be one tier without an `ending_amount` value which represents the final tier.
|
58
|
+
# @return [Array[PercentageTiersByCurrency]] `percentage_tiers` is an array of objects, which must have the set of tiers per currency and the currency code. The tier_type must be `volume` or `tiered`, if not, it must be absent. There must be one tier without an `ending_amount` value which represents the final tier. This feature is currently in development and requires approval and enablement, please contact support.
|
59
59
|
define_attribute :percentage_tiers, Array, { :item_type => :PercentageTiersByCurrency }
|
60
60
|
|
61
61
|
# @!attribute revenue_schedule_type
|
@@ -15,7 +15,7 @@ module Recurly
|
|
15
15
|
define_attribute :code, String
|
16
16
|
|
17
17
|
# @!attribute percentage_tiers
|
18
|
-
# @return [Array[SubscriptionAddOnPercentageTier]] If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be removed and replaced by the percentage tiers in the request. There must be one tier without ending_amount value which represents the final tier. Use only if add_on.tier_type is tiered or volume and add_on.usage_type is percentage.
|
18
|
+
# @return [Array[SubscriptionAddOnPercentageTier]] If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be removed and replaced by the percentage tiers in the request. There must be one tier without ending_amount value which represents the final tier. Use only if add_on.tier_type is tiered or volume and add_on.usage_type is percentage. This feature is currently in development and requires approval and enablement, please contact support.
|
19
19
|
define_attribute :percentage_tiers, Array, { :item_type => :SubscriptionAddOnPercentageTier }
|
20
20
|
|
21
21
|
# @!attribute quantity
|
@@ -19,7 +19,7 @@ module Recurly
|
|
19
19
|
define_attribute :id, String
|
20
20
|
|
21
21
|
# @!attribute percentage_tiers
|
22
|
-
# @return [Array[SubscriptionAddOnPercentageTier]] If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be removed and replaced by the percentage tiers in the request. Use only if add_on.tier_type is tiered or volume and add_on.usage_type is percentage. There must be one tier without an `ending_amount` value which represents the final tier.
|
22
|
+
# @return [Array[SubscriptionAddOnPercentageTier]] If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be removed and replaced by the percentage tiers in the request. Use only if add_on.tier_type is tiered or volume and add_on.usage_type is percentage. There must be one tier without an `ending_amount` value which represents the final tier. This feature is currently in development and requires approval and enablement, please contact support.
|
23
23
|
define_attribute :percentage_tiers, Array, { :item_type => :SubscriptionAddOnPercentageTier }
|
24
24
|
|
25
25
|
# @!attribute quantity
|
@@ -110,6 +110,10 @@ module Recurly
|
|
110
110
|
# @return [String] Used to determine the language and locale of emails sent on behalf of the merchant to the customer.
|
111
111
|
define_attribute :preferred_locale, String
|
112
112
|
|
113
|
+
# @!attribute preferred_time_zone
|
114
|
+
# @return [String] The [IANA time zone name](https://docs.recurly.com/docs/email-time-zones-and-time-stamps#supported-api-iana-time-zone-names) used to determine the time zone of emails sent on behalf of the merchant to the customer.
|
115
|
+
define_attribute :preferred_time_zone, String
|
116
|
+
|
113
117
|
# @!attribute shipping_addresses
|
114
118
|
# @return [Array[ShippingAddress]] The shipping addresses on the account.
|
115
119
|
define_attribute :shipping_addresses, Array, { :item_type => :ShippingAddress }
|
@@ -75,7 +75,7 @@ module Recurly
|
|
75
75
|
define_attribute :optional, :Boolean
|
76
76
|
|
77
77
|
# @!attribute percentage_tiers
|
78
|
-
# @return [Array[PercentageTiersByCurrency]]
|
78
|
+
# @return [Array[PercentageTiersByCurrency]] This feature is currently in development and requires approval and enablement, please contact support.
|
79
79
|
define_attribute :percentage_tiers, Array, { :item_type => :PercentageTiersByCurrency }
|
80
80
|
|
81
81
|
# @!attribute plan_id
|
@@ -103,7 +103,7 @@ module Recurly
|
|
103
103
|
define_attribute :po_number, String
|
104
104
|
|
105
105
|
# @!attribute previous_invoice_id
|
106
|
-
# @return [String] On refund invoices, this value will exist and show the invoice ID of the purchase invoice the refund was created from.
|
106
|
+
# @return [String] On refund invoices, this value will exist and show the invoice ID of the purchase invoice the refund was created from. This field is only populated for sites without the [Only Bill What Changed](https://docs.recurly.com/docs/only-bill-what-changed) feature enabled. Sites with Only Bill What Changed enabled should use the [related_invoices endpoint](https://recurly.com/developers/api/v2021-02-25/index.html#operation/list_related_invoices) to see purchase invoices refunded by this invoice.
|
107
107
|
define_attribute :previous_invoice_id, String
|
108
108
|
|
109
109
|
# @!attribute refundable_amount
|
@@ -31,7 +31,7 @@ module Recurly
|
|
31
31
|
define_attribute :object, String
|
32
32
|
|
33
33
|
# @!attribute percentage_tiers
|
34
|
-
# @return [Array[SubscriptionAddOnPercentageTier]] If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be removed and replaced by the percentage tiers in the request. Use only if add_on.tier_type is tiered or volume and add_on.usage_type is percentage. There must be one tier without an `ending_amount` value which represents the final tier.
|
34
|
+
# @return [Array[SubscriptionAddOnPercentageTier]] If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be removed and replaced by the percentage tiers in the request. Use only if add_on.tier_type is tiered or volume and add_on.usage_type is percentage. There must be one tier without an `ending_amount` value which represents the final tier. This feature is currently in development and requires approval and enablement, please contact support.
|
35
35
|
define_attribute :percentage_tiers, Array, { :item_type => :SubscriptionAddOnPercentageTier }
|
36
36
|
|
37
37
|
# @!attribute quantity
|
@@ -35,7 +35,7 @@ module Recurly
|
|
35
35
|
define_attribute :object, String
|
36
36
|
|
37
37
|
# @!attribute percentage_tiers
|
38
|
-
# @return [Array[SubscriptionAddOnPercentageTier]] The percentage tiers of the subscription based on the usage_timestamp. If tier_type = flat, percentage_tiers = []
|
38
|
+
# @return [Array[SubscriptionAddOnPercentageTier]] The percentage tiers of the subscription based on the usage_timestamp. If tier_type = flat, percentage_tiers = []. This feature is currently in development and requires approval and enablement, please contact support.
|
39
39
|
define_attribute :percentage_tiers, Array, { :item_type => :SubscriptionAddOnPercentageTier }
|
40
40
|
|
41
41
|
# @!attribute recording_timestamp
|
data/lib/recurly/version.rb
CHANGED
data/openapi/api.yaml
CHANGED
@@ -343,13 +343,13 @@ tags:
|
|
343
343
|
- name: external_subscriptions
|
344
344
|
x-displayName: External Subscription
|
345
345
|
description: A subscription from an external resource that is not managed by the
|
346
|
-
Recurly platform and instead is managed by third-party platforms like Apple
|
347
|
-
and Google Play.
|
346
|
+
Recurly platform and instead is managed by third-party platforms like Apple App
|
347
|
+
Store and Google Play Store.
|
348
348
|
- name: external_products
|
349
349
|
x-displayName: External Product
|
350
350
|
description: A product from an external resource that is not managed by the Recurly
|
351
|
-
platform and instead is managed by third-party platforms like Apple Store
|
352
|
-
Google Play.
|
351
|
+
platform and instead is managed by third-party platforms like Apple App Store
|
352
|
+
and Google Play Store.
|
353
353
|
paths:
|
354
354
|
"/sites":
|
355
355
|
get:
|
@@ -8092,6 +8092,8 @@ paths:
|
|
8092
8092
|
summary: Apply available credit to a pending or past due charge invoice
|
8093
8093
|
description: Apply credit payment to the outstanding balance on an existing
|
8094
8094
|
charge invoice from an account’s available balance from existing credit invoices.
|
8095
|
+
Credit that was refunded from the invoice cannot be applied back to the invoice
|
8096
|
+
as payment.
|
8095
8097
|
parameters:
|
8096
8098
|
- "$ref": "#/components/parameters/site_id"
|
8097
8099
|
- "$ref": "#/components/parameters/invoice_id"
|
@@ -8110,7 +8112,8 @@ paths:
|
|
8110
8112
|
"$ref": "#/components/schemas/Error"
|
8111
8113
|
'422':
|
8112
8114
|
description: Tried applying credit to a legacy or closed invoice or there
|
8113
|
-
was an error processing the credit payment
|
8115
|
+
was an error processing the credit payment, such as no available credit
|
8116
|
+
on the account.
|
8114
8117
|
content:
|
8115
8118
|
application/json:
|
8116
8119
|
schema:
|
@@ -8121,7 +8124,95 @@ paths:
|
|
8121
8124
|
application/json:
|
8122
8125
|
schema:
|
8123
8126
|
"$ref": "#/components/schemas/Error"
|
8124
|
-
x-code-samples:
|
8127
|
+
x-code-samples:
|
8128
|
+
- lang: Node.js
|
8129
|
+
source: |
|
8130
|
+
try {
|
8131
|
+
const invoice = await client.applyCreditBalance(invoiceId)
|
8132
|
+
console.log('Applied credit balance to invoice: ', invoice)
|
8133
|
+
} catch (err) {
|
8134
|
+
if (err instanceof recurly.errors.ValidationError) {
|
8135
|
+
// If the request was not valid, you may want to tell your user
|
8136
|
+
// why. You can find the invalid params and reasons in err.params
|
8137
|
+
console.log('Failed validation', err.params)
|
8138
|
+
} else {
|
8139
|
+
// If we don't know what to do with the err, we should
|
8140
|
+
// probably re-raise and let our web framework and logger handle it
|
8141
|
+
console.log('Unknown Error: ', err)
|
8142
|
+
}
|
8143
|
+
}
|
8144
|
+
- lang: Python
|
8145
|
+
source: |
|
8146
|
+
try:
|
8147
|
+
invoice = client.apply_credit_balance(invoice_id)
|
8148
|
+
print("Applied credit balance to invoice %s" % invoice.id)
|
8149
|
+
except recurly.errors.NotFoundError:
|
8150
|
+
# If the resource was not found, you may want to alert the user or
|
8151
|
+
# just return nil
|
8152
|
+
print("Resource Not Found")
|
8153
|
+
- lang: ".NET"
|
8154
|
+
source: |
|
8155
|
+
try
|
8156
|
+
{
|
8157
|
+
Invoice invoice = client.ApplyCreditBalance(invoiceId);
|
8158
|
+
Console.WriteLine($"Applied credit balance to invoice #{invoice.Number}");
|
8159
|
+
}
|
8160
|
+
catch (Recurly.Errors.Validation ex)
|
8161
|
+
{
|
8162
|
+
// If the request was not valid, you may want to tell your user
|
8163
|
+
// why. You can find the invalid params and reasons in ex.Error.Params
|
8164
|
+
Console.WriteLine($"Failed validation: {ex.Error.Message}");
|
8165
|
+
}
|
8166
|
+
catch (Recurly.Errors.ApiError ex)
|
8167
|
+
{
|
8168
|
+
// Use ApiError to catch a generic error from the API
|
8169
|
+
Console.WriteLine($"Unexpected Recurly Error: {ex.Error.Message}");
|
8170
|
+
}
|
8171
|
+
- lang: Ruby
|
8172
|
+
source: |
|
8173
|
+
begin
|
8174
|
+
invoice = @client.apply_credit_balance(invoice_id: invoice_id)
|
8175
|
+
puts "Applied credit balance to invoice #{invoice}"
|
8176
|
+
rescue Recurly::Errors::NotFoundError
|
8177
|
+
# If the resource was not found, you may want to alert the user or
|
8178
|
+
# just return nil
|
8179
|
+
puts "Resource Not Found"
|
8180
|
+
end
|
8181
|
+
- lang: Java
|
8182
|
+
source: |
|
8183
|
+
try {
|
8184
|
+
final Invoice invoice = client.applyCreditBalance(invoiceId);
|
8185
|
+
System.out.println("Applied credit balance to invoice " + invoice.getId());
|
8186
|
+
} catch (final ValidationException e) {
|
8187
|
+
// If the request was not valid, you may want to tell your user
|
8188
|
+
// why. You can find the invalid params and reasons in e.getError().getParams()
|
8189
|
+
System.out.println("Failed validation: " + e.getError().getMessage());
|
8190
|
+
} catch (final ApiException e) {
|
8191
|
+
// Use ApiException to catch a generic error from the API
|
8192
|
+
System.out.println("Unexpected Recurly Error: " + e.getError().getMessage());
|
8193
|
+
}
|
8194
|
+
- lang: PHP
|
8195
|
+
source: |
|
8196
|
+
try {
|
8197
|
+
$invoice = $client->applyCreditBalance($invoice_id);
|
8198
|
+
|
8199
|
+
echo 'Applied credit balance to invoice:' . PHP_EOL;
|
8200
|
+
var_dump($invoice);
|
8201
|
+
} catch (\Recurly\Errors\Validation $e) {
|
8202
|
+
// If the request was not valid, you may want to tell your user
|
8203
|
+
// why. You can find the invalid params and reasons in err.params
|
8204
|
+
var_dump($e);
|
8205
|
+
} catch (\Recurly\RecurlyError $e) {
|
8206
|
+
// If we don't know what to do with the err, we should
|
8207
|
+
// probably re-raise and let our web framework and logger handle it
|
8208
|
+
var_dump($e);
|
8209
|
+
}
|
8210
|
+
- lang: Go
|
8211
|
+
source: "invoice, err := client.ApplyCreditBalance(invoiceID)\nif e, ok :=
|
8212
|
+
err.(*recurly.Error); ok {\n\tif e.Type == recurly.ErrorTypeValidation {\n\t\tfmt.Printf(\"Failed
|
8213
|
+
validation: %v\", e)\n\t\treturn nil, err\n\t}\n\tfmt.Printf(\"Unexpected
|
8214
|
+
Recurly error: %v\", e)\n\treturn nil, err\n}\n\nfmt.Printf(\"Applied credit
|
8215
|
+
balance to invoice: %v\", invoice)"
|
8125
8216
|
"/invoices/{invoice_id}/collect":
|
8126
8217
|
put:
|
8127
8218
|
tags:
|
@@ -16177,6 +16268,11 @@ components:
|
|
16177
16268
|
behalf of the merchant to the customer. The list of locales is restricted
|
16178
16269
|
to those the merchant has enabled on the site.
|
16179
16270
|
"$ref": "#/components/schemas/PreferredLocaleEnum"
|
16271
|
+
preferred_time_zone:
|
16272
|
+
type: string
|
16273
|
+
example: America/Los_Angeles
|
16274
|
+
description: Used to determine the time zone of emails sent on behalf of
|
16275
|
+
the merchant to the customer. Must be a [supported IANA time zone name](https://docs.recurly.com/docs/email-time-zones-and-time-stamps#supported-api-iana-time-zone-names)
|
16180
16276
|
cc_emails:
|
16181
16277
|
type: string
|
16182
16278
|
description: Additional email address that should receive account correspondence.
|
@@ -16279,6 +16375,12 @@ components:
|
|
16279
16375
|
description: Used to determine the language and locale of emails sent on
|
16280
16376
|
behalf of the merchant to the customer.
|
16281
16377
|
"$ref": "#/components/schemas/PreferredLocaleEnum"
|
16378
|
+
preferred_time_zone:
|
16379
|
+
type: string
|
16380
|
+
example: America/Los_Angeles
|
16381
|
+
description: The [IANA time zone name](https://docs.recurly.com/docs/email-time-zones-and-time-stamps#supported-api-iana-time-zone-names)
|
16382
|
+
used to determine the time zone of emails sent on behalf of the merchant
|
16383
|
+
to the customer.
|
16282
16384
|
cc_emails:
|
16283
16385
|
type: string
|
16284
16386
|
description: Additional email address that should receive account correspondence.
|
@@ -16684,6 +16786,8 @@ components:
|
|
16684
16786
|
percentage_tiers:
|
16685
16787
|
type: array
|
16686
16788
|
title: Percentage Tiers
|
16789
|
+
description: This feature is currently in development and requires approval
|
16790
|
+
and enablement, please contact support.
|
16687
16791
|
items:
|
16688
16792
|
"$ref": "#/components/schemas/PercentageTiersByCurrency"
|
16689
16793
|
external_sku:
|
@@ -16877,7 +16981,8 @@ components:
|
|
16877
16981
|
Array of objects which must have at least one set of tiers
|
16878
16982
|
per currency and the currency code. The tier_type must be `volume` or `tiered`,
|
16879
16983
|
if not, it must be absent. There must be one tier without an `ending_amount` value
|
16880
|
-
which represents the final tier.
|
16984
|
+
which represents the final tier. This feature is currently in development and
|
16985
|
+
requires approval and enablement, please contact support.
|
16881
16986
|
required:
|
16882
16987
|
- code
|
16883
16988
|
- name
|
@@ -17018,7 +17123,8 @@ components:
|
|
17018
17123
|
`percentage_tiers` is an array of objects, which must have the set of tiers
|
17019
17124
|
per currency and the currency code. The tier_type must be `volume` or `tiered`,
|
17020
17125
|
if not, it must be absent. There must be one tier without an `ending_amount` value
|
17021
|
-
which represents the final tier.
|
17126
|
+
which represents the final tier. This feature is currently in development and
|
17127
|
+
requires approval and enablement, please contact support.
|
17022
17128
|
BillingInfo:
|
17023
17129
|
type: object
|
17024
17130
|
properties:
|
@@ -18256,7 +18362,11 @@ components:
|
|
18256
18362
|
type: string
|
18257
18363
|
title: Previous invoice ID
|
18258
18364
|
description: On refund invoices, this value will exist and show the invoice
|
18259
|
-
ID of the purchase invoice the refund was created from.
|
18365
|
+
ID of the purchase invoice the refund was created from. This field is
|
18366
|
+
only populated for sites without the [Only Bill What Changed](https://docs.recurly.com/docs/only-bill-what-changed)
|
18367
|
+
feature enabled. Sites with Only Bill What Changed enabled should use
|
18368
|
+
the [related_invoices endpoint](https://recurly.com/developers/api/v2021-02-25/index.html#operation/list_related_invoices)
|
18369
|
+
to see purchase invoices refunded by this invoice.
|
18260
18370
|
maxLength: 13
|
18261
18371
|
number:
|
18262
18372
|
type: string
|
@@ -20662,8 +20772,8 @@ components:
|
|
20662
20772
|
description: |
|
20663
20773
|
If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be
|
20664
20774
|
removed and replaced by the percentage tiers in the request. Use only if add_on.tier_type is tiered or volume and
|
20665
|
-
add_on.usage_type is percentage.
|
20666
|
-
|
20775
|
+
add_on.usage_type is percentage. There must be one tier without an `ending_amount` value which represents the final tier.
|
20776
|
+
This feature is currently in development and requires approval and enablement, please contact support.
|
20667
20777
|
usage_percentage:
|
20668
20778
|
type: number
|
20669
20779
|
format: float
|
@@ -20740,8 +20850,9 @@ components:
|
|
20740
20850
|
minItems: 1
|
20741
20851
|
description: |
|
20742
20852
|
If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be
|
20743
|
-
removed and replaced by the percentage tiers in the request. There must be one tier without ending_amount value
|
20744
|
-
Use only if add_on.tier_type is tiered or volume and add_on.usage_type is
|
20853
|
+
removed and replaced by the percentage tiers in the request. There must be one tier without ending_amount value
|
20854
|
+
which represents the final tier. Use only if add_on.tier_type is tiered or volume and add_on.usage_type is
|
20855
|
+
percentage. This feature is currently in development and requires approval and enablement, please contact support.
|
20745
20856
|
usage_percentage:
|
20746
20857
|
type: number
|
20747
20858
|
format: float
|
@@ -20820,8 +20931,8 @@ components:
|
|
20820
20931
|
description: |
|
20821
20932
|
If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be
|
20822
20933
|
removed and replaced by the percentage tiers in the request. Use only if add_on.tier_type is tiered or volume and
|
20823
|
-
add_on.usage_type is percentage.
|
20824
|
-
|
20934
|
+
add_on.usage_type is percentage. There must be one tier without an `ending_amount` value which represents the
|
20935
|
+
final tier. This feature is currently in development and requires approval and enablement, please contact support.
|
20825
20936
|
usage_percentage:
|
20826
20937
|
type: number
|
20827
20938
|
format: float
|
@@ -22002,7 +22113,8 @@ components:
|
|
22002
22113
|
items:
|
22003
22114
|
"$ref": "#/components/schemas/SubscriptionAddOnPercentageTier"
|
22004
22115
|
description: The percentage tiers of the subscription based on the usage_timestamp.
|
22005
|
-
If tier_type = flat, percentage_tiers = []
|
22116
|
+
If tier_type = flat, percentage_tiers = []. This feature is currently
|
22117
|
+
in development and requires approval and enablement, please contact support.
|
22006
22118
|
measured_unit_id:
|
22007
22119
|
type: string
|
22008
22120
|
description: The ID of the measured unit associated with the add-on the
|
@@ -22416,7 +22528,8 @@ components:
|
|
22416
22528
|
description: Time the object was last updated
|
22417
22529
|
ExternalProduct:
|
22418
22530
|
type: object
|
22419
|
-
description: Product from an external resource such as Apple App or Google
|
22531
|
+
description: Product from an external resource such as Apple App Store or Google
|
22532
|
+
Play Store.
|
22420
22533
|
properties:
|
22421
22534
|
id:
|
22422
22535
|
type: string
|
@@ -22496,8 +22609,8 @@ components:
|
|
22496
22609
|
description: When the external product was updated in Recurly.
|
22497
22610
|
ExternalSubscription:
|
22498
22611
|
type: object
|
22499
|
-
description: Subscription from an external resource such as Apple App
|
22500
|
-
Play.
|
22612
|
+
description: Subscription from an external resource such as Apple App Store
|
22613
|
+
or Google Play Store.
|
22501
22614
|
properties:
|
22502
22615
|
id:
|
22503
22616
|
type: string
|
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.27.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: 2023-01-11 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: bundler
|
@@ -326,7 +326,7 @@ metadata:
|
|
326
326
|
changelog_uri: https://github.com/recurly/recurly-client-ruby/blob/master/CHANGELOG.md
|
327
327
|
documentation_uri: https://recurly.github.io/recurly-client-ruby/
|
328
328
|
homepage_uri: https://github.com/recurly/recurly-client-ruby
|
329
|
-
source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.
|
329
|
+
source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.27.0
|
330
330
|
post_install_message:
|
331
331
|
rdoc_options: []
|
332
332
|
require_paths:
|