@teemill/product-catalog 1.86.0 → 1.88.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -2
- package/api.ts +274 -17
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +152 -11
- package/dist/api.js +178 -17
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +152 -11
- package/dist/esm/api.js +172 -15
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/ProductAnalyticsApi.md +30 -6
- package/docs/ProductCreatorsApi.md +63 -0
- package/docs/ProductWarehouseProduct.md +2 -0
- package/docs/UserList.md +20 -0
- package/docs/UserListCreatorsInner.md +24 -0
- package/docs/UserListCreatorsInnerAvatar.md +22 -0
- package/docs/VariantWarehouseVariant.md +2 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Product Catalog API
|
|
3
3
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.88.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1264,6 +1264,10 @@ export interface ProductWarehouseProduct {
|
|
|
1264
1264
|
* Reference to the product in the Global Fulfillment Network (GFN) catalog that will be used as a base for this product. A list of available products for the given project can be obtained from the GFN Catalog API.
|
|
1265
1265
|
*/
|
|
1266
1266
|
'gfnProductRef'?: string;
|
|
1267
|
+
/**
|
|
1268
|
+
* Meta fields from the warehouse product
|
|
1269
|
+
*/
|
|
1270
|
+
'metafields'?: Array<MetaField>;
|
|
1267
1271
|
}
|
|
1268
1272
|
export interface ProductsResponse {
|
|
1269
1273
|
'products'?: Array<Product>;
|
|
@@ -1831,6 +1835,30 @@ export declare const UpdateProductsRequestProductsInnerVariantsInnerSalePriceCur
|
|
|
1831
1835
|
readonly Gbp: "GBP";
|
|
1832
1836
|
};
|
|
1833
1837
|
export type UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum = typeof UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum[keyof typeof UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum];
|
|
1838
|
+
export interface UserList {
|
|
1839
|
+
'creators': Array<UserListCreatorsInner>;
|
|
1840
|
+
}
|
|
1841
|
+
export interface UserListCreatorsInner {
|
|
1842
|
+
/**
|
|
1843
|
+
* Unique object identifier
|
|
1844
|
+
*/
|
|
1845
|
+
'id': string;
|
|
1846
|
+
/**
|
|
1847
|
+
* The username of the product creator
|
|
1848
|
+
*/
|
|
1849
|
+
'username': string;
|
|
1850
|
+
'avatar': UserListCreatorsInnerAvatar;
|
|
1851
|
+
}
|
|
1852
|
+
export interface UserListCreatorsInnerAvatar {
|
|
1853
|
+
/**
|
|
1854
|
+
* URL to the thumbnail version of the avatar
|
|
1855
|
+
*/
|
|
1856
|
+
'thumbnail': string | null;
|
|
1857
|
+
/**
|
|
1858
|
+
* URL to the original avatar image
|
|
1859
|
+
*/
|
|
1860
|
+
'original': string | null;
|
|
1861
|
+
}
|
|
1834
1862
|
export interface Variant {
|
|
1835
1863
|
/**
|
|
1836
1864
|
* Unique object identifier
|
|
@@ -1909,6 +1937,10 @@ export interface VariantWarehouseVariant {
|
|
|
1909
1937
|
* Reference to the variant in the Global Fulfillment Network (GFN) catalog.
|
|
1910
1938
|
*/
|
|
1911
1939
|
'gfnVariantRef'?: string;
|
|
1940
|
+
/**
|
|
1941
|
+
* Meta fields from the warehouse variant
|
|
1942
|
+
*/
|
|
1943
|
+
'metafields'?: Array<MetaField>;
|
|
1912
1944
|
}
|
|
1913
1945
|
export interface VariantWholesaleCost {
|
|
1914
1946
|
'item': RequiredPrice;
|
|
@@ -2565,7 +2597,7 @@ export declare const ProductAnalyticsApiAxiosParamCreator: (configuration?: Conf
|
|
|
2565
2597
|
* @summary Export product analytics
|
|
2566
2598
|
* @param {string} project What project it is
|
|
2567
2599
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2568
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'
|
|
2600
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'productType:<id>\', \'Multiple filters can be combined with spaces and commas.\'
|
|
2569
2601
|
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
2570
2602
|
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
2571
2603
|
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
@@ -2576,10 +2608,14 @@ export declare const ProductAnalyticsApiAxiosParamCreator: (configuration?: Conf
|
|
|
2576
2608
|
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
2577
2609
|
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
2578
2610
|
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
2611
|
+
* @param {string} [createdBefore] Filter to only include products created before the given date
|
|
2612
|
+
* @param {string} [createdAfter] Filter to only include products created after the given date
|
|
2613
|
+
* @param {string} [updatedBefore] Filter to only include products updated before the given date
|
|
2614
|
+
* @param {string} [updatedAfter] Filter to only include products updated after the given date
|
|
2579
2615
|
* @param {*} [options] Override http request option.
|
|
2580
2616
|
* @throws {RequiredError}
|
|
2581
2617
|
*/
|
|
2582
|
-
exportProductAnalytics: (project: string, sortBy?: Array<string>, search?: string, dateRangeStartDate?: string, dateRangeEndDate?: string, minimumRevenue?: number, maximumRevenue?: number, minimumSales?: number, maximumSales?: number, minimumBasketPercent?: number, maximumBasketPercent?: number, minimumTraffic?: number, maximumTraffic?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2618
|
+
exportProductAnalytics: (project: string, sortBy?: Array<string>, search?: string, dateRangeStartDate?: string, dateRangeEndDate?: string, minimumRevenue?: number, maximumRevenue?: number, minimumSales?: number, maximumSales?: number, minimumBasketPercent?: number, maximumBasketPercent?: number, minimumTraffic?: number, maximumTraffic?: number, createdBefore?: string, createdAfter?: string, updatedBefore?: string, updatedAfter?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2583
2619
|
/**
|
|
2584
2620
|
* Get the AI-generated summary of the product analytics for the given project.
|
|
2585
2621
|
* @summary Get product analytics summary
|
|
@@ -2594,7 +2630,7 @@ export declare const ProductAnalyticsApiAxiosParamCreator: (configuration?: Conf
|
|
|
2594
2630
|
* @param {string} project What project it is
|
|
2595
2631
|
* @param {number} [pageToken] Page reference token
|
|
2596
2632
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2597
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'
|
|
2633
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'productType:<id>\', \'Multiple filters can be combined with spaces and commas.\'
|
|
2598
2634
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2599
2635
|
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
2600
2636
|
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
@@ -2606,10 +2642,14 @@ export declare const ProductAnalyticsApiAxiosParamCreator: (configuration?: Conf
|
|
|
2606
2642
|
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
2607
2643
|
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
2608
2644
|
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
2645
|
+
* @param {string} [createdBefore] Filter to only include products created before the given date
|
|
2646
|
+
* @param {string} [createdAfter] Filter to only include products created after the given date
|
|
2647
|
+
* @param {string} [updatedBefore] Filter to only include products updated before the given date
|
|
2648
|
+
* @param {string} [updatedAfter] Filter to only include products updated after the given date
|
|
2609
2649
|
* @param {*} [options] Override http request option.
|
|
2610
2650
|
* @throws {RequiredError}
|
|
2611
2651
|
*/
|
|
2612
|
-
listProductAnalytics: (project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, dateRangeStartDate?: string, dateRangeEndDate?: string, minimumRevenue?: number, maximumRevenue?: number, minimumSales?: number, maximumSales?: number, minimumBasketPercent?: number, maximumBasketPercent?: number, minimumTraffic?: number, maximumTraffic?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2652
|
+
listProductAnalytics: (project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, dateRangeStartDate?: string, dateRangeEndDate?: string, minimumRevenue?: number, maximumRevenue?: number, minimumSales?: number, maximumSales?: number, minimumBasketPercent?: number, maximumBasketPercent?: number, minimumTraffic?: number, maximumTraffic?: number, createdBefore?: string, createdAfter?: string, updatedBefore?: string, updatedAfter?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2613
2653
|
};
|
|
2614
2654
|
/**
|
|
2615
2655
|
* ProductAnalyticsApi - functional programming interface
|
|
@@ -2620,7 +2660,7 @@ export declare const ProductAnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
2620
2660
|
* @summary Export product analytics
|
|
2621
2661
|
* @param {string} project What project it is
|
|
2622
2662
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2623
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'
|
|
2663
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'productType:<id>\', \'Multiple filters can be combined with spaces and commas.\'
|
|
2624
2664
|
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
2625
2665
|
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
2626
2666
|
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
@@ -2631,10 +2671,14 @@ export declare const ProductAnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
2631
2671
|
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
2632
2672
|
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
2633
2673
|
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
2674
|
+
* @param {string} [createdBefore] Filter to only include products created before the given date
|
|
2675
|
+
* @param {string} [createdAfter] Filter to only include products created after the given date
|
|
2676
|
+
* @param {string} [updatedBefore] Filter to only include products updated before the given date
|
|
2677
|
+
* @param {string} [updatedAfter] Filter to only include products updated after the given date
|
|
2634
2678
|
* @param {*} [options] Override http request option.
|
|
2635
2679
|
* @throws {RequiredError}
|
|
2636
2680
|
*/
|
|
2637
|
-
exportProductAnalytics(project: string, sortBy?: Array<string>, search?: string, dateRangeStartDate?: string, dateRangeEndDate?: string, minimumRevenue?: number, maximumRevenue?: number, minimumSales?: number, maximumSales?: number, minimumBasketPercent?: number, maximumBasketPercent?: number, minimumTraffic?: number, maximumTraffic?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
2681
|
+
exportProductAnalytics(project: string, sortBy?: Array<string>, search?: string, dateRangeStartDate?: string, dateRangeEndDate?: string, minimumRevenue?: number, maximumRevenue?: number, minimumSales?: number, maximumSales?: number, minimumBasketPercent?: number, maximumBasketPercent?: number, minimumTraffic?: number, maximumTraffic?: number, createdBefore?: string, createdAfter?: string, updatedBefore?: string, updatedAfter?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
2638
2682
|
/**
|
|
2639
2683
|
* Get the AI-generated summary of the product analytics for the given project.
|
|
2640
2684
|
* @summary Get product analytics summary
|
|
@@ -2649,7 +2693,7 @@ export declare const ProductAnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
2649
2693
|
* @param {string} project What project it is
|
|
2650
2694
|
* @param {number} [pageToken] Page reference token
|
|
2651
2695
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2652
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'
|
|
2696
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'productType:<id>\', \'Multiple filters can be combined with spaces and commas.\'
|
|
2653
2697
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2654
2698
|
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
2655
2699
|
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
@@ -2661,10 +2705,14 @@ export declare const ProductAnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
2661
2705
|
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
2662
2706
|
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
2663
2707
|
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
2708
|
+
* @param {string} [createdBefore] Filter to only include products created before the given date
|
|
2709
|
+
* @param {string} [createdAfter] Filter to only include products created after the given date
|
|
2710
|
+
* @param {string} [updatedBefore] Filter to only include products updated before the given date
|
|
2711
|
+
* @param {string} [updatedAfter] Filter to only include products updated after the given date
|
|
2664
2712
|
* @param {*} [options] Override http request option.
|
|
2665
2713
|
* @throws {RequiredError}
|
|
2666
2714
|
*/
|
|
2667
|
-
listProductAnalytics(project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, dateRangeStartDate?: string, dateRangeEndDate?: string, minimumRevenue?: number, maximumRevenue?: number, minimumSales?: number, maximumSales?: number, minimumBasketPercent?: number, maximumBasketPercent?: number, minimumTraffic?: number, maximumTraffic?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductAnalyticsResponse>>;
|
|
2715
|
+
listProductAnalytics(project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, dateRangeStartDate?: string, dateRangeEndDate?: string, minimumRevenue?: number, maximumRevenue?: number, minimumSales?: number, maximumSales?: number, minimumBasketPercent?: number, maximumBasketPercent?: number, minimumTraffic?: number, maximumTraffic?: number, createdBefore?: string, createdAfter?: string, updatedBefore?: string, updatedAfter?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductAnalyticsResponse>>;
|
|
2668
2716
|
};
|
|
2669
2717
|
/**
|
|
2670
2718
|
* ProductAnalyticsApi - factory interface
|
|
@@ -2708,7 +2756,7 @@ export interface ProductAnalyticsApiExportProductAnalyticsRequest {
|
|
|
2708
2756
|
*/
|
|
2709
2757
|
readonly sortBy?: Array<string>;
|
|
2710
2758
|
/**
|
|
2711
|
-
* Search query string to filter results. Supports field-specific filters like: \'
|
|
2759
|
+
* Search query string to filter results. Supports field-specific filters like: \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'productType:<id>\', \'Multiple filters can be combined with spaces and commas.\'
|
|
2712
2760
|
*/
|
|
2713
2761
|
readonly search?: string;
|
|
2714
2762
|
/**
|
|
@@ -2751,6 +2799,22 @@ export interface ProductAnalyticsApiExportProductAnalyticsRequest {
|
|
|
2751
2799
|
* Filter to only include products with total traffic less than or equal to this number
|
|
2752
2800
|
*/
|
|
2753
2801
|
readonly maximumTraffic?: number;
|
|
2802
|
+
/**
|
|
2803
|
+
* Filter to only include products created before the given date
|
|
2804
|
+
*/
|
|
2805
|
+
readonly createdBefore?: string;
|
|
2806
|
+
/**
|
|
2807
|
+
* Filter to only include products created after the given date
|
|
2808
|
+
*/
|
|
2809
|
+
readonly createdAfter?: string;
|
|
2810
|
+
/**
|
|
2811
|
+
* Filter to only include products updated before the given date
|
|
2812
|
+
*/
|
|
2813
|
+
readonly updatedBefore?: string;
|
|
2814
|
+
/**
|
|
2815
|
+
* Filter to only include products updated after the given date
|
|
2816
|
+
*/
|
|
2817
|
+
readonly updatedAfter?: string;
|
|
2754
2818
|
}
|
|
2755
2819
|
/**
|
|
2756
2820
|
* Request parameters for getProductAnalyticsSummary operation in ProductAnalyticsApi.
|
|
@@ -2778,7 +2842,7 @@ export interface ProductAnalyticsApiListProductAnalyticsRequest {
|
|
|
2778
2842
|
*/
|
|
2779
2843
|
readonly pageSize?: number;
|
|
2780
2844
|
/**
|
|
2781
|
-
* Search query string to filter results. Supports field-specific filters like: \'
|
|
2845
|
+
* Search query string to filter results. Supports field-specific filters like: \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'productType:<id>\', \'Multiple filters can be combined with spaces and commas.\'
|
|
2782
2846
|
*/
|
|
2783
2847
|
readonly search?: string;
|
|
2784
2848
|
/**
|
|
@@ -2825,6 +2889,22 @@ export interface ProductAnalyticsApiListProductAnalyticsRequest {
|
|
|
2825
2889
|
* Filter to only include products with total traffic less than or equal to this number
|
|
2826
2890
|
*/
|
|
2827
2891
|
readonly maximumTraffic?: number;
|
|
2892
|
+
/**
|
|
2893
|
+
* Filter to only include products created before the given date
|
|
2894
|
+
*/
|
|
2895
|
+
readonly createdBefore?: string;
|
|
2896
|
+
/**
|
|
2897
|
+
* Filter to only include products created after the given date
|
|
2898
|
+
*/
|
|
2899
|
+
readonly createdAfter?: string;
|
|
2900
|
+
/**
|
|
2901
|
+
* Filter to only include products updated before the given date
|
|
2902
|
+
*/
|
|
2903
|
+
readonly updatedBefore?: string;
|
|
2904
|
+
/**
|
|
2905
|
+
* Filter to only include products updated after the given date
|
|
2906
|
+
*/
|
|
2907
|
+
readonly updatedAfter?: string;
|
|
2828
2908
|
}
|
|
2829
2909
|
/**
|
|
2830
2910
|
* ProductAnalyticsApi - object-oriented interface
|
|
@@ -2855,6 +2935,67 @@ export declare class ProductAnalyticsApi extends BaseAPI {
|
|
|
2855
2935
|
*/
|
|
2856
2936
|
listProductAnalytics(requestParameters: ProductAnalyticsApiListProductAnalyticsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductAnalyticsResponse, any, {}>>;
|
|
2857
2937
|
}
|
|
2938
|
+
/**
|
|
2939
|
+
* ProductCreatorsApi - axios parameter creator
|
|
2940
|
+
*/
|
|
2941
|
+
export declare const ProductCreatorsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2942
|
+
/**
|
|
2943
|
+
* Lists all the unique users that have created products for the given project.
|
|
2944
|
+
* @summary List product creators
|
|
2945
|
+
* @param {string} project What project it is
|
|
2946
|
+
* @param {*} [options] Override http request option.
|
|
2947
|
+
* @throws {RequiredError}
|
|
2948
|
+
*/
|
|
2949
|
+
listProductCreators: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2950
|
+
};
|
|
2951
|
+
/**
|
|
2952
|
+
* ProductCreatorsApi - functional programming interface
|
|
2953
|
+
*/
|
|
2954
|
+
export declare const ProductCreatorsApiFp: (configuration?: Configuration) => {
|
|
2955
|
+
/**
|
|
2956
|
+
* Lists all the unique users that have created products for the given project.
|
|
2957
|
+
* @summary List product creators
|
|
2958
|
+
* @param {string} project What project it is
|
|
2959
|
+
* @param {*} [options] Override http request option.
|
|
2960
|
+
* @throws {RequiredError}
|
|
2961
|
+
*/
|
|
2962
|
+
listProductCreators(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserList>>;
|
|
2963
|
+
};
|
|
2964
|
+
/**
|
|
2965
|
+
* ProductCreatorsApi - factory interface
|
|
2966
|
+
*/
|
|
2967
|
+
export declare const ProductCreatorsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2968
|
+
/**
|
|
2969
|
+
* Lists all the unique users that have created products for the given project.
|
|
2970
|
+
* @summary List product creators
|
|
2971
|
+
* @param {ProductCreatorsApiListProductCreatorsRequest} requestParameters Request parameters.
|
|
2972
|
+
* @param {*} [options] Override http request option.
|
|
2973
|
+
* @throws {RequiredError}
|
|
2974
|
+
*/
|
|
2975
|
+
listProductCreators(requestParameters: ProductCreatorsApiListProductCreatorsRequest, options?: RawAxiosRequestConfig): AxiosPromise<UserList>;
|
|
2976
|
+
};
|
|
2977
|
+
/**
|
|
2978
|
+
* Request parameters for listProductCreators operation in ProductCreatorsApi.
|
|
2979
|
+
*/
|
|
2980
|
+
export interface ProductCreatorsApiListProductCreatorsRequest {
|
|
2981
|
+
/**
|
|
2982
|
+
* What project it is
|
|
2983
|
+
*/
|
|
2984
|
+
readonly project: string;
|
|
2985
|
+
}
|
|
2986
|
+
/**
|
|
2987
|
+
* ProductCreatorsApi - object-oriented interface
|
|
2988
|
+
*/
|
|
2989
|
+
export declare class ProductCreatorsApi extends BaseAPI {
|
|
2990
|
+
/**
|
|
2991
|
+
* Lists all the unique users that have created products for the given project.
|
|
2992
|
+
* @summary List product creators
|
|
2993
|
+
* @param {ProductCreatorsApiListProductCreatorsRequest} requestParameters Request parameters.
|
|
2994
|
+
* @param {*} [options] Override http request option.
|
|
2995
|
+
* @throws {RequiredError}
|
|
2996
|
+
*/
|
|
2997
|
+
listProductCreators(requestParameters: ProductCreatorsApiListProductCreatorsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserList, any, {}>>;
|
|
2998
|
+
}
|
|
2858
2999
|
/**
|
|
2859
3000
|
* ProductTypesApi - axios parameter creator
|
|
2860
3001
|
*/
|
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Product Catalog API
|
|
5
5
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.88.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1114,7 +1114,7 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1114
1114
|
* @summary Export product analytics
|
|
1115
1115
|
* @param {string} project What project it is
|
|
1116
1116
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1117
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'
|
|
1117
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'productType:<id>\', \'Multiple filters can be combined with spaces and commas.\'
|
|
1118
1118
|
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
1119
1119
|
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
1120
1120
|
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
@@ -1125,10 +1125,14 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1125
1125
|
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
1126
1126
|
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
1127
1127
|
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
1128
|
+
* @param {string} [createdBefore] Filter to only include products created before the given date
|
|
1129
|
+
* @param {string} [createdAfter] Filter to only include products created after the given date
|
|
1130
|
+
* @param {string} [updatedBefore] Filter to only include products updated before the given date
|
|
1131
|
+
* @param {string} [updatedAfter] Filter to only include products updated after the given date
|
|
1128
1132
|
* @param {*} [options] Override http request option.
|
|
1129
1133
|
* @throws {RequiredError}
|
|
1130
1134
|
*/
|
|
1131
|
-
exportProductAnalytics: (project_1, sortBy_1, search_1, dateRangeStartDate_1, dateRangeEndDate_1, minimumRevenue_1, maximumRevenue_1, minimumSales_1, maximumSales_1, minimumBasketPercent_1, maximumBasketPercent_1, minimumTraffic_1, maximumTraffic_1, ...args_1) => __awaiter(this, [project_1, sortBy_1, search_1, dateRangeStartDate_1, dateRangeEndDate_1, minimumRevenue_1, maximumRevenue_1, minimumSales_1, maximumSales_1, minimumBasketPercent_1, maximumBasketPercent_1, minimumTraffic_1, maximumTraffic_1, ...args_1], void 0, function* (project, sortBy, search, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, options = {}) {
|
|
1135
|
+
exportProductAnalytics: (project_1, sortBy_1, search_1, dateRangeStartDate_1, dateRangeEndDate_1, minimumRevenue_1, maximumRevenue_1, minimumSales_1, maximumSales_1, minimumBasketPercent_1, maximumBasketPercent_1, minimumTraffic_1, maximumTraffic_1, createdBefore_1, createdAfter_1, updatedBefore_1, updatedAfter_1, ...args_1) => __awaiter(this, [project_1, sortBy_1, search_1, dateRangeStartDate_1, dateRangeEndDate_1, minimumRevenue_1, maximumRevenue_1, minimumSales_1, maximumSales_1, minimumBasketPercent_1, maximumBasketPercent_1, minimumTraffic_1, maximumTraffic_1, createdBefore_1, createdAfter_1, updatedBefore_1, updatedAfter_1, ...args_1], void 0, function* (project, sortBy, search, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, createdBefore, createdAfter, updatedBefore, updatedAfter, options = {}) {
|
|
1132
1136
|
// verify required parameter 'project' is not null or undefined
|
|
1133
1137
|
assertParamExists('exportProductAnalytics', 'project', project);
|
|
1134
1138
|
const localVarPath = `/v1/catalog/analytics/export`;
|
|
@@ -1189,6 +1193,26 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1189
1193
|
if (maximumTraffic !== undefined) {
|
|
1190
1194
|
localVarQueryParameter['maximumTraffic'] = maximumTraffic;
|
|
1191
1195
|
}
|
|
1196
|
+
if (createdBefore !== undefined) {
|
|
1197
|
+
localVarQueryParameter['createdBefore'] = (createdBefore instanceof Date) ?
|
|
1198
|
+
createdBefore.toISOString() :
|
|
1199
|
+
createdBefore;
|
|
1200
|
+
}
|
|
1201
|
+
if (createdAfter !== undefined) {
|
|
1202
|
+
localVarQueryParameter['createdAfter'] = (createdAfter instanceof Date) ?
|
|
1203
|
+
createdAfter.toISOString() :
|
|
1204
|
+
createdAfter;
|
|
1205
|
+
}
|
|
1206
|
+
if (updatedBefore !== undefined) {
|
|
1207
|
+
localVarQueryParameter['updatedBefore'] = (updatedBefore instanceof Date) ?
|
|
1208
|
+
updatedBefore.toISOString() :
|
|
1209
|
+
updatedBefore;
|
|
1210
|
+
}
|
|
1211
|
+
if (updatedAfter !== undefined) {
|
|
1212
|
+
localVarQueryParameter['updatedAfter'] = (updatedAfter instanceof Date) ?
|
|
1213
|
+
updatedAfter.toISOString() :
|
|
1214
|
+
updatedAfter;
|
|
1215
|
+
}
|
|
1192
1216
|
localVarHeaderParameter['Accept'] = 'text/csv; charset=utf-8,application/json';
|
|
1193
1217
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1194
1218
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1241,7 +1265,7 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1241
1265
|
* @param {string} project What project it is
|
|
1242
1266
|
* @param {number} [pageToken] Page reference token
|
|
1243
1267
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1244
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'
|
|
1268
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'productType:<id>\', \'Multiple filters can be combined with spaces and commas.\'
|
|
1245
1269
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1246
1270
|
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
1247
1271
|
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
@@ -1253,10 +1277,14 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1253
1277
|
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
1254
1278
|
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
1255
1279
|
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
1280
|
+
* @param {string} [createdBefore] Filter to only include products created before the given date
|
|
1281
|
+
* @param {string} [createdAfter] Filter to only include products created after the given date
|
|
1282
|
+
* @param {string} [updatedBefore] Filter to only include products updated before the given date
|
|
1283
|
+
* @param {string} [updatedAfter] Filter to only include products updated after the given date
|
|
1256
1284
|
* @param {*} [options] Override http request option.
|
|
1257
1285
|
* @throws {RequiredError}
|
|
1258
1286
|
*/
|
|
1259
|
-
listProductAnalytics: (project_1, pageToken_1, pageSize_1, search_1, sortBy_1, dateRangeStartDate_1, dateRangeEndDate_1, minimumRevenue_1, maximumRevenue_1, minimumSales_1, maximumSales_1, minimumBasketPercent_1, maximumBasketPercent_1, minimumTraffic_1, maximumTraffic_1, ...args_1) => __awaiter(this, [project_1, pageToken_1, pageSize_1, search_1, sortBy_1, dateRangeStartDate_1, dateRangeEndDate_1, minimumRevenue_1, maximumRevenue_1, minimumSales_1, maximumSales_1, minimumBasketPercent_1, maximumBasketPercent_1, minimumTraffic_1, maximumTraffic_1, ...args_1], void 0, function* (project, pageToken, pageSize, search, sortBy, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, options = {}) {
|
|
1287
|
+
listProductAnalytics: (project_1, pageToken_1, pageSize_1, search_1, sortBy_1, dateRangeStartDate_1, dateRangeEndDate_1, minimumRevenue_1, maximumRevenue_1, minimumSales_1, maximumSales_1, minimumBasketPercent_1, maximumBasketPercent_1, minimumTraffic_1, maximumTraffic_1, createdBefore_1, createdAfter_1, updatedBefore_1, updatedAfter_1, ...args_1) => __awaiter(this, [project_1, pageToken_1, pageSize_1, search_1, sortBy_1, dateRangeStartDate_1, dateRangeEndDate_1, minimumRevenue_1, maximumRevenue_1, minimumSales_1, maximumSales_1, minimumBasketPercent_1, maximumBasketPercent_1, minimumTraffic_1, maximumTraffic_1, createdBefore_1, createdAfter_1, updatedBefore_1, updatedAfter_1, ...args_1], void 0, function* (project, pageToken, pageSize, search, sortBy, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, createdBefore, createdAfter, updatedBefore, updatedAfter, options = {}) {
|
|
1260
1288
|
// verify required parameter 'project' is not null or undefined
|
|
1261
1289
|
assertParamExists('listProductAnalytics', 'project', project);
|
|
1262
1290
|
const localVarPath = `/v1/catalog/analytics`;
|
|
@@ -1323,6 +1351,26 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1323
1351
|
if (maximumTraffic !== undefined) {
|
|
1324
1352
|
localVarQueryParameter['maximumTraffic'] = maximumTraffic;
|
|
1325
1353
|
}
|
|
1354
|
+
if (createdBefore !== undefined) {
|
|
1355
|
+
localVarQueryParameter['createdBefore'] = (createdBefore instanceof Date) ?
|
|
1356
|
+
createdBefore.toISOString() :
|
|
1357
|
+
createdBefore;
|
|
1358
|
+
}
|
|
1359
|
+
if (createdAfter !== undefined) {
|
|
1360
|
+
localVarQueryParameter['createdAfter'] = (createdAfter instanceof Date) ?
|
|
1361
|
+
createdAfter.toISOString() :
|
|
1362
|
+
createdAfter;
|
|
1363
|
+
}
|
|
1364
|
+
if (updatedBefore !== undefined) {
|
|
1365
|
+
localVarQueryParameter['updatedBefore'] = (updatedBefore instanceof Date) ?
|
|
1366
|
+
updatedBefore.toISOString() :
|
|
1367
|
+
updatedBefore;
|
|
1368
|
+
}
|
|
1369
|
+
if (updatedAfter !== undefined) {
|
|
1370
|
+
localVarQueryParameter['updatedAfter'] = (updatedAfter instanceof Date) ?
|
|
1371
|
+
updatedAfter.toISOString() :
|
|
1372
|
+
updatedAfter;
|
|
1373
|
+
}
|
|
1326
1374
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1327
1375
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1328
1376
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1345,7 +1393,7 @@ export const ProductAnalyticsApiFp = function (configuration) {
|
|
|
1345
1393
|
* @summary Export product analytics
|
|
1346
1394
|
* @param {string} project What project it is
|
|
1347
1395
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1348
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'
|
|
1396
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'productType:<id>\', \'Multiple filters can be combined with spaces and commas.\'
|
|
1349
1397
|
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
1350
1398
|
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
1351
1399
|
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
@@ -1356,13 +1404,17 @@ export const ProductAnalyticsApiFp = function (configuration) {
|
|
|
1356
1404
|
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
1357
1405
|
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
1358
1406
|
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
1407
|
+
* @param {string} [createdBefore] Filter to only include products created before the given date
|
|
1408
|
+
* @param {string} [createdAfter] Filter to only include products created after the given date
|
|
1409
|
+
* @param {string} [updatedBefore] Filter to only include products updated before the given date
|
|
1410
|
+
* @param {string} [updatedAfter] Filter to only include products updated after the given date
|
|
1359
1411
|
* @param {*} [options] Override http request option.
|
|
1360
1412
|
* @throws {RequiredError}
|
|
1361
1413
|
*/
|
|
1362
|
-
exportProductAnalytics(project, sortBy, search, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, options) {
|
|
1414
|
+
exportProductAnalytics(project, sortBy, search, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, createdBefore, createdAfter, updatedBefore, updatedAfter, options) {
|
|
1363
1415
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1364
1416
|
var _a, _b, _c;
|
|
1365
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportProductAnalytics(project, sortBy, search, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, options);
|
|
1417
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportProductAnalytics(project, sortBy, search, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, createdBefore, createdAfter, updatedBefore, updatedAfter, options);
|
|
1366
1418
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1367
1419
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductAnalyticsApi.exportProductAnalytics']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1368
1420
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1390,7 +1442,7 @@ export const ProductAnalyticsApiFp = function (configuration) {
|
|
|
1390
1442
|
* @param {string} project What project it is
|
|
1391
1443
|
* @param {number} [pageToken] Page reference token
|
|
1392
1444
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1393
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'
|
|
1445
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'productType:<id>\', \'Multiple filters can be combined with spaces and commas.\'
|
|
1394
1446
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1395
1447
|
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
1396
1448
|
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
@@ -1402,13 +1454,17 @@ export const ProductAnalyticsApiFp = function (configuration) {
|
|
|
1402
1454
|
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
1403
1455
|
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
1404
1456
|
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
1457
|
+
* @param {string} [createdBefore] Filter to only include products created before the given date
|
|
1458
|
+
* @param {string} [createdAfter] Filter to only include products created after the given date
|
|
1459
|
+
* @param {string} [updatedBefore] Filter to only include products updated before the given date
|
|
1460
|
+
* @param {string} [updatedAfter] Filter to only include products updated after the given date
|
|
1405
1461
|
* @param {*} [options] Override http request option.
|
|
1406
1462
|
* @throws {RequiredError}
|
|
1407
1463
|
*/
|
|
1408
|
-
listProductAnalytics(project, pageToken, pageSize, search, sortBy, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, options) {
|
|
1464
|
+
listProductAnalytics(project, pageToken, pageSize, search, sortBy, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, createdBefore, createdAfter, updatedBefore, updatedAfter, options) {
|
|
1409
1465
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1410
1466
|
var _a, _b, _c;
|
|
1411
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.listProductAnalytics(project, pageToken, pageSize, search, sortBy, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, options);
|
|
1467
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listProductAnalytics(project, pageToken, pageSize, search, sortBy, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, createdBefore, createdAfter, updatedBefore, updatedAfter, options);
|
|
1412
1468
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1413
1469
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductAnalyticsApi.listProductAnalytics']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1414
1470
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1430,7 +1486,7 @@ export const ProductAnalyticsApiFactory = function (configuration, basePath, axi
|
|
|
1430
1486
|
* @throws {RequiredError}
|
|
1431
1487
|
*/
|
|
1432
1488
|
exportProductAnalytics(requestParameters, options) {
|
|
1433
|
-
return localVarFp.exportProductAnalytics(requestParameters.project, requestParameters.sortBy, requestParameters.search, requestParameters.dateRangeStartDate, requestParameters.dateRangeEndDate, requestParameters.minimumRevenue, requestParameters.maximumRevenue, requestParameters.minimumSales, requestParameters.maximumSales, requestParameters.minimumBasketPercent, requestParameters.maximumBasketPercent, requestParameters.minimumTraffic, requestParameters.maximumTraffic, options).then((request) => request(axios, basePath));
|
|
1489
|
+
return localVarFp.exportProductAnalytics(requestParameters.project, requestParameters.sortBy, requestParameters.search, requestParameters.dateRangeStartDate, requestParameters.dateRangeEndDate, requestParameters.minimumRevenue, requestParameters.maximumRevenue, requestParameters.minimumSales, requestParameters.maximumSales, requestParameters.minimumBasketPercent, requestParameters.maximumBasketPercent, requestParameters.minimumTraffic, requestParameters.maximumTraffic, requestParameters.createdBefore, requestParameters.createdAfter, requestParameters.updatedBefore, requestParameters.updatedAfter, options).then((request) => request(axios, basePath));
|
|
1434
1490
|
},
|
|
1435
1491
|
/**
|
|
1436
1492
|
* Get the AI-generated summary of the product analytics for the given project.
|
|
@@ -1450,7 +1506,7 @@ export const ProductAnalyticsApiFactory = function (configuration, basePath, axi
|
|
|
1450
1506
|
* @throws {RequiredError}
|
|
1451
1507
|
*/
|
|
1452
1508
|
listProductAnalytics(requestParameters, options) {
|
|
1453
|
-
return localVarFp.listProductAnalytics(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.dateRangeStartDate, requestParameters.dateRangeEndDate, requestParameters.minimumRevenue, requestParameters.maximumRevenue, requestParameters.minimumSales, requestParameters.maximumSales, requestParameters.minimumBasketPercent, requestParameters.maximumBasketPercent, requestParameters.minimumTraffic, requestParameters.maximumTraffic, options).then((request) => request(axios, basePath));
|
|
1509
|
+
return localVarFp.listProductAnalytics(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.dateRangeStartDate, requestParameters.dateRangeEndDate, requestParameters.minimumRevenue, requestParameters.maximumRevenue, requestParameters.minimumSales, requestParameters.maximumSales, requestParameters.minimumBasketPercent, requestParameters.maximumBasketPercent, requestParameters.minimumTraffic, requestParameters.maximumTraffic, requestParameters.createdBefore, requestParameters.createdAfter, requestParameters.updatedBefore, requestParameters.updatedAfter, options).then((request) => request(axios, basePath));
|
|
1454
1510
|
},
|
|
1455
1511
|
};
|
|
1456
1512
|
};
|
|
@@ -1466,7 +1522,7 @@ export class ProductAnalyticsApi extends BaseAPI {
|
|
|
1466
1522
|
* @throws {RequiredError}
|
|
1467
1523
|
*/
|
|
1468
1524
|
exportProductAnalytics(requestParameters, options) {
|
|
1469
|
-
return ProductAnalyticsApiFp(this.configuration).exportProductAnalytics(requestParameters.project, requestParameters.sortBy, requestParameters.search, requestParameters.dateRangeStartDate, requestParameters.dateRangeEndDate, requestParameters.minimumRevenue, requestParameters.maximumRevenue, requestParameters.minimumSales, requestParameters.maximumSales, requestParameters.minimumBasketPercent, requestParameters.maximumBasketPercent, requestParameters.minimumTraffic, requestParameters.maximumTraffic, options).then((request) => request(this.axios, this.basePath));
|
|
1525
|
+
return ProductAnalyticsApiFp(this.configuration).exportProductAnalytics(requestParameters.project, requestParameters.sortBy, requestParameters.search, requestParameters.dateRangeStartDate, requestParameters.dateRangeEndDate, requestParameters.minimumRevenue, requestParameters.maximumRevenue, requestParameters.minimumSales, requestParameters.maximumSales, requestParameters.minimumBasketPercent, requestParameters.maximumBasketPercent, requestParameters.minimumTraffic, requestParameters.maximumTraffic, requestParameters.createdBefore, requestParameters.createdAfter, requestParameters.updatedBefore, requestParameters.updatedAfter, options).then((request) => request(this.axios, this.basePath));
|
|
1470
1526
|
}
|
|
1471
1527
|
/**
|
|
1472
1528
|
* Get the AI-generated summary of the product analytics for the given project.
|
|
@@ -1486,7 +1542,108 @@ export class ProductAnalyticsApi extends BaseAPI {
|
|
|
1486
1542
|
* @throws {RequiredError}
|
|
1487
1543
|
*/
|
|
1488
1544
|
listProductAnalytics(requestParameters, options) {
|
|
1489
|
-
return ProductAnalyticsApiFp(this.configuration).listProductAnalytics(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.dateRangeStartDate, requestParameters.dateRangeEndDate, requestParameters.minimumRevenue, requestParameters.maximumRevenue, requestParameters.minimumSales, requestParameters.maximumSales, requestParameters.minimumBasketPercent, requestParameters.maximumBasketPercent, requestParameters.minimumTraffic, requestParameters.maximumTraffic, options).then((request) => request(this.axios, this.basePath));
|
|
1545
|
+
return ProductAnalyticsApiFp(this.configuration).listProductAnalytics(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.dateRangeStartDate, requestParameters.dateRangeEndDate, requestParameters.minimumRevenue, requestParameters.maximumRevenue, requestParameters.minimumSales, requestParameters.maximumSales, requestParameters.minimumBasketPercent, requestParameters.maximumBasketPercent, requestParameters.minimumTraffic, requestParameters.maximumTraffic, requestParameters.createdBefore, requestParameters.createdAfter, requestParameters.updatedBefore, requestParameters.updatedAfter, options).then((request) => request(this.axios, this.basePath));
|
|
1546
|
+
}
|
|
1547
|
+
}
|
|
1548
|
+
/**
|
|
1549
|
+
* ProductCreatorsApi - axios parameter creator
|
|
1550
|
+
*/
|
|
1551
|
+
export const ProductCreatorsApiAxiosParamCreator = function (configuration) {
|
|
1552
|
+
return {
|
|
1553
|
+
/**
|
|
1554
|
+
* Lists all the unique users that have created products for the given project.
|
|
1555
|
+
* @summary List product creators
|
|
1556
|
+
* @param {string} project What project it is
|
|
1557
|
+
* @param {*} [options] Override http request option.
|
|
1558
|
+
* @throws {RequiredError}
|
|
1559
|
+
*/
|
|
1560
|
+
listProductCreators: (project_1, ...args_1) => __awaiter(this, [project_1, ...args_1], void 0, function* (project, options = {}) {
|
|
1561
|
+
// verify required parameter 'project' is not null or undefined
|
|
1562
|
+
assertParamExists('listProductCreators', 'project', project);
|
|
1563
|
+
const localVarPath = `/v1/catalog/creators`;
|
|
1564
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1565
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1566
|
+
let baseOptions;
|
|
1567
|
+
if (configuration) {
|
|
1568
|
+
baseOptions = configuration.baseOptions;
|
|
1569
|
+
}
|
|
1570
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1571
|
+
const localVarHeaderParameter = {};
|
|
1572
|
+
const localVarQueryParameter = {};
|
|
1573
|
+
// authentication session-oauth required
|
|
1574
|
+
// oauth required
|
|
1575
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1576
|
+
// authentication api-key required
|
|
1577
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
1578
|
+
if (project !== undefined) {
|
|
1579
|
+
localVarQueryParameter['project'] = project;
|
|
1580
|
+
}
|
|
1581
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1582
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1583
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1584
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1585
|
+
return {
|
|
1586
|
+
url: toPathString(localVarUrlObj),
|
|
1587
|
+
options: localVarRequestOptions,
|
|
1588
|
+
};
|
|
1589
|
+
}),
|
|
1590
|
+
};
|
|
1591
|
+
};
|
|
1592
|
+
/**
|
|
1593
|
+
* ProductCreatorsApi - functional programming interface
|
|
1594
|
+
*/
|
|
1595
|
+
export const ProductCreatorsApiFp = function (configuration) {
|
|
1596
|
+
const localVarAxiosParamCreator = ProductCreatorsApiAxiosParamCreator(configuration);
|
|
1597
|
+
return {
|
|
1598
|
+
/**
|
|
1599
|
+
* Lists all the unique users that have created products for the given project.
|
|
1600
|
+
* @summary List product creators
|
|
1601
|
+
* @param {string} project What project it is
|
|
1602
|
+
* @param {*} [options] Override http request option.
|
|
1603
|
+
* @throws {RequiredError}
|
|
1604
|
+
*/
|
|
1605
|
+
listProductCreators(project, options) {
|
|
1606
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1607
|
+
var _a, _b, _c;
|
|
1608
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listProductCreators(project, options);
|
|
1609
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1610
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductCreatorsApi.listProductCreators']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1611
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1612
|
+
});
|
|
1613
|
+
},
|
|
1614
|
+
};
|
|
1615
|
+
};
|
|
1616
|
+
/**
|
|
1617
|
+
* ProductCreatorsApi - factory interface
|
|
1618
|
+
*/
|
|
1619
|
+
export const ProductCreatorsApiFactory = function (configuration, basePath, axios) {
|
|
1620
|
+
const localVarFp = ProductCreatorsApiFp(configuration);
|
|
1621
|
+
return {
|
|
1622
|
+
/**
|
|
1623
|
+
* Lists all the unique users that have created products for the given project.
|
|
1624
|
+
* @summary List product creators
|
|
1625
|
+
* @param {ProductCreatorsApiListProductCreatorsRequest} requestParameters Request parameters.
|
|
1626
|
+
* @param {*} [options] Override http request option.
|
|
1627
|
+
* @throws {RequiredError}
|
|
1628
|
+
*/
|
|
1629
|
+
listProductCreators(requestParameters, options) {
|
|
1630
|
+
return localVarFp.listProductCreators(requestParameters.project, options).then((request) => request(axios, basePath));
|
|
1631
|
+
},
|
|
1632
|
+
};
|
|
1633
|
+
};
|
|
1634
|
+
/**
|
|
1635
|
+
* ProductCreatorsApi - object-oriented interface
|
|
1636
|
+
*/
|
|
1637
|
+
export class ProductCreatorsApi extends BaseAPI {
|
|
1638
|
+
/**
|
|
1639
|
+
* Lists all the unique users that have created products for the given project.
|
|
1640
|
+
* @summary List product creators
|
|
1641
|
+
* @param {ProductCreatorsApiListProductCreatorsRequest} requestParameters Request parameters.
|
|
1642
|
+
* @param {*} [options] Override http request option.
|
|
1643
|
+
* @throws {RequiredError}
|
|
1644
|
+
*/
|
|
1645
|
+
listProductCreators(requestParameters, options) {
|
|
1646
|
+
return ProductCreatorsApiFp(this.configuration).listProductCreators(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
|
|
1490
1647
|
}
|
|
1491
1648
|
}
|
|
1492
1649
|
/**
|