@builtbystack/sq-shopify-theme-sdk 0.0.24 → 0.0.27

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。
@@ -221,8 +217,7 @@ getPointChangeActivities は購入者のポイント変動履歴を返します
 
 > **getPoints**(): `Promise`\<`null` \| [`Points`](#type-aliasespointsmd)\>
 
-getPoints は、現在の保有ポイントと、獲得予定ポイントを返します。
-存在しない場合は0を返します。
+getPoints は、Points は SDK から取得できるポイントの情報を返します。
 
 ##### Returns
 
@@ -411,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**
@@ -422,6 +446,7 @@ CurrencyCode は通貨コードを表す
 ## Enumerations
 
 - [CurrencyCode](#enumerationscurrencycodemd)
+- [LocationType](#enumerationslocationtypemd)
 
 ## Classes
 
@@ -437,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)
@@ -756,9 +783,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>
@@ -881,6 +948,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**
@@ -968,6 +1070,18 @@ PointCampaignOrderRule はポイントキャンペーンの設定を表す。
 
 > **id**: `string`
 
+#### pointMethod
+
+> **pointMethod**: `string`
+
+キャンペーンポイントの計算方法
+
+#### targetType
+
+> **targetType**: `string`
+
+キャンペーンポイント付与対象の種別
+
 #### title
 
 > **title**: `string`
@@ -1197,6 +1311,31 @@ Points は SDK から取得できるポイントの情報を表す。
 
 PointsApproved は保有ポイントを表す。
 
+#### pointsExpiringSoon?
+
+> `optional` **pointsExpiringSoon**: `object`
+
+PointsExpiringSoon は最も直近の失効予定ポイントを表す。
+
+#### pointsExpiringSoon.availableUntil
+
+> **availableUntil**: `Date`
+
+availableUntil は最も直近の失効予定ポイントが利用できる期限を表す。失効する直前を表すため、expiresDate から1ナノ秒を引いた値となる。
+例えば、expiresDate が 2024-06-12 00:00:00 なら、availableUntil は 2024-06-11 23:59:59.999999999 となる。
+
+#### pointsExpiringSoon.expiresDate
+
+> **expiresDate**: `Date`
+
+expiresDate は最も直近の失効日を表す。
+
+#### pointsExpiringSoon.points
+
+> **points**: `number`
+
+points は最も直近の失効予定ポイントを表す。
+
 #### pointsPending
 
 > **pointsPending**: `number`

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

@@ -135,7 +135,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 +200,24 @@ export declare type LocationAvailability = {
     inventoryQuantity: number;
 };
 
+/**
+ * LocationType はロケーションのフィルタリング条件を表現するオブジェクト
+ */
+export declare type LocationFilter = {
+    /**
+     * ロケーションの種別
+     */
+    locationType?: LocationType;
+    /**
+     * ロケーションのタグ
+     */
+    tag?: string;
+    /**
+     * ロケーションの都道府県コード
+     */
+    provinceCodes?: string[];
+};
+
 /**
  * Locations は Location の一覧を取得するための情報を表す。
  */
@@ -189,6 +226,16 @@ export declare type Locations = {
     pageInfo: PageInfo;
 };
 
+/**
+ * LocationType はロケーションの種別を表す
+ */
+export declare enum LocationType {
+    /** 店舗 */
+    Retail = "RETAIL",
+    /** 倉庫 */
+    Warehouse = "WAREHOUSE"
+}
+
 /**
  * PageInfo はページングを伴って一覧を取得したときに、その一覧のページングの情報を表す。
  */
@@ -221,6 +268,14 @@ export declare type PointCampaignOrderRule = {
      * キャンペーンのタイトル
      */
     title: string;
+    /**
+     * キャンペーンポイントの計算方法
+     */
+    pointMethod: string;
+    /**
+     * キャンペーンポイント付与対象の種別
+     */
+    targetType: string;
 };
 
 /**
@@ -331,6 +386,24 @@ export declare type Points = {
      * PointsPending は獲得予定ポイントを表す。
      */
     pointsPending: number;
+    /**
+     * PointsExpiringSoon は最も直近の失効予定ポイントを表す。
+     */
+    pointsExpiringSoon?: {
+        /**
+         * points は最も直近の失効予定ポイントを表す。
+         */
+        points: number;
+        /**
+         * expiresDate は最も直近の失効日を表す。
+         */
+        expiresDate: Date;
+        /**
+         * availableUntil は最も直近の失効予定ポイントが利用できる期限を表す。失効する直前を表すため、expiresDate から1ナノ秒を引いた値となる。
+         * 例えば、expiresDate が 2024-06-12 00:00:00 なら、availableUntil は 2024-06-11 23:59:59.999999999 となる。
+         */
+        availableUntil: Date;
+    };
 };
 
 /**
@@ -473,20 +546,18 @@ export declare class SDK {
      */
     getPurchasingCustomerMetafield(namespace: string, key: string): Promise<PurchasingCustomerMetafield | null>;
     /**
-     * getPoints は、現在の保有ポイントと、獲得予定ポイントを返します。
-     * 存在しない場合は0を返します。
+     * getPoints は、Points は SDK から取得できるポイントの情報を返します。
      */
     getPoints(): Promise<Points | null>;
     /**
      * 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 は購入者の割引情報を返します。
      *