@hartl-services/medusa-contracts 1.5.0 → 1.7.0

package/dist/order-assistant/schemas.d.ts

@@ -0,0 +1,391 @@
+import { z } from "@medusajs/framework/zod";
+/** Plugin key and container key of the order assistant in the base. */
+export declare const ORDER_ASSISTANT_PLUGIN_KEY = "order_assistant";
+/** Tool names as the MCP client sees them. */
+export declare const ORDER_ASSISTANT_TOOLS: {
+    readonly searchCustomers: "kunden_suchen";
+    readonly searchProducts: "produkte_suchen";
+    readonly listShippingOptions: "versandarten_auflisten";
+    readonly createDraftOrder: "bestellentwurf_anlegen";
+};
+export type OrderAssistantToolName = (typeof ORDER_ASSISTANT_TOOLS)[keyof typeof ORDER_ASSISTANT_TOOLS];
+/** How the order reached the shop; stored in the order metadata. */
+export declare const OrderAssistantSourceSchema: z.ZodEnum<{
+    fax: "fax";
+    telefon: "telefon";
+}>;
+/** Order metadata keys the assistant writes. */
+export declare const ORDER_ASSISTANT_METADATA: {
+    readonly source: "order_source";
+    readonly note: "order_note";
+};
+export declare const ORDER_ASSISTANT_LIMITS: {
+    readonly customers: 10;
+    readonly variants: 20;
+    readonly items: 50;
+    readonly noteLength: 2000;
+};
+export declare const OrderAssistantAddressSchema: z.ZodObject<{
+    first_name: z.ZodString;
+    last_name: z.ZodString;
+    company: z.ZodOptional<z.ZodString>;
+    address_1: z.ZodString;
+    address_2: z.ZodOptional<z.ZodString>;
+    postal_code: z.ZodString;
+    city: z.ZodString;
+    country_code: z.ZodString;
+    phone: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export declare const SearchCustomersInputSchema: z.ZodObject<{
+    query: z.ZodOptional<z.ZodString>;
+    postal_code: z.ZodOptional<z.ZodString>;
+    city: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export declare const OrderAssistantCustomerAddressSchema: z.ZodObject<{
+    first_name: z.ZodNullable<z.ZodString>;
+    last_name: z.ZodNullable<z.ZodString>;
+    company: z.ZodNullable<z.ZodString>;
+    address_1: z.ZodNullable<z.ZodString>;
+    address_2: z.ZodNullable<z.ZodString>;
+    postal_code: z.ZodNullable<z.ZodString>;
+    city: z.ZodNullable<z.ZodString>;
+    country_code: z.ZodNullable<z.ZodString>;
+    phone: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export declare const OrderAssistantCustomerSchema: z.ZodObject<{
+    id: z.ZodString;
+    first_name: z.ZodNullable<z.ZodString>;
+    last_name: z.ZodNullable<z.ZodString>;
+    company_name: z.ZodNullable<z.ZodString>;
+    email: z.ZodNullable<z.ZodString>;
+    phone: z.ZodNullable<z.ZodString>;
+    has_account: z.ZodBoolean;
+    addresses: z.ZodArray<z.ZodObject<{
+        first_name: z.ZodNullable<z.ZodString>;
+        last_name: z.ZodNullable<z.ZodString>;
+        company: z.ZodNullable<z.ZodString>;
+        address_1: z.ZodNullable<z.ZodString>;
+        address_2: z.ZodNullable<z.ZodString>;
+        postal_code: z.ZodNullable<z.ZodString>;
+        city: z.ZodNullable<z.ZodString>;
+        country_code: z.ZodNullable<z.ZodString>;
+        phone: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const SearchCustomersOutputSchema: z.ZodObject<{
+    customers: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        first_name: z.ZodNullable<z.ZodString>;
+        last_name: z.ZodNullable<z.ZodString>;
+        company_name: z.ZodNullable<z.ZodString>;
+        email: z.ZodNullable<z.ZodString>;
+        phone: z.ZodNullable<z.ZodString>;
+        has_account: z.ZodBoolean;
+        addresses: z.ZodArray<z.ZodObject<{
+            first_name: z.ZodNullable<z.ZodString>;
+            last_name: z.ZodNullable<z.ZodString>;
+            company: z.ZodNullable<z.ZodString>;
+            address_1: z.ZodNullable<z.ZodString>;
+            address_2: z.ZodNullable<z.ZodString>;
+            postal_code: z.ZodNullable<z.ZodString>;
+            city: z.ZodNullable<z.ZodString>;
+            country_code: z.ZodNullable<z.ZodString>;
+            phone: z.ZodNullable<z.ZodString>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const SearchProductsInputSchema: z.ZodObject<{
+    query: z.ZodString;
+    country_code: z.ZodString;
+}, z.core.$strict>;
+export declare const OrderAssistantVariantSchema: z.ZodObject<{
+    variant_id: z.ZodString;
+    product_title: z.ZodString;
+    variant_title: z.ZodNullable<z.ZodString>;
+    sku: z.ZodNullable<z.ZodString>;
+    unit_price: z.ZodNullable<z.ZodNumber>;
+    currency_code: z.ZodString;
+    available_quantity: z.ZodNullable<z.ZodNumber>;
+    orderable: z.ZodBoolean;
+}, z.core.$strip>;
+export declare const SearchProductsOutputSchema: z.ZodObject<{
+    variants: z.ZodArray<z.ZodObject<{
+        variant_id: z.ZodString;
+        product_title: z.ZodString;
+        variant_title: z.ZodNullable<z.ZodString>;
+        sku: z.ZodNullable<z.ZodString>;
+        unit_price: z.ZodNullable<z.ZodNumber>;
+        currency_code: z.ZodString;
+        available_quantity: z.ZodNullable<z.ZodNumber>;
+        orderable: z.ZodBoolean;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const ListShippingOptionsInputSchema: z.ZodObject<{
+    country_code: z.ZodString;
+}, z.core.$strict>;
+export declare const OrderAssistantShippingOptionSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    amount: z.ZodNullable<z.ZodNumber>;
+    currency_code: z.ZodString;
+}, z.core.$strip>;
+export declare const ListShippingOptionsOutputSchema: z.ZodObject<{
+    shipping_options: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        amount: z.ZodNullable<z.ZodNumber>;
+        currency_code: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const OrderAssistantNewCustomerSchema: z.ZodObject<{
+    first_name: z.ZodString;
+    last_name: z.ZodString;
+    company_name: z.ZodOptional<z.ZodString>;
+    email: z.ZodOptional<z.ZodString>;
+    phone: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export declare const CreateDraftOrderInputSchema: z.ZodObject<{
+    customer_id: z.ZodOptional<z.ZodString>;
+    new_customer: z.ZodOptional<z.ZodObject<{
+        first_name: z.ZodString;
+        last_name: z.ZodString;
+        company_name: z.ZodOptional<z.ZodString>;
+        email: z.ZodOptional<z.ZodString>;
+        phone: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+    shipping_address: z.ZodObject<{
+        first_name: z.ZodString;
+        last_name: z.ZodString;
+        company: z.ZodOptional<z.ZodString>;
+        address_1: z.ZodString;
+        address_2: z.ZodOptional<z.ZodString>;
+        postal_code: z.ZodString;
+        city: z.ZodString;
+        country_code: z.ZodString;
+        phone: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+    billing_address: z.ZodOptional<z.ZodObject<{
+        first_name: z.ZodString;
+        last_name: z.ZodString;
+        company: z.ZodOptional<z.ZodString>;
+        address_1: z.ZodString;
+        address_2: z.ZodOptional<z.ZodString>;
+        postal_code: z.ZodString;
+        city: z.ZodString;
+        country_code: z.ZodString;
+        phone: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+    items: z.ZodArray<z.ZodObject<{
+        variant_id: z.ZodString;
+        quantity: z.ZodNumber;
+    }, z.core.$strict>>;
+    shipping_option_id: z.ZodString;
+    source: z.ZodEnum<{
+        fax: "fax";
+        telefon: "telefon";
+    }>;
+    note: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export declare const OrderAssistantDraftItemSchema: z.ZodObject<{
+    title: z.ZodString;
+    sku: z.ZodNullable<z.ZodString>;
+    quantity: z.ZodNumber;
+    unit_price: z.ZodNumber;
+    total: z.ZodNumber;
+}, z.core.$strip>;
+export declare const CreateDraftOrderOutputSchema: z.ZodObject<{
+    draft_order_id: z.ZodString;
+    display_id: z.ZodNullable<z.ZodNumber>;
+    customer_id: z.ZodString;
+    customer_created: z.ZodBoolean;
+    currency_code: z.ZodString;
+    items: z.ZodArray<z.ZodObject<{
+        title: z.ZodString;
+        sku: z.ZodNullable<z.ZodString>;
+        quantity: z.ZodNumber;
+        unit_price: z.ZodNumber;
+        total: z.ZodNumber;
+    }, z.core.$strip>>;
+    shipping_total: z.ZodNumber;
+    tax_total: z.ZodNumber;
+    total: z.ZodNumber;
+    admin_path: z.ZodString;
+}, z.core.$strip>;
+/** Feature keys of the order assistant's plugin toggles. */
+export declare const ORDER_ASSISTANT_FEATURES: {
+    readonly oauth: "oauth";
+};
+export declare const ORDER_ASSISTANT_OAUTH: {
+    /** The one scope: use the assistant's tools as the signed-in Admin user. */
+    readonly scope: "order_assistant";
+    readonly accessTokenTtlSeconds: 3600;
+    /** A connection ends when its refresh token stays unused this long. */
+    readonly connectionIdleDays: 30;
+    /** How long the consent page may stay open. */
+    readonly authorizationRequestTtlSeconds: 600;
+    /** How long the client has to redeem the code after the consent. */
+    readonly authorizationCodeTtlSeconds: 120;
+    readonly maxRedirectUris: 10;
+    readonly maxUriLength: 2000;
+    readonly maxClientNameLength: 120;
+    readonly maxStateLength: 2000;
+};
+/** `http://localhost`, `http://127.0.0.1` or `http://[::1]`, any port. */
+export declare const isOAuthLoopbackRedirectUri: (value: string) => boolean;
+/**
+ * A redirect URI a client may register: https, or http on a loopback address
+ * (native clients such as Claude Code), without credentials or fragment.
+ */
+export declare const OAuthRedirectUriSchema: z.ZodString;
+/**
+ * Dynamic client registration request (RFC 7591). Unknown metadata is
+ * ignored; the requested authentication method, grant and response types are
+ * accepted as sent and answered with what the server actually supports.
+ */
+export declare const OAuthClientRegistrationRequestSchema: z.ZodObject<{
+    redirect_uris: z.ZodArray<z.ZodString>;
+    client_name: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export declare const OAuthClientRegistrationResponseSchema: z.ZodObject<{
+    client_id: z.ZodString;
+    client_id_issued_at: z.ZodNumber;
+    client_name: z.ZodOptional<z.ZodString>;
+    redirect_uris: z.ZodArray<z.ZodString>;
+    token_endpoint_auth_method: z.ZodLiteral<"none">;
+    grant_types: z.ZodArray<z.ZodString>;
+    response_types: z.ZodArray<z.ZodString>;
+    scope: z.ZodString;
+}, z.core.$strip>;
+/** Query of the authorization endpoint, before the client is looked up. */
+export declare const OAuthAuthorizeQuerySchema: z.ZodObject<{
+    client_id: z.ZodString;
+    redirect_uri: z.ZodString;
+    response_type: z.ZodOptional<z.ZodString>;
+    code_challenge: z.ZodOptional<z.ZodString>;
+    code_challenge_method: z.ZodOptional<z.ZodString>;
+    state: z.ZodOptional<z.ZodString>;
+    scope: z.ZodOptional<z.ZodString>;
+    resource: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/** Body of the token endpoint (`application/x-www-form-urlencoded`). */
+export declare const OAuthTokenRequestSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    grant_type: z.ZodLiteral<"authorization_code">;
+    code: z.ZodString;
+    code_verifier: z.ZodString;
+    client_id: z.ZodString;
+    redirect_uri: z.ZodOptional<z.ZodString>;
+    resource: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>, z.ZodObject<{
+    grant_type: z.ZodLiteral<"refresh_token">;
+    refresh_token: z.ZodString;
+    client_id: z.ZodString;
+    resource: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>], "grant_type">;
+export declare const OAuthTokenResponseSchema: z.ZodObject<{
+    access_token: z.ZodString;
+    token_type: z.ZodLiteral<"Bearer">;
+    expires_in: z.ZodNumber;
+    refresh_token: z.ZodString;
+    scope: z.ZodString;
+}, z.core.$strip>;
+export declare const OAuthErrorCodeSchema: z.ZodEnum<{
+    invalid_request: "invalid_request";
+    invalid_client: "invalid_client";
+    invalid_grant: "invalid_grant";
+    invalid_target: "invalid_target";
+    invalid_client_metadata: "invalid_client_metadata";
+    invalid_redirect_uri: "invalid_redirect_uri";
+    unsupported_grant_type: "unsupported_grant_type";
+    unsupported_response_type: "unsupported_response_type";
+    access_denied: "access_denied";
+    temporarily_unavailable: "temporarily_unavailable";
+}>;
+/** Error body of the registration and token endpoints (RFC 6749, RFC 7591). */
+export declare const OAuthErrorResponseSchema: z.ZodObject<{
+    error: z.ZodEnum<{
+        invalid_request: "invalid_request";
+        invalid_client: "invalid_client";
+        invalid_grant: "invalid_grant";
+        invalid_target: "invalid_target";
+        invalid_client_metadata: "invalid_client_metadata";
+        invalid_redirect_uri: "invalid_redirect_uri";
+        unsupported_grant_type: "unsupported_grant_type";
+        unsupported_response_type: "unsupported_response_type";
+        access_denied: "access_denied";
+        temporarily_unavailable: "temporarily_unavailable";
+    }>;
+    error_description: z.ZodString;
+}, z.core.$strip>;
+/** RFC 9728: where the MCP endpoint's authorization server is. */
+export declare const OAuthProtectedResourceMetadataSchema: z.ZodObject<{
+    resource: z.ZodString;
+    authorization_servers: z.ZodArray<z.ZodString>;
+    bearer_methods_supported: z.ZodArray<z.ZodString>;
+    scopes_supported: z.ZodArray<z.ZodString>;
+    resource_name: z.ZodString;
+}, z.core.$strip>;
+/** RFC 8414: the authorization server's endpoints and capabilities. */
+export declare const OAuthAuthorizationServerMetadataSchema: z.ZodObject<{
+    issuer: z.ZodString;
+    authorization_endpoint: z.ZodString;
+    token_endpoint: z.ZodString;
+    registration_endpoint: z.ZodString;
+    response_types_supported: z.ZodArray<z.ZodString>;
+    grant_types_supported: z.ZodArray<z.ZodString>;
+    code_challenge_methods_supported: z.ZodArray<z.ZodString>;
+    token_endpoint_auth_methods_supported: z.ZodArray<z.ZodString>;
+    scopes_supported: z.ZodArray<z.ZodString>;
+    authorization_response_iss_parameter_supported: z.ZodBoolean;
+}, z.core.$strip>;
+/** What the consent page shows about a pending sign-in request. */
+export declare const AdminOrderAssistantAuthorizationSchema: z.ZodObject<{
+    id: z.ZodString;
+    client_name: z.ZodNullable<z.ZodString>;
+    redirect_host: z.ZodString;
+    redirect_is_loopback: z.ZodBoolean;
+    redirect_is_known: z.ZodBoolean;
+    expires_at: z.ZodString;
+}, z.core.$strip>;
+export declare const AdminOrderAssistantAuthorizationResponseSchema: z.ZodObject<{
+    authorization: z.ZodObject<{
+        id: z.ZodString;
+        client_name: z.ZodNullable<z.ZodString>;
+        redirect_host: z.ZodString;
+        redirect_is_loopback: z.ZodBoolean;
+        redirect_is_known: z.ZodBoolean;
+        expires_at: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export declare const DecideOrderAssistantAuthorizationSchema: z.ZodObject<{
+    approve: z.ZodBoolean;
+}, z.core.$strict>;
+export declare const DecideOrderAssistantAuthorizationResponseSchema: z.ZodObject<{
+    redirect_to: z.ZodString;
+}, z.core.$strip>;
+/** One chatbot an Admin user connected through OAuth. */
+export declare const AdminOrderAssistantConnectionSchema: z.ZodObject<{
+    id: z.ZodString;
+    client_name: z.ZodNullable<z.ZodString>;
+    redirect_host: z.ZodString;
+    user_id: z.ZodString;
+    user_email: z.ZodNullable<z.ZodString>;
+    created_at: z.ZodString;
+    last_used_at: z.ZodNullable<z.ZodString>;
+    expires_at: z.ZodString;
+}, z.core.$strip>;
+export declare const AdminOrderAssistantConnectionsResponseSchema: z.ZodObject<{
+    connections: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        client_name: z.ZodNullable<z.ZodString>;
+        redirect_host: z.ZodString;
+        user_id: z.ZodString;
+        user_email: z.ZodNullable<z.ZodString>;
+        created_at: z.ZodString;
+        last_used_at: z.ZodNullable<z.ZodString>;
+        expires_at: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const DeleteOrderAssistantConnectionResponseSchema: z.ZodObject<{
+    id: z.ZodString;
+    deleted: z.ZodLiteral<true>;
+}, z.core.$strip>;