npm - @papierapi/sdk - Versions diffs - 0.1.0 - Mend

@papierapi/sdk 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (22) hide show

package/LICENSE +21 -0
package/README.md +450 -0
package/dist/chunk-JDUUPLUG.js +984 -0
package/dist/chunk-JDUUPLUG.js.map +7 -0
package/dist/client.d.ts +469 -0
package/dist/errors.d.ts +20 -0
package/dist/index.d.ts +3 -0
package/dist/index.js +343 -0
package/dist/index.js.map +7 -0
package/dist/internal/contracts/common.d.ts +108 -0
package/dist/internal/contracts/dispatch.d.ts +979 -0
package/dist/internal/contracts/fax.d.ts +49 -0
package/dist/internal/contracts/index.d.ts +7 -0
package/dist/internal/contracts/letter.d.ts +292 -0
package/dist/internal/contracts/mcp.d.ts +395 -0
package/dist/internal/contracts/platform.d.ts +424 -0
package/dist/internal/contracts/rest.d.ts +1656 -0
package/dist/operations.d.ts +1563 -0
package/dist/operations.js +7 -0
package/dist/operations.js.map +7 -0
package/examples/get-dispatch.ts +13 -0
package/package.json +68 -0

package/dist/internal/contracts/mcp.d.ts ADDED Viewed

@@ -0,0 +1,395 @@
+import { z } from "zod";
+import { ApprovalRequestSchema, DispatchSchema, DraftSchema, ProofBundleSchema, QuoteSchema } from "./dispatch.js";
+export declare const McpEmptyInputSchema: z.ZodObject<{}, z.core.$strict>;
+export declare const McpDraftReferenceSchema: z.ZodObject<{
+    draft_id: z.ZodString;
+}, z.core.$strict>;
+export declare const McpDispatchReferenceSchema: z.ZodObject<{
+    dispatch_id: z.ZodString;
+}, z.core.$strict>;
+export declare const McpRequestDispatchApprovalSchema: z.ZodObject<{
+    quote_id: z.ZodString;
+    expires_in_seconds: z.ZodDefault<z.ZodInt>;
+    draft_id: z.ZodString;
+}, z.core.$strict>;
+export declare const McpListDispatchesInputSchema: z.ZodObject<{
+    limit: z.ZodDefault<z.ZodNumber>;
+}, z.core.$strict>;
+export declare const WalletBalanceSchema: z.ZodObject<{
+    available_cents: z.ZodInt;
+    reserved_cents: z.ZodInt;
+    total_cents: z.ZodInt;
+    currency: z.ZodLiteral<"EUR">;
+}, z.core.$strict>;
+export declare const SenderProfileSummarySchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    status: z.ZodLiteral<"verified">;
+    usage: z.ZodEnum<{
+        saved: "saved";
+        one_off: "one_off";
+    }>;
+    is_default: z.ZodBoolean;
+    supersedes_sender_profile_id: z.ZodNullable<z.ZodString>;
+    verified_at: z.ZodISODateTime;
+    archived_at: z.ZodNullable<z.ZodISODateTime>;
+    created_at: z.ZodISODateTime;
+    updated_at: z.ZodISODateTime;
+    verification: z.ZodObject<{
+        verified_at: z.ZodNullable<z.ZodISODateTime>;
+        expires_at: z.ZodNullable<z.ZodISODateTime>;
+        state: z.ZodLiteral<"verified">;
+    }, z.core.$strict>;
+    is_selectable: z.ZodLiteral<true>;
+}, z.core.$strict>;
+export declare const McpSenderProfilesResultSchema: z.ZodObject<{
+    sender_profiles: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        status: z.ZodLiteral<"verified">;
+        usage: z.ZodEnum<{
+            saved: "saved";
+            one_off: "one_off";
+        }>;
+        is_default: z.ZodBoolean;
+        supersedes_sender_profile_id: z.ZodNullable<z.ZodString>;
+        verified_at: z.ZodISODateTime;
+        archived_at: z.ZodNullable<z.ZodISODateTime>;
+        created_at: z.ZodISODateTime;
+        updated_at: z.ZodISODateTime;
+        verification: z.ZodObject<{
+            verified_at: z.ZodNullable<z.ZodISODateTime>;
+            expires_at: z.ZodNullable<z.ZodISODateTime>;
+            state: z.ZodLiteral<"verified">;
+        }, z.core.$strict>;
+        is_selectable: z.ZodLiteral<true>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export declare const McpDispatchDetailsSchema: z.ZodObject<{
+    dispatch: z.ZodObject<{
+        id: z.ZodString;
+        draft_id: z.ZodString;
+        status: z.ZodEnum<{
+            failed: "failed";
+            cancelled: "cancelled";
+            funds_reserved: "funds_reserved";
+            submitting: "submitting";
+            provider_accepted: "provider_accepted";
+            producing: "producing";
+            sending: "sending";
+            handed_to_carrier: "handed_to_carrier";
+            delivered: "delivered";
+            returned: "returned";
+            cancellation_pending: "cancellation_pending";
+        }>;
+        channel: z.ZodEnum<{
+            letter: "letter";
+            fax: "fax";
+        }>;
+        amount_cents: z.ZodInt;
+        currency: z.ZodLiteral<"EUR">;
+        scheduled_for: z.ZodNullable<z.ZodISODateTime>;
+        needs_review: z.ZodBoolean;
+        terminal_reason: z.ZodNullable<z.ZodString>;
+        created_at: z.ZodISODateTime;
+        updated_at: z.ZodISODateTime;
+    }, z.core.$strict>;
+    events: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        dispatch_id: z.ZodString;
+        sequence: z.ZodInt;
+        type: z.ZodString;
+        status: z.ZodEnum<{
+            failed: "failed";
+            cancelled: "cancelled";
+            funds_reserved: "funds_reserved";
+            submitting: "submitting";
+            provider_accepted: "provider_accepted";
+            producing: "producing";
+            sending: "sending";
+            handed_to_carrier: "handed_to_carrier";
+            delivered: "delivered";
+            returned: "returned";
+            cancellation_pending: "cancellation_pending";
+        }>;
+        created_at: z.ZodISODateTime;
+        evidence: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        event_hash: z.ZodString;
+        previous_hash: z.ZodNullable<z.ZodString>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export declare const McpDispatchListSchema: z.ZodObject<{
+    dispatches: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        draft_id: z.ZodString;
+        status: z.ZodEnum<{
+            failed: "failed";
+            cancelled: "cancelled";
+            funds_reserved: "funds_reserved";
+            submitting: "submitting";
+            provider_accepted: "provider_accepted";
+            producing: "producing";
+            sending: "sending";
+            handed_to_carrier: "handed_to_carrier";
+            delivered: "delivered";
+            returned: "returned";
+            cancellation_pending: "cancellation_pending";
+        }>;
+        channel: z.ZodEnum<{
+            letter: "letter";
+            fax: "fax";
+        }>;
+        amount_cents: z.ZodInt;
+        currency: z.ZodLiteral<"EUR">;
+        scheduled_for: z.ZodNullable<z.ZodISODateTime>;
+        needs_review: z.ZodBoolean;
+        terminal_reason: z.ZodNullable<z.ZodString>;
+        created_at: z.ZodISODateTime;
+        updated_at: z.ZodISODateTime;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export declare const McpPrepareLetterForReviewSchema: z.ZodObject<{
+    sender_profile_id: z.ZodString;
+    recipient: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        type: z.ZodDefault<z.ZodLiteral<"street">>;
+        company: z.ZodOptional<z.ZodString>;
+        name: z.ZodString;
+        attention: z.ZodOptional<z.ZodString>;
+        additional_line: z.ZodOptional<z.ZodString>;
+        street: z.ZodString;
+        house_number: z.ZodString;
+        postal_code: z.ZodString;
+        city: z.ZodString;
+        country: z.ZodLiteral<"DE">;
+    }, z.core.$strict>, z.ZodObject<{
+        type: z.ZodLiteral<"post_box">;
+        company: z.ZodOptional<z.ZodString>;
+        name: z.ZodString;
+        attention: z.ZodOptional<z.ZodString>;
+        post_box: z.ZodString;
+        postal_code: z.ZodString;
+        city: z.ZodString;
+        country: z.ZodLiteral<"DE">;
+    }, z.core.$strict>], "type">;
+    source: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        mode: z.ZodLiteral<"structured">;
+        content: z.ZodObject<{
+            locale: z.ZodDefault<z.ZodEnum<{
+                "de-DE": "de-DE";
+                "en-DE": "en-DE";
+            }>>;
+            date: z.ZodISODate;
+            reference_lines: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                label: z.ZodString;
+                value: z.ZodString;
+            }, z.core.$strict>>>;
+            subject: z.ZodString;
+            salutation: z.ZodOptional<z.ZodString>;
+            blocks: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+                type: z.ZodLiteral<"paragraph">;
+                text: z.ZodString;
+                style: z.ZodDefault<z.ZodEnum<{
+                    normal: "normal";
+                    emphasis: "emphasis";
+                }>>;
+            }, z.core.$strict>, z.ZodObject<{
+                type: z.ZodLiteral<"heading">;
+                text: z.ZodString;
+                level: z.ZodUnion<readonly [z.ZodLiteral<1>, z.ZodLiteral<2>]>;
+            }, z.core.$strict>, z.ZodObject<{
+                type: z.ZodLiteral<"list">;
+                ordered: z.ZodDefault<z.ZodBoolean>;
+                items: z.ZodArray<z.ZodString>;
+            }, z.core.$strict>, z.ZodObject<{
+                type: z.ZodLiteral<"table">;
+                columns: z.ZodArray<z.ZodString>;
+                rows: z.ZodArray<z.ZodArray<z.ZodString>>;
+            }, z.core.$strict>, z.ZodObject<{
+                type: z.ZodLiteral<"spacer">;
+                millimeters: z.ZodNumber;
+            }, z.core.$strict>, z.ZodObject<{
+                type: z.ZodLiteral<"closing">;
+                text: z.ZodString;
+            }, z.core.$strict>, z.ZodObject<{
+                type: z.ZodLiteral<"signature_placeholder">;
+                height_mm: z.ZodNumber;
+            }, z.core.$strict>], "type">>;
+            closing: z.ZodOptional<z.ZodString>;
+            signatory: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>;
+    }, z.core.$strict>, z.ZodObject<{
+        mode: z.ZodLiteral<"raw_pdf">;
+        document_id: z.ZodString;
+    }, z.core.$strict>], "mode">;
+    attachments: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        document_id: z.ZodString;
+    }, z.core.$strict>>>;
+    options: z.ZodObject<{
+        print: z.ZodEnum<{
+            grayscale: "grayscale";
+            color: "color";
+        }>;
+        duplex: z.ZodBoolean;
+        service: z.ZodEnum<{
+            standard: "standard";
+            registered_insertion: "registered_insertion";
+            registered_signature: "registered_signature";
+        }>;
+        criticality: z.ZodDefault<z.ZodEnum<{
+            normal: "normal";
+            high: "high";
+        }>>;
+        layout_profile: z.ZodDefault<z.ZodEnum<{
+            de_business_window_a: "de_business_window_a";
+            de_business_window_b: "de_business_window_b";
+            de_business_no_window: "de_business_no_window";
+        }>>;
+    }, z.core.$strict>;
+    metadata: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
+    approval_expires_in_seconds: z.ZodDefault<z.ZodInt>;
+}, z.core.$strict>;
+export declare const McpPrepareFaxForReviewSchema: z.ZodObject<{
+    sender_profile_id: z.ZodString;
+    recipient: z.ZodObject<{
+        fax_number_e164: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+        company: z.ZodOptional<z.ZodString>;
+        recipient_reference: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+    document_id: z.ZodString;
+    cover: z.ZodDefault<z.ZodObject<{
+        enabled: z.ZodBoolean;
+        subject: z.ZodOptional<z.ZodString>;
+        note: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+    options: z.ZodObject<{
+        max_attempts: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<1>, z.ZodLiteral<2>, z.ZodLiteral<3>]>>;
+        scheduled_at: z.ZodOptional<z.ZodISODateTime>;
+        purpose: z.ZodEnum<{
+            transactional: "transactional";
+            contractual: "contractual";
+            support: "support";
+            other: "other";
+        }>;
+        consent_reference: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+    metadata: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
+    approval_expires_in_seconds: z.ZodDefault<z.ZodInt>;
+}, z.core.$strict>;
+export declare const McpCoreToolNameSchema: z.ZodEnum<{
+    list_sender_profiles: "list_sender_profiles";
+    prepare_letter_for_review: "prepare_letter_for_review";
+    prepare_fax_for_review: "prepare_fax_for_review";
+    get_dispatch: "get_dispatch";
+    get_dispatch_proof: "get_dispatch_proof";
+}>;
+export declare const McpReviewPackageSchema: z.ZodObject<{
+    draft: z.ZodObject<{
+        id: z.ZodString;
+        channel: z.ZodEnum<{
+            letter: "letter";
+            fax: "fax";
+        }>;
+        status: z.ZodEnum<{
+            draft: "draft";
+            validated: "validated";
+            quoted: "quoted";
+            awaiting_approval: "awaiting_approval";
+            approved: "approved";
+            cancelled: "cancelled";
+        }>;
+        content_sha256: z.ZodString;
+        page_count: z.ZodInt;
+        recipient_display: z.ZodString;
+        verification: z.ZodObject<{
+            status: z.ZodEnum<{
+                passed: "passed";
+                warning: "warning";
+                failed: "failed";
+            }>;
+            checks: z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                version: z.ZodString;
+                status: z.ZodEnum<{
+                    passed: "passed";
+                    warning: "warning";
+                    failed: "failed";
+                    skipped: "skipped";
+                }>;
+                rule: z.ZodString;
+                evidence: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+                violations: z.ZodArray<z.ZodObject<{
+                    code: z.ZodString;
+                    field_path: z.ZodOptional<z.ZodString>;
+                    page: z.ZodOptional<z.ZodInt>;
+                    rule: z.ZodString;
+                    message: z.ZodString;
+                    suggested_action: z.ZodString;
+                }, z.core.$strict>>;
+                duration_ms: z.ZodInt;
+            }, z.core.$strict>>;
+            verifier_version: z.ZodString;
+        }, z.core.$strict>;
+        preview_url: z.ZodURL;
+        preview_expires_at: z.ZodISODateTime;
+        created_at: z.ZodISODateTime;
+        updated_at: z.ZodISODateTime;
+    }, z.core.$strict>;
+    quote: z.ZodObject<{
+        id: z.ZodString;
+        draft_id: z.ZodString;
+        subtotal_cents: z.ZodInt;
+        vat_cents: z.ZodInt;
+        total_cents: z.ZodInt;
+        currency: z.ZodLiteral<"EUR">;
+        valid_until: z.ZodISODateTime;
+        assumptions: z.ZodObject<{
+            channel: z.ZodEnum<{
+                letter: "letter";
+                fax: "fax";
+            }>;
+            country: z.ZodLiteral<"DE">;
+            pages: z.ZodInt;
+            service: z.ZodString;
+        }, z.core.$strict>;
+    }, z.core.$strict>;
+    approval: z.ZodObject<{
+        id: z.ZodString;
+        draft_id: z.ZodString;
+        quote_id: z.ZodString;
+        status: z.ZodEnum<{
+            pending: "pending";
+            rejected: "rejected";
+            expired: "expired";
+            approved: "approved";
+            stale: "stale";
+        }>;
+        approval_url: z.ZodURL;
+        expires_at: z.ZodISODateTime;
+        created_at: z.ZodISODateTime;
+    }, z.core.$strict>;
+    human_action_required: z.ZodLiteral<true>;
+    next_action: z.ZodObject<{
+        type: z.ZodLiteral<"open_approval_url">;
+        url: z.ZodURL;
+        description: z.ZodString;
+    }, z.core.$strict>;
+}, z.core.$strict>;
+export declare const McpWorkflowGuideSchema: z.ZodObject<{
+    version: z.ZodLiteral<"1.0">;
+    core_tools: z.ZodArray<z.ZodEnum<{
+        list_sender_profiles: "list_sender_profiles";
+        prepare_letter_for_review: "prepare_letter_for_review";
+        prepare_fax_for_review: "prepare_fax_for_review";
+        get_dispatch: "get_dispatch";
+        get_dispatch_proof: "get_dispatch_proof";
+    }>>;
+    recommended_letter_tool: z.ZodLiteral<"prepare_letter_for_review">;
+    recommended_fax_tool: z.ZodOptional<z.ZodLiteral<"prepare_fax_for_review">>;
+    recommended_tracking_tool: z.ZodLiteral<"get_dispatch">;
+    recommended_proof_tool: z.ZodLiteral<"get_dispatch_proof">;
+    workflow: z.ZodArray<z.ZodString>;
+    safety_invariants: z.ZodArray<z.ZodString>;
+    browser_fallback_url: z.ZodURL;
+}, z.core.$strict>;
+export { ApprovalRequestSchema as McpApprovalRequestResultSchema, DispatchSchema as McpDispatchResultSchema, DraftSchema as McpDraftResultSchema, ProofBundleSchema as McpProofResultSchema, QuoteSchema as McpQuoteResultSchema, };