@builtbystack/sq-shopify-theme-sdk 0.0.12 → 0.0.15

package/README.md

@@ -236,6 +236,48 @@ getPurchasingCustomerMetafield は渡されたnamespaceとkeyに一致する現
 
 `Promise`\<`null` \| [`PurchasingCustomerMetafield`](#type-aliasespurchasingcustomermetafieldmd)\>
 
+***
+
+#### getSharingPurchasingCustomerCount()
+
+> **getSharingPurchasingCustomerCount**(): `Promise`\<`number`\>
+
+getSharingPurchasingCustomerCount は顧客が共有化している数を返します。
+
+##### Returns
+
+`Promise`\<`number`\>
+
+***
+
+#### purchasingCustomerActivateCustomerSharing()
+
+> **purchasingCustomerActivateCustomerSharing**(`email`, `activationCode`): `Promise`\<`null` \| [`PurchasingCustomer`](#type-aliasespurchasingcustomermd)\>
+
+purchasingCustomerActivateCustomerSharing はクティベーションコードを入力して顧客を有効化する。
+
+##### Parameters
+
+• **email**: `string`
+
+• **activationCode**: `string`
+
+##### Returns
+
+`Promise`\<`null` \| [`PurchasingCustomer`](#type-aliasespurchasingcustomermd)\>
+
+***
+
+#### purchasingCustomerSendCustomerSharingActivationCode()
+
+> **purchasingCustomerSendCustomerSharingActivationCode**(): `Promise`\<`null` \| [`CustomerSharingActivationCode`](#type-aliasescustomersharingactivationcodemd)\>
+
+purchasingCustomerSendCustomerSharingActivationCode はログインしているアカウントのメールアドレスに顧客情報共有のためのアクティベーションコードを送信する。
+
+##### Returns
+
+`Promise`\<`null` \| [`CustomerSharingActivationCode`](#type-aliasescustomersharingactivationcodemd)\>
+
 
 <a name="globalsmd"></a>
 
@@ -256,6 +298,7 @@ getPurchasingCustomerMetafield は渡されたnamespaceとkeyに一致する現
 - [CustomerRankCalculationCondition](#type-aliasescustomerrankcalculationconditionmd)
 - [CustomerRankCalculationPeriod](#type-aliasescustomerrankcalculationperiodmd)
 - [CustomerRankRule](#type-aliasescustomerrankrulemd)
+- [CustomerSharingActivationCode](#type-aliasescustomersharingactivationcodemd)
 - [Location](#type-aliaseslocationmd)
 - [LocationAvailabilities](#type-aliaseslocationavailabilitiesmd)
 - [LocationAvailability](#type-aliaseslocationavailabilitymd)
@@ -266,6 +309,7 @@ getPurchasingCustomerMetafield は渡されたnamespaceとkeyに一致する現
 - [PointChangeActivity](#type-aliasespointchangeactivitymd)
 - [PointMultiplierCustomerRankRule](#type-aliasespointmultipliercustomerrankrulemd)
 - [Points](#type-aliasespointsmd)
+- [PurchasingCustomer](#type-aliasespurchasingcustomermd)
 - [PurchasingCustomerDiscount](#type-aliasespurchasingcustomerdiscountmd)
 - [PurchasingCustomerDiscounts](#type-aliasespurchasingcustomerdiscountsmd)
 - [PurchasingCustomerMetafield](#type-aliasespurchasingcustomermetafieldmd)
@@ -492,6 +536,29 @@ CustomerRankRule は会員ランクのルールを表す。
 この会員ランクへのランクアップに必要な値。会員ランクの算出方法によりthresholdが指す値は異なり、獲得ポイントと購入金額のどちらかになる。
 
 
+<a name="type-aliasescustomersharingactivationcodemd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / CustomerSharingActivationCode
+
+## Type Alias: CustomerSharingActivationCode
+
+> **CustomerSharingActivationCode**: `object`
+
+### Type declaration
+
+#### customerSharingActivationCodeID
+
+> **customerSharingActivationCodeID**: `string`
+
+#### purchasingCustomer
+
+> **purchasingCustomer**: [`PurchasingCustomer`](#type-aliasespurchasingcustomermd)
+
+
 <a name="type-aliaseslocationmd"></a>
 
 [**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
@@ -516,6 +583,10 @@ Location は ShopifyIntegration に紐付いている Location を表す。
 
 > **id**: `string`
 
+#### mapURL?
+
+> `optional` **mapURL**: `string`
+
 #### name
 
 > **name**: `string`
@@ -820,6 +891,29 @@ PointsApproved は保有ポイントを表す。
 PointsPending は獲得予定ポイントを表す。
 
 
+<a name="type-aliasespurchasingcustomermd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / PurchasingCustomer
+
+## Type Alias: PurchasingCustomer
+
+> **PurchasingCustomer**: `object`
+
+### Type declaration
+
+#### id
+
+> **id**: `string`
+
+#### sharingPurchasingCustomerCount
+
+> **sharingPurchasingCustomerCount**: `number`
+
+
 <a name="type-aliasespurchasingcustomerdiscountmd"></a>
 
 [**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**

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

@@ -99,6 +99,11 @@ export declare type CustomerRankRule = {
     threshold: number;
 };
 
+export declare type CustomerSharingActivationCode = {
+    purchasingCustomer: PurchasingCustomer;
+    customerSharingActivationCodeID: string;
+};
+
 /**
  * Location は ShopifyIntegration に紐付いている Location を表す。
  */
@@ -106,6 +111,7 @@ declare type Location_2 = {
     id: string;
     name: string;
     phone: string;
+    mapURL?: string;
     address?: Address;
 };
 export { Location_2 as Location }
@@ -241,6 +247,11 @@ export declare type Points = {
     pointsPending: number;
 };
 
+export declare type PurchasingCustomer = {
+    id: string;
+    sharingPurchasingCustomerCount: number;
+};
+
 /**
  * PurchasingCustomerDiscount は購入者の割引情報を表す。
  */
@@ -350,6 +361,18 @@ export declare class SDK {
      * getPurchasingCustomerDiscountCodeCount は顧客に紐付くDiscountCodeの数を返します。
      */
     getPurchasingCustomerDiscountCodeCount(): Promise<number>;
+    /**
+     * getSharingPurchasingCustomerCount は顧客が共有化している数を返します。
+     */
+    getSharingPurchasingCustomerCount(): Promise<number>;
+    /**
+     * purchasingCustomerSendCustomerSharingActivationCode はログインしているアカウントのメールアドレスに顧客情報共有のためのアクティベーションコードを送信する。
+     */
+    purchasingCustomerSendCustomerSharingActivationCode(): Promise<CustomerSharingActivationCode | null>;
+    /**
+     * purchasingCustomerActivateCustomerSharing はクティベーションコードを入力して顧客を有効化する。
+     */
+    purchasingCustomerActivateCustomerSharing(email: string, activationCode: string): Promise<PurchasingCustomer | null>;
 }
 
 export { }