diff --git a/openapi/api.yaml b/openapi/api.yaml index 8d3bcf33..b0cca2cd 100644 --- a/openapi/api.yaml +++ b/openapi/api.yaml @@ -18373,9 +18373,11 @@ components: street1: type: string title: Street 1 + maxLength: 50 street2: type: string title: Street 2 + maxLength: 50 city: type: string title: City @@ -23977,8 +23979,10 @@ components: gateway_code: type: string title: Gateway Code - description: If present, this subscription's transactions will use the payment - gateway with this code. + description: If present, this subscription's subsequent transactions will + use the payment gateway with this code. To select a payment gateway to + use when creating a Subscription, be sure to set the `account.billing_info.gateway_code` + as well. maxLength: 13 transaction_type: description: An optional type designation for the payment gateway transaction @@ -24388,11 +24392,11 @@ components: tax_details: type: array description: 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. + 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. items: "$ref": "#/components/schemas/TaxDetail" TaxDetail: @@ -24403,8 +24407,8 @@ components: type: string title: Type description: 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. + tax when Avalara for Communications or Vertex is enabled. For Canadian + Sales Tax, this will be GST, HST, QST or PST. region: type: string title: Region @@ -24425,18 +24429,18 @@ components: type: string title: Name description: Provides the name of the Communications tax applied. Present - only when Avalara for Communications is enabled. + only when Avalara for Communications or Vertex is enabled. level: type: string title: Level description: Provides the jurisdiction level for the Communications tax applied. Example values include city, state and federal. Present only - when Avalara for Communications is enabled. + when Avalara for Communications or Vertex is enabled. billable: type: boolean title: Billable description: Whether or not the line item is taxable. Only populated for - a single LineItem fetch when Avalara for Communications is enabled. + a single LineItem fetch when Avalara for Communications or Vertex is enabled. Transaction: type: object properties: @@ -24634,6 +24638,22 @@ components: title: VAT Number fraud_info: "$ref": "#/components/schemas/TransactionFraudInfo" + next_action: + type: object + x-class-name: TransactionNextAction + description: Next action values are used for any required customer follow-up + action. Currently, this is supported for Ebanx when using Pix Automatico. + properties: + type: + type: string + title: Next action type + description: The type of next action required. + "$ref": "#/components/schemas/NextActionTypeEnum" + value: + type: string + title: Next action value + description: The value associated with the next action type. + title: Next action TransactionFraudInfo: type: object title: Fraud information @@ -27043,9 +27063,11 @@ components: - credit_card - eft - google_pay + - mercadopago - money_order - other - paypal + - pix_automatico - roku - sepadirectdebit - wire_transfer @@ -27183,6 +27205,11 @@ components: - scheduled - success - void + NextActionTypeEnum: + type: string + description: The type of next action required for the transaction. + enum: + - qr_code CvvCheckEnum: type: string enum: @@ -27259,6 +27286,9 @@ components: - boleto - cash_app - upi_autopay + - pix_automatico + - mercadopago + - klarna CardTypeEnum: type: string enum: @@ -27584,10 +27614,12 @@ components: AchTypeEnum: type: string description: The payment method type for a non-credit card based billing info. - `bacs` and `becs` are the only accepted values. + `bacs`, `becs`, `pix-automatico`, `mercadopago` are the only accepted values. enum: - bacs - becs + - pix-automatico + - mercadopago AchAccountTypeEnum: type: string description: The bank account type. (ACH only) diff --git a/recurly/resources.py b/recurly/resources.py index e6e07d7c..ea333e6d 100644 --- a/recurly/resources.py +++ b/recurly/resources.py @@ -816,6 +816,8 @@ class Transaction(Resource): - 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. - 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. - 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. + next_action : TransactionNextAction + Next action values are used for any required customer follow-up action. Currently, this is supported for Ebanx when using Pix Automatico. object : str Object type origin : str @@ -881,6 +883,7 @@ class Transaction(Resource): "ip_address_country": str, "ip_address_v4": str, "merchant_reason_code": str, + "next_action": "TransactionNextAction", "object": str, "origin": str, "original_transaction_id": str, @@ -988,6 +991,22 @@ class TransactionPaymentGateway(Resource): } +class TransactionNextAction(Resource): + """ + Attributes + ---------- + type : str + The type of next action required. + value : str + The value associated with the next action type. + """ + + schema = { + "type": str, + "value": str, + } + + class CouponRedemption(Resource): """ Attributes @@ -1757,7 +1776,7 @@ class TaxInfo(Resource): region : str 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. tax_details : :obj:`list` of :obj:`TaxDetail` - 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. + 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. type : str 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. """ @@ -1775,11 +1794,11 @@ class TaxDetail(Resource): Attributes ---------- billable : bool - Whether or not the line item is taxable. Only populated for a single LineItem fetch when Avalara for Communications is enabled. + Whether or not the line item is taxable. Only populated for a single LineItem fetch when Avalara for Communications or Vertex is enabled. level : str - Provides the jurisdiction level for the Communications tax applied. Example values include city, state and federal. Present only when Avalara for Communications is enabled. + 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. name : str - Provides the name of the Communications tax applied. Present only when Avalara for Communications is enabled. + Provides the name of the Communications tax applied. Present only when Avalara for Communications or Vertex is enabled. rate : float Provides the tax rate for the region. region : str @@ -1787,7 +1806,7 @@ class TaxDetail(Resource): tax : float The total tax applied for this tax type. type : str - 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. + 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. """ schema = {