@leaflow/sdk 0.129.2 → 0.131.0

package/dist/canopy/v1/generated/models.d.ts

@@ -249,7 +249,11 @@ export declare const RequestResourceUsageSource: {
     readonly estimated: "estimated";
 };
 export interface RequestResource {
-    api_key_id: string;
+    /**
+     * Null for a request made by an internal service directly for the project.
+     * @nullable
+     */
+    api_key_id: string | null;
     /** The portion served from the upstream prefix cache, which costs an order of magnitude less than ordinary input */
     cache_read_tokens: number;
     cache_write_tokens: number;
@@ -586,108 +590,159 @@ export interface CursorPagination {
     /** @nullable */
     next_cursor?: string | null;
 }
+export interface WithdrawalAllocation {
+    source_transaction_id: string;
+    /** @pattern ^[0-9]{1,15}([.][0-9]{1,10})?$ */
+    amount: string;
+    /** @pattern ^[0-9]{1,15}([.][0-9]{1,10})?$ */
+    fee_amount: string;
+    /** @pattern ^[0-9]{1,15}([.][0-9]{1,10})?$ */
+    refund_amount: string;
+}
+export type WithdrawalItemStatus = (typeof WithdrawalItemStatus)[keyof typeof WithdrawalItemStatus];
+export declare const WithdrawalItemStatus: {
+    readonly pending: "pending";
+    readonly succeeded: "succeeded";
+    readonly failed: "failed";
+    readonly reversed: "reversed";
+};
 /**
- * How tax applies to the customer, as in Stripe. `none` taxes normally. `exempt` charges no tax.
- * `reverse` charges no tax and leaves it to the customer under the reverse-charge mechanism;
- * invoices state this. Only operators change it.
+ * The original top-up and its refund destination. Card details are included when the original payment method was saved; missing card details do not change the original refund route.
  */
-export type ContactTaxExempt = (typeof ContactTaxExempt)[keyof typeof ContactTaxExempt];
-export declare const ContactTaxExempt: {
-    readonly none: "none";
-    readonly exempt: "exempt";
-    readonly reverse: "reverse";
-};
+export interface WithdrawalSource {
+    /** @pattern ^[0-9]{1,15}([.][0-9]{1,10})?$ */
+    amount: string;
+    /**
+     * @minLength 3
+     * @maxLength 3
+     */
+    currency: string;
+    received_at: string;
+    payment_gateway: string;
+    method_type: string;
+    card_brand?: string;
+    /** @pattern ^[0-9]{4}$ */
+    card_last4?: string;
+}
 /**
- * A billing-account contact profile with one address. An account can hold multiple contacts; this is not a login identity.
+ * The fixed principal deduction, withdrawal fee and exact refund obligation for one original top-up. Each item has its own refund; payment_gateway and method_type identify the original route.
  */
-export interface Contact {
+export interface WithdrawalItem {
+    source_transaction_id: string;
+    /** @pattern ^[0-9]{1,15}([.][0-9]{1,10})?$ */
+    amount: string;
+    /** @pattern ^[0-9]{1,15}([.][0-9]{1,10})?$ */
+    fee_amount: string;
+    /** @pattern ^[0-9]{1,15}([.][0-9]{1,10})?$ */
+    refund_amount: string;
     id: string;
+    withdrawal_id: string;
     billing_account_id: number;
     /**
-     * @minLength 1
-     * @maxLength 255
+     * @minLength 3
+     * @maxLength 3
      */
-    name: string;
-    /** @maxLength 255 */
-    legal_name?: string;
-    /** @maxLength 255 */
-    email?: string;
-    /** @maxLength 64 */
-    tax_id?: string;
-    /** @maxLength 255 */
-    address_line1?: string;
-    /** @maxLength 255 */
-    address_line2?: string;
-    /** @maxLength 128 */
-    address_city?: string;
-    /** @maxLength 128 */
-    address_state?: string;
-    /** @maxLength 32 */
-    address_postal_code?: string;
-    /** @pattern ^([A-Z]{2})?$ */
-    address_country?: string;
+    currency: string;
+    refund_id: string;
+    fee_transaction_id?: string;
+    status: WithdrawalItemStatus;
+    completed_at?: string;
+    payment_gateway: string;
+    method_type: string;
+    source: WithdrawalSource;
+    /** The original gateway failure code when a refund failed, or refund_reversed when a completed refund was reversed. Absent while pending or successful. */
+    failure_code?: string;
+}
+export type WithdrawalStatus = (typeof WithdrawalStatus)[keyof typeof WithdrawalStatus];
+export declare const WithdrawalStatus: {
+    readonly pending: "pending";
+    readonly processing: "processing";
+    readonly succeeded: "succeeded";
+    readonly partially_completed: "partially_completed";
+    readonly failed: "failed";
+    readonly reversed: "reversed";
+};
+/**
+ * An account withdrawal to the original payment methods of its unused top-ups. Accepted amounts are fixed. deducted_amount, settled_amount and charged_fee_amount report completed source items. Failed items release their principal and fee reservations; successful items are retained when another source fails.
+ */
+export interface Withdrawal {
+    id: string;
+    billing_account_id: number;
     /**
-     * How tax applies to the customer, as in Stripe. `none` taxes normally. `exempt` charges no tax.
-     * `reverse` charges no tax and leaves it to the customer under the reverse-charge mechanism;
-     * invoices state this. Only operators change it.
+     * @minLength 3
+     * @maxLength 3
      */
-    tax_exempt: ContactTaxExempt;
-    active: boolean;
+    currency: string;
+    /** @pattern ^[0-9]{1,15}([.][0-9]{1,10})?$ */
+    amount: string;
+    /** @pattern ^[0-9]{1,15}([.][0-9]{1,10})?$ */
+    fee_amount: string;
+    /** @pattern ^[0-9]{1,15}([.][0-9]{1,10})?$ */
+    refund_amount: string;
+    /** @pattern ^[0-9]{1,15}([.][0-9]{1,10})?$ */
+    deducted_amount: string;
+    /** @pattern ^[0-9]{1,15}([.][0-9]{1,10})?$ */
+    settled_amount: string;
+    /** @pattern ^[0-9]{1,15}([.][0-9]{1,10})?$ */
+    charged_fee_amount: string;
+    status: WithdrawalStatus;
     created_at: string;
-}
-export interface ContactCreate {
+    completed_at?: string;
+    /** Identity that submitted this withdrawal. It can differ from the billing account owner. */
+    created_by?: string;
+}
+export interface WithdrawalPreviewItem {
+    source_transaction_id: string;
+    /** @pattern ^[0-9]{1,15}([.][0-9]{1,10})?$ */
+    amount: string;
+    /** @pattern ^[0-9]{1,15}([.][0-9]{1,10})?$ */
+    fee_amount: string;
+    /** @pattern ^[0-9]{1,15}([.][0-9]{1,10})?$ */
+    refund_amount: string;
+    source: WithdrawalSource;
+}
+export interface WithdrawalPreview {
+    billing_account_id: number;
     /**
-     * @minLength 1
-     * @maxLength 255
+     * @minLength 3
+     * @maxLength 3
      */
-    name: string;
-    /** @maxLength 255 */
-    legal_name?: string;
-    /** @maxLength 255 */
-    email?: string;
-    /** @maxLength 64 */
-    tax_id?: string;
-    /** @maxLength 255 */
-    address_line1?: string;
-    /** @maxLength 255 */
-    address_line2?: string;
-    /** @maxLength 128 */
-    address_city?: string;
-    /** @maxLength 128 */
-    address_state?: string;
-    /** @maxLength 32 */
-    address_postal_code?: string;
-    /** @pattern ^([A-Z]{2})?$ */
-    address_country?: string;
+    currency: string;
+    /** @pattern ^[0-9]{1,15}([.][0-9]{1,10})?$ */
+    available_amount: string;
+    /** @pattern ^[0-9]{1,15}([.][0-9]{1,10})?$ */
+    amount: string;
+    /** @pattern ^[0-9]{1,15}([.][0-9]{1,10})?$ */
+    fee_amount: string;
+    /** @pattern ^[0-9]{1,15}([.][0-9]{1,10})?$ */
+    refund_amount: string;
+    /** @maxItems 200 */
+    items: WithdrawalPreviewItem[];
+}
+export interface WithdrawalPreviewRequest {
+    billing_account_id: number;
+    /** @pattern ^[0-9]{1,15}([.][0-9]{1,10})?$ */
+    amount?: string;
 }
-export interface ContactUpdate {
+export interface WithdrawalCreate {
+    id: string;
+    billing_account_id: number;
+    /** @pattern ^[0-9]{1,15}([.][0-9]{1,10})?$ */
+    amount: string;
+    /** @pattern ^[0-9]{1,15}([.][0-9]{1,10})?$ */
+    expected_refund_amount: string;
     /**
-     * @minLength 1
-     * @maxLength 255
+     * @minItems 1
+     * @maxItems 200
      */
-    name?: string;
-    /** @maxLength 255 */
-    legal_name?: string;
-    /** @maxLength 255 */
-    email?: string;
-    /** @maxLength 64 */
-    tax_id?: string;
-    /** @maxLength 255 */
-    address_line1?: string;
-    /** @maxLength 255 */
-    address_line2?: string;
-    /** @maxLength 128 */
-    address_city?: string;
-    /** @maxLength 128 */
-    address_state?: string;
-    /** @maxLength 32 */
-    address_postal_code?: string;
-    /** @pattern ^([A-Z]{2})?$ */
-    address_country?: string;
-    active?: boolean;
+    expected_items: WithdrawalAllocation[];
 }
-export interface ContactList {
-    items: Contact[];
+export interface WithdrawalList {
+    items: Withdrawal[];
+    pagination: OffsetPagination;
+}
+export interface WithdrawalItemList {
+    items: WithdrawalItem[];
     pagination: OffsetPagination;
 }
 /**
@@ -1749,6 +1804,7 @@ export declare const TransactionType: {
     readonly payment: "payment";
     readonly refund: "refund";
     readonly adjustment: "adjustment";
+    readonly fee: "fee";
 };
 /**
  * A funds operation. Each payment has one source; refunds identify the original successful transaction. Unknown gateway results remain pending. Payments from the balance or a gateway are distinct from credit-grant payments.
@@ -3360,6 +3416,110 @@ export interface QuoteRequest {
     promotion_code?: string;
     refund?: OrderRefundQuoteInput;
 }
+/**
+ * How tax applies to the customer, as in Stripe. `none` taxes normally. `exempt` charges no tax.
+ * `reverse` charges no tax and leaves it to the customer under the reverse-charge mechanism;
+ * invoices state this. Only operators change it.
+ */
+export type ContactTaxExempt = (typeof ContactTaxExempt)[keyof typeof ContactTaxExempt];
+export declare const ContactTaxExempt: {
+    readonly none: "none";
+    readonly exempt: "exempt";
+    readonly reverse: "reverse";
+};
+/**
+ * A billing-account contact profile with one address. An account can hold multiple contacts; this is not a login identity.
+ */
+export interface Contact {
+    id: string;
+    billing_account_id: number;
+    /**
+     * @minLength 1
+     * @maxLength 255
+     */
+    name: string;
+    /** @maxLength 255 */
+    legal_name?: string;
+    /** @maxLength 255 */
+    email?: string;
+    /** @maxLength 64 */
+    tax_id?: string;
+    /** @maxLength 255 */
+    address_line1?: string;
+    /** @maxLength 255 */
+    address_line2?: string;
+    /** @maxLength 128 */
+    address_city?: string;
+    /** @maxLength 128 */
+    address_state?: string;
+    /** @maxLength 32 */
+    address_postal_code?: string;
+    /** @pattern ^([A-Z]{2})?$ */
+    address_country?: string;
+    /**
+     * How tax applies to the customer, as in Stripe. `none` taxes normally. `exempt` charges no tax.
+     * `reverse` charges no tax and leaves it to the customer under the reverse-charge mechanism;
+     * invoices state this. Only operators change it.
+     */
+    tax_exempt: ContactTaxExempt;
+    active: boolean;
+    created_at: string;
+}
+export interface ContactCreate {
+    /**
+     * @minLength 1
+     * @maxLength 255
+     */
+    name: string;
+    /** @maxLength 255 */
+    legal_name?: string;
+    /** @maxLength 255 */
+    email?: string;
+    /** @maxLength 64 */
+    tax_id?: string;
+    /** @maxLength 255 */
+    address_line1?: string;
+    /** @maxLength 255 */
+    address_line2?: string;
+    /** @maxLength 128 */
+    address_city?: string;
+    /** @maxLength 128 */
+    address_state?: string;
+    /** @maxLength 32 */
+    address_postal_code?: string;
+    /** @pattern ^([A-Z]{2})?$ */
+    address_country?: string;
+}
+export interface ContactUpdate {
+    /**
+     * @minLength 1
+     * @maxLength 255
+     */
+    name?: string;
+    /** @maxLength 255 */
+    legal_name?: string;
+    /** @maxLength 255 */
+    email?: string;
+    /** @maxLength 64 */
+    tax_id?: string;
+    /** @maxLength 255 */
+    address_line1?: string;
+    /** @maxLength 255 */
+    address_line2?: string;
+    /** @maxLength 128 */
+    address_city?: string;
+    /** @maxLength 128 */
+    address_state?: string;
+    /** @maxLength 32 */
+    address_postal_code?: string;
+    /** @pattern ^([A-Z]{2})?$ */
+    address_country?: string;
+    active?: boolean;
+}
+export interface ContactList {
+    items: Contact[];
+    pagination: OffsetPagination;
+}
 export interface CancelSubscriptionRequest {
     mode: TerminationPolicy;
     /** For immediate cancellation, the quoted whole-second refund basis. Now when omitted. */

package/dist/canopy/v1/generated/models.js

@@ -54,10 +54,19 @@ export const InvoiceStatus = {
     void: "void",
     uncollectible: "uncollectible",
 };
-export const ContactTaxExempt = {
-    none: "none",
-    exempt: "exempt",
-    reverse: "reverse",
+export const WithdrawalItemStatus = {
+    pending: "pending",
+    succeeded: "succeeded",
+    failed: "failed",
+    reversed: "reversed",
+};
+export const WithdrawalStatus = {
+    pending: "pending",
+    processing: "processing",
+    succeeded: "succeeded",
+    partially_completed: "partially_completed",
+    failed: "failed",
+    reversed: "reversed",
 };
 export const TerminationPolicy = {
     immediate: "immediate",
@@ -192,6 +201,7 @@ export const TransactionType = {
     payment: "payment",
     refund: "refund",
     adjustment: "adjustment",
+    fee: "fee",
 };
 export const InvoiceCustomerTaxExempt = {
     none: "none",
@@ -402,6 +412,11 @@ export const ActiveResourceStatus = {
     closing: "closing",
     closed: "closed",
 };
+export const ContactTaxExempt = {
+    none: "none",
+    exempt: "exempt",
+    reverse: "reverse",
+};
 export const StatementStatus = {
     open: "open",
     closed: "closed",

package/dist/canopy/v1/generated/validators/cursorPageRequestResource.zod.d.ts

@@ -31,7 +31,7 @@
 import * as zod from "zod";
 export declare const CursorPageRequestResource: zod.ZodObject<{
     items: zod.ZodArray<zod.ZodObject<{
-        api_key_id: zod.ZodUUID;
+        api_key_id: zod.ZodNullable<zod.ZodUUID>;
         cache_read_tokens: zod.ZodInt;
         cache_write_tokens: zod.ZodInt;
         error_code: zod.ZodString;

package/dist/canopy/v1/generated/validators/paymentResult.zod.d.ts

@@ -66,6 +66,7 @@ export declare const PaymentResult: zod.ZodObject<{
             payment: "payment";
             refund: "refund";
             adjustment: "adjustment";
+            fee: "fee";
         }>;
         amount: zod.ZodString;
         remaining_amount: zod.ZodString;

package/dist/canopy/v1/generated/validators/refund.zod.d.ts

@@ -68,6 +68,7 @@ export declare const Refund: zod.ZodObject<{
             payment: "payment";
             refund: "refund";
             adjustment: "adjustment";
+            fee: "fee";
         }>;
         amount: zod.ZodString;
         remaining_amount: zod.ZodString;

package/dist/canopy/v1/generated/validators/refundList.zod.d.ts

@@ -69,6 +69,7 @@ export declare const RefundList: zod.ZodObject<{
                 payment: "payment";
                 refund: "refund";
                 adjustment: "adjustment";
+                fee: "fee";
             }>;
             amount: zod.ZodString;
             remaining_amount: zod.ZodString;

package/dist/canopy/v1/generated/validators/requestResource.zod.d.ts

@@ -30,7 +30,7 @@
  */
 import * as zod from "zod";
 export declare const RequestResource: zod.ZodObject<{
-    api_key_id: zod.ZodUUID;
+    api_key_id: zod.ZodNullable<zod.ZodUUID>;
     cache_read_tokens: zod.ZodInt;
     cache_write_tokens: zod.ZodInt;
     error_code: zod.ZodString;

package/dist/canopy/v1/generated/validators/requestResource.zod.js

@@ -30,7 +30,10 @@
  */
 import * as zod from "zod";
 export const RequestResource = zod.strictObject({
-    api_key_id: zod.uuid(),
+    api_key_id: zod
+        .uuid()
+        .nullable()
+        .describe("Null for a request made by an internal service directly for the project."),
     cache_read_tokens: zod
         .int()
         .describe("The portion served from the upstream prefix cache, which costs an order of magnitude less than ordinary input"),

package/dist/canopy/v1/generated/validators/transaction.zod.d.ts

@@ -65,6 +65,7 @@ export declare const Transaction: zod.ZodObject<{
         payment: "payment";
         refund: "refund";
         adjustment: "adjustment";
+        fee: "fee";
     }>;
     amount: zod.ZodString;
     remaining_amount: zod.ZodString;

package/dist/canopy/v1/generated/validators/transactionList.zod.d.ts

@@ -66,6 +66,7 @@ export declare const TransactionList: zod.ZodObject<{
             payment: "payment";
             refund: "refund";
             adjustment: "adjustment";
+            fee: "fee";
         }>;
         amount: zod.ZodString;
         remaining_amount: zod.ZodString;

package/dist/canopy/v1/generated/validators/transactionType.zod.d.ts

@@ -34,6 +34,7 @@ export declare const TransactionType: zod.ZodEnum<{
     payment: "payment";
     refund: "refund";
     adjustment: "adjustment";
+    fee: "fee";
 }>;
 export type TransactionType = zod.input<typeof TransactionType>;
 export type TransactionTypeOutput = zod.output<typeof TransactionType>;

package/dist/canopy/v1/generated/validators/transactionType.zod.js

@@ -30,5 +30,5 @@
  */
 import * as zod from "zod";
 export const TransactionType = zod
-    .enum(["topup", "payment", "refund", "adjustment"])
+    .enum(["topup", "payment", "refund", "adjustment", "fee"])
     .describe("topup adds to the balance; payment settles an invoice; refund returns original funds; adjustment changes the balance with an audit reason.");

package/dist/canopy/v1/generated/validators/withdrawal.zod.d.ts

@@ -0,0 +1,63 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Canopy API
+ * Management of API keys, together with the models available and the usage recorded against them.
+ *
+ * **These endpoints do not perform inference.** Requests are issued to the forwarding address, which accepts the OpenAI, Anthropic and Gemini request formats:
+ *
+ * ```
+ * POST /v1/chat/completions                    OpenAI
+ * POST /v1/messages                            Anthropic
+ * POST /v1beta/models/{model}:generateContent  Gemini
+ * ```
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme.
+ *
+ * These endpoints do not accept an API key, and the forwarding endpoints do not accept a scoped token.
+ *
+ * ## Conventions
+ *
+ * - **The plaintext of an API key is returned once.** The `secret` appears in the response that issues it and is returned by no other endpoint. A key that has been lost has to be revoked and reissued.
+ * - **Disabling and revoking are distinct.** A disabled key may be enabled again at any time, while a revocation is irreversible and is intended for a key that has been exposed. Neither removes the record, and the usage the key accrued remains readable.
+ * - **A usage query must carry a time range**, spanning no more than 31 days. `from` and `to` carry a timezone offset, which the server does not infer.
+ * - **The request and response bodies do not appear in the ledger.** They are not recorded. Quote the `upstream_request_id` from the response when reporting a problem.
+ * - **Usage may be estimated.** The upstream provider does not report usage on every request. Where it does not, `usage_source` is `estimated` and the figures are derived from the character classes of the payload, to within roughly fifteen per cent.
+ * - **The service is enabled before use.** A project enables the model platform once, through `create-service`; the forwarding endpoints refuse its requests until the service is `active`. Requests are then billed under the service's subscription by the tokens they use, at the rates stated in each model's `pricing`.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+export declare const withdrawalCurrencyMin = 3;
+export declare const withdrawalCurrencyMax = 3;
+export declare const withdrawalAmountRegExp: RegExp;
+export declare const withdrawalFeeAmountRegExp: RegExp;
+export declare const withdrawalRefundAmountRegExp: RegExp;
+export declare const withdrawalDeductedAmountRegExp: RegExp;
+export declare const withdrawalSettledAmountRegExp: RegExp;
+export declare const withdrawalChargedFeeAmountRegExp: RegExp;
+export declare const Withdrawal: zod.ZodObject<{
+    id: zod.ZodUUID;
+    billing_account_id: zod.ZodInt;
+    currency: zod.ZodString;
+    amount: zod.ZodString;
+    fee_amount: zod.ZodString;
+    refund_amount: zod.ZodString;
+    deducted_amount: zod.ZodString;
+    settled_amount: zod.ZodString;
+    charged_fee_amount: zod.ZodString;
+    status: zod.ZodEnum<{
+        pending: "pending";
+        failed: "failed";
+        succeeded: "succeeded";
+        processing: "processing";
+        partially_completed: "partially_completed";
+        reversed: "reversed";
+    }>;
+    created_at: zod.z.ZodISODateTime;
+    completed_at: zod.ZodOptional<zod.z.ZodISODateTime>;
+    created_by: zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strict>;
+export type Withdrawal = zod.input<typeof Withdrawal>;
+export type WithdrawalOutput = zod.output<typeof Withdrawal>;

package/dist/canopy/v1/generated/validators/withdrawal.zod.js

@@ -0,0 +1,66 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Canopy API
+ * Management of API keys, together with the models available and the usage recorded against them.
+ *
+ * **These endpoints do not perform inference.** Requests are issued to the forwarding address, which accepts the OpenAI, Anthropic and Gemini request formats:
+ *
+ * ```
+ * POST /v1/chat/completions                    OpenAI
+ * POST /v1/messages                            Anthropic
+ * POST /v1beta/models/{model}:generateContent  Gemini
+ * ```
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme.
+ *
+ * These endpoints do not accept an API key, and the forwarding endpoints do not accept a scoped token.
+ *
+ * ## Conventions
+ *
+ * - **The plaintext of an API key is returned once.** The `secret` appears in the response that issues it and is returned by no other endpoint. A key that has been lost has to be revoked and reissued.
+ * - **Disabling and revoking are distinct.** A disabled key may be enabled again at any time, while a revocation is irreversible and is intended for a key that has been exposed. Neither removes the record, and the usage the key accrued remains readable.
+ * - **A usage query must carry a time range**, spanning no more than 31 days. `from` and `to` carry a timezone offset, which the server does not infer.
+ * - **The request and response bodies do not appear in the ledger.** They are not recorded. Quote the `upstream_request_id` from the response when reporting a problem.
+ * - **Usage may be estimated.** The upstream provider does not report usage on every request. Where it does not, `usage_source` is `estimated` and the figures are derived from the character classes of the payload, to within roughly fifteen per cent.
+ * - **The service is enabled before use.** A project enables the model platform once, through `create-service`; the forwarding endpoints refuse its requests until the service is `active`. Requests are then billed under the service's subscription by the tokens they use, at the rates stated in each model's `pricing`.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+export const withdrawalCurrencyMin = 3;
+export const withdrawalCurrencyMax = 3;
+export const withdrawalAmountRegExp = new RegExp("^[0-9]{1,15}([.][0-9]{1,10})?$");
+export const withdrawalFeeAmountRegExp = new RegExp("^[0-9]{1,15}([.][0-9]{1,10})?$");
+export const withdrawalRefundAmountRegExp = new RegExp("^[0-9]{1,15}([.][0-9]{1,10})?$");
+export const withdrawalDeductedAmountRegExp = new RegExp("^[0-9]{1,15}([.][0-9]{1,10})?$");
+export const withdrawalSettledAmountRegExp = new RegExp("^[0-9]{1,15}([.][0-9]{1,10})?$");
+export const withdrawalChargedFeeAmountRegExp = new RegExp("^[0-9]{1,15}([.][0-9]{1,10})?$");
+export const Withdrawal = zod
+    .strictObject({
+    id: zod.uuid(),
+    billing_account_id: zod.int(),
+    currency: zod.string().min(withdrawalCurrencyMin).max(withdrawalCurrencyMax),
+    amount: zod.string().regex(withdrawalAmountRegExp),
+    fee_amount: zod.string().regex(withdrawalFeeAmountRegExp),
+    refund_amount: zod.string().regex(withdrawalRefundAmountRegExp),
+    deducted_amount: zod.string().regex(withdrawalDeductedAmountRegExp),
+    settled_amount: zod.string().regex(withdrawalSettledAmountRegExp),
+    charged_fee_amount: zod.string().regex(withdrawalChargedFeeAmountRegExp),
+    status: zod.enum([
+        "pending",
+        "processing",
+        "succeeded",
+        "partially_completed",
+        "failed",
+        "reversed",
+    ]),
+    created_at: zod.iso.datetime({ offset: true }),
+    completed_at: zod.iso.datetime({ offset: true }).optional(),
+    created_by: zod
+        .string()
+        .optional()
+        .describe("Identity that submitted this withdrawal. It can differ from the billing account owner."),
+})
+    .describe("An account withdrawal to the original payment methods of its unused top-ups. Accepted amounts are fixed. deducted_amount, settled_amount and charged_fee_amount report completed source items. Failed items release their principal and fee reservations; successful items are retained when another source fails.");