@wix/ecom 1.0.868 → 1.0.870
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/build/cjs/service-plugins-context.d.ts +1 -0
- package/build/cjs/service-plugins-context.js +2 -1
- package/build/cjs/service-plugins-context.js.map +1 -1
- package/build/cjs/service-plugins.d.ts +1 -0
- package/build/cjs/service-plugins.js +2 -1
- package/build/cjs/service-plugins.js.map +1 -1
- package/build/es/service-plugins-context.d.ts +1 -0
- package/build/es/service-plugins-context.js +1 -0
- package/build/es/service-plugins-context.js.map +1 -1
- package/build/es/service-plugins.d.ts +1 -0
- package/build/es/service-plugins.js +1 -0
- package/build/es/service-plugins.js.map +1 -1
- package/package.json +4 -3
- package/type-bundles/service-plugins-context.bundle.d.ts +814 -198
- package/type-bundles/service-plugins.bundle.d.ts +814 -198
|
@@ -86,26 +86,26 @@ interface GiftCardProviderConfig {
|
|
|
86
86
|
* }
|
|
87
87
|
* ```
|
|
88
88
|
*/
|
|
89
|
-
interface Context$
|
|
89
|
+
interface Context$9 {
|
|
90
90
|
/** A unique identifier of the request. You may print this ID to your logs to help with future debugging and easier correlation with Wix's logs. */
|
|
91
91
|
requestId?: string | null;
|
|
92
92
|
/** [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code. */
|
|
93
93
|
currency?: string | null;
|
|
94
94
|
/** An object that describes the identity that triggered this request. */
|
|
95
|
-
identity?: IdentificationData$
|
|
95
|
+
identity?: IdentificationData$9;
|
|
96
96
|
/** A string representing a language and region in the format of `"xx-XX"`. First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2. For example, `"en-US"`. */
|
|
97
97
|
languages?: string[];
|
|
98
98
|
/** The service provider app's instance ID. */
|
|
99
99
|
instanceId?: string | null;
|
|
100
100
|
}
|
|
101
|
-
declare enum IdentityType$
|
|
101
|
+
declare enum IdentityType$9 {
|
|
102
102
|
UNKNOWN = "UNKNOWN",
|
|
103
103
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
104
104
|
MEMBER = "MEMBER",
|
|
105
105
|
WIX_USER = "WIX_USER",
|
|
106
106
|
APP = "APP"
|
|
107
107
|
}
|
|
108
|
-
interface IdentificationData$
|
|
108
|
+
interface IdentificationData$9 extends IdentificationDataIdOneOf$9 {
|
|
109
109
|
/** ID of a site visitor that has not logged in to the site. */
|
|
110
110
|
anonymousVisitorId?: string;
|
|
111
111
|
/** ID of a site visitor that has logged in to the site. */
|
|
@@ -115,10 +115,10 @@ interface IdentificationData$8 extends IdentificationDataIdOneOf$8 {
|
|
|
115
115
|
/** ID of an app. */
|
|
116
116
|
appId?: string;
|
|
117
117
|
/** @readonly */
|
|
118
|
-
identityType?: IdentityType$
|
|
118
|
+
identityType?: IdentityType$9;
|
|
119
119
|
}
|
|
120
120
|
/** @oneof */
|
|
121
|
-
interface IdentificationDataIdOneOf$
|
|
121
|
+
interface IdentificationDataIdOneOf$9 {
|
|
122
122
|
/** ID of a site visitor that has not logged in to the site. */
|
|
123
123
|
anonymousVisitorId?: string;
|
|
124
124
|
/** ID of a site visitor that has logged in to the site. */
|
|
@@ -310,17 +310,17 @@ declare global {
|
|
|
310
310
|
|
|
311
311
|
interface GetBalanceEnvelope {
|
|
312
312
|
request: GetBalanceRequest;
|
|
313
|
-
metadata: Context$
|
|
313
|
+
metadata: Context$9;
|
|
314
314
|
}
|
|
315
315
|
interface RedeemEnvelope {
|
|
316
316
|
request: RedeemRequest;
|
|
317
|
-
metadata: Context$
|
|
317
|
+
metadata: Context$9;
|
|
318
318
|
}
|
|
319
319
|
interface _voidEnvelope {
|
|
320
320
|
request: VoidRequest;
|
|
321
|
-
metadata: Context$
|
|
321
|
+
metadata: Context$9;
|
|
322
322
|
}
|
|
323
|
-
declare const provideHandlers$
|
|
323
|
+
declare const provideHandlers$j: ServicePluginDefinition<{
|
|
324
324
|
/**
|
|
325
325
|
*
|
|
326
326
|
* This method retrieves gift card data from your app.
|
|
@@ -338,35 +338,35 @@ declare const provideHandlers$h: ServicePluginDefinition<{
|
|
|
338
338
|
_void(payload: _voidEnvelope): VoidResponse | Promise<VoidResponse>;
|
|
339
339
|
}>;
|
|
340
340
|
|
|
341
|
-
declare function createServicePluginModule$
|
|
341
|
+
declare function createServicePluginModule$9<T extends ServicePluginDefinition<any>>(servicePluginDefinition: T): BuildServicePluginDefinition<T> & T;
|
|
342
342
|
|
|
343
|
-
type _publicProvideHandlersType$
|
|
344
|
-
declare const provideHandlers$
|
|
343
|
+
type _publicProvideHandlersType$9 = typeof provideHandlers$j;
|
|
344
|
+
declare const provideHandlers$i: ReturnType<typeof createServicePluginModule$9<_publicProvideHandlersType>>;
|
|
345
345
|
|
|
346
|
-
type context$
|
|
347
|
-
declare const context$
|
|
348
|
-
type context$
|
|
349
|
-
declare const context$
|
|
350
|
-
type context$
|
|
351
|
-
declare const context$
|
|
352
|
-
type context$
|
|
353
|
-
type context$
|
|
354
|
-
type context$
|
|
355
|
-
declare const context$
|
|
356
|
-
type context$
|
|
357
|
-
declare const context$
|
|
358
|
-
type context$
|
|
359
|
-
declare const context$
|
|
360
|
-
type context$
|
|
361
|
-
type context$
|
|
362
|
-
type context$
|
|
363
|
-
declare const context$
|
|
364
|
-
type context$
|
|
365
|
-
type context$
|
|
366
|
-
type context$
|
|
367
|
-
type context$
|
|
368
|
-
declare namespace context$
|
|
369
|
-
export { context$
|
|
346
|
+
type context$9_AlreadyRedeemedWixError = AlreadyRedeemedWixError;
|
|
347
|
+
declare const context$9_AlreadyRedeemedWixError: typeof AlreadyRedeemedWixError;
|
|
348
|
+
type context$9_AlreadyVoidedWixError = AlreadyVoidedWixError;
|
|
349
|
+
declare const context$9_AlreadyVoidedWixError: typeof AlreadyVoidedWixError;
|
|
350
|
+
type context$9_CurrencyNotSupportedWixError = CurrencyNotSupportedWixError;
|
|
351
|
+
declare const context$9_CurrencyNotSupportedWixError: typeof CurrencyNotSupportedWixError;
|
|
352
|
+
type context$9_GetBalanceRequest = GetBalanceRequest;
|
|
353
|
+
type context$9_GetBalanceResponse = GetBalanceResponse;
|
|
354
|
+
type context$9_GiftCardDisabledWixError = GiftCardDisabledWixError;
|
|
355
|
+
declare const context$9_GiftCardDisabledWixError: typeof GiftCardDisabledWixError;
|
|
356
|
+
type context$9_GiftCardExpiredWixError = GiftCardExpiredWixError;
|
|
357
|
+
declare const context$9_GiftCardExpiredWixError: typeof GiftCardExpiredWixError;
|
|
358
|
+
type context$9_GiftCardNotFoundWixError = GiftCardNotFoundWixError;
|
|
359
|
+
declare const context$9_GiftCardNotFoundWixError: typeof GiftCardNotFoundWixError;
|
|
360
|
+
type context$9_GiftCardProviderConfig = GiftCardProviderConfig;
|
|
361
|
+
type context$9_GiftCardProviderEntity = GiftCardProviderEntity;
|
|
362
|
+
type context$9_InsufficientFundsWixError = InsufficientFundsWixError;
|
|
363
|
+
declare const context$9_InsufficientFundsWixError: typeof InsufficientFundsWixError;
|
|
364
|
+
type context$9_RedeemRequest = RedeemRequest;
|
|
365
|
+
type context$9_RedeemResponse = RedeemResponse;
|
|
366
|
+
type context$9_VoidRequest = VoidRequest;
|
|
367
|
+
type context$9_VoidResponse = VoidResponse;
|
|
368
|
+
declare namespace context$9 {
|
|
369
|
+
export { context$9_AlreadyRedeemedWixError as AlreadyRedeemedWixError, context$9_AlreadyVoidedWixError as AlreadyVoidedWixError, type Context$9 as Context, context$9_CurrencyNotSupportedWixError as CurrencyNotSupportedWixError, type context$9_GetBalanceRequest as GetBalanceRequest, type context$9_GetBalanceResponse as GetBalanceResponse, context$9_GiftCardDisabledWixError as GiftCardDisabledWixError, context$9_GiftCardExpiredWixError as GiftCardExpiredWixError, context$9_GiftCardNotFoundWixError as GiftCardNotFoundWixError, type context$9_GiftCardProviderConfig as GiftCardProviderConfig, type context$9_GiftCardProviderEntity as GiftCardProviderEntity, type IdentificationData$9 as IdentificationData, type IdentificationDataIdOneOf$9 as IdentificationDataIdOneOf, IdentityType$9 as IdentityType, context$9_InsufficientFundsWixError as InsufficientFundsWixError, type context$9_RedeemRequest as RedeemRequest, type context$9_RedeemResponse as RedeemResponse, TransactionNotFoundWixError$1 as TransactionNotFoundWixError, type context$9_VoidRequest as VoidRequest, type context$9_VoidResponse as VoidResponse, type _publicProvideHandlersType$9 as _publicProvideHandlersType, provideHandlers$i as provideHandlers, provideHandlers$j as publicProvideHandlers };
|
|
370
370
|
}
|
|
371
371
|
|
|
372
372
|
interface ListEligibleMembershipsRequest {
|
|
@@ -390,9 +390,9 @@ interface LineItem$5 {
|
|
|
390
390
|
/** Line item ID. */
|
|
391
391
|
_id?: string;
|
|
392
392
|
/** Catalog and item reference info. */
|
|
393
|
-
catalogReference?: CatalogReference$
|
|
393
|
+
catalogReference?: CatalogReference$8;
|
|
394
394
|
/** Properties of the service. When relevant, contains information such as date and number of participants. */
|
|
395
|
-
serviceProperties?: ServiceProperties$
|
|
395
|
+
serviceProperties?: ServiceProperties$2;
|
|
396
396
|
/**
|
|
397
397
|
* Root catalog item ID.
|
|
398
398
|
*
|
|
@@ -403,7 +403,7 @@ interface LineItem$5 {
|
|
|
403
403
|
rootCatalogItemId?: string | null;
|
|
404
404
|
}
|
|
405
405
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
406
|
-
interface CatalogReference$
|
|
406
|
+
interface CatalogReference$8 {
|
|
407
407
|
/** ID of the item within the catalog it belongs to. */
|
|
408
408
|
catalogItemId?: string;
|
|
409
409
|
/**
|
|
@@ -424,7 +424,7 @@ interface CatalogReference$7 {
|
|
|
424
424
|
*/
|
|
425
425
|
options?: Record<string, any> | null;
|
|
426
426
|
}
|
|
427
|
-
interface ServiceProperties$
|
|
427
|
+
interface ServiceProperties$2 {
|
|
428
428
|
/**
|
|
429
429
|
* Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
430
430
|
* For example, the start time of a class.
|
|
@@ -552,9 +552,9 @@ interface ChargeMembershipRequest {
|
|
|
552
552
|
*
|
|
553
553
|
* When relevant, this contains information such as date and number of participants.
|
|
554
554
|
*/
|
|
555
|
-
serviceProperties?: ServiceProperties$
|
|
555
|
+
serviceProperties?: ServiceProperties$2;
|
|
556
556
|
/** Catalog and item reference info. */
|
|
557
|
-
catalogReference: CatalogReference$
|
|
557
|
+
catalogReference: CatalogReference$8;
|
|
558
558
|
/**
|
|
559
559
|
* Root catalog item ID.
|
|
560
560
|
*
|
|
@@ -659,26 +659,26 @@ interface MembershipsSPIConfig {
|
|
|
659
659
|
* }
|
|
660
660
|
* ```
|
|
661
661
|
*/
|
|
662
|
-
interface Context$
|
|
662
|
+
interface Context$8 {
|
|
663
663
|
/** A unique identifier of the request. You may print this ID to your logs to help with future debugging and easier correlation with Wix's logs. */
|
|
664
664
|
requestId?: string | null;
|
|
665
665
|
/** [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code. */
|
|
666
666
|
currency?: string | null;
|
|
667
667
|
/** An object that describes the identity that triggered this request. */
|
|
668
|
-
identity?: IdentificationData$
|
|
668
|
+
identity?: IdentificationData$8;
|
|
669
669
|
/** A string representing a language and region in the format of `"xx-XX"`. First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2. For example, `"en-US"`. */
|
|
670
670
|
languages?: string[];
|
|
671
671
|
/** The service provider app's instance ID. */
|
|
672
672
|
instanceId?: string | null;
|
|
673
673
|
}
|
|
674
|
-
declare enum IdentityType$
|
|
674
|
+
declare enum IdentityType$8 {
|
|
675
675
|
UNKNOWN = "UNKNOWN",
|
|
676
676
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
677
677
|
MEMBER = "MEMBER",
|
|
678
678
|
WIX_USER = "WIX_USER",
|
|
679
679
|
APP = "APP"
|
|
680
680
|
}
|
|
681
|
-
interface IdentificationData$
|
|
681
|
+
interface IdentificationData$8 extends IdentificationDataIdOneOf$8 {
|
|
682
682
|
/** ID of a site visitor that has not logged in to the site. */
|
|
683
683
|
anonymousVisitorId?: string;
|
|
684
684
|
/** ID of a site visitor that has logged in to the site. */
|
|
@@ -688,10 +688,10 @@ interface IdentificationData$7 extends IdentificationDataIdOneOf$7 {
|
|
|
688
688
|
/** ID of an app. */
|
|
689
689
|
appId?: string;
|
|
690
690
|
/** @readonly */
|
|
691
|
-
identityType?: IdentityType$
|
|
691
|
+
identityType?: IdentityType$8;
|
|
692
692
|
}
|
|
693
693
|
/** @oneof */
|
|
694
|
-
interface IdentificationDataIdOneOf$
|
|
694
|
+
interface IdentificationDataIdOneOf$8 {
|
|
695
695
|
/** ID of a site visitor that has not logged in to the site. */
|
|
696
696
|
anonymousVisitorId?: string;
|
|
697
697
|
/** ID of a site visitor that has logged in to the site. */
|
|
@@ -854,21 +854,21 @@ declare class TransactionAlreadyVoidedWixError extends Error {
|
|
|
854
854
|
|
|
855
855
|
interface ListEligibleMembershipsEnvelope {
|
|
856
856
|
request: ListEligibleMembershipsRequest;
|
|
857
|
-
metadata: Context$
|
|
857
|
+
metadata: Context$8;
|
|
858
858
|
}
|
|
859
859
|
interface ChargeMembershipEnvelope {
|
|
860
860
|
request: ChargeMembershipRequest;
|
|
861
|
-
metadata: Context$
|
|
861
|
+
metadata: Context$8;
|
|
862
862
|
}
|
|
863
863
|
interface GetMembershipVoidabilityEnvelope {
|
|
864
864
|
request: GetMembershipVoidabilityRequest;
|
|
865
|
-
metadata: Context$
|
|
865
|
+
metadata: Context$8;
|
|
866
866
|
}
|
|
867
867
|
interface VoidMembershipChargeEnvelope {
|
|
868
868
|
request: VoidMembershipChargeRequest;
|
|
869
|
-
metadata: Context$
|
|
869
|
+
metadata: Context$8;
|
|
870
870
|
}
|
|
871
|
-
declare const provideHandlers$
|
|
871
|
+
declare const provideHandlers$h: ServicePluginDefinition<{
|
|
872
872
|
/**
|
|
873
873
|
*
|
|
874
874
|
* This method retrieves eligible memberships from your app. */
|
|
@@ -887,63 +887,63 @@ declare const provideHandlers$f: ServicePluginDefinition<{
|
|
|
887
887
|
voidMembershipCharge(payload: VoidMembershipChargeEnvelope): VoidMembershipChargeResponse | Promise<VoidMembershipChargeResponse>;
|
|
888
888
|
}>;
|
|
889
889
|
|
|
890
|
-
declare function createServicePluginModule$
|
|
890
|
+
declare function createServicePluginModule$8<T extends ServicePluginDefinition<any>>(servicePluginDefinition: T): BuildServicePluginDefinition<T> & T;
|
|
891
891
|
|
|
892
|
-
type _publicProvideHandlersType$
|
|
893
|
-
declare const provideHandlers$
|
|
892
|
+
type _publicProvideHandlersType$8 = typeof provideHandlers$h;
|
|
893
|
+
declare const provideHandlers$g: ReturnType<typeof createServicePluginModule$8<_publicProvideHandlersType>>;
|
|
894
894
|
|
|
895
|
-
type context$
|
|
896
|
-
type context$
|
|
897
|
-
type context$
|
|
898
|
-
type context$
|
|
899
|
-
type context$
|
|
900
|
-
type context$
|
|
901
|
-
declare const context$
|
|
902
|
-
type context$
|
|
903
|
-
type context$
|
|
904
|
-
type context$
|
|
905
|
-
type context$
|
|
906
|
-
type context$
|
|
907
|
-
declare const context$
|
|
908
|
-
type context$
|
|
909
|
-
type context$
|
|
910
|
-
type context$
|
|
911
|
-
declare const context$
|
|
912
|
-
type context$
|
|
913
|
-
type context$
|
|
914
|
-
type context$
|
|
915
|
-
declare const context$
|
|
916
|
-
type context$
|
|
917
|
-
declare const context$
|
|
918
|
-
type context$
|
|
919
|
-
declare const context$
|
|
920
|
-
type context$
|
|
921
|
-
type context$
|
|
922
|
-
type context$
|
|
923
|
-
type context$
|
|
924
|
-
type context$
|
|
925
|
-
type context$
|
|
926
|
-
type context$
|
|
927
|
-
declare const context$
|
|
928
|
-
type context$
|
|
929
|
-
declare const context$
|
|
930
|
-
type context$
|
|
931
|
-
declare const context$
|
|
932
|
-
type context$
|
|
933
|
-
type context$
|
|
934
|
-
declare namespace context$
|
|
935
|
-
export { type CatalogReference$
|
|
895
|
+
type context$8_ChargeMembershipRequest = ChargeMembershipRequest;
|
|
896
|
+
type context$8_ChargeMembershipResponse = ChargeMembershipResponse;
|
|
897
|
+
type context$8_Ended = Ended;
|
|
898
|
+
type context$8_GetMembershipVoidabilityRequest = GetMembershipVoidabilityRequest;
|
|
899
|
+
type context$8_GetMembershipVoidabilityResponse = GetMembershipVoidabilityResponse;
|
|
900
|
+
type context$8_InvalidSelectionWixError = InvalidSelectionWixError;
|
|
901
|
+
declare const context$8_InvalidSelectionWixError: typeof InvalidSelectionWixError;
|
|
902
|
+
type context$8_LineItemNotFoundInfo = LineItemNotFoundInfo;
|
|
903
|
+
type context$8_ListEligibleMembershipsRequest = ListEligibleMembershipsRequest;
|
|
904
|
+
type context$8_ListEligibleMembershipsResponse = ListEligibleMembershipsResponse;
|
|
905
|
+
type context$8_MembershipAlreadyChargedError = MembershipAlreadyChargedError;
|
|
906
|
+
type context$8_MembershipAlreadyChargedWixError = MembershipAlreadyChargedWixError;
|
|
907
|
+
declare const context$8_MembershipAlreadyChargedWixError: typeof MembershipAlreadyChargedWixError;
|
|
908
|
+
type context$8_MembershipCannotBeChargedError = MembershipCannotBeChargedError;
|
|
909
|
+
type context$8_MembershipCannotBeChargedErrorErrorDataOneOf = MembershipCannotBeChargedErrorErrorDataOneOf;
|
|
910
|
+
type context$8_MembershipCannotBeChargedType = MembershipCannotBeChargedType;
|
|
911
|
+
declare const context$8_MembershipCannotBeChargedType: typeof MembershipCannotBeChargedType;
|
|
912
|
+
type context$8_MembershipCannotBeUsedForLineItemInfo = MembershipCannotBeUsedForLineItemInfo;
|
|
913
|
+
type context$8_MembershipCannotBeUsedForLineItemsInfo = MembershipCannotBeUsedForLineItemsInfo;
|
|
914
|
+
type context$8_MembershipCannotBeUsedWixError = MembershipCannotBeUsedWixError;
|
|
915
|
+
declare const context$8_MembershipCannotBeUsedWixError: typeof MembershipCannotBeUsedWixError;
|
|
916
|
+
type context$8_MembershipDoesNotApplyToItemWixError = MembershipDoesNotApplyToItemWixError;
|
|
917
|
+
declare const context$8_MembershipDoesNotApplyToItemWixError: typeof MembershipDoesNotApplyToItemWixError;
|
|
918
|
+
type context$8_MembershipErrorType = MembershipErrorType;
|
|
919
|
+
declare const context$8_MembershipErrorType: typeof MembershipErrorType;
|
|
920
|
+
type context$8_MembershipInvalidSelectionError = MembershipInvalidSelectionError;
|
|
921
|
+
type context$8_MembershipInvalidSelectionErrorErrorDataOneOf = MembershipInvalidSelectionErrorErrorDataOneOf;
|
|
922
|
+
type context$8_MembershipInvalidSelectionErrors = MembershipInvalidSelectionErrors;
|
|
923
|
+
type context$8_MembershipsSPIConfig = MembershipsSPIConfig;
|
|
924
|
+
type context$8_NotStartedYet = NotStartedYet;
|
|
925
|
+
type context$8_OutOfCredits = OutOfCredits;
|
|
926
|
+
type context$8_TransactionAlreadyVoidedWixError = TransactionAlreadyVoidedWixError;
|
|
927
|
+
declare const context$8_TransactionAlreadyVoidedWixError: typeof TransactionAlreadyVoidedWixError;
|
|
928
|
+
type context$8_TransactionCannotBeVoidedWixError = TransactionCannotBeVoidedWixError;
|
|
929
|
+
declare const context$8_TransactionCannotBeVoidedWixError: typeof TransactionCannotBeVoidedWixError;
|
|
930
|
+
type context$8_TransactionNotFoundWixError = TransactionNotFoundWixError;
|
|
931
|
+
declare const context$8_TransactionNotFoundWixError: typeof TransactionNotFoundWixError;
|
|
932
|
+
type context$8_VoidMembershipChargeRequest = VoidMembershipChargeRequest;
|
|
933
|
+
type context$8_VoidMembershipChargeResponse = VoidMembershipChargeResponse;
|
|
934
|
+
declare namespace context$8 {
|
|
935
|
+
export { type CatalogReference$8 as CatalogReference, type context$8_ChargeMembershipRequest as ChargeMembershipRequest, type context$8_ChargeMembershipResponse as ChargeMembershipResponse, type Context$8 as Context, type context$8_Ended as Ended, type context$8_GetMembershipVoidabilityRequest as GetMembershipVoidabilityRequest, type context$8_GetMembershipVoidabilityResponse as GetMembershipVoidabilityResponse, type IdentificationData$8 as IdentificationData, type IdentificationDataIdOneOf$8 as IdentificationDataIdOneOf, IdentityType$8 as IdentityType, type InvalidMembership$1 as InvalidMembership, context$8_InvalidSelectionWixError as InvalidSelectionWixError, type LineItem$5 as LineItem, type context$8_LineItemNotFoundInfo as LineItemNotFoundInfo, type context$8_ListEligibleMembershipsRequest as ListEligibleMembershipsRequest, type context$8_ListEligibleMembershipsResponse as ListEligibleMembershipsResponse, type Membership$1 as Membership, type context$8_MembershipAlreadyChargedError as MembershipAlreadyChargedError, context$8_MembershipAlreadyChargedWixError as MembershipAlreadyChargedWixError, type context$8_MembershipCannotBeChargedError as MembershipCannotBeChargedError, type context$8_MembershipCannotBeChargedErrorErrorDataOneOf as MembershipCannotBeChargedErrorErrorDataOneOf, context$8_MembershipCannotBeChargedType as MembershipCannotBeChargedType, type context$8_MembershipCannotBeUsedForLineItemInfo as MembershipCannotBeUsedForLineItemInfo, type context$8_MembershipCannotBeUsedForLineItemsInfo as MembershipCannotBeUsedForLineItemsInfo, context$8_MembershipCannotBeUsedWixError as MembershipCannotBeUsedWixError, context$8_MembershipDoesNotApplyToItemWixError as MembershipDoesNotApplyToItemWixError, context$8_MembershipErrorType as MembershipErrorType, type context$8_MembershipInvalidSelectionError as MembershipInvalidSelectionError, type context$8_MembershipInvalidSelectionErrorErrorDataOneOf as MembershipInvalidSelectionErrorErrorDataOneOf, type context$8_MembershipInvalidSelectionErrors as MembershipInvalidSelectionErrors, type MembershipName$1 as MembershipName, type MembershipPaymentCredits$1 as MembershipPaymentCredits, type context$8_MembershipsSPIConfig as MembershipsSPIConfig, type context$8_NotStartedYet as NotStartedYet, type context$8_OutOfCredits as OutOfCredits, type SelectedMembership$1 as SelectedMembership, type SelectedMemberships$1 as SelectedMemberships, type ServiceProperties$2 as ServiceProperties, context$8_TransactionAlreadyVoidedWixError as TransactionAlreadyVoidedWixError, context$8_TransactionCannotBeVoidedWixError as TransactionCannotBeVoidedWixError, context$8_TransactionNotFoundWixError as TransactionNotFoundWixError, type context$8_VoidMembershipChargeRequest as VoidMembershipChargeRequest, type context$8_VoidMembershipChargeResponse as VoidMembershipChargeResponse, type _publicProvideHandlersType$8 as _publicProvideHandlersType, provideHandlers$g as provideHandlers, provideHandlers$h as publicProvideHandlers };
|
|
936
936
|
}
|
|
937
937
|
|
|
938
938
|
/** additional information can be passed via aspects, for example GEO */
|
|
939
939
|
interface GetRecommendationsRequest {
|
|
940
940
|
/** The set of items used by algorithms with the `RELATED_ITEMS` `algorithmType` to determine related item recommendations. */
|
|
941
|
-
items?: CatalogReference$
|
|
941
|
+
items?: CatalogReference$7[];
|
|
942
942
|
/** List of algorithms used to find recommended items. Items will be returned in a separate object for each algorithm */
|
|
943
943
|
algorithmIds?: string[];
|
|
944
944
|
}
|
|
945
945
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
946
|
-
interface CatalogReference$
|
|
946
|
+
interface CatalogReference$7 {
|
|
947
947
|
/** ID of the item within the catalog it belongs to. */
|
|
948
948
|
catalogItemId?: string;
|
|
949
949
|
/**
|
|
@@ -976,7 +976,7 @@ interface RecommendationForAlgorithm {
|
|
|
976
976
|
/** Id of the algorithm that provided the recommendation. */
|
|
977
977
|
algorithmId?: string;
|
|
978
978
|
/** Item recommendations provided by the algorithm. Depending on the algorithm, these recommendations may be influenced by the items provided in the request. */
|
|
979
|
-
recommendedItems?: CatalogReference$
|
|
979
|
+
recommendedItems?: CatalogReference$7[];
|
|
980
980
|
}
|
|
981
981
|
interface RecommendationAlgorithmNotSupported {
|
|
982
982
|
/** Not supported algorithms. */
|
|
@@ -984,7 +984,7 @@ interface RecommendationAlgorithmNotSupported {
|
|
|
984
984
|
}
|
|
985
985
|
interface ItemAppIdNotSupportedError {
|
|
986
986
|
/** Items with not supported catalogs. */
|
|
987
|
-
items?: CatalogReference$
|
|
987
|
+
items?: CatalogReference$7[];
|
|
988
988
|
}
|
|
989
989
|
interface RecommendationsProviderConfig {
|
|
990
990
|
/** URI where the application implementing the SPI is deployed. */
|
|
@@ -1028,26 +1028,26 @@ declare enum AlgorithmType {
|
|
|
1028
1028
|
* }
|
|
1029
1029
|
* ```
|
|
1030
1030
|
*/
|
|
1031
|
-
interface Context$
|
|
1031
|
+
interface Context$7 {
|
|
1032
1032
|
/** A unique identifier of the request. You may print this ID to your logs to help with future debugging and easier correlation with Wix's logs. */
|
|
1033
1033
|
requestId?: string | null;
|
|
1034
1034
|
/** [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code. */
|
|
1035
1035
|
currency?: string | null;
|
|
1036
1036
|
/** An object that describes the identity that triggered this request. */
|
|
1037
|
-
identity?: IdentificationData$
|
|
1037
|
+
identity?: IdentificationData$7;
|
|
1038
1038
|
/** A string representing a language and region in the format of `"xx-XX"`. First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2. For example, `"en-US"`. */
|
|
1039
1039
|
languages?: string[];
|
|
1040
1040
|
/** The service provider app's instance ID. */
|
|
1041
1041
|
instanceId?: string | null;
|
|
1042
1042
|
}
|
|
1043
|
-
declare enum IdentityType$
|
|
1043
|
+
declare enum IdentityType$7 {
|
|
1044
1044
|
UNKNOWN = "UNKNOWN",
|
|
1045
1045
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1046
1046
|
MEMBER = "MEMBER",
|
|
1047
1047
|
WIX_USER = "WIX_USER",
|
|
1048
1048
|
APP = "APP"
|
|
1049
1049
|
}
|
|
1050
|
-
interface IdentificationData$
|
|
1050
|
+
interface IdentificationData$7 extends IdentificationDataIdOneOf$7 {
|
|
1051
1051
|
/** ID of a site visitor that has not logged in to the site. */
|
|
1052
1052
|
anonymousVisitorId?: string;
|
|
1053
1053
|
/** ID of a site visitor that has logged in to the site. */
|
|
@@ -1057,10 +1057,10 @@ interface IdentificationData$6 extends IdentificationDataIdOneOf$6 {
|
|
|
1057
1057
|
/** ID of an app. */
|
|
1058
1058
|
appId?: string;
|
|
1059
1059
|
/** @readonly */
|
|
1060
|
-
identityType?: IdentityType$
|
|
1060
|
+
identityType?: IdentityType$7;
|
|
1061
1061
|
}
|
|
1062
1062
|
/** @oneof */
|
|
1063
|
-
interface IdentificationDataIdOneOf$
|
|
1063
|
+
interface IdentificationDataIdOneOf$7 {
|
|
1064
1064
|
/** ID of a site visitor that has not logged in to the site. */
|
|
1065
1065
|
anonymousVisitorId?: string;
|
|
1066
1066
|
/** ID of a site visitor that has logged in to the site. */
|
|
@@ -1114,9 +1114,9 @@ declare class ItemAppIdNotSupportedWixError extends Error {
|
|
|
1114
1114
|
|
|
1115
1115
|
interface GetRecommendationsEnvelope {
|
|
1116
1116
|
request: GetRecommendationsRequest;
|
|
1117
|
-
metadata: Context$
|
|
1117
|
+
metadata: Context$7;
|
|
1118
1118
|
}
|
|
1119
|
-
declare const provideHandlers$
|
|
1119
|
+
declare const provideHandlers$f: ServicePluginDefinition<{
|
|
1120
1120
|
/**
|
|
1121
1121
|
*
|
|
1122
1122
|
* This method retrieves an array containing the lists of recommended items returned by each algorithm. Items must be selected from catalogs in Wix apps installed on the site.
|
|
@@ -1126,26 +1126,26 @@ declare const provideHandlers$d: ServicePluginDefinition<{
|
|
|
1126
1126
|
getRecommendations(payload: GetRecommendationsEnvelope): GetRecommendationsResponse | Promise<GetRecommendationsResponse>;
|
|
1127
1127
|
}>;
|
|
1128
1128
|
|
|
1129
|
-
declare function createServicePluginModule$
|
|
1129
|
+
declare function createServicePluginModule$7<T extends ServicePluginDefinition<any>>(servicePluginDefinition: T): BuildServicePluginDefinition<T> & T;
|
|
1130
1130
|
|
|
1131
|
-
type _publicProvideHandlersType$
|
|
1132
|
-
declare const provideHandlers$
|
|
1131
|
+
type _publicProvideHandlersType$7 = typeof provideHandlers$f;
|
|
1132
|
+
declare const provideHandlers$e: ReturnType<typeof createServicePluginModule$7<_publicProvideHandlersType>>;
|
|
1133
1133
|
|
|
1134
|
-
type context$
|
|
1135
|
-
type context$
|
|
1136
|
-
declare const context$
|
|
1137
|
-
type context$
|
|
1138
|
-
declare const context$
|
|
1139
|
-
type context$
|
|
1140
|
-
type context$
|
|
1141
|
-
type context$
|
|
1142
|
-
type context$
|
|
1143
|
-
declare const context$
|
|
1144
|
-
type context$
|
|
1145
|
-
type context$
|
|
1146
|
-
type context$
|
|
1147
|
-
declare namespace context$
|
|
1148
|
-
export { type context$
|
|
1134
|
+
type context$7_AlgorithmConfig = AlgorithmConfig;
|
|
1135
|
+
type context$7_AlgorithmNotSupportedWixError = AlgorithmNotSupportedWixError;
|
|
1136
|
+
declare const context$7_AlgorithmNotSupportedWixError: typeof AlgorithmNotSupportedWixError;
|
|
1137
|
+
type context$7_AlgorithmType = AlgorithmType;
|
|
1138
|
+
declare const context$7_AlgorithmType: typeof AlgorithmType;
|
|
1139
|
+
type context$7_GetRecommendationsRequest = GetRecommendationsRequest;
|
|
1140
|
+
type context$7_GetRecommendationsResponse = GetRecommendationsResponse;
|
|
1141
|
+
type context$7_ItemAppIdNotSupportedError = ItemAppIdNotSupportedError;
|
|
1142
|
+
type context$7_ItemAppIdNotSupportedWixError = ItemAppIdNotSupportedWixError;
|
|
1143
|
+
declare const context$7_ItemAppIdNotSupportedWixError: typeof ItemAppIdNotSupportedWixError;
|
|
1144
|
+
type context$7_RecommendationAlgorithmNotSupported = RecommendationAlgorithmNotSupported;
|
|
1145
|
+
type context$7_RecommendationForAlgorithm = RecommendationForAlgorithm;
|
|
1146
|
+
type context$7_RecommendationsProviderConfig = RecommendationsProviderConfig;
|
|
1147
|
+
declare namespace context$7 {
|
|
1148
|
+
export { type context$7_AlgorithmConfig as AlgorithmConfig, context$7_AlgorithmNotSupportedWixError as AlgorithmNotSupportedWixError, context$7_AlgorithmType as AlgorithmType, type CatalogReference$7 as CatalogReference, type Context$7 as Context, type context$7_GetRecommendationsRequest as GetRecommendationsRequest, type context$7_GetRecommendationsResponse as GetRecommendationsResponse, type IdentificationData$7 as IdentificationData, type IdentificationDataIdOneOf$7 as IdentificationDataIdOneOf, IdentityType$7 as IdentityType, type context$7_ItemAppIdNotSupportedError as ItemAppIdNotSupportedError, context$7_ItemAppIdNotSupportedWixError as ItemAppIdNotSupportedWixError, type context$7_RecommendationAlgorithmNotSupported as RecommendationAlgorithmNotSupported, type context$7_RecommendationForAlgorithm as RecommendationForAlgorithm, type context$7_RecommendationsProviderConfig as RecommendationsProviderConfig, type _publicProvideHandlersType$7 as _publicProvideHandlersType, provideHandlers$e as provideHandlers, provideHandlers$f as publicProvideHandlers };
|
|
1149
1149
|
}
|
|
1150
1150
|
|
|
1151
1151
|
interface GetShippingRatesRequest {
|
|
@@ -1164,7 +1164,7 @@ interface GetShippingRatesRequest {
|
|
|
1164
1164
|
* + `"KG"`: kilograms
|
|
1165
1165
|
* + `"LB"`: pounds
|
|
1166
1166
|
*/
|
|
1167
|
-
weightUnit?: WeightUnit$
|
|
1167
|
+
weightUnit?: WeightUnit$3;
|
|
1168
1168
|
/**
|
|
1169
1169
|
* Whether tax is included in the items' prices.
|
|
1170
1170
|
* @deprecated Whether tax is included in the items' prices.
|
|
@@ -1187,9 +1187,9 @@ interface ProductItem {
|
|
|
1187
1187
|
/** The number of items ordered. */
|
|
1188
1188
|
quantity?: number;
|
|
1189
1189
|
/** Reference to the item's origin catalog. */
|
|
1190
|
-
catalogReference?: CatalogReference$
|
|
1190
|
+
catalogReference?: CatalogReference$6;
|
|
1191
1191
|
/** Physical properties of the item. */
|
|
1192
|
-
physicalProperties?: PhysicalProperties$
|
|
1192
|
+
physicalProperties?: PhysicalProperties$4;
|
|
1193
1193
|
/** Price of a single item after discounts. */
|
|
1194
1194
|
price?: string;
|
|
1195
1195
|
/** Total line item price before discounts. */
|
|
@@ -1206,7 +1206,7 @@ interface ProductItem {
|
|
|
1206
1206
|
taxIncludedInPrice?: boolean | null;
|
|
1207
1207
|
}
|
|
1208
1208
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
1209
|
-
interface CatalogReference$
|
|
1209
|
+
interface CatalogReference$6 {
|
|
1210
1210
|
/** ID of the item within the catalog it belongs to. */
|
|
1211
1211
|
catalogItemId?: string;
|
|
1212
1212
|
/**
|
|
@@ -1227,7 +1227,7 @@ interface CatalogReference$5 {
|
|
|
1227
1227
|
*/
|
|
1228
1228
|
options?: Record<string, any> | null;
|
|
1229
1229
|
}
|
|
1230
|
-
interface PhysicalProperties$
|
|
1230
|
+
interface PhysicalProperties$4 {
|
|
1231
1231
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
1232
1232
|
weight?: number | null;
|
|
1233
1233
|
/** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
|
|
@@ -1332,7 +1332,7 @@ declare enum VatType$3 {
|
|
|
1332
1332
|
/** CNPJ - for corporations */
|
|
1333
1333
|
CNPJ = "CNPJ"
|
|
1334
1334
|
}
|
|
1335
|
-
declare enum WeightUnit$
|
|
1335
|
+
declare enum WeightUnit$3 {
|
|
1336
1336
|
/** Weight unit can't be classified, due to an error */
|
|
1337
1337
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
1338
1338
|
/** Kilograms */
|
|
@@ -1551,26 +1551,26 @@ interface ShippingRatesConfig {
|
|
|
1551
1551
|
* }
|
|
1552
1552
|
* ```
|
|
1553
1553
|
*/
|
|
1554
|
-
interface Context$
|
|
1554
|
+
interface Context$6 {
|
|
1555
1555
|
/** A unique identifier of the request. You may print this ID to your logs to help with future debugging and easier correlation with Wix's logs. */
|
|
1556
1556
|
requestId?: string | null;
|
|
1557
1557
|
/** [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code. */
|
|
1558
1558
|
currency?: string | null;
|
|
1559
1559
|
/** An object that describes the identity that triggered this request. */
|
|
1560
|
-
identity?: IdentificationData$
|
|
1560
|
+
identity?: IdentificationData$6;
|
|
1561
1561
|
/** A string representing a language and region in the format of `"xx-XX"`. First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2. For example, `"en-US"`. */
|
|
1562
1562
|
languages?: string[];
|
|
1563
1563
|
/** The service provider app's instance ID. */
|
|
1564
1564
|
instanceId?: string | null;
|
|
1565
1565
|
}
|
|
1566
|
-
declare enum IdentityType$
|
|
1566
|
+
declare enum IdentityType$6 {
|
|
1567
1567
|
UNKNOWN = "UNKNOWN",
|
|
1568
1568
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1569
1569
|
MEMBER = "MEMBER",
|
|
1570
1570
|
WIX_USER = "WIX_USER",
|
|
1571
1571
|
APP = "APP"
|
|
1572
1572
|
}
|
|
1573
|
-
interface IdentificationData$
|
|
1573
|
+
interface IdentificationData$6 extends IdentificationDataIdOneOf$6 {
|
|
1574
1574
|
/** ID of a site visitor that has not logged in to the site. */
|
|
1575
1575
|
anonymousVisitorId?: string;
|
|
1576
1576
|
/** ID of a site visitor that has logged in to the site. */
|
|
@@ -1580,10 +1580,10 @@ interface IdentificationData$5 extends IdentificationDataIdOneOf$5 {
|
|
|
1580
1580
|
/** ID of an app. */
|
|
1581
1581
|
appId?: string;
|
|
1582
1582
|
/** @readonly */
|
|
1583
|
-
identityType?: IdentityType$
|
|
1583
|
+
identityType?: IdentityType$6;
|
|
1584
1584
|
}
|
|
1585
1585
|
/** @oneof */
|
|
1586
|
-
interface IdentificationDataIdOneOf$
|
|
1586
|
+
interface IdentificationDataIdOneOf$6 {
|
|
1587
1587
|
/** ID of a site visitor that has not logged in to the site. */
|
|
1588
1588
|
anonymousVisitorId?: string;
|
|
1589
1589
|
/** ID of a site visitor that has logged in to the site. */
|
|
@@ -1711,9 +1711,9 @@ declare class GenericShippingRatesWixError extends Error {
|
|
|
1711
1711
|
|
|
1712
1712
|
interface GetShippingRatesEnvelope {
|
|
1713
1713
|
request: GetShippingRatesRequest;
|
|
1714
|
-
metadata: Context$
|
|
1714
|
+
metadata: Context$6;
|
|
1715
1715
|
}
|
|
1716
|
-
declare const provideHandlers$
|
|
1716
|
+
declare const provideHandlers$d: ServicePluginDefinition<{
|
|
1717
1717
|
/**
|
|
1718
1718
|
*
|
|
1719
1719
|
* This method retrieves applicable shipping rates for a delivery from your app.
|
|
@@ -1724,43 +1724,43 @@ declare const provideHandlers$b: ServicePluginDefinition<{
|
|
|
1724
1724
|
getShippingRates(payload: GetShippingRatesEnvelope): GetShippingRatesResponse | Promise<GetShippingRatesResponse>;
|
|
1725
1725
|
}>;
|
|
1726
1726
|
|
|
1727
|
-
declare function createServicePluginModule$
|
|
1727
|
+
declare function createServicePluginModule$6<T extends ServicePluginDefinition<any>>(servicePluginDefinition: T): BuildServicePluginDefinition<T> & T;
|
|
1728
1728
|
|
|
1729
|
-
type _publicProvideHandlersType$
|
|
1730
|
-
declare const provideHandlers$
|
|
1729
|
+
type _publicProvideHandlersType$6 = typeof provideHandlers$d;
|
|
1730
|
+
declare const provideHandlers$c: ReturnType<typeof createServicePluginModule$6<_publicProvideHandlersType>>;
|
|
1731
1731
|
|
|
1732
|
-
type context$
|
|
1733
|
-
type context$
|
|
1734
|
-
type context$
|
|
1735
|
-
type context$
|
|
1736
|
-
type context$
|
|
1737
|
-
type context$
|
|
1738
|
-
type context$
|
|
1739
|
-
declare const context$
|
|
1740
|
-
type context$
|
|
1741
|
-
type context$
|
|
1742
|
-
type context$
|
|
1743
|
-
type context$
|
|
1744
|
-
type context$
|
|
1745
|
-
type context$
|
|
1746
|
-
declare const context$
|
|
1747
|
-
type context$
|
|
1748
|
-
type context$
|
|
1749
|
-
declare const context$
|
|
1750
|
-
type context$
|
|
1751
|
-
type context$
|
|
1752
|
-
declare const context$
|
|
1753
|
-
type context$
|
|
1754
|
-
type context$
|
|
1755
|
-
type context$
|
|
1756
|
-
type context$
|
|
1757
|
-
type context$
|
|
1758
|
-
type context$
|
|
1759
|
-
type context$
|
|
1760
|
-
type context$
|
|
1761
|
-
declare const context$
|
|
1762
|
-
declare namespace context$
|
|
1763
|
-
export { type context$
|
|
1732
|
+
type context$6_AdditionalCharge = AdditionalCharge;
|
|
1733
|
+
type context$6_AddressStreetOneOf = AddressStreetOneOf;
|
|
1734
|
+
type context$6_Column = Column;
|
|
1735
|
+
type context$6_DashboardTable = DashboardTable;
|
|
1736
|
+
type context$6_DeliveryPreferences = DeliveryPreferences;
|
|
1737
|
+
type context$6_GenericShippingRatesError = GenericShippingRatesError;
|
|
1738
|
+
type context$6_GenericShippingRatesWixError = GenericShippingRatesWixError;
|
|
1739
|
+
declare const context$6_GenericShippingRatesWixError: typeof GenericShippingRatesWixError;
|
|
1740
|
+
type context$6_GetDashboardTablesRequest = GetDashboardTablesRequest;
|
|
1741
|
+
type context$6_GetDashboardTablesResponse = GetDashboardTablesResponse;
|
|
1742
|
+
type context$6_GetShippingRatesRequest = GetShippingRatesRequest;
|
|
1743
|
+
type context$6_GetShippingRatesResponse = GetShippingRatesResponse;
|
|
1744
|
+
type context$6_InvalidAddressError = InvalidAddressError;
|
|
1745
|
+
type context$6_InvalidAddressWixError = InvalidAddressWixError;
|
|
1746
|
+
declare const context$6_InvalidAddressWixError: typeof InvalidAddressWixError;
|
|
1747
|
+
type context$6_InvalidPostalCodeError = InvalidPostalCodeError;
|
|
1748
|
+
type context$6_InvalidPostalCodeWixError = InvalidPostalCodeWixError;
|
|
1749
|
+
declare const context$6_InvalidPostalCodeWixError: typeof InvalidPostalCodeWixError;
|
|
1750
|
+
type context$6_MissingPostalCodeError = MissingPostalCodeError;
|
|
1751
|
+
type context$6_MissingPostalCodeWixError = MissingPostalCodeWixError;
|
|
1752
|
+
declare const context$6_MissingPostalCodeWixError: typeof MissingPostalCodeWixError;
|
|
1753
|
+
type context$6_PartialOption = PartialOption;
|
|
1754
|
+
type context$6_ProductItem = ProductItem;
|
|
1755
|
+
type context$6_RegionDashboardTables = RegionDashboardTables;
|
|
1756
|
+
type context$6_Row = Row;
|
|
1757
|
+
type context$6_ShippingRatesConfig = ShippingRatesConfig;
|
|
1758
|
+
type context$6_StandardDetails = StandardDetails;
|
|
1759
|
+
type context$6_Subdivision = Subdivision;
|
|
1760
|
+
type context$6_SubdivisionType = SubdivisionType;
|
|
1761
|
+
declare const context$6_SubdivisionType: typeof SubdivisionType;
|
|
1762
|
+
declare namespace context$6 {
|
|
1763
|
+
export { type context$6_AdditionalCharge as AdditionalCharge, type Address$3 as Address, type AddressLocation$3 as AddressLocation, type context$6_AddressStreetOneOf as AddressStreetOneOf, type ApplicationError$1 as ApplicationError, type CatalogReference$6 as CatalogReference, ChargeType$2 as ChargeType, type context$6_Column as Column, type Context$6 as Context, type context$6_DashboardTable as DashboardTable, type DeliveryLogistics$2 as DeliveryLogistics, type context$6_DeliveryPreferences as DeliveryPreferences, type DeliveryTimeSlot$1 as DeliveryTimeSlot, type ExternalReference$2 as ExternalReference, type FieldViolation$1 as FieldViolation, type FullAddressContactDetails$3 as FullAddressContactDetails, type context$6_GenericShippingRatesError as GenericShippingRatesError, context$6_GenericShippingRatesWixError as GenericShippingRatesWixError, type context$6_GetDashboardTablesRequest as GetDashboardTablesRequest, type context$6_GetDashboardTablesResponse as GetDashboardTablesResponse, type context$6_GetShippingRatesRequest as GetShippingRatesRequest, type context$6_GetShippingRatesResponse as GetShippingRatesResponse, type IdentificationData$6 as IdentificationData, type IdentificationDataIdOneOf$6 as IdentificationDataIdOneOf, IdentityType$6 as IdentityType, type context$6_InvalidAddressError as InvalidAddressError, context$6_InvalidAddressWixError as InvalidAddressWixError, type context$6_InvalidPostalCodeError as InvalidPostalCodeError, context$6_InvalidPostalCodeWixError as InvalidPostalCodeWixError, type context$6_MissingPostalCodeError as MissingPostalCodeError, context$6_MissingPostalCodeWixError as MissingPostalCodeWixError, type context$6_PartialOption as PartialOption, type PhysicalProperties$4 as PhysicalProperties, type PickupDetails$2 as PickupDetails, PickupMethod$2 as PickupMethod, type context$6_ProductItem as ProductItem, type context$6_RegionDashboardTables as RegionDashboardTables, type context$6_Row as Row, RuleType$1 as RuleType, type ShippingOption$1 as ShippingOption, type ShippingPrice$1 as ShippingPrice, type context$6_ShippingRatesConfig as ShippingRatesConfig, type context$6_StandardDetails as StandardDetails, type StreetAddress$3 as StreetAddress, type context$6_Subdivision as Subdivision, context$6_SubdivisionType as SubdivisionType, type VatId$3 as VatId, VatType$3 as VatType, WeightUnit$3 as WeightUnit, type _publicProvideHandlersType$6 as _publicProvideHandlersType, provideHandlers$c as provideHandlers, provideHandlers$d as publicProvideHandlers };
|
|
1764
1764
|
}
|
|
1765
1765
|
|
|
1766
1766
|
interface CalculateAdditionalFeesRequest {
|
|
@@ -1792,13 +1792,13 @@ interface LineItem$4 {
|
|
|
1792
1792
|
*/
|
|
1793
1793
|
quantity?: number | null;
|
|
1794
1794
|
/** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
|
|
1795
|
-
catalogReference?: CatalogReference$
|
|
1795
|
+
catalogReference?: CatalogReference$5;
|
|
1796
1796
|
/** Item name. */
|
|
1797
1797
|
productName?: string | null;
|
|
1798
1798
|
/** Price for a single item. */
|
|
1799
1799
|
price?: string;
|
|
1800
1800
|
/** Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability. */
|
|
1801
|
-
physicalProperties?: PhysicalProperties$
|
|
1801
|
+
physicalProperties?: PhysicalProperties$3;
|
|
1802
1802
|
/**
|
|
1803
1803
|
* Partial payment to be paid upfront during the checkout.
|
|
1804
1804
|
* Only eligible for catalog items with `lineItem.paymentOption` type of `DEPOSIT_ONLINE`.
|
|
@@ -1806,7 +1806,7 @@ interface LineItem$4 {
|
|
|
1806
1806
|
depositAmount?: string | null;
|
|
1807
1807
|
}
|
|
1808
1808
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
1809
|
-
interface CatalogReference$
|
|
1809
|
+
interface CatalogReference$5 {
|
|
1810
1810
|
/** ID of the item within the catalog it belongs to. */
|
|
1811
1811
|
catalogItemId?: string;
|
|
1812
1812
|
/**
|
|
@@ -1827,7 +1827,7 @@ interface CatalogReference$4 {
|
|
|
1827
1827
|
*/
|
|
1828
1828
|
options?: Record<string, any> | null;
|
|
1829
1829
|
}
|
|
1830
|
-
interface PhysicalProperties$
|
|
1830
|
+
interface PhysicalProperties$3 {
|
|
1831
1831
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
1832
1832
|
weight?: number | null;
|
|
1833
1833
|
/** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
|
|
@@ -2046,7 +2046,7 @@ declare enum ChargeType$1 {
|
|
|
2046
2046
|
}
|
|
2047
2047
|
interface CalculateAdditionalFeesResponse {
|
|
2048
2048
|
/** Additional fees calculated. */
|
|
2049
|
-
additionalFees?: AdditionalFee$
|
|
2049
|
+
additionalFees?: AdditionalFee$2[];
|
|
2050
2050
|
/**
|
|
2051
2051
|
* Currency of additional fees calculated. In three-letter currency code
|
|
2052
2052
|
* [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
@@ -2059,7 +2059,7 @@ interface CalculateAdditionalFeesResponse {
|
|
|
2059
2059
|
currency?: string;
|
|
2060
2060
|
}
|
|
2061
2061
|
/** Additional fees calculated. */
|
|
2062
|
-
interface AdditionalFee$
|
|
2062
|
+
interface AdditionalFee$2 {
|
|
2063
2063
|
/** Additional fee's unique code or ID. */
|
|
2064
2064
|
code?: string | null;
|
|
2065
2065
|
/**
|
|
@@ -2075,7 +2075,7 @@ interface AdditionalFee$1 {
|
|
|
2075
2075
|
*
|
|
2076
2076
|
* > **Note:** Tax is not calculated in the returned `price` even when `taxDetails.taxable` is `true`.
|
|
2077
2077
|
*/
|
|
2078
|
-
taxDetails?: TaxDetails;
|
|
2078
|
+
taxDetails?: TaxDetails$1;
|
|
2079
2079
|
/**
|
|
2080
2080
|
* Optional - Line items associated with this additional fee.
|
|
2081
2081
|
* If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
|
|
@@ -2083,7 +2083,7 @@ interface AdditionalFee$1 {
|
|
|
2083
2083
|
lineItemIds?: string[];
|
|
2084
2084
|
}
|
|
2085
2085
|
/** Tax details. */
|
|
2086
|
-
interface TaxDetails {
|
|
2086
|
+
interface TaxDetails$1 {
|
|
2087
2087
|
/** Whether additional fee is taxable. */
|
|
2088
2088
|
taxable?: boolean;
|
|
2089
2089
|
/** Reserved for internal use. */
|
|
@@ -2111,26 +2111,26 @@ interface AdditionalFeesSPIConfig {
|
|
|
2111
2111
|
* }
|
|
2112
2112
|
* ```
|
|
2113
2113
|
*/
|
|
2114
|
-
interface Context$
|
|
2114
|
+
interface Context$5 {
|
|
2115
2115
|
/** A unique identifier of the request. You may print this ID to your logs to help with future debugging and easier correlation with Wix's logs. */
|
|
2116
2116
|
requestId?: string | null;
|
|
2117
2117
|
/** [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code. */
|
|
2118
2118
|
currency?: string | null;
|
|
2119
2119
|
/** An object that describes the identity that triggered this request. */
|
|
2120
|
-
identity?: IdentificationData$
|
|
2120
|
+
identity?: IdentificationData$5;
|
|
2121
2121
|
/** A string representing a language and region in the format of `"xx-XX"`. First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2. For example, `"en-US"`. */
|
|
2122
2122
|
languages?: string[];
|
|
2123
2123
|
/** The service provider app's instance ID. */
|
|
2124
2124
|
instanceId?: string | null;
|
|
2125
2125
|
}
|
|
2126
|
-
declare enum IdentityType$
|
|
2126
|
+
declare enum IdentityType$5 {
|
|
2127
2127
|
UNKNOWN = "UNKNOWN",
|
|
2128
2128
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2129
2129
|
MEMBER = "MEMBER",
|
|
2130
2130
|
WIX_USER = "WIX_USER",
|
|
2131
2131
|
APP = "APP"
|
|
2132
2132
|
}
|
|
2133
|
-
interface IdentificationData$
|
|
2133
|
+
interface IdentificationData$5 extends IdentificationDataIdOneOf$5 {
|
|
2134
2134
|
/** ID of a site visitor that has not logged in to the site. */
|
|
2135
2135
|
anonymousVisitorId?: string;
|
|
2136
2136
|
/** ID of a site visitor that has logged in to the site. */
|
|
@@ -2140,10 +2140,10 @@ interface IdentificationData$4 extends IdentificationDataIdOneOf$4 {
|
|
|
2140
2140
|
/** ID of an app. */
|
|
2141
2141
|
appId?: string;
|
|
2142
2142
|
/** @readonly */
|
|
2143
|
-
identityType?: IdentityType$
|
|
2143
|
+
identityType?: IdentityType$5;
|
|
2144
2144
|
}
|
|
2145
2145
|
/** @oneof */
|
|
2146
|
-
interface IdentificationDataIdOneOf$
|
|
2146
|
+
interface IdentificationDataIdOneOf$5 {
|
|
2147
2147
|
/** ID of a site visitor that has not logged in to the site. */
|
|
2148
2148
|
anonymousVisitorId?: string;
|
|
2149
2149
|
/** ID of a site visitor that has logged in to the site. */
|
|
@@ -2156,9 +2156,9 @@ interface IdentificationDataIdOneOf$4 {
|
|
|
2156
2156
|
|
|
2157
2157
|
interface CalculateAdditionalFeesEnvelope {
|
|
2158
2158
|
request: CalculateAdditionalFeesRequest;
|
|
2159
|
-
metadata: Context$
|
|
2159
|
+
metadata: Context$5;
|
|
2160
2160
|
}
|
|
2161
|
-
declare const provideHandlers$
|
|
2161
|
+
declare const provideHandlers$b: ServicePluginDefinition<{
|
|
2162
2162
|
/**
|
|
2163
2163
|
*
|
|
2164
2164
|
* This method retrieves additional fees calculated by your app.
|
|
@@ -2172,17 +2172,633 @@ declare const provideHandlers$9: ServicePluginDefinition<{
|
|
|
2172
2172
|
calculateAdditionalFees(payload: CalculateAdditionalFeesEnvelope): CalculateAdditionalFeesResponse | Promise<CalculateAdditionalFeesResponse>;
|
|
2173
2173
|
}>;
|
|
2174
2174
|
|
|
2175
|
+
declare function createServicePluginModule$5<T extends ServicePluginDefinition<any>>(servicePluginDefinition: T): BuildServicePluginDefinition<T> & T;
|
|
2176
|
+
|
|
2177
|
+
type _publicProvideHandlersType$5 = typeof provideHandlers$b;
|
|
2178
|
+
declare const provideHandlers$a: ReturnType<typeof createServicePluginModule$5<_publicProvideHandlersType>>;
|
|
2179
|
+
|
|
2180
|
+
type context$5_AdditionalFeesSPIConfig = AdditionalFeesSPIConfig;
|
|
2181
|
+
type context$5_CalculateAdditionalFeesRequest = CalculateAdditionalFeesRequest;
|
|
2182
|
+
type context$5_CalculateAdditionalFeesResponse = CalculateAdditionalFeesResponse;
|
|
2183
|
+
declare namespace context$5 {
|
|
2184
|
+
export { type AdditionalFee$2 as AdditionalFee, type context$5_AdditionalFeesSPIConfig as AdditionalFeesSPIConfig, type Address$2 as Address, type AddressLocation$2 as AddressLocation, type AppliedDiscount$2 as AppliedDiscount, type AppliedDiscountDiscountSourceOneOf$2 as AppliedDiscountDiscountSourceOneOf, type BuyerDetails$1 as BuyerDetails, type context$5_CalculateAdditionalFeesRequest as CalculateAdditionalFeesRequest, type context$5_CalculateAdditionalFeesResponse as CalculateAdditionalFeesResponse, type CatalogReference$5 as CatalogReference, ChargeType$1 as ChargeType, type Context$5 as Context, type Coupon$2 as Coupon, type DeliveryLogistics$1 as DeliveryLogistics, type DiscountRule$2 as DiscountRule, type DiscountRuleName$2 as DiscountRuleName, DiscountType$2 as DiscountType, type FullAddressContactDetails$2 as FullAddressContactDetails, type IdentificationData$5 as IdentificationData, type IdentificationDataIdOneOf$5 as IdentificationDataIdOneOf, IdentityType$5 as IdentityType, type LineItem$4 as LineItem, type MerchantDiscount$2 as MerchantDiscount, type PhysicalProperties$3 as PhysicalProperties, type PickupDetails$1 as PickupDetails, PickupMethod$1 as PickupMethod, type SelectedCarrierServiceOption$2 as SelectedCarrierServiceOption, type SelectedCarrierServiceOptionOtherCharge$1 as SelectedCarrierServiceOptionOtherCharge, type SelectedCarrierServiceOptionPrices$2 as SelectedCarrierServiceOptionPrices, type ShippingInformation$1 as ShippingInformation, type StreetAddress$2 as StreetAddress, type TaxDetails$1 as TaxDetails, type VatId$2 as VatId, VatType$2 as VatType, type _publicProvideHandlersType$5 as _publicProvideHandlersType, provideHandlers$a as provideHandlers, provideHandlers$b as publicProvideHandlers };
|
|
2185
|
+
}
|
|
2186
|
+
|
|
2187
|
+
interface GetCatalogItemsRequest {
|
|
2188
|
+
/** Catalog reference details for the items to retrieve, including quantity of each item. */
|
|
2189
|
+
catalogReferences?: CatalogReferenceAndQuantity[];
|
|
2190
|
+
/**
|
|
2191
|
+
* Weight measurement unit.
|
|
2192
|
+
*
|
|
2193
|
+
* By default, Wix sends the weight unit specified in the site's settings.
|
|
2194
|
+
*/
|
|
2195
|
+
weightUnit?: WeightUnit$2;
|
|
2196
|
+
/**
|
|
2197
|
+
* Currency to return item prices in, in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format. For example, `USD` or `EUR`.
|
|
2198
|
+
*
|
|
2199
|
+
* By default, Wix sends the currency specified in the site's settings.
|
|
2200
|
+
*/
|
|
2201
|
+
currency?: string;
|
|
2202
|
+
}
|
|
2203
|
+
interface CatalogReferenceAndQuantity {
|
|
2204
|
+
/** Catalog and item reference info. Holds IDs for the item and the catalog it belongs to, as well as further optional details. This is identical in the request and response. */
|
|
2205
|
+
catalogReference?: CatalogReference$4;
|
|
2206
|
+
/** Item quantity. */
|
|
2207
|
+
quantity?: number;
|
|
2208
|
+
}
|
|
2209
|
+
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
2210
|
+
interface CatalogReference$4 {
|
|
2211
|
+
/** ID of the item within the catalog it belongs to. */
|
|
2212
|
+
catalogItemId?: string;
|
|
2213
|
+
/**
|
|
2214
|
+
* ID of the app providing the catalog.
|
|
2215
|
+
*
|
|
2216
|
+
* You can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
|
|
2217
|
+
*
|
|
2218
|
+
* For items from Wix catalogs, the following values always apply:
|
|
2219
|
+
* + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
|
|
2220
|
+
* + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
|
|
2221
|
+
* + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
|
|
2222
|
+
*/
|
|
2223
|
+
appId?: string;
|
|
2224
|
+
/**
|
|
2225
|
+
* Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
|
|
2226
|
+
*
|
|
2227
|
+
* For products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration).
|
|
2228
|
+
*/
|
|
2229
|
+
options?: Record<string, any> | null;
|
|
2230
|
+
}
|
|
2231
|
+
declare enum WeightUnit$2 {
|
|
2232
|
+
/** Weight unit can't be classified, due to an error */
|
|
2233
|
+
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
2234
|
+
/** Kilograms */
|
|
2235
|
+
KG = "KG",
|
|
2236
|
+
/** Pounds */
|
|
2237
|
+
LB = "LB"
|
|
2238
|
+
}
|
|
2239
|
+
interface GetCatalogItemsResponse {
|
|
2240
|
+
/**
|
|
2241
|
+
* Details for each item, including catalog reference details and item data. Any items that don't exist in the catalog are excluded.
|
|
2242
|
+
* If none of the requested items exist in the catalog, this array must be empty.
|
|
2243
|
+
*/
|
|
2244
|
+
catalogItems?: Item[];
|
|
2245
|
+
}
|
|
2246
|
+
interface Item {
|
|
2247
|
+
/** Catalog and item reference info. Holds IDs for the item and the catalog it belongs to, as well as further optional details. This is identical in the request and response. */
|
|
2248
|
+
catalogReference?: CatalogReference$4;
|
|
2249
|
+
/** Item data. Contains full details about the item. */
|
|
2250
|
+
data?: ItemData;
|
|
2251
|
+
}
|
|
2252
|
+
interface ItemData {
|
|
2253
|
+
/** __Required.__ Item name. */
|
|
2254
|
+
productName?: ProductName$2;
|
|
2255
|
+
/**
|
|
2256
|
+
* URL for the item's page on the site.
|
|
2257
|
+
*
|
|
2258
|
+
* This is used to link back to the relevant item page from the cart page. If not provided, the site URL is used.
|
|
2259
|
+
*/
|
|
2260
|
+
url?: string;
|
|
2261
|
+
/** __Required.__ Item type. Either one of the preset types or a custom type. */
|
|
2262
|
+
itemType?: ItemType$2;
|
|
2263
|
+
/** __Required.__ Item price with discounts applied. If a catalog-defined discount applies, the discount is reflected in this price. */
|
|
2264
|
+
price?: string;
|
|
2265
|
+
/**
|
|
2266
|
+
* Item price **before** applying any catalog-defined discount.
|
|
2267
|
+
*
|
|
2268
|
+
* Default: Value of `price` field, if no catalog-defined discount applies.
|
|
2269
|
+
*/
|
|
2270
|
+
fullPrice?: string | null;
|
|
2271
|
+
/** The tax group ID associated with this item. Learn more about the [Tax Groups Service Plugin](https://dev.wix.com/docs/rest/business-management/payments/tax/tax-groups-integration-service-plugin/introduction). */
|
|
2272
|
+
taxGroupId?: string | null;
|
|
2273
|
+
/**
|
|
2274
|
+
* Line item description lines. Used for displaying the item in a cart, checkout or order. For example, if you want `Size: Large` to appear under the item name, create a description line with `"name": {"original": "Size"}` and `"plainText": {"original": "Large"}`.
|
|
2275
|
+
*
|
|
2276
|
+
* Default: No description line.
|
|
2277
|
+
*/
|
|
2278
|
+
descriptionLines?: DescriptionLine$1[];
|
|
2279
|
+
/**
|
|
2280
|
+
* Line item image details. Supports images from the [Wix Media Manager](https://support.wix.com/en/article/wix-media-accessing-the-media-manager) only.
|
|
2281
|
+
*
|
|
2282
|
+
* To use an image from another source, first upload it to the Media Manager.
|
|
2283
|
+
* You can retrieve the ID, width and height of an image from the Wix Media Manager.
|
|
2284
|
+
*/
|
|
2285
|
+
media?: string;
|
|
2286
|
+
/**
|
|
2287
|
+
* Quantity of the item available for purchase. Only return if the catalog manages inventory.
|
|
2288
|
+
* If not returned, a buyer can increase the quantity of this item to add to the cart or checkout without limit.
|
|
2289
|
+
*/
|
|
2290
|
+
quantityAvailable?: number | null;
|
|
2291
|
+
/** Physical properties of the item. Only return for physical items. When applicable, contains information such as SKU and item weight. */
|
|
2292
|
+
physicalProperties?: PhysicalProperties$2;
|
|
2293
|
+
/** Subscription option info. */
|
|
2294
|
+
subscriptionOptionInfo?: SubscriptionOptionInfo$2;
|
|
2295
|
+
/**
|
|
2296
|
+
* Payment method selected for the item.
|
|
2297
|
+
*
|
|
2298
|
+
* + `FULL_PAYMENT_ONLINE`: The entire payment for this item happens as part of the checkout.
|
|
2299
|
+
* + `FULL_PAYMENT_OFFLINE`: The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
|
|
2300
|
+
* + `MEMBERSHIP`: Payment for this item is done by charging a membership. When selected, `price` is `0`.
|
|
2301
|
+
* + `DEPOSIT_ONLINE`: Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`.
|
|
2302
|
+
* + `MEMBERSHIP_OFFLINE`: Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`.
|
|
2303
|
+
*
|
|
2304
|
+
* Default: `FULL_PAYMENT_ONLINE`.
|
|
2305
|
+
*/
|
|
2306
|
+
paymentOption?: PaymentOptionType$1;
|
|
2307
|
+
/** Service properties. When applicable, this contains information such as time and number of participants. */
|
|
2308
|
+
serviceProperties?: ServiceProperties$1;
|
|
2309
|
+
/**
|
|
2310
|
+
* Additional ID for the item in the catalog.
|
|
2311
|
+
* This field provides an additional identifier for the item if your flow requires another ID as well as `catalogReference.catalogItemId`.
|
|
2312
|
+
* Can be used for membership validation.
|
|
2313
|
+
*
|
|
2314
|
+
* Default: Same as `catalogReference.catalogItemId`.
|
|
2315
|
+
*/
|
|
2316
|
+
rootCatalogItemId?: string | null;
|
|
2317
|
+
/**
|
|
2318
|
+
* Additional description for the price. Return when additional information about the price is needed.
|
|
2319
|
+
*
|
|
2320
|
+
* For example, when `price` is `"0"` but additional details about the actual price are needed, such as `"Starts at $67"`.
|
|
2321
|
+
*/
|
|
2322
|
+
priceDescription?: PriceDescription$1;
|
|
2323
|
+
/**
|
|
2324
|
+
* Partial payment to be paid upfront during the checkout. Return when `paymentOption` is `DEPOSIT_ONLINE`.
|
|
2325
|
+
*
|
|
2326
|
+
* Default: If `paymentOption` is `DEPOSIT_ONLINE` but `depositAmount` is not provided, the item is treated as if `paymentOption` is `FULL_PAYMENT_ONLINE`.
|
|
2327
|
+
*/
|
|
2328
|
+
depositAmount?: string | null;
|
|
2329
|
+
/** Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page. */
|
|
2330
|
+
consentRequiredPaymentPolicy?: string | null;
|
|
2331
|
+
/**
|
|
2332
|
+
* Whether to save the payment method on the order.
|
|
2333
|
+
*
|
|
2334
|
+
* Default: `false`
|
|
2335
|
+
*/
|
|
2336
|
+
savePaymentMethod?: boolean;
|
|
2337
|
+
}
|
|
2338
|
+
interface ProductName$2 {
|
|
2339
|
+
/**
|
|
2340
|
+
* __Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
2341
|
+
*
|
|
2342
|
+
* Min: 1 character.
|
|
2343
|
+
* Max: 200 characters.
|
|
2344
|
+
*/
|
|
2345
|
+
original?: string;
|
|
2346
|
+
/**
|
|
2347
|
+
* Item name translated into the buyer's language.
|
|
2348
|
+
*
|
|
2349
|
+
* Min: 1 character.
|
|
2350
|
+
* Max: 400 characters.
|
|
2351
|
+
* Default: Same as `original`.
|
|
2352
|
+
*/
|
|
2353
|
+
translated?: string | null;
|
|
2354
|
+
}
|
|
2355
|
+
interface ItemType$2 extends ItemTypeItemTypeDataOneOf$2 {
|
|
2356
|
+
/** Preset item type. */
|
|
2357
|
+
preset?: ItemTypeItemType$2;
|
|
2358
|
+
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
2359
|
+
custom?: string;
|
|
2360
|
+
}
|
|
2361
|
+
/** @oneof */
|
|
2362
|
+
interface ItemTypeItemTypeDataOneOf$2 {
|
|
2363
|
+
/** Preset item type. */
|
|
2364
|
+
preset?: ItemTypeItemType$2;
|
|
2365
|
+
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
2366
|
+
custom?: string;
|
|
2367
|
+
}
|
|
2368
|
+
declare enum ItemTypeItemType$2 {
|
|
2369
|
+
UNRECOGNISED = "UNRECOGNISED",
|
|
2370
|
+
PHYSICAL = "PHYSICAL",
|
|
2371
|
+
DIGITAL = "DIGITAL",
|
|
2372
|
+
GIFT_CARD = "GIFT_CARD",
|
|
2373
|
+
SERVICE = "SERVICE"
|
|
2374
|
+
}
|
|
2375
|
+
interface DescriptionLine$1 extends DescriptionLineValueOneOf$1, DescriptionLineDescriptionLineValueOneOf$1 {
|
|
2376
|
+
/** Description line plain text value. */
|
|
2377
|
+
plainText?: PlainTextValue$1;
|
|
2378
|
+
/** Description line color value. */
|
|
2379
|
+
colorInfo?: Color$1;
|
|
2380
|
+
/** Description line name. */
|
|
2381
|
+
name?: DescriptionLineName$1;
|
|
2382
|
+
}
|
|
2383
|
+
/** @oneof */
|
|
2384
|
+
interface DescriptionLineValueOneOf$1 {
|
|
2385
|
+
/** Description line plain text value. */
|
|
2386
|
+
plainText?: PlainTextValue$1;
|
|
2387
|
+
/** Description line color value. */
|
|
2388
|
+
colorInfo?: Color$1;
|
|
2389
|
+
}
|
|
2390
|
+
/** @oneof */
|
|
2391
|
+
interface DescriptionLineDescriptionLineValueOneOf$1 {
|
|
2392
|
+
}
|
|
2393
|
+
interface DescriptionLineName$1 {
|
|
2394
|
+
/** Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
|
|
2395
|
+
original?: string;
|
|
2396
|
+
/**
|
|
2397
|
+
* Description line name translated into the buyer's language.
|
|
2398
|
+
*
|
|
2399
|
+
* Default: Same as `original`.
|
|
2400
|
+
*/
|
|
2401
|
+
translated?: string | null;
|
|
2402
|
+
}
|
|
2403
|
+
interface PlainTextValue$1 {
|
|
2404
|
+
/** Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
|
|
2405
|
+
original?: string;
|
|
2406
|
+
/**
|
|
2407
|
+
* Description line plain text value translated into the buyer's language.
|
|
2408
|
+
*
|
|
2409
|
+
* Default: Same as `original`.
|
|
2410
|
+
*/
|
|
2411
|
+
translated?: string | null;
|
|
2412
|
+
}
|
|
2413
|
+
interface Color$1 {
|
|
2414
|
+
/** Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
|
|
2415
|
+
original?: string;
|
|
2416
|
+
/**
|
|
2417
|
+
* Description line color name translated into the buyer's language.
|
|
2418
|
+
*
|
|
2419
|
+
* Default: Same as `original`.
|
|
2420
|
+
*/
|
|
2421
|
+
translated?: string | null;
|
|
2422
|
+
/** HEX or RGB color code for display. */
|
|
2423
|
+
code?: string | null;
|
|
2424
|
+
}
|
|
2425
|
+
declare enum DescriptionLineType$1 {
|
|
2426
|
+
/** Unrecognized type. */
|
|
2427
|
+
UNRECOGNISED = "UNRECOGNISED",
|
|
2428
|
+
/** Plain text type. */
|
|
2429
|
+
PLAIN_TEXT = "PLAIN_TEXT",
|
|
2430
|
+
/** Color type. */
|
|
2431
|
+
COLOR = "COLOR"
|
|
2432
|
+
}
|
|
2433
|
+
interface PhysicalProperties$2 {
|
|
2434
|
+
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
2435
|
+
weight?: number | null;
|
|
2436
|
+
/** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
|
|
2437
|
+
sku?: string | null;
|
|
2438
|
+
/** Whether this line item is shippable. */
|
|
2439
|
+
shippable?: boolean;
|
|
2440
|
+
}
|
|
2441
|
+
interface Scope$1 {
|
|
2442
|
+
/** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
|
|
2443
|
+
namespace?: string;
|
|
2444
|
+
/** Coupon scope's applied group (e.g., event or ticket in Wix Events) */
|
|
2445
|
+
group?: Group$1;
|
|
2446
|
+
}
|
|
2447
|
+
interface Group$1 {
|
|
2448
|
+
/** Coupon scope's group (e.g., product or collection in Wix Stores). See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */
|
|
2449
|
+
name?: string;
|
|
2450
|
+
/** Item ID (when the coupon scope is limited to just one item). */
|
|
2451
|
+
entityId?: string | null;
|
|
2452
|
+
}
|
|
2453
|
+
interface SubscriptionOptionInfo$2 {
|
|
2454
|
+
/** Subscription option settings. */
|
|
2455
|
+
subscriptionSettings?: SubscriptionSettings$2;
|
|
2456
|
+
/** Subscription option title. */
|
|
2457
|
+
title?: Title$2;
|
|
2458
|
+
/** Subscription option description. */
|
|
2459
|
+
description?: Description$2;
|
|
2460
|
+
}
|
|
2461
|
+
interface SubscriptionSettings$2 {
|
|
2462
|
+
/** Frequency of recurring payment. */
|
|
2463
|
+
frequency?: SubscriptionFrequency$2;
|
|
2464
|
+
/**
|
|
2465
|
+
* Interval of recurring payment.
|
|
2466
|
+
*
|
|
2467
|
+
* Default: `1`.
|
|
2468
|
+
* If SubscriptionFrequency is Day the minimum interval is 7
|
|
2469
|
+
*/
|
|
2470
|
+
interval?: number | null;
|
|
2471
|
+
/** Whether subscription is renewed automatically at the end of each period. */
|
|
2472
|
+
autoRenewal?: boolean;
|
|
2473
|
+
/** Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`. */
|
|
2474
|
+
billingCycles?: number | null;
|
|
2475
|
+
}
|
|
2476
|
+
/** Frequency unit of recurring payment */
|
|
2477
|
+
declare enum SubscriptionFrequency$2 {
|
|
2478
|
+
UNDEFINED = "UNDEFINED",
|
|
2479
|
+
DAY = "DAY",
|
|
2480
|
+
WEEK = "WEEK",
|
|
2481
|
+
MONTH = "MONTH",
|
|
2482
|
+
YEAR = "YEAR"
|
|
2483
|
+
}
|
|
2484
|
+
interface FreeTrialPeriod$2 {
|
|
2485
|
+
/** Frequency of priod. Values: DAY, WEEK, MONTH, YEAR */
|
|
2486
|
+
frequency?: SubscriptionFrequency$2;
|
|
2487
|
+
/** interval of period */
|
|
2488
|
+
interval?: number;
|
|
2489
|
+
}
|
|
2490
|
+
interface Title$2 {
|
|
2491
|
+
/** Subscription option name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
|
|
2492
|
+
original?: string;
|
|
2493
|
+
/**
|
|
2494
|
+
* Subscription option name translated into the buyer's language.
|
|
2495
|
+
*
|
|
2496
|
+
* Default: Same as `original`.
|
|
2497
|
+
*/
|
|
2498
|
+
translated?: string | null;
|
|
2499
|
+
}
|
|
2500
|
+
interface Description$2 {
|
|
2501
|
+
/** Subscription option description. */
|
|
2502
|
+
original?: string;
|
|
2503
|
+
/** Translated subscription option description. */
|
|
2504
|
+
translated?: string | null;
|
|
2505
|
+
}
|
|
2506
|
+
interface SecuredMedia$1 {
|
|
2507
|
+
/** Media ID in Wix Media Manager. */
|
|
2508
|
+
_id?: string;
|
|
2509
|
+
/** Original filename. */
|
|
2510
|
+
fileName?: string;
|
|
2511
|
+
/** File type. */
|
|
2512
|
+
fileType?: FileType$1;
|
|
2513
|
+
}
|
|
2514
|
+
declare enum FileType$1 {
|
|
2515
|
+
UNSPECIFIED = "UNSPECIFIED",
|
|
2516
|
+
SECURE_PICTURE = "SECURE_PICTURE",
|
|
2517
|
+
SECURE_VIDEO = "SECURE_VIDEO",
|
|
2518
|
+
SECURE_DOCUMENT = "SECURE_DOCUMENT",
|
|
2519
|
+
SECURE_MUSIC = "SECURE_MUSIC",
|
|
2520
|
+
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
2521
|
+
}
|
|
2522
|
+
/** Type of selected payment option for catalog item */
|
|
2523
|
+
declare enum PaymentOptionType$1 {
|
|
2524
|
+
/** The entire payment for this item happens as part of the checkout. */
|
|
2525
|
+
FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
|
|
2526
|
+
/** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
|
|
2527
|
+
FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
|
|
2528
|
+
/** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
|
|
2529
|
+
MEMBERSHIP = "MEMBERSHIP",
|
|
2530
|
+
/** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
|
|
2531
|
+
DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
|
|
2532
|
+
/** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
|
|
2533
|
+
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
2534
|
+
}
|
|
2535
|
+
interface ServiceProperties$1 {
|
|
2536
|
+
/**
|
|
2537
|
+
* Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
2538
|
+
* For example, the start time of a class.
|
|
2539
|
+
*/
|
|
2540
|
+
scheduledDate?: Date | null;
|
|
2541
|
+
/** The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room. */
|
|
2542
|
+
numberOfParticipants?: number | null;
|
|
2543
|
+
}
|
|
2544
|
+
interface PriceDescription$1 {
|
|
2545
|
+
/** __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
|
|
2546
|
+
original?: string;
|
|
2547
|
+
/**
|
|
2548
|
+
* Price description translated into the buyer's language.
|
|
2549
|
+
*
|
|
2550
|
+
* Default: Same as `original`.
|
|
2551
|
+
*/
|
|
2552
|
+
translated?: string | null;
|
|
2553
|
+
}
|
|
2554
|
+
interface TaxableAddress$1 extends TaxableAddressTaxableAddressDataOneOf$1 {
|
|
2555
|
+
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
2556
|
+
addressType?: TaxableAddressType$1;
|
|
2557
|
+
}
|
|
2558
|
+
/** @oneof */
|
|
2559
|
+
interface TaxableAddressTaxableAddressDataOneOf$1 {
|
|
2560
|
+
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
2561
|
+
addressType?: TaxableAddressType$1;
|
|
2562
|
+
}
|
|
2563
|
+
declare enum TaxableAddressType$1 {
|
|
2564
|
+
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
2565
|
+
BUSINESS = "BUSINESS",
|
|
2566
|
+
BILLING = "BILLING",
|
|
2567
|
+
SHIPPING = "SHIPPING"
|
|
2568
|
+
}
|
|
2569
|
+
interface Policy$1 {
|
|
2570
|
+
/** Policy title - should be translated */
|
|
2571
|
+
title?: string | null;
|
|
2572
|
+
/** Policy content - should be translated */
|
|
2573
|
+
content?: string;
|
|
2574
|
+
}
|
|
2575
|
+
interface AdditionalFee$1 {
|
|
2576
|
+
/** Additional fee's unique code or ID. */
|
|
2577
|
+
code?: string | null;
|
|
2578
|
+
/**
|
|
2579
|
+
* Additional fee's name.
|
|
2580
|
+
*
|
|
2581
|
+
* Max: 50 characters
|
|
2582
|
+
*/
|
|
2583
|
+
name?: string;
|
|
2584
|
+
/** Total additional fees. This `price` does not include any taxes that may apply to these additional fees. */
|
|
2585
|
+
price?: string;
|
|
2586
|
+
/**
|
|
2587
|
+
* Tax details.
|
|
2588
|
+
*
|
|
2589
|
+
* > **Note:** Tax is not calculated in the returned `price` even when `taxDetails.taxable` is `true`.
|
|
2590
|
+
*/
|
|
2591
|
+
taxDetails?: TaxDetails;
|
|
2592
|
+
}
|
|
2593
|
+
/** Tax details. */
|
|
2594
|
+
interface TaxDetails {
|
|
2595
|
+
/** Whether additional fee is taxable. */
|
|
2596
|
+
taxable?: boolean;
|
|
2597
|
+
/** Reserved for internal use. */
|
|
2598
|
+
taxGroupId?: string | null;
|
|
2599
|
+
}
|
|
2600
|
+
interface QueryCatalogItemsRequest {
|
|
2601
|
+
/** A list of itemIDs to filter by. If exists, the result will only include the items with the IDs passed. */
|
|
2602
|
+
catalogItemIds?: string[] | null;
|
|
2603
|
+
/** An item name to filter by. If exists, the result will only include items with name that starts with this string. */
|
|
2604
|
+
catalogItemName?: string | null;
|
|
2605
|
+
/** Paging options to limit and skip a number of items. */
|
|
2606
|
+
paging?: Paging;
|
|
2607
|
+
/**
|
|
2608
|
+
* Optional, if exist add filter by numericId gt last_numeric_id
|
|
2609
|
+
* https://dev.wix.com/api/rest/wix-stores/pagination#wix-stores_pagination_pagination
|
|
2610
|
+
*/
|
|
2611
|
+
lastNumericId?: string | null;
|
|
2612
|
+
}
|
|
2613
|
+
interface Paging {
|
|
2614
|
+
/** Number of items to load. */
|
|
2615
|
+
limit?: number | null;
|
|
2616
|
+
/** Number of items to skip in the current sort order. */
|
|
2617
|
+
offset?: number | null;
|
|
2618
|
+
}
|
|
2619
|
+
interface QueryCatalogItemsResponse {
|
|
2620
|
+
/** Catalog info and item data. */
|
|
2621
|
+
catalogItems?: BasicItem[];
|
|
2622
|
+
/** Paging metadata. */
|
|
2623
|
+
metadata?: PagingMetadata;
|
|
2624
|
+
}
|
|
2625
|
+
interface BasicItem {
|
|
2626
|
+
/** The ID of the the item. */
|
|
2627
|
+
_id?: string;
|
|
2628
|
+
/** The name of the item. */
|
|
2629
|
+
name?: string;
|
|
2630
|
+
/** Item Media items. */
|
|
2631
|
+
image?: string[];
|
|
2632
|
+
/** The current status of the inventory */
|
|
2633
|
+
inStock?: boolean;
|
|
2634
|
+
/** current version of an item. Each time the item is modified, its `revision` changes */
|
|
2635
|
+
revision?: string | null;
|
|
2636
|
+
/**
|
|
2637
|
+
* Unique numeric ID
|
|
2638
|
+
* @readonly
|
|
2639
|
+
*/
|
|
2640
|
+
numericId?: string | null;
|
|
2641
|
+
}
|
|
2642
|
+
interface NumericPropertyRange {
|
|
2643
|
+
/** Minimum value. */
|
|
2644
|
+
minValue?: number;
|
|
2645
|
+
/** Maximum value. */
|
|
2646
|
+
maxValue?: number;
|
|
2647
|
+
}
|
|
2648
|
+
interface PagingMetadata {
|
|
2649
|
+
/** Number of items returned in the response. */
|
|
2650
|
+
count?: number | null;
|
|
2651
|
+
/** Offset that was requested. */
|
|
2652
|
+
offset?: number | null;
|
|
2653
|
+
/** Total number of items that match the query. */
|
|
2654
|
+
total?: number | null;
|
|
2655
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
2656
|
+
tooManyToCount?: boolean | null;
|
|
2657
|
+
}
|
|
2658
|
+
interface CatalogSPIConfig {
|
|
2659
|
+
/** Base URI which Wix eCommerce will call to access Catalog service plugin endpoints. For example, to call the Get Catalog Items endpoint at `https://my-external-catalog.com/get-catalog-items`, the base URI you provide here is `https://my-external-catalog.com`. */
|
|
2660
|
+
deploymentUri?: string;
|
|
2661
|
+
/** Configuration details for discounts applied to all items in the catalog. */
|
|
2662
|
+
allItemsDiscount?: AllItemsDiscountConfig;
|
|
2663
|
+
/** Configuration details for discounts applied to specific items in the catalog. */
|
|
2664
|
+
specificItemsDiscount?: SpecificItemsDiscountConfig;
|
|
2665
|
+
}
|
|
2666
|
+
/** Configuration for all items discount functionality in the catalog. */
|
|
2667
|
+
interface AllItemsDiscountConfig {
|
|
2668
|
+
/**
|
|
2669
|
+
* Whether the discount is enabled.
|
|
2670
|
+
*
|
|
2671
|
+
* Default: `false`.
|
|
2672
|
+
*/
|
|
2673
|
+
enabled?: boolean;
|
|
2674
|
+
/**
|
|
2675
|
+
* Translatable name for "all items discount" in the catalog.
|
|
2676
|
+
* For example, for restaurant menus, this could be "All dishes".
|
|
2677
|
+
*/
|
|
2678
|
+
name?: string | null;
|
|
2679
|
+
}
|
|
2680
|
+
/** Configuration for discount functionality in the catalog. */
|
|
2681
|
+
interface SpecificItemsDiscountConfig {
|
|
2682
|
+
/**
|
|
2683
|
+
* Whether the discount is enabled.
|
|
2684
|
+
*
|
|
2685
|
+
* Default: `false`.
|
|
2686
|
+
*/
|
|
2687
|
+
enabled?: boolean;
|
|
2688
|
+
/** Translatable name for "all items discount" in the catalog. */
|
|
2689
|
+
name?: string | null;
|
|
2690
|
+
}
|
|
2691
|
+
/**
|
|
2692
|
+
* this message is not directly used by any service,
|
|
2693
|
+
* it exists to describe the expected parameters that SHOULD be provided to invoked Velo methods as part of open-platform.
|
|
2694
|
+
* e.g. SPIs, event-handlers, etc..
|
|
2695
|
+
* NOTE: this context object MUST be provided as the last argument in each Velo method signature.
|
|
2696
|
+
*
|
|
2697
|
+
* Example:
|
|
2698
|
+
* ```typescript
|
|
2699
|
+
* export function wixStores_onOrderCanceled({ event, metadata }: OrderCanceledEvent) {
|
|
2700
|
+
* ...
|
|
2701
|
+
* }
|
|
2702
|
+
* ```
|
|
2703
|
+
*/
|
|
2704
|
+
interface Context$4 {
|
|
2705
|
+
/** A unique identifier of the request. You may print this ID to your logs to help with future debugging and easier correlation with Wix's logs. */
|
|
2706
|
+
requestId?: string | null;
|
|
2707
|
+
/** [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code. */
|
|
2708
|
+
currency?: string | null;
|
|
2709
|
+
/** An object that describes the identity that triggered this request. */
|
|
2710
|
+
identity?: IdentificationData$4;
|
|
2711
|
+
/** A string representing a language and region in the format of `"xx-XX"`. First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2. For example, `"en-US"`. */
|
|
2712
|
+
languages?: string[];
|
|
2713
|
+
/** The service provider app's instance ID. */
|
|
2714
|
+
instanceId?: string | null;
|
|
2715
|
+
}
|
|
2716
|
+
declare enum IdentityType$4 {
|
|
2717
|
+
UNKNOWN = "UNKNOWN",
|
|
2718
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2719
|
+
MEMBER = "MEMBER",
|
|
2720
|
+
WIX_USER = "WIX_USER",
|
|
2721
|
+
APP = "APP"
|
|
2722
|
+
}
|
|
2723
|
+
interface IdentificationData$4 extends IdentificationDataIdOneOf$4 {
|
|
2724
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
2725
|
+
anonymousVisitorId?: string;
|
|
2726
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
2727
|
+
memberId?: string;
|
|
2728
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
2729
|
+
wixUserId?: string;
|
|
2730
|
+
/** ID of an app. */
|
|
2731
|
+
appId?: string;
|
|
2732
|
+
/** @readonly */
|
|
2733
|
+
identityType?: IdentityType$4;
|
|
2734
|
+
}
|
|
2735
|
+
/** @oneof */
|
|
2736
|
+
interface IdentificationDataIdOneOf$4 {
|
|
2737
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
2738
|
+
anonymousVisitorId?: string;
|
|
2739
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
2740
|
+
memberId?: string;
|
|
2741
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
2742
|
+
wixUserId?: string;
|
|
2743
|
+
/** ID of an app. */
|
|
2744
|
+
appId?: string;
|
|
2745
|
+
}
|
|
2746
|
+
|
|
2747
|
+
interface GetCatalogItemsEnvelope {
|
|
2748
|
+
request: GetCatalogItemsRequest;
|
|
2749
|
+
metadata: Context$4;
|
|
2750
|
+
}
|
|
2751
|
+
declare const provideHandlers$9: ServicePluginDefinition<{
|
|
2752
|
+
/**
|
|
2753
|
+
*
|
|
2754
|
+
* Retrieves data for specified items in a specified catalog.
|
|
2755
|
+
*
|
|
2756
|
+
* Wix calls this method whenever a cart or checkout is updated, and when an item is added to an order.
|
|
2757
|
+
*
|
|
2758
|
+
* The method receives a `catalogReferences` array. Each catalog reference in the array contains:
|
|
2759
|
+
* + The ID of the item whose latest information Wix needs to retrieve.
|
|
2760
|
+
* + The ID of the app providing the catalog containing the item.
|
|
2761
|
+
* + Optional details about preferences or customization of the item.
|
|
2762
|
+
*
|
|
2763
|
+
* The method also receives preferences for the currency and weight unit to be used in the response.
|
|
2764
|
+
*
|
|
2765
|
+
* Your external catalog can store and organize item details in any way you prefer.
|
|
2766
|
+
* When implementing the Catalog service plugin, learn how to [handle item variants](https://dev.wix.com/docs/rest/business-solutions/e-commerce/catalog-service-plugin/handle-item-variants) in a way that meets your needs.
|
|
2767
|
+
*
|
|
2768
|
+
* The method's response must contain a `catalogItems` array. Each item in the array must contain:
|
|
2769
|
+
* + A `catalogReference` object. This must be identical to the `catalogReference` object received in the request.
|
|
2770
|
+
* + A `data` object with full details about the item.
|
|
2771
|
+
*
|
|
2772
|
+
* > **Notes:**
|
|
2773
|
+
* > + If an item doesn't exist in the catalog, the response must exclude it from the `catalogItems` array in the response.
|
|
2774
|
+
* > + When none of the items requested exist in the catalog, `catalogItems` must contain an empty array.
|
|
2775
|
+
* > + Wix calls the method every time a cart or checkout is updated. If the response doesn't include an item that was already in the cart or checkout, Wix removes the item from the cart or checkout.
|
|
2776
|
+
* > + Learn more about [implementing a Wix service plugin](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions). */
|
|
2777
|
+
getCatalogItems(payload: GetCatalogItemsEnvelope): GetCatalogItemsResponse | Promise<GetCatalogItemsResponse>;
|
|
2778
|
+
}>;
|
|
2779
|
+
|
|
2175
2780
|
declare function createServicePluginModule$4<T extends ServicePluginDefinition<any>>(servicePluginDefinition: T): BuildServicePluginDefinition<T> & T;
|
|
2176
2781
|
|
|
2177
2782
|
type _publicProvideHandlersType$4 = typeof provideHandlers$9;
|
|
2178
2783
|
declare const provideHandlers$8: ReturnType<typeof createServicePluginModule$4<_publicProvideHandlersType>>;
|
|
2179
2784
|
|
|
2180
|
-
type context$
|
|
2181
|
-
type context$
|
|
2182
|
-
type context$
|
|
2785
|
+
type context$4_AllItemsDiscountConfig = AllItemsDiscountConfig;
|
|
2786
|
+
type context$4_BasicItem = BasicItem;
|
|
2787
|
+
type context$4_CatalogReferenceAndQuantity = CatalogReferenceAndQuantity;
|
|
2788
|
+
type context$4_CatalogSPIConfig = CatalogSPIConfig;
|
|
2789
|
+
type context$4_GetCatalogItemsRequest = GetCatalogItemsRequest;
|
|
2790
|
+
type context$4_GetCatalogItemsResponse = GetCatalogItemsResponse;
|
|
2791
|
+
type context$4_Item = Item;
|
|
2792
|
+
type context$4_ItemData = ItemData;
|
|
2793
|
+
type context$4_NumericPropertyRange = NumericPropertyRange;
|
|
2794
|
+
type context$4_Paging = Paging;
|
|
2795
|
+
type context$4_PagingMetadata = PagingMetadata;
|
|
2796
|
+
type context$4_QueryCatalogItemsRequest = QueryCatalogItemsRequest;
|
|
2797
|
+
type context$4_QueryCatalogItemsResponse = QueryCatalogItemsResponse;
|
|
2798
|
+
type context$4_SpecificItemsDiscountConfig = SpecificItemsDiscountConfig;
|
|
2183
2799
|
type context$4_TaxDetails = TaxDetails;
|
|
2184
2800
|
declare namespace context$4 {
|
|
2185
|
-
export { type AdditionalFee$1 as AdditionalFee, type context$
|
|
2801
|
+
export { type AdditionalFee$1 as AdditionalFee, type context$4_AllItemsDiscountConfig as AllItemsDiscountConfig, type context$4_BasicItem as BasicItem, type CatalogReference$4 as CatalogReference, type context$4_CatalogReferenceAndQuantity as CatalogReferenceAndQuantity, type context$4_CatalogSPIConfig as CatalogSPIConfig, type Color$1 as Color, type Context$4 as Context, type Description$2 as Description, type DescriptionLine$1 as DescriptionLine, type DescriptionLineDescriptionLineValueOneOf$1 as DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName$1 as DescriptionLineName, DescriptionLineType$1 as DescriptionLineType, type DescriptionLineValueOneOf$1 as DescriptionLineValueOneOf, FileType$1 as FileType, type FreeTrialPeriod$2 as FreeTrialPeriod, type context$4_GetCatalogItemsRequest as GetCatalogItemsRequest, type context$4_GetCatalogItemsResponse as GetCatalogItemsResponse, type Group$1 as Group, type IdentificationData$4 as IdentificationData, type IdentificationDataIdOneOf$4 as IdentificationDataIdOneOf, IdentityType$4 as IdentityType, type context$4_Item as Item, type context$4_ItemData as ItemData, type ItemType$2 as ItemType, ItemTypeItemType$2 as ItemTypeItemType, type ItemTypeItemTypeDataOneOf$2 as ItemTypeItemTypeDataOneOf, type context$4_NumericPropertyRange as NumericPropertyRange, type context$4_Paging as Paging, type context$4_PagingMetadata as PagingMetadata, PaymentOptionType$1 as PaymentOptionType, type PhysicalProperties$2 as PhysicalProperties, type PlainTextValue$1 as PlainTextValue, type Policy$1 as Policy, type PriceDescription$1 as PriceDescription, type ProductName$2 as ProductName, type context$4_QueryCatalogItemsRequest as QueryCatalogItemsRequest, type context$4_QueryCatalogItemsResponse as QueryCatalogItemsResponse, type Scope$1 as Scope, type SecuredMedia$1 as SecuredMedia, type ServiceProperties$1 as ServiceProperties, type context$4_SpecificItemsDiscountConfig as SpecificItemsDiscountConfig, SubscriptionFrequency$2 as SubscriptionFrequency, type SubscriptionOptionInfo$2 as SubscriptionOptionInfo, type SubscriptionSettings$2 as SubscriptionSettings, type context$4_TaxDetails as TaxDetails, type TaxableAddress$1 as TaxableAddress, type TaxableAddressTaxableAddressDataOneOf$1 as TaxableAddressTaxableAddressDataOneOf, TaxableAddressType$1 as TaxableAddressType, type Title$2 as Title, WeightUnit$2 as WeightUnit, type _publicProvideHandlersType$4 as _publicProvideHandlersType, provideHandlers$8 as provideHandlers, provideHandlers$9 as publicProvideHandlers };
|
|
2186
2802
|
}
|
|
2187
2803
|
|
|
2188
2804
|
interface CustomTrigger {
|
|
@@ -6655,4 +7271,4 @@ declare namespace context {
|
|
|
6655
7271
|
export { type context_Address as Address, type context_AddressLocation as AddressLocation, type context_AddressWithContact as AddressWithContact, type context_ApplicableLineItems as ApplicableLineItems, type context_AppliedDiscount as AppliedDiscount, type context_AppliedDiscountDiscountSourceOneOf as AppliedDiscountDiscountSourceOneOf, type context_BuyerDetails as BuyerDetails, type context_Carrier as Carrier, type context_CatalogReference as CatalogReference, context_CheckoutStage as CheckoutStage, type context_Context as Context, type context_Coupon as Coupon, type context_CustomField as CustomField, type context_CustomFields as CustomFields, type context_DeliveryAllocation as DeliveryAllocation, type context_Description as Description, type context_DiscountRule as DiscountRule, type context_DiscountRuleName as DiscountRuleName, context_DiscountType as DiscountType, type context_ExtendedFields as ExtendedFields, type context_ExternalReference as ExternalReference, type context_FreeTrialPeriod as FreeTrialPeriod, type context_FullAddressContactDetails as FullAddressContactDetails, type context_GetValidationViolationsRequest as GetValidationViolationsRequest, type context_GetValidationViolationsResponse as GetValidationViolationsResponse, type context_GiftCard as GiftCard, type context_IdentificationData as IdentificationData, type context_IdentificationDataIdOneOf as IdentificationDataIdOneOf, context_IdentityType as IdentityType, type context_ItemTaxFullDetails as ItemTaxFullDetails, type context_ItemType as ItemType, context_ItemTypeItemType as ItemTypeItemType, type context_ItemTypeItemTypeDataOneOf as ItemTypeItemTypeDataOneOf, context_JurisdictionType as JurisdictionType, type context_LineItem as LineItem, type context_LineItemPricesData as LineItemPricesData, type context_MerchantDiscount as MerchantDiscount, type context_MultiCurrencyPrice as MultiCurrencyPrice, context_NameInLineItem as NameInLineItem, context_NameInOther as NameInOther, type context_Other as Other, type context_PhysicalProperties as PhysicalProperties, type context_PriceSummary as PriceSummary, type context_ProductName as ProductName, type context_Region as Region, type context_SelectedCarrierServiceOption as SelectedCarrierServiceOption, type context_SelectedCarrierServiceOptionPrices as SelectedCarrierServiceOptionPrices, context_Severity as Severity, type context_ShippingInfo as ShippingInfo, context_Source as Source, type context_SourceInfo as SourceInfo, type context_Stage as Stage, type context_StageStagesOneOf as StageStagesOneOf, type context_StreetAddress as StreetAddress, context_SubscriptionFrequency as SubscriptionFrequency, type context_SubscriptionOptionInfo as SubscriptionOptionInfo, type context_SubscriptionSettings as SubscriptionSettings, context_SuggestedFix as SuggestedFix, type context_Target as Target, type context_TargetLineItem as TargetLineItem, type context_TargetTargetTypeOneOf as TargetTargetTypeOneOf, type context_TaxBreakdown as TaxBreakdown, type context_Title as Title, type context_ValidationInfo as ValidationInfo, type context_ValidationsSPIConfig as ValidationsSPIConfig, type context_VatId as VatId, context_VatType as VatType, type context_Violation as Violation, context_WeightUnit as WeightUnit, type context__publicProvideHandlersType as _publicProvideHandlersType, context_provideHandlers as provideHandlers, provideHandlers$1 as publicProvideHandlers };
|
|
6656
7272
|
}
|
|
6657
7273
|
|
|
6658
|
-
export { context$
|
|
7274
|
+
export { context$5 as additionalFees, context$4 as catalog, context$3 as customTriggers, context$2 as discounts, context$9 as giftVouchersProvider, context$8 as memberships, context$1 as paymentSettings, context$7 as recommendationsProvider, context$6 as shippingRates, context as validations };
|