@builtbystack/sq-shopify-theme-sdk 0.0.1

package/dist/sq-shopify-appproxy-sdk.d.ts

@@ -0,0 +1,102 @@
+/**
+ * LocationAvailabilities は LocationAvailability の一覧を取得するための情報を表す。
+ */
+export declare type LocationAvailabilities = {
+    nodes: LocationAvailability[];
+    pageInfo: PageInfo | null;
+};
+
+/**
+ * LocationAvailability はLocationの在庫情報を表す。
+ */
+export declare type LocationAvailability = {
+    /**
+     * location は在庫のLocationを表す。
+     */
+    location: {
+        /**
+         * name はLocationの名前を表す。
+         */
+        name: string;
+    };
+    /**
+     * inventoryQuantity は在庫数を表す。
+     */
+    inventoryQuantity: number;
+};
+
+/**
+ * PageInfo はページングを伴って一覧を取得したときに、その一覧のページングの情報を表す。
+ */
+export declare type PageInfo = {
+    /**
+     * startCursor は一覧の先頭のカーソルを表す。
+     */
+    startCursor: string;
+    /**
+     * endCursor は一覧の末尾のカーソルを表す。
+     * このカーソルを使って次のページを取得することができる。
+     */
+    endCursor: string;
+    /**
+     * hasNextPage は次のページがあるかどうかを表す。
+     */
+    hasNextPage: boolean;
+    /**
+     * hasPreviousPage は前のページがあるかどうかを表す。
+     */
+    hasPreviousPage: boolean;
+};
+
+/**
+ * Points は SDK から取得できるポイントの情報を表す。
+ */
+export declare type Points = {
+    pointsApproved: number;
+    pointsPending: number;
+};
+
+/**
+ * PurchasingCustomerMetafield は購入者のカスタムメタフィールドを表す。
+ */
+export declare type PurchasingCustomerMetafield = {
+    id: string;
+    namespace: string;
+    key: string;
+    value: string;
+};
+
+export declare class SDK {
+    private api;
+    constructor(apiURL: string);
+    /**
+     * getLocationAvailabilities は渡されたSKUの各ロケーションにおける残り在庫の一覧を返します。
+     *
+     * @param {string} sku 在庫一覧を取得したい商品のSKU。
+     * @param {number} [first] 取得してくる個数。デフォルトは250。
+     * @param {string} [before] ページングの値。指定しない場合先頭から取得してくる。
+     * @param {boolean} [isReverse] 並び順。デフォルトはfalse。
+     */
+    getLocationAvailabilities(sku: string, first?: number, after?: string, isReverse?: boolean): Promise<LocationAvailabilities>;
+    /**
+     * getLocationAvailability は渡されたSKUとLocationIDにおける在庫情報を返します。
+     * @param {string} sku 在庫情報を取得したい商品のSKU。
+     * @param {string} locationID 在庫情報を取得したいLocationのID。
+     */
+    getLocationAvailability(sku: string, locationID: string): Promise<LocationAvailability>;
+    /**
+     * getPurchasingCustomerMetafield は渡されたnamespaceとkeyに一致する現在ログインしているCustomerのカスタムメタフィールドを返します。
+     * 存在しない場合はnullを返します。
+     *
+     * @param {string} namespace 取得したいメタフィールドのnamespace。
+     * @param {string} key 取得したいメタフィールドのkey。
+     */
+    getPurchasingCustomerMetafield(namespace: string, key: string): Promise<PurchasingCustomerMetafield | null>;
+    /**
+     * getPoints は、現在の保有ポイントと、獲得予定ポイントを返します。
+     * 存在しない場合は0を返します。
+     */
+    getPoints(): Promise<Points | null>;
+}
+
+export { }