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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -238,6 +238,18 @@ getPurchasingCustomerMetafield は渡されたnamespaceとkeyに一致する現
238
238
 
239
239
  ***
240
240
 
241
+ #### getPurchasingCustomerSharing()
242
+
243
+ > **getPurchasingCustomerSharing**(): `Promise`\<`null` \| [`PurchasingCustomerSharing`](#type-aliasespurchasingcustomersharingmd)\>
244
+
245
+ getPurchasingCustomerSharing は共有化している顧客情報を返します。
246
+
247
+ ##### Returns
248
+
249
+ `Promise`\<`null` \| [`PurchasingCustomerSharing`](#type-aliasespurchasingcustomersharingmd)\>
250
+
251
+ ***
252
+
241
253
  #### getSharingPurchasingCustomerCount()
242
254
 
243
255
  > **getSharingPurchasingCustomerCount**(): `Promise`\<`number`\>
@@ -272,7 +284,7 @@ purchasingCustomerActivateCustomerSharing はクティベーションコード
272
284
 
273
285
  > **purchasingCustomerSendCustomerSharingActivationCode**(): `Promise`\<`null` \| [`CustomerSharingActivationCode`](#type-aliasescustomersharingactivationcodemd)\>
274
286
 
275
- purchasingCustomerSendCustomerSharingActivationCode はログインしているアカウントのメールアドレスに顧客情報共有のためのアクティベーションコードを送信する。
287
+ purchasingCustomerSendCustomerSharingActivationCode はログインしているアカウントのメールアドレスに顧客情報共有のためのアクティベーションコードを送信します。
276
288
 
277
289
  ##### Returns
278
290
 
@@ -313,6 +325,8 @@ purchasingCustomerSendCustomerSharingActivationCode はログインしている
313
325
  - [PurchasingCustomerDiscount](#type-aliasespurchasingcustomerdiscountmd)
314
326
  - [PurchasingCustomerDiscounts](#type-aliasespurchasingcustomerdiscountsmd)
315
327
  - [PurchasingCustomerMetafield](#type-aliasespurchasingcustomermetafieldmd)
328
+ - [PurchasingCustomerSharing](#type-aliasespurchasingcustomersharingmd)
329
+ - [Tenant](#type-aliasestenantmd)
316
330
 
317
331
  # Type Aliases
318
332
 
@@ -774,6 +788,12 @@ PointChangeのコミットタイムスタンプ
774
788
 
775
789
  ポイントの発生日時
776
790
 
791
+ #### tenant
792
+
793
+ > **tenant**: [`Tenant`](#type-aliasestenantmd)
794
+
795
+ ポイントに紐づくテナント情報
796
+
777
797
 
778
798
  <a name="type-aliasespointchangeactivitiesmd"></a>
779
799
 
@@ -828,6 +848,10 @@ PointChangeActivity はポイントの変動の履歴を表す。
828
848
 
829
849
  > `optional` **retailLocation**: [`Location`](#type-aliaseslocationmd)
830
850
 
851
+ #### tenant
852
+
853
+ > **tenant**: [`Tenant`](#type-aliasestenantmd)
854
+
831
855
  #### title
832
856
 
833
857
  > **title**: `string`
@@ -913,6 +937,10 @@ PointsPending は獲得予定ポイントを表す。
913
937
 
914
938
  > **sharingPurchasingCustomerCount**: `number`
915
939
 
940
+ #### tenant
941
+
942
+ > **tenant**: [`Tenant`](#type-aliasestenantmd)
943
+
916
944
 
917
945
  <a name="type-aliasespurchasingcustomerdiscountmd"></a>
918
946
 
@@ -1047,3 +1075,51 @@ PurchasingCustomerMetafield は購入者のカスタムメタフィールドを
1047
1075
  #### value
1048
1076
 
1049
1077
  > **value**: `string`
1078
+
1079
+
1080
+ <a name="type-aliasespurchasingcustomersharingmd"></a>
1081
+
1082
+ [**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
1083
+
1084
+ ***
1085
+
1086
+ [@builtbystack/sq-shopify-theme-sdk](#globalsmd) / PurchasingCustomerSharing
1087
+
1088
+ ## Type Alias: PurchasingCustomerSharing
1089
+
1090
+ > **PurchasingCustomerSharing**: `object`
1091
+
1092
+ ### Type declaration
1093
+
1094
+ #### id
1095
+
1096
+ > **id**: `string`
1097
+
1098
+ #### purchasingCustomers
1099
+
1100
+ > **purchasingCustomers**: [`PurchasingCustomer`](#type-aliasespurchasingcustomermd)[]
1101
+
1102
+
1103
+ <a name="type-aliasestenantmd"></a>
1104
+
1105
+ [**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
1106
+
1107
+ ***
1108
+
1109
+ [@builtbystack/sq-shopify-theme-sdk](#globalsmd) / Tenant
1110
+
1111
+ ## Type Alias: Tenant
1112
+
1113
+ > **Tenant**: `object`
1114
+
1115
+ Tenant はテナント情報を表す。
1116
+
1117
+ ### Type declaration
1118
+
1119
+ #### id
1120
+
1121
+ > **id**: `string`
1122
+
1123
+ #### name
1124
+
1125
+ > **name**: `string`
@@ -195,6 +195,10 @@ export declare type PointChange = {
195
195
  * ポイントの発生日時
196
196
  */
197
197
  pointChangeCreatedAt: Date;
198
+ /**
199
+ * ポイントに紐づくテナント情報
200
+ */
201
+ tenant: Tenant;
198
202
  /**
199
203
  * PointChangeのコミットタイムスタンプ
200
204
  */
@@ -217,6 +221,7 @@ export declare type PointChangeActivity = {
217
221
  title: string;
218
222
  pointChange: PointChange;
219
223
  retailLocation?: Location_2;
224
+ tenant: Tenant;
220
225
  };
221
226
 
222
227
  declare enum PointChangeActivitySortKey {
@@ -250,6 +255,7 @@ export declare type Points = {
250
255
  export declare type PurchasingCustomer = {
251
256
  id: string;
252
257
  sharingPurchasingCustomerCount: number;
258
+ tenant: Tenant;
253
259
  };
254
260
 
255
261
  /**
@@ -296,6 +302,11 @@ export declare type PurchasingCustomerMetafield = {
296
302
  value: string;
297
303
  };
298
304
 
305
+ export declare type PurchasingCustomerSharing = {
306
+ id: string;
307
+ purchasingCustomers: PurchasingCustomer[];
308
+ };
309
+
299
310
  export declare class SDK {
300
311
  private api;
301
312
  constructor(apiURL: string);
@@ -366,7 +377,11 @@ export declare class SDK {
366
377
  */
367
378
  getSharingPurchasingCustomerCount(): Promise<number>;
368
379
  /**
369
- * purchasingCustomerSendCustomerSharingActivationCode はログインしているアカウントのメールアドレスに顧客情報共有のためのアクティベーションコードを送信する。
380
+ * getPurchasingCustomerSharing は共有化している顧客情報を返します。
381
+ */
382
+ getPurchasingCustomerSharing(): Promise<PurchasingCustomerSharing | null>;
383
+ /**
384
+ * purchasingCustomerSendCustomerSharingActivationCode はログインしているアカウントのメールアドレスに顧客情報共有のためのアクティベーションコードを送信します。
370
385
  */
371
386
  purchasingCustomerSendCustomerSharingActivationCode(): Promise<CustomerSharingActivationCode | null>;
372
387
  /**
@@ -375,4 +390,12 @@ export declare class SDK {
375
390
  purchasingCustomerActivateCustomerSharing(email: string, activationCode: string): Promise<PurchasingCustomer | null>;
376
391
  }
377
392
 
393
+ /**
394
+ * Tenant はテナント情報を表す。
395
+ */
396
+ export declare type Tenant = {
397
+ id: string;
398
+ name: string;
399
+ };
400
+
378
401
  export { }