@teemill/product-catalog 1.85.0 → 1.87.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 +10 -2
- package/api.ts +424 -17
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +249 -11
- package/dist/api.js +261 -16
- 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 +249 -11
- package/dist/esm/api.js +255 -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/Action.md +32 -0
- package/docs/AnalyticsSummary.md +26 -0
- package/docs/ProductAnalyticsApi.md +85 -6
- package/docs/ProductCreatorsApi.md +63 -0
- package/docs/Recommendation.md +34 -0
- package/docs/UserList.md +20 -0
- package/docs/UserListCreatorsInner.md +24 -0
- package/docs/UserListCreatorsInnerAvatar.md +22 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/configuration.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Product Catalog API
|
|
4
4
|
* 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.
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 1.
|
|
6
|
+
* The version of the OpenAPI document: 1.87.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/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.87.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -13,6 +13,33 @@ import type { Configuration } from './configuration';
|
|
|
13
13
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
import type { RequestArgs } from './base';
|
|
15
15
|
import { BaseAPI } from './base';
|
|
16
|
+
export interface Action {
|
|
17
|
+
/**
|
|
18
|
+
* Unique object identifier
|
|
19
|
+
*/
|
|
20
|
+
'id': string;
|
|
21
|
+
/**
|
|
22
|
+
* A reference to the action resource location
|
|
23
|
+
*/
|
|
24
|
+
'ref': string;
|
|
25
|
+
/**
|
|
26
|
+
* The title of the action
|
|
27
|
+
*/
|
|
28
|
+
'title': string;
|
|
29
|
+
'impact': ActionImpactEnum;
|
|
30
|
+
/**
|
|
31
|
+
* A reference to the task resource location
|
|
32
|
+
*/
|
|
33
|
+
'taskRef': string | null;
|
|
34
|
+
'createdAt': string;
|
|
35
|
+
'updatedAt': string;
|
|
36
|
+
}
|
|
37
|
+
export declare const ActionImpactEnum: {
|
|
38
|
+
readonly High: "high";
|
|
39
|
+
readonly Medium: "medium";
|
|
40
|
+
readonly Low: "low";
|
|
41
|
+
};
|
|
42
|
+
export type ActionImpactEnum = typeof ActionImpactEnum[keyof typeof ActionImpactEnum];
|
|
16
43
|
export interface AdditionalFile {
|
|
17
44
|
/**
|
|
18
45
|
* Publicly available file URL.
|
|
@@ -45,6 +72,15 @@ export interface AnalyticsItem {
|
|
|
45
72
|
*/
|
|
46
73
|
'revenue': number;
|
|
47
74
|
}
|
|
75
|
+
export interface AnalyticsSummary {
|
|
76
|
+
/**
|
|
77
|
+
* A summary of the recommendations
|
|
78
|
+
*/
|
|
79
|
+
'summary': string;
|
|
80
|
+
'recommendations': Array<Recommendation>;
|
|
81
|
+
'createdAt': string;
|
|
82
|
+
'updatedAt': string;
|
|
83
|
+
}
|
|
48
84
|
export interface ApiError {
|
|
49
85
|
'code'?: string;
|
|
50
86
|
'message': string;
|
|
@@ -1236,6 +1272,34 @@ export interface ProductsResponse {
|
|
|
1236
1272
|
*/
|
|
1237
1273
|
'nextPageToken'?: number | null;
|
|
1238
1274
|
}
|
|
1275
|
+
export interface Recommendation {
|
|
1276
|
+
/**
|
|
1277
|
+
* Unique object identifier
|
|
1278
|
+
*/
|
|
1279
|
+
'id': string;
|
|
1280
|
+
/**
|
|
1281
|
+
* A reference to the recommendation resource location
|
|
1282
|
+
*/
|
|
1283
|
+
'ref': string;
|
|
1284
|
+
/**
|
|
1285
|
+
* The reason for the recommendation
|
|
1286
|
+
*/
|
|
1287
|
+
'reason': string;
|
|
1288
|
+
/**
|
|
1289
|
+
* The recommendation for the target
|
|
1290
|
+
*/
|
|
1291
|
+
'recommendation': string;
|
|
1292
|
+
'priority': RecommendationPriorityEnum;
|
|
1293
|
+
'actions': Array<Action>;
|
|
1294
|
+
'createdAt': string;
|
|
1295
|
+
'updatedAt': string;
|
|
1296
|
+
}
|
|
1297
|
+
export declare const RecommendationPriorityEnum: {
|
|
1298
|
+
readonly High: "high";
|
|
1299
|
+
readonly Medium: "medium";
|
|
1300
|
+
readonly Low: "low";
|
|
1301
|
+
};
|
|
1302
|
+
export type RecommendationPriorityEnum = typeof RecommendationPriorityEnum[keyof typeof RecommendationPriorityEnum];
|
|
1239
1303
|
/**
|
|
1240
1304
|
* Required price definition that defines the amount and currency.
|
|
1241
1305
|
*/
|
|
@@ -1767,6 +1831,30 @@ export declare const UpdateProductsRequestProductsInnerVariantsInnerSalePriceCur
|
|
|
1767
1831
|
readonly Gbp: "GBP";
|
|
1768
1832
|
};
|
|
1769
1833
|
export type UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum = typeof UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum[keyof typeof UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum];
|
|
1834
|
+
export interface UserList {
|
|
1835
|
+
'creators': Array<UserListCreatorsInner>;
|
|
1836
|
+
}
|
|
1837
|
+
export interface UserListCreatorsInner {
|
|
1838
|
+
/**
|
|
1839
|
+
* Unique object identifier
|
|
1840
|
+
*/
|
|
1841
|
+
'id': string;
|
|
1842
|
+
/**
|
|
1843
|
+
* The username of the product creator
|
|
1844
|
+
*/
|
|
1845
|
+
'username': string;
|
|
1846
|
+
'avatar': UserListCreatorsInnerAvatar;
|
|
1847
|
+
}
|
|
1848
|
+
export interface UserListCreatorsInnerAvatar {
|
|
1849
|
+
/**
|
|
1850
|
+
* URL to the thumbnail version of the avatar
|
|
1851
|
+
*/
|
|
1852
|
+
'thumbnail': string | null;
|
|
1853
|
+
/**
|
|
1854
|
+
* URL to the original avatar image
|
|
1855
|
+
*/
|
|
1856
|
+
'original': string | null;
|
|
1857
|
+
}
|
|
1770
1858
|
export interface Variant {
|
|
1771
1859
|
/**
|
|
1772
1860
|
* Unique object identifier
|
|
@@ -2501,7 +2589,7 @@ export declare const ProductAnalyticsApiAxiosParamCreator: (configuration?: Conf
|
|
|
2501
2589
|
* @summary Export product analytics
|
|
2502
2590
|
* @param {string} project What project it is
|
|
2503
2591
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2504
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'
|
|
2592
|
+
* @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.\'
|
|
2505
2593
|
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
2506
2594
|
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
2507
2595
|
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
@@ -2512,17 +2600,29 @@ export declare const ProductAnalyticsApiAxiosParamCreator: (configuration?: Conf
|
|
|
2512
2600
|
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
2513
2601
|
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
2514
2602
|
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
2603
|
+
* @param {string} [createdBefore] Filter to only include products created before the given date
|
|
2604
|
+
* @param {string} [createdAfter] Filter to only include products created after the given date
|
|
2605
|
+
* @param {string} [updatedBefore] Filter to only include products updated before the given date
|
|
2606
|
+
* @param {string} [updatedAfter] Filter to only include products updated after the given date
|
|
2515
2607
|
* @param {*} [options] Override http request option.
|
|
2516
2608
|
* @throws {RequiredError}
|
|
2517
2609
|
*/
|
|
2518
|
-
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>;
|
|
2610
|
+
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>;
|
|
2611
|
+
/**
|
|
2612
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
2613
|
+
* @summary Get product analytics summary
|
|
2614
|
+
* @param {string} project What project it is
|
|
2615
|
+
* @param {*} [options] Override http request option.
|
|
2616
|
+
* @throws {RequiredError}
|
|
2617
|
+
*/
|
|
2618
|
+
getProductAnalyticsSummary: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2519
2619
|
/**
|
|
2520
2620
|
* Lists all product analytics items.
|
|
2521
2621
|
* @summary List product analytics
|
|
2522
2622
|
* @param {string} project What project it is
|
|
2523
2623
|
* @param {number} [pageToken] Page reference token
|
|
2524
2624
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2525
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'
|
|
2625
|
+
* @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.\'
|
|
2526
2626
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2527
2627
|
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
2528
2628
|
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
@@ -2534,10 +2634,14 @@ export declare const ProductAnalyticsApiAxiosParamCreator: (configuration?: Conf
|
|
|
2534
2634
|
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
2535
2635
|
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
2536
2636
|
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
2637
|
+
* @param {string} [createdBefore] Filter to only include products created before the given date
|
|
2638
|
+
* @param {string} [createdAfter] Filter to only include products created after the given date
|
|
2639
|
+
* @param {string} [updatedBefore] Filter to only include products updated before the given date
|
|
2640
|
+
* @param {string} [updatedAfter] Filter to only include products updated after the given date
|
|
2537
2641
|
* @param {*} [options] Override http request option.
|
|
2538
2642
|
* @throws {RequiredError}
|
|
2539
2643
|
*/
|
|
2540
|
-
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>;
|
|
2644
|
+
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>;
|
|
2541
2645
|
};
|
|
2542
2646
|
/**
|
|
2543
2647
|
* ProductAnalyticsApi - functional programming interface
|
|
@@ -2548,7 +2652,7 @@ export declare const ProductAnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
2548
2652
|
* @summary Export product analytics
|
|
2549
2653
|
* @param {string} project What project it is
|
|
2550
2654
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2551
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'
|
|
2655
|
+
* @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.\'
|
|
2552
2656
|
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
2553
2657
|
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
2554
2658
|
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
@@ -2559,17 +2663,29 @@ export declare const ProductAnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
2559
2663
|
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
2560
2664
|
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
2561
2665
|
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
2666
|
+
* @param {string} [createdBefore] Filter to only include products created before the given date
|
|
2667
|
+
* @param {string} [createdAfter] Filter to only include products created after the given date
|
|
2668
|
+
* @param {string} [updatedBefore] Filter to only include products updated before the given date
|
|
2669
|
+
* @param {string} [updatedAfter] Filter to only include products updated after the given date
|
|
2670
|
+
* @param {*} [options] Override http request option.
|
|
2671
|
+
* @throws {RequiredError}
|
|
2672
|
+
*/
|
|
2673
|
+
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>>;
|
|
2674
|
+
/**
|
|
2675
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
2676
|
+
* @summary Get product analytics summary
|
|
2677
|
+
* @param {string} project What project it is
|
|
2562
2678
|
* @param {*} [options] Override http request option.
|
|
2563
2679
|
* @throws {RequiredError}
|
|
2564
2680
|
*/
|
|
2565
|
-
|
|
2681
|
+
getProductAnalyticsSummary(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnalyticsSummary>>;
|
|
2566
2682
|
/**
|
|
2567
2683
|
* Lists all product analytics items.
|
|
2568
2684
|
* @summary List product analytics
|
|
2569
2685
|
* @param {string} project What project it is
|
|
2570
2686
|
* @param {number} [pageToken] Page reference token
|
|
2571
2687
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2572
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'
|
|
2688
|
+
* @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.\'
|
|
2573
2689
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2574
2690
|
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
2575
2691
|
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
@@ -2581,10 +2697,14 @@ export declare const ProductAnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
2581
2697
|
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
2582
2698
|
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
2583
2699
|
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
2700
|
+
* @param {string} [createdBefore] Filter to only include products created before the given date
|
|
2701
|
+
* @param {string} [createdAfter] Filter to only include products created after the given date
|
|
2702
|
+
* @param {string} [updatedBefore] Filter to only include products updated before the given date
|
|
2703
|
+
* @param {string} [updatedAfter] Filter to only include products updated after the given date
|
|
2584
2704
|
* @param {*} [options] Override http request option.
|
|
2585
2705
|
* @throws {RequiredError}
|
|
2586
2706
|
*/
|
|
2587
|
-
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>>;
|
|
2707
|
+
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>>;
|
|
2588
2708
|
};
|
|
2589
2709
|
/**
|
|
2590
2710
|
* ProductAnalyticsApi - factory interface
|
|
@@ -2598,6 +2718,14 @@ export declare const ProductAnalyticsApiFactory: (configuration?: Configuration,
|
|
|
2598
2718
|
* @throws {RequiredError}
|
|
2599
2719
|
*/
|
|
2600
2720
|
exportProductAnalytics(requestParameters: ProductAnalyticsApiExportProductAnalyticsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
2721
|
+
/**
|
|
2722
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
2723
|
+
* @summary Get product analytics summary
|
|
2724
|
+
* @param {ProductAnalyticsApiGetProductAnalyticsSummaryRequest} requestParameters Request parameters.
|
|
2725
|
+
* @param {*} [options] Override http request option.
|
|
2726
|
+
* @throws {RequiredError}
|
|
2727
|
+
*/
|
|
2728
|
+
getProductAnalyticsSummary(requestParameters: ProductAnalyticsApiGetProductAnalyticsSummaryRequest, options?: RawAxiosRequestConfig): AxiosPromise<AnalyticsSummary>;
|
|
2601
2729
|
/**
|
|
2602
2730
|
* Lists all product analytics items.
|
|
2603
2731
|
* @summary List product analytics
|
|
@@ -2620,7 +2748,7 @@ export interface ProductAnalyticsApiExportProductAnalyticsRequest {
|
|
|
2620
2748
|
*/
|
|
2621
2749
|
readonly sortBy?: Array<string>;
|
|
2622
2750
|
/**
|
|
2623
|
-
* Search query string to filter results. Supports field-specific filters like: \'
|
|
2751
|
+
* 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
2752
|
*/
|
|
2625
2753
|
readonly search?: string;
|
|
2626
2754
|
/**
|
|
@@ -2663,6 +2791,31 @@ export interface ProductAnalyticsApiExportProductAnalyticsRequest {
|
|
|
2663
2791
|
* Filter to only include products with total traffic less than or equal to this number
|
|
2664
2792
|
*/
|
|
2665
2793
|
readonly maximumTraffic?: number;
|
|
2794
|
+
/**
|
|
2795
|
+
* Filter to only include products created before the given date
|
|
2796
|
+
*/
|
|
2797
|
+
readonly createdBefore?: string;
|
|
2798
|
+
/**
|
|
2799
|
+
* Filter to only include products created after the given date
|
|
2800
|
+
*/
|
|
2801
|
+
readonly createdAfter?: string;
|
|
2802
|
+
/**
|
|
2803
|
+
* Filter to only include products updated before the given date
|
|
2804
|
+
*/
|
|
2805
|
+
readonly updatedBefore?: string;
|
|
2806
|
+
/**
|
|
2807
|
+
* Filter to only include products updated after the given date
|
|
2808
|
+
*/
|
|
2809
|
+
readonly updatedAfter?: string;
|
|
2810
|
+
}
|
|
2811
|
+
/**
|
|
2812
|
+
* Request parameters for getProductAnalyticsSummary operation in ProductAnalyticsApi.
|
|
2813
|
+
*/
|
|
2814
|
+
export interface ProductAnalyticsApiGetProductAnalyticsSummaryRequest {
|
|
2815
|
+
/**
|
|
2816
|
+
* What project it is
|
|
2817
|
+
*/
|
|
2818
|
+
readonly project: string;
|
|
2666
2819
|
}
|
|
2667
2820
|
/**
|
|
2668
2821
|
* Request parameters for listProductAnalytics operation in ProductAnalyticsApi.
|
|
@@ -2681,7 +2834,7 @@ export interface ProductAnalyticsApiListProductAnalyticsRequest {
|
|
|
2681
2834
|
*/
|
|
2682
2835
|
readonly pageSize?: number;
|
|
2683
2836
|
/**
|
|
2684
|
-
* Search query string to filter results. Supports field-specific filters like: \'
|
|
2837
|
+
* 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.\'
|
|
2685
2838
|
*/
|
|
2686
2839
|
readonly search?: string;
|
|
2687
2840
|
/**
|
|
@@ -2728,6 +2881,22 @@ export interface ProductAnalyticsApiListProductAnalyticsRequest {
|
|
|
2728
2881
|
* Filter to only include products with total traffic less than or equal to this number
|
|
2729
2882
|
*/
|
|
2730
2883
|
readonly maximumTraffic?: number;
|
|
2884
|
+
/**
|
|
2885
|
+
* Filter to only include products created before the given date
|
|
2886
|
+
*/
|
|
2887
|
+
readonly createdBefore?: string;
|
|
2888
|
+
/**
|
|
2889
|
+
* Filter to only include products created after the given date
|
|
2890
|
+
*/
|
|
2891
|
+
readonly createdAfter?: string;
|
|
2892
|
+
/**
|
|
2893
|
+
* Filter to only include products updated before the given date
|
|
2894
|
+
*/
|
|
2895
|
+
readonly updatedBefore?: string;
|
|
2896
|
+
/**
|
|
2897
|
+
* Filter to only include products updated after the given date
|
|
2898
|
+
*/
|
|
2899
|
+
readonly updatedAfter?: string;
|
|
2731
2900
|
}
|
|
2732
2901
|
/**
|
|
2733
2902
|
* ProductAnalyticsApi - object-oriented interface
|
|
@@ -2741,6 +2910,14 @@ export declare class ProductAnalyticsApi extends BaseAPI {
|
|
|
2741
2910
|
* @throws {RequiredError}
|
|
2742
2911
|
*/
|
|
2743
2912
|
exportProductAnalytics(requestParameters: ProductAnalyticsApiExportProductAnalyticsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
|
|
2913
|
+
/**
|
|
2914
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
2915
|
+
* @summary Get product analytics summary
|
|
2916
|
+
* @param {ProductAnalyticsApiGetProductAnalyticsSummaryRequest} requestParameters Request parameters.
|
|
2917
|
+
* @param {*} [options] Override http request option.
|
|
2918
|
+
* @throws {RequiredError}
|
|
2919
|
+
*/
|
|
2920
|
+
getProductAnalyticsSummary(requestParameters: ProductAnalyticsApiGetProductAnalyticsSummaryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AnalyticsSummary, any, {}>>;
|
|
2744
2921
|
/**
|
|
2745
2922
|
* Lists all product analytics items.
|
|
2746
2923
|
* @summary List product analytics
|
|
@@ -2750,6 +2927,67 @@ export declare class ProductAnalyticsApi extends BaseAPI {
|
|
|
2750
2927
|
*/
|
|
2751
2928
|
listProductAnalytics(requestParameters: ProductAnalyticsApiListProductAnalyticsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductAnalyticsResponse, any, {}>>;
|
|
2752
2929
|
}
|
|
2930
|
+
/**
|
|
2931
|
+
* ProductCreatorsApi - axios parameter creator
|
|
2932
|
+
*/
|
|
2933
|
+
export declare const ProductCreatorsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2934
|
+
/**
|
|
2935
|
+
* Lists all the unique users that have created products for the given project.
|
|
2936
|
+
* @summary List product creators
|
|
2937
|
+
* @param {string} project What project it is
|
|
2938
|
+
* @param {*} [options] Override http request option.
|
|
2939
|
+
* @throws {RequiredError}
|
|
2940
|
+
*/
|
|
2941
|
+
listProductCreators: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2942
|
+
};
|
|
2943
|
+
/**
|
|
2944
|
+
* ProductCreatorsApi - functional programming interface
|
|
2945
|
+
*/
|
|
2946
|
+
export declare const ProductCreatorsApiFp: (configuration?: Configuration) => {
|
|
2947
|
+
/**
|
|
2948
|
+
* Lists all the unique users that have created products for the given project.
|
|
2949
|
+
* @summary List product creators
|
|
2950
|
+
* @param {string} project What project it is
|
|
2951
|
+
* @param {*} [options] Override http request option.
|
|
2952
|
+
* @throws {RequiredError}
|
|
2953
|
+
*/
|
|
2954
|
+
listProductCreators(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserList>>;
|
|
2955
|
+
};
|
|
2956
|
+
/**
|
|
2957
|
+
* ProductCreatorsApi - factory interface
|
|
2958
|
+
*/
|
|
2959
|
+
export declare const ProductCreatorsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2960
|
+
/**
|
|
2961
|
+
* Lists all the unique users that have created products for the given project.
|
|
2962
|
+
* @summary List product creators
|
|
2963
|
+
* @param {ProductCreatorsApiListProductCreatorsRequest} requestParameters Request parameters.
|
|
2964
|
+
* @param {*} [options] Override http request option.
|
|
2965
|
+
* @throws {RequiredError}
|
|
2966
|
+
*/
|
|
2967
|
+
listProductCreators(requestParameters: ProductCreatorsApiListProductCreatorsRequest, options?: RawAxiosRequestConfig): AxiosPromise<UserList>;
|
|
2968
|
+
};
|
|
2969
|
+
/**
|
|
2970
|
+
* Request parameters for listProductCreators operation in ProductCreatorsApi.
|
|
2971
|
+
*/
|
|
2972
|
+
export interface ProductCreatorsApiListProductCreatorsRequest {
|
|
2973
|
+
/**
|
|
2974
|
+
* What project it is
|
|
2975
|
+
*/
|
|
2976
|
+
readonly project: string;
|
|
2977
|
+
}
|
|
2978
|
+
/**
|
|
2979
|
+
* ProductCreatorsApi - object-oriented interface
|
|
2980
|
+
*/
|
|
2981
|
+
export declare class ProductCreatorsApi extends BaseAPI {
|
|
2982
|
+
/**
|
|
2983
|
+
* Lists all the unique users that have created products for the given project.
|
|
2984
|
+
* @summary List product creators
|
|
2985
|
+
* @param {ProductCreatorsApiListProductCreatorsRequest} requestParameters Request parameters.
|
|
2986
|
+
* @param {*} [options] Override http request option.
|
|
2987
|
+
* @throws {RequiredError}
|
|
2988
|
+
*/
|
|
2989
|
+
listProductCreators(requestParameters: ProductCreatorsApiListProductCreatorsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserList, any, {}>>;
|
|
2990
|
+
}
|
|
2753
2991
|
/**
|
|
2754
2992
|
* ProductTypesApi - axios parameter creator
|
|
2755
2993
|
*/
|