@builtbystack/sq-shopify-theme-sdk 0.0.14 → 0.0.16

package/README.md

@@ -238,6 +238,18 @@ getPurchasingCustomerMetafield は渡されたnamespaceとkeyに一致する現
 
 ***
 
+#### getPurchasingCustomerSharing()
+
+> **getPurchasingCustomerSharing**(): `Promise`\<`null` \| [`PurchasingCustomerSharing`](#type-aliasespurchasingcustomersharingmd)\>
+
+getPurchasingCustomerSharing は共有化している顧客情報を返します。
+
+##### Returns
+
+`Promise`\<`null` \| [`PurchasingCustomerSharing`](#type-aliasespurchasingcustomersharingmd)\>
+
+***
+
 #### getSharingPurchasingCustomerCount()
 
 > **getSharingPurchasingCustomerCount**(): `Promise`\<`number`\>
@@ -250,11 +262,29 @@ getSharingPurchasingCustomerCount は顧客が共有化している数を返し
 
 ***
 
+#### 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 はログインしているアカウントのメールアドレスに顧客情報共有のためのアクティベーションコードを送信する。
+purchasingCustomerSendCustomerSharingActivationCode はログインしているアカウントのメールアドレスに顧客情報共有のためのアクティベーションコードを送信します。
 
 ##### Returns
 
@@ -291,9 +321,12 @@ purchasingCustomerSendCustomerSharingActivationCode はログインしている
 - [PointChangeActivity](#type-aliasespointchangeactivitymd)
 - [PointMultiplierCustomerRankRule](#type-aliasespointmultipliercustomerrankrulemd)
 - [Points](#type-aliasespointsmd)
+- [PurchasingCustomer](#type-aliasespurchasingcustomermd)
 - [PurchasingCustomerDiscount](#type-aliasespurchasingcustomerdiscountmd)
 - [PurchasingCustomerDiscounts](#type-aliasespurchasingcustomerdiscountsmd)
 - [PurchasingCustomerMetafield](#type-aliasespurchasingcustomermetafieldmd)
+- [PurchasingCustomerSharing](#type-aliasespurchasingcustomersharingmd)
+- [Tenant](#type-aliasestenantmd)
 
 # Type Aliases
 
@@ -535,9 +568,9 @@ CustomerRankRule は会員ランクのルールを表す。
 
 > **customerSharingActivationCodeID**: `string`
 
-#### purchasingCustomerID
+#### purchasingCustomer
 
-> **purchasingCustomerID**: `string`
+> **purchasingCustomer**: [`PurchasingCustomer`](#type-aliasespurchasingcustomermd)
 
 
 <a name="type-aliaseslocationmd"></a>
@@ -755,6 +788,12 @@ PointChangeのコミットタイムスタンプ
 
 ポイントの発生日時
 
+#### tenant
+
+> **tenant**: [`Tenant`](#type-aliasestenantmd)
+
+ポイントに紐づくテナント情報
+
 
 <a name="type-aliasespointchangeactivitiesmd"></a>
 
@@ -809,6 +848,10 @@ PointChangeActivity はポイントの変動の履歴を表す。
 
 > `optional` **retailLocation**: [`Location`](#type-aliaseslocationmd)
 
+#### tenant
+
+> **tenant**: [`Tenant`](#type-aliasestenantmd)
+
 #### title
 
 > **title**: `string`
@@ -872,6 +915,33 @@ 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`
+
+#### tenant
+
+> **tenant**: [`Tenant`](#type-aliasestenantmd)
+
+
 <a name="type-aliasespurchasingcustomerdiscountmd"></a>
 
 [**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
@@ -1005,3 +1075,51 @@ PurchasingCustomerMetafield は購入者のカスタムメタフィールドを
 #### value
 
 > **value**: `string`
+
+
+<a name="type-aliasespurchasingcustomersharingmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / PurchasingCustomerSharing
+
+## Type Alias: PurchasingCustomerSharing
+
+> **PurchasingCustomerSharing**: `object`
+
+### Type declaration
+
+#### id
+
+> **id**: `string`
+
+#### purchasingCustomers
+
+> **purchasingCustomers**: [`PurchasingCustomer`](#type-aliasespurchasingcustomermd)[]
+
+
+<a name="type-aliasestenantmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / Tenant
+
+## Type Alias: Tenant
+
+> **Tenant**: `object`
+
+Tenant はテナント情報を表す。
+
+### Type declaration
+
+#### id
+
+> **id**: `string`
+
+#### name
+
+> **name**: `string`

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

@@ -100,7 +100,7 @@ export declare type CustomerRankRule = {
 };
 
 export declare type CustomerSharingActivationCode = {
-    purchasingCustomerID: string;
+    purchasingCustomer: PurchasingCustomer;
     customerSharingActivationCodeID: string;
 };
 
@@ -195,6 +195,10 @@ export declare type PointChange = {
      * ポイントの発生日時
      */
     pointChangeCreatedAt: Date;
+    /**
+     * ポイントに紐づくテナント情報
+     */
+    tenant: Tenant;
     /**
      * PointChangeのコミットタイムスタンプ
      */
@@ -217,6 +221,7 @@ export declare type PointChangeActivity = {
     title: string;
     pointChange: PointChange;
     retailLocation?: Location_2;
+    tenant: Tenant;
 };
 
 declare enum PointChangeActivitySortKey {
@@ -247,6 +252,12 @@ export declare type Points = {
     pointsPending: number;
 };
 
+export declare type PurchasingCustomer = {
+    id: string;
+    sharingPurchasingCustomerCount: number;
+    tenant: Tenant;
+};
+
 /**
  * PurchasingCustomerDiscount は購入者の割引情報を表す。
  */
@@ -291,6 +302,11 @@ export declare type PurchasingCustomerMetafield = {
     value: string;
 };
 
+export declare type PurchasingCustomerSharing = {
+    id: string;
+    purchasingCustomers: PurchasingCustomer[];
+};
+
 export declare class SDK {
     private api;
     constructor(apiURL: string);
@@ -361,9 +377,25 @@ export declare class SDK {
      */
     getSharingPurchasingCustomerCount(): Promise<number>;
     /**
-     * purchasingCustomerSendCustomerSharingActivationCode はログインしているアカウントのメールアドレスに顧客情報共有のためのアクティベーションコードを送信する。
+     * getPurchasingCustomerSharing は共有化している顧客情報を返します。
+     */
+    getPurchasingCustomerSharing(): Promise<PurchasingCustomerSharing | null>;
+    /**
+     * purchasingCustomerSendCustomerSharingActivationCode はログインしているアカウントのメールアドレスに顧客情報共有のためのアクティベーションコードを送信します。
      */
     purchasingCustomerSendCustomerSharingActivationCode(): Promise<CustomerSharingActivationCode | null>;
+    /**
+     * purchasingCustomerActivateCustomerSharing はクティベーションコードを入力して顧客を有効化する。
+     */
+    purchasingCustomerActivateCustomerSharing(email: string, activationCode: string): Promise<PurchasingCustomer | null>;
 }
 
+/**
+ * Tenant はテナント情報を表す。
+ */
+export declare type Tenant = {
+    id: string;
+    name: string;
+};
+
 export { }