@builtbystack/sq-shopify-theme-sdk 0.0.7 → 0.0.9

package/README.md

@@ -239,6 +239,7 @@ getPurchasingCustomerMetafield は渡されたnamespaceとkeyに一致する現
 
 ## Type Aliases
 
+- [Address](#type-aliasesaddressmd)
 - [CustomerRank](#type-aliasescustomerrankmd)
 - [CustomerRankCalculationCondition](#type-aliasescustomerrankcalculationconditionmd)
 - [CustomerRankCalculationPeriod](#type-aliasescustomerrankcalculationperiodmd)
@@ -260,6 +261,59 @@ getPurchasingCustomerMetafield は渡されたnamespaceとkeyに一致する現
 # Type Aliases
 
 
+<a name="type-aliasesaddressmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / Address
+
+## Type Alias: Address
+
+> **Address**: `object`
+
+Address はLocationの住所を表す。
+
+### Type declaration
+
+#### address1
+
+> **address1**: `string`
+
+#### address2
+
+> **address2**: `string`
+
+#### city
+
+> **city**: `string`
+
+#### country
+
+> **country**: `string`
+
+#### countryCode
+
+> **countryCode**: `string`
+
+#### id
+
+> **id**: `string`
+
+#### postalCode
+
+> **postalCode**: `string`
+
+#### province
+
+> **province**: `string`
+
+#### provinceCode
+
+> **provinceCode**: `string`
+
+
 <a name="type-aliasescustomerrankmd"></a>
 
 [**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
@@ -280,14 +334,20 @@ CustomerRank は会員ランクを表す。
 
 > **calculationCondition**: [`CustomerRankCalculationCondition`](#type-aliasescustomerrankcalculationconditionmd)
 
+この会員ランクを算出した際の条件
+
 #### earnedPointToRankUp
 
 > **earnedPointToRankUp**: `number`
 
+ランクアップするために必要な残り獲得ポイント
+
 #### higherRank?
 
 > `optional` **higherRank**: [`CustomerRankRule`](#type-aliasescustomerrankrulemd)
 
+この会員ランクの一段階上の会員ランク。上の会員ランクが存在しない場合はnull
+
 #### id
 
 > **id**: `string`
@@ -296,22 +356,32 @@ CustomerRank は会員ランクを表す。
 
 > `optional` **lowerRank**: [`CustomerRankRule`](#type-aliasescustomerrankrulemd)
 
+この会員ランクの一段階下の会員ランク。下の会員ランクが存在しない場合はnull
+
 #### name
 
 > **name**: `string`
 
+会員ランク名
+
 #### pointMultiplier?
 
 > `optional` **pointMultiplier**: [`PointMultiplierCustomerRankRule`](#type-aliasespointmultipliercustomerrankrulemd)
 
+この会員ランクの注文時ポイント倍率。ポイント設定がなかったり、ポイント設定があってもポイント倍率設定がなければnullが返る
+
 #### purchasePriceToRankUp
 
 > **purchasePriceToRankUp**: `number`
 
+ランクアップするために必要な残り購入金額
+
 #### threshold
 
 > **threshold**: `number`
 
+この会員ランクへのランクアップに必要な値。会員ランクの算出方法によりthresholdが指す値は異なり、獲得ポイントと購入金額のどちらかになる
+
 
 <a name="type-aliasescustomerrankcalculationconditionmd"></a>
 
@@ -333,14 +403,20 @@ CustomerRankCalculationCondition は会員ランクの算出条件を表す。
 
 > `optional` **customerRankCalculationPeriod**: [`CustomerRankCalculationPeriod`](#type-aliasescustomerrankcalculationperiodmd)
 
+会員ランク算出期間。期間が無期限の場合はnullを返す
+
 #### earnedPoint
 
 > **earnedPoint**: `number`
 
+会員ランクの算出根拠となる獲得ポイント
+
 #### purchasePrice
 
 > **purchasePrice**: `number`
 
+会員ランクの算出根拠となる購入金額
+
 
 <a name="type-aliasescustomerrankcalculationperiodmd"></a>
 
@@ -362,10 +438,14 @@ CustomerRankCalculationPeriod は会員ランクの算出期間を表す。
 
 > **end**: `Date`
 
+集計期間終了日
+
 #### start
 
 > **start**: `Date`
 
+集計期間開始日
+
 
 <a name="type-aliasescustomerrankrulemd"></a>
 
@@ -391,10 +471,14 @@ CustomerRankRule は会員ランクのルールを表す。
 
 > **name**: `string`
 
+会員ランク名
+
 #### threshold
 
 > **threshold**: `number`
 
+この会員ランクへのランクアップに必要な値。会員ランクの算出方法によりthresholdが指す値は異なり、獲得ポイントと購入金額のどちらかになる。
+
 
 <a name="type-aliaseslocationmd"></a>
 
@@ -412,6 +496,10 @@ Location は ShopifyIntegration に紐付いている Location を表す。
 
 ### Type declaration
 
+#### address?
+
+> `optional` **address**: [`Address`](#type-aliasesaddressmd)
+
 #### id
 
 > **id**: `string`
@@ -420,6 +508,10 @@ Location は ShopifyIntegration に紐付いている Location を表す。
 
 > **name**: `string`
 
+#### phone
+
+> **phone**: `string`
+
 
 <a name="type-aliaseslocationavailabilitiesmd"></a>
 
@@ -470,16 +562,10 @@ inventoryQuantity は在庫数を表す。
 
 #### location
 
-> **location**: `object`
+> **location**: [`Location`](#type-aliaseslocationmd)
 
 location は在庫のLocationを表す。
 
-#### location.name
-
-> **name**: `string`
-
-name はLocationの名前を表す。
-
 
 <a name="type-aliaseslocationsmd"></a>
 
@@ -568,22 +654,33 @@ PointChange はポイントの変動を表す。
 
 > `optional` **availableAt**: `Date`
 
+ポイントが利用可能になる日時。nilの場合はまだ利用可能になる日時が決まっていない。主に未配送注文に関するポイントはnilになる。
+
 #### availableUntil?
 
 > `optional` **availableUntil**: `Date`
 
+ポイントが利用できる期限。失効する直前を表すため、expiresDateから1ナノ秒を引いた値となる。
+例えば、expiresDateが 2024-06-12 00:00:00 なら、availableUntilは 2024-06-11 23:59:59.999999999 となる。
+
 #### createdAt
 
 > **createdAt**: `Date`
 
+PointChangeのコミットタイムスタンプ
+
 #### delta
 
 > **delta**: `number`
 
+ポイント変動の数値。正負どちらの値も取りうる。
+
 #### expiresDate?
 
 > `optional` **expiresDate**: `Date`
 
+ポイントの失効日。nilの場合はまだ失効日が決まっていない。ポイント消費や、未配送注文に関するポイントはnilになる。
+
 #### id
 
 > **id**: `string`
@@ -592,6 +689,8 @@ PointChange はポイントの変動を表す。
 
 > **pointChangeCreatedAt**: `Date`
 
+ポイントの発生日時
+
 
 <a name="type-aliasespointchangeactivitiesmd"></a>
 
@@ -605,6 +704,8 @@ PointChange はポイントの変動を表す。
 
 > **PointChangeActivities**: `object`
 
+PointChangeActivities はポイントの変動の履歴一覧を表す。
+
 ### Type declaration
 
 #### nodes
@@ -694,10 +795,14 @@ Points は SDK から取得できるポイントの情報を表す。
 
 > **pointsApproved**: `number`
 
+PointsApproved は保有ポイントを表す。
+
 #### pointsPending
 
 > **pointsPending**: `number`
 
+PointsPending は獲得予定ポイントを表す。
+
 
 <a name="type-aliasespurchasingcustomerdiscountmd"></a>
 
@@ -727,10 +832,24 @@ PurchasingCustomerDiscount は購入者の割引情報を表す。
 
 > **description**: `string`
 
+#### endsAt
+
+> **endsAt**: `Date`
+
 #### id
 
 > **id**: `string`
 
+#### startsAt
+
+> **startsAt**: `Date`
+
+#### status
+
+> **status**: `string`
+
+Discountのステータス。"ACTIVE", "SCHEDULED", "EXPIRED" のいずれかが入る。
+
 #### title
 
 > **title**: `string`
@@ -752,7 +871,7 @@ PurchasingCustomerDiscount は購入者の割引情報を表す。
 
 > **PurchasingCustomerDiscounts**: `object`
 
-DiscountCodes は PurchasingCustomerDiscount の一覧を取得するための情報を表す。
+PurchasingCustomerDiscounts は PurchasingCustomerDiscount の一覧を取得するための情報を表す。
 
 ### Type declaration
 

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

@@ -1,15 +1,54 @@
+/**
+ * Address はLocationの住所を表す。
+ */
+export declare type Address = {
+    id: string;
+    countryCode: string;
+    country: string;
+    postalCode: string;
+    provinceCode: string;
+    province: string;
+    city: string;
+    address1: string;
+    address2: string;
+};
+
 /**
  * CustomerRank は会員ランクを表す。
  */
 export declare type CustomerRank = {
     id: string;
+    /**
+     * 会員ランク名
+     */
     name: string;
+    /**
+     * この会員ランクを算出した際の条件
+     */
     calculationCondition: CustomerRankCalculationCondition;
+    /**
+     * ランクアップするために必要な残り獲得ポイント
+     */
     earnedPointToRankUp: number;
+    /**
+     * この会員ランクの一段階上の会員ランク。上の会員ランクが存在しない場合はnull
+     */
     higherRank?: CustomerRankRule;
+    /**
+     * この会員ランクの一段階下の会員ランク。下の会員ランクが存在しない場合はnull
+     */
     lowerRank?: CustomerRankRule;
+    /**
+     * ランクアップするために必要な残り購入金額
+     */
     purchasePriceToRankUp: number;
+    /**
+     * この会員ランクへのランクアップに必要な値。会員ランクの算出方法によりthresholdが指す値は異なり、獲得ポイントと購入金額のどちらかになる
+     */
     threshold: number;
+    /**
+     * この会員ランクの注文時ポイント倍率。ポイント設定がなかったり、ポイント設定があってもポイント倍率設定がなければnullが返る
+     */
     pointMultiplier?: PointMultiplierCustomerRankRule;
 };
 
@@ -17,8 +56,17 @@ export declare type CustomerRank = {
  * CustomerRankCalculationCondition は会員ランクの算出条件を表す。
  */
 export declare type CustomerRankCalculationCondition = {
+    /**
+     * 会員ランク算出期間。期間が無期限の場合はnullを返す
+     */
     customerRankCalculationPeriod?: CustomerRankCalculationPeriod;
+    /**
+     * 会員ランクの算出根拠となる獲得ポイント
+     */
     earnedPoint: number;
+    /**
+     * 会員ランクの算出根拠となる購入金額
+     */
     purchasePrice: number;
 };
 
@@ -26,7 +74,13 @@ export declare type CustomerRankCalculationCondition = {
  * CustomerRankCalculationPeriod は会員ランクの算出期間を表す。
  */
 export declare type CustomerRankCalculationPeriod = {
+    /**
+     * 集計期間開始日
+     */
     start: Date;
+    /**
+     * 集計期間終了日
+     */
     end: Date;
 };
 
@@ -35,7 +89,13 @@ export declare type CustomerRankCalculationPeriod = {
  */
 export declare type CustomerRankRule = {
     id: string;
+    /**
+     * 会員ランク名
+     */
     name: string;
+    /**
+     * この会員ランクへのランクアップに必要な値。会員ランクの算出方法によりthresholdが指す値は異なり、獲得ポイントと購入金額のどちらかになる。
+     */
     threshold: number;
 };
 
@@ -45,6 +105,8 @@ export declare type CustomerRankRule = {
 declare type Location_2 = {
     id: string;
     name: string;
+    phone: string;
+    address?: Address;
 };
 export { Location_2 as Location }
 
@@ -63,12 +125,7 @@ export declare type LocationAvailability = {
     /**
      * location は在庫のLocationを表す。
      */
-    location: {
-        /**
-         * name はLocationの名前を表す。
-         */
-        name: string;
-    };
+    location: Location_2;
     /**
      * inventoryQuantity は在庫数を表す。
      */
@@ -111,16 +168,35 @@ export declare type PageInfo = {
  */
 export declare type PointChange = {
     id: string;
+    /**
+     * ポイント変動の数値。正負どちらの値も取りうる。
+     */
     delta: number;
+    /**
+     * ポイントが利用可能になる日時。nilの場合はまだ利用可能になる日時が決まっていない。主に未配送注文に関するポイントはnilになる。
+     */
     availableAt?: Date;
+    /**
+     * ポイントが利用できる期限。失効する直前を表すため、expiresDateから1ナノ秒を引いた値となる。
+     * 例えば、expiresDateが 2024-06-12 00:00:00 なら、availableUntilは 2024-06-11 23:59:59.999999999 となる。
+     */
     availableUntil?: Date;
+    /**
+     * ポイントの失効日。nilの場合はまだ失効日が決まっていない。ポイント消費や、未配送注文に関するポイントはnilになる。
+     */
     expiresDate?: Date;
+    /**
+     * ポイントの発生日時
+     */
     pointChangeCreatedAt: Date;
+    /**
+     * PointChangeのコミットタイムスタンプ
+     */
     createdAt: Date;
 };
 
 /**
- *
+ * PointChangeActivities はポイントの変動の履歴一覧を表す。
  */
 export declare type PointChangeActivities = {
     nodes: PointChangeActivity[];
@@ -142,7 +218,7 @@ declare enum PointChangeActivitySortKey {
 }
 
 /**
- *  PointMultiplierCustomerRankRule はこの会員ランクの注文時ポイント倍率を表す。
+ * PointMultiplierCustomerRankRule はこの会員ランクの注文時ポイント倍率を表す。
  */
 export declare type PointMultiplierCustomerRankRule = {
     id: string;
@@ -154,7 +230,13 @@ export declare type PointMultiplierCustomerRankRule = {
  * Points は SDK から取得できるポイントの情報を表す。
  */
 export declare type Points = {
+    /**
+     * PointsApproved は保有ポイントを表す。
+     */
     pointsApproved: number;
+    /**
+     * PointsPending は獲得予定ポイントを表す。
+     */
     pointsPending: number;
 };
 
@@ -165,13 +247,19 @@ export declare type PurchasingCustomerDiscount = {
     id: string;
     title: string;
     description: string;
+    /**
+     * Discountのステータス。"ACTIVE", "SCHEDULED", "EXPIRED" のいずれかが入る。
+     */
+    status: string;
     code: string;
+    startsAt: Date;
+    endsAt: Date;
     createdAt: Date;
     updatedAt: Date;
 };
 
 /**
- * DiscountCodes は PurchasingCustomerDiscount の一覧を取得するための情報を表す。
+ * PurchasingCustomerDiscounts は PurchasingCustomerDiscount の一覧を取得するための情報を表す。
  */
 export declare type PurchasingCustomerDiscounts = {
     id: string;