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

package/README.md

@@ -51,6 +51,46 @@ SDKは名前空間 `SQ` 内に存在するため、SDKの初期化は `new SQ.SD
 
 ### Methods
 
+#### getEstimatedShopifyCartLineItemPoint()
+
+> **getEstimatedShopifyCartLineItemPoint**(`currencyCode`, `taxesIncluded`, `sku`, `quantity`, `unitPrice`): `Promise`\<`null` \| [`EstimatedPoint`](#type-aliasesestimatedpointmd)\>
+
+##### Parameters
+
+• **currencyCode**: [`CurrencyCode`](#enumerationscurrencycodemd)
+
+• **taxesIncluded**: `boolean`
+
+• **sku**: `string`
+
+• **quantity**: `number`
+
+• **unitPrice**: `string`
+
+##### Returns
+
+`Promise`\<`null` \| [`EstimatedPoint`](#type-aliasesestimatedpointmd)\>
+
+***
+
+#### getEstimatedShopifyCartPoint()
+
+> **getEstimatedShopifyCartPoint**(`currencyCode`, `taxesIncluded`, `lineItems`): `Promise`\<`null` \| [`EstimatedPoint`](#type-aliasesestimatedpointmd)\>
+
+##### Parameters
+
+• **currencyCode**: [`CurrencyCode`](#enumerationscurrencycodemd)
+
+• **taxesIncluded**: `boolean`
+
+• **lineItems**: [`CartLineItem`](#type-aliasescartlineitemmd)[]
+
+##### Returns
+
+`Promise`\<`null` \| [`EstimatedPoint`](#type-aliasesestimatedpointmd)\>
+
+***
+
 #### getLocationAvailabilities()
 
 > **getLocationAvailabilities**(`sku`, `first`?, `after`?, `isReverse`?): `Promise`\<[`LocationAvailabilities`](#type-aliaseslocationavailabilitiesmd)\>
@@ -181,8 +221,7 @@ getPointChangeActivities は購入者のポイント変動履歴を返します
 
 > **getPoints**(): `Promise`\<`null` \| [`Points`](#type-aliasespointsmd)\>
 
-getPoints は、現在の保有ポイントと、獲得予定ポイントを返します。
-存在しない場合は0を返します。
+getPoints は、Points は SDK から取得できるポイントの情報を返します。
 
 ##### Returns
 
@@ -337,6 +376,39 @@ purchasingCustomerSendCustomerSharingActivationCode はログインしている
 
 `Promise`\<`null` \| [`CustomerSharingActivationCode`](#type-aliasescustomersharingactivationcodemd)\>
 
+# Enumerations
+
+
+<a name="enumerationscurrencycodemd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / CurrencyCode
+
+## Enumeration: CurrencyCode
+
+CurrencyCode は通貨コードを表す
+
+### Enumeration Members
+
+#### Eur
+
+> **Eur**: `"EUR"`
+
+***
+
+#### Jpy
+
+> **Jpy**: `"JPY"`
+
+***
+
+#### Usd
+
+> **Usd**: `"USD"`
+
 
 <a name="globalsmd"></a>
 
@@ -346,6 +418,10 @@ purchasingCustomerSendCustomerSharingActivationCode はログインしている
 
 # @builtbystack/sq-shopify-theme-sdk
 
+## Enumerations
+
+- [CurrencyCode](#enumerationscurrencycodemd)
+
 ## Classes
 
 - [SDK](#classessdkmd)
@@ -353,11 +429,13 @@ purchasingCustomerSendCustomerSharingActivationCode はログインしている
 ## Type Aliases
 
 - [Address](#type-aliasesaddressmd)
+- [CartLineItem](#type-aliasescartlineitemmd)
 - [CustomerRank](#type-aliasescustomerrankmd)
 - [CustomerRankCalculationCondition](#type-aliasescustomerrankcalculationconditionmd)
 - [CustomerRankCalculationPeriod](#type-aliasescustomerrankcalculationperiodmd)
 - [CustomerRankRule](#type-aliasescustomerrankrulemd)
 - [CustomerSharingActivationCode](#type-aliasescustomersharingactivationcodemd)
+- [EstimatedPoint](#type-aliasesestimatedpointmd)
 - [InventoryItem](#type-aliasesinventoryitemmd)
 - [Location](#type-aliaseslocationmd)
 - [LocationAvailabilities](#type-aliaseslocationavailabilitiesmd)
@@ -437,6 +515,41 @@ Address はLocationの住所を表す。
 > **provinceCode**: `string`
 
 
+<a name="type-aliasescartlineitemmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / CartLineItem
+
+## Type Alias: CartLineItem
+
+> **CartLineItem**: `object`
+
+CartLineItem はカートの商品明細情報を表す
+
+### Type declaration
+
+#### quantity
+
+> **quantity**: `number`
+
+商品の数量
+
+#### sku
+
+> **sku**: `string`
+
+商品のSKU
+
+#### unitPrice
+
+> **unitPrice**: `string`
+
+商品の単価
+
+
 <a name="type-aliasescustomerrankmd"></a>
 
 [**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
@@ -626,6 +739,27 @@ CustomerRankRule は会員ランクのルールを表す。
 > **purchasingCustomer**: [`PurchasingCustomer`](#type-aliasespurchasingcustomermd)
 
 
+<a name="type-aliasesestimatedpointmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / EstimatedPoint
+
+## Type Alias: EstimatedPoint
+
+> **EstimatedPoint**: `object`
+
+EstimatedPoint は獲得予想ポイントを表す
+
+### Type declaration
+
+#### pointsEarned
+
+> **pointsEarned**: `number`
+
+
 <a name="type-aliasesinventoryitemmd"></a>
 
 [**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
@@ -1062,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

@@ -13,6 +13,33 @@ export declare type Address = {
     address2: string;
 };
 
+/**
+ * CartLineItem はカートの商品明細情報を表す
+ */
+export declare type CartLineItem = {
+    /**
+     * 商品のSKU
+     */
+    sku: string;
+    /**
+     * 商品の数量
+     */
+    quantity: number;
+    /**
+     * 商品の単価
+     */
+    unitPrice: string;
+};
+
+/**
+ * CurrencyCode は通貨コードを表す
+ */
+export declare enum CurrencyCode {
+    Eur = "EUR",
+    Jpy = "JPY",
+    Usd = "USD"
+}
+
 /**
  * CustomerRank は会員ランクを表す。
  */
@@ -104,6 +131,13 @@ export declare type CustomerSharingActivationCode = {
     customerSharingActivationCodeID: string;
 };
 
+/**
+ * EstimatedPoint は獲得予想ポイントを表す
+ */
+export declare type EstimatedPoint = {
+    pointsEarned: number;
+};
+
 /**
  * InventoryItem は在庫情報を表す。
  */
@@ -297,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;
+    };
 };
 
 /**
@@ -439,8 +491,7 @@ export declare class SDK {
      */
     getPurchasingCustomerMetafield(namespace: string, key: string): Promise<PurchasingCustomerMetafield | null>;
     /**
-     * getPoints は、現在の保有ポイントと、獲得予定ポイントを返します。
-     * 存在しない場合は0を返します。
+     * getPoints は、Points は SDK から取得できるポイントの情報を返します。
      */
     getPoints(): Promise<Points | null>;
     /**
@@ -489,6 +540,8 @@ 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>;
+    getEstimatedShopifyCartPoint(currencyCode: CurrencyCode, taxesIncluded: boolean, lineItems: CartLineItem[]): Promise<EstimatedPoint | null>;
+    getEstimatedShopifyCartLineItemPoint(currencyCode: CurrencyCode, taxesIncluded: boolean, sku: string, quantity: number, unitPrice: string): Promise<EstimatedPoint | null>;
     /**
      * purchasingCustomerSendCustomerSharingActivationCode はログインしているアカウントのメールアドレスに顧客情報共有のためのアクティベーションコードを送信します。
      */