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

package/README.md

@@ -190,6 +190,108 @@ getLocations は ShopifyIntegration に紐づく LocationGroup の Location の
 
 ***
 
+#### getMileChangeActivities()
+
+> **getMileChangeActivities**(`first`?, `after`?, `isReverse`?, `sortKeys`?): `Promise`\<`null` \| [`MileChangeActivities`](#type-aliasesmilechangeactivitiesmd)\>
+
+getMileChangeActivities は購入者のマイル変動履歴を返します。
+
+##### Parameters
+
+• **first?**: `number`
+
+取得してくる個数。デフォルトは250。
+
+• **after?**: `string`
+
+ページングの値。指定しない場合先頭から取得してくる。
+
+• **isReverse?**: `boolean`
+
+並び順。デフォルトはfalse。
+
+• **sortKeys?**: `MileChangeActivitySortKey`
+
+ソートキー。CREATED_ATかMILE_CHANGE_CREATED_ATを渡す。デフォルトはCREATED_AT。
+
+##### Returns
+
+`Promise`\<`null` \| [`MileChangeActivities`](#type-aliasesmilechangeactivitiesmd)\>
+
+***
+
+#### getMileItems()
+
+> **getMileItems**(`first`?, `after`?, `isReverse`?, `sortKeys`?): `Promise`\<`null` \| [`MileItems`](#type-aliasesmileitemsmd)\>
+
+getMileItems は顧客が利用可能なマイル交換商品の一覧を返します。
+
+##### Parameters
+
+• **first?**: `number`
+
+取得してくる個数。デフォルトは250。
+
+• **after?**: `string`
+
+ページングの値。指定しない場合先頭から取得してくる。
+
+• **isReverse?**: `boolean`
+
+並び順。デフォルトはfalse。
+
+• **sortKeys?**: `ShopifyMileItemSortKey`
+
+ソートキー。デフォルトはCREATED_AT。
+
+##### Returns
+
+`Promise`\<`null` \| [`MileItems`](#type-aliasesmileitemsmd)\>
+
+***
+
+#### getMileOrders()
+
+> **getMileOrders**(`first`?, `after`?, `isReverse`?, `sortKeys`?): `Promise`\<`null` \| [`MileOrders`](#type-aliasesmileordersmd)\>
+
+getMileOrders は顧客のマイル交換履歴の一覧を返します。
+
+##### Parameters
+
+• **first?**: `number`
+
+取得してくる個数。デフォルトは250。
+
+• **after?**: `string`
+
+ページングの値。指定しない場合先頭から取得してくる。
+
+• **isReverse?**: `boolean`
+
+並び順。デフォルトはfalse。
+
+• **sortKeys?**: `MileOrderSortKey`
+
+ソートキー。デフォルトはCREATED_AT。
+
+##### Returns
+
+`Promise`\<`null` \| [`MileOrders`](#type-aliasesmileordersmd)\>
+
+***
+
+#### getMiles()
+
+> **getMiles**(): `Promise`\<`null` \| [`Miles`](#type-aliasesmilesmd)\>
+
+getMiles は、Miles は SDK から取得できるマイルの情報を返します。
+
+##### Returns
+
+`Promise`\<`null` \| [`Miles`](#type-aliasesmilesmd)\>
+
+***
+
 #### getPointCampaignOrderRuleTargetCustomerRank()
 
 > **getPointCampaignOrderRuleTargetCustomerRank**(): `Promise`\<`null` \| [`PointCampaignOrderRuleTargetCustomerRank`](#type-aliasespointcampaignorderruletargetcustomerrankmd)\>
@@ -361,6 +463,24 @@ getSharingPurchasingCustomerCount は顧客が共有化している数を返し
 
 ***
 
+#### mileItemExchange()
+
+> **mileItemExchange**(`mileItemID`): `Promise`\<`null` \| [`MileOrder`](#type-aliasesmileordermd)\>
+
+mileItemExchange は指定したマイル商品を交換します。
+
+##### Parameters
+
+• **mileItemID**: `string`
+
+交換したいマイル商品のID。
+
+##### Returns
+
+`Promise`\<`null` \| [`MileOrder`](#type-aliasesmileordermd)\>
+
+***
+
 #### purchasingCustomerActivateCustomerSharing()
 
 > **purchasingCustomerActivateCustomerSharing**(`email`, `activationCode`): `Promise`\<`null` \| [`PurchasingCustomer`](#type-aliasespurchasingcustomermd)\>
@@ -486,6 +606,14 @@ LocationType はロケーションの種別を表す
 - [LocationAvailability](#type-aliaseslocationavailabilitymd)
 - [LocationFilter](#type-aliaseslocationfiltermd)
 - [Locations](#type-aliaseslocationsmd)
+- [MileChange](#type-aliasesmilechangemd)
+- [MileChangeActivities](#type-aliasesmilechangeactivitiesmd)
+- [MileChangeActivity](#type-aliasesmilechangeactivitymd)
+- [MileItem](#type-aliasesmileitemmd)
+- [MileItems](#type-aliasesmileitemsmd)
+- [MileOrder](#type-aliasesmileordermd)
+- [MileOrders](#type-aliasesmileordersmd)
+- [Miles](#type-aliasesmilesmd)
 - [PageInfo](#type-aliasespageinfomd)
 - [PointCampaignOrderRule](#type-aliasespointcampaignorderrulemd)
 - [PointCampaignOrderRuleTargetCustomerRank](#type-aliasespointcampaignorderruletargetcustomerrankmd)
@@ -1037,6 +1165,288 @@ Locations は Location の一覧を取得するための情報を表す。
 > **pageInfo**: [`PageInfo`](#type-aliasespageinfomd)
 
 
+<a name="type-aliasesmilechangemd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / MileChange
+
+## Type Alias: MileChange
+
+> **MileChange**: `object`
+
+MileChange はマイルの変動を表す。
+
+### Type declaration
+
+#### createdAt
+
+> **createdAt**: `Date`
+
+MileChangeのコミットタイムスタンプ
+
+#### delta
+
+> **delta**: `number`
+
+マイル変動の数値。正負どちらの値も取りうる。
+
+#### id
+
+> **id**: `string`
+
+#### mileChangeCreatedAt
+
+> **mileChangeCreatedAt**: `Date`
+
+マイルの発生日時
+
+
+<a name="type-aliasesmilechangeactivitiesmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / MileChangeActivities
+
+## Type Alias: MileChangeActivities
+
+> **MileChangeActivities**: `object`
+
+MileChangeActivities はマイルの変動の履歴一覧を表す。
+
+### Type declaration
+
+#### nodes
+
+> **nodes**: [`MileChangeActivity`](#type-aliasesmilechangeactivitymd)[]
+
+#### pageInfo
+
+> **pageInfo**: [`PageInfo`](#type-aliasespageinfomd)
+
+
+<a name="type-aliasesmilechangeactivitymd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / MileChangeActivity
+
+## Type Alias: MileChangeActivity
+
+> **MileChangeActivity**: `object`
+
+MileChangeActivity はマイルの変動の履歴を表す。
+
+### Type declaration
+
+#### id
+
+> **id**: `string`
+
+#### mileChange
+
+> **mileChange**: [`MileChange`](#type-aliasesmilechangemd)
+
+#### title
+
+> **title**: `string`
+
+
+<a name="type-aliasesmileitemmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / MileItem
+
+## Type Alias: MileItem
+
+> **MileItem**: `object`
+
+MileItem はマイル商品の情報を表す。
+
+### Type declaration
+
+#### customerExchangeable
+
+> **customerExchangeable**: `boolean`
+
+交換可能かどうか
+
+#### description
+
+> **description**: `string`
+
+マイル商品の説明
+
+#### endsAt?
+
+> `optional` **endsAt**: `Date`
+
+交換可能期間の終了日時
+
+#### id
+
+> **id**: `string`
+
+オブジェクトのID
+
+#### isActive
+
+> **isActive**: `boolean`
+
+現在交換可能かどうか
+
+#### isScheduled
+
+> **isScheduled**: `boolean`
+
+交換開始前かどうか
+
+#### miles
+
+> **miles**: `number`
+
+マイル商品の画像URL
+
+#### sku
+
+> **sku**: `string`
+
+マイル商品のSKU
+
+#### startsAt
+
+> **startsAt**: `Date`
+
+交換可能期間の開始日時
+
+#### title
+
+> **title**: `string`
+
+マイル商品のタイトル
+
+
+<a name="type-aliasesmileitemsmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / MileItems
+
+## Type Alias: MileItems
+
+> **MileItems**: `object`
+
+MileItems はマイル商品の一覧を取得するための情報を表す。
+
+### Type declaration
+
+#### nodes
+
+> **nodes**: [`MileItem`](#type-aliasesmileitemmd)[]
+
+#### pageInfo
+
+> **pageInfo**: [`PageInfo`](#type-aliasespageinfomd)
+
+
+<a name="type-aliasesmileordermd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / MileOrder
+
+## Type Alias: MileOrder
+
+> **MileOrder**: `object`
+
+### Type declaration
+
+#### exchangedAt
+
+> **exchangedAt**: `Date`
+
+交換日時
+
+#### id
+
+> **id**: `string`
+
+オブジェクトのID
+
+#### mileItem
+
+> **mileItem**: [`MileItem`](#type-aliasesmileitemmd)
+
+交換したマイル商品
+
+#### miles
+
+> **miles**: `number`
+
+使用したマイル数
+
+
+<a name="type-aliasesmileordersmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / MileOrders
+
+## Type Alias: MileOrders
+
+> **MileOrders**: `object`
+
+MileOrders はマイル商品の交換履歴の一覧を取得するための情報を表す。
+
+### Type declaration
+
+#### nodes
+
+> **nodes**: [`MileOrder`](#type-aliasesmileordermd)[]
+
+#### pageInfo
+
+> **pageInfo**: [`PageInfo`](#type-aliasespageinfomd)
+
+
+<a name="type-aliasesmilesmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / Miles
+
+## Type Alias: Miles
+
+> **Miles**: `object`
+
+Miles は SDK から取得できるマイルの情報を表す。
+
+### Type declaration
+
+#### miles
+
+> **miles**: `number`
+
+Miles は保有マイルを表す。
+
+
 <a name="type-aliasespageinfomd"></a>
 
 [**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**

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

@@ -244,6 +244,142 @@ export declare enum LocationType {
     Warehouse = "WAREHOUSE"
 }
 
+/**
+ * MileChange はマイルの変動を表す。
+ */
+export declare type MileChange = {
+    id: string;
+    /**
+     * マイル変動の数値。正負どちらの値も取りうる。
+     */
+    delta: number;
+    /**
+     * マイルの発生日時
+     */
+    mileChangeCreatedAt: Date;
+    /**
+     * MileChangeのコミットタイムスタンプ
+     */
+    createdAt: Date;
+};
+
+/**
+ * MileChangeActivities はマイルの変動の履歴一覧を表す。
+ */
+export declare type MileChangeActivities = {
+    nodes: MileChangeActivity[];
+    pageInfo: PageInfo;
+};
+
+/**
+ * MileChangeActivity はマイルの変動の履歴を表す。
+ */
+export declare type MileChangeActivity = {
+    id: string;
+    title: string;
+    mileChange: MileChange;
+};
+
+declare enum MileChangeActivitySortKey {
+    CreatedAt = "CREATED_AT",
+    MileChangeCreatedAt = "MILE_CHANGE_CREATED_AT"
+}
+
+/**
+ * MileItem はマイル商品の情報を表す。
+ */
+export declare type MileItem = {
+    /**
+     * オブジェクトのID
+     */
+    id: string;
+    /**
+     * マイル商品のタイトル
+     */
+    title: string;
+    /**
+     * マイル商品の説明
+     */
+    description: string;
+    /**
+     * マイル商品の画像URL
+     */
+    miles: number;
+    /**
+     * マイル商品のSKU
+     */
+    sku: string;
+    /**
+     * 現在交換可能かどうか
+     */
+    isActive: boolean;
+    /**
+     * 交換開始前かどうか
+     */
+    isScheduled: boolean;
+    /**
+     * 交換可能かどうか
+     */
+    customerExchangeable: boolean;
+    /**
+     * 交換可能期間の開始日時
+     */
+    startsAt: Date;
+    /**
+     * 交換可能期間の終了日時
+     */
+    endsAt?: Date;
+};
+
+/**
+ * MileItems はマイル商品の一覧を取得するための情報を表す。
+ */
+export declare type MileItems = {
+    nodes: MileItem[];
+    pageInfo: PageInfo;
+};
+
+export declare type MileOrder = {
+    /**
+     * オブジェクトのID
+     */
+    id: string;
+    /**
+     * 交換したマイル商品
+     */
+    mileItem: MileItem;
+    /**
+     * 使用したマイル数
+     */
+    miles: number;
+    /**
+     * 交換日時
+     */
+    exchangedAt: Date;
+};
+
+/**
+ * MileOrders はマイル商品の交換履歴の一覧を取得するための情報を表す。
+ */
+export declare type MileOrders = {
+    nodes: MileOrder[];
+    pageInfo: PageInfo;
+};
+
+declare enum MileOrderSortKey {
+    CreatedAt = "CREATED_AT"
+}
+
+/**
+ * Miles は SDK から取得できるマイルの情報を表す。
+ */
+export declare type Miles = {
+    /**
+     * Miles は保有マイルを表す。
+     */
+    miles: number;
+};
+
 /**
  * PageInfo はページングを伴って一覧を取得したときに、その一覧のページングの情報を表す。
  */
@@ -618,6 +754,47 @@ export declare class SDK {
      * purchasingCustomerActivateCustomerSharing はクティベーションコードを入力して顧客を有効化する。
      */
     purchasingCustomerActivateCustomerSharing(email: string, activationCode: string): Promise<PurchasingCustomer | null>;
+    /**
+     * getMiles は、Miles は SDK から取得できるマイルの情報を返します。
+     */
+    getMiles(): Promise<Miles | null>;
+    /**
+     * getMileChangeActivities は購入者のマイル変動履歴を返します。
+     *
+     * @param {number} [first] 取得してくる個数。デフォルトは250。
+     * @param {string} [after] ページングの値。指定しない場合先頭から取得してくる。
+     * @param {boolean} [isReverse] 並び順。デフォルトはfalse。
+     * @param {MileChangeActivitySortKey} [sortKeys] ソートキー。CREATED_ATかMILE_CHANGE_CREATED_ATを渡す。デフォルトはCREATED_AT。
+     */
+    getMileChangeActivities(first?: number, after?: string, isReverse?: boolean, sortKeys?: MileChangeActivitySortKey): Promise<MileChangeActivities | null>;
+    /**
+     * getMileItems は顧客が利用可能なマイル交換商品の一覧を返します。
+     *
+     * @param {number} [first] 取得してくる個数。デフォルトは250。
+     * @param {string} [after] ページングの値。指定しない場合先頭から取得してくる。
+     * @param {boolean} [isReverse] 並び順。デフォルトはfalse。
+     * @param {ShopifyMileItemSortKey} [sortKeys] ソートキー。デフォルトはCREATED_AT。
+     */
+    getMileItems(first?: number, after?: string, isReverse?: boolean, sortKeys?: ShopifyMileItemSortKey): Promise<MileItems | null>;
+    /**
+     * getMileOrders は顧客のマイル交換履歴の一覧を返します。
+     *
+     * @param {number} [first] 取得してくる個数。デフォルトは250。
+     * @param {string} [after] ページングの値。指定しない場合先頭から取得してくる。
+     * @param {boolean} [isReverse] 並び順。デフォルトはfalse。
+     * @param {MileOrderSortKey} [sortKeys] ソートキー。デフォルトはCREATED_AT。
+     */
+    getMileOrders(first?: number, after?: string, isReverse?: boolean, sortKeys?: MileOrderSortKey): Promise<MileOrders | null>;
+    /**
+     * mileItemExchange は指定したマイル商品を交換します。
+     *
+     * @param {mileItemID} mileItemID 交換したいマイル商品のID。
+     */
+    mileItemExchange(mileItemID: string): Promise<MileOrder | null>;
+}
+
+declare enum ShopifyMileItemSortKey {
+    CreatedAt = "CREATED_AT"
 }
 
 /**