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

package/README.md

@@ -439,6 +439,18 @@ getPurchasingCustomerMetafield は渡されたnamespaceとkeyに一致する現
 
 ***
 
+#### getPurchasingCustomerSMS()
+
+> **getPurchasingCustomerSMS**(): `Promise`\<`null` \| [`PurchasingCustomerSMS`](#type-aliasespurchasingcustomersmsmd)\>
+
+getPurchasingCustomerSMS は顧客のSMS認証情報を返します。
+
+##### Returns
+
+`Promise`\<`null` \| [`PurchasingCustomerSMS`](#type-aliasespurchasingcustomersmsmd)\>
+
+***
+
 #### getPurchasingCustomerSharing()
 
 > **getPurchasingCustomerSharing**(): `Promise`\<`null` \| [`PurchasingCustomerSharing`](#type-aliasespurchasingcustomersharingmd)\>
@@ -485,7 +497,7 @@ mileItemExchange は指定したマイル商品を交換します。
 
 > **purchasingCustomerActivateCustomerSharing**(`email`, `activationCode`): `Promise`\<`null` \| [`PurchasingCustomer`](#type-aliasespurchasingcustomermd)\>
 
-purchasingCustomerActivateCustomerSharing はクティベーションコードを入力して顧客を有効化する。
+purchasingCustomerActivateCustomerSharing はアクティベーションコードを入力して顧客を有効化する。
 
 ##### Parameters
 
@@ -509,6 +521,46 @@ purchasingCustomerSendCustomerSharingActivationCode はログインしている
 
 `Promise`\<`null` \| [`CustomerSharingActivationCode`](#type-aliasescustomersharingactivationcodemd)\>
 
+***
+
+#### purchasingCustomerSendSMSVerificationCode()
+
+> **purchasingCustomerSendSMSVerificationCode**(`phone`): `Promise`\<`null` \| [`PurchasingCustomerSMS`](#type-aliasespurchasingcustomersmsmd)\>
+
+purchasingCustomerSendSMSVerificationCode は指定された電話番号に対して、SMS認証用コード(数字6桁)を送信します。
+
+##### Parameters
+
+• **phone**: `string`
+
+SMS認証コードを送信する電話番号
+
+##### Returns
+
+`Promise`\<`null` \| [`PurchasingCustomerSMS`](#type-aliasespurchasingcustomersmsmd)\>
+
+***
+
+#### purchasingCustomerVerifySMS()
+
+> **purchasingCustomerVerifySMS**(`phone`, `verificationCode`): `Promise`\<`null` \| [`PurchasingCustomerSMS`](#type-aliasespurchasingcustomersmsmd)\>
+
+purchasingCustomerVerifySMS はSMS認証用コード(数字6桁)を指定して、SMS認証を行います。
+
+##### Parameters
+
+• **phone**: `string`
+
+SMS認証コードを送信した電話番号
+
+• **verificationCode**: `string`
+
+SMS認証用コード
+
+##### Returns
+
+`Promise`\<`null` \| [`PurchasingCustomerSMS`](#type-aliasespurchasingcustomersmsmd)\>
+
 # Enumerations
 
 
@@ -629,6 +681,7 @@ LocationType はロケーションの種別を表す
 - [PurchasingCustomerDiscount](#type-aliasespurchasingcustomerdiscountmd)
 - [PurchasingCustomerDiscounts](#type-aliasespurchasingcustomerdiscountsmd)
 - [PurchasingCustomerMetafield](#type-aliasespurchasingcustomermetafieldmd)
+- [PurchasingCustomerSMS](#type-aliasespurchasingcustomersmsmd)
 - [PurchasingCustomerSharing](#type-aliasespurchasingcustomersharingmd)
 - [Tenant](#type-aliasestenantmd)
 
@@ -1386,6 +1439,12 @@ MileItems はマイル商品の一覧を取得するための情報を表す。
 
 オブジェクトのID
 
+#### isCancelled
+
+> **isCancelled**: `boolean`
+
+Shopifyマイル交換履歴をキャンセルしたかどうか
+
 #### mileItem
 
 > **mileItem**: [`MileItem`](#type-aliasesmileitemmd)
@@ -1552,7 +1611,7 @@ PointCampaignOrderRuleTargetCustomerRank は会員ランク種別のポイント
 
 > `optional` **fixedPoint**: `string`
 
-顧客に適用されるキャンペーン倍率
+顧客に適用されるキャンペーン固定ポイント
 以下の場合はnullを返す
 - 該当キャンペーンが存在しない場合
 - 未ログイン状態の場合
@@ -2059,6 +2118,39 @@ PurchasingCustomerMetafield は購入者のカスタムメタフィールドを
 > **value**: `string`
 
 
+<a name="type-aliasespurchasingcustomersmsmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / PurchasingCustomerSMS
+
+## Type Alias: PurchasingCustomerSMS
+
+> **PurchasingCustomerSMS**: `object`
+
+PurchasingCustomerSMS は、顧客のSMS認証情報を表す。
+
+### Type declaration
+
+#### id
+
+> **id**: `string`
+
+#### smsVerified
+
+> **smsVerified**: `boolean`
+
+この会員がSMS認証を行ったかどうかを表すフラグ
+
+#### smsVerifiedPhone
+
+> **smsVerifiedPhone**: `string`
+
+この会員がSMS認証を行った電話番号
+
+
 <a name="type-aliasespurchasingcustomersharingmd"></a>
 
 [**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**

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

@@ -356,6 +356,10 @@ export declare type MileOrder = {
      * 交換日時
      */
     exchangedAt: Date;
+    /**
+     * Shopifyマイル交換履歴をキャンセルしたかどうか
+     */
+    isCancelled: boolean;
 };
 
 /**
@@ -440,7 +444,7 @@ export declare type PointCampaignOrderRuleTargetCustomerRank = {
      */
     multiplier?: string;
     /**
-     * 顧客に適用されるキャンペーン倍率
+     * 顧客に適用されるキャンペーン固定ポイント
      * 以下の場合はnullを返す
      * - 該当キャンペーンが存在しない場合
      * - 未ログイン状態の場合
@@ -663,6 +667,21 @@ export declare type PurchasingCustomerSharing = {
     purchasingCustomers: PurchasingCustomer[];
 };
 
+/**
+ * PurchasingCustomerSMS は、顧客のSMS認証情報を表す。
+ */
+export declare type PurchasingCustomerSMS = {
+    id: string;
+    /**
+     * この会員がSMS認証を行ったかどうかを表すフラグ
+     */
+    smsVerified: boolean;
+    /**
+     * この会員がSMS認証を行った電話番号
+     */
+    smsVerifiedPhone: string;
+};
+
 export declare class SDK {
     private api;
     constructor(apiURL: string);
@@ -751,7 +770,7 @@ export declare class SDK {
      */
     purchasingCustomerSendCustomerSharingActivationCode(): Promise<CustomerSharingActivationCode | null>;
     /**
-     * purchasingCustomerActivateCustomerSharing はクティベーションコードを入力して顧客を有効化する。
+     * purchasingCustomerActivateCustomerSharing はアクティベーションコードを入力して顧客を有効化する。
      */
     purchasingCustomerActivateCustomerSharing(email: string, activationCode: string): Promise<PurchasingCustomer | null>;
     /**
@@ -785,12 +804,29 @@ export declare class SDK {
      * @param {MileOrderSortKey} [sortKeys] ソートキー。デフォルトはCREATED_AT。
      */
     getMileOrders(first?: number, after?: string, isReverse?: boolean, sortKeys?: MileOrderSortKey): Promise<MileOrders | null>;
+    /**
+     * getPurchasingCustomerSMS は顧客のSMS認証情報を返します。
+     */
+    getPurchasingCustomerSMS(): Promise<PurchasingCustomerSMS | null>;
     /**
      * mileItemExchange は指定したマイル商品を交換します。
      *
      * @param {mileItemID} mileItemID 交換したいマイル商品のID。
      */
     mileItemExchange(mileItemID: string): Promise<MileOrder | null>;
+    /**
+     * purchasingCustomerSendSMSVerificationCode は指定された電話番号に対して、SMS認証用コード(数字6桁)を送信します。
+     *
+     * @param {string} phone SMS認証コードを送信する電話番号
+     */
+    purchasingCustomerSendSMSVerificationCode(phone: string): Promise<PurchasingCustomerSMS | null>;
+    /**
+     * purchasingCustomerVerifySMS はSMS認証用コード(数字6桁)を指定して、SMS認証を行います。
+     *
+     * @param {string} phone SMS認証コードを送信した電話番号
+     * @param {string} verificationCode SMS認証用コード
+     */
+    purchasingCustomerVerifySMS(phone: string, verificationCode: string): Promise<PurchasingCustomerSMS | null>;
 }
 
 declare enum ShopifyMileItemSortKey {