@peable.to/contracts 0.4.0 → 1.0.0

package/dist/types/resources/billingEngine/customerBalanceTransactions.d.ts

@@ -0,0 +1,282 @@
+import { z } from 'zod';
+import { type Expand } from '../../common/objects';
+/**
+ * The customer balance ledger (`cbtxn_…`, ADR 0018 §3): every movement of a
+ * customer's balance. Negative is credit the customer holds (Stripe's
+ * convention), applied to their next invoice when it finalizes.
+ */
+export declare const customerBalanceTransactionSchema: z.ZodObject<{
+    id: z.ZodString;
+    object: z.ZodLiteral<"customer_balance_transaction">;
+    livemode: z.ZodBoolean;
+    customer: z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>;
+    type: z.ZodEnum<{
+        credit_note: "credit_note";
+        adjustment: "adjustment";
+        applied_to_invoice: "applied_to_invoice";
+        invoice_overpaid: "invoice_overpaid";
+        unapplied_from_invoice: "unapplied_from_invoice";
+    }>;
+    amount: z.ZodString;
+    currency: z.ZodEnum<{
+        FAIR: "FAIR";
+        EUR: "EUR";
+        USD: "USD";
+        GBP: "GBP";
+        CHF: "CHF";
+        SEK: "SEK";
+        NOK: "NOK";
+        DKK: "DKK";
+        PLN: "PLN";
+        CZK: "CZK";
+        CAD: "CAD";
+        AUD: "AUD";
+        JPY: "JPY";
+    }>;
+    ending_balance: z.ZodString;
+    description: z.ZodNullable<z.ZodString>;
+    invoice: z.ZodNullable<z.ZodType<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">, z.core.$ZodTypeInternals<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">>>>;
+    credit_note: z.ZodNullable<z.ZodString>;
+    metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+    created: z.ZodNumber;
+}, z.core.$strict>;
+export type CustomerBalanceTransaction = Expand<z.output<typeof customerBalanceTransactionSchema>>;
+declare module '../../common/objects' {
+    interface ObjectMap {
+        customer_balance_transaction: CustomerBalanceTransaction;
+    }
+}
+/** An adjustment: a negative `amount` credits the customer, a positive one adds to what they owe. */
+export declare const createCustomerBalanceTransactionParams: z.ZodObject<{
+    amount: z.ZodString;
+    currency: z.ZodEnum<{
+        FAIR: "FAIR";
+        EUR: "EUR";
+        USD: "USD";
+        GBP: "GBP";
+        CHF: "CHF";
+        SEK: "SEK";
+        NOK: "NOK";
+        DKK: "DKK";
+        PLN: "PLN";
+        CZK: "CZK";
+        CAD: "CAD";
+        AUD: "AUD";
+        JPY: "JPY";
+    }>;
+    description: z.ZodOptional<z.ZodString>;
+    metadata: z.ZodOptional<z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodString>, z.ZodTransform<Record<string, string>, Record<string, string>>>>;
+    expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+}, z.core.$strict>;
+export type CreateCustomerBalanceTransactionParams = z.input<typeof createCustomerBalanceTransactionParams>;
+export declare const listCustomerBalanceTransactionsQuery: z.ZodObject<{
+    limit: z.ZodPipe<z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>, z.ZodTransform<number, number | undefined>>;
+    starting_after: z.ZodOptional<z.ZodString>;
+    ending_before: z.ZodOptional<z.ZodString>;
+    created: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>, z.ZodTransform<import("../..").RangeFilter, number>>, z.ZodPipe<z.ZodObject<{
+        gt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        gte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        lt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        lte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+    }, z.core.$strict>, z.ZodTransform<import("../..").RangeFilter, {
+        gt?: number | undefined;
+        gte?: number | undefined;
+        lt?: number | undefined;
+        lte?: number | undefined;
+    }>>]>>;
+    expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+}, z.core.$strict>;
+export type CustomerBalanceTransactionListParams = z.input<typeof listCustomerBalanceTransactionsQuery>;
+export declare const customerBalanceTransactionRoutes: readonly [{
+    readonly operationId: "createCustomerBalanceTransaction";
+    readonly method: "post";
+    readonly path: "/v1/customers/{id}/balance_transactions";
+    readonly tag: "Customer balance";
+    readonly summary: "Adjust a customer's balance";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly params: {
+        readonly id: "The customer (`cus_…`).";
+    };
+    readonly body: z.ZodObject<{
+        amount: z.ZodString;
+        currency: z.ZodEnum<{
+            FAIR: "FAIR";
+            EUR: "EUR";
+            USD: "USD";
+            GBP: "GBP";
+            CHF: "CHF";
+            SEK: "SEK";
+            NOK: "NOK";
+            DKK: "DKK";
+            PLN: "PLN";
+            CZK: "CZK";
+            CAD: "CAD";
+            AUD: "AUD";
+            JPY: "JPY";
+        }>;
+        description: z.ZodOptional<z.ZodString>;
+        metadata: z.ZodOptional<z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodString>, z.ZodTransform<Record<string, string>, Record<string, string>>>>;
+        expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"customer_balance_transaction">;
+        livemode: z.ZodBoolean;
+        customer: z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>;
+        type: z.ZodEnum<{
+            credit_note: "credit_note";
+            adjustment: "adjustment";
+            applied_to_invoice: "applied_to_invoice";
+            invoice_overpaid: "invoice_overpaid";
+            unapplied_from_invoice: "unapplied_from_invoice";
+        }>;
+        amount: z.ZodString;
+        currency: z.ZodEnum<{
+            FAIR: "FAIR";
+            EUR: "EUR";
+            USD: "USD";
+            GBP: "GBP";
+            CHF: "CHF";
+            SEK: "SEK";
+            NOK: "NOK";
+            DKK: "DKK";
+            PLN: "PLN";
+            CZK: "CZK";
+            CAD: "CAD";
+            AUD: "AUD";
+            JPY: "JPY";
+        }>;
+        ending_balance: z.ZodString;
+        description: z.ZodNullable<z.ZodString>;
+        invoice: z.ZodNullable<z.ZodType<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">, z.core.$ZodTypeInternals<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">>>>;
+        credit_note: z.ZodNullable<z.ZodString>;
+        metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "customerBalanceTransactions.create";
+    readonly expandable: "customer_balance_transaction";
+}, {
+    readonly operationId: "listCustomerBalanceTransactions";
+    readonly method: "get";
+    readonly path: "/v1/customers/{id}/balance_transactions";
+    readonly tag: "Customer balance";
+    readonly summary: "List a customer's balance transactions";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly params: {
+        readonly id: "The customer (`cus_…`).";
+    };
+    readonly query: z.ZodObject<{
+        limit: z.ZodPipe<z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>, z.ZodTransform<number, number | undefined>>;
+        starting_after: z.ZodOptional<z.ZodString>;
+        ending_before: z.ZodOptional<z.ZodString>;
+        created: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>, z.ZodTransform<import("../..").RangeFilter, number>>, z.ZodPipe<z.ZodObject<{
+            gt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+            gte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+            lt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+            lte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        }, z.core.$strict>, z.ZodTransform<import("../..").RangeFilter, {
+            gt?: number | undefined;
+            gte?: number | undefined;
+            lt?: number | undefined;
+            lte?: number | undefined;
+        }>>]>>;
+        expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        object: z.ZodLiteral<"list">;
+        data: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            object: z.ZodLiteral<"customer_balance_transaction">;
+            livemode: z.ZodBoolean;
+            customer: z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>;
+            type: z.ZodEnum<{
+                credit_note: "credit_note";
+                adjustment: "adjustment";
+                applied_to_invoice: "applied_to_invoice";
+                invoice_overpaid: "invoice_overpaid";
+                unapplied_from_invoice: "unapplied_from_invoice";
+            }>;
+            amount: z.ZodString;
+            currency: z.ZodEnum<{
+                FAIR: "FAIR";
+                EUR: "EUR";
+                USD: "USD";
+                GBP: "GBP";
+                CHF: "CHF";
+                SEK: "SEK";
+                NOK: "NOK";
+                DKK: "DKK";
+                PLN: "PLN";
+                CZK: "CZK";
+                CAD: "CAD";
+                AUD: "AUD";
+                JPY: "JPY";
+            }>;
+            ending_balance: z.ZodString;
+            description: z.ZodNullable<z.ZodString>;
+            invoice: z.ZodNullable<z.ZodType<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">, z.core.$ZodTypeInternals<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">>>>;
+            credit_note: z.ZodNullable<z.ZodString>;
+            metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+            created: z.ZodNumber;
+        }, z.core.$strict>>;
+        has_more: z.ZodBoolean;
+        url: z.ZodString;
+    }, z.core.$strict>;
+    readonly sdk: "customerBalanceTransactions.list";
+    readonly expandable: "customer_balance_transaction";
+}, {
+    readonly operationId: "retrieveCustomerBalanceTransaction";
+    readonly method: "get";
+    readonly path: "/v1/customers/{id}/balance_transactions/{transaction}";
+    readonly tag: "Customer balance";
+    readonly summary: "Retrieve a customer balance transaction";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly params: {
+        readonly id: "The customer (`cus_…`).";
+        readonly transaction: "The balance transaction (`cbtxn_…`).";
+    };
+    readonly query: z.ZodObject<{
+        expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"customer_balance_transaction">;
+        livemode: z.ZodBoolean;
+        customer: z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>;
+        type: z.ZodEnum<{
+            credit_note: "credit_note";
+            adjustment: "adjustment";
+            applied_to_invoice: "applied_to_invoice";
+            invoice_overpaid: "invoice_overpaid";
+            unapplied_from_invoice: "unapplied_from_invoice";
+        }>;
+        amount: z.ZodString;
+        currency: z.ZodEnum<{
+            FAIR: "FAIR";
+            EUR: "EUR";
+            USD: "USD";
+            GBP: "GBP";
+            CHF: "CHF";
+            SEK: "SEK";
+            NOK: "NOK";
+            DKK: "DKK";
+            PLN: "PLN";
+            CZK: "CZK";
+            CAD: "CAD";
+            AUD: "AUD";
+            JPY: "JPY";
+        }>;
+        ending_balance: z.ZodString;
+        description: z.ZodNullable<z.ZodString>;
+        invoice: z.ZodNullable<z.ZodType<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">, z.core.$ZodTypeInternals<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">>>>;
+        credit_note: z.ZodNullable<z.ZodString>;
+        metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "customerBalanceTransactions.retrieve";
+    readonly expandable: "customer_balance_transaction";
+}];