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

package/README.md

@@ -221,8 +221,7 @@ getPointChangeActivities は購入者のポイント変動履歴を返します
 
 > **getPoints**(): `Promise`\<`null` \| [`Points`](#type-aliasespointsmd)\>
 
-getPoints は、現在の保有ポイントと、獲得予定ポイントを返します。
-存在しない場合は0を返します。
+getPoints は、Points は SDK から取得できるポイントの情報を返します。
 
 ##### Returns
 
@@ -1197,6 +1196,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

@@ -331,6 +331,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,8 +491,7 @@ export declare class SDK {
      */
     getPurchasingCustomerMetafield(namespace: string, key: string): Promise<PurchasingCustomerMetafield | null>;
     /**
-     * getPoints は、現在の保有ポイントと、獲得予定ポイントを返します。
-     * 存在しない場合は0を返します。
+     * getPoints は、Points は SDK から取得できるポイントの情報を返します。
      */
     getPoints(): Promise<Points | null>;
     /**