local-protocol 0.1.0

package/resources/merchants.d.mts

@@ -0,0 +1,405 @@
+import { APIResource } from "../core/resource.mjs";
+import * as MerchantsAPI from "./merchants.mjs";
+import * as PaymentInstrumentsAPI from "./payment-instruments.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+/**
+ * Read merchant profile and denormalized catalog data.
+ */
+export declare class Merchants extends APIResource {
+    /**
+     * Returns a merchant with its full denormalized catalog tree.
+     */
+    retrieve(merchantID: string, options?: RequestOptions): APIPromise<MerchantRetrieveResponse>;
+}
+/**
+ * Availability schedule for a catalog, category, or item.
+ */
+export interface Availability {
+    /**
+     * Availability intervals (weekly or date-specific).
+     */
+    intervals: Array<Availability.Interval>;
+    /**
+     * IANA timezone. Defaults to merchant timezone when omitted.
+     */
+    timezone?: string;
+}
+export declare namespace Availability {
+    /**
+     * A single time interval for a day of the week or a specific date.
+     */
+    interface Interval {
+        /**
+         * Start hour (0-23).
+         */
+        from_hour: number;
+        /**
+         * Start minute (0-59).
+         */
+        from_minute: number;
+        /**
+         * End hour (0-23).
+         */
+        to_hour: number;
+        /**
+         * End minute (0-59).
+         */
+        to_minute: number;
+        /**
+         * Calendar date in YYYY-MM-DD.
+         */
+        date?: string;
+        /**
+         * Day of week (e.g., Monday, Tuesday).
+         */
+        day?: string;
+    }
+}
+/**
+ * A category grouping items in a catalog.
+ */
+export interface CatalogCategory {
+    /**
+     * Category identifier.
+     */
+    id: string;
+    /**
+     * Ordered items in this category.
+     */
+    items: Array<CatalogCategory.Item>;
+    /**
+     * Category display name.
+     */
+    name: string;
+    /**
+     * Category availability.
+     */
+    availability?: Availability;
+    /**
+     * Ordered child categories for nested category trees.
+     */
+    categories?: Array<CatalogCategory>;
+    /**
+     * Optional category description.
+     */
+    description?: string;
+    /**
+     * Business-defined custom data.
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+}
+export declare namespace CatalogCategory {
+    /**
+     * A menu item with embedded modifier groups.
+     */
+    interface Item {
+        /**
+         * Item identifier.
+         */
+        id: string;
+        /**
+         * Item description.
+         */
+        description: string;
+        /**
+         * Item name.
+         */
+        name: string;
+        /**
+         * Base price for the item.
+         */
+        price: PaymentInstrumentsAPI.Amount;
+        /**
+         * Item availability.
+         */
+        availability?: MerchantsAPI.Availability;
+        /**
+         * Item media (images, videos, 3D models).
+         */
+        media?: Array<Item.Media>;
+        /**
+         * Business-defined custom data.
+         */
+        metadata?: {
+            [key: string]: unknown;
+        };
+        /**
+         * Modifier groups available for this item.
+         */
+        modifier_groups?: Array<MerchantsAPI.ModifierGroup>;
+    }
+    namespace Item {
+        /**
+         * Product media item (image, video, etc.).
+         */
+        interface Media {
+            /**
+             * Media type discriminator.
+             */
+            type: 'image' | 'video' | 'model_3d';
+            /**
+             * URL to the media resource.
+             */
+            url: string;
+            /**
+             * Accessibility text describing the media.
+             */
+            alt_text?: string;
+            /**
+             * Height in pixels.
+             */
+            height?: number;
+            /**
+             * Width in pixels.
+             */
+            width?: number;
+        }
+    }
+}
+/**
+ * Group of modifier options with selection constraints.
+ */
+export interface ModifierGroup {
+    /**
+     * Modifier group identifier.
+     */
+    id: string;
+    /**
+     * Ordered modifier options within this group.
+     */
+    modifier_options: Array<ModifierOption>;
+    /**
+     * Display name for the modifier group.
+     */
+    name: string;
+    /**
+     * Whether options can be selected with quantities > 1.
+     */
+    allow_quantities?: boolean;
+    /**
+     * Optional modifier group description.
+     */
+    description?: string;
+    /**
+     * Maximum quantity per modifier option.
+     */
+    max_per_modifier?: number;
+    /**
+     * Maximum selections allowed.
+     */
+    maximum_selections?: number;
+    /**
+     * Business-defined custom data.
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Minimum selections required.
+     */
+    minimum_selections?: number;
+    /**
+     * Modifier group type classification.
+     */
+    type?: string;
+}
+/**
+ * Selectable option within a modifier group.
+ */
+export interface ModifierOption {
+    /**
+     * Modifier option identifier.
+     */
+    id: string;
+    /**
+     * Modifier item for this option.
+     */
+    modifier_item: ModifierOption.ModifierItem;
+    /**
+     * Nested modifier groups required after selecting this option.
+     */
+    child_modifier_groups?: Array<ModifierGroup>;
+    /**
+     * Whether this option is selected by default.
+     */
+    is_default?: boolean;
+    /**
+     * Business-defined custom data.
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+}
+export declare namespace ModifierOption {
+    /**
+     * Modifier item for this option.
+     */
+    interface ModifierItem {
+        /**
+         * Modifier item identifier.
+         */
+        id: string;
+        /**
+         * Modifier item name.
+         */
+        name: string;
+        /**
+         * Price for this modifier item.
+         */
+        price: PaymentInstrumentsAPI.Amount;
+        /**
+         * Optional modifier item description.
+         */
+        description?: string;
+        /**
+         * Business-defined custom data.
+         */
+        metadata?: {
+            [key: string]: unknown;
+        };
+    }
+}
+/**
+ * Merchant catalog payload containing denormalized catalogs.
+ */
+export interface MerchantRetrieveResponse {
+    /**
+     * Merchant identifier.
+     */
+    id: string;
+    /**
+     * Catalogs available for the merchant.
+     */
+    catalogs: Array<MerchantRetrieveResponse.Catalog>;
+    /**
+     * Merchant name.
+     */
+    name: string;
+    /**
+     * IANA timezone for availability schedules.
+     */
+    timezone: string;
+    /**
+     * RFC 3339 timestamp of the latest catalog update.
+     */
+    last_updated?: string;
+    /**
+     * Business-defined custom data.
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+}
+export declare namespace MerchantRetrieveResponse {
+    /**
+     * A catalog containing embedded categories, items, availability, and fulfillment
+     * configuration.
+     */
+    interface Catalog {
+        /**
+         * Catalog identifier.
+         */
+        id: string;
+        /**
+         * Ordered top-level categories.
+         */
+        categories: Array<MerchantsAPI.CatalogCategory>;
+        /**
+         * Catalog name.
+         */
+        name: string;
+        /**
+         * Catalog-wide availability override.
+         */
+        availability?: MerchantsAPI.Availability;
+        /**
+         * Catalog description.
+         */
+        description?: string;
+        /**
+         * Items not assigned to a category.
+         */
+        items?: Array<Catalog.Item>;
+        /**
+         * Business-defined custom data.
+         */
+        metadata?: {
+            [key: string]: unknown;
+        };
+    }
+    namespace Catalog {
+        /**
+         * A menu item with embedded modifier groups.
+         */
+        interface Item {
+            /**
+             * Item identifier.
+             */
+            id: string;
+            /**
+             * Item description.
+             */
+            description: string;
+            /**
+             * Item name.
+             */
+            name: string;
+            /**
+             * Base price for the item.
+             */
+            price: PaymentInstrumentsAPI.Amount;
+            /**
+             * Item availability.
+             */
+            availability?: MerchantsAPI.Availability;
+            /**
+             * Item media (images, videos, 3D models).
+             */
+            media?: Array<Item.Media>;
+            /**
+             * Business-defined custom data.
+             */
+            metadata?: {
+                [key: string]: unknown;
+            };
+            /**
+             * Modifier groups available for this item.
+             */
+            modifier_groups?: Array<MerchantsAPI.ModifierGroup>;
+        }
+        namespace Item {
+            /**
+             * Product media item (image, video, etc.).
+             */
+            interface Media {
+                /**
+                 * Media type discriminator.
+                 */
+                type: 'image' | 'video' | 'model_3d';
+                /**
+                 * URL to the media resource.
+                 */
+                url: string;
+                /**
+                 * Accessibility text describing the media.
+                 */
+                alt_text?: string;
+                /**
+                 * Height in pixels.
+                 */
+                height?: number;
+                /**
+                 * Width in pixels.
+                 */
+                width?: number;
+            }
+        }
+    }
+}
+export declare namespace Merchants {
+    export { type Availability as Availability, type CatalogCategory as CatalogCategory, type ModifierGroup as ModifierGroup, type ModifierOption as ModifierOption, type MerchantRetrieveResponse as MerchantRetrieveResponse, };
+}
+//# sourceMappingURL=merchants.d.mts.map

package/resources/merchants.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"merchants.d.mts","sourceRoot":"","sources":["../src/resources/merchants.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,KAAK,qBAAqB;OAC1B,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAG7F;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IAExC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,YAAY,CAAC;IAC5B;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAEnC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAEpC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACvC;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,qBAAqB,CAAC,MAAM,CAAC;QAEpC;;WAEG;QACH,YAAY,CAAC,EAAE,YAAY,CAAC,YAAY,CAAC;QAEzC;;WAEG;QACH,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAE1B;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;WAEG;QACH,eAAe,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;KACrD;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,KAAK;YACpB;;eAEG;YACH,IAAI,EAAE,OAAO,GAAG,OAAO,GAAG,UAAU,CAAC;YAErC;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;YAEZ;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,gBAAgB,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IAExC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,cAAc,CAAC,YAAY,CAAC;IAE3C;;OAEG;IACH,qBAAqB,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAE7C;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACvC;AAED,yBAAiB,cAAc,CAAC;IAC9B;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,qBAAqB,CAAC,MAAM,CAAC;QAEpC;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;KACvC;CACF;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;IAElD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACvC;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;;OAGG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;QAEhD;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,YAAY,CAAC,EAAE,YAAY,CAAC,YAAY,CAAC;QAEzC;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,KAAK,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAE5B;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;KACvC;IAED,UAAiB,OAAO,CAAC;QACvB;;WAEG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,KAAK,EAAE,qBAAqB,CAAC,MAAM,CAAC;YAEpC;;eAEG;YACH,YAAY,CAAC,EAAE,YAAY,CAAC,YAAY,CAAC;YAEzC;;eAEG;YACH,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAE1B;;eAEG;YACH,QAAQ,CAAC,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,CAAC;YAEtC;;eAEG;YACH,eAAe,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;SACrD;QAED,UAAiB,IAAI,CAAC;YACpB;;eAEG;YACH,UAAiB,KAAK;gBACpB;;mBAEG;gBACH,IAAI,EAAE,OAAO,GAAG,OAAO,GAAG,UAAU,CAAC;gBAErC;;mBAEG;gBACH,GAAG,EAAE,MAAM,CAAC;gBAEZ;;mBAEG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB;;mBAEG;gBACH,MAAM,CAAC,EAAE,MAAM,CAAC;gBAEhB;;mBAEG;gBACH,KAAK,CAAC,EAAE,MAAM,CAAC;aAChB;SACF;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}