@builtbystack/sq-shopify-theme-sdk 0.0.19 → 0.0.22

package/README.doc.md

@@ -4,6 +4,13 @@
 
 `@x.x.x` で指定されているバージョンは適宜最新のものを利用してください。
 
+SDKは名前空間 `SQ` 内に存在するため、SDKの初期化は `new SQ.SDK()` で行ってください。
+
 ```html
 <script src="https://unpkg.com/@builtbystack/sq-shopify-theme-sdk@x.x.x/dist/sq-shopify-theme-sdk.umd.js" defer></script>
+<script type="text/javascript">
+  window.onload = async () => {
+    const sdk = new SQ.SDK({{ request.origin | json }});
+  }
+</script>
 ```

package/README.md

@@ -11,8 +11,15 @@
 
 `@x.x.x` で指定されているバージョンは適宜最新のものを利用してください。
 
+SDKは名前空間 `SQ` 内に存在するため、SDKの初期化は `new SQ.SDK()` で行ってください。
+
 ```html
 <script src="https://unpkg.com/@builtbystack/sq-shopify-theme-sdk@x.x.x/dist/sq-shopify-theme-sdk.umd.js" defer></script>
+<script type="text/javascript">
+  window.onload = async () => {
+    const sdk = new SQ.SDK({{ request.origin | json }});
+  }
+</script>
 ```
 
 # Classes
@@ -98,12 +105,20 @@ getLocationAvailability は渡されたSKUとLocationIDにおける在庫情報
 
 #### getLocations()
 
-> **getLocations**(`first`?, `after`?, `isReverse`?): `Promise`\<[`Locations`](#type-aliaseslocationsmd)\>
+> **getLocations**(`tag`?, `provinceCodes`?, `first`?, `after`?, `isReverse`?): `Promise`\<[`Locations`](#type-aliaseslocationsmd)\>
 
 getLocations は ShopifyIntegration に紐づく LocationGroup の Location の一覧を取得します。
 
 ##### Parameters
 
+• **tag?**: `string`
+
+取得したいLocationのタグ。
+
+• **provinceCodes?**: `string`[]
+
+取得したいLocationの都道府県コード。
+
 • **first?**: `number`
 
 取得してくる個数。デフォルトは250。
@@ -660,6 +675,10 @@ Location は ShopifyIntegration に紐付いている Location を表す。
 
 > **phone**: `string`
 
+#### tags
+
+> **tags**: `string`[]
+
 
 <a name="type-aliaseslocationavailabilitiesmd"></a>
 
@@ -982,18 +1001,34 @@ Product は商品情報を表す。
 
 ### Type declaration
 
+#### hasBackOrderProductVariants
+
+> **hasBackOrderProductVariants**: `boolean`
+
+商品が持つバリエーションに1つでも予約販売設定がされている場合trueが返る
+
 #### id
 
 > **id**: `string`
 
+#### isLocalPickupAvailable
+
+> **isLocalPickupAvailable**: `boolean`
+
+商品の店舗受取が可能な場合にtrueが返る
+
 #### title
 
 > **title**: `string`
 
+商品のタイトル
+
 #### variants
 
 > **variants**: [`ProductVariants`](#type-aliasesproductvariantsmd)
 
+商品のバリエーション一覧
+
 
 <a name="type-aliasesproductvariantmd"></a>
 
@@ -1019,14 +1054,26 @@ ProductVariant は商品のバリエーションを表す。
 
 > **inventoryItem**: [`InventoryItem`](#type-aliasesinventoryitemmd)
 
+在庫情報
+
 #### isBackOrderEnable
 
 > **isBackOrderEnable**: `boolean`
 
+予約販売が設定されている場合にtrueが返る
+
+#### isLocalPickupAvailable
+
+> **isLocalPickupAvailable**: `boolean`
+
+商品の店舗受取が可能な場合にtrueが返る
+
 #### title
 
 > **title**: `string`
 
+商品バリエーションのタイトル
+
 
 <a name="type-aliasesproductvariantsmd"></a>
 

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

@@ -120,6 +120,7 @@ declare type Location_2 = {
     name: string;
     phone: string;
     mapURL?: string;
+    tags: string[];
     address?: Address;
 };
 export { Location_2 as Location }
@@ -265,7 +266,21 @@ export declare type Points = {
  */
 export declare type Product = {
     id: string;
+    /**
+     * 商品のタイトル
+     */
     title: string;
+    /**
+     * 商品が持つバリエーションに1つでも予約販売設定がされている場合trueが返る
+     */
+    hasBackOrderProductVariants: boolean;
+    /**
+     * 商品の店舗受取が可能な場合にtrueが返る
+     */
+    isLocalPickupAvailable: boolean;
+    /**
+     * 商品のバリエーション一覧
+     */
     variants: ProductVariants;
 };
 
@@ -274,8 +289,21 @@ export declare type Product = {
  */
 export declare type ProductVariant = {
     id: string;
+    /**
+     * 商品バリエーションのタイトル
+     */
     title: string;
+    /**
+     * 予約販売が設定されている場合にtrueが返る
+     */
     isBackOrderEnable: boolean;
+    /**
+     * 商品の店舗受取が可能な場合にtrueが返る
+     */
+    isLocalPickupAvailable: boolean;
+    /**
+     * 在庫情報
+     */
     inventoryItem: InventoryItem;
 };
 
@@ -380,11 +408,13 @@ export declare class SDK {
     /**
      * getLocations は ShopifyIntegration に紐づく LocationGroup の Location の一覧を取得します。
      *
+     * @param {string} [tag] 取得したいLocationのタグ。
+     * @param {string[]} [provinceCodes] 取得したいLocationの都道府県コード。
      * @param {number} [first] 取得してくる個数。デフォルトは250。
      * @param {string} [after] ページングの値。指定しない場合先頭から取得してくる。
      * @param {boolean} [isReverse] 並び順。デフォルトはfalse。
      */
-    getLocations(first?: number, after?: string, isReverse?: boolean): Promise<Locations>;
+    getLocations(tag?: string, provinceCodes?: string[], first?: number, after?: string, isReverse?: boolean): Promise<Locations>;
     /**
      * getPurchasingCustomerDiscounts は購入者の割引情報を返します。
      *