@peable.to/contracts 0.4.0 → 1.0.0

package/dist/types/resources/tax/deadlines.d.ts

@@ -0,0 +1,133 @@
+import { z } from 'zod';
+import { type Expand } from '../../common/objects';
+/**
+ * A due date the rule set can compute. `filing_status` is `not_tracked`:
+ * Peable files nothing, so it never claims a return was or was not filed.
+ */
+export declare const taxDeadlineSchema: z.ZodObject<{
+    object: z.ZodLiteral<"tax.deadline">;
+    kind: z.ZodEnum<{
+        return: "return";
+        payment: "payment";
+        registration: "registration";
+    }>;
+    rule: z.ZodString;
+    country: z.ZodNullable<z.ZodString>;
+    state: z.ZodNullable<z.ZodString>;
+    period_start: z.ZodNullable<z.ZodNumber>;
+    period_end: z.ZodNullable<z.ZodNumber>;
+    due: z.ZodNumber;
+    status: z.ZodEnum<{
+        upcoming: "upcoming";
+        due_soon: "due_soon";
+        passed: "passed";
+    }>;
+    filing_status: z.ZodLiteral<"not_tracked">;
+    description: z.ZodString;
+    source: z.ZodObject<{
+        title: z.ZodString;
+        publisher: z.ZodString;
+        url: z.ZodString;
+    }, z.core.$strict>;
+}, z.core.$strict>;
+export type TaxDeadline = Expand<z.output<typeof taxDeadlineSchema>>;
+declare module '../../common/objects' {
+    interface ObjectMap {
+        'tax.deadline': TaxDeadline;
+    }
+}
+/** Where a deadline exists but the rule set cannot compute it, and why. */
+export declare const taxDeadlineUnavailableSchema: z.ZodObject<{
+    rule: z.ZodNullable<z.ZodString>;
+    country: z.ZodNullable<z.ZodString>;
+    state: z.ZodNullable<z.ZodString>;
+    reason: z.ZodString;
+}, z.core.$strict>;
+export type TaxDeadlineUnavailable = z.output<typeof taxDeadlineUnavailableSchema>;
+/** A complete list (`has_more` is `false`), with what could not be computed beside it. */
+export declare const taxDeadlineListSchema: z.ZodObject<{
+    object: z.ZodLiteral<"list">;
+    data: z.ZodArray<z.ZodObject<{
+        object: z.ZodLiteral<"tax.deadline">;
+        kind: z.ZodEnum<{
+            return: "return";
+            payment: "payment";
+            registration: "registration";
+        }>;
+        rule: z.ZodString;
+        country: z.ZodNullable<z.ZodString>;
+        state: z.ZodNullable<z.ZodString>;
+        period_start: z.ZodNullable<z.ZodNumber>;
+        period_end: z.ZodNullable<z.ZodNumber>;
+        due: z.ZodNumber;
+        status: z.ZodEnum<{
+            upcoming: "upcoming";
+            due_soon: "due_soon";
+            passed: "passed";
+        }>;
+        filing_status: z.ZodLiteral<"not_tracked">;
+        description: z.ZodString;
+        source: z.ZodObject<{
+            title: z.ZodString;
+            publisher: z.ZodString;
+            url: z.ZodString;
+        }, z.core.$strict>;
+    }, z.core.$strict>>;
+    has_more: z.ZodBoolean;
+    url: z.ZodString;
+    unavailable: z.ZodArray<z.ZodObject<{
+        rule: z.ZodNullable<z.ZodString>;
+        country: z.ZodNullable<z.ZodString>;
+        state: z.ZodNullable<z.ZodString>;
+        reason: z.ZodString;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type TaxDeadlineList = Expand<z.output<typeof taxDeadlineListSchema>>;
+export declare const taxDeadlineRoutes: readonly [{
+    readonly operationId: "listTaxDeadlines";
+    readonly method: "get";
+    readonly path: "/v1/tax/deadlines";
+    readonly tag: "Tax compliance";
+    readonly summary: "List tax deadlines";
+    readonly description: "Due dates the rule set computes from declared registrations and the latest assessment, soonest first.";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly response: z.ZodObject<{
+        object: z.ZodLiteral<"list">;
+        data: z.ZodArray<z.ZodObject<{
+            object: z.ZodLiteral<"tax.deadline">;
+            kind: z.ZodEnum<{
+                return: "return";
+                payment: "payment";
+                registration: "registration";
+            }>;
+            rule: z.ZodString;
+            country: z.ZodNullable<z.ZodString>;
+            state: z.ZodNullable<z.ZodString>;
+            period_start: z.ZodNullable<z.ZodNumber>;
+            period_end: z.ZodNullable<z.ZodNumber>;
+            due: z.ZodNumber;
+            status: z.ZodEnum<{
+                upcoming: "upcoming";
+                due_soon: "due_soon";
+                passed: "passed";
+            }>;
+            filing_status: z.ZodLiteral<"not_tracked">;
+            description: z.ZodString;
+            source: z.ZodObject<{
+                title: z.ZodString;
+                publisher: z.ZodString;
+                url: z.ZodString;
+            }, z.core.$strict>;
+        }, z.core.$strict>>;
+        has_more: z.ZodBoolean;
+        url: z.ZodString;
+        unavailable: z.ZodArray<z.ZodObject<{
+            rule: z.ZodNullable<z.ZodString>;
+            country: z.ZodNullable<z.ZodString>;
+            state: z.ZodNullable<z.ZodString>;
+            reason: z.ZodString;
+        }, z.core.$strict>>;
+    }, z.core.$strict>;
+    readonly sdk: "tax.compliance.listDeadlines";
+}];

package/dist/types/resources/tax/documents.d.ts

@@ -0,0 +1,257 @@
+import { z } from 'zod';
+import { type Expand } from '../../common/objects';
+/**
+ * A supporting document (`taxdoc_…`): a `file_…` of purpose `tax_document`
+ * (private, never addressable by URL) with what it is for. Attaching a
+ * document proves nothing by itself; it is what a reviewer reads.
+ */
+export declare const taxDocumentSchema: z.ZodObject<{
+    object: z.ZodLiteral<"tax.document">;
+    id: z.ZodString;
+    livemode: z.ZodBoolean;
+    file: z.ZodString;
+    file_status: z.ZodEnum<{
+        available: "available";
+        withheld: "withheld";
+        removed: "removed";
+    }>;
+    filename: z.ZodNullable<z.ZodString>;
+    kind: z.ZodEnum<{
+        other: "other";
+        registration_certificate: "registration_certificate";
+        authority_correspondence: "authority_correspondence";
+        incorporation_record: "incorporation_record";
+        filing_confirmation: "filing_confirmation";
+        payment_receipt: "payment_receipt";
+    }>;
+    country: z.ZodNullable<z.ZodString>;
+    state: z.ZodNullable<z.ZodString>;
+    registration_declaration: z.ZodNullable<z.ZodString>;
+    description: z.ZodNullable<z.ZodString>;
+    metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+    created: z.ZodNumber;
+}, z.core.$strict>;
+export type TaxDocument = Expand<z.output<typeof taxDocumentSchema>>;
+export declare const taxDocumentChecklistItemSchema: z.ZodObject<{
+    key: z.ZodString;
+    kind: z.ZodEnum<{
+        other: "other";
+        registration_certificate: "registration_certificate";
+        authority_correspondence: "authority_correspondence";
+        incorporation_record: "incorporation_record";
+        filing_confirmation: "filing_confirmation";
+        payment_receipt: "payment_receipt";
+    }>;
+    country: z.ZodNullable<z.ZodString>;
+    state: z.ZodNullable<z.ZodString>;
+    status: z.ZodEnum<{
+        provided: "provided";
+        missing: "missing";
+        unavailable: "unavailable";
+    }>;
+    documents: z.ZodArray<z.ZodString>;
+    reason: z.ZodString;
+}, z.core.$strict>;
+export type TaxDocumentChecklistItem = z.output<typeof taxDocumentChecklistItemSchema>;
+/** The documents the recorded facts call for, and which are attached. */
+export declare const taxDocumentChecklistSchema: z.ZodObject<{
+    object: z.ZodLiteral<"tax.document_checklist">;
+    livemode: z.ZodBoolean;
+    items: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        kind: z.ZodEnum<{
+            other: "other";
+            registration_certificate: "registration_certificate";
+            authority_correspondence: "authority_correspondence";
+            incorporation_record: "incorporation_record";
+            filing_confirmation: "filing_confirmation";
+            payment_receipt: "payment_receipt";
+        }>;
+        country: z.ZodNullable<z.ZodString>;
+        state: z.ZodNullable<z.ZodString>;
+        status: z.ZodEnum<{
+            provided: "provided";
+            missing: "missing";
+            unavailable: "unavailable";
+        }>;
+        documents: z.ZodArray<z.ZodString>;
+        reason: z.ZodString;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type TaxDocumentChecklist = Expand<z.output<typeof taxDocumentChecklistSchema>>;
+declare module '../../common/objects' {
+    interface ObjectMap {
+        'tax.document': TaxDocument;
+        'tax.document_checklist': TaxDocumentChecklist;
+    }
+}
+/** Orbit's attachment of a document (the owner's). Attaching the same file again answers the same document. */
+export declare const createTaxDocumentParams: z.ZodObject<{
+    file: z.ZodString;
+    kind: z.ZodEnum<{
+        other: "other";
+        registration_certificate: "registration_certificate";
+        authority_correspondence: "authority_correspondence";
+        incorporation_record: "incorporation_record";
+        filing_confirmation: "filing_confirmation";
+        payment_receipt: "payment_receipt";
+    }>;
+    country: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    state: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    registration_declaration: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    metadata: z.ZodOptional<z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodString>, z.ZodTransform<Record<string, string>, Record<string, string>>>>;
+}, z.core.$strict>;
+export type CreateTaxDocumentParams = z.input<typeof createTaxDocumentParams>;
+export declare const listTaxDocumentsQuery: 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 ListTaxDocumentsParams = z.input<typeof listTaxDocumentsQuery>;
+export declare const taxDocumentRoutes: readonly [{
+    readonly operationId: "listTaxDocuments";
+    readonly method: "get";
+    readonly path: "/v1/tax/documents";
+    readonly tag: "Tax compliance";
+    readonly summary: "List tax documents";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    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<{
+            object: z.ZodLiteral<"tax.document">;
+            id: z.ZodString;
+            livemode: z.ZodBoolean;
+            file: z.ZodString;
+            file_status: z.ZodEnum<{
+                available: "available";
+                withheld: "withheld";
+                removed: "removed";
+            }>;
+            filename: z.ZodNullable<z.ZodString>;
+            kind: z.ZodEnum<{
+                other: "other";
+                registration_certificate: "registration_certificate";
+                authority_correspondence: "authority_correspondence";
+                incorporation_record: "incorporation_record";
+                filing_confirmation: "filing_confirmation";
+                payment_receipt: "payment_receipt";
+            }>;
+            country: z.ZodNullable<z.ZodString>;
+            state: z.ZodNullable<z.ZodString>;
+            registration_declaration: z.ZodNullable<z.ZodString>;
+            description: 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: "tax.compliance.listDocuments";
+    readonly expandable: "tax.document";
+}, {
+    readonly operationId: "retrieveTaxDocument";
+    readonly method: "get";
+    readonly path: "/v1/tax/documents/{id}";
+    readonly tag: "Tax compliance";
+    readonly summary: "Retrieve a tax document";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly params: {
+        readonly id: "The document (`taxdoc_…`).";
+    };
+    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<{
+        object: z.ZodLiteral<"tax.document">;
+        id: z.ZodString;
+        livemode: z.ZodBoolean;
+        file: z.ZodString;
+        file_status: z.ZodEnum<{
+            available: "available";
+            withheld: "withheld";
+            removed: "removed";
+        }>;
+        filename: z.ZodNullable<z.ZodString>;
+        kind: z.ZodEnum<{
+            other: "other";
+            registration_certificate: "registration_certificate";
+            authority_correspondence: "authority_correspondence";
+            incorporation_record: "incorporation_record";
+            filing_confirmation: "filing_confirmation";
+            payment_receipt: "payment_receipt";
+        }>;
+        country: z.ZodNullable<z.ZodString>;
+        state: z.ZodNullable<z.ZodString>;
+        registration_declaration: z.ZodNullable<z.ZodString>;
+        description: z.ZodNullable<z.ZodString>;
+        metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "tax.compliance.retrieveDocument";
+    readonly expandable: "tax.document";
+}, {
+    readonly operationId: "retrieveTaxDocumentChecklist";
+    readonly method: "get";
+    readonly path: "/v1/tax/document_checklist";
+    readonly tag: "Tax compliance";
+    readonly summary: "Retrieve the document checklist";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly response: z.ZodObject<{
+        object: z.ZodLiteral<"tax.document_checklist">;
+        livemode: z.ZodBoolean;
+        items: z.ZodArray<z.ZodObject<{
+            key: z.ZodString;
+            kind: z.ZodEnum<{
+                other: "other";
+                registration_certificate: "registration_certificate";
+                authority_correspondence: "authority_correspondence";
+                incorporation_record: "incorporation_record";
+                filing_confirmation: "filing_confirmation";
+                payment_receipt: "payment_receipt";
+            }>;
+            country: z.ZodNullable<z.ZodString>;
+            state: z.ZodNullable<z.ZodString>;
+            status: z.ZodEnum<{
+                provided: "provided";
+                missing: "missing";
+                unavailable: "unavailable";
+            }>;
+            documents: z.ZodArray<z.ZodString>;
+            reason: z.ZodString;
+        }, z.core.$strict>>;
+    }, z.core.$strict>;
+    readonly sdk: "tax.compliance.retrieveDocumentChecklist";
+}];