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

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)\>
@@ -137,6 +177,16 @@ getLocations は ShopifyIntegration に紐づく LocationGroup の Location の
 
 ***
 
+#### getPointCampaignOrderRuleTargetCustomerRank()
+
+> **getPointCampaignOrderRuleTargetCustomerRank**(): `Promise`\<`null` \| [`PointCampaignOrderRuleTargetCustomerRank`](#type-aliasespointcampaignorderruletargetcustomerrankmd)\>
+
+##### Returns
+
+`Promise`\<`null` \| [`PointCampaignOrderRuleTargetCustomerRank`](#type-aliasespointcampaignorderruletargetcustomerrankmd)\>
+
+***
+
 #### getPointChangeActivities()
 
 > **getPointChangeActivities**(`first`?, `after`?, `isReverse`?, `sortKeys`?): `Promise`\<`null` \| [`PointChangeActivities`](#type-aliasespointchangeactivitiesmd)\>
@@ -327,6 +377,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>
 
@@ -336,6 +419,10 @@ purchasingCustomerSendCustomerSharingActivationCode はログインしている
 
 # @builtbystack/sq-shopify-theme-sdk
 
+## Enumerations
+
+- [CurrencyCode](#enumerationscurrencycodemd)
+
 ## Classes
 
 - [SDK](#classessdkmd)
@@ -343,17 +430,21 @@ 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)
 - [LocationAvailability](#type-aliaseslocationavailabilitymd)
 - [Locations](#type-aliaseslocationsmd)
 - [PageInfo](#type-aliasespageinfomd)
+- [PointCampaignOrderRule](#type-aliasespointcampaignorderrulemd)
+- [PointCampaignOrderRuleTargetCustomerRank](#type-aliasespointcampaignorderruletargetcustomerrankmd)
 - [PointChange](#type-aliasespointchangemd)
 - [PointChangeActivities](#type-aliasespointchangeactivitiesmd)
 - [PointChangeActivity](#type-aliasespointchangeactivitymd)
@@ -425,6 +516,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**
@@ -614,6 +740,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**
@@ -801,6 +948,78 @@ hasPreviousPage は前のページがあるかどうかを表す。
 startCursor は一覧の先頭のカーソルを表す。
 
 
+<a name="type-aliasespointcampaignorderrulemd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / PointCampaignOrderRule
+
+## Type Alias: PointCampaignOrderRule
+
+> **PointCampaignOrderRule**: `object`
+
+PointCampaignOrderRule はポイントキャンペーンの設定を表す。
+
+### Type declaration
+
+#### id
+
+> **id**: `string`
+
+#### title
+
+> **title**: `string`
+
+キャンペーンのタイトル
+
+
+<a name="type-aliasespointcampaignorderruletargetcustomerrankmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / PointCampaignOrderRuleTargetCustomerRank
+
+## Type Alias: PointCampaignOrderRuleTargetCustomerRank
+
+> **PointCampaignOrderRuleTargetCustomerRank**: `object`
+
+PointCampaignOrderRuleTargetCustomerRank は会員ランク種別のポイントキャンペーンの設定を表す。
+以下の場合はnullを返す
+- 開催期間中であるキャンペーンが存在しない場合
+- 存在するが種別が会員ランクではない場合
+- 未ログインの場合
+
+### Type declaration
+
+#### fixedPoint?
+
+> `optional` **fixedPoint**: `string`
+
+顧客に適用されるキャンペーン倍率
+以下の場合はnullを返す
+- 該当キャンペーンが存在しない場合
+- 未ログイン状態の場合
+- 計算方法が固定ポイントでない場合
+
+#### multiplier?
+
+> `optional` **multiplier**: `string`
+
+顧客に適用されるキャンペーン倍率
+以下の場合はnullを返す
+- 該当キャンペーンが存在しない場合
+- 未ログイン状態の場合
+- 計算方法が倍率でない場合
+
+#### pointCampaignOrderRule
+
+> **pointCampaignOrderRule**: [`PointCampaignOrderRule`](#type-aliasespointcampaignorderrulemd)
+
+
 <a name="type-aliasespointchangemd"></a>
 
 [**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**

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 は在庫情報を表す。
  */
@@ -178,6 +212,44 @@ export declare type PageInfo = {
     hasPreviousPage: boolean;
 };
 
+/**
+ * PointCampaignOrderRule はポイントキャンペーンの設定を表す。
+ */
+export declare type PointCampaignOrderRule = {
+    id: string;
+    /**
+     * キャンペーンのタイトル
+     */
+    title: string;
+};
+
+/**
+ * PointCampaignOrderRuleTargetCustomerRank は会員ランク種別のポイントキャンペーンの設定を表す。
+ * 以下の場合はnullを返す
+ * - 開催期間中であるキャンペーンが存在しない場合
+ * - 存在するが種別が会員ランクではない場合
+ * - 未ログインの場合
+ */
+export declare type PointCampaignOrderRuleTargetCustomerRank = {
+    pointCampaignOrderRule: PointCampaignOrderRule;
+    /**
+     * 顧客に適用されるキャンペーン倍率
+     * 以下の場合はnullを返す
+     * - 該当キャンペーンが存在しない場合
+     * - 未ログイン状態の場合
+     * - 計算方法が倍率でない場合
+     */
+    multiplier?: string;
+    /**
+     * 顧客に適用されるキャンペーン倍率
+     * 以下の場合はnullを返す
+     * - 該当キャンペーンが存在しない場合
+     * - 未ログイン状態の場合
+     * - 計算方法が固定ポイントでない場合
+     */
+    fixedPoint?: string;
+};
+
 /**
  * PointChange はポイントの変動を表す。
  */
@@ -450,6 +522,9 @@ 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 はログインしているアカウントのメールアドレスに顧客情報共有のためのアクティベーションコードを送信します。
      */