Skip to content

Commit f8346a2

Browse files
authored
Merge pull request #728 from recurly/v3-v2021-02-25-19084420846
Generated Latest Changes for v2021-02-25
2 parents c1b2cc0 + 8a11df0 commit f8346a2

File tree

2 files changed

+69
-18
lines changed

2 files changed

+69
-18
lines changed

openapi/api.yaml

Lines changed: 45 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18373,9 +18373,11 @@ components:
1837318373
street1:
1837418374
type: string
1837518375
title: Street 1
18376+
maxLength: 50
1837618377
street2:
1837718378
type: string
1837818379
title: Street 2
18380+
maxLength: 50
1837918381
city:
1838018382
type: string
1838118383
title: City
@@ -23977,8 +23979,10 @@ components:
2397723979
gateway_code:
2397823980
type: string
2397923981
title: Gateway Code
23980-
description: If present, this subscription's transactions will use the payment
23981-
gateway with this code.
23982+
description: If present, this subscription's subsequent transactions will
23983+
use the payment gateway with this code. To select a payment gateway to
23984+
use when creating a Subscription, be sure to set the `account.billing_info.gateway_code`
23985+
as well.
2398223986
maxLength: 13
2398323987
transaction_type:
2398423988
description: An optional type designation for the payment gateway transaction
@@ -24388,11 +24392,11 @@ components:
2438824392
tax_details:
2438924393
type: array
2439024394
description: Provides additional tax details for Communications taxes when
24391-
Avalara for Communications is enabled or Canadian Sales Tax when there
24392-
is tax applied at both the country and province levels. This will only
24393-
be populated for the Invoice response when fetching a single invoice and
24394-
not for the InvoiceList or LineItemList. Only populated for a single LineItem
24395-
fetch when Avalara for Communications is enabled.
24395+
Avalara for Communications or Vertex Tax Breakdown is enabled or Canadian
24396+
Sales Tax. Tax details will only be populated for the Invoice response
24397+
when fetching a single invoice and not for the InvoiceList or LineItemList.
24398+
Only populated for a single LineItem fetch when Avalara for Communications
24399+
is enabled.
2439624400
items:
2439724401
"$ref": "#/components/schemas/TaxDetail"
2439824402
TaxDetail:
@@ -24403,8 +24407,8 @@ components:
2440324407
type: string
2440424408
title: Type
2440524409
description: Provides the tax type for the region or type of Comminications
24406-
tax when Avalara for Communications is enabled. For Canadian Sales Tax,
24407-
this will be GST, HST, QST or PST.
24410+
tax when Avalara for Communications or Vertex is enabled. For Canadian
24411+
Sales Tax, this will be GST, HST, QST or PST.
2440824412
region:
2440924413
type: string
2441024414
title: Region
@@ -24425,18 +24429,18 @@ components:
2442524429
type: string
2442624430
title: Name
2442724431
description: Provides the name of the Communications tax applied. Present
24428-
only when Avalara for Communications is enabled.
24432+
only when Avalara for Communications or Vertex is enabled.
2442924433
level:
2443024434
type: string
2443124435
title: Level
2443224436
description: Provides the jurisdiction level for the Communications tax
2443324437
applied. Example values include city, state and federal. Present only
24434-
when Avalara for Communications is enabled.
24438+
when Avalara for Communications or Vertex is enabled.
2443524439
billable:
2443624440
type: boolean
2443724441
title: Billable
2443824442
description: Whether or not the line item is taxable. Only populated for
24439-
a single LineItem fetch when Avalara for Communications is enabled.
24443+
a single LineItem fetch when Avalara for Communications or Vertex is enabled.
2444024444
Transaction:
2444124445
type: object
2444224446
properties:
@@ -24634,6 +24638,22 @@ components:
2463424638
title: VAT Number
2463524639
fraud_info:
2463624640
"$ref": "#/components/schemas/TransactionFraudInfo"
24641+
next_action:
24642+
type: object
24643+
x-class-name: TransactionNextAction
24644+
description: Next action values are used for any required customer follow-up
24645+
action. Currently, this is supported for Ebanx when using Pix Automatico.
24646+
properties:
24647+
type:
24648+
type: string
24649+
title: Next action type
24650+
description: The type of next action required.
24651+
"$ref": "#/components/schemas/NextActionTypeEnum"
24652+
value:
24653+
type: string
24654+
title: Next action value
24655+
description: The value associated with the next action type.
24656+
title: Next action
2463724657
TransactionFraudInfo:
2463824658
type: object
2463924659
title: Fraud information
@@ -27043,9 +27063,11 @@ components:
2704327063
- credit_card
2704427064
- eft
2704527065
- google_pay
27066+
- mercadopago
2704627067
- money_order
2704727068
- other
2704827069
- paypal
27070+
- pix_automatico
2704927071
- roku
2705027072
- sepadirectdebit
2705127073
- wire_transfer
@@ -27183,6 +27205,11 @@ components:
2718327205
- scheduled
2718427206
- success
2718527207
- void
27208+
NextActionTypeEnum:
27209+
type: string
27210+
description: The type of next action required for the transaction.
27211+
enum:
27212+
- qr_code
2718627213
CvvCheckEnum:
2718727214
type: string
2718827215
enum:
@@ -27259,6 +27286,9 @@ components:
2725927286
- boleto
2726027287
- cash_app
2726127288
- upi_autopay
27289+
- pix_automatico
27290+
- mercadopago
27291+
- klarna
2726227292
CardTypeEnum:
2726327293
type: string
2726427294
enum:
@@ -27584,10 +27614,12 @@ components:
2758427614
AchTypeEnum:
2758527615
type: string
2758627616
description: The payment method type for a non-credit card based billing info.
27587-
`bacs` and `becs` are the only accepted values.
27617+
`bacs`, `becs`, `pix-automatico`, `mercadopago` are the only accepted values.
2758827618
enum:
2758927619
- bacs
2759027620
- becs
27621+
- pix-automatico
27622+
- mercadopago
2759127623
AchAccountTypeEnum:
2759227624
type: string
2759327625
description: The bank account type. (ACH only)

recurly/resources.py

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -816,6 +816,8 @@ class Transaction(Resource):
816816
- Service Extension: Send `service_extension` if you are in a service industry and the customer has increased/extended their service in some way. For example: adding a day onto a car rental agreement.
817817
- Split Shipment: Send `split_shipment` if you sell physical product and need to split up a shipment into multiple transactions when the customer is no longer in session.
818818
- Top Up: Send `top_up` if you process one-time transactions based on a pre-arranged agreement with your customer where there is a pre-arranged account balance that needs maintaining. For example, if the customer has agreed to maintain an account balance of 30.00 and their current balance is 20.00, the MIT amount would be at least 10.00 to meet that 30.00 threshold.
819+
next_action : TransactionNextAction
820+
Next action values are used for any required customer follow-up action. Currently, this is supported for Ebanx when using Pix Automatico.
819821
object : str
820822
Object type
821823
origin : str
@@ -881,6 +883,7 @@ class Transaction(Resource):
881883
"ip_address_country": str,
882884
"ip_address_v4": str,
883885
"merchant_reason_code": str,
886+
"next_action": "TransactionNextAction",
884887
"object": str,
885888
"origin": str,
886889
"original_transaction_id": str,
@@ -988,6 +991,22 @@ class TransactionPaymentGateway(Resource):
988991
}
989992

990993

994+
class TransactionNextAction(Resource):
995+
"""
996+
Attributes
997+
----------
998+
type : str
999+
The type of next action required.
1000+
value : str
1001+
The value associated with the next action type.
1002+
"""
1003+
1004+
schema = {
1005+
"type": str,
1006+
"value": str,
1007+
}
1008+
1009+
9911010
class CouponRedemption(Resource):
9921011
"""
9931012
Attributes
@@ -1757,7 +1776,7 @@ class TaxInfo(Resource):
17571776
region : str
17581777
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. Not present when Avalara for Communications is enabled.
17591778
tax_details : :obj:`list` of :obj:`TaxDetail`
1760-
Provides additional tax details for Communications taxes when Avalara for Communications is enabled or Canadian Sales Tax when there is tax applied at both the country and province levels. This will only be populated for the Invoice response when fetching a single invoice and not for the InvoiceList or LineItemList. Only populated for a single LineItem fetch when Avalara for Communications is enabled.
1779+
Provides additional tax details for Communications taxes when Avalara for Communications or Vertex Tax Breakdown is enabled or Canadian Sales Tax. Tax details will only be populated for the Invoice response when fetching a single invoice and not for the InvoiceList or LineItemList. Only populated for a single LineItem fetch when Avalara for Communications is enabled.
17611780
type : str
17621781
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. Not present when Avalara for Communications is enabled.
17631782
"""
@@ -1775,19 +1794,19 @@ class TaxDetail(Resource):
17751794
Attributes
17761795
----------
17771796
billable : bool
1778-
Whether or not the line item is taxable. Only populated for a single LineItem fetch when Avalara for Communications is enabled.
1797+
Whether or not the line item is taxable. Only populated for a single LineItem fetch when Avalara for Communications or Vertex is enabled.
17791798
level : str
1780-
Provides the jurisdiction level for the Communications tax applied. Example values include city, state and federal. Present only when Avalara for Communications is enabled.
1799+
Provides the jurisdiction level for the Communications tax applied. Example values include city, state and federal. Present only when Avalara for Communications or Vertex is enabled.
17811800
name : str
1782-
Provides the name of the Communications tax applied. Present only when Avalara for Communications is enabled.
1801+
Provides the name of the Communications tax applied. Present only when Avalara for Communications or Vertex is enabled.
17831802
rate : float
17841803
Provides the tax rate for the region.
17851804
region : str
17861805
Provides the tax region applied on an invoice. For Canadian Sales Tax, this will be either the 2 letter province code or country code. Not present when Avalara for Communications is enabled.
17871806
tax : float
17881807
The total tax applied for this tax type.
17891808
type : str
1790-
Provides the tax type for the region or type of Comminications tax when Avalara for Communications is enabled. For Canadian Sales Tax, this will be GST, HST, QST or PST.
1809+
Provides the tax type for the region or type of Comminications tax when Avalara for Communications or Vertex is enabled. For Canadian Sales Tax, this will be GST, HST, QST or PST.
17911810
"""
17921811

17931812
schema = {

0 commit comments

Comments
 (0)