@builtbystack/sq-shopify-theme-sdk 0.0.5 → 0.0.6

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

@@ -1,3 +1,43 @@
+/**
+ * CustomerRank は会員ランクを表す。
+ */
+export declare type CustomerRank = {
+    id: string;
+    name: string;
+    calculationCondition: CustomerRankCalculationCondition;
+    earnedPointToRankUp: number;
+    higherRank?: CustomerRankRule;
+    lowerRank?: CustomerRankRule;
+    purchasePriceToRankUp: number;
+    threshold: number;
+};
+
+/**
+ * CustomerRankCalculationCondition は会員ランクの算出条件を表す。
+ */
+export declare type CustomerRankCalculationCondition = {
+    customerRankCalculationPeriod?: CustomerRankCalculationPeriod;
+    earnedPoint: number;
+    purchasePrice: number;
+};
+
+/**
+ * CustomerRankCalculationPeriod は会員ランクの算出期間を表す。
+ */
+export declare type CustomerRankCalculationPeriod = {
+    start: Date;
+    end: Date;
+};
+
+/**
+ * CustomerRankRule は会員ランクのルールを表す。
+ */
+export declare type CustomerRankRule = {
+    id: string;
+    name: string;
+    threshold: number;
+};
+
 /**
  * Location は ShopifyIntegration に紐付いている Location を表す。
  */
@@ -12,7 +52,7 @@ export { Location_2 as Location }
  */
 export declare type LocationAvailabilities = {
     nodes: LocationAvailability[];
-    pageInfo: PageInfo | null;
+    pageInfo: PageInfo;
 };
 
 /**
@@ -39,7 +79,7 @@ export declare type LocationAvailability = {
  */
 export declare type Locations = {
     nodes: Location_2[];
-    pageInfo: PageInfo | null;
+    pageInfo: PageInfo;
 };
 
 /**
@@ -65,6 +105,41 @@ export declare type PageInfo = {
     hasPreviousPage: boolean;
 };
 
+/**
+ * PointChange はポイントの変動を表す。
+ */
+export declare type PointChange = {
+    id: string;
+    delta: number;
+    availableAt?: Date;
+    availableUntil?: Date;
+    expiresDate?: Date;
+    pointChangeCreatedAt: Date;
+    createdAt: Date;
+};
+
+/**
+ *
+ */
+export declare type PointChangeActivities = {
+    nodes: PointChangeActivity[];
+    pageInfo: PageInfo;
+};
+
+/**
+ * PointChangeActivity はポイントの変動の履歴を表す。
+ */
+export declare type PointChangeActivity = {
+    id: string;
+    title: string;
+    pointChange: PointChange;
+};
+
+declare enum PointChangeActivitySortKey {
+    CreatedAt = "CREATED_AT",
+    PointChangeCreatedAt = "POINT_CHANGE_CREATED_AT"
+}
+
 /**
  * Points は SDK から取得できるポイントの情報を表す。
  */
@@ -91,7 +166,7 @@ export declare type PurchasingCustomerDiscount = {
 export declare type PurchasingCustomerDiscounts = {
     id: string;
     nodes: PurchasingCustomerDiscount[];
-    pageInfo: PageInfo | null;
+    pageInfo: PageInfo;
 };
 
 /**
@@ -150,7 +225,20 @@ export declare class SDK {
      * @param {string} [after] ページングの値。指定しない場合先頭から取得してくる。
      * @param {boolean} [isReverse] 並び順。デフォルトはfalse。
      */
-    getPurchasingCustomerDiscounts(first?: number, after?: string, isReverse?: boolean): Promise<PurchasingCustomerDiscounts>;
+    getPurchasingCustomerDiscounts(first?: number, after?: string, isReverse?: boolean): Promise<PurchasingCustomerDiscounts | null>;
+    /**
+     * getPointChangeActivities は購入者のポイント変動履歴を返します。
+     *
+     * @param {number} [first] 取得してくる個数。デフォルトは250。
+     * @param {string} [after] ページングの値。指定しない場合先頭から取得してくる。
+     * @param {boolean} [isReverse] 並び順。デフォルトはfalse。
+     * @param {PointChangeActivitySortKey} [sortKeys] ソートキー。CREATED_ATかPOINT_CHANGE_CREATED_ATを渡す。デフォルトはCREATED_AT。
+     */
+    getPointChangeActivities(first?: number, after?: string, isReverse?: boolean, sortKeys?: PointChangeActivitySortKey): Promise<PointChangeActivities | null>;
+    /**
+     * getPurchasingCustomerCurrentRank は購入者の現在のランク情報を返します。
+     */
+    getPurchasingCustomerCurrentRank(): Promise<CustomerRank | null>;
 }
 
 export { }