@builtbystack/sq-shopify-theme-sdk 0.0.25 → 0.0.28

package/README.md

@@ -145,20 +145,12 @@ getLocationAvailability は渡されたSKUとLocationIDにおける在庫情報
 
 #### getLocations()
 
-> **getLocations**(`tag`?, `provinceCodes`?, `first`?, `after`?, `isReverse`?): `Promise`\<[`Locations`](#type-aliaseslocationsmd)\>
+> **getLocations**(`first`?, `after`?, `locationFilter`?, `isReverse`?): `Promise`\<[`Locations`](#type-aliaseslocationsmd)\>
 
 getLocations は ShopifyIntegration に紐づく LocationGroup の Location の一覧を取得します。
 
 ##### Parameters
 
-• **tag?**: `string`
-
-取得したいLocationのタグ。
-
-• **provinceCodes?**: `string`[]
-
-取得したいLocationの都道府県コード。
-
 • **first?**: `number`
 
 取得してくる個数。デフォルトは250。
@@ -167,6 +159,10 @@ getLocations は ShopifyIntegration に紐づく LocationGroup の Location の
 
 ページングの値。指定しない場合先頭から取得してくる。
 
+• **locationFilter?**: [`LocationFilter`](#type-aliaseslocationfiltermd)
+
+ロケーションのロケーションのフィルタリング条件。
+
 • **isReverse?**: `boolean`
 
 並び順。デフォルトはfalse。
@@ -410,6 +406,35 @@ CurrencyCode は通貨コードを表す
 > **Usd**: `"USD"`
 
 
+<a name="enumerationslocationtypemd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / LocationType
+
+## Enumeration: LocationType
+
+LocationType はロケーションの種別を表す
+
+### Enumeration Members
+
+#### Retail
+
+> **Retail**: `"RETAIL"`
+
+店舗
+
+***
+
+#### Warehouse
+
+> **Warehouse**: `"WAREHOUSE"`
+
+倉庫
+
+
 <a name="globalsmd"></a>
 
 [**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
@@ -421,6 +446,7 @@ CurrencyCode は通貨コードを表す
 ## Enumerations
 
 - [CurrencyCode](#enumerationscurrencycodemd)
+- [LocationType](#enumerationslocationtypemd)
 
 ## Classes
 
@@ -436,10 +462,12 @@ CurrencyCode は通貨コードを表す
 - [CustomerRankRule](#type-aliasescustomerrankrulemd)
 - [CustomerSharingActivationCode](#type-aliasescustomersharingactivationcodemd)
 - [EstimatedPoint](#type-aliasesestimatedpointmd)
+- [EstimatedPointCampaign](#type-aliasesestimatedpointcampaignmd)
 - [InventoryItem](#type-aliasesinventoryitemmd)
 - [Location](#type-aliaseslocationmd)
 - [LocationAvailabilities](#type-aliaseslocationavailabilitiesmd)
 - [LocationAvailability](#type-aliaseslocationavailabilitymd)
+- [LocationFilter](#type-aliaseslocationfiltermd)
 - [Locations](#type-aliaseslocationsmd)
 - [PageInfo](#type-aliasespageinfomd)
 - [PointCampaignOrderRule](#type-aliasespointcampaignorderrulemd)
@@ -572,6 +600,12 @@ CustomerRank は会員ランクを表す。
 
 この会員ランクを算出した際の条件
 
+#### earnedPoint
+
+> **earnedPoint**: `number`
+
+現在時刻時点を含む算出期間における顧客のリアルタイムな獲得ポイント数
+
 #### earnedPointToRankUp
 
 > **earnedPointToRankUp**: `number`
@@ -606,6 +640,12 @@ CustomerRank は会員ランクを表す。
 
 この会員ランクの注文時ポイント倍率。ポイント設定がなかったり、ポイント設定があってもポイント倍率設定がなければnullが返る
 
+#### purchasePrice
+
+> **purchasePrice**: `number`
+
+現在時刻時点を含む算出期間における顧客のリアルタイムな購入金額
+
 #### purchasePriceToRankUp
 
 > **purchasePriceToRankUp**: `number`
@@ -755,9 +795,49 @@ EstimatedPoint は獲得予想ポイントを表す
 
 ### Type declaration
 
-#### pointsEarned
+#### pointCampaign?
+
+> `optional` **pointCampaign**: [`EstimatedPointCampaign`](#type-aliasesestimatedpointcampaignmd)
+
+適用されるポイントキャンペーン
+注文日時に開催期間内で条件を満たすキャンペーンが存在しなかった場合はnilを返す
+カートの場合、明細ごとのポイント計算ロジック内でポイントが加算されるため、ポイントキャンペーンの種別が「商品」の場合もnilを返す
+商品に適用されるポイントキャンペーンはgetEstimatedShopifyCartLineItemPointから取得が可能
+
+#### pointsEarning
+
+> **pointsEarning**: `number`
+
+ポイントキャンペーン適用前の獲得予想ポイント
+
+#### totalPointsEarning
+
+> **totalPointsEarning**: `number`
+
+ポイントキャンペーン適用後の獲得予想ポイント
+
+
+<a name="type-aliasesestimatedpointcampaignmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / EstimatedPointCampaign
+
+## Type Alias: EstimatedPointCampaign
+
+> **EstimatedPointCampaign**: `object`
+
+### Type declaration
+
+#### pointCampaignOrderRule
+
+> **pointCampaignOrderRule**: [`PointCampaignOrderRule`](#type-aliasespointcampaignorderrulemd)
+
+#### pointsEarning
 
-> **pointsEarned**: `number`
+> **pointsEarning**: `number`
 
 
 <a name="type-aliasesinventoryitemmd"></a>
@@ -880,6 +960,41 @@ inventoryQuantity は在庫数を表す。
 location は在庫のLocationを表す。
 
 
+<a name="type-aliaseslocationfiltermd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / LocationFilter
+
+## Type Alias: LocationFilter
+
+> **LocationFilter**: `object`
+
+LocationType はロケーションのフィルタリング条件を表現するオブジェクト
+
+### Type declaration
+
+#### locationType?
+
+> `optional` **locationType**: [`LocationType`](#enumerationslocationtypemd)
+
+ロケーションの種別
+
+#### provinceCodes?
+
+> `optional` **provinceCodes**: `string`[]
+
+ロケーションの都道府県コード
+
+#### tag?
+
+> `optional` **tag**: `string`
+
+ロケーションのタグ
+
+
 <a name="type-aliaseslocationsmd"></a>
 
 [**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
@@ -967,6 +1082,18 @@ PointCampaignOrderRule はポイントキャンペーンの設定を表す。
 
 > **id**: `string`
 
+#### pointMethod
+
+> **pointMethod**: `string`
+
+キャンペーンポイントの計算方法
+
+#### targetType
+
+> **targetType**: `string`
+
+キャンペーンポイント付与対象の種別
+
 #### title
 
 > **title**: `string`

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

@@ -50,13 +50,9 @@ export declare type CustomerRank = {
      */
     name: string;
     /**
-     * この会員ランクを算出した際の条件
-     */
-    calculationCondition: CustomerRankCalculationCondition;
-    /**
-     * ランクアップするために必要な残り獲得ポイント
+     * この会員ランクへのランクアップに必要な値。会員ランクの算出方法によりthresholdが指す値は異なり、獲得ポイントと購入金額のどちらかになる
      */
-    earnedPointToRankUp: number;
+    threshold: number;
     /**
      * この会員ランクの一段階上の会員ランク。上の会員ランクが存在しない場合はnull
      */
@@ -65,14 +61,26 @@ export declare type CustomerRank = {
      * この会員ランクの一段階下の会員ランク。下の会員ランクが存在しない場合はnull
      */
     lowerRank?: CustomerRankRule;
+    /**
+     * 現在時刻時点を含む算出期間における顧客のリアルタイムな獲得ポイント数
+     */
+    earnedPoint: number;
+    /**
+     * 現在時刻時点を含む算出期間における顧客のリアルタイムな購入金額
+     */
+    purchasePrice: number;
+    /**
+     * ランクアップするために必要な残り獲得ポイント
+     */
+    earnedPointToRankUp: number;
     /**
      * ランクアップするために必要な残り購入金額
      */
     purchasePriceToRankUp: number;
     /**
-     * この会員ランクへのランクアップに必要な値。会員ランクの算出方法によりthresholdが指す値は異なり、獲得ポイントと購入金額のどちらかになる
+     * この会員ランクを算出した際の条件
      */
-    threshold: number;
+    calculationCondition: CustomerRankCalculationCondition;
     /**
      * この会員ランクの注文時ポイント倍率。ポイント設定がなかったり、ポイント設定があってもポイント倍率設定がなければnullが返る
      */
@@ -135,7 +143,26 @@ export declare type CustomerSharingActivationCode = {
  * EstimatedPoint は獲得予想ポイントを表す
  */
 export declare type EstimatedPoint = {
-    pointsEarned: number;
+    /**
+     * ポイントキャンペーン適用前の獲得予想ポイント
+     */
+    pointsEarning: number;
+    /**
+     * ポイントキャンペーン適用後の獲得予想ポイント
+     */
+    totalPointsEarning: number;
+    /**
+     * 適用されるポイントキャンペーン
+     * 注文日時に開催期間内で条件を満たすキャンペーンが存在しなかった場合はnilを返す
+     * カートの場合、明細ごとのポイント計算ロジック内でポイントが加算されるため、ポイントキャンペーンの種別が「商品」の場合もnilを返す
+     * 商品に適用されるポイントキャンペーンはgetEstimatedShopifyCartLineItemPointから取得が可能
+     */
+    pointCampaign?: EstimatedPointCampaign;
+};
+
+export declare type EstimatedPointCampaign = {
+    pointsEarning: number;
+    pointCampaignOrderRule: PointCampaignOrderRule;
 };
 
 /**
@@ -181,6 +208,24 @@ export declare type LocationAvailability = {
     inventoryQuantity: number;
 };
 
+/**
+ * LocationType はロケーションのフィルタリング条件を表現するオブジェクト
+ */
+export declare type LocationFilter = {
+    /**
+     * ロケーションの種別
+     */
+    locationType?: LocationType;
+    /**
+     * ロケーションのタグ
+     */
+    tag?: string;
+    /**
+     * ロケーションの都道府県コード
+     */
+    provinceCodes?: string[];
+};
+
 /**
  * Locations は Location の一覧を取得するための情報を表す。
  */
@@ -189,6 +234,16 @@ export declare type Locations = {
     pageInfo: PageInfo;
 };
 
+/**
+ * LocationType はロケーションの種別を表す
+ */
+export declare enum LocationType {
+    /** 店舗 */
+    Retail = "RETAIL",
+    /** 倉庫 */
+    Warehouse = "WAREHOUSE"
+}
+
 /**
  * PageInfo はページングを伴って一覧を取得したときに、その一覧のページングの情報を表す。
  */
@@ -221,6 +276,14 @@ export declare type PointCampaignOrderRule = {
      * キャンペーンのタイトル
      */
     title: string;
+    /**
+     * キャンペーンポイントの計算方法
+     */
+    pointMethod: string;
+    /**
+     * キャンペーンポイント付与対象の種別
+     */
+    targetType: string;
 };
 
 /**
@@ -263,15 +326,15 @@ export declare type PointChange = {
      * ポイントが利用可能になる日時。nilの場合はまだ利用可能になる日時が決まっていない。主に未配送注文に関するポイントはnilになる。
      */
     availableAt?: Date;
+    /**
+     * ポイントの失効日。nilの場合はまだ失効日が決まっていない。ポイント消費や、未配送注文に関するポイントはnilになる。
+     */
+    expiresDate?: Date;
     /**
      * ポイントが利用できる期限。失効する直前を表すため、expiresDateから1ナノ秒を引いた値となる。
      * 例えば、expiresDateが 2024-06-12 00:00:00 なら、availableUntilは 2024-06-11 23:59:59.999999999 となる。
      */
     availableUntil?: Date;
-    /**
-     * ポイントの失効日。nilの場合はまだ失効日が決まっていない。ポイント消費や、未配送注文に関するポイントはnilになる。
-     */
-    expiresDate?: Date;
     /**
      * ポイントの発生日時
      */
@@ -300,9 +363,9 @@ export declare type PointChangeActivities = {
 export declare type PointChangeActivity = {
     id: string;
     title: string;
+    tenant: Tenant;
     pointChange: PointChange;
     retailLocation?: Location_2;
-    tenant: Tenant;
 };
 
 declare enum PointChangeActivitySortKey {
@@ -383,6 +446,10 @@ export declare type ProductVariant = {
      * 商品バリエーションのタイトル
      */
     title: string;
+    /**
+     * 在庫情報
+     */
+    inventoryItem: InventoryItem;
     /**
      * 予約販売が設定されている場合にtrueが返る
      */
@@ -391,10 +458,6 @@ export declare type ProductVariant = {
      * 商品の店舗受取が可能な場合にtrueが返る
      */
     isLocalPickupAvailable: boolean;
-    /**
-     * 在庫情報
-     */
-    inventoryItem: InventoryItem;
 };
 
 /**
@@ -421,11 +484,11 @@ export declare type PurchasingCustomer = {
 export declare type PurchasingCustomerDiscount = {
     id: string;
     title: string;
-    description: string;
     /**
      * Discountのステータス。"ACTIVE", "SCHEDULED", "EXPIRED" のいずれかが入る。
      */
     status: string;
+    description: string;
     code: string;
     /**
      * Discountがこの顧客で有効かどうかを表す。
@@ -497,13 +560,12 @@ export declare class SDK {
     /**
      * getLocations は ShopifyIntegration に紐づく LocationGroup の Location の一覧を取得します。
      *
-     * @param {string} [tag] 取得したいLocationのタグ。
-     * @param {string[]} [provinceCodes] 取得したいLocationの都道府県コード。
      * @param {number} [first] 取得してくる個数。デフォルトは250。
      * @param {string} [after] ページングの値。指定しない場合先頭から取得してくる。
+     * @param {LocationFilter} [locationFilter] ロケーションのロケーションのフィルタリング条件。
      * @param {boolean} [isReverse] 並び順。デフォルトはfalse。
      */
-    getLocations(tag?: string, provinceCodes?: string[], first?: number, after?: string, isReverse?: boolean): Promise<Locations>;
+    getLocations(first?: number, after?: string, locationFilter?: LocationFilter, isReverse?: boolean): Promise<Locations>;
     /**
      * getPurchasingCustomerDiscounts は購入者の割引情報を返します。
      *