@marteye/studiojs 1.0.0 → 1.1.0

package/dist/resources/sales.d.ts

@@ -0,0 +1,56 @@
+import { HttpClient } from "../net/http";
+import { Sale } from "../types";
+type SalesListResponse = {
+    start: string;
+    end: string;
+    sales: Sale[];
+};
+export default function create(httpClient: HttpClient): {
+    get: (marketId: string, saleId: string) => Promise<Sale>;
+    list: (marketId: string, opts: {
+        start?: string;
+        end?: string;
+    }) => Promise<SalesListResponse>;
+    update: (marketId: string, saleId: string, data: {
+        name?: string;
+        recurring?: "Weekly" | "Bi-weekly" | "Monthly" | null;
+        defaultProductCode?: string;
+        attributeDefaults?: Record<string, any>;
+        martEyeId?: string | null;
+        marteyeSettings?: {
+            description?: string;
+            image?: string;
+            logo?: string;
+            type: "LIVE" | "TIMED";
+            location?: string | null;
+            descriptionLines?: string[];
+            descriptionLink?: string;
+            deposit?: number;
+            hidePrices?: boolean;
+            hideReplay?: boolean;
+            labels?: string[];
+            tags?: string[];
+            details?: Array<{
+                markdownBase64: string;
+                title: string;
+            }>;
+            cover?: string;
+            primaryColour?: string;
+            secondaryColour?: string;
+            foregroundColour?: string;
+            extensionTime?: number;
+            incrementLadder?: Array<{
+                max: number;
+                increment: number;
+            }>;
+            hideNav?: boolean;
+            signInOverrideLink?: string;
+            published?: boolean;
+            pin?: boolean;
+            cascade?: boolean;
+            reportEmail?: string;
+        } | null;
+    }) => Promise<Sale>;
+};
+export type Sales = ReturnType<typeof create>;
+export {};

package/dist/resources/webhooks.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="node" />
+import { HttpClient } from "../net/http";
+export default function create(_: HttpClient): {
+    /***
+     * This is used to construct the webhook event from the request body
+     * @param body the request body
+     * @param signature the signature of the request taken from the header
+     * @param endpointSecret the pre-shared secret
+     * @returns the webhook event
+     */
+    constructEvent: (bodyAsBuffer: Buffer, signature: string, endpointSecret: string) => Promise<any>;
+};
+export type Webhooks = ReturnType<typeof create>;

package/dist/resources.d.ts

@@ -0,0 +1,115 @@
+/// <reference types="node" />
+import { HttpClient } from "./net/http";
+export default function resources(httpClient: HttpClient): {
+    markets: {
+        get: (marketId: string) => Promise<import("./types").Market>;
+    };
+    sales: {
+        get: (marketId: string, saleId: string) => Promise<import("./types").Sale>;
+        list: (marketId: string, opts: {
+            start?: string | undefined;
+            end?: string | undefined;
+        }) => Promise<{
+            start: string;
+            end: string;
+            sales: import("./types").Sale[];
+        }>;
+        update: (marketId: string, saleId: string, data: {
+            name?: string | undefined;
+            recurring?: "Weekly" | "Bi-weekly" | "Monthly" | null | undefined;
+            defaultProductCode?: string | undefined;
+            attributeDefaults?: Record<string, any> | undefined;
+            martEyeId?: string | null | undefined;
+            marteyeSettings?: {
+                description?: string | undefined;
+                image?: string | undefined;
+                logo?: string | undefined;
+                type: "LIVE" | "TIMED";
+                location?: string | null | undefined;
+                descriptionLines?: string[] | undefined;
+                descriptionLink?: string | undefined;
+                deposit?: number | undefined;
+                hidePrices?: boolean | undefined;
+                hideReplay?: boolean | undefined;
+                labels?: string[] | undefined;
+                tags?: string[] | undefined;
+                details?: {
+                    markdownBase64: string;
+                    title: string;
+                }[] | undefined;
+                cover?: string | undefined;
+                primaryColour?: string | undefined;
+                secondaryColour?: string | undefined;
+                foregroundColour?: string | undefined;
+                extensionTime?: number | undefined;
+                incrementLadder?: {
+                    max: number;
+                    increment: number;
+                }[] | undefined;
+                hideNav?: boolean | undefined;
+                signInOverrideLink?: string | undefined;
+                published?: boolean | undefined;
+                pin?: boolean | undefined;
+                cascade?: boolean | undefined;
+                reportEmail?: string | undefined;
+            } | null | undefined;
+        }) => Promise<import("./types").Sale>;
+    };
+    lots: {
+        get: (marketId: string, saleId: string, lotId: string) => Promise<import("./types").Lot>;
+        list: (marketId: string, saleId: string) => Promise<import("./types").Lot[]>;
+        create: (marketId: string, saleId: string, data: {
+            index?: number | undefined;
+            lotNumber?: string | undefined;
+            group?: string | undefined;
+            productCode?: string | undefined;
+            sellerCustomerId?: string | undefined;
+            attributes?: Record<string, any> | undefined;
+            metadata?: Record<string, any> | undefined;
+            buyerCustomerId?: string | undefined;
+            unitPriceInCents?: number | undefined;
+            startedAt?: string | undefined;
+            endedAt?: string | undefined;
+            previousLotNumber?: string | undefined;
+        }) => Promise<import("./types").Lot>;
+        update: (marketId: string, saleId: string, lotId: string, data: {
+            productCode?: string | undefined;
+            attributes?: Record<string, any> | undefined;
+            sellerCasual?: string | null | undefined;
+            sellerCustomerId?: string | null | undefined;
+            lotNumber?: string | null | undefined;
+            remarks?: string | undefined;
+            notes?: string | undefined;
+            unitOfSale?: "Per KG" | "Per Item" | "Per Lot" | "Per 1000KG" | undefined;
+            unitPriceInCents?: number | undefined;
+            buyerCasual?: string | null | undefined;
+            buyerCustomerId?: string | null | undefined;
+            startedAt?: string | null | undefined;
+            endedAt?: string | null | undefined;
+            saleStatus?: "Sold" | "Unsold" | "Rerun" | "Resold" | null | undefined;
+            metadata?: Record<string, any> | undefined;
+        }) => Promise<import("./types").Lot>;
+        delete: (marketId: string, saleId: string, lotId: string) => Promise<unknown>;
+    };
+    lotitems: {
+        create: (marketId: string, saleId: string, lotId: string, data: {
+            attributes?: Record<string, any> | undefined;
+            notes?: {
+                text: string;
+            }[] | undefined;
+            metadata?: Record<string, any> | undefined;
+        }) => Promise<import("./types").LotItem>;
+        update: (marketId: string, saleId: string, lotId: string, itemId: string, data: {
+            attributes?: Record<string, any> | undefined;
+            index?: number | undefined;
+            metadata?: Record<string, any> | undefined;
+        }) => Promise<import("./types").LotItem>;
+        delete: (marketId: string, saleId: string, lotId: string, itemId: string) => Promise<unknown>;
+    };
+    webhooks: {
+        constructEvent: (bodyAsBuffer: Buffer, signature: string, endpointSecret: string) => Promise<any>;
+    };
+    actions: {
+        constructAction: (bodyAsBuffer: Buffer, signature: string, endpointSecret: string) => Promise<any>;
+    };
+};

package/dist/studio.d.ts

@@ -0,0 +1,115 @@
+/// <reference types="node" />
+export declare function Studio(apiKey: string, baseUrl?: string, defaultTimeout?: number, debug?: boolean): {
+    isDebugMode: boolean;
+    markets: {
+        get: (marketId: string) => Promise<import("./types").Market>;
+    };
+    sales: {
+        get: (marketId: string, saleId: string) => Promise<import("./types").Sale>;
+        list: (marketId: string, opts: {
+            start?: string | undefined;
+            end?: string | undefined;
+        }) => Promise<{
+            start: string;
+            end: string;
+            sales: import("./types").Sale[];
+        }>;
+        update: (marketId: string, saleId: string, data: {
+            name?: string | undefined;
+            recurring?: "Weekly" | "Bi-weekly" | "Monthly" | null | undefined;
+            defaultProductCode?: string | undefined;
+            attributeDefaults?: Record<string, any> | undefined;
+            martEyeId?: string | null | undefined;
+            marteyeSettings?: {
+                description?: string | undefined;
+                image?: string | undefined;
+                logo?: string | undefined;
+                type: "LIVE" | "TIMED";
+                location?: string | null | undefined;
+                descriptionLines?: string[] | undefined;
+                descriptionLink?: string | undefined;
+                deposit?: number | undefined;
+                hidePrices?: boolean | undefined;
+                hideReplay?: boolean | undefined;
+                labels?: string[] | undefined;
+                tags?: string[] | undefined;
+                details?: {
+                    markdownBase64: string;
+                    title: string;
+                }[] | undefined;
+                cover?: string | undefined;
+                primaryColour?: string | undefined;
+                secondaryColour?: string | undefined;
+                foregroundColour?: string | undefined;
+                extensionTime?: number | undefined;
+                incrementLadder?: {
+                    max: number;
+                    increment: number;
+                }[] | undefined;
+                hideNav?: boolean | undefined;
+                signInOverrideLink?: string | undefined;
+                published?: boolean | undefined;
+                pin?: boolean | undefined;
+                cascade?: boolean | undefined;
+                reportEmail?: string | undefined;
+            } | null | undefined;
+        }) => Promise<import("./types").Sale>;
+    };
+    lots: {
+        get: (marketId: string, saleId: string, lotId: string) => Promise<import("./types").Lot>;
+        list: (marketId: string, saleId: string) => Promise<import("./types").Lot[]>;
+        create: (marketId: string, saleId: string, data: {
+            index?: number | undefined;
+            lotNumber?: string | undefined;
+            group?: string | undefined;
+            productCode?: string | undefined;
+            sellerCustomerId?: string | undefined;
+            attributes?: Record<string, any> | undefined;
+            metadata?: Record<string, any> | undefined;
+            buyerCustomerId?: string | undefined;
+            unitPriceInCents?: number | undefined;
+            startedAt?: string | undefined;
+            endedAt?: string | undefined;
+            previousLotNumber?: string | undefined;
+        }) => Promise<import("./types").Lot>;
+        update: (marketId: string, saleId: string, lotId: string, data: {
+            productCode?: string | undefined;
+            attributes?: Record<string, any> | undefined;
+            sellerCasual?: string | null | undefined;
+            sellerCustomerId?: string | null | undefined;
+            lotNumber?: string | null | undefined;
+            remarks?: string | undefined;
+            notes?: string | undefined;
+            unitOfSale?: "Per KG" | "Per Item" | "Per Lot" | "Per 1000KG" | undefined;
+            unitPriceInCents?: number | undefined;
+            buyerCasual?: string | null | undefined;
+            buyerCustomerId?: string | null | undefined;
+            startedAt?: string | null | undefined;
+            endedAt?: string | null | undefined;
+            saleStatus?: "Sold" | "Unsold" | "Rerun" | "Resold" | null | undefined;
+            metadata?: Record<string, any> | undefined;
+        }) => Promise<import("./types").Lot>;
+        delete: (marketId: string, saleId: string, lotId: string) => Promise<unknown>;
+    };
+    lotitems: {
+        create: (marketId: string, saleId: string, lotId: string, data: {
+            attributes?: Record<string, any> | undefined;
+            notes?: {
+                text: string;
+            }[] | undefined;
+            metadata?: Record<string, any> | undefined;
+        }) => Promise<import("./types").LotItem>;
+        update: (marketId: string, saleId: string, lotId: string, itemId: string, data: {
+            attributes?: Record<string, any> | undefined;
+            index?: number | undefined;
+            metadata?: Record<string, any> | undefined;
+        }) => Promise<import("./types").LotItem>;
+        delete: (marketId: string, saleId: string, lotId: string, itemId: string) => Promise<unknown>;
+    };
+    webhooks: {
+        constructEvent: (bodyAsBuffer: Buffer, signature: string, endpointSecret: string) => Promise<any>;
+    };
+    actions: {
+        constructAction: (bodyAsBuffer: Buffer, signature: string, endpointSecret: string) => Promise<any>;
+    };
+};