@wix/stores 1.0.202 → 1.0.204
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/package.json +15 -15
- package/type-bundles/context.bundle.d.ts +1625 -237
- package/type-bundles/index.bundle.d.ts +1625 -237
- package/type-bundles/meta.bundle.d.ts +10 -58
|
@@ -1,3 +1,47 @@
|
|
|
1
|
+
type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
|
|
2
|
+
interface HttpClient {
|
|
3
|
+
request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
|
|
4
|
+
fetchWithAuth: typeof fetch;
|
|
5
|
+
wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
|
|
6
|
+
}
|
|
7
|
+
type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
|
|
8
|
+
type HttpResponse<T = any> = {
|
|
9
|
+
data: T;
|
|
10
|
+
status: number;
|
|
11
|
+
statusText: string;
|
|
12
|
+
headers: any;
|
|
13
|
+
request?: any;
|
|
14
|
+
};
|
|
15
|
+
type RequestOptions<_TResponse = any, Data = any> = {
|
|
16
|
+
method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
|
|
17
|
+
url: string;
|
|
18
|
+
data?: Data;
|
|
19
|
+
params?: URLSearchParams;
|
|
20
|
+
} & APIMetadata;
|
|
21
|
+
type APIMetadata = {
|
|
22
|
+
methodFqn?: string;
|
|
23
|
+
entityFqdn?: string;
|
|
24
|
+
packageName?: string;
|
|
25
|
+
};
|
|
26
|
+
type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
|
|
27
|
+
type EventDefinition<Payload = unknown, Type extends string = string> = {
|
|
28
|
+
__type: 'event-definition';
|
|
29
|
+
type: Type;
|
|
30
|
+
isDomainEvent?: boolean;
|
|
31
|
+
transformations?: (envelope: unknown) => Payload;
|
|
32
|
+
__payload: Payload;
|
|
33
|
+
};
|
|
34
|
+
declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
|
|
35
|
+
type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
|
|
36
|
+
type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
|
|
37
|
+
|
|
38
|
+
declare global {
|
|
39
|
+
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
|
|
40
|
+
interface SymbolConstructor {
|
|
41
|
+
readonly observable: symbol;
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
|
|
1
45
|
interface WishlistData {
|
|
2
46
|
/** GUID unique to this list for this site */
|
|
3
47
|
_id?: string | null;
|
|
@@ -153,52 +197,16 @@ interface GetWishlistByIdOptions {
|
|
|
153
197
|
kind?: WishlistItemKind[];
|
|
154
198
|
}
|
|
155
199
|
|
|
156
|
-
|
|
157
|
-
interface
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
data: T;
|
|
165
|
-
status: number;
|
|
166
|
-
statusText: string;
|
|
167
|
-
headers: any;
|
|
168
|
-
request?: any;
|
|
169
|
-
};
|
|
170
|
-
type RequestOptions<_TResponse = any, Data = any> = {
|
|
171
|
-
method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
|
|
172
|
-
url: string;
|
|
173
|
-
data?: Data;
|
|
174
|
-
params?: URLSearchParams;
|
|
175
|
-
} & APIMetadata;
|
|
176
|
-
type APIMetadata = {
|
|
177
|
-
methodFqn?: string;
|
|
178
|
-
entityFqdn?: string;
|
|
179
|
-
packageName?: string;
|
|
180
|
-
};
|
|
181
|
-
type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
|
|
182
|
-
type EventDefinition<Payload = unknown, Type extends string = string> = {
|
|
183
|
-
__type: 'event-definition';
|
|
184
|
-
type: Type;
|
|
185
|
-
isDomainEvent?: boolean;
|
|
186
|
-
transformations?: (envelope: unknown) => Payload;
|
|
187
|
-
__payload: Payload;
|
|
188
|
-
};
|
|
189
|
-
declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
|
|
190
|
-
type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
|
|
191
|
-
type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
|
|
192
|
-
|
|
193
|
-
declare global {
|
|
194
|
-
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
|
|
195
|
-
interface SymbolConstructor {
|
|
196
|
-
readonly observable: symbol;
|
|
197
|
-
}
|
|
200
|
+
declare function getWishlistById$1(httpClient: HttpClient): GetWishlistByIdSignature;
|
|
201
|
+
interface GetWishlistByIdSignature {
|
|
202
|
+
/**
|
|
203
|
+
* Get wishlist by id
|
|
204
|
+
* @param - Unique identifier representing requested list
|
|
205
|
+
* @returns Object containing requested list data
|
|
206
|
+
*/
|
|
207
|
+
(_id: string, options?: GetWishlistByIdOptions | undefined): Promise<WishlistData & WishlistDataNonNullableFields>;
|
|
198
208
|
}
|
|
199
209
|
|
|
200
|
-
declare function getWishlistById$1(httpClient: HttpClient): (_id: string, options?: GetWishlistByIdOptions) => Promise<WishlistData & WishlistDataNonNullableFields>;
|
|
201
|
-
|
|
202
210
|
declare function createRESTModule$c<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
203
211
|
|
|
204
212
|
type _publicGetWishlistByIdType = typeof getWishlistById$1;
|
|
@@ -553,9 +561,30 @@ interface CollectionsQueryBuilder {
|
|
|
553
561
|
find: () => Promise<CollectionsQueryResult>;
|
|
554
562
|
}
|
|
555
563
|
|
|
556
|
-
declare function queryCollections$1(httpClient: HttpClient):
|
|
557
|
-
|
|
558
|
-
|
|
564
|
+
declare function queryCollections$1(httpClient: HttpClient): QueryCollectionsSignature;
|
|
565
|
+
interface QueryCollectionsSignature {
|
|
566
|
+
/**
|
|
567
|
+
* Retrieves a list of up to 100 collections, given the provided paging, sorting and filtering.
|
|
568
|
+
* See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.
|
|
569
|
+
*/
|
|
570
|
+
(): CollectionsQueryBuilder;
|
|
571
|
+
}
|
|
572
|
+
declare function getCollection$1(httpClient: HttpClient): GetCollectionSignature;
|
|
573
|
+
interface GetCollectionSignature {
|
|
574
|
+
/**
|
|
575
|
+
* Retrieves a collection with the provided ID.
|
|
576
|
+
* @param - Requested collection ID.
|
|
577
|
+
*/
|
|
578
|
+
(_id: string): Promise<Collection$1 & CollectionNonNullableFields$1>;
|
|
579
|
+
}
|
|
580
|
+
declare function getCollectionBySlug$3(httpClient: HttpClient): GetCollectionBySlugSignature$1;
|
|
581
|
+
interface GetCollectionBySlugSignature$1 {
|
|
582
|
+
/**
|
|
583
|
+
* Retrieves a collection with the provided slug.
|
|
584
|
+
* @param - Slug of the collection to retrieve.
|
|
585
|
+
*/
|
|
586
|
+
(slug: string): Promise<GetCollectionBySlugResponse$1 & GetCollectionBySlugResponseNonNullableFields$1>;
|
|
587
|
+
}
|
|
559
588
|
|
|
560
589
|
declare function createRESTModule$b<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
561
590
|
|
|
@@ -2648,32 +2677,235 @@ interface QueryProductVariantsOptions {
|
|
|
2648
2677
|
includeMerchantSpecificData?: boolean;
|
|
2649
2678
|
}
|
|
2650
2679
|
|
|
2651
|
-
declare function createProduct$3(httpClient: HttpClient):
|
|
2652
|
-
|
|
2653
|
-
|
|
2654
|
-
|
|
2655
|
-
|
|
2656
|
-
|
|
2657
|
-
|
|
2658
|
-
|
|
2659
|
-
declare function
|
|
2660
|
-
|
|
2661
|
-
|
|
2662
|
-
|
|
2663
|
-
|
|
2664
|
-
|
|
2665
|
-
|
|
2666
|
-
|
|
2667
|
-
|
|
2668
|
-
declare function
|
|
2669
|
-
|
|
2670
|
-
|
|
2671
|
-
|
|
2672
|
-
|
|
2673
|
-
|
|
2674
|
-
|
|
2675
|
-
|
|
2676
|
-
declare function
|
|
2680
|
+
declare function createProduct$3(httpClient: HttpClient): CreateProductSignature$1;
|
|
2681
|
+
interface CreateProductSignature$1 {
|
|
2682
|
+
/**
|
|
2683
|
+
* Creates a new product.
|
|
2684
|
+
* @param - Product information.
|
|
2685
|
+
*/
|
|
2686
|
+
(product: Product$2): Promise<CreateProductResponse$1 & CreateProductResponseNonNullableFields$1>;
|
|
2687
|
+
}
|
|
2688
|
+
declare function updateProduct$3(httpClient: HttpClient): UpdateProductSignature$1;
|
|
2689
|
+
interface UpdateProductSignature$1 {
|
|
2690
|
+
/**
|
|
2691
|
+
* Updates specified fields in a product.
|
|
2692
|
+
* @param - Product ID (generated automatically by the catalog).
|
|
2693
|
+
* @param - Product info to update.
|
|
2694
|
+
*/
|
|
2695
|
+
(_id: string, product: UpdateProduct$1): Promise<UpdateProductResponse$1 & UpdateProductResponseNonNullableFields$1>;
|
|
2696
|
+
}
|
|
2697
|
+
declare function deleteProduct$3(httpClient: HttpClient): DeleteProductSignature$1;
|
|
2698
|
+
interface DeleteProductSignature$1 {
|
|
2699
|
+
/**
|
|
2700
|
+
* Deletes a product.
|
|
2701
|
+
* @param - ID of the product to delete.
|
|
2702
|
+
*/
|
|
2703
|
+
(_id: string): Promise<void>;
|
|
2704
|
+
}
|
|
2705
|
+
declare function updateProductVariants$1(httpClient: HttpClient): UpdateProductVariantsSignature;
|
|
2706
|
+
interface UpdateProductVariantsSignature {
|
|
2707
|
+
/**
|
|
2708
|
+
* Updates variants of a specified product.
|
|
2709
|
+
* @param - ID of the product with managed variants.
|
|
2710
|
+
* @param - Variant info to update.
|
|
2711
|
+
*/
|
|
2712
|
+
(_id: string, variants: VariantOverride[]): Promise<UpdateVariantsResponse & UpdateVariantsResponseNonNullableFields>;
|
|
2713
|
+
}
|
|
2714
|
+
declare function resetAllProductVariantData$1(httpClient: HttpClient): ResetAllProductVariantDataSignature;
|
|
2715
|
+
interface ResetAllProductVariantDataSignature {
|
|
2716
|
+
/**
|
|
2717
|
+
* Resets the data (such as the price and the weight) of all variants for a given product to their default values.
|
|
2718
|
+
* @param - Product ID.
|
|
2719
|
+
*/
|
|
2720
|
+
(_id: string): Promise<void>;
|
|
2721
|
+
}
|
|
2722
|
+
declare function addProductsToCollection$1(httpClient: HttpClient): AddProductsToCollectionSignature;
|
|
2723
|
+
interface AddProductsToCollectionSignature {
|
|
2724
|
+
/**
|
|
2725
|
+
* Adds products to a specified collection.
|
|
2726
|
+
* @param - Collection ID.
|
|
2727
|
+
* @param - IDs of the products to add to the collection, separated by commas.
|
|
2728
|
+
*/
|
|
2729
|
+
(_id: string, productIds: string[]): Promise<void>;
|
|
2730
|
+
}
|
|
2731
|
+
declare function removeProductsFromCollection$1(httpClient: HttpClient): RemoveProductsFromCollectionSignature;
|
|
2732
|
+
interface RemoveProductsFromCollectionSignature {
|
|
2733
|
+
/**
|
|
2734
|
+
* Deletes products from a specified collection.
|
|
2735
|
+
* @param - ID of the collection from which to remove products.
|
|
2736
|
+
* @param - IDs of the products to remove from the collection.
|
|
2737
|
+
*/
|
|
2738
|
+
(_id: string, productIds: string[]): Promise<void>;
|
|
2739
|
+
}
|
|
2740
|
+
declare function addProductMedia$1(httpClient: HttpClient): AddProductMediaSignature;
|
|
2741
|
+
interface AddProductMediaSignature {
|
|
2742
|
+
/**
|
|
2743
|
+
* Adds media items to a specified product, either via URL or existing media ID.
|
|
2744
|
+
*
|
|
2745
|
+
* > **NOTE:** The URL is not validated and no event is triggered to indicate if the media was added successfully.
|
|
2746
|
+
* @param - Product ID.
|
|
2747
|
+
* @param - Sources of media items already uploaded to the Wix site.
|
|
2748
|
+
*/
|
|
2749
|
+
(_id: string, media: MediaDataForWrite[]): Promise<void>;
|
|
2750
|
+
}
|
|
2751
|
+
declare function removeProductMedia$1(httpClient: HttpClient): RemoveProductMediaSignature;
|
|
2752
|
+
interface RemoveProductMediaSignature {
|
|
2753
|
+
/**
|
|
2754
|
+
* Removes specified media items from a product.
|
|
2755
|
+
* Pass an empty array to remove all media items.
|
|
2756
|
+
* @param - Product ID.
|
|
2757
|
+
* @param - List of media IDs to remove. Pass an empty array to delete all media items for the product.
|
|
2758
|
+
*/
|
|
2759
|
+
(_id: string, mediaIds: string[]): Promise<void>;
|
|
2760
|
+
}
|
|
2761
|
+
declare function addProductMediaToChoices$1(httpClient: HttpClient): AddProductMediaToChoicesSignature;
|
|
2762
|
+
interface AddProductMediaToChoicesSignature {
|
|
2763
|
+
/**
|
|
2764
|
+
* Links media items that are already associated with a specific product to a choice within the same product.
|
|
2765
|
+
*
|
|
2766
|
+
* Media items can only be set for choices within one option at a time - e.g., if you set media items for some or all of the choices within the Colors option (blue, green, and red), you won't be able to also assign media items to choices within the Size option (S, M, and L).
|
|
2767
|
+
*
|
|
2768
|
+
* To remove all existing media items, call the [Remove Product Media From Choices](https://dev.wix.com/api/rest/wix-stores/catalog/products/remove-product-media-from-choices) endpoint.
|
|
2769
|
+
* @param - Product ID.
|
|
2770
|
+
* @param - Product media items and the choices to add the media to.
|
|
2771
|
+
*/
|
|
2772
|
+
(_id: string, media: MediaAssignmentToChoice[]): Promise<void>;
|
|
2773
|
+
}
|
|
2774
|
+
declare function removeProductMediaFromChoices$1(httpClient: HttpClient): RemoveProductMediaFromChoicesSignature;
|
|
2775
|
+
interface RemoveProductMediaFromChoicesSignature {
|
|
2776
|
+
/**
|
|
2777
|
+
* Removes media items from all or some of a product's choices.
|
|
2778
|
+
* (Media items can only be set for choices within one option at a time - e.g., if you set media items for some or all of the choices within the Colors option (blue, green, and red), you won't be able to also assign media items to choices within the Size option (S, M, and L).)
|
|
2779
|
+
* @param - Product ID from whose choices to remove media items.
|
|
2780
|
+
* @param - Media to remove from choices. If an empty array is passed, all media will be removed from all choices for the given product.
|
|
2781
|
+
*/
|
|
2782
|
+
(_id: string, media: MediaAssignmentToChoice[]): Promise<void>;
|
|
2783
|
+
}
|
|
2784
|
+
declare function deleteProductOptions$1(httpClient: HttpClient): DeleteProductOptionsSignature;
|
|
2785
|
+
interface DeleteProductOptionsSignature {
|
|
2786
|
+
/**
|
|
2787
|
+
* Delete all options from a specific product. Only available when [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is disabled.
|
|
2788
|
+
* @param - ID of the product with options to delete.
|
|
2789
|
+
*/
|
|
2790
|
+
(_id: string): Promise<void>;
|
|
2791
|
+
}
|
|
2792
|
+
declare function removeBrand$1(httpClient: HttpClient): RemoveBrandSignature;
|
|
2793
|
+
interface RemoveBrandSignature {
|
|
2794
|
+
/**
|
|
2795
|
+
* Deletes a product's brand.
|
|
2796
|
+
* @param - Product ID.
|
|
2797
|
+
*/
|
|
2798
|
+
(_id: string): Promise<void>;
|
|
2799
|
+
}
|
|
2800
|
+
declare function createCollection$1(httpClient: HttpClient): CreateCollectionSignature;
|
|
2801
|
+
interface CreateCollectionSignature {
|
|
2802
|
+
/**
|
|
2803
|
+
* Creates a new collection.
|
|
2804
|
+
* @param - Collection info.
|
|
2805
|
+
*/
|
|
2806
|
+
(collection: Collection): Promise<CreateCollectionResponse & CreateCollectionResponseNonNullableFields>;
|
|
2807
|
+
}
|
|
2808
|
+
declare function updateCollection$1(httpClient: HttpClient): UpdateCollectionSignature;
|
|
2809
|
+
interface UpdateCollectionSignature {
|
|
2810
|
+
/**
|
|
2811
|
+
* Updates specified properties of a collection. To add products to a collection, call the [addProductsToCollection](#addproductstocollection) function.
|
|
2812
|
+
* @param - Collection ID (generated automatically by the catalog).
|
|
2813
|
+
* @param - Collection info to update.
|
|
2814
|
+
*/
|
|
2815
|
+
(_id: string | null, collection: UpdateCollection): Promise<UpdateCollectionResponse & UpdateCollectionResponseNonNullableFields>;
|
|
2816
|
+
}
|
|
2817
|
+
declare function deleteCollection$1(httpClient: HttpClient): DeleteCollectionSignature;
|
|
2818
|
+
interface DeleteCollectionSignature {
|
|
2819
|
+
/**
|
|
2820
|
+
* Deletes a collection.
|
|
2821
|
+
* @param - ID of the collection to delete.
|
|
2822
|
+
*/
|
|
2823
|
+
(_id: string): Promise<void>;
|
|
2824
|
+
}
|
|
2825
|
+
declare function removeRibbon$1(httpClient: HttpClient): RemoveRibbonSignature;
|
|
2826
|
+
interface RemoveRibbonSignature {
|
|
2827
|
+
/**
|
|
2828
|
+
* Deletes a product's ribbon.
|
|
2829
|
+
* @param - Product ID.
|
|
2830
|
+
*/
|
|
2831
|
+
(_id: string): Promise<void>;
|
|
2832
|
+
}
|
|
2833
|
+
declare function bulkUpdateProductsProperty$1(httpClient: HttpClient): BulkUpdateProductsPropertySignature;
|
|
2834
|
+
interface BulkUpdateProductsPropertySignature {
|
|
2835
|
+
/**
|
|
2836
|
+
* Updates a specified property for up to 100 products at a time.
|
|
2837
|
+
* @param - Product IDs.
|
|
2838
|
+
* @param - Field to update.
|
|
2839
|
+
*/
|
|
2840
|
+
(ids: string[], set: SetValue): Promise<BulkUpdateProductsResponse$1 & BulkUpdateProductsResponseNonNullableFields$1>;
|
|
2841
|
+
}
|
|
2842
|
+
declare function bulkAdjustProductProperty$1(httpClient: HttpClient): BulkAdjustProductPropertySignature;
|
|
2843
|
+
interface BulkAdjustProductPropertySignature {
|
|
2844
|
+
/**
|
|
2845
|
+
* Adjusts a specified numerical property for up to 100 products at a time.
|
|
2846
|
+
* The property can be increased or decreased either by percentage or amount.
|
|
2847
|
+
* @param - Numerical property to adjust.
|
|
2848
|
+
* @param - Product IDs.
|
|
2849
|
+
*/
|
|
2850
|
+
(adjust: AdjustValue$1, ids: string[]): Promise<BulkAdjustProductPropertiesResponse & BulkAdjustProductPropertiesResponseNonNullableFields>;
|
|
2851
|
+
}
|
|
2852
|
+
declare function queryProducts$3(httpClient: HttpClient): QueryProductsSignature$1;
|
|
2853
|
+
interface QueryProductsSignature$1 {
|
|
2854
|
+
/**
|
|
2855
|
+
* Returns a list of up to 100 products, given the provided paging, sorting and filtering.
|
|
2856
|
+
*/
|
|
2857
|
+
(): ProductsQueryBuilder$1;
|
|
2858
|
+
}
|
|
2859
|
+
declare function getProduct$3(httpClient: HttpClient): GetProductSignature$1;
|
|
2860
|
+
interface GetProductSignature$1 {
|
|
2861
|
+
/**
|
|
2862
|
+
* Retrieves a product with the provided ID.
|
|
2863
|
+
* @param - Requested product ID.
|
|
2864
|
+
*/
|
|
2865
|
+
(_id: string, options?: GetProductOptions$1 | undefined): Promise<GetProductResponse$1 & GetProductResponseNonNullableFields>;
|
|
2866
|
+
}
|
|
2867
|
+
declare function getCollectionBySlug$1(httpClient: HttpClient): GetCollectionBySlugSignature;
|
|
2868
|
+
interface GetCollectionBySlugSignature {
|
|
2869
|
+
/**
|
|
2870
|
+
* Retrieves a collection with the provided slug.
|
|
2871
|
+
* @param - Slug of the collection to retrieve.
|
|
2872
|
+
*/
|
|
2873
|
+
(slug: string): Promise<GetCollectionBySlugResponse & GetCollectionBySlugResponseNonNullableFields>;
|
|
2874
|
+
}
|
|
2875
|
+
declare function getProductOptionsAvailability$1(httpClient: HttpClient): GetProductOptionsAvailabilitySignature;
|
|
2876
|
+
interface GetProductOptionsAvailabilitySignature {
|
|
2877
|
+
/**
|
|
2878
|
+
* Gets the availability of relevant product variants based on the product ID and selections provided. See [Use Cases](https://dev.wix.com/api/rest/wix-stores/catalog/use-cases) for an example.
|
|
2879
|
+
* @param - Requested product ID.
|
|
2880
|
+
* @param - Array containing the selected options. For example, `["color": "Blue", "size": "Large"]`.
|
|
2881
|
+
*/
|
|
2882
|
+
(_id: string, options: Record<string, string>): Promise<ProductOptionsAvailabilityResponse & ProductOptionsAvailabilityResponseNonNullableFields>;
|
|
2883
|
+
}
|
|
2884
|
+
declare function queryProductVariants$1(httpClient: HttpClient): QueryProductVariantsSignature;
|
|
2885
|
+
interface QueryProductVariantsSignature {
|
|
2886
|
+
/**
|
|
2887
|
+
* Retrieves product variants, based on either choices (option-choice key-value pairs) or variant IDs.
|
|
2888
|
+
* See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.
|
|
2889
|
+
* @param - Requested product ID.
|
|
2890
|
+
*/
|
|
2891
|
+
(_id: string, options?: QueryProductVariantsOptions | undefined): Promise<QueryProductVariantsResponse & QueryProductVariantsResponseNonNullableFields>;
|
|
2892
|
+
}
|
|
2893
|
+
declare function queryStoreVariants$1(httpClient: HttpClient): QueryStoreVariantsSignature;
|
|
2894
|
+
interface QueryStoreVariantsSignature {
|
|
2895
|
+
/**
|
|
2896
|
+
* Retrieves up to 100 store variants, given the provided paging, filtering, and sorting.
|
|
2897
|
+
* @param - Query options.
|
|
2898
|
+
*/
|
|
2899
|
+
(query: PlatformQuery): Promise<QueryStoreVariantsResponse & QueryStoreVariantsResponseNonNullableFields>;
|
|
2900
|
+
}
|
|
2901
|
+
declare function getStoreVariant$1(httpClient: HttpClient): GetStoreVariantSignature;
|
|
2902
|
+
interface GetStoreVariantSignature {
|
|
2903
|
+
/**
|
|
2904
|
+
* Retrieves a store variant with the provided ID.
|
|
2905
|
+
* @param - Store variant ID. Comprised of the `productId` and the `variantId`, separated by a hyphen. For example, `{productId}-{variantId}`.
|
|
2906
|
+
*/
|
|
2907
|
+
(_id: string): Promise<GetStoreVariantResponse & GetStoreVariantResponseNonNullableFields>;
|
|
2908
|
+
}
|
|
2677
2909
|
declare const onProductCreated$3: EventDefinition<ProductCreatedEnvelope$1, "com.wix.ecommerce.catalog.api.v1.ProductCreated">;
|
|
2678
2910
|
declare const onProductChanged$1: EventDefinition<ProductChangedEnvelope, "com.wix.ecommerce.catalog.api.v1.ProductChanged">;
|
|
2679
2911
|
declare const onProductDeleted$3: EventDefinition<ProductDeletedEnvelope$1, "com.wix.ecommerce.catalog.api.v1.ProductDeleted">;
|
|
@@ -2740,24 +2972,45 @@ type _publicGetStoreVariantType = typeof getStoreVariant$1;
|
|
|
2740
2972
|
declare const getStoreVariant: ReturnType<typeof createRESTModule$a<_publicGetStoreVariantType>>;
|
|
2741
2973
|
|
|
2742
2974
|
type _publicOnProductCreatedType$1 = typeof onProductCreated$3;
|
|
2975
|
+
/**
|
|
2976
|
+
* Triggered when a product is created.
|
|
2977
|
+
*/
|
|
2743
2978
|
declare const onProductCreated$2: ReturnType<typeof createEventModule$7<_publicOnProductCreatedType>>;
|
|
2744
2979
|
|
|
2745
2980
|
type _publicOnProductChangedType = typeof onProductChanged$1;
|
|
2981
|
+
/**
|
|
2982
|
+
* Triggered when a product is changed.
|
|
2983
|
+
*/
|
|
2746
2984
|
declare const onProductChanged: ReturnType<typeof createEventModule$7<_publicOnProductChangedType>>;
|
|
2747
2985
|
|
|
2748
2986
|
type _publicOnProductDeletedType$1 = typeof onProductDeleted$3;
|
|
2987
|
+
/**
|
|
2988
|
+
* Triggered when a product is deleted.
|
|
2989
|
+
*/
|
|
2749
2990
|
declare const onProductDeleted$2: ReturnType<typeof createEventModule$7<_publicOnProductDeletedType>>;
|
|
2750
2991
|
|
|
2751
2992
|
type _publicOnProductCollectionCreatedType = typeof onProductCollectionCreated$1;
|
|
2993
|
+
/**
|
|
2994
|
+
* Triggered when a collection is created.
|
|
2995
|
+
*/
|
|
2752
2996
|
declare const onProductCollectionCreated: ReturnType<typeof createEventModule$7<_publicOnProductCollectionCreatedType>>;
|
|
2753
2997
|
|
|
2754
2998
|
type _publicOnProductCollectionChangedType = typeof onProductCollectionChanged$1;
|
|
2999
|
+
/**
|
|
3000
|
+
* Triggered when a collection is changed.
|
|
3001
|
+
*/
|
|
2755
3002
|
declare const onProductCollectionChanged: ReturnType<typeof createEventModule$7<_publicOnProductCollectionChangedType>>;
|
|
2756
3003
|
|
|
2757
3004
|
type _publicOnProductCollectionDeletedType = typeof onProductCollectionDeleted$1;
|
|
3005
|
+
/**
|
|
3006
|
+
* Triggered when a collection is deleted.
|
|
3007
|
+
*/
|
|
2758
3008
|
declare const onProductCollectionDeleted: ReturnType<typeof createEventModule$7<_publicOnProductCollectionDeletedType>>;
|
|
2759
3009
|
|
|
2760
3010
|
type _publicOnProductVariantsChangedType = typeof onProductVariantsChanged$1;
|
|
3011
|
+
/**
|
|
3012
|
+
* Triggered when a product variant is changed.
|
|
3013
|
+
*/
|
|
2761
3014
|
declare const onProductVariantsChanged: ReturnType<typeof createEventModule$7<_publicOnProductVariantsChangedType>>;
|
|
2762
3015
|
|
|
2763
3016
|
type context$a_AddProductMediaRequest = AddProductMediaRequest;
|
|
@@ -3723,16 +3976,116 @@ interface BulkGetOrCreateBrandsOptions {
|
|
|
3723
3976
|
fields?: RequestedFields$4[];
|
|
3724
3977
|
}
|
|
3725
3978
|
|
|
3726
|
-
declare function createBrand$1(httpClient: HttpClient):
|
|
3727
|
-
|
|
3728
|
-
|
|
3729
|
-
|
|
3730
|
-
|
|
3731
|
-
|
|
3732
|
-
|
|
3733
|
-
|
|
3734
|
-
|
|
3735
|
-
|
|
3979
|
+
declare function createBrand$1(httpClient: HttpClient): CreateBrandSignature;
|
|
3980
|
+
interface CreateBrandSignature {
|
|
3981
|
+
/**
|
|
3982
|
+
* Creates a brand.
|
|
3983
|
+
*
|
|
3984
|
+
* To assign the brand to a product, include the `brand.id` or `brand.name`
|
|
3985
|
+
* when [creating](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/create-product) or
|
|
3986
|
+
* [updating](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/update-product) a product.
|
|
3987
|
+
* @param - Brand to create.
|
|
3988
|
+
* @returns Created brand.
|
|
3989
|
+
*/
|
|
3990
|
+
(brand: Brand$1): Promise<Brand$1 & BrandNonNullableFields>;
|
|
3991
|
+
}
|
|
3992
|
+
declare function getBrand$1(httpClient: HttpClient): GetBrandSignature;
|
|
3993
|
+
interface GetBrandSignature {
|
|
3994
|
+
/**
|
|
3995
|
+
* Retrieves a brand.
|
|
3996
|
+
* @param - Brand ID.
|
|
3997
|
+
* @returns Brand.
|
|
3998
|
+
*/
|
|
3999
|
+
(brandId: string, options?: GetBrandOptions | undefined): Promise<Brand$1 & BrandNonNullableFields>;
|
|
4000
|
+
}
|
|
4001
|
+
declare function updateBrand$1(httpClient: HttpClient): UpdateBrandSignature;
|
|
4002
|
+
interface UpdateBrandSignature {
|
|
4003
|
+
/**
|
|
4004
|
+
* Updates a brand.
|
|
4005
|
+
*
|
|
4006
|
+
* Each time the brand is updated, `revision` increments by 1.
|
|
4007
|
+
* The current `revision` must be passed when updating the brand.
|
|
4008
|
+
* This ensures you're working with the latest brand and prevents unintended overwrites.
|
|
4009
|
+
* @param - Brand ID.
|
|
4010
|
+
* @returns Updated brand.
|
|
4011
|
+
*/
|
|
4012
|
+
(_id: string | null, brand: UpdateBrand, options?: UpdateBrandOptions | undefined): Promise<Brand$1 & BrandNonNullableFields>;
|
|
4013
|
+
}
|
|
4014
|
+
declare function deleteBrand$1(httpClient: HttpClient): DeleteBrandSignature;
|
|
4015
|
+
interface DeleteBrandSignature {
|
|
4016
|
+
/**
|
|
4017
|
+
* Deletes a brand.
|
|
4018
|
+
*
|
|
4019
|
+
* > **Note:** Deleting a brand will also remove it from all products it is assigned to.
|
|
4020
|
+
* @param - Brand ID.
|
|
4021
|
+
*/
|
|
4022
|
+
(brandId: string): Promise<void>;
|
|
4023
|
+
}
|
|
4024
|
+
declare function queryBrands$1(httpClient: HttpClient): QueryBrandsSignature;
|
|
4025
|
+
interface QueryBrandsSignature {
|
|
4026
|
+
/**
|
|
4027
|
+
* Retrieves a list of up to 100 brands, given the provided filtering, sorting, and cursor paging.
|
|
4028
|
+
* Pass supported values to the `fields` array in the request to include those fields in the response.
|
|
4029
|
+
*
|
|
4030
|
+
*
|
|
4031
|
+
* Query Brands runs with these defaults, which you can override:
|
|
4032
|
+
*
|
|
4033
|
+
* - `createdDate` is sorted in `DESC` order
|
|
4034
|
+
* - `cursorPaging.limit` is `100`
|
|
4035
|
+
*
|
|
4036
|
+
* For field support for filters and sorting,
|
|
4037
|
+
* see [Brands: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/brands-v3/supported-filters-and-sorting).
|
|
4038
|
+
*
|
|
4039
|
+
* To learn about working with _Query_ endpoints, see
|
|
4040
|
+
* [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),
|
|
4041
|
+
* and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
4042
|
+
*/
|
|
4043
|
+
(options?: QueryBrandsOptions | undefined): BrandsQueryBuilder;
|
|
4044
|
+
}
|
|
4045
|
+
declare function bulkCreateBrands$1(httpClient: HttpClient): BulkCreateBrandsSignature;
|
|
4046
|
+
interface BulkCreateBrandsSignature {
|
|
4047
|
+
/**
|
|
4048
|
+
* Creates multiple brands.
|
|
4049
|
+
* @param - Brands to create.
|
|
4050
|
+
*/
|
|
4051
|
+
(brands: Brand$1[], options?: BulkCreateBrandsOptions | undefined): Promise<BulkCreateBrandsResponse & BulkCreateBrandsResponseNonNullableFields>;
|
|
4052
|
+
}
|
|
4053
|
+
declare function bulkUpdateBrands$1(httpClient: HttpClient): BulkUpdateBrandsSignature;
|
|
4054
|
+
interface BulkUpdateBrandsSignature {
|
|
4055
|
+
/**
|
|
4056
|
+
* Updates multiple brands.
|
|
4057
|
+
*
|
|
4058
|
+
* Each time a brand is updated, `revision` increments by 1.
|
|
4059
|
+
* The current `revision` must be passed when updating a brand.
|
|
4060
|
+
* This ensures you're working with the latest brand and prevents unintended overwrites.
|
|
4061
|
+
* @param - List of brands to update.
|
|
4062
|
+
*/
|
|
4063
|
+
(brands: MaskedBrand[], options?: BulkUpdateBrandsOptions | undefined): Promise<BulkUpdateBrandsResponse & BulkUpdateBrandsResponseNonNullableFields>;
|
|
4064
|
+
}
|
|
4065
|
+
declare function getOrCreateBrand$1(httpClient: HttpClient): GetOrCreateBrandSignature;
|
|
4066
|
+
interface GetOrCreateBrandSignature {
|
|
4067
|
+
/**
|
|
4068
|
+
* Retrieves a brand by name, or creates a brand if one with the passed `brandName` doesn't exist.
|
|
4069
|
+
* @param - Brand name to retrieve or create.
|
|
4070
|
+
*/
|
|
4071
|
+
(brandName: string, options?: GetOrCreateBrandOptions | undefined): Promise<GetOrCreateBrandResponse & GetOrCreateBrandResponseNonNullableFields>;
|
|
4072
|
+
}
|
|
4073
|
+
declare function bulkGetOrCreateBrands$1(httpClient: HttpClient): BulkGetOrCreateBrandsSignature;
|
|
4074
|
+
interface BulkGetOrCreateBrandsSignature {
|
|
4075
|
+
/**
|
|
4076
|
+
* Retrieves multiple brands by name, or creates multiple brands if those with the passed `ribbonNames` don't exist.
|
|
4077
|
+
* @param - Brand names to retrieve or create.
|
|
4078
|
+
*/
|
|
4079
|
+
(brandNames: string[], options?: BulkGetOrCreateBrandsOptions | undefined): Promise<BulkGetOrCreateBrandsResponse & BulkGetOrCreateBrandsResponseNonNullableFields>;
|
|
4080
|
+
}
|
|
4081
|
+
declare function bulkDeleteBrands$1(httpClient: HttpClient): BulkDeleteBrandsSignature;
|
|
4082
|
+
interface BulkDeleteBrandsSignature {
|
|
4083
|
+
/**
|
|
4084
|
+
* Deletes multiple brands.
|
|
4085
|
+
* @param - IDs of brands to delete.
|
|
4086
|
+
*/
|
|
4087
|
+
(brandIds: string[]): Promise<BulkDeleteBrandsResponse & BulkDeleteBrandsResponseNonNullableFields>;
|
|
4088
|
+
}
|
|
3736
4089
|
declare const onBrandCreated$1: EventDefinition<BrandCreatedEnvelope, "wix.stores.catalog.v3.brand_created">;
|
|
3737
4090
|
declare const onBrandUpdated$1: EventDefinition<BrandUpdatedEnvelope, "wix.stores.catalog.v3.brand_updated">;
|
|
3738
4091
|
declare const onBrandDeleted$1: EventDefinition<BrandDeletedEnvelope, "wix.stores.catalog.v3.brand_deleted">;
|
|
@@ -3763,12 +4116,21 @@ type _publicBulkDeleteBrandsType = typeof bulkDeleteBrands$1;
|
|
|
3763
4116
|
declare const bulkDeleteBrands: ReturnType<typeof createRESTModule$9<_publicBulkDeleteBrandsType>>;
|
|
3764
4117
|
|
|
3765
4118
|
type _publicOnBrandCreatedType = typeof onBrandCreated$1;
|
|
4119
|
+
/**
|
|
4120
|
+
* Triggered when a brand is created.
|
|
4121
|
+
*/
|
|
3766
4122
|
declare const onBrandCreated: ReturnType<typeof createEventModule$6<_publicOnBrandCreatedType>>;
|
|
3767
4123
|
|
|
3768
4124
|
type _publicOnBrandUpdatedType = typeof onBrandUpdated$1;
|
|
4125
|
+
/**
|
|
4126
|
+
* Triggered when a brand is updated.
|
|
4127
|
+
*/
|
|
3769
4128
|
declare const onBrandUpdated: ReturnType<typeof createEventModule$6<_publicOnBrandUpdatedType>>;
|
|
3770
4129
|
|
|
3771
4130
|
type _publicOnBrandDeletedType = typeof onBrandDeleted$1;
|
|
4131
|
+
/**
|
|
4132
|
+
* Triggered when a brand is deleted.
|
|
4133
|
+
*/
|
|
3772
4134
|
declare const onBrandDeleted: ReturnType<typeof createEventModule$6<_publicOnBrandDeletedType>>;
|
|
3773
4135
|
|
|
3774
4136
|
type context$9_BrandCreatedEnvelope = BrandCreatedEnvelope;
|
|
@@ -4803,35 +5165,145 @@ interface BulkUpdateCustomizationsOptions {
|
|
|
4803
5165
|
fields?: RequestedFields$3[];
|
|
4804
5166
|
}
|
|
4805
5167
|
|
|
4806
|
-
declare function createCustomization$1(httpClient: HttpClient):
|
|
4807
|
-
|
|
4808
|
-
|
|
4809
|
-
|
|
4810
|
-
|
|
4811
|
-
|
|
4812
|
-
|
|
4813
|
-
|
|
4814
|
-
|
|
4815
|
-
declare function
|
|
4816
|
-
|
|
4817
|
-
|
|
4818
|
-
|
|
4819
|
-
|
|
4820
|
-
|
|
4821
|
-
|
|
4822
|
-
|
|
4823
|
-
|
|
4824
|
-
|
|
4825
|
-
|
|
4826
|
-
|
|
4827
|
-
|
|
4828
|
-
|
|
4829
|
-
|
|
4830
|
-
|
|
4831
|
-
|
|
4832
|
-
|
|
4833
|
-
|
|
4834
|
-
|
|
5168
|
+
declare function createCustomization$1(httpClient: HttpClient): CreateCustomizationSignature;
|
|
5169
|
+
interface CreateCustomizationSignature {
|
|
5170
|
+
/**
|
|
5171
|
+
* Creates a customization.
|
|
5172
|
+
* @param - Customization to create.
|
|
5173
|
+
* @returns Created customization.
|
|
5174
|
+
*/
|
|
5175
|
+
(customization: Customization): Promise<Customization & CustomizationNonNullableFields>;
|
|
5176
|
+
}
|
|
5177
|
+
declare function getCustomization$1(httpClient: HttpClient): GetCustomizationSignature;
|
|
5178
|
+
interface GetCustomizationSignature {
|
|
5179
|
+
/**
|
|
5180
|
+
* Retrieves a customization.
|
|
5181
|
+
* @param - Customization ID.
|
|
5182
|
+
* @returns Customization.
|
|
5183
|
+
*/
|
|
5184
|
+
(customizationId: string, options?: GetCustomizationOptions | undefined): Promise<Customization & CustomizationNonNullableFields>;
|
|
5185
|
+
}
|
|
5186
|
+
declare function updateCustomization$1(httpClient: HttpClient): UpdateCustomizationSignature;
|
|
5187
|
+
interface UpdateCustomizationSignature {
|
|
5188
|
+
/**
|
|
5189
|
+
* Updates a customization.
|
|
5190
|
+
*
|
|
5191
|
+
* Each time the customization is updated, `revision` increments by 1.
|
|
5192
|
+
* The current `revision` must be passed when updating the customization.
|
|
5193
|
+
* This ensures you're working with the latest customization and prevents unintended overwrites.
|
|
5194
|
+
* @param - Customization ID.
|
|
5195
|
+
* @returns Updated customization.
|
|
5196
|
+
*/
|
|
5197
|
+
(_id: string | null, customization: UpdateCustomization, options?: UpdateCustomizationOptions | undefined): Promise<Customization & CustomizationNonNullableFields>;
|
|
5198
|
+
}
|
|
5199
|
+
declare function deleteCustomization$1(httpClient: HttpClient): DeleteCustomizationSignature;
|
|
5200
|
+
interface DeleteCustomizationSignature {
|
|
5201
|
+
/**
|
|
5202
|
+
* Deletes a customization.
|
|
5203
|
+
*
|
|
5204
|
+
* > **Note:** A customization cannot be deleted if it is assigned to one or more products.
|
|
5205
|
+
* @param - Customization ID.
|
|
5206
|
+
*/
|
|
5207
|
+
(customizationId: string): Promise<void>;
|
|
5208
|
+
}
|
|
5209
|
+
declare function queryCustomizations$1(httpClient: HttpClient): QueryCustomizationsSignature;
|
|
5210
|
+
interface QueryCustomizationsSignature {
|
|
5211
|
+
/**
|
|
5212
|
+
* Retrieves a list of up to 100 customizations, given the provided filtering, sorting, and cursor paging.
|
|
5213
|
+
* Pass supported values to the `fields` array in the request to include those fields in the response.
|
|
5214
|
+
*
|
|
5215
|
+
*
|
|
5216
|
+
* Query Customizations runs with these defaults, which you can override:
|
|
5217
|
+
*
|
|
5218
|
+
* - `createdDate` is sorted in `DESC` order
|
|
5219
|
+
* - `cursorPaging.limit` is `100`
|
|
5220
|
+
*
|
|
5221
|
+
* For field support for filters and sorting,
|
|
5222
|
+
* see [Customizations: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/customizations-v3/supported-filters-and-sorting).
|
|
5223
|
+
*
|
|
5224
|
+
* To learn about working with _Query_ endpoints, see
|
|
5225
|
+
* [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),
|
|
5226
|
+
* and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
5227
|
+
*/
|
|
5228
|
+
(options?: QueryCustomizationsOptions | undefined): CustomizationsQueryBuilder;
|
|
5229
|
+
}
|
|
5230
|
+
declare function bulkCreateCustomizations$1(httpClient: HttpClient): BulkCreateCustomizationsSignature;
|
|
5231
|
+
interface BulkCreateCustomizationsSignature {
|
|
5232
|
+
/**
|
|
5233
|
+
* Creates multiple brands.
|
|
5234
|
+
* @param - Customizations to create.
|
|
5235
|
+
*/
|
|
5236
|
+
(customizations: Customization[], options?: BulkCreateCustomizationsOptions | undefined): Promise<BulkCreateCustomizationsResponse & BulkCreateCustomizationsResponseNonNullableFields>;
|
|
5237
|
+
}
|
|
5238
|
+
declare function addCustomizationChoices$1(httpClient: HttpClient): AddCustomizationChoicesSignature;
|
|
5239
|
+
interface AddCustomizationChoicesSignature {
|
|
5240
|
+
/**
|
|
5241
|
+
* Adds choices to a customization.
|
|
5242
|
+
* @param - Customization ID.
|
|
5243
|
+
* @param - Choices to add.
|
|
5244
|
+
*/
|
|
5245
|
+
(customizationId: string, choices: Choice[], options?: AddCustomizationChoicesOptions | undefined): Promise<AddCustomizationChoicesResponse & AddCustomizationChoicesResponseNonNullableFields>;
|
|
5246
|
+
}
|
|
5247
|
+
declare function setCustomizationChoices$1(httpClient: HttpClient): SetCustomizationChoicesSignature;
|
|
5248
|
+
interface SetCustomizationChoicesSignature {
|
|
5249
|
+
/**
|
|
5250
|
+
* Sets a customization's choices. Any and all existing choices will be overridden.
|
|
5251
|
+
*
|
|
5252
|
+
* > **Note:** A choice cannot be overridden if it is assigned to one or more products.
|
|
5253
|
+
* @param - Customization ID.
|
|
5254
|
+
* @param - Choices to set.
|
|
5255
|
+
*/
|
|
5256
|
+
(customizationId: string, choices: Choice[], options?: SetCustomizationChoicesOptions | undefined): Promise<SetCustomizationChoicesResponse & SetCustomizationChoicesResponseNonNullableFields>;
|
|
5257
|
+
}
|
|
5258
|
+
declare function removeCustomizationChoices$1(httpClient: HttpClient): RemoveCustomizationChoicesSignature;
|
|
5259
|
+
interface RemoveCustomizationChoicesSignature {
|
|
5260
|
+
/**
|
|
5261
|
+
* Removes choices from a customization.
|
|
5262
|
+
*
|
|
5263
|
+
* +> **Note:** A choice cannot be removed if it is assigned to one or more products.
|
|
5264
|
+
* @param - Customization ID.
|
|
5265
|
+
* @param - IDs of choices to remove.
|
|
5266
|
+
*/
|
|
5267
|
+
(customizationId: string, choiceIds: string[], options?: RemoveCustomizationChoicesOptions | undefined): Promise<RemoveCustomizationChoicesResponse & RemoveCustomizationChoicesResponseNonNullableFields>;
|
|
5268
|
+
}
|
|
5269
|
+
declare function bulkAddCustomizationChoices$1(httpClient: HttpClient): BulkAddCustomizationChoicesSignature;
|
|
5270
|
+
interface BulkAddCustomizationChoicesSignature {
|
|
5271
|
+
/**
|
|
5272
|
+
* Adds choices to multiple customizations.
|
|
5273
|
+
* @param - List of customization IDs and choices.
|
|
5274
|
+
*/
|
|
5275
|
+
(customizationsChoices: CustomizationChoices[], options?: BulkAddCustomizationChoicesOptions | undefined): Promise<BulkAddCustomizationChoicesResponse & BulkAddCustomizationChoicesResponseNonNullableFields>;
|
|
5276
|
+
}
|
|
5277
|
+
declare function bulkUpdateCustomizations$1(httpClient: HttpClient): BulkUpdateCustomizationsSignature;
|
|
5278
|
+
interface BulkUpdateCustomizationsSignature {
|
|
5279
|
+
/**
|
|
5280
|
+
* Updates multiple customizations.
|
|
5281
|
+
*
|
|
5282
|
+
* Each time the customization is updated, `revision` increments by 1.
|
|
5283
|
+
* The current `revision` must be passed when updating the customization.
|
|
5284
|
+
* This ensures you're working with the latest customization and prevents unintended overwrites.
|
|
5285
|
+
* @param - List of customizations to update.
|
|
5286
|
+
*/
|
|
5287
|
+
(customizations: MaskedCustomization[], options?: BulkUpdateCustomizationsOptions | undefined): Promise<BulkUpdateCustomizationsResponse & BulkUpdateCustomizationsResponseNonNullableFields>;
|
|
5288
|
+
}
|
|
5289
|
+
declare const onCustomizationCreated$1: EventDefinition<CustomizationCreatedEnvelope, "wix.stores.catalog.v3.customization_created">;
|
|
5290
|
+
declare const onCustomizationUpdated$1: EventDefinition<CustomizationUpdatedEnvelope, "wix.stores.catalog.v3.customization_updated">;
|
|
5291
|
+
declare const onCustomizationDeleted$1: EventDefinition<CustomizationDeletedEnvelope, "wix.stores.catalog.v3.customization_deleted">;
|
|
5292
|
+
|
|
5293
|
+
declare function createRESTModule$8<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
5294
|
+
|
|
5295
|
+
declare function createEventModule$5<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
|
5296
|
+
|
|
5297
|
+
type _publicCreateCustomizationType = typeof createCustomization$1;
|
|
5298
|
+
declare const createCustomization: ReturnType<typeof createRESTModule$8<_publicCreateCustomizationType>>;
|
|
5299
|
+
type _publicGetCustomizationType = typeof getCustomization$1;
|
|
5300
|
+
declare const getCustomization: ReturnType<typeof createRESTModule$8<_publicGetCustomizationType>>;
|
|
5301
|
+
type _publicUpdateCustomizationType = typeof updateCustomization$1;
|
|
5302
|
+
declare const updateCustomization: ReturnType<typeof createRESTModule$8<_publicUpdateCustomizationType>>;
|
|
5303
|
+
type _publicDeleteCustomizationType = typeof deleteCustomization$1;
|
|
5304
|
+
declare const deleteCustomization: ReturnType<typeof createRESTModule$8<_publicDeleteCustomizationType>>;
|
|
5305
|
+
type _publicQueryCustomizationsType = typeof queryCustomizations$1;
|
|
5306
|
+
declare const queryCustomizations: ReturnType<typeof createRESTModule$8<_publicQueryCustomizationsType>>;
|
|
4835
5307
|
type _publicBulkCreateCustomizationsType = typeof bulkCreateCustomizations$1;
|
|
4836
5308
|
declare const bulkCreateCustomizations: ReturnType<typeof createRESTModule$8<_publicBulkCreateCustomizationsType>>;
|
|
4837
5309
|
type _publicAddCustomizationChoicesType = typeof addCustomizationChoices$1;
|
|
@@ -4846,12 +5318,21 @@ type _publicBulkUpdateCustomizationsType = typeof bulkUpdateCustomizations$1;
|
|
|
4846
5318
|
declare const bulkUpdateCustomizations: ReturnType<typeof createRESTModule$8<_publicBulkUpdateCustomizationsType>>;
|
|
4847
5319
|
|
|
4848
5320
|
type _publicOnCustomizationCreatedType = typeof onCustomizationCreated$1;
|
|
5321
|
+
/**
|
|
5322
|
+
* Triggered when a customization is created.
|
|
5323
|
+
*/
|
|
4849
5324
|
declare const onCustomizationCreated: ReturnType<typeof createEventModule$5<_publicOnCustomizationCreatedType>>;
|
|
4850
5325
|
|
|
4851
5326
|
type _publicOnCustomizationUpdatedType = typeof onCustomizationUpdated$1;
|
|
5327
|
+
/**
|
|
5328
|
+
* Triggered when a customization is updated.
|
|
5329
|
+
*/
|
|
4852
5330
|
declare const onCustomizationUpdated: ReturnType<typeof createEventModule$5<_publicOnCustomizationUpdatedType>>;
|
|
4853
5331
|
|
|
4854
5332
|
type _publicOnCustomizationDeletedType = typeof onCustomizationDeleted$1;
|
|
5333
|
+
/**
|
|
5334
|
+
* Triggered when a customization is deleted.
|
|
5335
|
+
*/
|
|
4855
5336
|
declare const onCustomizationDeleted: ReturnType<typeof createEventModule$5<_publicOnCustomizationDeletedType>>;
|
|
4856
5337
|
|
|
4857
5338
|
type context$8_AddCustomizationChoicesOptions = AddCustomizationChoicesOptions;
|
|
@@ -7234,16 +7715,119 @@ interface BulkUpdateInfoSectionsOptions {
|
|
|
7234
7715
|
fields?: RequestedFields$2[];
|
|
7235
7716
|
}
|
|
7236
7717
|
|
|
7237
|
-
declare function createInfoSection$1(httpClient: HttpClient):
|
|
7238
|
-
|
|
7239
|
-
|
|
7240
|
-
|
|
7241
|
-
|
|
7242
|
-
|
|
7243
|
-
|
|
7244
|
-
|
|
7245
|
-
|
|
7246
|
-
|
|
7718
|
+
declare function createInfoSection$1(httpClient: HttpClient): CreateInfoSectionSignature;
|
|
7719
|
+
interface CreateInfoSectionSignature {
|
|
7720
|
+
/**
|
|
7721
|
+
* Creates an info section.
|
|
7722
|
+
*
|
|
7723
|
+
* To assign the info section to a product, include the `infoSection.id` or `infoSection.uniqueName`
|
|
7724
|
+
* when [creating](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/create-product) or
|
|
7725
|
+
* [updating](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/update-product) a product.
|
|
7726
|
+
* @param - Info section to create.
|
|
7727
|
+
* @returns Created info section.
|
|
7728
|
+
*/
|
|
7729
|
+
(infoSection: InfoSection$1): Promise<InfoSection$1 & InfoSectionNonNullableFields$1>;
|
|
7730
|
+
}
|
|
7731
|
+
declare function getInfoSection$1(httpClient: HttpClient): GetInfoSectionSignature;
|
|
7732
|
+
interface GetInfoSectionSignature {
|
|
7733
|
+
/**
|
|
7734
|
+
* Retrieves an info section.
|
|
7735
|
+
* @param - Info section ID.
|
|
7736
|
+
* @returns Info section.
|
|
7737
|
+
*/
|
|
7738
|
+
(infoSectionId: string, options?: GetInfoSectionOptions | undefined): Promise<InfoSection$1 & InfoSectionNonNullableFields$1>;
|
|
7739
|
+
}
|
|
7740
|
+
declare function getOrCreateInfoSection$1(httpClient: HttpClient): GetOrCreateInfoSectionSignature;
|
|
7741
|
+
interface GetOrCreateInfoSectionSignature {
|
|
7742
|
+
/**
|
|
7743
|
+
* Retrieves an info section by ID or `uniqueName`, or creates an info section if one with the passed `uniqueName` doesn't exist.
|
|
7744
|
+
*
|
|
7745
|
+
* > **Note:** If an info section with the passed `uniqueName` doesn't exist, the `uniqueName` and `title` fields are required to create a new info section.
|
|
7746
|
+
*/
|
|
7747
|
+
(options?: GetOrCreateInfoSectionOptions | undefined): Promise<GetOrCreateInfoSectionResponse & GetOrCreateInfoSectionResponseNonNullableFields>;
|
|
7748
|
+
}
|
|
7749
|
+
declare function bulkGetOrCreateInfoSections$1(httpClient: HttpClient): BulkGetOrCreateInfoSectionsSignature;
|
|
7750
|
+
interface BulkGetOrCreateInfoSectionsSignature {
|
|
7751
|
+
/**
|
|
7752
|
+
* Retrieves multiple info sections by ID or `uniqueName`, or creates multiple info sections if those with the passed `uniqueName` don't exist.
|
|
7753
|
+
*
|
|
7754
|
+
* > **Note:** If an info section with the passed `uniqueName` doesn't exist, the `uniqueName` and `title` fields are required to create a new info section.
|
|
7755
|
+
*/
|
|
7756
|
+
(options?: BulkGetOrCreateInfoSectionsOptions | undefined): Promise<BulkGetOrCreateInfoSectionsResponse & BulkGetOrCreateInfoSectionsResponseNonNullableFields>;
|
|
7757
|
+
}
|
|
7758
|
+
declare function updateInfoSection$1(httpClient: HttpClient): UpdateInfoSectionSignature;
|
|
7759
|
+
interface UpdateInfoSectionSignature {
|
|
7760
|
+
/**
|
|
7761
|
+
* Updates an info section.
|
|
7762
|
+
*
|
|
7763
|
+
*
|
|
7764
|
+
* Each time the info section is updated, `revision` increments by 1.
|
|
7765
|
+
* The current `revision` must be passed when updating the info section.
|
|
7766
|
+
* This ensures you're working with the latest info section and prevents unintended overwrites.
|
|
7767
|
+
* @param - Info section ID.
|
|
7768
|
+
* @returns Updated info section.
|
|
7769
|
+
*/
|
|
7770
|
+
(_id: string | null, infoSection: UpdateInfoSection, options?: UpdateInfoSectionOptions | undefined): Promise<InfoSection$1 & InfoSectionNonNullableFields$1>;
|
|
7771
|
+
}
|
|
7772
|
+
declare function deleteInfoSection$1(httpClient: HttpClient): DeleteInfoSectionSignature;
|
|
7773
|
+
interface DeleteInfoSectionSignature {
|
|
7774
|
+
/**
|
|
7775
|
+
* Deletes an info section.
|
|
7776
|
+
*
|
|
7777
|
+
* > **Note:** Deleting an info section will also remove it from all products it is assigned to.
|
|
7778
|
+
* @param - Info section ID
|
|
7779
|
+
*/
|
|
7780
|
+
(infoSectionId: string): Promise<void>;
|
|
7781
|
+
}
|
|
7782
|
+
declare function queryInfoSections$1(httpClient: HttpClient): QueryInfoSectionsSignature;
|
|
7783
|
+
interface QueryInfoSectionsSignature {
|
|
7784
|
+
/**
|
|
7785
|
+
* Retrieves a list of up to 100 info sections, given the provided filtering, sorting, and cursor paging.
|
|
7786
|
+
* Pass supported values to the `fields` array in the request to include those fields in the response.
|
|
7787
|
+
*
|
|
7788
|
+
*
|
|
7789
|
+
* Query Info Sections runs with these defaults, which you can override:
|
|
7790
|
+
*
|
|
7791
|
+
* - `createdDate` is sorted in `DESC` order
|
|
7792
|
+
* - `cursorPaging.limit` is `100`
|
|
7793
|
+
*
|
|
7794
|
+
* For field support for filters and sorting,
|
|
7795
|
+
* see [Info Sections: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/info-sections-v3/supported-filters-and-sorting).
|
|
7796
|
+
*
|
|
7797
|
+
* To learn about working with _Query_ endpoints, see
|
|
7798
|
+
* [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),
|
|
7799
|
+
* and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
7800
|
+
*/
|
|
7801
|
+
(options?: QueryInfoSectionsOptions | undefined): InfoSectionsQueryBuilder;
|
|
7802
|
+
}
|
|
7803
|
+
declare function bulkCreateInfoSections$1(httpClient: HttpClient): BulkCreateInfoSectionsSignature;
|
|
7804
|
+
interface BulkCreateInfoSectionsSignature {
|
|
7805
|
+
/**
|
|
7806
|
+
* Creates multiple info sections.
|
|
7807
|
+
* @param - Info sections to create.
|
|
7808
|
+
*/
|
|
7809
|
+
(infoSections: InfoSection$1[], options?: BulkCreateInfoSectionsOptions | undefined): Promise<BulkCreateInfoSectionsResponse & BulkCreateInfoSectionsResponseNonNullableFields>;
|
|
7810
|
+
}
|
|
7811
|
+
declare function bulkUpdateInfoSections$1(httpClient: HttpClient): BulkUpdateInfoSectionsSignature;
|
|
7812
|
+
interface BulkUpdateInfoSectionsSignature {
|
|
7813
|
+
/**
|
|
7814
|
+
* Updates multiple info sections.
|
|
7815
|
+
*
|
|
7816
|
+
* Each time an info section is updated, `revision` increments by 1.
|
|
7817
|
+
* The current `revision` must be passed when updating an info section.
|
|
7818
|
+
* This ensures you're working with the latest info section and prevents unintended overwrites.
|
|
7819
|
+
* @param - List of info sections to update.
|
|
7820
|
+
*/
|
|
7821
|
+
(infoSections: MaskedInfoSection[], options?: BulkUpdateInfoSectionsOptions | undefined): Promise<BulkUpdateInfoSectionsResponse & BulkUpdateInfoSectionsResponseNonNullableFields>;
|
|
7822
|
+
}
|
|
7823
|
+
declare function bulkDeleteInfoSections$1(httpClient: HttpClient): BulkDeleteInfoSectionsSignature;
|
|
7824
|
+
interface BulkDeleteInfoSectionsSignature {
|
|
7825
|
+
/**
|
|
7826
|
+
* Deletes multiple info sections.
|
|
7827
|
+
* @param - IDs of info sections to delete.
|
|
7828
|
+
*/
|
|
7829
|
+
(infoSectionIds: string[]): Promise<BulkDeleteInfoSectionsResponse & BulkDeleteInfoSectionsResponseNonNullableFields>;
|
|
7830
|
+
}
|
|
7247
7831
|
declare const onInfoSectionCreated$1: EventDefinition<InfoSectionCreatedEnvelope, "wix.stores.catalog.v3.info_section_created">;
|
|
7248
7832
|
declare const onInfoSectionUpdated$1: EventDefinition<InfoSectionUpdatedEnvelope, "wix.stores.catalog.v3.info_section_updated">;
|
|
7249
7833
|
declare const onInfoSectionDeleted$1: EventDefinition<InfoSectionDeletedEnvelope, "wix.stores.catalog.v3.info_section_deleted">;
|
|
@@ -7274,12 +7858,21 @@ type _publicBulkDeleteInfoSectionsType = typeof bulkDeleteInfoSections$1;
|
|
|
7274
7858
|
declare const bulkDeleteInfoSections: ReturnType<typeof createRESTModule$7<_publicBulkDeleteInfoSectionsType>>;
|
|
7275
7859
|
|
|
7276
7860
|
type _publicOnInfoSectionCreatedType = typeof onInfoSectionCreated$1;
|
|
7861
|
+
/**
|
|
7862
|
+
* Triggered when an info section is created.
|
|
7863
|
+
*/
|
|
7277
7864
|
declare const onInfoSectionCreated: ReturnType<typeof createEventModule$4<_publicOnInfoSectionCreatedType>>;
|
|
7278
7865
|
|
|
7279
7866
|
type _publicOnInfoSectionUpdatedType = typeof onInfoSectionUpdated$1;
|
|
7867
|
+
/**
|
|
7868
|
+
* Triggered when an info section is updated.
|
|
7869
|
+
*/
|
|
7280
7870
|
declare const onInfoSectionUpdated: ReturnType<typeof createEventModule$4<_publicOnInfoSectionUpdatedType>>;
|
|
7281
7871
|
|
|
7282
7872
|
type _publicOnInfoSectionDeletedType = typeof onInfoSectionDeleted$1;
|
|
7873
|
+
/**
|
|
7874
|
+
* Triggered when an info section is deleted.
|
|
7875
|
+
*/
|
|
7283
7876
|
declare const onInfoSectionDeleted: ReturnType<typeof createEventModule$4<_publicOnInfoSectionDeletedType>>;
|
|
7284
7877
|
|
|
7285
7878
|
type context$7_BulkCreateInfoSectionsOptions = BulkCreateInfoSectionsOptions;
|
|
@@ -9036,20 +9629,169 @@ interface BulkIncrementInventoryItemsByVariantAndLocationOptions {
|
|
|
9036
9629
|
reason?: ReasonType$1;
|
|
9037
9630
|
}
|
|
9038
9631
|
|
|
9039
|
-
declare function createInventoryItem$1(httpClient: HttpClient):
|
|
9040
|
-
|
|
9041
|
-
|
|
9042
|
-
|
|
9043
|
-
|
|
9044
|
-
|
|
9045
|
-
|
|
9046
|
-
|
|
9047
|
-
|
|
9048
|
-
|
|
9049
|
-
declare function
|
|
9050
|
-
|
|
9051
|
-
|
|
9052
|
-
|
|
9632
|
+
declare function createInventoryItem$1(httpClient: HttpClient): CreateInventoryItemSignature;
|
|
9633
|
+
interface CreateInventoryItemSignature {
|
|
9634
|
+
/**
|
|
9635
|
+
* Creates an inventory item.
|
|
9636
|
+
* The combination of `variantId` and `locationId` is unique.
|
|
9637
|
+
* @param - Inventory item to create.
|
|
9638
|
+
* @returns Created inventory item.
|
|
9639
|
+
*/
|
|
9640
|
+
(inventoryItem: InventoryItem$1): Promise<InventoryItem$1 & InventoryItemNonNullableFields$1>;
|
|
9641
|
+
}
|
|
9642
|
+
declare function bulkCreateInventoryItems$1(httpClient: HttpClient): BulkCreateInventoryItemsSignature;
|
|
9643
|
+
interface BulkCreateInventoryItemsSignature {
|
|
9644
|
+
/**
|
|
9645
|
+
* Creates multiple inventory items.
|
|
9646
|
+
* @param - Inventory items to create.
|
|
9647
|
+
*/
|
|
9648
|
+
(inventoryItems: InventoryItem$1[], options?: BulkCreateInventoryItemsOptions | undefined): Promise<BulkCreateInventoryItemsResponse & BulkCreateInventoryItemsResponseNonNullableFields>;
|
|
9649
|
+
}
|
|
9650
|
+
declare function getInventoryItem$1(httpClient: HttpClient): GetInventoryItemSignature;
|
|
9651
|
+
interface GetInventoryItemSignature {
|
|
9652
|
+
/**
|
|
9653
|
+
* Retrieves an inventory item.
|
|
9654
|
+
* @param - Inventory item ID.
|
|
9655
|
+
* @returns Inventory item.
|
|
9656
|
+
*/
|
|
9657
|
+
(inventoryItemId: string): Promise<InventoryItem$1 & InventoryItemNonNullableFields$1>;
|
|
9658
|
+
}
|
|
9659
|
+
declare function updateInventoryItem$1(httpClient: HttpClient): UpdateInventoryItemSignature;
|
|
9660
|
+
interface UpdateInventoryItemSignature {
|
|
9661
|
+
/**
|
|
9662
|
+
* Updates an inventory item.
|
|
9663
|
+
*
|
|
9664
|
+
*
|
|
9665
|
+
* Each time the inventory item is updated, `revision` increments by 1.
|
|
9666
|
+
* The current `revision` must be passed when updating the inventory item.
|
|
9667
|
+
* This ensures you're working with the latest inventory item and prevents unintended overwrites.
|
|
9668
|
+
* @param - Inventory item ID.
|
|
9669
|
+
* @returns Updated inventory item.
|
|
9670
|
+
*/
|
|
9671
|
+
(_id: string | null, inventoryItem: UpdateInventoryItem, options?: UpdateInventoryItemOptions | undefined): Promise<InventoryItem$1 & InventoryItemNonNullableFields$1>;
|
|
9672
|
+
}
|
|
9673
|
+
declare function bulkUpdateInventoryItems$1(httpClient: HttpClient): BulkUpdateInventoryItemsSignature;
|
|
9674
|
+
interface BulkUpdateInventoryItemsSignature {
|
|
9675
|
+
/**
|
|
9676
|
+
* Updates multiple inventory items.
|
|
9677
|
+
*
|
|
9678
|
+
* Each time an inventory item is updated, `revision` increments by 1.
|
|
9679
|
+
* The current `revision` must be passed when updating an inventory item.
|
|
9680
|
+
* This ensures you're working with the latest inventory item and prevents unintended overwrites.
|
|
9681
|
+
* @param - Inventory items to update.
|
|
9682
|
+
*/
|
|
9683
|
+
(inventoryItems: MaskedInventoryItem[], options?: BulkUpdateInventoryItemsOptions | undefined): Promise<BulkUpdateInventoryItemsResponse$1 & BulkUpdateInventoryItemsResponseNonNullableFields>;
|
|
9684
|
+
}
|
|
9685
|
+
declare function bulkUpdateInventoryItemsByFilter$1(httpClient: HttpClient): BulkUpdateInventoryItemsByFilterSignature;
|
|
9686
|
+
interface BulkUpdateInventoryItemsByFilterSignature {
|
|
9687
|
+
/**
|
|
9688
|
+
* Updates multiple inventory items, given the provided filter.
|
|
9689
|
+
*
|
|
9690
|
+
* Each time an inventory item is updated, `revision` increments by 1.
|
|
9691
|
+
* The current `revision` must be passed when updating an inventory item.
|
|
9692
|
+
* This ensures you're working with the latest inventory item and prevents unintended overwrites.
|
|
9693
|
+
* @param - Filter object.
|
|
9694
|
+
*/
|
|
9695
|
+
(filter: Record<string, any> | null, options?: BulkUpdateInventoryItemsByFilterOptions | undefined): Promise<BulkUpdateInventoryItemsByFilterResponse & BulkUpdateInventoryItemsByFilterResponseNonNullableFields>;
|
|
9696
|
+
}
|
|
9697
|
+
declare function deleteInventoryItem$1(httpClient: HttpClient): DeleteInventoryItemSignature;
|
|
9698
|
+
interface DeleteInventoryItemSignature {
|
|
9699
|
+
/**
|
|
9700
|
+
* Deletes an inventory item.
|
|
9701
|
+
* @param - Inventory item ID.
|
|
9702
|
+
*/
|
|
9703
|
+
(inventoryItemId: string): Promise<void>;
|
|
9704
|
+
}
|
|
9705
|
+
declare function bulkDeleteInventoryItems$1(httpClient: HttpClient): BulkDeleteInventoryItemsSignature;
|
|
9706
|
+
interface BulkDeleteInventoryItemsSignature {
|
|
9707
|
+
/**
|
|
9708
|
+
* Deletes multiple inventory items.
|
|
9709
|
+
* @param - IDs of inventory items to delete.
|
|
9710
|
+
*/
|
|
9711
|
+
(inventoryItemIds: string[]): Promise<BulkDeleteInventoryItemsResponse & BulkDeleteInventoryItemsResponseNonNullableFields>;
|
|
9712
|
+
}
|
|
9713
|
+
declare function queryInventoryItems$1(httpClient: HttpClient): QueryInventoryItemsSignature;
|
|
9714
|
+
interface QueryInventoryItemsSignature {
|
|
9715
|
+
/**
|
|
9716
|
+
* Retrieves a list of up to 1,000 inventory items, given the provided filtering, sorting, and cursor paging.
|
|
9717
|
+
*
|
|
9718
|
+
* For field support for filters and sorting,
|
|
9719
|
+
* see [Inventory Items: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/inventory-items-v3/supported-filters-and-sorting).
|
|
9720
|
+
*
|
|
9721
|
+
* To learn about working with _Query_ endpoints, see
|
|
9722
|
+
* [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),
|
|
9723
|
+
* and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
9724
|
+
*/
|
|
9725
|
+
(): InventoryItemsQueryBuilder;
|
|
9726
|
+
}
|
|
9727
|
+
declare function searchInventoryItems$1(httpClient: HttpClient): SearchInventoryItemsSignature;
|
|
9728
|
+
interface SearchInventoryItemsSignature {
|
|
9729
|
+
/**
|
|
9730
|
+
* Retrieves a list of inventory items, given the provided filtering, sorting, and cursor paging.
|
|
9731
|
+
*
|
|
9732
|
+
*
|
|
9733
|
+
* Search Inventory Items runs with these defaults, which you can override:
|
|
9734
|
+
*
|
|
9735
|
+
* - `createdDate` is sorted in `DESC` order
|
|
9736
|
+
* - `cursorPaging.limit` is `100`
|
|
9737
|
+
*
|
|
9738
|
+
* For field support for filters and sorting,
|
|
9739
|
+
* see [Inventory Items: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/inventory-items-v3/supported-filters-and-sorting).
|
|
9740
|
+
*
|
|
9741
|
+
* To learn about working with _Search_ endpoints, see
|
|
9742
|
+
* [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),
|
|
9743
|
+
* and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
9744
|
+
*/
|
|
9745
|
+
(options?: SearchInventoryItemsOptions | undefined): Promise<SearchInventoryItemsResponse & SearchInventoryItemsResponseNonNullableFields>;
|
|
9746
|
+
}
|
|
9747
|
+
declare function bulkDecrementInventoryItems$1(httpClient: HttpClient): BulkDecrementInventoryItemsSignature;
|
|
9748
|
+
interface BulkDecrementInventoryItemsSignature {
|
|
9749
|
+
/**
|
|
9750
|
+
* Decrements quantities of multiple inventory items.
|
|
9751
|
+
*
|
|
9752
|
+
* > **Notes:**:
|
|
9753
|
+
* > + `trackQuantity` must be `true` to allow for decrementing the quantity.
|
|
9754
|
+
* > + If you pass `restrictInventory: true` and the `decrementData.decrementBy` amount is greater than the current quantity in stock, the request will fail with an `INSUFFICIENT_INVENTORY` error.
|
|
9755
|
+
* > + Pass `restrictInventory: false` to allow for negative quantities.
|
|
9756
|
+
* > + If you pass `preorderRequest: true` and the item is available for preorder, the item's `preorderCounter` will increase and the item's quantity will stay the same.
|
|
9757
|
+
* @param - Inventory item IDs and decrement data.
|
|
9758
|
+
*/
|
|
9759
|
+
(decrementData: DecrementDataById[], options?: BulkDecrementInventoryItemsOptions | undefined): Promise<BulkDecrementInventoryItemsResponse & BulkDecrementInventoryItemsResponseNonNullableFields>;
|
|
9760
|
+
}
|
|
9761
|
+
declare function bulkIncrementInventoryItems$1(httpClient: HttpClient): BulkIncrementInventoryItemsSignature;
|
|
9762
|
+
interface BulkIncrementInventoryItemsSignature {
|
|
9763
|
+
/**
|
|
9764
|
+
* Increments quantities of multiple inventory items.
|
|
9765
|
+
*
|
|
9766
|
+
* > **Note:** `trackQuantity` must be `true` to allow for incrementing the quantity.
|
|
9767
|
+
* @param - Inventory item IDs and increment data.
|
|
9768
|
+
*/
|
|
9769
|
+
(incrementData: IncrementDataById[], options?: BulkIncrementInventoryItemsOptions | undefined): Promise<BulkIncrementInventoryItemsResponse & BulkIncrementInventoryItemsResponseNonNullableFields>;
|
|
9770
|
+
}
|
|
9771
|
+
declare function bulkDecrementInventoryItemsByVariantAndLocation$1(httpClient: HttpClient): BulkDecrementInventoryItemsByVariantAndLocationSignature;
|
|
9772
|
+
interface BulkDecrementInventoryItemsByVariantAndLocationSignature {
|
|
9773
|
+
/**
|
|
9774
|
+
* Decrements quantities of multiple inventory items by variant and location.
|
|
9775
|
+
*
|
|
9776
|
+
* > **Notes:**:
|
|
9777
|
+
* > + `trackQuantity` must be `true` to allow for decrementing the quantity.
|
|
9778
|
+
* > + If you pass `restrictInventory: true` and the `decrementData.decrementBy` amount is greater than the current quantity in stock, the request will fail with an `INSUFFICIENT_INVENTORY` error.
|
|
9779
|
+
* > + Pass `restrictInventory: false` to allow for negative quantities.
|
|
9780
|
+
* > + If you pass `preorderRequest: true` and the item is available for preorder, the item's `preorderCounter` will increase and the item's quantity will stay the same.
|
|
9781
|
+
* @param - Variant and location IDs, as well as decrement data.
|
|
9782
|
+
*/
|
|
9783
|
+
(decrementData: DecrementDataByVariantAndLocation[], options?: BulkDecrementInventoryItemsByVariantAndLocationOptions | undefined): Promise<BulkDecrementInventoryItemsByVariantAndLocationResponse & BulkDecrementInventoryItemsByVariantAndLocationResponseNonNullableFields>;
|
|
9784
|
+
}
|
|
9785
|
+
declare function bulkIncrementInventoryItemsByVariantAndLocation$1(httpClient: HttpClient): BulkIncrementInventoryItemsByVariantAndLocationSignature;
|
|
9786
|
+
interface BulkIncrementInventoryItemsByVariantAndLocationSignature {
|
|
9787
|
+
/**
|
|
9788
|
+
* Increments quantities of multiple inventory items by variant and location.
|
|
9789
|
+
*
|
|
9790
|
+
* > **Note:** `trackQuantity` must be `true` to allow for incrementing the quantity.
|
|
9791
|
+
* @param - Variant and location IDs, as well as increment data.
|
|
9792
|
+
*/
|
|
9793
|
+
(incrementData: IncrementDataByVariantAndLocation[], options?: BulkIncrementInventoryItemsByVariantAndLocationOptions | undefined): Promise<BulkIncrementInventoryItemsByVariantAndLocationResponse & BulkIncrementInventoryItemsByVariantAndLocationResponseNonNullableFields>;
|
|
9794
|
+
}
|
|
9053
9795
|
declare const onInventoryItemCreated$1: EventDefinition<InventoryItemCreatedEnvelope, "wix.stores.catalog.v3.inventory_item_created">;
|
|
9054
9796
|
declare const onInventoryItemUpdated$1: EventDefinition<InventoryItemUpdatedEnvelope, "wix.stores.catalog.v3.inventory_item_updated">;
|
|
9055
9797
|
declare const onInventoryItemStockStatusUpdated$1: EventDefinition<InventoryItemStockStatusUpdatedEnvelope, "wix.stores.catalog.v3.inventory_item_stock_status_updated">;
|
|
@@ -9090,18 +9832,33 @@ type _publicBulkIncrementInventoryItemsByVariantAndLocationType = typeof bulkInc
|
|
|
9090
9832
|
declare const bulkIncrementInventoryItemsByVariantAndLocation: ReturnType<typeof createRESTModule$6<_publicBulkIncrementInventoryItemsByVariantAndLocationType>>;
|
|
9091
9833
|
|
|
9092
9834
|
type _publicOnInventoryItemCreatedType = typeof onInventoryItemCreated$1;
|
|
9835
|
+
/**
|
|
9836
|
+
* Triggered when an inventory item is created.
|
|
9837
|
+
*/
|
|
9093
9838
|
declare const onInventoryItemCreated: ReturnType<typeof createEventModule$3<_publicOnInventoryItemCreatedType>>;
|
|
9094
9839
|
|
|
9095
9840
|
type _publicOnInventoryItemUpdatedType = typeof onInventoryItemUpdated$1;
|
|
9841
|
+
/**
|
|
9842
|
+
* Triggered when an inventory item is updated.
|
|
9843
|
+
*/
|
|
9096
9844
|
declare const onInventoryItemUpdated: ReturnType<typeof createEventModule$3<_publicOnInventoryItemUpdatedType>>;
|
|
9097
9845
|
|
|
9098
9846
|
type _publicOnInventoryItemStockStatusUpdatedType = typeof onInventoryItemStockStatusUpdated$1;
|
|
9847
|
+
/**
|
|
9848
|
+
* Triggered when an inventory item's stock is updated.
|
|
9849
|
+
*/
|
|
9099
9850
|
declare const onInventoryItemStockStatusUpdated: ReturnType<typeof createEventModule$3<_publicOnInventoryItemStockStatusUpdatedType>>;
|
|
9100
9851
|
|
|
9101
9852
|
type _publicOnInventoryItemUpdatedWithReasonType = typeof onInventoryItemUpdatedWithReason$1;
|
|
9853
|
+
/**
|
|
9854
|
+
* Triggered when an inventory item is updated.
|
|
9855
|
+
*/
|
|
9102
9856
|
declare const onInventoryItemUpdatedWithReason: ReturnType<typeof createEventModule$3<_publicOnInventoryItemUpdatedWithReasonType>>;
|
|
9103
9857
|
|
|
9104
9858
|
type _publicOnInventoryItemDeletedType = typeof onInventoryItemDeleted$1;
|
|
9859
|
+
/**
|
|
9860
|
+
* Triggered when an inventory item is deleted.
|
|
9861
|
+
*/
|
|
9105
9862
|
declare const onInventoryItemDeleted: ReturnType<typeof createEventModule$3<_publicOnInventoryItemDeletedType>>;
|
|
9106
9863
|
|
|
9107
9864
|
type context$6_AdjustInventoryAction = AdjustInventoryAction;
|
|
@@ -9345,22 +10102,6 @@ interface V3Product extends V3ProductTypedPropertiesOneOf {
|
|
|
9345
10102
|
* @readonly
|
|
9346
10103
|
*/
|
|
9347
10104
|
allCategoriesInfo?: ProductCategoriesInfo;
|
|
9348
|
-
/**
|
|
9349
|
-
* A list of categories that this product is included in directly. Updated automatically when product added/removed from category, when an item is moved within the category or when category deleted.
|
|
9350
|
-
* @readonly
|
|
9351
|
-
* @deprecated A list of categories that this product is included in directly. Updated automatically when product added/removed from category, when an item is moved within the category or when category deleted.
|
|
9352
|
-
* @replacedBy direct_categories_info
|
|
9353
|
-
* @targetRemovalDate 2024-08-12
|
|
9354
|
-
*/
|
|
9355
|
-
directCategories?: ProductCategory[];
|
|
9356
|
-
/**
|
|
9357
|
-
* A list of all categories that this product is included in directly and their parent category ids. For example, product included in category "Shoes", "Shoes" has parent category "Women", product is not included in category "Women" directly but it still will be returned in this list because product included in it's subcategory.
|
|
9358
|
-
* @readonly
|
|
9359
|
-
* @deprecated A list of all categories that this product is included in directly and their parent category ids. For example, product included in category "Shoes", "Shoes" has parent category "Women", product is not included in category "Women" directly but it still will be returned in this list because product included in it's subcategory.
|
|
9360
|
-
* @replacedBy all_categories_info
|
|
9361
|
-
* @targetRemovalDate 2024-08-12
|
|
9362
|
-
*/
|
|
9363
|
-
allCategories?: ProductCategory[];
|
|
9364
10105
|
/** Main category ID. */
|
|
9365
10106
|
mainCategoryId?: string | null;
|
|
9366
10107
|
/**
|
|
@@ -10677,13 +11418,6 @@ interface Media {
|
|
|
10677
11418
|
* @readonly
|
|
10678
11419
|
*/
|
|
10679
11420
|
main?: ProductMedia;
|
|
10680
|
-
/**
|
|
10681
|
-
* Other media (images, videos, etc.) associated with this product.
|
|
10682
|
-
* @deprecated Other media (images, videos, etc.) associated with this product.
|
|
10683
|
-
* @replacedBy items_info
|
|
10684
|
-
* @targetRemovalDate 2024-08-05
|
|
10685
|
-
*/
|
|
10686
|
-
items?: ProductMedia[];
|
|
10687
11421
|
/**
|
|
10688
11422
|
* All media items.
|
|
10689
11423
|
* > **Note:** Returned only when you pass `"MEDIA_ITEMS_INFO"` to the `fields` array in Products API requests.
|
|
@@ -10964,7 +11698,7 @@ interface InfoSection {
|
|
|
10964
11698
|
title?: string | null;
|
|
10965
11699
|
/**
|
|
10966
11700
|
* Info section description using rich content. Learn more about [Working with Rich Content](https://dev.wix.com/docs/go-headless/tutorials-templates/other-tutorials/working-with-rich-content).
|
|
10967
|
-
* > **Note:** Returned only when you pass `"
|
|
11701
|
+
* > **Note:** Returned only when you pass `"INFO_SECTION_DESCRIPTION"` to the `fields` array in Products API requests.
|
|
10968
11702
|
* @readonly
|
|
10969
11703
|
*/
|
|
10970
11704
|
description?: RichContent;
|
|
@@ -11743,7 +12477,8 @@ declare enum SingleEntityOpsRequestedFields {
|
|
|
11743
12477
|
DESCRIPTION = "DESCRIPTION",
|
|
11744
12478
|
DIRECT_CATEGORIES_INFO = "DIRECT_CATEGORIES_INFO",
|
|
11745
12479
|
ALL_CATEGORIES_INFO = "ALL_CATEGORIES_INFO",
|
|
11746
|
-
MIN_VARIANT_PRICE_INFO = "MIN_VARIANT_PRICE_INFO"
|
|
12480
|
+
MIN_VARIANT_PRICE_INFO = "MIN_VARIANT_PRICE_INFO",
|
|
12481
|
+
INFO_SECTION_DESCRIPTION = "INFO_SECTION_DESCRIPTION"
|
|
11747
12482
|
}
|
|
11748
12483
|
interface CreateProductResponse {
|
|
11749
12484
|
/** Created product. */
|
|
@@ -12268,7 +13003,8 @@ declare enum RequestedFields$1 {
|
|
|
12268
13003
|
DESCRIPTION = "DESCRIPTION",
|
|
12269
13004
|
DIRECT_CATEGORIES_INFO = "DIRECT_CATEGORIES_INFO",
|
|
12270
13005
|
ALL_CATEGORIES_INFO = "ALL_CATEGORIES_INFO",
|
|
12271
|
-
MIN_VARIANT_PRICE_INFO = "MIN_VARIANT_PRICE_INFO"
|
|
13006
|
+
MIN_VARIANT_PRICE_INFO = "MIN_VARIANT_PRICE_INFO",
|
|
13007
|
+
INFO_SECTION_DESCRIPTION = "INFO_SECTION_DESCRIPTION"
|
|
12272
13008
|
}
|
|
12273
13009
|
interface BulkCreateProductsResponse {
|
|
12274
13010
|
/** Products created by bulk action. */
|
|
@@ -14735,7 +15471,6 @@ interface MediaItemsInfoNonNullableFields {
|
|
|
14735
15471
|
}
|
|
14736
15472
|
interface MediaNonNullableFields {
|
|
14737
15473
|
main?: ProductMediaNonNullableFields;
|
|
14738
|
-
items: ProductMediaNonNullableFields[];
|
|
14739
15474
|
itemsInfo?: MediaItemsInfoNonNullableFields;
|
|
14740
15475
|
}
|
|
14741
15476
|
interface TagNonNullableFields {
|
|
@@ -14928,8 +15663,6 @@ interface V3ProductNonNullableFields {
|
|
|
14928
15663
|
infoSections: InfoSectionNonNullableFields[];
|
|
14929
15664
|
directCategoriesInfo?: ProductCategoriesInfoNonNullableFields;
|
|
14930
15665
|
allCategoriesInfo?: ProductCategoriesInfoNonNullableFields;
|
|
14931
|
-
directCategories: ProductCategoryNonNullableFields[];
|
|
14932
|
-
allCategories: ProductCategoryNonNullableFields[];
|
|
14933
15666
|
basePriceRange?: PriceRangeNonNullableFields;
|
|
14934
15667
|
salePriceRange?: PriceRangeNonNullableFields;
|
|
14935
15668
|
costRange?: PriceRangeNonNullableFields;
|
|
@@ -15324,22 +16057,6 @@ interface UpdateProduct {
|
|
|
15324
16057
|
* @readonly
|
|
15325
16058
|
*/
|
|
15326
16059
|
allCategoriesInfo?: ProductCategoriesInfo;
|
|
15327
|
-
/**
|
|
15328
|
-
* A list of categories that this product is included in directly. Updated automatically when product added/removed from category, when an item is moved within the category or when category deleted.
|
|
15329
|
-
* @readonly
|
|
15330
|
-
* @deprecated A list of categories that this product is included in directly. Updated automatically when product added/removed from category, when an item is moved within the category or when category deleted.
|
|
15331
|
-
* @replacedBy direct_categories_info
|
|
15332
|
-
* @targetRemovalDate 2024-08-12
|
|
15333
|
-
*/
|
|
15334
|
-
directCategories?: ProductCategory[];
|
|
15335
|
-
/**
|
|
15336
|
-
* A list of all categories that this product is included in directly and their parent category ids. For example, product included in category "Shoes", "Shoes" has parent category "Women", product is not included in category "Women" directly but it still will be returned in this list because product included in it's subcategory.
|
|
15337
|
-
* @readonly
|
|
15338
|
-
* @deprecated A list of all categories that this product is included in directly and their parent category ids. For example, product included in category "Shoes", "Shoes" has parent category "Women", product is not included in category "Women" directly but it still will be returned in this list because product included in it's subcategory.
|
|
15339
|
-
* @replacedBy all_categories_info
|
|
15340
|
-
* @targetRemovalDate 2024-08-12
|
|
15341
|
-
*/
|
|
15342
|
-
allCategories?: ProductCategory[];
|
|
15343
16060
|
/** Main category ID. */
|
|
15344
16061
|
mainCategoryId?: string | null;
|
|
15345
16062
|
/**
|
|
@@ -15795,32 +16512,327 @@ interface BulkRemoveProductsFromCategoriesByFilterOptions {
|
|
|
15795
16512
|
search?: WixCommonSearchDetails;
|
|
15796
16513
|
}
|
|
15797
16514
|
|
|
15798
|
-
declare function createProduct$1(httpClient: HttpClient):
|
|
15799
|
-
|
|
15800
|
-
|
|
15801
|
-
|
|
15802
|
-
|
|
15803
|
-
|
|
15804
|
-
|
|
15805
|
-
|
|
15806
|
-
|
|
15807
|
-
|
|
15808
|
-
|
|
15809
|
-
|
|
15810
|
-
|
|
15811
|
-
|
|
15812
|
-
declare function
|
|
15813
|
-
|
|
15814
|
-
|
|
15815
|
-
|
|
15816
|
-
|
|
15817
|
-
|
|
15818
|
-
|
|
15819
|
-
|
|
15820
|
-
|
|
15821
|
-
|
|
15822
|
-
|
|
15823
|
-
|
|
16515
|
+
declare function createProduct$1(httpClient: HttpClient): CreateProductSignature;
|
|
16516
|
+
interface CreateProductSignature {
|
|
16517
|
+
/**
|
|
16518
|
+
* Creates a new product.
|
|
16519
|
+
*
|
|
16520
|
+
* This endpoint also allows to add a ribbon, brand, info sections, options, and modifiers.
|
|
16521
|
+
* @param - Product to create.
|
|
16522
|
+
*
|
|
16523
|
+
* At least 1 variant must be provided and each variant must have relevant item in `choices` field for every item in `options`.
|
|
16524
|
+
* If `options` is empty one default variant must be provided with empty `choices` list.
|
|
16525
|
+
* @returns Created product.
|
|
16526
|
+
*/
|
|
16527
|
+
(product: V3Product, options?: CreateProductOptions | undefined): Promise<V3Product & V3ProductNonNullableFields>;
|
|
16528
|
+
}
|
|
16529
|
+
declare function createProductWithInventory$1(httpClient: HttpClient): CreateProductWithInventorySignature;
|
|
16530
|
+
interface CreateProductWithInventorySignature {
|
|
16531
|
+
/**
|
|
16532
|
+
* Creates a new product, and can create the product's inventory in the variants' default locations.
|
|
16533
|
+
*
|
|
16534
|
+
* This endpoint also allows to add a ribbon, brand, info sections, options, and modifiers.
|
|
16535
|
+
* @param - Product to create with inventory.
|
|
16536
|
+
*
|
|
16537
|
+
* At least one variant must be provided and each variant must have relevant item in `choices` field for every item in `options`.
|
|
16538
|
+
* If `options` is empty one default variant must be provided with empty `choices` list.
|
|
16539
|
+
*/
|
|
16540
|
+
(product: ProductWithInventory, options?: CreateProductWithInventoryOptions | undefined): Promise<CreateProductWithInventoryResponse & CreateProductWithInventoryResponseNonNullableFields>;
|
|
16541
|
+
}
|
|
16542
|
+
declare function updateProduct$1(httpClient: HttpClient): UpdateProductSignature;
|
|
16543
|
+
interface UpdateProductSignature {
|
|
16544
|
+
/**
|
|
16545
|
+
* Updates a product.
|
|
16546
|
+
*
|
|
16547
|
+
* Each time the product is updated, `revision` increments by 1.
|
|
16548
|
+
* The current `revision` must be passed when updating the product.
|
|
16549
|
+
* This ensures you're working with the latest product and prevents unintended overwrites.
|
|
16550
|
+
*
|
|
16551
|
+
* >**Notes:**
|
|
16552
|
+
* > + If `variantsInfo.variants` are passed, they will replace all existing variants.
|
|
16553
|
+
* > + To update existing `variantsInfo.variants`, make sure to provide `variantsInfo.variants.id`. If no ID is passed, the variant will be created with a new ID.
|
|
16554
|
+
* @param - Product ID.
|
|
16555
|
+
* @returns Updated product.
|
|
16556
|
+
*/
|
|
16557
|
+
(_id: string | null, product: UpdateProduct, options?: UpdateProductOptions | undefined): Promise<V3Product & V3ProductNonNullableFields>;
|
|
16558
|
+
}
|
|
16559
|
+
declare function updateProductWithInventory$1(httpClient: HttpClient): UpdateProductWithInventorySignature;
|
|
16560
|
+
interface UpdateProductWithInventorySignature {
|
|
16561
|
+
/**
|
|
16562
|
+
* Updates a new product, and can update the product's inventory.
|
|
16563
|
+
*
|
|
16564
|
+
* Each time the product is updated, `revision` increments by 1.
|
|
16565
|
+
* The current `revision` must be passed when updating the product.
|
|
16566
|
+
* This ensures you're working with the latest product and prevents unintended overwrites.
|
|
16567
|
+
*
|
|
16568
|
+
* >**Notes:**
|
|
16569
|
+
* > + Passing `variantsInfo.variants` will replace all existing variants.
|
|
16570
|
+
* > + To update existing `variantsInfo.variants`, pass `variantsInfo.variants.id`. If no ID is passed, the variant will be created with a new ID.
|
|
16571
|
+
* @param - Product ID.
|
|
16572
|
+
*/
|
|
16573
|
+
(_id: string | null, product: UpdateProductWithInventoryProduct, options?: UpdateProductWithInventoryOptions | undefined): Promise<UpdateProductWithInventoryResponse & UpdateProductWithInventoryResponseNonNullableFields>;
|
|
16574
|
+
}
|
|
16575
|
+
declare function bulkCreateProducts$1(httpClient: HttpClient): BulkCreateProductsSignature;
|
|
16576
|
+
interface BulkCreateProductsSignature {
|
|
16577
|
+
/**
|
|
16578
|
+
* Creates up to 100 products.
|
|
16579
|
+
*
|
|
16580
|
+
* >**Note:**
|
|
16581
|
+
* > The following limits apply to the total number of creatable entities in a single request.
|
|
16582
|
+
* > For example, you can create 10 products with up to 10 options for each product (10 x 10 = 100), or one product with 100 options.
|
|
16583
|
+
* > Alternatively, you can create 100 products with up to 10 variants in each (100 x 10 = 1000), or one product with 1000 variants.
|
|
16584
|
+
* > + `options`: 100
|
|
16585
|
+
* > + `modifiers`: 100
|
|
16586
|
+
* > + `infoSections`: 100
|
|
16587
|
+
* > + `variantsInfo.variants`: 1000
|
|
16588
|
+
* @param - List of products to create.
|
|
16589
|
+
*/
|
|
16590
|
+
(products: V3Product[], options?: BulkCreateProductsOptions | undefined): Promise<BulkCreateProductsResponse & BulkCreateProductsResponseNonNullableFields>;
|
|
16591
|
+
}
|
|
16592
|
+
declare function bulkCreateProductsWithInventory$1(httpClient: HttpClient): BulkCreateProductsWithInventorySignature;
|
|
16593
|
+
interface BulkCreateProductsWithInventorySignature {
|
|
16594
|
+
/**
|
|
16595
|
+
* Creates up to 100 products, and can create the products' inventories in the variants' default locations.
|
|
16596
|
+
*
|
|
16597
|
+
* >**Note:**
|
|
16598
|
+
* > The following limits apply to the total number of creatable entities in a single request.
|
|
16599
|
+
* > For example, you can create 10 products with up to 10 options for each product (10 x 10 = 100), or one product with 100 options.
|
|
16600
|
+
* > Alternatively, you can create 100 products with up to 10 variants in each (100 x 10 = 1000), or one product with 1000 variants.
|
|
16601
|
+
* > + `options`: 100
|
|
16602
|
+
* > + `modifiers`: 100
|
|
16603
|
+
* > + `infoSections`: 100
|
|
16604
|
+
* > + `variantsInfo.variants`: 1000
|
|
16605
|
+
* @param - List of products to create with inventory.
|
|
16606
|
+
*/
|
|
16607
|
+
(products: ProductWithInventory[], options?: BulkCreateProductsWithInventoryOptions | undefined): Promise<BulkCreateProductsWithInventoryResponse & BulkCreateProductsWithInventoryResponseNonNullableFields>;
|
|
16608
|
+
}
|
|
16609
|
+
declare function bulkUpdateProducts$1(httpClient: HttpClient): BulkUpdateProductsSignature;
|
|
16610
|
+
interface BulkUpdateProductsSignature {
|
|
16611
|
+
/**
|
|
16612
|
+
* Updates up to 100 products.
|
|
16613
|
+
*
|
|
16614
|
+
* >**Note:**
|
|
16615
|
+
* > The following limits apply to the total number of updatable entities in a single request.
|
|
16616
|
+
* > For example, you can update 10 products with up to 10 options for each product (10 x 10 = 100), or one product with 100 options.
|
|
16617
|
+
* > Alternatively, you can update 100 products with up to 10 variants in each (100 x 10 = 1000), or one product with 1000 variants.
|
|
16618
|
+
* > + `options`: 100
|
|
16619
|
+
* > + `modifiers`: 100
|
|
16620
|
+
* > + `infoSections`: 100
|
|
16621
|
+
* > + `variantsInfo.variants`: 1000
|
|
16622
|
+
* @param - List of products to update.
|
|
16623
|
+
*/
|
|
16624
|
+
(products: V3MaskedProduct[], options?: BulkUpdateProductsOptions | undefined): Promise<BulkUpdateProductsResponse & BulkUpdateProductsResponseNonNullableFields>;
|
|
16625
|
+
}
|
|
16626
|
+
declare function bulkUpdateProductsWithInventory$1(httpClient: HttpClient): BulkUpdateProductsWithInventorySignature;
|
|
16627
|
+
interface BulkUpdateProductsWithInventorySignature {
|
|
16628
|
+
/**
|
|
16629
|
+
* Updates up to 100 products, and can update the products' inventories in the variants' default locations.
|
|
16630
|
+
*
|
|
16631
|
+
* >**Note:**
|
|
16632
|
+
* > The following limits apply to the total number of updatable entities in a single request.
|
|
16633
|
+
* > For example, you can update 10 products with up to 10 options for each product (10 x 10 = 100), or one product with 100 options.
|
|
16634
|
+
* > Alternatively, you can update 100 products with up to 10 variants in each (100 x 10 = 1000), or one product with 1000 variants.
|
|
16635
|
+
* > + `options`: 100
|
|
16636
|
+
* > + `modifiers`: 100
|
|
16637
|
+
* > + `infoSections`: 100
|
|
16638
|
+
* > + `variantsInfo.variants`: 1000
|
|
16639
|
+
* @param - List of products to update.
|
|
16640
|
+
*/
|
|
16641
|
+
(products: MaskedProductWithInventory[], options?: BulkUpdateProductsWithInventoryOptions | undefined): Promise<BulkUpdateProductsWithInventoryResponse & BulkUpdateProductsWithInventoryResponseNonNullableFields>;
|
|
16642
|
+
}
|
|
16643
|
+
declare function bulkUpdateProductsByFilter$1(httpClient: HttpClient): BulkUpdateProductsByFilterSignature;
|
|
16644
|
+
interface BulkUpdateProductsByFilterSignature {
|
|
16645
|
+
/**
|
|
16646
|
+
* Updates multiple products, given the provided filter.
|
|
16647
|
+
*
|
|
16648
|
+
* To update `infoSections`, `brand` or `ribbon` fields, you must also pass their existing `id`.
|
|
16649
|
+
*
|
|
16650
|
+
* > **Note:**
|
|
16651
|
+
* > The following fields cannot be updated with this endpoint:
|
|
16652
|
+
* > + `slug`
|
|
16653
|
+
* > + `options`
|
|
16654
|
+
* > + `modifiers`
|
|
16655
|
+
* > + `variantsInfo`
|
|
16656
|
+
* >
|
|
16657
|
+
* > To update these fields, use [Bulk Update Products](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-update-products).
|
|
16658
|
+
*/
|
|
16659
|
+
(options?: BulkUpdateProductsByFilterOptions | undefined): Promise<V3BulkUpdateProductsByFilterResponse & V3BulkUpdateProductsByFilterResponseNonNullableFields>;
|
|
16660
|
+
}
|
|
16661
|
+
declare function updateExtendedFields$1(httpClient: HttpClient): UpdateExtendedFieldsSignature;
|
|
16662
|
+
interface UpdateExtendedFieldsSignature {
|
|
16663
|
+
/**
|
|
16664
|
+
* Updates a product's extended fields.
|
|
16665
|
+
*
|
|
16666
|
+
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must first be configured in the Wix Developers Center.
|
|
16667
|
+
* @param - Product ID.
|
|
16668
|
+
* @param - App namespace.
|
|
16669
|
+
*/
|
|
16670
|
+
(productId: string, namespace: string, options?: UpdateExtendedFieldsOptions | undefined): Promise<V3UpdateExtendedFieldsResponse & V3UpdateExtendedFieldsResponseNonNullableFields>;
|
|
16671
|
+
}
|
|
16672
|
+
declare function deleteProduct$1(httpClient: HttpClient): DeleteProductSignature;
|
|
16673
|
+
interface DeleteProductSignature {
|
|
16674
|
+
/**
|
|
16675
|
+
* Deletes a product and all its variants.
|
|
16676
|
+
* @param - Product ID.
|
|
16677
|
+
*/
|
|
16678
|
+
(productId: string): Promise<void>;
|
|
16679
|
+
}
|
|
16680
|
+
declare function bulkDeleteProducts$1(httpClient: HttpClient): BulkDeleteProductsSignature;
|
|
16681
|
+
interface BulkDeleteProductsSignature {
|
|
16682
|
+
/**
|
|
16683
|
+
* Deletes multiple products.
|
|
16684
|
+
* @param - IDs of products to delete.
|
|
16685
|
+
*/
|
|
16686
|
+
(productIds: string[]): Promise<V3BulkDeleteProductsResponse & V3BulkDeleteProductsResponseNonNullableFields>;
|
|
16687
|
+
}
|
|
16688
|
+
declare function bulkDeleteProductsByFilter$1(httpClient: HttpClient): BulkDeleteProductsByFilterSignature;
|
|
16689
|
+
interface BulkDeleteProductsByFilterSignature {
|
|
16690
|
+
/**
|
|
16691
|
+
* Delete multiple products, given the provided filter.
|
|
16692
|
+
* @param - Filter object.
|
|
16693
|
+
*/
|
|
16694
|
+
(filter: Record<string, any> | null, options?: BulkDeleteProductsByFilterOptions | undefined): Promise<V3BulkDeleteProductsByFilterResponse & V3BulkDeleteProductsByFilterResponseNonNullableFields>;
|
|
16695
|
+
}
|
|
16696
|
+
declare function getProduct$1(httpClient: HttpClient): GetProductSignature;
|
|
16697
|
+
interface GetProductSignature {
|
|
16698
|
+
/**
|
|
16699
|
+
* Retrieves a product.
|
|
16700
|
+
*
|
|
16701
|
+
* > **Note:**
|
|
16702
|
+
* > To retrieve a non-visible product (`visible: false`), your app must have the required `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope.
|
|
16703
|
+
* @param - Product ID.
|
|
16704
|
+
* @returns Product.
|
|
16705
|
+
*/
|
|
16706
|
+
(productId: string, options?: GetProductOptions | undefined): Promise<V3Product & V3ProductNonNullableFields>;
|
|
16707
|
+
}
|
|
16708
|
+
declare function getProductBySlug$1(httpClient: HttpClient): GetProductBySlugSignature;
|
|
16709
|
+
interface GetProductBySlugSignature {
|
|
16710
|
+
/**
|
|
16711
|
+
* Retrieves a product by slug.
|
|
16712
|
+
*
|
|
16713
|
+
* > **Note:**
|
|
16714
|
+
* > To retrieve a non-visible product (`visible: false`), your app must have the required `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope.
|
|
16715
|
+
* @param - Product slug.
|
|
16716
|
+
*/
|
|
16717
|
+
(slug: string, options?: GetProductBySlugOptions | undefined): Promise<V3GetProductBySlugResponse & V3GetProductBySlugResponseNonNullableFields>;
|
|
16718
|
+
}
|
|
16719
|
+
declare function searchProducts$1(httpClient: HttpClient): SearchProductsSignature;
|
|
16720
|
+
interface SearchProductsSignature {
|
|
16721
|
+
/**
|
|
16722
|
+
* Retrieves a list of up to 100 products, given the provided filtering, search expression, sorting, and cursor paging.
|
|
16723
|
+
* Pass supported values to the `fields` array in the request to include those fields in the response.
|
|
16724
|
+
*
|
|
16725
|
+
*
|
|
16726
|
+
* To learn about working with _Search_ endpoints, see
|
|
16727
|
+
* [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),
|
|
16728
|
+
* and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
16729
|
+
*
|
|
16730
|
+
* > **Note:** To retrieve a non-visible product (`visible: false`), your app must have the required `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope.
|
|
16731
|
+
*/
|
|
16732
|
+
(options?: SearchProductsOptions | undefined): Promise<V3SearchProductsResponse & V3SearchProductsResponseNonNullableFields>;
|
|
16733
|
+
}
|
|
16734
|
+
declare function queryProducts$1(httpClient: HttpClient): QueryProductsSignature;
|
|
16735
|
+
interface QueryProductsSignature {
|
|
16736
|
+
/**
|
|
16737
|
+
* Retrieves a list of up to 100 products, given the provided filtering, sorting, and cursor paging.
|
|
16738
|
+
* Pass supported values to the `fields` array in the request to include those fields in the response.
|
|
16739
|
+
*
|
|
16740
|
+
*
|
|
16741
|
+
* To learn about working with _Query_ endpoints, see
|
|
16742
|
+
* [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),
|
|
16743
|
+
* and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
16744
|
+
*
|
|
16745
|
+
* > **Note:** To retrieve a non-visible product (`visible: false`), your app must have the required `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope.
|
|
16746
|
+
*/
|
|
16747
|
+
(options?: QueryProductsOptions | undefined): ProductsQueryBuilder;
|
|
16748
|
+
}
|
|
16749
|
+
declare function countProducts$1(httpClient: HttpClient): CountProductsSignature;
|
|
16750
|
+
interface CountProductsSignature {
|
|
16751
|
+
/**
|
|
16752
|
+
* Counts the number of products that match the provided filtering.
|
|
16753
|
+
*/
|
|
16754
|
+
(options?: CountProductsOptions | undefined): Promise<V3CountProductsResponse & V3CountProductsResponseNonNullableFields>;
|
|
16755
|
+
}
|
|
16756
|
+
declare function bulkUpdateProductVariantsByFilter$1(httpClient: HttpClient): BulkUpdateProductVariantsByFilterSignature;
|
|
16757
|
+
interface BulkUpdateProductVariantsByFilterSignature {
|
|
16758
|
+
/**
|
|
16759
|
+
* Updates a variant of multiple products, given the provided filter and search expression.
|
|
16760
|
+
*
|
|
16761
|
+
*
|
|
16762
|
+
* Only the following variant fields can be updated:
|
|
16763
|
+
* + `visible`
|
|
16764
|
+
* + `price`
|
|
16765
|
+
* + `revenueDetails.cost`
|
|
16766
|
+
* + `physicalOptions`
|
|
16767
|
+
* @param - Filter object.
|
|
16768
|
+
*/
|
|
16769
|
+
(filter: Record<string, any> | null, options?: BulkUpdateProductVariantsByFilterOptions | undefined): Promise<BulkUpdateProductVariantsByFilterResponse & BulkUpdateProductVariantsByFilterResponseNonNullableFields>;
|
|
16770
|
+
}
|
|
16771
|
+
declare function bulkAdjustProductVariantsByFilter$1(httpClient: HttpClient): BulkAdjustProductVariantsByFilterSignature;
|
|
16772
|
+
interface BulkAdjustProductVariantsByFilterSignature {
|
|
16773
|
+
/**
|
|
16774
|
+
* Adjusts the price and cost of multiple variants, given the provided filter and search expression.
|
|
16775
|
+
*
|
|
16776
|
+
*
|
|
16777
|
+
* Only the following variant fields can be increased/decreased by amount or percentage:
|
|
16778
|
+
* + `basePrice`
|
|
16779
|
+
* + `salePrice`
|
|
16780
|
+
* + `cost`
|
|
16781
|
+
* + `salePriceFromBasePrice`
|
|
16782
|
+
* @param - Filter object.
|
|
16783
|
+
*/
|
|
16784
|
+
(filter: Record<string, any> | null, options?: BulkAdjustProductVariantsByFilterOptions | undefined): Promise<BulkAdjustProductVariantsByFilterResponse & BulkAdjustProductVariantsByFilterResponseNonNullableFields>;
|
|
16785
|
+
}
|
|
16786
|
+
declare function bulkAddInfoSectionsToProductsByFilter$1(httpClient: HttpClient): BulkAddInfoSectionsToProductsByFilterSignature;
|
|
16787
|
+
interface BulkAddInfoSectionsToProductsByFilterSignature {
|
|
16788
|
+
/**
|
|
16789
|
+
* Adds info sections to multiple products, given the provided filter and search expression.
|
|
16790
|
+
* @param - Filter object.
|
|
16791
|
+
*/
|
|
16792
|
+
(filter: Record<string, any> | null, options?: BulkAddInfoSectionsToProductsByFilterOptions | undefined): Promise<V3BulkAddInfoSectionsToProductsByFilterResponse & V3BulkAddInfoSectionsToProductsByFilterResponseNonNullableFields>;
|
|
16793
|
+
}
|
|
16794
|
+
declare function bulkAddInfoSectionsToProducts$1(httpClient: HttpClient): BulkAddInfoSectionsToProductsSignature;
|
|
16795
|
+
interface BulkAddInfoSectionsToProductsSignature {
|
|
16796
|
+
/**
|
|
16797
|
+
* Adds info sections to multiple products.
|
|
16798
|
+
* @param - List of product IDs and revisions.
|
|
16799
|
+
*/
|
|
16800
|
+
(products: V3ProductIdWithRevision[], options?: BulkAddInfoSectionsToProductsOptions | undefined): Promise<V3BulkAddInfoSectionsToProductsResponse & V3BulkAddInfoSectionsToProductsResponseNonNullableFields>;
|
|
16801
|
+
}
|
|
16802
|
+
declare function bulkRemoveInfoSectionsFromProductsByFilter$1(httpClient: HttpClient): BulkRemoveInfoSectionsFromProductsByFilterSignature;
|
|
16803
|
+
interface BulkRemoveInfoSectionsFromProductsByFilterSignature {
|
|
16804
|
+
/**
|
|
16805
|
+
* Removes info sections from multiple products, given the provided filter and search expression.
|
|
16806
|
+
* @param - Filter object.
|
|
16807
|
+
*/
|
|
16808
|
+
(filter: Record<string, any> | null, options?: BulkRemoveInfoSectionsFromProductsByFilterOptions | undefined): Promise<V3BulkRemoveInfoSectionsFromProductsByFilterResponse & V3BulkRemoveInfoSectionsFromProductsByFilterResponseNonNullableFields>;
|
|
16809
|
+
}
|
|
16810
|
+
declare function bulkRemoveInfoSectionsFromProducts$1(httpClient: HttpClient): BulkRemoveInfoSectionsFromProductsSignature;
|
|
16811
|
+
interface BulkRemoveInfoSectionsFromProductsSignature {
|
|
16812
|
+
/**
|
|
16813
|
+
* Removes info sections from multiple products.
|
|
16814
|
+
* @param - List of product IDs and revisions.
|
|
16815
|
+
*/
|
|
16816
|
+
(products: V3ProductIdWithRevision[], options?: BulkRemoveInfoSectionsFromProductsOptions | undefined): Promise<V3BulkRemoveInfoSectionsFromProductsResponse & V3BulkRemoveInfoSectionsFromProductsResponseNonNullableFields>;
|
|
16817
|
+
}
|
|
16818
|
+
declare function bulkAddProductsToCategoriesByFilter$1(httpClient: HttpClient): BulkAddProductsToCategoriesByFilterSignature;
|
|
16819
|
+
interface BulkAddProductsToCategoriesByFilterSignature {
|
|
16820
|
+
/**
|
|
16821
|
+
* Adds multiple products, given the provided filter and search expression, to up to 5 categories.
|
|
16822
|
+
*
|
|
16823
|
+
* Learn more about the [Categories API](https://dev.wix.com/docs/rest/business-management/categories/introduction).
|
|
16824
|
+
*/
|
|
16825
|
+
(options?: BulkAddProductsToCategoriesByFilterOptions | undefined): Promise<BulkAddProductsToCategoriesByFilterResponse & BulkAddProductsToCategoriesByFilterResponseNonNullableFields>;
|
|
16826
|
+
}
|
|
16827
|
+
declare function bulkRemoveProductsFromCategoriesByFilter$1(httpClient: HttpClient): BulkRemoveProductsFromCategoriesByFilterSignature;
|
|
16828
|
+
interface BulkRemoveProductsFromCategoriesByFilterSignature {
|
|
16829
|
+
/**
|
|
16830
|
+
* Removes multiple products, given the provided filter and search expression, from up to 5 categories.
|
|
16831
|
+
*
|
|
16832
|
+
* Learn more about the [Categories API](https://dev.wix.com/docs/rest/business-management/categories/introduction).
|
|
16833
|
+
*/
|
|
16834
|
+
(options?: BulkRemoveProductsFromCategoriesByFilterOptions | undefined): Promise<BulkRemoveProductsFromCategoriesByFilterResponse & BulkRemoveProductsFromCategoriesByFilterResponseNonNullableFields>;
|
|
16835
|
+
}
|
|
15824
16836
|
declare const onProductCreated$1: EventDefinition<ProductCreatedEnvelope, "wix.stores.catalog.v3.product_created">;
|
|
15825
16837
|
declare const onProductUpdated$1: EventDefinition<ProductUpdatedEnvelope, "wix.stores.catalog.v3.product_updated">;
|
|
15826
16838
|
declare const onProductDeleted$1: EventDefinition<ProductDeletedEnvelope, "wix.stores.catalog.v3.product_deleted">;
|
|
@@ -15883,12 +16895,15 @@ type _publicBulkRemoveProductsFromCategoriesByFilterType = typeof bulkRemoveProd
|
|
|
15883
16895
|
declare const bulkRemoveProductsFromCategoriesByFilter: ReturnType<typeof createRESTModule$5<_publicBulkRemoveProductsFromCategoriesByFilterType>>;
|
|
15884
16896
|
|
|
15885
16897
|
type _publicOnProductCreatedType = typeof onProductCreated$1;
|
|
16898
|
+
/** */
|
|
15886
16899
|
declare const onProductCreated: ReturnType<typeof createEventModule$2<_publicOnProductCreatedType>>;
|
|
15887
16900
|
|
|
15888
16901
|
type _publicOnProductUpdatedType = typeof onProductUpdated$1;
|
|
16902
|
+
/** */
|
|
15889
16903
|
declare const onProductUpdated: ReturnType<typeof createEventModule$2<_publicOnProductUpdatedType>>;
|
|
15890
16904
|
|
|
15891
16905
|
type _publicOnProductDeletedType = typeof onProductDeleted$1;
|
|
16906
|
+
/** */
|
|
15892
16907
|
declare const onProductDeleted: ReturnType<typeof createEventModule$2<_publicOnProductDeletedType>>;
|
|
15893
16908
|
|
|
15894
16909
|
type context$5_AdjustValue = AdjustValue;
|
|
@@ -16924,7 +17939,13 @@ interface GetCatalogVersionResponseNonNullableFields {
|
|
|
16924
17939
|
catalogVersion: Version;
|
|
16925
17940
|
}
|
|
16926
17941
|
|
|
16927
|
-
declare function getCatalogVersion$1(httpClient: HttpClient):
|
|
17942
|
+
declare function getCatalogVersion$1(httpClient: HttpClient): GetCatalogVersionSignature;
|
|
17943
|
+
interface GetCatalogVersionSignature {
|
|
17944
|
+
/**
|
|
17945
|
+
* Retrieves the version of Stores Catalog installed on a site.
|
|
17946
|
+
*/
|
|
17947
|
+
(): Promise<GetCatalogVersionResponse & GetCatalogVersionResponseNonNullableFields>;
|
|
17948
|
+
}
|
|
16928
17949
|
|
|
16929
17950
|
declare function createRESTModule$4<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
16930
17951
|
|
|
@@ -17713,16 +18734,116 @@ interface BulkGetOrCreateRibbonsOptions {
|
|
|
17713
18734
|
fields?: RequestedFields[];
|
|
17714
18735
|
}
|
|
17715
18736
|
|
|
17716
|
-
declare function createRibbon$1(httpClient: HttpClient):
|
|
17717
|
-
|
|
17718
|
-
|
|
17719
|
-
|
|
17720
|
-
|
|
17721
|
-
|
|
17722
|
-
|
|
17723
|
-
|
|
17724
|
-
|
|
17725
|
-
|
|
18737
|
+
declare function createRibbon$1(httpClient: HttpClient): CreateRibbonSignature;
|
|
18738
|
+
interface CreateRibbonSignature {
|
|
18739
|
+
/**
|
|
18740
|
+
* Creates a ribbon.
|
|
18741
|
+
*
|
|
18742
|
+
* To assign the ribbon to a product, include the `ribbon.id` or `ribbon.name` when [creating](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/create-product) or [updating](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/update-product) a product.
|
|
18743
|
+
* @param - Ribbon to create.
|
|
18744
|
+
* @returns Created ribbon.
|
|
18745
|
+
*/
|
|
18746
|
+
(ribbon: Ribbon): Promise<Ribbon & RibbonNonNullableFields>;
|
|
18747
|
+
}
|
|
18748
|
+
declare function getRibbon$1(httpClient: HttpClient): GetRibbonSignature;
|
|
18749
|
+
interface GetRibbonSignature {
|
|
18750
|
+
/**
|
|
18751
|
+
* Retrieves a ribbon.
|
|
18752
|
+
* @param - Ribbon ID.
|
|
18753
|
+
* @returns Ribbon.
|
|
18754
|
+
*/
|
|
18755
|
+
(ribbonId: string, options?: GetRibbonOptions | undefined): Promise<Ribbon & RibbonNonNullableFields>;
|
|
18756
|
+
}
|
|
18757
|
+
declare function updateRibbon$1(httpClient: HttpClient): UpdateRibbonSignature;
|
|
18758
|
+
interface UpdateRibbonSignature {
|
|
18759
|
+
/**
|
|
18760
|
+
* Updates a ribbon.
|
|
18761
|
+
*
|
|
18762
|
+
*
|
|
18763
|
+
* Each time the ribbon is updated, `revision` increments by 1.
|
|
18764
|
+
* The current `revision` must be passed when updating the ribbon.
|
|
18765
|
+
* This ensures you're working with the latest ribbon and prevents unintended overwrites.
|
|
18766
|
+
* @param - Ribbon ID.
|
|
18767
|
+
* @returns Updated Ribbon.
|
|
18768
|
+
*/
|
|
18769
|
+
(_id: string | null, ribbon: UpdateRibbon, options?: UpdateRibbonOptions | undefined): Promise<Ribbon & RibbonNonNullableFields>;
|
|
18770
|
+
}
|
|
18771
|
+
declare function deleteRibbon$1(httpClient: HttpClient): DeleteRibbonSignature;
|
|
18772
|
+
interface DeleteRibbonSignature {
|
|
18773
|
+
/**
|
|
18774
|
+
* Deletes a ribbon.
|
|
18775
|
+
*
|
|
18776
|
+
*
|
|
18777
|
+
* > **Note:** Deleting a ribbon will also remove it from all products it is assigned to.
|
|
18778
|
+
* @param - Ribbon ID.
|
|
18779
|
+
*/
|
|
18780
|
+
(ribbonId: string): Promise<void>;
|
|
18781
|
+
}
|
|
18782
|
+
declare function queryRibbons$1(httpClient: HttpClient): QueryRibbonsSignature;
|
|
18783
|
+
interface QueryRibbonsSignature {
|
|
18784
|
+
/**
|
|
18785
|
+
* Retrieves a list of up to 100 ribbons, given the provided filtering, sorting, and cursor paging.
|
|
18786
|
+
* Pass supported values to the `fields` array in the request to include those fields in the response.
|
|
18787
|
+
*
|
|
18788
|
+
*
|
|
18789
|
+
* Query Brands runs with these defaults, which you can override:
|
|
18790
|
+
*
|
|
18791
|
+
* - `createdDate` is sorted in `DESC` order
|
|
18792
|
+
* - `cursorPaging.limit` is `100`
|
|
18793
|
+
*
|
|
18794
|
+
* For field support for filters and sorting,
|
|
18795
|
+
* see [Ribbons: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/ribbons-v3/supported-filters-and-sorting).
|
|
18796
|
+
*
|
|
18797
|
+
* To learn about working with _Query_ endpoints, see
|
|
18798
|
+
* [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),
|
|
18799
|
+
* and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
18800
|
+
*/
|
|
18801
|
+
(options?: QueryRibbonsOptions | undefined): RibbonsQueryBuilder;
|
|
18802
|
+
}
|
|
18803
|
+
declare function bulkCreateRibbons$1(httpClient: HttpClient): BulkCreateRibbonsSignature;
|
|
18804
|
+
interface BulkCreateRibbonsSignature {
|
|
18805
|
+
/**
|
|
18806
|
+
* Creates multiple ribbons.
|
|
18807
|
+
* @param - Ribbons to create.
|
|
18808
|
+
*/
|
|
18809
|
+
(ribbons: Ribbon[], options?: BulkCreateRibbonsOptions | undefined): Promise<BulkCreateRibbonsResponse & BulkCreateRibbonsResponseNonNullableFields>;
|
|
18810
|
+
}
|
|
18811
|
+
declare function bulkUpdateRibbons$1(httpClient: HttpClient): BulkUpdateRibbonsSignature;
|
|
18812
|
+
interface BulkUpdateRibbonsSignature {
|
|
18813
|
+
/**
|
|
18814
|
+
* Updates multiple ribbons.
|
|
18815
|
+
*
|
|
18816
|
+
* Each time a ribbon is updated, `revision` increments by 1.
|
|
18817
|
+
* The current `revision` must be passed when updating a ribbon.
|
|
18818
|
+
* This ensures you're working with the latest ribbon and prevents unintended overwrites.
|
|
18819
|
+
* @param - List of ribbons to update.
|
|
18820
|
+
*/
|
|
18821
|
+
(ribbons: MaskedRibbon[], options?: BulkUpdateRibbonsOptions | undefined): Promise<BulkUpdateRibbonsResponse & BulkUpdateRibbonsResponseNonNullableFields>;
|
|
18822
|
+
}
|
|
18823
|
+
declare function getOrCreateRibbon$1(httpClient: HttpClient): GetOrCreateRibbonSignature;
|
|
18824
|
+
interface GetOrCreateRibbonSignature {
|
|
18825
|
+
/**
|
|
18826
|
+
* Retrieves a ribbon by name, or creates a ribbon if one with the passed `ribbonName` doesn't exist.
|
|
18827
|
+
* @param - Ribbon name to retrieve or create.
|
|
18828
|
+
*/
|
|
18829
|
+
(ribbonName: string, options?: GetOrCreateRibbonOptions | undefined): Promise<GetOrCreateRibbonResponse & GetOrCreateRibbonResponseNonNullableFields>;
|
|
18830
|
+
}
|
|
18831
|
+
declare function bulkGetOrCreateRibbons$1(httpClient: HttpClient): BulkGetOrCreateRibbonsSignature;
|
|
18832
|
+
interface BulkGetOrCreateRibbonsSignature {
|
|
18833
|
+
/**
|
|
18834
|
+
* Retrieves multiple ribbons by name, or creates multiple ribbons if those with the passed `ribbonNames` don't exist.
|
|
18835
|
+
* @param - Ribbon names to retrieve or create.
|
|
18836
|
+
*/
|
|
18837
|
+
(ribbonNames: string[], options?: BulkGetOrCreateRibbonsOptions | undefined): Promise<BulkGetOrCreateRibbonsResponse & BulkGetOrCreateRibbonsResponseNonNullableFields>;
|
|
18838
|
+
}
|
|
18839
|
+
declare function bulkDeleteRibbons$1(httpClient: HttpClient): BulkDeleteRibbonsSignature;
|
|
18840
|
+
interface BulkDeleteRibbonsSignature {
|
|
18841
|
+
/**
|
|
18842
|
+
* Deletes multiple ribbons.
|
|
18843
|
+
* @param - IDs of ribbons to delete.
|
|
18844
|
+
*/
|
|
18845
|
+
(ribbonIds: string[]): Promise<BulkDeleteRibbonsResponse & BulkDeleteRibbonsResponseNonNullableFields>;
|
|
18846
|
+
}
|
|
17726
18847
|
declare const onRibbonCreated$1: EventDefinition<RibbonCreatedEnvelope, "wix.stores.catalog.v3.ribbon_created">;
|
|
17727
18848
|
declare const onRibbonUpdated$1: EventDefinition<RibbonUpdatedEnvelope, "wix.stores.catalog.v3.ribbon_updated">;
|
|
17728
18849
|
declare const onRibbonDeleted$1: EventDefinition<RibbonDeletedEnvelope, "wix.stores.catalog.v3.ribbon_deleted">;
|
|
@@ -17753,12 +18874,15 @@ type _publicBulkDeleteRibbonsType = typeof bulkDeleteRibbons$1;
|
|
|
17753
18874
|
declare const bulkDeleteRibbons: ReturnType<typeof createRESTModule$3<_publicBulkDeleteRibbonsType>>;
|
|
17754
18875
|
|
|
17755
18876
|
type _publicOnRibbonCreatedType = typeof onRibbonCreated$1;
|
|
18877
|
+
/** */
|
|
17756
18878
|
declare const onRibbonCreated: ReturnType<typeof createEventModule$1<_publicOnRibbonCreatedType>>;
|
|
17757
18879
|
|
|
17758
18880
|
type _publicOnRibbonUpdatedType = typeof onRibbonUpdated$1;
|
|
18881
|
+
/** */
|
|
17759
18882
|
declare const onRibbonUpdated: ReturnType<typeof createEventModule$1<_publicOnRibbonUpdatedType>>;
|
|
17760
18883
|
|
|
17761
18884
|
type _publicOnRibbonDeletedType = typeof onRibbonDeleted$1;
|
|
18885
|
+
/** */
|
|
17762
18886
|
declare const onRibbonDeleted: ReturnType<typeof createEventModule$1<_publicOnRibbonDeletedType>>;
|
|
17763
18887
|
|
|
17764
18888
|
type context$3_ApplicationError = ApplicationError;
|
|
@@ -18266,8 +19390,36 @@ interface StoresLocationsQueryBuilder {
|
|
|
18266
19390
|
find: () => Promise<StoresLocationsQueryResult>;
|
|
18267
19391
|
}
|
|
18268
19392
|
|
|
18269
|
-
declare function getStoresLocation$1(httpClient: HttpClient):
|
|
18270
|
-
|
|
19393
|
+
declare function getStoresLocation$1(httpClient: HttpClient): GetStoresLocationSignature;
|
|
19394
|
+
interface GetStoresLocationSignature {
|
|
19395
|
+
/**
|
|
19396
|
+
* Retrieves a Stores location.
|
|
19397
|
+
* @param - Stores location ID.
|
|
19398
|
+
* @returns Stores location.
|
|
19399
|
+
*/
|
|
19400
|
+
(storesLocationId: string): Promise<StoresLocation & StoresLocationNonNullableFields>;
|
|
19401
|
+
}
|
|
19402
|
+
declare function queryStoresLocations$1(httpClient: HttpClient): QueryStoresLocationsSignature;
|
|
19403
|
+
interface QueryStoresLocationsSignature {
|
|
19404
|
+
/**
|
|
19405
|
+
* Retrieves a list of up to 100 Stores locations, given the provided filtering, sorting, and cursor paging.
|
|
19406
|
+
* Pass supported values to the `fields` array in the request to include those fields in the response.
|
|
19407
|
+
*
|
|
19408
|
+
*
|
|
19409
|
+
* Query Stores Locations runs with these defaults, which you can override:
|
|
19410
|
+
*
|
|
19411
|
+
* - `createdDate` is sorted in `DESC` order
|
|
19412
|
+
* - `cursorPaging.limit` is `100`
|
|
19413
|
+
*
|
|
19414
|
+
* For field support for filters and sorting,
|
|
19415
|
+
* see [Stores Locations: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/stores-locations-v3/supported-filters-and-sorting).
|
|
19416
|
+
*
|
|
19417
|
+
* To learn about working with _Query_ endpoints, see
|
|
19418
|
+
* [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),
|
|
19419
|
+
* and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
19420
|
+
*/
|
|
19421
|
+
(): StoresLocationsQueryBuilder;
|
|
19422
|
+
}
|
|
18271
19423
|
|
|
18272
19424
|
declare function createRESTModule$2<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
18273
19425
|
|
|
@@ -18670,18 +19822,201 @@ interface GetProductIdsForSubscriptionOptionOptions {
|
|
|
18670
19822
|
paging?: Paging$1;
|
|
18671
19823
|
}
|
|
18672
19824
|
|
|
18673
|
-
declare function createSubscriptionOption$1(httpClient: HttpClient):
|
|
18674
|
-
|
|
18675
|
-
|
|
18676
|
-
|
|
18677
|
-
|
|
18678
|
-
|
|
18679
|
-
|
|
18680
|
-
|
|
18681
|
-
|
|
18682
|
-
|
|
18683
|
-
|
|
18684
|
-
|
|
19825
|
+
declare function createSubscriptionOption$1(httpClient: HttpClient): CreateSubscriptionOptionSignature;
|
|
19826
|
+
interface CreateSubscriptionOptionSignature {
|
|
19827
|
+
/**
|
|
19828
|
+
* Creates a subscription option.
|
|
19829
|
+
* To assign to a product, call [`assignSubscriptionOptionsToProduct()`](https://www.wix.com/velo/reference/wix-stores-v2/subscriptionoptions/assign-subscription-options-to-product).
|
|
19830
|
+
* Subscription options that are not assigned to a product will not be visible in the Wix business manager.
|
|
19831
|
+
* @param - Subscription option info.
|
|
19832
|
+
* @returns Newly created subscription option.
|
|
19833
|
+
* @deprecated
|
|
19834
|
+
*/
|
|
19835
|
+
(subscriptionOption: SubscriptionOption): Promise<SubscriptionOption & SubscriptionOptionNonNullableFields>;
|
|
19836
|
+
}
|
|
19837
|
+
declare function updateSubscriptionOption$1(httpClient: HttpClient): UpdateSubscriptionOptionSignature;
|
|
19838
|
+
interface UpdateSubscriptionOptionSignature {
|
|
19839
|
+
/**
|
|
19840
|
+
* Updates a subscription option.
|
|
19841
|
+
* Only parameters passed will be updated.
|
|
19842
|
+
* <blockquote class='warning'>
|
|
19843
|
+
*
|
|
19844
|
+
* __Deprecation Notice:__
|
|
19845
|
+
*
|
|
19846
|
+
* This endpoint has been deprecated and will be removed on January 29, 2024.
|
|
19847
|
+
*
|
|
19848
|
+
* </blockquote>
|
|
19849
|
+
* @param - Subscription option ID (auto-generated upon subscription option creation).
|
|
19850
|
+
* @param - Subscription option update options.
|
|
19851
|
+
* @returns Updated subscription option.
|
|
19852
|
+
* @deprecated
|
|
19853
|
+
*/
|
|
19854
|
+
(_id: string | null, subscriptionOption: UpdateSubscriptionOption): Promise<SubscriptionOption & SubscriptionOptionNonNullableFields>;
|
|
19855
|
+
}
|
|
19856
|
+
declare function deleteSubscriptionOption$1(httpClient: HttpClient): DeleteSubscriptionOptionSignature;
|
|
19857
|
+
interface DeleteSubscriptionOptionSignature {
|
|
19858
|
+
/**
|
|
19859
|
+
* Deletes a subscription option.
|
|
19860
|
+
* <blockquote class='warning'>
|
|
19861
|
+
*
|
|
19862
|
+
* __Deprecation Notice:__
|
|
19863
|
+
*
|
|
19864
|
+
* This endpoint has been deprecated and will be removed on January 29, 2024.
|
|
19865
|
+
*
|
|
19866
|
+
* </blockquote>
|
|
19867
|
+
* @param - ID of the subscription option to delete.
|
|
19868
|
+
* @deprecated
|
|
19869
|
+
*/
|
|
19870
|
+
(_id: string): Promise<void>;
|
|
19871
|
+
}
|
|
19872
|
+
declare function bulkCreateSubscriptionOptions$1(httpClient: HttpClient): BulkCreateSubscriptionOptionsSignature;
|
|
19873
|
+
interface BulkCreateSubscriptionOptionsSignature {
|
|
19874
|
+
/**
|
|
19875
|
+
* Creates multiple subscription options (up to 100).
|
|
19876
|
+
* To assign to a product, call [`assignSubscriptionOptionsToProduct()`](https://www.wix.com/velo/reference/wix-stores-v2/subscriptionoptions/assign-subscription-options-to-product).
|
|
19877
|
+
* Subscription options that are not assigned to a product will not be visible in the Wix business manager.
|
|
19878
|
+
* @param - Subscription options info.
|
|
19879
|
+
* @deprecated
|
|
19880
|
+
*/
|
|
19881
|
+
(subscriptionOptions: SubscriptionOption[]): Promise<BulkCreateSubscriptionOptionsResponse & BulkCreateSubscriptionOptionsResponseNonNullableFields>;
|
|
19882
|
+
}
|
|
19883
|
+
declare function bulkUpdateSubscriptionOptions$1(httpClient: HttpClient): BulkUpdateSubscriptionOptionsSignature;
|
|
19884
|
+
interface BulkUpdateSubscriptionOptionsSignature {
|
|
19885
|
+
/**
|
|
19886
|
+
* Updates multiple subscription options.
|
|
19887
|
+
* Only parameters passed will be updated.
|
|
19888
|
+
* <blockquote class='warning'>
|
|
19889
|
+
*
|
|
19890
|
+
* __Deprecation Notice:__
|
|
19891
|
+
*
|
|
19892
|
+
* This endpoint has been deprecated and will be removed on January 29, 2024.
|
|
19893
|
+
*
|
|
19894
|
+
* </blockquote>
|
|
19895
|
+
* @param - Subscription options info. Only the passed parameters in each subscription option will be updated.
|
|
19896
|
+
* @deprecated
|
|
19897
|
+
*/
|
|
19898
|
+
(subscriptionOptions: SubscriptionOption[]): Promise<BulkUpdateSubscriptionOptionsResponse & BulkUpdateSubscriptionOptionsResponseNonNullableFields>;
|
|
19899
|
+
}
|
|
19900
|
+
declare function bulkDeleteSubscriptionOptions$1(httpClient: HttpClient): BulkDeleteSubscriptionOptionsSignature;
|
|
19901
|
+
interface BulkDeleteSubscriptionOptionsSignature {
|
|
19902
|
+
/**
|
|
19903
|
+
* Deletes multiple subscription options.
|
|
19904
|
+
* <blockquote class='warning'>
|
|
19905
|
+
*
|
|
19906
|
+
* __Deprecation Notice:__
|
|
19907
|
+
*
|
|
19908
|
+
* This endpoint has been deprecated and will be removed on January 29, 2024.
|
|
19909
|
+
*
|
|
19910
|
+
* </blockquote>
|
|
19911
|
+
* @param - IDs of the subscription options to delete.
|
|
19912
|
+
* @deprecated
|
|
19913
|
+
*/
|
|
19914
|
+
(ids: string[]): Promise<void>;
|
|
19915
|
+
}
|
|
19916
|
+
declare function assignSubscriptionOptionsToProduct$1(httpClient: HttpClient): AssignSubscriptionOptionsToProductSignature;
|
|
19917
|
+
interface AssignSubscriptionOptionsToProductSignature {
|
|
19918
|
+
/**
|
|
19919
|
+
* Assign up to 6 subscription options to a specified product.
|
|
19920
|
+
* Pass an empty array to remove all subscription options assigned to a product.
|
|
19921
|
+
* <blockquote class='warning'>
|
|
19922
|
+
*
|
|
19923
|
+
* __Deprecation Notice:__
|
|
19924
|
+
*
|
|
19925
|
+
* This endpoint has been deprecated and will be removed on January 29, 2024.
|
|
19926
|
+
*
|
|
19927
|
+
* </blockquote>
|
|
19928
|
+
* @param - Product ID.
|
|
19929
|
+
* @param - Subscription option assignment options.
|
|
19930
|
+
* @deprecated
|
|
19931
|
+
*/
|
|
19932
|
+
(productId: string, options?: AssignSubscriptionOptionsToProductOptions | undefined): Promise<void>;
|
|
19933
|
+
}
|
|
19934
|
+
declare function allowOneTimePurchases$1(httpClient: HttpClient): AllowOneTimePurchasesSignature;
|
|
19935
|
+
interface AllowOneTimePurchasesSignature {
|
|
19936
|
+
/**
|
|
19937
|
+
* Allow for one-time purchase of a product.
|
|
19938
|
+
* By default, product can be sold only as part of a subscription, not as a one-time purchase.
|
|
19939
|
+
* <blockquote class='warning'>
|
|
19940
|
+
*
|
|
19941
|
+
* __Deprecation Notice:__
|
|
19942
|
+
*
|
|
19943
|
+
* This endpoint has been deprecated and will be removed on January 29, 2024.
|
|
19944
|
+
*
|
|
19945
|
+
* </blockquote>
|
|
19946
|
+
* @param - Product ID.
|
|
19947
|
+
* @param - Pass `true` to offer product by subscription and as one-time purchase. Pass `false` to offer product as subscription only.
|
|
19948
|
+
* @deprecated
|
|
19949
|
+
*/
|
|
19950
|
+
(productId: string, allowed: boolean | null): Promise<void>;
|
|
19951
|
+
}
|
|
19952
|
+
declare function getSubscriptionOption$1(httpClient: HttpClient): GetSubscriptionOptionSignature;
|
|
19953
|
+
interface GetSubscriptionOptionSignature {
|
|
19954
|
+
/**
|
|
19955
|
+
* Retrieves a subscription option by ID.
|
|
19956
|
+
* <blockquote class='warning'>
|
|
19957
|
+
*
|
|
19958
|
+
* __Deprecation Notice:__
|
|
19959
|
+
*
|
|
19960
|
+
* This endpoint has been deprecated and will be removed on January 29, 2024.
|
|
19961
|
+
*
|
|
19962
|
+
* </blockquote>
|
|
19963
|
+
* @param - Subscription option ID.
|
|
19964
|
+
* @returns Subscription option.
|
|
19965
|
+
* @deprecated
|
|
19966
|
+
*/
|
|
19967
|
+
(_id: string): Promise<SubscriptionOption & SubscriptionOptionNonNullableFields>;
|
|
19968
|
+
}
|
|
19969
|
+
declare function getSubscriptionOptionsForProduct$1(httpClient: HttpClient): GetSubscriptionOptionsForProductSignature;
|
|
19970
|
+
interface GetSubscriptionOptionsForProductSignature {
|
|
19971
|
+
/**
|
|
19972
|
+
* Retrieves all subscription options assigned to a specified product.
|
|
19973
|
+
* By default, hidden subscription options are not returned. To retrieve all subscription options you must pass `includeHiddenSubscriptionOptions = true`.
|
|
19974
|
+
* <blockquote class='warning'>
|
|
19975
|
+
*
|
|
19976
|
+
* __Deprecation Notice:__
|
|
19977
|
+
*
|
|
19978
|
+
* This endpoint has been deprecated and will be removed on January 29, 2024.
|
|
19979
|
+
*
|
|
19980
|
+
* </blockquote>
|
|
19981
|
+
* @param - Product ID.
|
|
19982
|
+
* @param - Options.
|
|
19983
|
+
* @deprecated
|
|
19984
|
+
*/
|
|
19985
|
+
(productId: string, options?: GetSubscriptionOptionsForProductOptions | undefined): Promise<GetSubscriptionOptionsForProductResponse & GetSubscriptionOptionsForProductResponseNonNullableFields>;
|
|
19986
|
+
}
|
|
19987
|
+
declare function getProductIdsForSubscriptionOption$1(httpClient: HttpClient): GetProductIdsForSubscriptionOptionSignature;
|
|
19988
|
+
interface GetProductIdsForSubscriptionOptionSignature {
|
|
19989
|
+
/**
|
|
19990
|
+
* Retrieves the IDs of products associated with a specified subscription option.
|
|
19991
|
+
* <blockquote class='warning'>
|
|
19992
|
+
*
|
|
19993
|
+
* __Deprecation Notice:__
|
|
19994
|
+
*
|
|
19995
|
+
* This endpoint has been deprecated and will be removed on January 29, 2024.
|
|
19996
|
+
*
|
|
19997
|
+
* </blockquote>
|
|
19998
|
+
* @param - Subscription option ID.
|
|
19999
|
+
* @param - Paging and other options.
|
|
20000
|
+
* @deprecated
|
|
20001
|
+
*/
|
|
20002
|
+
(_id: string, options?: GetProductIdsForSubscriptionOptionOptions | undefined): Promise<GetProductIdsForSubscriptionOptionResponse & GetProductIdsForSubscriptionOptionResponseNonNullableFields>;
|
|
20003
|
+
}
|
|
20004
|
+
declare function getOneTimePurchasesStatus$1(httpClient: HttpClient): GetOneTimePurchasesStatusSignature;
|
|
20005
|
+
interface GetOneTimePurchasesStatusSignature {
|
|
20006
|
+
/**
|
|
20007
|
+
* Checks whether a specified product (associated with subscription options) is available for one-time purchase.
|
|
20008
|
+
* <blockquote class='warning'>
|
|
20009
|
+
*
|
|
20010
|
+
* __Deprecation Notice:__
|
|
20011
|
+
*
|
|
20012
|
+
* This endpoint has been deprecated and will be removed on January 29, 2024.
|
|
20013
|
+
*
|
|
20014
|
+
* </blockquote>
|
|
20015
|
+
* @param - Product ID.
|
|
20016
|
+
* @deprecated
|
|
20017
|
+
*/
|
|
20018
|
+
(productId: string): Promise<GetOneTimePurchasesStatusResponse & GetOneTimePurchasesStatusResponseNonNullableFields>;
|
|
20019
|
+
}
|
|
18685
20020
|
|
|
18686
20021
|
declare function createRESTModule$1<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
18687
20022
|
|
|
@@ -19222,11 +20557,58 @@ interface UpdateInventoryVariantsInventoryItem {
|
|
|
19222
20557
|
preorderInfo?: PreorderInfo;
|
|
19223
20558
|
}
|
|
19224
20559
|
|
|
19225
|
-
declare function getInventoryVariants$1(httpClient: HttpClient):
|
|
19226
|
-
|
|
19227
|
-
|
|
19228
|
-
|
|
19229
|
-
|
|
20560
|
+
declare function getInventoryVariants$1(httpClient: HttpClient): GetInventoryVariantsSignature;
|
|
20561
|
+
interface GetInventoryVariantsSignature {
|
|
20562
|
+
/**
|
|
20563
|
+
* Gets inventory variant information based on the specified option choices.
|
|
20564
|
+
*
|
|
20565
|
+
*
|
|
20566
|
+
* The `getInventoryVariants()` function returns a Promise that resolves to the specified inventory variant information.
|
|
20567
|
+
* @param - Inventory item ID.
|
|
20568
|
+
*/
|
|
20569
|
+
(inventoryId: string, options?: GetInventoryVariantsOptions | undefined): Promise<GetInventoryVariantsResponse & GetInventoryVariantsResponseNonNullableFields>;
|
|
20570
|
+
}
|
|
20571
|
+
declare function queryInventory$1(httpClient: HttpClient): QueryInventorySignature;
|
|
20572
|
+
interface QueryInventorySignature {
|
|
20573
|
+
/**
|
|
20574
|
+
* Returns a list of inventory items, given the provided paging, sorting and filtering.
|
|
20575
|
+
*/
|
|
20576
|
+
(options?: QueryInventoryOptions | undefined): Promise<QueryInventoryResponse & QueryInventoryResponseNonNullableFields>;
|
|
20577
|
+
}
|
|
20578
|
+
declare function updateInventoryVariants$1(httpClient: HttpClient): UpdateInventoryVariantsSignature;
|
|
20579
|
+
interface UpdateInventoryVariantsSignature {
|
|
20580
|
+
/**
|
|
20581
|
+
* Updates product inventory, including total quantity, whether the product is in stock, and whether the product inventory is tracked.
|
|
20582
|
+
*
|
|
20583
|
+
*
|
|
20584
|
+
* The `updateInventoryVariants()` function is a Promise that resolves to the updated inventory variant data.
|
|
20585
|
+
* @param - Product ID.
|
|
20586
|
+
* @param - Inventory item to update.
|
|
20587
|
+
*/
|
|
20588
|
+
(productId: string | null, inventoryItem: UpdateInventoryVariantsInventoryItem): Promise<void>;
|
|
20589
|
+
}
|
|
20590
|
+
declare function decrementInventory$1(httpClient: HttpClient): DecrementInventorySignature;
|
|
20591
|
+
interface DecrementInventorySignature {
|
|
20592
|
+
/**
|
|
20593
|
+
* Subtracts a set number of items from inventory.
|
|
20594
|
+
*
|
|
20595
|
+
*
|
|
20596
|
+
* The `decrementInventory()` function returns a Promise that is resolved when the specified item's quantity has been updated in the inventory.
|
|
20597
|
+
* @param - Item or product to decrement.
|
|
20598
|
+
*/
|
|
20599
|
+
(decrementData: DecrementData[]): Promise<void>;
|
|
20600
|
+
}
|
|
20601
|
+
declare function incrementInventory$1(httpClient: HttpClient): IncrementInventorySignature;
|
|
20602
|
+
interface IncrementInventorySignature {
|
|
20603
|
+
/**
|
|
20604
|
+
* Adds a set number of items to inventory.
|
|
20605
|
+
*
|
|
20606
|
+
*
|
|
20607
|
+
* The `incrementInventory()` function returns a Promise that is resolved when the specified item's quantity has been updated in the inventory.
|
|
20608
|
+
* @param - Item or product to increment.
|
|
20609
|
+
*/
|
|
20610
|
+
(incrementData: IncrementData[]): Promise<void>;
|
|
20611
|
+
}
|
|
19230
20612
|
declare const onInventoryItemChanged$1: EventDefinition<InventoryItemChangedEnvelope, "com.wix.ecommerce.inventory.api.v1.InventoryItemChanged">;
|
|
19231
20613
|
declare const onInventoryVariantsChanged$1: EventDefinition<InventoryVariantsChangedEnvelope, "com.wix.ecommerce.inventory.api.v1.InventoryVariantsChanged">;
|
|
19232
20614
|
|
|
@@ -19246,9 +20628,15 @@ type _publicIncrementInventoryType = typeof incrementInventory$1;
|
|
|
19246
20628
|
declare const incrementInventory: ReturnType<typeof createRESTModule<_publicIncrementInventoryType>>;
|
|
19247
20629
|
|
|
19248
20630
|
type _publicOnInventoryItemChangedType = typeof onInventoryItemChanged$1;
|
|
20631
|
+
/**
|
|
20632
|
+
* Triggered when an inventory item is changed.
|
|
20633
|
+
*/
|
|
19249
20634
|
declare const onInventoryItemChanged: ReturnType<typeof createEventModule<_publicOnInventoryItemChangedType>>;
|
|
19250
20635
|
|
|
19251
20636
|
type _publicOnInventoryVariantsChangedType = typeof onInventoryVariantsChanged$1;
|
|
20637
|
+
/**
|
|
20638
|
+
* Triggered when inventory variants are changed.
|
|
20639
|
+
*/
|
|
19252
20640
|
declare const onInventoryVariantsChanged: ReturnType<typeof createEventModule<_publicOnInventoryVariantsChangedType>>;
|
|
19253
20641
|
|
|
19254
20642
|
type context_BaseEventMetadata = BaseEventMetadata;
|