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

package/README.md

@@ -91,6 +91,23 @@ SDKは名前空間 `SQ` 内に存在するため、SDKの初期化は `new SQ.SD
 
 ***
 
+#### getHasBackOrderProductVariants()
+
+> **getHasBackOrderProductVariants**(`id`): `Promise`\<`null` \| `boolean`\>
+
+getHasBackOrderProductVariants はIDで指定した商品が持つ商品バリエーションに1つでも予約販売設定がされている場合trueを返します。
+指定したIDの商品が存在しない場合はnullを返します。
+
+##### Parameters
+
+• **id**: `string`
+
+##### Returns
+
+`Promise`\<`null` \| `boolean`\>
+
+***
+
 #### getLocationAvailabilities()
 
 > **getLocationAvailabilities**(`sku`, `first`?, `after`?, `isReverse`?): `Promise`\<[`LocationAvailabilities`](#type-aliaseslocationavailabilitiesmd)\>
@@ -600,6 +617,12 @@ CustomerRank は会員ランクを表す。
 
 この会員ランクを算出した際の条件
 
+#### earnedPoint
+
+> **earnedPoint**: `number`
+
+現在時刻時点を含む算出期間における顧客のリアルタイムな獲得ポイント数
+
 #### earnedPointToRankUp
 
 > **earnedPointToRankUp**: `number`
@@ -634,6 +657,12 @@ CustomerRank は会員ランクを表す。
 
 この会員ランクの注文時ポイント倍率。ポイント設定がなかったり、ポイント設定があってもポイント倍率設定がなければnullが返る
 
+#### purchasePrice
+
+> **purchasePrice**: `number`
+
+現在時刻時点を含む算出期間における顧客のリアルタイムな購入金額
+
 #### purchasePriceToRankUp
 
 > **purchasePriceToRankUp**: `number`

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が返る
      */
@@ -318,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;
     /**
      * ポイントの発生日時
      */
@@ -355,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 {
@@ -438,6 +446,10 @@ export declare type ProductVariant = {
      * 商品バリエーションのタイトル
      */
     title: string;
+    /**
+     * 在庫情報
+     */
+    inventoryItem: InventoryItem;
     /**
      * 予約販売が設定されている場合にtrueが返る
      */
@@ -446,10 +458,6 @@ export declare type ProductVariant = {
      * 商品の店舗受取が可能な場合にtrueが返る
      */
     isLocalPickupAvailable: boolean;
-    /**
-     * 在庫情報
-     */
-    inventoryItem: InventoryItem;
 };
 
 /**
@@ -476,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がこの顧客で有効かどうかを表す。
@@ -593,6 +601,12 @@ export declare class SDK {
      */
     getPurchasingCustomerSharing(): Promise<PurchasingCustomerSharing | null>;
     getProduct(id: string, first?: number, after?: string, isReverse?: boolean, sortKeys?: ProductVariantSortKeys): Promise<Product | null>;
+    /**
+     * getHasBackOrderProductVariants はIDで指定した商品が持つ商品バリエーションに1つでも予約販売設定がされている場合trueを返します。
+     * 指定したIDの商品が存在しない場合はnullを返します。
+     * @param {string} [productShopifyLegacyResourceID] 商品のShopifyLegacyResourceID(gid://shopify/Product/xxxのxxxの部分)
+     */
+    getHasBackOrderProductVariants(id: string): Promise<boolean | 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>;