lago-javascript-client 1.53.0 → 1.54.0

package/script/openapi/webhooks.d.ts

@@ -1226,7 +1226,7 @@ export interface paths {
         get?: never;
         /**
          * Set the payment method as default
-         * @description Use the payment method as default when not selected a payment method
+         * @description This endpoint sets a payment method as the customer's default one. It is the payment method Lago uses when a payment is triggered without an explicit one. Any other default payment method of the customer is unset.
          */
         put: operations["paymentMethodSetAsDefault"];
         post?: never;
@@ -1901,7 +1901,7 @@ export interface paths {
             query?: never;
             header?: never;
             path: {
-                /** @description Payment receipt ID */
+                /** @description Unique identifier of the payment receipt. */
                 lago_id: string;
             };
             cookie?: never;
@@ -4888,7 +4888,7 @@ export interface components {
          * @example USD
          * @enum {string}
          */
-        Currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLF" | "CLP" | "CNY" | "COP" | "CRC" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "ISK" | "JMD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KRW" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "STD" | "SZL" | "THB" | "TJS" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XOF" | "XPF" | "YER" | "ZAR" | "ZMW";
+        Currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLF" | "CLP" | "CNY" | "COP" | "CRC" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "ISK" | "JMD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KRW" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XOF" | "XPF" | "YER" | "ZAR" | "ZMW";
         /**
          * @example US
          * @enum {string|null}
@@ -6001,7 +6001,7 @@ export interface components {
          * @example USD
          * @enum {string|null}
          */
-        CurrencyOrNull: null | "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLF" | "CLP" | "CNY" | "COP" | "CRC" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "ISK" | "JMD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KRW" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "STD" | "SZL" | "THB" | "TJS" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XOF" | "XPF" | "YER" | "ZAR" | "ZMW";
+        CurrencyOrNull: null | "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLF" | "CLP" | "CNY" | "COP" | "CRC" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "ISK" | "JMD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KRW" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XOF" | "XPF" | "YER" | "ZAR" | "ZMW";
         AppliedCouponObject: {
             /**
              * Format: uuid
@@ -6025,6 +6025,11 @@ export interface components {
              * @example Startup Deal
              */
             coupon_name: string;
+            /**
+             * @description The description of the parent coupon.
+             * @example I am a coupon description
+             */
+            coupon_description?: string | null;
             /**
              * @description The status of the parent coupon. Can be either `active` or `terminated`.
              * @example active
@@ -8876,7 +8881,7 @@ export interface components {
             /** @description List of invoice IDs associated with the payment. */
             invoice_ids: string[];
             /** @description List of invoice numbers associated with the payment. */
-            invoice_numbers?: string[];
+            invoice_numbers: string[];
             /**
              * Format: uuid
              * @description The unique identifier of the paid resource, created by Lago.
@@ -8917,15 +8922,15 @@ export interface components {
              */
             type: "manual" | "provider";
             /**
-             * @description Reference for the payment.
+             * @description Reference for the payment. Set on manual payments only; it is always `null` for payments collected through a payment provider.
              * @example ref1
              */
-            reference: string;
+            reference: string | null;
             /**
-             * @description Code of the payment provider
+             * @description Code of the payment provider. It is `null` for manual payments, which are not attached to a payment provider.
              * @example stripe_prod
              */
-            payment_provider_code: string;
+            payment_provider_code: string | null;
             /**
              * @description The type of payment provider
              * @example stripe
@@ -8940,16 +8945,10 @@ export interface components {
              */
             provider_payment_id: string | null;
             /**
-             * @description Unique identifier of the customer within the payment provider
+             * @description Unique identifier of the customer within the payment provider. It is `null` for manual payments.
              * @example cus_5eb0285bcf941bc6ba
              */
-            provider_customer_id: string;
-            /**
-             * Format: uuid
-             * @description The unique identifier of the payment method used for this payment.
-             * @example 1a901a90-1a90-1a90-1a90-1a901a901a90
-             */
-            payment_method_id?: string | null;
+            provider_customer_id: string | null;
             /**
              * @description The next action to be taken by the customer to complete the payment. Should usually be empty, except when receiving the `payment.requires_action` webhook.
              * @example {
@@ -8983,10 +8982,10 @@ export interface components {
             lago_id: string;
             /**
              * Format: email
-             * @description The customer's email address used for sending dunning notifications
+             * @description The email address used for sending dunning notifications. It defaults to the customer's own email address, and is `null` when the customer has none.
              * @example dinesh@piedpiper.test
              */
-            email: string;
+            email: string | null;
             /**
              * @description The sum of the total amounts of all the invoices included in the payment request, expressed in cents.
              * @example 100
@@ -9481,7 +9480,7 @@ export interface components {
              */
             code?: string | null;
             /**
-             * @description Wallet priority for ordering when a customer has multiple wallets. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50.
+             * @description Wallet priority for ordering when a customer has multiple wallets. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50. Wallets with the same priority are applied by expiration date, soonest first, with wallets without an expiration date last, then by creation date, oldest first.
              * @example 50
              */
             priority?: number;
@@ -9620,7 +9619,7 @@ export interface components {
             invoice_custom_section_codes?: string[];
         };
         WalletCreateInput: {
-            wallet?: {
+            wallet: {
                 /**
                  * @description The name of the wallet.
                  * @example Prepaid
@@ -9632,7 +9631,7 @@ export interface components {
                  */
                 code?: string | null;
                 /**
-                 * @description Wallet priority for ordering when a customer has multiple wallets. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50.
+                 * @description Wallet priority for ordering when a customer has multiple wallets. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50. Wallets with the same priority are applied by expiration date, soonest first, with wallets without an expiration date last, then by creation date, oldest first.
                  * @example 50
                  */
                 priority?: number;
@@ -9701,6 +9700,11 @@ export interface components {
                  * @example Tokens for models 'high-fidelity-boost'
                  */
                 transaction_name?: string | null;
+                /**
+                 * @description The priority of the wallet transactions triggered when creating the wallet. It drives the order in which credits are consumed. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50.
+                 * @example 50
+                 */
+                transaction_priority?: number;
                 /**
                  * @description The purchase order number associated with the wallet. It will be added to invoices generated for wallet top-ups, unless a more specific purchase order number is set on the wallet transaction or recurring transaction rule that triggered the top-up.
                  * @example PO-123
@@ -9858,7 +9862,7 @@ export interface components {
                  */
                 code?: string | null;
                 /**
-                 * @description Wallet priority for ordering when a customer has multiple wallets. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50.
+                 * @description Wallet priority for ordering when a customer has multiple wallets. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50. Wallets with the same priority are applied by expiration date, soonest first, with wallets without an expiration date last, then by creation date, oldest first.
                  * @example 50
                  */
                 priority?: number;
@@ -9873,6 +9877,16 @@ export interface components {
                  * @example false
                  */
                 invoice_requires_successful_payment?: boolean;
+                /**
+                 * @description Minimum amount of cents that can be top-up with a single paid transaction.
+                 * @example 100
+                 */
+                paid_top_up_min_amount_cents?: number | null;
+                /**
+                 * @description Maximum amount of cents that can be top-up with a single paid transaction.
+                 * @example 1000
+                 */
+                paid_top_up_max_amount_cents?: number | null;
                 /**
                  * @description The code of the billing entity associated with the wallet.
                  * @example default
@@ -10666,18 +10680,18 @@ export interface components {
              * @description Code of the payment provider associated with this payment method.
              * @example stripe_prod
              */
-            payment_provider_code?: string | null;
+            payment_provider_code: string | null;
             /**
              * @description Human-readable name of the payment provider.
              * @example Stripe
              */
-            payment_provider_name?: string | null;
+            payment_provider_name: string | null;
             /**
-             * @description The type of the payment provider.
+             * @description The type of the payment provider. It is `null` when the payment method is no longer attached to a payment provider.
              * @example stripe
-             * @enum {string}
+             * @enum {string|null}
              */
-            payment_provider_type: "adyen" | "cashfree" | "gocardless" | "stripe" | "flutterwave" | "moneyhash";
+            payment_provider_type: null | "adyen" | "cashfree" | "gocardless" | "stripe" | "flutterwave" | "moneyhash";
             /**
              * @description Unique identifier of the payment method within the payment provider.
              * @example pm_1N8ZQX2eZvKYlo2CkL9Y8XYZ
@@ -12574,6 +12588,16 @@ export interface components {
              * @example LAG-1234-001-002
              */
             number: string;
+            /**
+             * @description The PDF file of the payment receipt. It is `null` while no PDF has been generated.
+             * @example https://getlago.com/payment_receipt/file
+             */
+            file_url?: string | null;
+            /**
+             * @description The e-invoicing XML file of the payment receipt. It is `null` while no XML file has been generated.
+             * @example https://getlago.com/payment_receipt/xml
+             */
+            xml_url?: string | null;
             payment: components["schemas"]["PaymentObject"];
         };
         PaymentReceiptsPaginated: {
@@ -12592,10 +12616,10 @@ export interface components {
                 external_customer_id: string;
                 /**
                  * Format: email
-                 * @description The customer's email address used for sending dunning notifications
+                 * @description The email address used for sending dunning notifications. When omitted, the customer's own email address is used.
                  * @example dinesh@piedpiper.test
                  */
-                email: string;
+                email?: string;
                 /** @description A list of Lago IDs for the customer's overdue invoices to start the dunning process */
                 lago_invoice_ids: string[];
                 /** @description Optional payment method to use for processing the payment request. */
@@ -15519,6 +15543,17 @@ export interface components {
                  * @example 5.0
                  */
                 voided_credits?: string | null;
+                /**
+                 * Format: uuid
+                 * @description Unique identifier of the inbound wallet transaction to void. Only available on traceable wallets, and the target transaction must still have a remaining amount.
+                 * @example 1a901a90-1a90-1a90-1a90-1a901a901a90
+                 */
+                voided_transaction_id?: string | null;
+                /**
+                 * @description The priority of the wallet transaction. It drives the order in which credits are consumed. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50.
+                 * @example 50
+                 */
+                priority?: number;
                 /**
                  * @description A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
                  * @example false
@@ -15571,6 +15606,11 @@ export interface components {
              * @example 1a901a90-1a90-1a90-1a90-1a901a901a90
              */
             lago_wallet_id: string;
+            /**
+             * @description The code of the billing entity associated with the wallet transaction. Falls back to the wallet's billing entity when the transaction does not carry one.
+             * @example default
+             */
+            billing_entity_code?: string;
             /**
              * Format: uuid
              * @description Unique identifier assigned to the invoice associated with this wallet transaction. This ID is exclusively created by Lago and serves as a unique identifier for the invoice's record within the Lago system.
@@ -16484,6 +16524,8 @@ export interface components {
         purchase_order_number: string;
         /** @description The customer external unique identifier (provided by your own application) */
         external_customer_id_path: string;
+        /** @description Filter the results by currency, expressed as an ISO 4217 code. */
+        currency: string;
         /** @description Filter by payment status. Possible values are `pending`, `failed` or `succeeded`. */
         payment_status: "pending" | "failed" | "succeeded";
         /** @description A unique wallet identifier within a customer. It is either set by the user at creation or auto-generated by Lago if not provided. */
@@ -16494,8 +16536,6 @@ export interface components {
         lago_order_form_id: string;
         /** @description Unique identifier assigned to the order within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the order's record within the Lago system. */
         lago_order_id: string;
-        /** @description Filter the results by currency, expressed as an ISO 4217 code. */
-        currency: string;
         /** @description Code of the existing plan. */
         plan_code: string;
         /** @description Code of the existing charge. */
@@ -18304,6 +18344,8 @@ export interface operations {
                 page?: components["parameters"]["page"];
                 /** @description Number of records per page. */
                 per_page?: components["parameters"]["per_page"];
+                /** @description Filter the results by currency, expressed as an ISO 4217 code. */
+                currency?: components["parameters"]["currency"];
                 /** @description Filter by payment status. Possible values are `pending`, `failed` or `succeeded`. */
                 payment_status?: components["parameters"]["payment_status"];
                 /** @description Filter payment requests by billing entity codes. */
@@ -18409,6 +18451,8 @@ export interface operations {
                 page?: components["parameters"]["page"];
                 /** @description Number of records per page. */
                 per_page?: components["parameters"]["per_page"];
+                /** @description Filter the results by currency, expressed as an ISO 4217 code. */
+                currency?: components["parameters"]["currency"];
                 /** @description Filter wallets by billing entity codes. */
                 "billing_entity_codes[]"?: string[];
             };
@@ -18681,7 +18725,12 @@ export interface operations {
     };
     getCustomerWalletAlerts: {
         parameters: {
-            query?: never;
+            query?: {
+                /** @description Page number. */
+                page?: components["parameters"]["page"];
+                /** @description Number of records per page. */
+                per_page?: components["parameters"]["per_page"];
+            };
             header?: never;
             path: {
                 /** @description The customer external unique identifier (provided by your own application) */
@@ -19060,7 +19109,7 @@ export interface operations {
         };
         requestBody?: never;
         responses: {
-            /** @description Return a 200 status to indicate that the data was received successfully */
+            /** @description Payment method set as default */
             200: {
                 headers: {
                     [name: string]: unknown;
@@ -20190,7 +20239,7 @@ export interface operations {
             query?: never;
             header?: never;
             path: {
-                /** @description Payment receipt ID */
+                /** @description Unique identifier of the payment receipt. */
                 lago_id: string;
             };
             cookie?: never;
@@ -21738,6 +21787,10 @@ export interface operations {
             query?: {
                 /** @description Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`. */
                 subscription_status?: components["parameters"]["subscription_status"];
+                /** @description Page number. */
+                page?: components["parameters"]["page"];
+                /** @description Number of records per page. */
+                per_page?: components["parameters"]["per_page"];
             };
             header?: never;
             path: {
@@ -23005,6 +23058,8 @@ export interface operations {
                 transaction_status?: string;
                 /** @description The transaction type of the wallet transaction. Possible values are `inbound` (increasing the wallet balance) or `outbound` (decreasing the wallet balance). */
                 transaction_type?: string;
+                /** @description Filter wallet transactions by metadata. Replace `key` with the actual metadata key you want to match, and provide the corresponding value. For example, `metadata[color]=blue`. */
+                "metadata[key]"?: string;
             };
             header?: never;
             path: {