recurly 4.2.0 → 4.3.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 +12 -0
- data/GETTING_STARTED.md +1 -1
- data/lib/recurly/client.rb +5 -3
- data/lib/recurly/client/operations.rb +25 -1
- data/lib/recurly/requests/billing_info_create.rb +2 -2
- data/lib/recurly/requests/billing_info_verify.rb +14 -0
- data/lib/recurly/resources/billing_info.rb +2 -2
- data/lib/recurly/resources/tax_detail.rb +26 -0
- data/lib/recurly/resources/tax_info.rb +4 -0
- data/lib/recurly/version.rb +1 -1
- data/openapi/api.yaml +207 -34
- 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: 946f99f504cb40b5cfe6d19fa930a2a2f56e9e65896ae117f51f6dc765c93520
|
4
|
+
data.tar.gz: 17f8e1d63237dd4a442afa351a89a84880ae189a31224b3de855d2c932808397
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a882e57fd39d3519f308f1bcaeb5a3eced0674ab9d6b2425b561b7a66a30e414df91e844c6b237239e45c796a30999a0ba6137aadbaa955cfb5d4f702ee817cf
|
7
|
+
data.tar.gz: 1d5ba672b2caf851be6dd564b3fec80572588620bd3ca5a01729e0bba5b5a5ec4c05957ff54daa18cadba2554bb1a7c417c1931eb9eddab511e887245494bed3
|
data/.bumpversion.cfg
CHANGED
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,17 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## [4.3.0](https://github.com/recurly/recurly-client-ruby/tree/4.3.0) (2021-06-04)
|
4
|
+
|
5
|
+
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.2.0...4.3.0)
|
6
|
+
|
7
|
+
|
8
|
+
**Merged Pull Requests**
|
9
|
+
|
10
|
+
- Generated Latest Changes for v2021-02-25 [#702](https://github.com/recurly/recurly-client-ruby/pull/702) ([recurly-integrations](https://github.com/recurly-integrations))
|
11
|
+
- Making #post allow a nil body [#699](https://github.com/recurly/recurly-client-ruby/pull/699) ([douglasmiller](https://github.com/douglasmiller))
|
12
|
+
|
13
|
+
|
14
|
+
|
3
15
|
## [4.2.0](https://github.com/recurly/recurly-client-ruby/tree/4.2.0) (2021-04-21)
|
4
16
|
|
5
17
|
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.1.0...4.2.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.3'
|
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.
|
data/lib/recurly/client.rb
CHANGED
@@ -113,13 +113,15 @@ module Recurly
|
|
113
113
|
handle_response! request, http_response
|
114
114
|
end
|
115
115
|
|
116
|
-
def post(path, request_data, request_class, **options)
|
116
|
+
def post(path, request_data = nil, request_class = nil, **options)
|
117
117
|
validate_options!(**options)
|
118
|
-
request_class.new(request_data).validate!
|
119
118
|
request = Net::HTTP::Post.new build_url(path, options)
|
120
119
|
request.set_content_type(JSON_CONTENT_TYPE)
|
121
120
|
set_headers(request, options[:headers])
|
122
|
-
|
121
|
+
if request_data
|
122
|
+
request_class.new(request_data).validate!
|
123
|
+
request.body = JSON.dump(request_data)
|
124
|
+
end
|
123
125
|
http_response = run_request(request, options)
|
124
126
|
handle_response! request, http_response
|
125
127
|
end
|
@@ -452,6 +452,30 @@ module Recurly
|
|
452
452
|
delete(path, **options)
|
453
453
|
end
|
454
454
|
|
455
|
+
# Verify an account's credit card billing information
|
456
|
+
#
|
457
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/verify_billing_info verify_billing_info api documenation}
|
458
|
+
#
|
459
|
+
# @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+.
|
460
|
+
# @param params [Hash] Optional query string parameters:
|
461
|
+
# :body [Requests::BillingInfoVerify] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoVerify}
|
462
|
+
#
|
463
|
+
# @return [Resources::Transaction] Transaction information from verify.
|
464
|
+
# @example
|
465
|
+
# begin
|
466
|
+
# transaction = @client.verify_billing_info(account_id: account_id)
|
467
|
+
# puts "Got Transaction #{transaction}"
|
468
|
+
# rescue Recurly::Errors::NotFoundError
|
469
|
+
# # If the resource was not found, you may want to alert the user or
|
470
|
+
# # just return nil
|
471
|
+
# puts "Resource Not Found"
|
472
|
+
# end
|
473
|
+
#
|
474
|
+
def verify_billing_info(account_id:, **options)
|
475
|
+
path = interpolate_path("/accounts/{account_id}/billing_info/verify", account_id: account_id)
|
476
|
+
post(path, options[:body], Requests::BillingInfoVerify, **options)
|
477
|
+
end
|
478
|
+
|
455
479
|
# Get the list of billing information associated with an account
|
456
480
|
#
|
457
481
|
# {https://developers.recurly.com/api/v2021-02-25#operation/list_billing_infos list_billing_infos api documenation}
|
@@ -488,7 +512,7 @@ module Recurly
|
|
488
512
|
pager(path, **options)
|
489
513
|
end
|
490
514
|
|
491
|
-
#
|
515
|
+
# Add new billing information on an account
|
492
516
|
#
|
493
517
|
# {https://developers.recurly.com/api/v2021-02-25#operation/create_billing_info create_billing_info api documenation}
|
494
518
|
#
|
@@ -15,7 +15,7 @@ module Recurly
|
|
15
15
|
define_attribute :amazon_billing_agreement_id, String
|
16
16
|
|
17
17
|
# @!attribute backup_payment_method
|
18
|
-
# @return [Boolean] The `backup_payment_method`
|
18
|
+
# @return [Boolean] The `backup_payment_method` field is used to designate a billing info as a backup on the account that will be tried if the initial billing info used for an invoice is declined. All payment methods, including the billing info marked `primary_payment_method` can be set as a backup. An account can have a maximum of 1 backup, if a user sets a different payment method as a backup, the existing backup will no longer be marked as such.
|
19
19
|
define_attribute :backup_payment_method, :Boolean
|
20
20
|
|
21
21
|
# @!attribute company
|
@@ -67,7 +67,7 @@ module Recurly
|
|
67
67
|
define_attribute :paypal_billing_agreement_id, String
|
68
68
|
|
69
69
|
# @!attribute primary_payment_method
|
70
|
-
# @return [Boolean] The `primary_payment_method`
|
70
|
+
# @return [Boolean] The `primary_payment_method` field is used to designate the primary billing info on the account. The first billing info created on an account will always become primary. Adding additional billing infos provides the flexibility to mark another billing info as primary, or adding additional non-primary billing infos. This can be accomplished by passing the `primary_payment_method` with a value of `true`. When adding billing infos via the billing_info and /accounts endpoints, this value is not permitted, and will return an error if provided.
|
71
71
|
define_attribute :primary_payment_method, :Boolean
|
72
72
|
|
73
73
|
# @!attribute tax_identifier
|
@@ -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 BillingInfoVerify < Request
|
8
|
+
|
9
|
+
# @!attribute gateway_code
|
10
|
+
# @return [String] An identifier for a specific payment gateway.
|
11
|
+
define_attribute :gateway_code, String
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
@@ -15,7 +15,7 @@ module Recurly
|
|
15
15
|
define_attribute :address, :Address
|
16
16
|
|
17
17
|
# @!attribute backup_payment_method
|
18
|
-
# @return [Boolean] The `backup_payment_method`
|
18
|
+
# @return [Boolean] The `backup_payment_method` field is used to indicate a billing info as a backup on the account that will be tried if the initial billing info used for an invoice is declined.
|
19
19
|
define_attribute :backup_payment_method, :Boolean
|
20
20
|
|
21
21
|
# @!attribute company
|
@@ -51,7 +51,7 @@ module Recurly
|
|
51
51
|
define_attribute :payment_method, :PaymentMethod
|
52
52
|
|
53
53
|
# @!attribute primary_payment_method
|
54
|
-
# @return [Boolean] The `primary_payment_method`
|
54
|
+
# @return [Boolean] The `primary_payment_method` field is used to indicate the primary billing info on the account. The first billing info created on an account will always become primary. This payment method will be used
|
55
55
|
define_attribute :primary_payment_method, :Boolean
|
56
56
|
|
57
57
|
# @!attribute updated_at
|
@@ -0,0 +1,26 @@
|
|
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 Resources
|
7
|
+
class TaxDetail < Resource
|
8
|
+
|
9
|
+
# @!attribute rate
|
10
|
+
# @return [Float] Provides the tax rate for the region.
|
11
|
+
define_attribute :rate, Float
|
12
|
+
|
13
|
+
# @!attribute region
|
14
|
+
# @return [String] Provides the tax region applied on an invoice. For Canadian Sales Tax, this will be either the 2 letter province code or country code.
|
15
|
+
define_attribute :region, String
|
16
|
+
|
17
|
+
# @!attribute tax
|
18
|
+
# @return [Float] The total tax applied for this tax type.
|
19
|
+
define_attribute :tax, Float
|
20
|
+
|
21
|
+
# @!attribute type
|
22
|
+
# @return [String] Provides the tax type for the region. For Canadian Sales Tax, this will be GST, HST, QST or PST.
|
23
|
+
define_attribute :type, String
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
@@ -14,6 +14,10 @@ module Recurly
|
|
14
14
|
# @return [String] Provides the tax region applied on an invoice. For U.S. Sales Tax, this will be the 2 letter state code. For EU VAT this will be the 2 letter country code. For all country level tax types, this will display the regional tax, like VAT, GST, or PST.
|
15
15
|
define_attribute :region, String
|
16
16
|
|
17
|
+
# @!attribute tax_details
|
18
|
+
# @return [Array[TaxDetail]]
|
19
|
+
define_attribute :tax_details, Array, { :item_type => :TaxDetail }
|
20
|
+
|
17
21
|
# @!attribute type
|
18
22
|
# @return [String] Provides the tax type as "vat" for EU VAT, "usst" for U.S. Sales Tax, or the 2 letter country code for country level tax types like Canada, Australia, New Zealand, Israel, and all non-EU European countries.
|
19
23
|
define_attribute :type, String
|
data/lib/recurly/version.rb
CHANGED
data/openapi/api.yaml
CHANGED
@@ -111,9 +111,11 @@ info:
|
|
111
111
|
developers and those who are familiar with API technology. When using the
|
112
112
|
API and passing error messages to target systems, be mindful that
|
113
113
|
these messages may not make sense in the context of the target system.
|
114
|
-
Please consider changing these messages in target system to be better
|
114
|
+
Please consider changing these messages in the target system to be better
|
115
115
|
suited to the audience of the system.
|
116
116
|
|
117
|
+
Please see [transaction error codes](https://developers.recurly.com/pages/api-transaction-errors.html) for more details.
|
118
|
+
|
117
119
|
## Pagination
|
118
120
|
### Response Schema
|
119
121
|
Every GET listing endpoint returns a response with the same schema:
|
@@ -190,6 +192,7 @@ x-tagGroups:
|
|
190
192
|
- note
|
191
193
|
- account_acquisition
|
192
194
|
- billing_info
|
195
|
+
- billing_infos
|
193
196
|
- subscription
|
194
197
|
- subscription_change
|
195
198
|
- shipping_address
|
@@ -260,9 +263,15 @@ tags:
|
|
260
263
|
to match this data with revenue and billing data events in Recurly.
|
261
264
|
- name: billing_info
|
262
265
|
x-displayName: Billing Info
|
263
|
-
description:
|
264
|
-
a credit
|
265
|
-
the customer upon purchase or when they update their
|
266
|
+
description: Without the premium Wallet feature, an account can only have one stored
|
267
|
+
payment method at a time. Examples include credit cards, PayPal, or bank accounts.
|
268
|
+
Billing info is filled out by the customer upon purchase or when they update their
|
269
|
+
information.
|
270
|
+
- name: billing_infos
|
271
|
+
x-displayName: Billing Infos
|
272
|
+
description: If the premium Wallet feature is enabled, an account can have multiple
|
273
|
+
payment methods stored. Examples include credit cards, PayPal, or bank accounts.
|
274
|
+
Primary or backup billing infos can be designated from these endpoints.
|
266
275
|
- name: subscription
|
267
276
|
x-displayName: Subscription
|
268
277
|
description: Subscriptions are created when your customers subscribe to one of your
|
@@ -2297,10 +2306,141 @@ paths:
|
|
2297
2306
|
{\n\t\tfmt.Printf(\"Resource not found: %v\", e)\n\t\treturn nil, err\n\t}\n\tfmt.Printf(\"Unexpected
|
2298
2307
|
Recurly error: %v\", e)\n\treturn nil, err\n}\n\nfmt.Printf(\"Removed Billing
|
2299
2308
|
Info: %v\", billingInfo)"
|
2309
|
+
"/accounts/{account_id}/billing_info/verify":
|
2310
|
+
post:
|
2311
|
+
tags:
|
2312
|
+
- billing_info
|
2313
|
+
operationId: verify_billing_info
|
2314
|
+
summary: Verify an account's credit card billing information
|
2315
|
+
parameters:
|
2316
|
+
- "$ref": "#/components/parameters/account_id"
|
2317
|
+
requestBody:
|
2318
|
+
content:
|
2319
|
+
application/json:
|
2320
|
+
schema:
|
2321
|
+
"$ref": "#/components/schemas/BillingInfoVerify"
|
2322
|
+
required: false
|
2323
|
+
responses:
|
2324
|
+
'200':
|
2325
|
+
description: Transaction information from verify.
|
2326
|
+
content:
|
2327
|
+
application/json:
|
2328
|
+
schema:
|
2329
|
+
"$ref": "#/components/schemas/Transaction"
|
2330
|
+
'404':
|
2331
|
+
description: Account has no billing information, or incorrect site or account
|
2332
|
+
ID.
|
2333
|
+
content:
|
2334
|
+
application/json:
|
2335
|
+
schema:
|
2336
|
+
"$ref": "#/components/schemas/Error"
|
2337
|
+
default:
|
2338
|
+
description: Unexpected error.
|
2339
|
+
content:
|
2340
|
+
application/json:
|
2341
|
+
schema:
|
2342
|
+
"$ref": "#/components/schemas/Error"
|
2343
|
+
'422':
|
2344
|
+
description: Invalid billing information, or error running the verification
|
2345
|
+
transaction.
|
2346
|
+
content:
|
2347
|
+
application/json:
|
2348
|
+
schema:
|
2349
|
+
"$ref": "#/components/schemas/ErrorMayHaveTransaction"
|
2350
|
+
x-code-samples:
|
2351
|
+
- lang: Node.js
|
2352
|
+
source: |
|
2353
|
+
try {
|
2354
|
+
const transaction = await client.verifyBillingInfo(accountId)
|
2355
|
+
console.log('Fetched Transaction: ', transaction.id)
|
2356
|
+
} catch (err) {
|
2357
|
+
if (err instanceof recurly.errors.NotFoundError) {
|
2358
|
+
// If the request was not found, you may want to alert the user or
|
2359
|
+
// just return null
|
2360
|
+
console.log('Resource Not Found')
|
2361
|
+
} else {
|
2362
|
+
// If we don't know what to do with the err, we should
|
2363
|
+
// probably re-raise and let our web framework and logger handle it
|
2364
|
+
console.log('Unknown Error: ', err)
|
2365
|
+
}
|
2366
|
+
}
|
2367
|
+
- lang: Python
|
2368
|
+
source: |
|
2369
|
+
try:
|
2370
|
+
transaction = client.verify_billing_info(account_id)
|
2371
|
+
print("Got Transaction %s" % transaction)
|
2372
|
+
except recurly.errors.NotFoundError:
|
2373
|
+
# If the resource was not found, you may want to alert the user or
|
2374
|
+
# just return nil
|
2375
|
+
print("Resource Not Found")
|
2376
|
+
- lang: ".NET"
|
2377
|
+
source: |
|
2378
|
+
try
|
2379
|
+
{
|
2380
|
+
Transaction transaction = client.VerifyBillingInfo(accountId);
|
2381
|
+
Console.WriteLine($"Fetched transaction {transaction.Id}");
|
2382
|
+
}
|
2383
|
+
catch (Recurly.Errors.NotFound ex)
|
2384
|
+
{
|
2385
|
+
// If the resource was not found
|
2386
|
+
// we may want to alert the user or just return null
|
2387
|
+
Console.WriteLine($"Resource Not Found: {ex.Error.Message}");
|
2388
|
+
}
|
2389
|
+
catch (Recurly.Errors.ApiError ex)
|
2390
|
+
{
|
2391
|
+
// Use ApiError to catch a generic error from the API
|
2392
|
+
Console.WriteLine($"Unexpected Recurly Error: {ex.Error.Message}");
|
2393
|
+
}
|
2394
|
+
- lang: Ruby
|
2395
|
+
source: |
|
2396
|
+
begin
|
2397
|
+
transaction = @client.verify_billing_info(account_id: account_id)
|
2398
|
+
puts "Got Transaction #{transaction}"
|
2399
|
+
rescue Recurly::Errors::NotFoundError
|
2400
|
+
# If the resource was not found, you may want to alert the user or
|
2401
|
+
# just return nil
|
2402
|
+
puts "Resource Not Found"
|
2403
|
+
end
|
2404
|
+
- lang: Java
|
2405
|
+
source: |
|
2406
|
+
try {
|
2407
|
+
final Transaction transaction = client.verifyBillingInfo(accountId);
|
2408
|
+
System.out.println("Fetched transaction " + transaction.getId());
|
2409
|
+
} catch (NotFoundException e) {
|
2410
|
+
// If the resource was not found
|
2411
|
+
// we may want to alert the user or just return null
|
2412
|
+
System.out.println("Resource Not Found: " + e.getError().getMessage());
|
2413
|
+
} catch (ApiException e) {
|
2414
|
+
// Use ApiException to catch a generic error from the API
|
2415
|
+
System.out.println("Unexpected Recurly Error: " + e.getError().getMessage());
|
2416
|
+
}
|
2417
|
+
- lang: PHP
|
2418
|
+
source: |
|
2419
|
+
try {
|
2420
|
+
$transaction = $client->verifyBillingInfo($account_id);
|
2421
|
+
|
2422
|
+
echo 'Got Transaction:' . PHP_EOL;
|
2423
|
+
var_dump($transaction);
|
2424
|
+
} catch (\Recurly\Errors\NotFound $e) {
|
2425
|
+
// Could not find the resource, you may want to inform the user
|
2426
|
+
// or just return a NULL
|
2427
|
+
echo 'Could not find resource.' . PHP_EOL;
|
2428
|
+
var_dump($e);
|
2429
|
+
} catch (\Recurly\RecurlyError $e) {
|
2430
|
+
// Something bad happened... tell the user so that they can fix it?
|
2431
|
+
echo 'Some unexpected Recurly error happened. Try again later.' . PHP_EOL;
|
2432
|
+
}
|
2433
|
+
- lang: Go
|
2434
|
+
source: "verifyBillingInfoParams := &recurly.VerifyBillingInfoParams{}\ntransaction,
|
2435
|
+
err := client.VerifyBillingInfo(accountID, verifyBillingInfoParams)\nif
|
2436
|
+
e, ok := err.(*recurly.Error); ok {\n\tif e.Type == recurly.ErrorTypeNotFound
|
2437
|
+
{\n\t\tfmt.Printf(\"Resource not found: %v\", e)\n\t\treturn nil, err\n\t}\n\tfmt.Printf(\"Unexpected
|
2438
|
+
Recurly error: %v\", e)\n\treturn nil, err\n}\n\nfmt.Printf(\"Fetched Transaction:
|
2439
|
+
%v\", transaction)"
|
2300
2440
|
"/accounts/{account_id}/billing_infos":
|
2301
2441
|
get:
|
2302
2442
|
tags:
|
2303
|
-
-
|
2443
|
+
- billing_infos
|
2304
2444
|
operationId: list_billing_infos
|
2305
2445
|
summary: Get the list of billing information associated with an account
|
2306
2446
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
@@ -2333,9 +2473,9 @@ paths:
|
|
2333
2473
|
x-code-samples: []
|
2334
2474
|
post:
|
2335
2475
|
tags:
|
2336
|
-
-
|
2476
|
+
- billing_infos
|
2337
2477
|
operationId: create_billing_info
|
2338
|
-
summary:
|
2478
|
+
summary: Add new billing information on an account
|
2339
2479
|
description: |
|
2340
2480
|
If you're using Recurly.js to securely submit data from webforms without sending it through your server,
|
2341
2481
|
you can associate the billing information with an account by passing in the `token_id`. The only other
|
@@ -2393,7 +2533,7 @@ paths:
|
|
2393
2533
|
"/accounts/{account_id}/billing_infos/{billing_info_id}":
|
2394
2534
|
get:
|
2395
2535
|
tags:
|
2396
|
-
-
|
2536
|
+
- billing_infos
|
2397
2537
|
operationId: get_a_billing_info
|
2398
2538
|
summary: Fetch a billing info
|
2399
2539
|
parameters:
|
@@ -2415,7 +2555,7 @@ paths:
|
|
2415
2555
|
x-code-samples: []
|
2416
2556
|
put:
|
2417
2557
|
tags:
|
2418
|
-
-
|
2558
|
+
- billing_infos
|
2419
2559
|
operationId: update_a_billing_info
|
2420
2560
|
summary: Update an account's billing information
|
2421
2561
|
description: |
|
@@ -2475,7 +2615,7 @@ paths:
|
|
2475
2615
|
x-code-samples: []
|
2476
2616
|
delete:
|
2477
2617
|
tags:
|
2478
|
-
-
|
2618
|
+
- billing_infos
|
2479
2619
|
operationId: remove_a_billing_info
|
2480
2620
|
summary: Remove an account's billing information
|
2481
2621
|
parameters:
|
@@ -15897,19 +16037,14 @@ components:
|
|
15897
16037
|
title: Kount rules
|
15898
16038
|
primary_payment_method:
|
15899
16039
|
type: boolean
|
15900
|
-
description: The `primary_payment_method`
|
15901
|
-
|
15902
|
-
|
15903
|
-
provides the flexibility to mark another billing info as primary, or adding
|
15904
|
-
additional non-primary billing infos. This can be accomplished by passing
|
15905
|
-
the `primary_payment_method` indicator. When adding billing infos via
|
15906
|
-
the billing_info and /accounts endpoints, this value is not permitted,
|
15907
|
-
and will return an error if provided.
|
16040
|
+
description: The `primary_payment_method` field is used to indicate the
|
16041
|
+
primary billing info on the account. The first billing info created on
|
16042
|
+
an account will always become primary. This payment method will be used
|
15908
16043
|
backup_payment_method:
|
15909
16044
|
type: boolean
|
15910
|
-
description: The `backup_payment_method`
|
15911
|
-
|
15912
|
-
info
|
16045
|
+
description: The `backup_payment_method` field is used to indicate a billing
|
16046
|
+
info as a backup on the account that will be tried if the initial billing
|
16047
|
+
info used for an invoice is declined.
|
15913
16048
|
created_at:
|
15914
16049
|
type: string
|
15915
16050
|
format: date-time
|
@@ -16030,23 +16165,29 @@ components:
|
|
16030
16165
|
primary_payment_method:
|
16031
16166
|
type: boolean
|
16032
16167
|
title: Primary Payment Method
|
16033
|
-
description: The `primary_payment_method`
|
16034
|
-
|
16035
|
-
|
16168
|
+
description: The `primary_payment_method` field is used to designate the
|
16169
|
+
primary billing info on the account. The first billing info created on
|
16170
|
+
an account will always become primary. Adding additional billing infos
|
16036
16171
|
provides the flexibility to mark another billing info as primary, or adding
|
16037
16172
|
additional non-primary billing infos. This can be accomplished by passing
|
16038
|
-
the `primary_payment_method`
|
16039
|
-
the billing_info and /accounts endpoints, this value is not
|
16040
|
-
and will return an error if provided.
|
16173
|
+
the `primary_payment_method` with a value of `true`. When adding billing
|
16174
|
+
infos via the billing_info and /accounts endpoints, this value is not
|
16175
|
+
permitted, and will return an error if provided.
|
16041
16176
|
backup_payment_method:
|
16042
16177
|
type: boolean
|
16043
|
-
description: The `backup_payment_method`
|
16044
|
-
|
16045
|
-
info
|
16046
|
-
|
16047
|
-
|
16048
|
-
|
16049
|
-
|
16178
|
+
description: The `backup_payment_method` field is used to designate a billing
|
16179
|
+
info as a backup on the account that will be tried if the initial billing
|
16180
|
+
info used for an invoice is declined. All payment methods, including the
|
16181
|
+
billing info marked `primary_payment_method` can be set as a backup. An
|
16182
|
+
account can have a maximum of 1 backup, if a user sets a different payment
|
16183
|
+
method as a backup, the existing backup will no longer be marked as such.
|
16184
|
+
BillingInfoVerify:
|
16185
|
+
type: object
|
16186
|
+
properties:
|
16187
|
+
gateway_code:
|
16188
|
+
type: string
|
16189
|
+
description: An identifier for a specific payment gateway.
|
16190
|
+
maxLength: 13
|
16050
16191
|
Coupon:
|
16051
16192
|
type: object
|
16052
16193
|
properties:
|
@@ -20010,6 +20151,38 @@ components:
|
|
20010
20151
|
type: number
|
20011
20152
|
format: float
|
20012
20153
|
title: Rate
|
20154
|
+
tax_details:
|
20155
|
+
type: array
|
20156
|
+
items:
|
20157
|
+
"$ref": "#/components/schemas/TaxDetail"
|
20158
|
+
TaxDetail:
|
20159
|
+
type: object
|
20160
|
+
title: Tax info
|
20161
|
+
description: Provides additional tax details for Canadian Sales Tax when there
|
20162
|
+
is tax applied at both the country and province levels. This will only be
|
20163
|
+
populated for the Invoice response when fetching a single invoice and not
|
20164
|
+
for the InvoiceList or LineItem.
|
20165
|
+
properties:
|
20166
|
+
type:
|
20167
|
+
type: string
|
20168
|
+
title: Type
|
20169
|
+
description: Provides the tax type for the region. For Canadian Sales Tax,
|
20170
|
+
this will be GST, HST, QST or PST.
|
20171
|
+
region:
|
20172
|
+
type: string
|
20173
|
+
title: Region
|
20174
|
+
description: Provides the tax region applied on an invoice. For Canadian
|
20175
|
+
Sales Tax, this will be either the 2 letter province code or country code.
|
20176
|
+
rate:
|
20177
|
+
type: number
|
20178
|
+
format: float
|
20179
|
+
title: Rate
|
20180
|
+
description: Provides the tax rate for the region.
|
20181
|
+
tax:
|
20182
|
+
type: number
|
20183
|
+
format: float
|
20184
|
+
title: Tax
|
20185
|
+
description: The total tax applied for this tax type.
|
20013
20186
|
Transaction:
|
20014
20187
|
type: object
|
20015
20188
|
properties:
|
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.3.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Recurly
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-04
|
11
|
+
date: 2021-06-04 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: bundler
|
@@ -155,6 +155,7 @@ files:
|
|
155
155
|
- lib/recurly/requests/add_on_update.rb
|
156
156
|
- lib/recurly/requests/address.rb
|
157
157
|
- lib/recurly/requests/billing_info_create.rb
|
158
|
+
- lib/recurly/requests/billing_info_verify.rb
|
158
159
|
- lib/recurly/requests/coupon_bulk_create.rb
|
159
160
|
- lib/recurly/requests/coupon_create.rb
|
160
161
|
- lib/recurly/requests/coupon_pricing.rb
|
@@ -259,6 +260,7 @@ files:
|
|
259
260
|
- lib/recurly/resources/subscription_add_on_tier.rb
|
260
261
|
- lib/recurly/resources/subscription_change.rb
|
261
262
|
- lib/recurly/resources/subscription_shipping.rb
|
263
|
+
- lib/recurly/resources/tax_detail.rb
|
262
264
|
- lib/recurly/resources/tax_info.rb
|
263
265
|
- lib/recurly/resources/tier.rb
|
264
266
|
- lib/recurly/resources/tier_pricing.rb
|
@@ -293,7 +295,7 @@ metadata:
|
|
293
295
|
changelog_uri: https://github.com/recurly/recurly-client-ruby/blob/master/CHANGELOG.md
|
294
296
|
documentation_uri: https://recurly.github.io/recurly-client-ruby/
|
295
297
|
homepage_uri: https://github.com/recurly/recurly-client-ruby
|
296
|
-
source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.
|
298
|
+
source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.3.0
|
297
299
|
post_install_message:
|
298
300
|
rdoc_options: []
|
299
301
|
require_paths:
|