@misiki/gocommerce-connector 0.6.0 → 0.7.0

package/dist/{index-1Tr-Urb_.d.cts → index-D-hnd6-D.d.cts}

@@ -4542,6 +4542,219 @@ declare class OrderService extends BaseService {
         noOfPage: number;
         page: number;
     }>;
+    /**
+     * Opens an order with its number and the email or phone on it, no code. The
+     * engine answers one 404 for an unknown number and a wrong contact. The
+     * token it answers is kept like an order placed in this browser, so the
+     * order page and `getOrder` read it again.
+     */
+    openOrder({ orderNo, contact }: {
+        orderNo: string;
+        contact: string;
+    }): Promise<{
+        data: {
+            id: string;
+            orderNo: string;
+            orderNumber: string;
+            number: string;
+            parentOrderNo: string;
+            status: string;
+            engineStatus: string;
+            paymentStatus: string;
+            paymentMethod: string;
+            currencyCode: string;
+            subtotal: number;
+            shippingCharges: number;
+            discount: number;
+            tax: number;
+            taxIncluded: boolean;
+            total: number;
+            refunded: number;
+            codCharges: number;
+            coupon: {
+                code: string;
+            } | null;
+            userEmail: string;
+            email: string;
+            phone: string | null;
+            shippingAddress: {
+                firstName: string;
+                lastName: string;
+                email: string | null;
+                phone: string | null;
+                address_1: string;
+                address_2: string;
+                city: string;
+                state: string;
+                zip: string;
+                country: string;
+                countryCode: string;
+            } | null;
+            billingAddress: {
+                firstName: string;
+                lastName: string;
+                email: string | null;
+                phone: string | null;
+                address_1: string;
+                address_2: string;
+                city: string;
+                state: string;
+                zip: string;
+                country: string;
+                countryCode: string;
+            } | null;
+            shippingMethod: string | null;
+            shippingRate: {
+                name: string;
+            } | null;
+            lineItems: {
+                id: string;
+                productId: string;
+                variantId: string;
+                sku: string;
+                title: string;
+                name: string;
+                slug: string;
+                thumbnail: string | null;
+                img: string | null;
+                variantTitle: string;
+                qty: number;
+                shippedQty: number;
+                price: number;
+                mrp: number;
+                subtotal: number;
+                total: number;
+                currencyCode: string;
+                status: string;
+                files: never[];
+                usedOptions: never[];
+            }[];
+            fulfillments: {
+                id: string;
+                status: string;
+                carrier: string;
+                trackingNumber: string | null;
+                trackingUrl: string | null;
+                lineItems: {
+                    id: string;
+                    title: string;
+                    qty: number;
+                }[];
+                createdAt: string;
+            }[];
+            tracking: never[];
+            orderHistory: never[];
+            isReplaceOrReturn: boolean;
+            createdAt: string;
+            updatedAt: string;
+        }[];
+    }>;
+    /**
+     * Opens an order from the link in its emails, which carries the order's key
+     * (`/order-tracking?order=…&key=…`). The key is kept like an order placed in
+     * this browser, so the page can drop it from the address bar.
+     */
+    openOrderWithKey({ orderNo, key }: {
+        orderNo: string;
+        key: string;
+    }): Promise<{
+        data: {
+            id: string;
+            orderNo: string;
+            orderNumber: string;
+            number: string;
+            parentOrderNo: string;
+            status: string;
+            engineStatus: string;
+            paymentStatus: string;
+            paymentMethod: string;
+            currencyCode: string;
+            subtotal: number;
+            shippingCharges: number;
+            discount: number;
+            tax: number;
+            taxIncluded: boolean;
+            total: number;
+            refunded: number;
+            codCharges: number;
+            coupon: {
+                code: string;
+            } | null;
+            userEmail: string;
+            email: string;
+            phone: string | null;
+            shippingAddress: {
+                firstName: string;
+                lastName: string;
+                email: string | null;
+                phone: string | null;
+                address_1: string;
+                address_2: string;
+                city: string;
+                state: string;
+                zip: string;
+                country: string;
+                countryCode: string;
+            } | null;
+            billingAddress: {
+                firstName: string;
+                lastName: string;
+                email: string | null;
+                phone: string | null;
+                address_1: string;
+                address_2: string;
+                city: string;
+                state: string;
+                zip: string;
+                country: string;
+                countryCode: string;
+            } | null;
+            shippingMethod: string | null;
+            shippingRate: {
+                name: string;
+            } | null;
+            lineItems: {
+                id: string;
+                productId: string;
+                variantId: string;
+                sku: string;
+                title: string;
+                name: string;
+                slug: string;
+                thumbnail: string | null;
+                img: string | null;
+                variantTitle: string;
+                qty: number;
+                shippedQty: number;
+                price: number;
+                mrp: number;
+                subtotal: number;
+                total: number;
+                currencyCode: string;
+                status: string;
+                files: never[];
+                usedOptions: never[];
+            }[];
+            fulfillments: {
+                id: string;
+                status: string;
+                carrier: string;
+                trackingNumber: string | null;
+                trackingUrl: string | null;
+                lineItems: {
+                    id: string;
+                    title: string;
+                    qty: number;
+                }[];
+                createdAt: string;
+            }[];
+            tracking: never[];
+            orderHistory: never[];
+            isReplaceOrReturn: boolean;
+            createdAt: string;
+            updatedAt: string;
+        }[];
+    }>;
     /**
      * Sends a 4-digit code to the email or phone on the order, when `contact`
      * is that email or phone. The engine answers the same either way, so this

package/dist/{index-1Tr-Urb_.d.ts → index-D-hnd6-D.d.ts}

@@ -4542,6 +4542,219 @@ declare class OrderService extends BaseService {
         noOfPage: number;
         page: number;
     }>;
+    /**
+     * Opens an order with its number and the email or phone on it, no code. The
+     * engine answers one 404 for an unknown number and a wrong contact. The
+     * token it answers is kept like an order placed in this browser, so the
+     * order page and `getOrder` read it again.
+     */
+    openOrder({ orderNo, contact }: {
+        orderNo: string;
+        contact: string;
+    }): Promise<{
+        data: {
+            id: string;
+            orderNo: string;
+            orderNumber: string;
+            number: string;
+            parentOrderNo: string;
+            status: string;
+            engineStatus: string;
+            paymentStatus: string;
+            paymentMethod: string;
+            currencyCode: string;
+            subtotal: number;
+            shippingCharges: number;
+            discount: number;
+            tax: number;
+            taxIncluded: boolean;
+            total: number;
+            refunded: number;
+            codCharges: number;
+            coupon: {
+                code: string;
+            } | null;
+            userEmail: string;
+            email: string;
+            phone: string | null;
+            shippingAddress: {
+                firstName: string;
+                lastName: string;
+                email: string | null;
+                phone: string | null;
+                address_1: string;
+                address_2: string;
+                city: string;
+                state: string;
+                zip: string;
+                country: string;
+                countryCode: string;
+            } | null;
+            billingAddress: {
+                firstName: string;
+                lastName: string;
+                email: string | null;
+                phone: string | null;
+                address_1: string;
+                address_2: string;
+                city: string;
+                state: string;
+                zip: string;
+                country: string;
+                countryCode: string;
+            } | null;
+            shippingMethod: string | null;
+            shippingRate: {
+                name: string;
+            } | null;
+            lineItems: {
+                id: string;
+                productId: string;
+                variantId: string;
+                sku: string;
+                title: string;
+                name: string;
+                slug: string;
+                thumbnail: string | null;
+                img: string | null;
+                variantTitle: string;
+                qty: number;
+                shippedQty: number;
+                price: number;
+                mrp: number;
+                subtotal: number;
+                total: number;
+                currencyCode: string;
+                status: string;
+                files: never[];
+                usedOptions: never[];
+            }[];
+            fulfillments: {
+                id: string;
+                status: string;
+                carrier: string;
+                trackingNumber: string | null;
+                trackingUrl: string | null;
+                lineItems: {
+                    id: string;
+                    title: string;
+                    qty: number;
+                }[];
+                createdAt: string;
+            }[];
+            tracking: never[];
+            orderHistory: never[];
+            isReplaceOrReturn: boolean;
+            createdAt: string;
+            updatedAt: string;
+        }[];
+    }>;
+    /**
+     * Opens an order from the link in its emails, which carries the order's key
+     * (`/order-tracking?order=…&key=…`). The key is kept like an order placed in
+     * this browser, so the page can drop it from the address bar.
+     */
+    openOrderWithKey({ orderNo, key }: {
+        orderNo: string;
+        key: string;
+    }): Promise<{
+        data: {
+            id: string;
+            orderNo: string;
+            orderNumber: string;
+            number: string;
+            parentOrderNo: string;
+            status: string;
+            engineStatus: string;
+            paymentStatus: string;
+            paymentMethod: string;
+            currencyCode: string;
+            subtotal: number;
+            shippingCharges: number;
+            discount: number;
+            tax: number;
+            taxIncluded: boolean;
+            total: number;
+            refunded: number;
+            codCharges: number;
+            coupon: {
+                code: string;
+            } | null;
+            userEmail: string;
+            email: string;
+            phone: string | null;
+            shippingAddress: {
+                firstName: string;
+                lastName: string;
+                email: string | null;
+                phone: string | null;
+                address_1: string;
+                address_2: string;
+                city: string;
+                state: string;
+                zip: string;
+                country: string;
+                countryCode: string;
+            } | null;
+            billingAddress: {
+                firstName: string;
+                lastName: string;
+                email: string | null;
+                phone: string | null;
+                address_1: string;
+                address_2: string;
+                city: string;
+                state: string;
+                zip: string;
+                country: string;
+                countryCode: string;
+            } | null;
+            shippingMethod: string | null;
+            shippingRate: {
+                name: string;
+            } | null;
+            lineItems: {
+                id: string;
+                productId: string;
+                variantId: string;
+                sku: string;
+                title: string;
+                name: string;
+                slug: string;
+                thumbnail: string | null;
+                img: string | null;
+                variantTitle: string;
+                qty: number;
+                shippedQty: number;
+                price: number;
+                mrp: number;
+                subtotal: number;
+                total: number;
+                currencyCode: string;
+                status: string;
+                files: never[];
+                usedOptions: never[];
+            }[];
+            fulfillments: {
+                id: string;
+                status: string;
+                carrier: string;
+                trackingNumber: string | null;
+                trackingUrl: string | null;
+                lineItems: {
+                    id: string;
+                    title: string;
+                    qty: number;
+                }[];
+                createdAt: string;
+            }[];
+            tracking: never[];
+            orderHistory: never[];
+            isReplaceOrReturn: boolean;
+            createdAt: string;
+            updatedAt: string;
+        }[];
+    }>;
     /**
      * Sends a 4-digit code to the email or phone on the order, when `contact`
      * is that email or phone. The engine answers the same either way, so this

package/dist/index.cjs

@@ -2053,6 +2053,31 @@ var OrderService = class extends BaseService {
   async listPublic(_args = {}) {
     return emptyPage();
   }
+  /**
+   * Opens an order with its number and the email or phone on it, no code. The
+   * engine answers one 404 for an unknown number and a wrong contact. The
+   * token it answers is kept like an order placed in this browser, so the
+   * order page and `getOrder` read it again.
+   */
+  async openOrder({ orderNo, contact }) {
+    const res = await this.data(
+      `/api/orders/${encodeURIComponent(orderNo.trim())}/open`,
+      { method: "POST", body: { contact: contact.trim() } }
+    );
+    rememberOrder({ number: res.order.number, token: res.access_token, cartId: "" });
+    return { data: [toOrder(res.order)] };
+  }
+  /**
+   * Opens an order from the link in its emails, which carries the order's key
+   * (`/order-tracking?order=…&key=…`). The key is kept like an order placed in
+   * this browser, so the page can drop it from the address bar.
+   */
+  async openOrderWithKey({ orderNo, key }) {
+    const number = orderNo.trim();
+    const order = await this.data(`/api/orders/${encodeURIComponent(number)}`, { query: { token: key.trim() } });
+    rememberOrder({ number: order.number, token: key.trim(), cartId: "" });
+    return { data: [toOrder(order)] };
+  }
   /**
    * Sends a 4-digit code to the email or phone on the order, when `contact`
    * is that email or phone. The engine answers the same either way, so this