@builtbystack/sq-shopify-theme-sdk 0.0.20 → 0.0.23

package/README.md

@@ -105,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。
@@ -129,6 +137,16 @@ getLocations は ShopifyIntegration に紐づく LocationGroup の Location の
 
 ***
 
+#### getPointCampaignOrderRuleTargetCustomerRank()
+
+> **getPointCampaignOrderRuleTargetCustomerRank**(): `Promise`\<`null` \| [`PointCampaignOrderRuleTargetCustomerRank`](#type-aliasespointcampaignorderruletargetcustomerrankmd)\>
+
+##### Returns
+
+`Promise`\<`null` \| [`PointCampaignOrderRuleTargetCustomerRank`](#type-aliasespointcampaignorderruletargetcustomerrankmd)\>
+
+***
+
 #### getPointChangeActivities()
 
 > **getPointChangeActivities**(`first`?, `after`?, `isReverse`?, `sortKeys`?): `Promise`\<`null` \| [`PointChangeActivities`](#type-aliasespointchangeactivitiesmd)\>
@@ -346,6 +364,8 @@ purchasingCustomerSendCustomerSharingActivationCode はログインしている
 - [LocationAvailability](#type-aliaseslocationavailabilitymd)
 - [Locations](#type-aliaseslocationsmd)
 - [PageInfo](#type-aliasespageinfomd)
+- [PointCampaignOrderRule](#type-aliasespointcampaignorderrulemd)
+- [PointCampaignOrderRuleTargetCustomerRank](#type-aliasespointcampaignorderruletargetcustomerrankmd)
 - [PointChange](#type-aliasespointchangemd)
 - [PointChangeActivities](#type-aliasespointchangeactivitiesmd)
 - [PointChangeActivity](#type-aliasespointchangeactivitymd)
@@ -667,6 +687,10 @@ Location は ShopifyIntegration に紐付いている Location を表す。
 
 > **phone**: `string`
 
+#### tags
+
+> **tags**: `string`[]
+
 
 <a name="type-aliaseslocationavailabilitiesmd"></a>
 
@@ -789,6 +813,78 @@ hasPreviousPage は前のページがあるかどうかを表す。
 startCursor は一覧の先頭のカーソルを表す。
 
 
+<a name="type-aliasespointcampaignorderrulemd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / PointCampaignOrderRule
+
+## Type Alias: PointCampaignOrderRule
+
+> **PointCampaignOrderRule**: `object`
+
+PointCampaignOrderRule はポイントキャンペーンの設定を表す。
+
+### Type declaration
+
+#### id
+
+> **id**: `string`
+
+#### title
+
+> **title**: `string`
+
+キャンペーンのタイトル
+
+
+<a name="type-aliasespointcampaignorderruletargetcustomerrankmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / PointCampaignOrderRuleTargetCustomerRank
+
+## Type Alias: PointCampaignOrderRuleTargetCustomerRank
+
+> **PointCampaignOrderRuleTargetCustomerRank**: `object`
+
+PointCampaignOrderRuleTargetCustomerRank は会員ランク種別のポイントキャンペーンの設定を表す。
+以下の場合はnullを返す
+- 開催期間中であるキャンペーンが存在しない場合
+- 存在するが種別が会員ランクではない場合
+- 未ログインの場合
+
+### Type declaration
+
+#### fixedPoint?
+
+> `optional` **fixedPoint**: `string`
+
+顧客に適用されるキャンペーン倍率
+以下の場合はnullを返す
+- 該当キャンペーンが存在しない場合
+- 未ログイン状態の場合
+- 計算方法が固定ポイントでない場合
+
+#### multiplier?
+
+> `optional` **multiplier**: `string`
+
+顧客に適用されるキャンペーン倍率
+以下の場合はnullを返す
+- 該当キャンペーンが存在しない場合
+- 未ログイン状態の場合
+- 計算方法が倍率でない場合
+
+#### pointCampaignOrderRule
+
+> **pointCampaignOrderRule**: [`PointCampaignOrderRule`](#type-aliasespointcampaignorderrulemd)
+
+
 <a name="type-aliasespointchangemd"></a>
 
 [**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
@@ -999,6 +1095,12 @@ Product は商品情報を表す。
 
 > **id**: `string`
 
+#### isLocalPickupAvailable
+
+> **isLocalPickupAvailable**: `boolean`
+
+商品の店舗受取が可能な場合にtrueが返る
+
 #### title
 
 > **title**: `string`
@@ -1036,14 +1138,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 }
@@ -177,6 +178,44 @@ export declare type PageInfo = {
     hasPreviousPage: boolean;
 };
 
+/**
+ * PointCampaignOrderRule はポイントキャンペーンの設定を表す。
+ */
+export declare type PointCampaignOrderRule = {
+    id: string;
+    /**
+     * キャンペーンのタイトル
+     */
+    title: string;
+};
+
+/**
+ * PointCampaignOrderRuleTargetCustomerRank は会員ランク種別のポイントキャンペーンの設定を表す。
+ * 以下の場合はnullを返す
+ * - 開催期間中であるキャンペーンが存在しない場合
+ * - 存在するが種別が会員ランクではない場合
+ * - 未ログインの場合
+ */
+export declare type PointCampaignOrderRuleTargetCustomerRank = {
+    pointCampaignOrderRule: PointCampaignOrderRule;
+    /**
+     * 顧客に適用されるキャンペーン倍率
+     * 以下の場合はnullを返す
+     * - 該当キャンペーンが存在しない場合
+     * - 未ログイン状態の場合
+     * - 計算方法が倍率でない場合
+     */
+    multiplier?: string;
+    /**
+     * 顧客に適用されるキャンペーン倍率
+     * 以下の場合はnullを返す
+     * - 該当キャンペーンが存在しない場合
+     * - 未ログイン状態の場合
+     * - 計算方法が固定ポイントでない場合
+     */
+    fixedPoint?: string;
+};
+
 /**
  * PointChange はポイントの変動を表す。
  */
@@ -273,6 +312,10 @@ export declare type Product = {
      * 商品が持つバリエーションに1つでも予約販売設定がされている場合trueが返る
      */
     hasBackOrderProductVariants: boolean;
+    /**
+     * 商品の店舗受取が可能な場合にtrueが返る
+     */
+    isLocalPickupAvailable: boolean;
     /**
      * 商品のバリエーション一覧
      */
@@ -284,8 +327,21 @@ export declare type Product = {
  */
 export declare type ProductVariant = {
     id: string;
+    /**
+     * 商品バリエーションのタイトル
+     */
     title: string;
+    /**
+     * 予約販売が設定されている場合にtrueが返る
+     */
     isBackOrderEnable: boolean;
+    /**
+     * 商品の店舗受取が可能な場合にtrueが返る
+     */
+    isLocalPickupAvailable: boolean;
+    /**
+     * 在庫情報
+     */
     inventoryItem: InventoryItem;
 };
 
@@ -390,11 +446,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 は購入者の割引情報を返します。
      *
@@ -430,6 +488,7 @@ export declare class SDK {
      */
     getPurchasingCustomerSharing(): Promise<PurchasingCustomerSharing | null>;
     getProduct(id: string, first?: number, after?: string, isReverse?: boolean, sortKeys?: ProductVariantSortKeys): Promise<Product | null>;
+    getPointCampaignOrderRuleTargetCustomerRank(): Promise<PointCampaignOrderRuleTargetCustomerRank | null>;
     /**
      * purchasingCustomerSendCustomerSharingActivationCode はログインしているアカウントのメールアドレスに顧客情報共有のためのアクティベーションコードを送信します。
      */