@builtbystack/sq-shopify-theme-sdk 0.0.3 → 0.0.4

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

@@ -1,3 +1,12 @@
+/**
+ * Location は ShopifyIntegration に紐付いている Location を表す。
+ */
+declare type Location_2 = {
+    id: string;
+    name: string;
+};
+export { Location_2 as Location }
+
 /**
  * LocationAvailabilities は LocationAvailability の一覧を取得するための情報を表す。
  */
@@ -25,6 +34,14 @@ export declare type LocationAvailability = {
     inventoryQuantity: number;
 };
 
+/**
+ * Locations は Location の一覧を取得するための情報を表す。
+ */
+export declare type Locations = {
+    nodes: Location_2[];
+    pageInfo: PageInfo | null;
+};
+
 /**
  * PageInfo はページングを伴って一覧を取得したときに、その一覧のページングの情報を表す。
  */
@@ -56,6 +73,27 @@ export declare type Points = {
     pointsPending: number;
 };
 
+/**
+ * PurchasingCustomerDiscount は購入者の割引情報を表す。
+ */
+export declare type PurchasingCustomerDiscount = {
+    id: string;
+    title: string;
+    description: string;
+    code: string;
+    createdAt: Date;
+    updatedAt: Date;
+};
+
+/**
+ * DiscountCodes は PurchasingCustomerDiscount の一覧を取得するための情報を表す。
+ */
+export declare type PurchasingCustomerDiscounts = {
+    id: string;
+    nodes: PurchasingCustomerDiscount[];
+    pageInfo: PageInfo | null;
+};
+
 /**
  * PurchasingCustomerMetafield は購入者のカスタムメタフィールドを表す。
  */
@@ -74,7 +112,7 @@ export declare class SDK {
      *
      * @param {string} sku 在庫一覧を取得したい商品のSKU。
      * @param {number} [first] 取得してくる個数。デフォルトは250。
-     * @param {string} [before] ページングの値。指定しない場合先頭から取得してくる。
+     * @param {string} [after] ページングの値。指定しない場合先頭から取得してくる。
      * @param {boolean} [isReverse] 並び順。デフォルトはfalse。
      */
     getLocationAvailabilities(sku: string, first?: number, after?: string, isReverse?: boolean): Promise<LocationAvailabilities>;
@@ -97,6 +135,22 @@ export declare class SDK {
      * 存在しない場合は0を返します。
      */
     getPoints(): Promise<Points | null>;
+    /**
+     * getLocations は ShopifyIntegration に紐づく LocationGroup の Location の一覧を取得します。
+     *
+     * @param {number} [first] 取得してくる個数。デフォルトは250。
+     * @param {string} [after] ページングの値。指定しない場合先頭から取得してくる。
+     * @param {boolean} [isReverse] 並び順。デフォルトはfalse。
+     */
+    getLocations(first?: number, after?: string, isReverse?: boolean): Promise<Locations>;
+    /**
+     * getPurchasingCustomerDiscounts は購入者の割引情報を返します。
+     *
+     * @param {number} [first] 取得してくる個数。デフォルトは250。
+     * @param {string} [after] ページングの値。指定しない場合先頭から取得してくる。
+     * @param {boolean} [isReverse] 並び順。デフォルトはfalse。
+     */
+    getPurchasingCustomerDiscounts(first?: number, after?: string, isReverse?: boolean): Promise<PurchasingCustomerDiscounts>;
 }
 
 export { }