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

package/README.md

@@ -236,6 +236,30 @@ getPurchasingCustomerMetafield は渡されたnamespaceとkeyに一致する現
 
 `Promise`\<`null` \| [`PurchasingCustomerMetafield`](#type-aliasespurchasingcustomermetafieldmd)\>
 
+***
+
+#### getSharingPurchasingCustomerCount()
+
+> **getSharingPurchasingCustomerCount**(): `Promise`\<`number`\>
+
+getSharingPurchasingCustomerCount は顧客が共有化している数を返します。
+
+##### Returns
+
+`Promise`\<`number`\>
+
+***
+
+#### purchasingCustomerSendCustomerSharingActivationCode()
+
+> **purchasingCustomerSendCustomerSharingActivationCode**(): `Promise`\<`null` \| [`CustomerSharingActivationCode`](#type-aliasescustomersharingactivationcodemd)\>
+
+purchasingCustomerSendCustomerSharingActivationCode はログインしているアカウントのメールアドレスに顧客情報共有のためのアクティベーションコードを送信する。
+
+##### Returns
+
+`Promise`\<`null` \| [`CustomerSharingActivationCode`](#type-aliasescustomersharingactivationcodemd)\>
+
 
 <a name="globalsmd"></a>
 
@@ -256,6 +280,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)
@@ -492,6 +517,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`
+
+#### purchasingCustomerID
+
+> **purchasingCustomerID**: `string`
+
+
 <a name="type-aliaseslocationmd"></a>
 
 [**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
@@ -516,6 +564,10 @@ Location は ShopifyIntegration に紐付いている Location を表す。
 
 > **id**: `string`
 
+#### mapURL?
+
+> `optional` **mapURL**: `string`
+
 #### name
 
 > **name**: `string`
@@ -836,6 +888,10 @@ PurchasingCustomerDiscount は購入者の割引情報を表す。
 
 ### Type declaration
 
+#### applicableLocationCount
+
+> **applicableLocationCount**: `number`
+
 #### code
 
 > **code**: `string`
@@ -858,10 +914,18 @@ Discountがこの顧客で有効かどうかを表す。
 
 > **endsAt**: `Date`
 
+#### hasApplicableLocations
+
+> **hasApplicableLocations**: `boolean`
+
 #### id
 
 > **id**: `string`
 
+#### shopifyStoreApplicable
+
+> **shopifyStoreApplicable**: `boolean`
+
 #### startsAt
 
 > **startsAt**: `Date`

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

@@ -99,6 +99,11 @@ export declare type CustomerRankRule = {
     threshold: number;
 };
 
+export declare type CustomerSharingActivationCode = {
+    purchasingCustomerID: string;
+    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 }
@@ -257,6 +263,9 @@ export declare type PurchasingCustomerDiscount = {
      * Discountがこの顧客で有効かどうかを表す。
      */
     customerApplicable: boolean;
+    shopifyStoreApplicable: boolean;
+    applicableLocationCount: number;
+    hasApplicableLocations: boolean;
     startsAt: Date;
     endsAt: Date;
     createdAt: Date;
@@ -324,6 +333,7 @@ export declare class SDK {
     /**
      * getPurchasingCustomerDiscounts は購入者の割引情報を返します。
      *
+     * @param {string} [retailLocationID] 取得したい割引情報が適用されているLocationのID。
      * @param {number} [first] 取得してくる個数。デフォルトは250。
      * @param {string} [after] ページングの値。指定しない場合先頭から取得してくる。
      * @param {boolean} [isReverse] 並び順。デフォルトはfalse。
@@ -346,6 +356,14 @@ export declare class SDK {
      * getPurchasingCustomerDiscountCodeCount は顧客に紐付くDiscountCodeの数を返します。
      */
     getPurchasingCustomerDiscountCodeCount(): Promise<number>;
+    /**
+     * getSharingPurchasingCustomerCount は顧客が共有化している数を返します。
+     */
+    getSharingPurchasingCustomerCount(): Promise<number>;
+    /**
+     * purchasingCustomerSendCustomerSharingActivationCode はログインしているアカウントのメールアドレスに顧客情報共有のためのアクティベーションコードを送信する。
+     */
+    purchasingCustomerSendCustomerSharingActivationCode(): Promise<CustomerSharingActivationCode | null>;
 }
 
 export { }