@teemill/product-catalog 1.85.0 → 1.86.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 +159 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +106 -1
- package/dist/api.js +86 -2
- 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 +106 -1
- package/dist/esm/api.js +84 -1
- 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 +55 -0
- package/docs/Recommendation.md +34 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/product-catalog@1.
|
|
1
|
+
## @teemill/product-catalog@1.86.0
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @teemill/product-catalog@1.
|
|
39
|
+
npm install @teemill/product-catalog@1.86.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -63,6 +63,7 @@ Class | Method | HTTP request | Description
|
|
|
63
63
|
*ApplicationSetsApi* | [**updateApplicationSet**](docs/ApplicationSetsApi.md#updateapplicationset) | **PATCH** /v1/catalog/applications/sets/{applicationSetId} | Update application set
|
|
64
64
|
*ApplicationTechnologiesApi* | [**listTechnologies**](docs/ApplicationTechnologiesApi.md#listtechnologies) | **GET** /v1/catalog/applications/technologies | List technologies available to this project
|
|
65
65
|
*ProductAnalyticsApi* | [**exportProductAnalytics**](docs/ProductAnalyticsApi.md#exportproductanalytics) | **GET** /v1/catalog/analytics/export | Export product analytics
|
|
66
|
+
*ProductAnalyticsApi* | [**getProductAnalyticsSummary**](docs/ProductAnalyticsApi.md#getproductanalyticssummary) | **GET** /v1/catalog/analytics/summary | Get product analytics summary
|
|
66
67
|
*ProductAnalyticsApi* | [**listProductAnalytics**](docs/ProductAnalyticsApi.md#listproductanalytics) | **GET** /v1/catalog/analytics | List product analytics
|
|
67
68
|
*ProductTypesApi* | [**listProductTypes**](docs/ProductTypesApi.md#listproducttypes) | **GET** /v1/catalog/product-types | List product types
|
|
68
69
|
*ProductsApi* | [**createProduct**](docs/ProductsApi.md#createproduct) | **POST** /v1/catalog/products | Create product
|
|
@@ -82,8 +83,10 @@ Class | Method | HTTP request | Description
|
|
|
82
83
|
|
|
83
84
|
### Documentation For Models
|
|
84
85
|
|
|
86
|
+
- [Action](docs/Action.md)
|
|
85
87
|
- [AdditionalFile](docs/AdditionalFile.md)
|
|
86
88
|
- [AnalyticsItem](docs/AnalyticsItem.md)
|
|
89
|
+
- [AnalyticsSummary](docs/AnalyticsSummary.md)
|
|
87
90
|
- [ApiError](docs/ApiError.md)
|
|
88
91
|
- [Application](docs/Application.md)
|
|
89
92
|
- [ApplicationGroup](docs/ApplicationGroup.md)
|
|
@@ -147,6 +150,7 @@ Class | Method | HTTP request | Description
|
|
|
147
150
|
- [ProductTypeListResponse](docs/ProductTypeListResponse.md)
|
|
148
151
|
- [ProductWarehouseProduct](docs/ProductWarehouseProduct.md)
|
|
149
152
|
- [ProductsResponse](docs/ProductsResponse.md)
|
|
153
|
+
- [Recommendation](docs/Recommendation.md)
|
|
150
154
|
- [RequiredPrice](docs/RequiredPrice.md)
|
|
151
155
|
- [SEOMetadata](docs/SEOMetadata.md)
|
|
152
156
|
- [SEOMetadata1](docs/SEOMetadata1.md)
|
package/api.ts
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.86.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -23,6 +23,36 @@ import type { RequestArgs } from './base';
|
|
|
23
23
|
// @ts-ignore
|
|
24
24
|
import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base';
|
|
25
25
|
|
|
26
|
+
export interface Action {
|
|
27
|
+
/**
|
|
28
|
+
* Unique object identifier
|
|
29
|
+
*/
|
|
30
|
+
'id': string;
|
|
31
|
+
/**
|
|
32
|
+
* A reference to the action resource location
|
|
33
|
+
*/
|
|
34
|
+
'ref': string;
|
|
35
|
+
/**
|
|
36
|
+
* The title of the action
|
|
37
|
+
*/
|
|
38
|
+
'title': string;
|
|
39
|
+
'impact': ActionImpactEnum;
|
|
40
|
+
/**
|
|
41
|
+
* A reference to the task resource location
|
|
42
|
+
*/
|
|
43
|
+
'taskRef': string | null;
|
|
44
|
+
'createdAt': string;
|
|
45
|
+
'updatedAt': string;
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
export const ActionImpactEnum = {
|
|
49
|
+
High: 'high',
|
|
50
|
+
Medium: 'medium',
|
|
51
|
+
Low: 'low'
|
|
52
|
+
} as const;
|
|
53
|
+
|
|
54
|
+
export type ActionImpactEnum = typeof ActionImpactEnum[keyof typeof ActionImpactEnum];
|
|
55
|
+
|
|
26
56
|
export interface AdditionalFile {
|
|
27
57
|
/**
|
|
28
58
|
* Publicly available file URL.
|
|
@@ -55,6 +85,15 @@ export interface AnalyticsItem {
|
|
|
55
85
|
*/
|
|
56
86
|
'revenue': number;
|
|
57
87
|
}
|
|
88
|
+
export interface AnalyticsSummary {
|
|
89
|
+
/**
|
|
90
|
+
* A summary of the recommendations
|
|
91
|
+
*/
|
|
92
|
+
'summary': string;
|
|
93
|
+
'recommendations': Array<Recommendation>;
|
|
94
|
+
'createdAt': string;
|
|
95
|
+
'updatedAt': string;
|
|
96
|
+
}
|
|
58
97
|
export interface ApiError {
|
|
59
98
|
'code'?: string;
|
|
60
99
|
'message': string;
|
|
@@ -1273,6 +1312,37 @@ export interface ProductsResponse {
|
|
|
1273
1312
|
*/
|
|
1274
1313
|
'nextPageToken'?: number | null;
|
|
1275
1314
|
}
|
|
1315
|
+
export interface Recommendation {
|
|
1316
|
+
/**
|
|
1317
|
+
* Unique object identifier
|
|
1318
|
+
*/
|
|
1319
|
+
'id': string;
|
|
1320
|
+
/**
|
|
1321
|
+
* A reference to the recommendation resource location
|
|
1322
|
+
*/
|
|
1323
|
+
'ref': string;
|
|
1324
|
+
/**
|
|
1325
|
+
* The reason for the recommendation
|
|
1326
|
+
*/
|
|
1327
|
+
'reason': string;
|
|
1328
|
+
/**
|
|
1329
|
+
* The recommendation for the target
|
|
1330
|
+
*/
|
|
1331
|
+
'recommendation': string;
|
|
1332
|
+
'priority': RecommendationPriorityEnum;
|
|
1333
|
+
'actions': Array<Action>;
|
|
1334
|
+
'createdAt': string;
|
|
1335
|
+
'updatedAt': string;
|
|
1336
|
+
}
|
|
1337
|
+
|
|
1338
|
+
export const RecommendationPriorityEnum = {
|
|
1339
|
+
High: 'high',
|
|
1340
|
+
Medium: 'medium',
|
|
1341
|
+
Low: 'low'
|
|
1342
|
+
} as const;
|
|
1343
|
+
|
|
1344
|
+
export type RecommendationPriorityEnum = typeof RecommendationPriorityEnum[keyof typeof RecommendationPriorityEnum];
|
|
1345
|
+
|
|
1276
1346
|
/**
|
|
1277
1347
|
* Required price definition that defines the amount and currency.
|
|
1278
1348
|
*/
|
|
@@ -3287,6 +3357,50 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration?: Co
|
|
|
3287
3357
|
options: localVarRequestOptions,
|
|
3288
3358
|
};
|
|
3289
3359
|
},
|
|
3360
|
+
/**
|
|
3361
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
3362
|
+
* @summary Get product analytics summary
|
|
3363
|
+
* @param {string} project What project it is
|
|
3364
|
+
* @param {*} [options] Override http request option.
|
|
3365
|
+
* @throws {RequiredError}
|
|
3366
|
+
*/
|
|
3367
|
+
getProductAnalyticsSummary: async (project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3368
|
+
// verify required parameter 'project' is not null or undefined
|
|
3369
|
+
assertParamExists('getProductAnalyticsSummary', 'project', project)
|
|
3370
|
+
const localVarPath = `/v1/catalog/analytics/summary`;
|
|
3371
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3372
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3373
|
+
let baseOptions;
|
|
3374
|
+
if (configuration) {
|
|
3375
|
+
baseOptions = configuration.baseOptions;
|
|
3376
|
+
}
|
|
3377
|
+
|
|
3378
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
3379
|
+
const localVarHeaderParameter = {} as any;
|
|
3380
|
+
const localVarQueryParameter = {} as any;
|
|
3381
|
+
|
|
3382
|
+
// authentication session-oauth required
|
|
3383
|
+
// oauth required
|
|
3384
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3385
|
+
|
|
3386
|
+
// authentication api-key required
|
|
3387
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3388
|
+
|
|
3389
|
+
if (project !== undefined) {
|
|
3390
|
+
localVarQueryParameter['project'] = project;
|
|
3391
|
+
}
|
|
3392
|
+
|
|
3393
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
3394
|
+
|
|
3395
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3396
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3397
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3398
|
+
|
|
3399
|
+
return {
|
|
3400
|
+
url: toPathString(localVarUrlObj),
|
|
3401
|
+
options: localVarRequestOptions,
|
|
3402
|
+
};
|
|
3403
|
+
},
|
|
3290
3404
|
/**
|
|
3291
3405
|
* Lists all product analytics items.
|
|
3292
3406
|
* @summary List product analytics
|
|
@@ -3439,6 +3553,19 @@ export const ProductAnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
3439
3553
|
const localVarOperationServerBasePath = operationServerMap['ProductAnalyticsApi.exportProductAnalytics']?.[localVarOperationServerIndex]?.url;
|
|
3440
3554
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3441
3555
|
},
|
|
3556
|
+
/**
|
|
3557
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
3558
|
+
* @summary Get product analytics summary
|
|
3559
|
+
* @param {string} project What project it is
|
|
3560
|
+
* @param {*} [options] Override http request option.
|
|
3561
|
+
* @throws {RequiredError}
|
|
3562
|
+
*/
|
|
3563
|
+
async getProductAnalyticsSummary(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnalyticsSummary>> {
|
|
3564
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getProductAnalyticsSummary(project, options);
|
|
3565
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3566
|
+
const localVarOperationServerBasePath = operationServerMap['ProductAnalyticsApi.getProductAnalyticsSummary']?.[localVarOperationServerIndex]?.url;
|
|
3567
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3568
|
+
},
|
|
3442
3569
|
/**
|
|
3443
3570
|
* Lists all product analytics items.
|
|
3444
3571
|
* @summary List product analytics
|
|
@@ -3485,6 +3612,16 @@ export const ProductAnalyticsApiFactory = function (configuration?: Configuratio
|
|
|
3485
3612
|
exportProductAnalytics(requestParameters: ProductAnalyticsApiExportProductAnalyticsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
3486
3613
|
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));
|
|
3487
3614
|
},
|
|
3615
|
+
/**
|
|
3616
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
3617
|
+
* @summary Get product analytics summary
|
|
3618
|
+
* @param {ProductAnalyticsApiGetProductAnalyticsSummaryRequest} requestParameters Request parameters.
|
|
3619
|
+
* @param {*} [options] Override http request option.
|
|
3620
|
+
* @throws {RequiredError}
|
|
3621
|
+
*/
|
|
3622
|
+
getProductAnalyticsSummary(requestParameters: ProductAnalyticsApiGetProductAnalyticsSummaryRequest, options?: RawAxiosRequestConfig): AxiosPromise<AnalyticsSummary> {
|
|
3623
|
+
return localVarFp.getProductAnalyticsSummary(requestParameters.project, options).then((request) => request(axios, basePath));
|
|
3624
|
+
},
|
|
3488
3625
|
/**
|
|
3489
3626
|
* Lists all product analytics items.
|
|
3490
3627
|
* @summary List product analytics
|
|
@@ -3568,6 +3705,16 @@ export interface ProductAnalyticsApiExportProductAnalyticsRequest {
|
|
|
3568
3705
|
readonly maximumTraffic?: number
|
|
3569
3706
|
}
|
|
3570
3707
|
|
|
3708
|
+
/**
|
|
3709
|
+
* Request parameters for getProductAnalyticsSummary operation in ProductAnalyticsApi.
|
|
3710
|
+
*/
|
|
3711
|
+
export interface ProductAnalyticsApiGetProductAnalyticsSummaryRequest {
|
|
3712
|
+
/**
|
|
3713
|
+
* What project it is
|
|
3714
|
+
*/
|
|
3715
|
+
readonly project: string
|
|
3716
|
+
}
|
|
3717
|
+
|
|
3571
3718
|
/**
|
|
3572
3719
|
* Request parameters for listProductAnalytics operation in ProductAnalyticsApi.
|
|
3573
3720
|
*/
|
|
@@ -3663,6 +3810,17 @@ export class ProductAnalyticsApi extends BaseAPI {
|
|
|
3663
3810
|
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));
|
|
3664
3811
|
}
|
|
3665
3812
|
|
|
3813
|
+
/**
|
|
3814
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
3815
|
+
* @summary Get product analytics summary
|
|
3816
|
+
* @param {ProductAnalyticsApiGetProductAnalyticsSummaryRequest} requestParameters Request parameters.
|
|
3817
|
+
* @param {*} [options] Override http request option.
|
|
3818
|
+
* @throws {RequiredError}
|
|
3819
|
+
*/
|
|
3820
|
+
public getProductAnalyticsSummary(requestParameters: ProductAnalyticsApiGetProductAnalyticsSummaryRequest, options?: RawAxiosRequestConfig) {
|
|
3821
|
+
return ProductAnalyticsApiFp(this.configuration).getProductAnalyticsSummary(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
|
|
3822
|
+
}
|
|
3823
|
+
|
|
3666
3824
|
/**
|
|
3667
3825
|
* Lists all product analytics items.
|
|
3668
3826
|
* @summary List product analytics
|
package/base.ts
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.86.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/common.ts
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.86.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
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.86.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.86.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
|
*/
|
|
@@ -2516,6 +2580,14 @@ export declare const ProductAnalyticsApiAxiosParamCreator: (configuration?: Conf
|
|
|
2516
2580
|
* @throws {RequiredError}
|
|
2517
2581
|
*/
|
|
2518
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>;
|
|
2583
|
+
/**
|
|
2584
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
2585
|
+
* @summary Get product analytics summary
|
|
2586
|
+
* @param {string} project What project it is
|
|
2587
|
+
* @param {*} [options] Override http request option.
|
|
2588
|
+
* @throws {RequiredError}
|
|
2589
|
+
*/
|
|
2590
|
+
getProductAnalyticsSummary: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2519
2591
|
/**
|
|
2520
2592
|
* Lists all product analytics items.
|
|
2521
2593
|
* @summary List product analytics
|
|
@@ -2563,6 +2635,14 @@ export declare const ProductAnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
2563
2635
|
* @throws {RequiredError}
|
|
2564
2636
|
*/
|
|
2565
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>>;
|
|
2638
|
+
/**
|
|
2639
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
2640
|
+
* @summary Get product analytics summary
|
|
2641
|
+
* @param {string} project What project it is
|
|
2642
|
+
* @param {*} [options] Override http request option.
|
|
2643
|
+
* @throws {RequiredError}
|
|
2644
|
+
*/
|
|
2645
|
+
getProductAnalyticsSummary(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnalyticsSummary>>;
|
|
2566
2646
|
/**
|
|
2567
2647
|
* Lists all product analytics items.
|
|
2568
2648
|
* @summary List product analytics
|
|
@@ -2598,6 +2678,14 @@ export declare const ProductAnalyticsApiFactory: (configuration?: Configuration,
|
|
|
2598
2678
|
* @throws {RequiredError}
|
|
2599
2679
|
*/
|
|
2600
2680
|
exportProductAnalytics(requestParameters: ProductAnalyticsApiExportProductAnalyticsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
2681
|
+
/**
|
|
2682
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
2683
|
+
* @summary Get product analytics summary
|
|
2684
|
+
* @param {ProductAnalyticsApiGetProductAnalyticsSummaryRequest} requestParameters Request parameters.
|
|
2685
|
+
* @param {*} [options] Override http request option.
|
|
2686
|
+
* @throws {RequiredError}
|
|
2687
|
+
*/
|
|
2688
|
+
getProductAnalyticsSummary(requestParameters: ProductAnalyticsApiGetProductAnalyticsSummaryRequest, options?: RawAxiosRequestConfig): AxiosPromise<AnalyticsSummary>;
|
|
2601
2689
|
/**
|
|
2602
2690
|
* Lists all product analytics items.
|
|
2603
2691
|
* @summary List product analytics
|
|
@@ -2664,6 +2752,15 @@ export interface ProductAnalyticsApiExportProductAnalyticsRequest {
|
|
|
2664
2752
|
*/
|
|
2665
2753
|
readonly maximumTraffic?: number;
|
|
2666
2754
|
}
|
|
2755
|
+
/**
|
|
2756
|
+
* Request parameters for getProductAnalyticsSummary operation in ProductAnalyticsApi.
|
|
2757
|
+
*/
|
|
2758
|
+
export interface ProductAnalyticsApiGetProductAnalyticsSummaryRequest {
|
|
2759
|
+
/**
|
|
2760
|
+
* What project it is
|
|
2761
|
+
*/
|
|
2762
|
+
readonly project: string;
|
|
2763
|
+
}
|
|
2667
2764
|
/**
|
|
2668
2765
|
* Request parameters for listProductAnalytics operation in ProductAnalyticsApi.
|
|
2669
2766
|
*/
|
|
@@ -2741,6 +2838,14 @@ export declare class ProductAnalyticsApi extends BaseAPI {
|
|
|
2741
2838
|
* @throws {RequiredError}
|
|
2742
2839
|
*/
|
|
2743
2840
|
exportProductAnalytics(requestParameters: ProductAnalyticsApiExportProductAnalyticsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
|
|
2841
|
+
/**
|
|
2842
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
2843
|
+
* @summary Get product analytics summary
|
|
2844
|
+
* @param {ProductAnalyticsApiGetProductAnalyticsSummaryRequest} requestParameters Request parameters.
|
|
2845
|
+
* @param {*} [options] Override http request option.
|
|
2846
|
+
* @throws {RequiredError}
|
|
2847
|
+
*/
|
|
2848
|
+
getProductAnalyticsSummary(requestParameters: ProductAnalyticsApiGetProductAnalyticsSummaryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AnalyticsSummary, any, {}>>;
|
|
2744
2849
|
/**
|
|
2745
2850
|
* Lists all product analytics items.
|
|
2746
2851
|
* @summary List product analytics
|
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Product Catalog API
|
|
6
6
|
* 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.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.86.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -22,13 +22,19 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.
|
|
25
|
+
exports.VariantsApiFactory = exports.VariantsApiFp = exports.VariantsApiAxiosParamCreator = exports.ListProductsDateFilterTypeEnum = exports.ExportProductsDateFilterTypeEnum = exports.ProductsApi = exports.ProductsApiFactory = exports.ProductsApiFp = exports.ProductsApiAxiosParamCreator = exports.ProductTypesApi = exports.ProductTypesApiFactory = exports.ProductTypesApiFp = exports.ProductTypesApiAxiosParamCreator = exports.ProductAnalyticsApi = exports.ProductAnalyticsApiFactory = exports.ProductAnalyticsApiFp = exports.ProductAnalyticsApiAxiosParamCreator = exports.ApplicationTechnologiesApi = exports.ApplicationTechnologiesApiFactory = exports.ApplicationTechnologiesApiFp = exports.ApplicationTechnologiesApiAxiosParamCreator = exports.ApplicationSetsApi = exports.ApplicationSetsApiFactory = exports.ApplicationSetsApiFp = exports.ApplicationSetsApiAxiosParamCreator = exports.ApplicationGroupsApi = exports.ApplicationGroupsApiFactory = exports.ApplicationGroupsApiFp = exports.ApplicationGroupsApiAxiosParamCreator = exports.UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum = exports.UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum = exports.UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum = exports.TextApplicationPropertiesPersonalizationTypeEnum = exports.TextApplicationPropertiesFontStyleEnum = exports.TextApplicationPropertiesFontWeightEnum = exports.SalePriceCurrencyCodeEnum = exports.RequiredPriceCurrencyCodeEnum = exports.RecommendationPriorityEnum = exports.PriceCurrencyCodeEnum = exports.CreateApplicationPropertiesFontStyleEnum = exports.CreateApplicationPropertiesFontWeightEnum = exports.CreateApplicationPlacementEnum = exports.CreateApplicationTechnologyEnum = exports.AttributeThumbnailTypeEnum = exports.ApplicationPropertiesPropertiesFontStyleEnum = exports.ApplicationPropertiesPropertiesFontWeightEnum = exports.ApplicationPropertiesPersonalizationRulesFitEnum = exports.ApplicationPlacementEnum = exports.ApplicationTechnologyEnum = exports.ActionImpactEnum = void 0;
|
|
26
|
+
exports.VariantsApi = void 0;
|
|
26
27
|
const axios_1 = require("axios");
|
|
27
28
|
// Some imports not used depending on template conditions
|
|
28
29
|
// @ts-ignore
|
|
29
30
|
const common_1 = require("./common");
|
|
30
31
|
// @ts-ignore
|
|
31
32
|
const base_1 = require("./base");
|
|
33
|
+
exports.ActionImpactEnum = {
|
|
34
|
+
High: 'high',
|
|
35
|
+
Medium: 'medium',
|
|
36
|
+
Low: 'low'
|
|
37
|
+
};
|
|
32
38
|
exports.ApplicationTechnologyEnum = {
|
|
33
39
|
Dtg: 'dtg',
|
|
34
40
|
Embroidery: 'embroidery',
|
|
@@ -103,6 +109,11 @@ exports.CreateApplicationPropertiesFontStyleEnum = {
|
|
|
103
109
|
exports.PriceCurrencyCodeEnum = {
|
|
104
110
|
Gbp: 'GBP'
|
|
105
111
|
};
|
|
112
|
+
exports.RecommendationPriorityEnum = {
|
|
113
|
+
High: 'high',
|
|
114
|
+
Medium: 'medium',
|
|
115
|
+
Low: 'low'
|
|
116
|
+
};
|
|
106
117
|
exports.RequiredPriceCurrencyCodeEnum = {
|
|
107
118
|
Gbp: 'GBP'
|
|
108
119
|
};
|
|
@@ -1203,6 +1214,43 @@ const ProductAnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1203
1214
|
options: localVarRequestOptions,
|
|
1204
1215
|
};
|
|
1205
1216
|
}),
|
|
1217
|
+
/**
|
|
1218
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
1219
|
+
* @summary Get product analytics summary
|
|
1220
|
+
* @param {string} project What project it is
|
|
1221
|
+
* @param {*} [options] Override http request option.
|
|
1222
|
+
* @throws {RequiredError}
|
|
1223
|
+
*/
|
|
1224
|
+
getProductAnalyticsSummary: (project_1, ...args_1) => __awaiter(this, [project_1, ...args_1], void 0, function* (project, options = {}) {
|
|
1225
|
+
// verify required parameter 'project' is not null or undefined
|
|
1226
|
+
(0, common_1.assertParamExists)('getProductAnalyticsSummary', 'project', project);
|
|
1227
|
+
const localVarPath = `/v1/catalog/analytics/summary`;
|
|
1228
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1229
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1230
|
+
let baseOptions;
|
|
1231
|
+
if (configuration) {
|
|
1232
|
+
baseOptions = configuration.baseOptions;
|
|
1233
|
+
}
|
|
1234
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1235
|
+
const localVarHeaderParameter = {};
|
|
1236
|
+
const localVarQueryParameter = {};
|
|
1237
|
+
// authentication session-oauth required
|
|
1238
|
+
// oauth required
|
|
1239
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1240
|
+
// authentication api-key required
|
|
1241
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
1242
|
+
if (project !== undefined) {
|
|
1243
|
+
localVarQueryParameter['project'] = project;
|
|
1244
|
+
}
|
|
1245
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1246
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1247
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1248
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1249
|
+
return {
|
|
1250
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1251
|
+
options: localVarRequestOptions,
|
|
1252
|
+
};
|
|
1253
|
+
}),
|
|
1206
1254
|
/**
|
|
1207
1255
|
* Lists all product analytics items.
|
|
1208
1256
|
* @summary List product analytics
|
|
@@ -1337,6 +1385,22 @@ const ProductAnalyticsApiFp = function (configuration) {
|
|
|
1337
1385
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1338
1386
|
});
|
|
1339
1387
|
},
|
|
1388
|
+
/**
|
|
1389
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
1390
|
+
* @summary Get product analytics summary
|
|
1391
|
+
* @param {string} project What project it is
|
|
1392
|
+
* @param {*} [options] Override http request option.
|
|
1393
|
+
* @throws {RequiredError}
|
|
1394
|
+
*/
|
|
1395
|
+
getProductAnalyticsSummary(project, options) {
|
|
1396
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1397
|
+
var _a, _b, _c;
|
|
1398
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getProductAnalyticsSummary(project, options);
|
|
1399
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1400
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProductAnalyticsApi.getProductAnalyticsSummary']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1401
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1402
|
+
});
|
|
1403
|
+
},
|
|
1340
1404
|
/**
|
|
1341
1405
|
* Lists all product analytics items.
|
|
1342
1406
|
* @summary List product analytics
|
|
@@ -1386,6 +1450,16 @@ const ProductAnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
1386
1450
|
exportProductAnalytics(requestParameters, options) {
|
|
1387
1451
|
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));
|
|
1388
1452
|
},
|
|
1453
|
+
/**
|
|
1454
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
1455
|
+
* @summary Get product analytics summary
|
|
1456
|
+
* @param {ProductAnalyticsApiGetProductAnalyticsSummaryRequest} requestParameters Request parameters.
|
|
1457
|
+
* @param {*} [options] Override http request option.
|
|
1458
|
+
* @throws {RequiredError}
|
|
1459
|
+
*/
|
|
1460
|
+
getProductAnalyticsSummary(requestParameters, options) {
|
|
1461
|
+
return localVarFp.getProductAnalyticsSummary(requestParameters.project, options).then((request) => request(axios, basePath));
|
|
1462
|
+
},
|
|
1389
1463
|
/**
|
|
1390
1464
|
* Lists all product analytics items.
|
|
1391
1465
|
* @summary List product analytics
|
|
@@ -1413,6 +1487,16 @@ class ProductAnalyticsApi extends base_1.BaseAPI {
|
|
|
1413
1487
|
exportProductAnalytics(requestParameters, options) {
|
|
1414
1488
|
return (0, exports.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));
|
|
1415
1489
|
}
|
|
1490
|
+
/**
|
|
1491
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
1492
|
+
* @summary Get product analytics summary
|
|
1493
|
+
* @param {ProductAnalyticsApiGetProductAnalyticsSummaryRequest} requestParameters Request parameters.
|
|
1494
|
+
* @param {*} [options] Override http request option.
|
|
1495
|
+
* @throws {RequiredError}
|
|
1496
|
+
*/
|
|
1497
|
+
getProductAnalyticsSummary(requestParameters, options) {
|
|
1498
|
+
return (0, exports.ProductAnalyticsApiFp)(this.configuration).getProductAnalyticsSummary(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
|
|
1499
|
+
}
|
|
1416
1500
|
/**
|
|
1417
1501
|
* Lists all product analytics items.
|
|
1418
1502
|
* @summary List product analytics
|
package/dist/base.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.86.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/base.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Product Catalog API
|
|
6
6
|
* 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.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.86.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.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.86.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Product Catalog API
|
|
6
6
|
* 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.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.86.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.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.86.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.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.86.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
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.86.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
|
*/
|
|
@@ -2516,6 +2580,14 @@ export declare const ProductAnalyticsApiAxiosParamCreator: (configuration?: Conf
|
|
|
2516
2580
|
* @throws {RequiredError}
|
|
2517
2581
|
*/
|
|
2518
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>;
|
|
2583
|
+
/**
|
|
2584
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
2585
|
+
* @summary Get product analytics summary
|
|
2586
|
+
* @param {string} project What project it is
|
|
2587
|
+
* @param {*} [options] Override http request option.
|
|
2588
|
+
* @throws {RequiredError}
|
|
2589
|
+
*/
|
|
2590
|
+
getProductAnalyticsSummary: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2519
2591
|
/**
|
|
2520
2592
|
* Lists all product analytics items.
|
|
2521
2593
|
* @summary List product analytics
|
|
@@ -2563,6 +2635,14 @@ export declare const ProductAnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
2563
2635
|
* @throws {RequiredError}
|
|
2564
2636
|
*/
|
|
2565
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>>;
|
|
2638
|
+
/**
|
|
2639
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
2640
|
+
* @summary Get product analytics summary
|
|
2641
|
+
* @param {string} project What project it is
|
|
2642
|
+
* @param {*} [options] Override http request option.
|
|
2643
|
+
* @throws {RequiredError}
|
|
2644
|
+
*/
|
|
2645
|
+
getProductAnalyticsSummary(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnalyticsSummary>>;
|
|
2566
2646
|
/**
|
|
2567
2647
|
* Lists all product analytics items.
|
|
2568
2648
|
* @summary List product analytics
|
|
@@ -2598,6 +2678,14 @@ export declare const ProductAnalyticsApiFactory: (configuration?: Configuration,
|
|
|
2598
2678
|
* @throws {RequiredError}
|
|
2599
2679
|
*/
|
|
2600
2680
|
exportProductAnalytics(requestParameters: ProductAnalyticsApiExportProductAnalyticsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
2681
|
+
/**
|
|
2682
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
2683
|
+
* @summary Get product analytics summary
|
|
2684
|
+
* @param {ProductAnalyticsApiGetProductAnalyticsSummaryRequest} requestParameters Request parameters.
|
|
2685
|
+
* @param {*} [options] Override http request option.
|
|
2686
|
+
* @throws {RequiredError}
|
|
2687
|
+
*/
|
|
2688
|
+
getProductAnalyticsSummary(requestParameters: ProductAnalyticsApiGetProductAnalyticsSummaryRequest, options?: RawAxiosRequestConfig): AxiosPromise<AnalyticsSummary>;
|
|
2601
2689
|
/**
|
|
2602
2690
|
* Lists all product analytics items.
|
|
2603
2691
|
* @summary List product analytics
|
|
@@ -2664,6 +2752,15 @@ export interface ProductAnalyticsApiExportProductAnalyticsRequest {
|
|
|
2664
2752
|
*/
|
|
2665
2753
|
readonly maximumTraffic?: number;
|
|
2666
2754
|
}
|
|
2755
|
+
/**
|
|
2756
|
+
* Request parameters for getProductAnalyticsSummary operation in ProductAnalyticsApi.
|
|
2757
|
+
*/
|
|
2758
|
+
export interface ProductAnalyticsApiGetProductAnalyticsSummaryRequest {
|
|
2759
|
+
/**
|
|
2760
|
+
* What project it is
|
|
2761
|
+
*/
|
|
2762
|
+
readonly project: string;
|
|
2763
|
+
}
|
|
2667
2764
|
/**
|
|
2668
2765
|
* Request parameters for listProductAnalytics operation in ProductAnalyticsApi.
|
|
2669
2766
|
*/
|
|
@@ -2741,6 +2838,14 @@ export declare class ProductAnalyticsApi extends BaseAPI {
|
|
|
2741
2838
|
* @throws {RequiredError}
|
|
2742
2839
|
*/
|
|
2743
2840
|
exportProductAnalytics(requestParameters: ProductAnalyticsApiExportProductAnalyticsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
|
|
2841
|
+
/**
|
|
2842
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
2843
|
+
* @summary Get product analytics summary
|
|
2844
|
+
* @param {ProductAnalyticsApiGetProductAnalyticsSummaryRequest} requestParameters Request parameters.
|
|
2845
|
+
* @param {*} [options] Override http request option.
|
|
2846
|
+
* @throws {RequiredError}
|
|
2847
|
+
*/
|
|
2848
|
+
getProductAnalyticsSummary(requestParameters: ProductAnalyticsApiGetProductAnalyticsSummaryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AnalyticsSummary, any, {}>>;
|
|
2744
2849
|
/**
|
|
2745
2850
|
* Lists all product analytics items.
|
|
2746
2851
|
* @summary List product analytics
|
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.86.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -26,6 +26,11 @@ import globalAxios from 'axios';
|
|
|
26
26
|
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
|
|
27
27
|
// @ts-ignore
|
|
28
28
|
import { BASE_PATH, BaseAPI, operationServerMap } from './base';
|
|
29
|
+
export const ActionImpactEnum = {
|
|
30
|
+
High: 'high',
|
|
31
|
+
Medium: 'medium',
|
|
32
|
+
Low: 'low'
|
|
33
|
+
};
|
|
29
34
|
export const ApplicationTechnologyEnum = {
|
|
30
35
|
Dtg: 'dtg',
|
|
31
36
|
Embroidery: 'embroidery',
|
|
@@ -100,6 +105,11 @@ export const CreateApplicationPropertiesFontStyleEnum = {
|
|
|
100
105
|
export const PriceCurrencyCodeEnum = {
|
|
101
106
|
Gbp: 'GBP'
|
|
102
107
|
};
|
|
108
|
+
export const RecommendationPriorityEnum = {
|
|
109
|
+
High: 'high',
|
|
110
|
+
Medium: 'medium',
|
|
111
|
+
Low: 'low'
|
|
112
|
+
};
|
|
103
113
|
export const RequiredPriceCurrencyCodeEnum = {
|
|
104
114
|
Gbp: 'GBP'
|
|
105
115
|
};
|
|
@@ -1188,6 +1198,43 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1188
1198
|
options: localVarRequestOptions,
|
|
1189
1199
|
};
|
|
1190
1200
|
}),
|
|
1201
|
+
/**
|
|
1202
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
1203
|
+
* @summary Get product analytics summary
|
|
1204
|
+
* @param {string} project What project it is
|
|
1205
|
+
* @param {*} [options] Override http request option.
|
|
1206
|
+
* @throws {RequiredError}
|
|
1207
|
+
*/
|
|
1208
|
+
getProductAnalyticsSummary: (project_1, ...args_1) => __awaiter(this, [project_1, ...args_1], void 0, function* (project, options = {}) {
|
|
1209
|
+
// verify required parameter 'project' is not null or undefined
|
|
1210
|
+
assertParamExists('getProductAnalyticsSummary', 'project', project);
|
|
1211
|
+
const localVarPath = `/v1/catalog/analytics/summary`;
|
|
1212
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1213
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1214
|
+
let baseOptions;
|
|
1215
|
+
if (configuration) {
|
|
1216
|
+
baseOptions = configuration.baseOptions;
|
|
1217
|
+
}
|
|
1218
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1219
|
+
const localVarHeaderParameter = {};
|
|
1220
|
+
const localVarQueryParameter = {};
|
|
1221
|
+
// authentication session-oauth required
|
|
1222
|
+
// oauth required
|
|
1223
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1224
|
+
// authentication api-key required
|
|
1225
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
1226
|
+
if (project !== undefined) {
|
|
1227
|
+
localVarQueryParameter['project'] = project;
|
|
1228
|
+
}
|
|
1229
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1230
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1231
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1232
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1233
|
+
return {
|
|
1234
|
+
url: toPathString(localVarUrlObj),
|
|
1235
|
+
options: localVarRequestOptions,
|
|
1236
|
+
};
|
|
1237
|
+
}),
|
|
1191
1238
|
/**
|
|
1192
1239
|
* Lists all product analytics items.
|
|
1193
1240
|
* @summary List product analytics
|
|
@@ -1321,6 +1368,22 @@ export const ProductAnalyticsApiFp = function (configuration) {
|
|
|
1321
1368
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1322
1369
|
});
|
|
1323
1370
|
},
|
|
1371
|
+
/**
|
|
1372
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
1373
|
+
* @summary Get product analytics summary
|
|
1374
|
+
* @param {string} project What project it is
|
|
1375
|
+
* @param {*} [options] Override http request option.
|
|
1376
|
+
* @throws {RequiredError}
|
|
1377
|
+
*/
|
|
1378
|
+
getProductAnalyticsSummary(project, options) {
|
|
1379
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1380
|
+
var _a, _b, _c;
|
|
1381
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getProductAnalyticsSummary(project, options);
|
|
1382
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1383
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductAnalyticsApi.getProductAnalyticsSummary']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1384
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1385
|
+
});
|
|
1386
|
+
},
|
|
1324
1387
|
/**
|
|
1325
1388
|
* Lists all product analytics items.
|
|
1326
1389
|
* @summary List product analytics
|
|
@@ -1369,6 +1432,16 @@ export const ProductAnalyticsApiFactory = function (configuration, basePath, axi
|
|
|
1369
1432
|
exportProductAnalytics(requestParameters, options) {
|
|
1370
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));
|
|
1371
1434
|
},
|
|
1435
|
+
/**
|
|
1436
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
1437
|
+
* @summary Get product analytics summary
|
|
1438
|
+
* @param {ProductAnalyticsApiGetProductAnalyticsSummaryRequest} requestParameters Request parameters.
|
|
1439
|
+
* @param {*} [options] Override http request option.
|
|
1440
|
+
* @throws {RequiredError}
|
|
1441
|
+
*/
|
|
1442
|
+
getProductAnalyticsSummary(requestParameters, options) {
|
|
1443
|
+
return localVarFp.getProductAnalyticsSummary(requestParameters.project, options).then((request) => request(axios, basePath));
|
|
1444
|
+
},
|
|
1372
1445
|
/**
|
|
1373
1446
|
* Lists all product analytics items.
|
|
1374
1447
|
* @summary List product analytics
|
|
@@ -1395,6 +1468,16 @@ export class ProductAnalyticsApi extends BaseAPI {
|
|
|
1395
1468
|
exportProductAnalytics(requestParameters, options) {
|
|
1396
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));
|
|
1397
1470
|
}
|
|
1471
|
+
/**
|
|
1472
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
1473
|
+
* @summary Get product analytics summary
|
|
1474
|
+
* @param {ProductAnalyticsApiGetProductAnalyticsSummaryRequest} requestParameters Request parameters.
|
|
1475
|
+
* @param {*} [options] Override http request option.
|
|
1476
|
+
* @throws {RequiredError}
|
|
1477
|
+
*/
|
|
1478
|
+
getProductAnalyticsSummary(requestParameters, options) {
|
|
1479
|
+
return ProductAnalyticsApiFp(this.configuration).getProductAnalyticsSummary(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
|
|
1480
|
+
}
|
|
1398
1481
|
/**
|
|
1399
1482
|
* Lists all product analytics items.
|
|
1400
1483
|
* @summary List product analytics
|
package/dist/esm/base.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.86.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/base.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.86.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.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.86.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.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.86.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -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.86.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -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.86.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/index.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.86.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/index.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.86.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.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.86.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Product Catalog API
|
|
6
6
|
* 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.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.86.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/docs/Action.md
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Action
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | Unique object identifier | [default to undefined]
|
|
9
|
+
**ref** | **string** | A reference to the action resource location | [default to undefined]
|
|
10
|
+
**title** | **string** | The title of the action | [default to undefined]
|
|
11
|
+
**impact** | **string** | | [default to undefined]
|
|
12
|
+
**taskRef** | **string** | A reference to the task resource location | [default to undefined]
|
|
13
|
+
**createdAt** | **string** | | [default to undefined]
|
|
14
|
+
**updatedAt** | **string** | | [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { Action } from '@teemill/product-catalog';
|
|
20
|
+
|
|
21
|
+
const instance: Action = {
|
|
22
|
+
id,
|
|
23
|
+
ref,
|
|
24
|
+
title,
|
|
25
|
+
impact,
|
|
26
|
+
taskRef,
|
|
27
|
+
createdAt,
|
|
28
|
+
updatedAt,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# AnalyticsSummary
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**summary** | **string** | A summary of the recommendations | [default to undefined]
|
|
9
|
+
**recommendations** | [**Array<Recommendation>**](Recommendation.md) | | [default to undefined]
|
|
10
|
+
**createdAt** | **string** | | [default to undefined]
|
|
11
|
+
**updatedAt** | **string** | | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { AnalyticsSummary } from '@teemill/product-catalog';
|
|
17
|
+
|
|
18
|
+
const instance: AnalyticsSummary = {
|
|
19
|
+
summary,
|
|
20
|
+
recommendations,
|
|
21
|
+
createdAt,
|
|
22
|
+
updatedAt,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -5,6 +5,7 @@ All URIs are relative to *https://api.podos.io*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**exportProductAnalytics**](#exportproductanalytics) | **GET** /v1/catalog/analytics/export | Export product analytics|
|
|
8
|
+
|[**getProductAnalyticsSummary**](#getproductanalyticssummary) | **GET** /v1/catalog/analytics/summary | Get product analytics summary|
|
|
8
9
|
|[**listProductAnalytics**](#listproductanalytics) | **GET** /v1/catalog/analytics | List product analytics|
|
|
9
10
|
|
|
10
11
|
# **exportProductAnalytics**
|
|
@@ -98,6 +99,60 @@ const { status, data } = await apiInstance.exportProductAnalytics(
|
|
|
98
99
|
|
|
99
100
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
100
101
|
|
|
102
|
+
# **getProductAnalyticsSummary**
|
|
103
|
+
> AnalyticsSummary getProductAnalyticsSummary()
|
|
104
|
+
|
|
105
|
+
Get the AI-generated summary of the product analytics for the given project.
|
|
106
|
+
|
|
107
|
+
### Example
|
|
108
|
+
|
|
109
|
+
```typescript
|
|
110
|
+
import {
|
|
111
|
+
ProductAnalyticsApi,
|
|
112
|
+
Configuration
|
|
113
|
+
} from '@teemill/product-catalog';
|
|
114
|
+
|
|
115
|
+
const configuration = new Configuration();
|
|
116
|
+
const apiInstance = new ProductAnalyticsApi(configuration);
|
|
117
|
+
|
|
118
|
+
let project: string; //What project it is (default to undefined)
|
|
119
|
+
|
|
120
|
+
const { status, data } = await apiInstance.getProductAnalyticsSummary(
|
|
121
|
+
project
|
|
122
|
+
);
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
### Parameters
|
|
126
|
+
|
|
127
|
+
|Name | Type | Description | Notes|
|
|
128
|
+
|------------- | ------------- | ------------- | -------------|
|
|
129
|
+
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
### Return type
|
|
133
|
+
|
|
134
|
+
**AnalyticsSummary**
|
|
135
|
+
|
|
136
|
+
### Authorization
|
|
137
|
+
|
|
138
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
139
|
+
|
|
140
|
+
### HTTP request headers
|
|
141
|
+
|
|
142
|
+
- **Content-Type**: Not defined
|
|
143
|
+
- **Accept**: application/json
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
### HTTP response details
|
|
147
|
+
| Status code | Description | Response headers |
|
|
148
|
+
|-------------|-------------|------------------|
|
|
149
|
+
|**200** | Successfully retrieved the AI-generated summary of the product analytics. | - |
|
|
150
|
+
|**401** | Not authorised to access this resource. | - |
|
|
151
|
+
|**403** | Refuse to authorize. | - |
|
|
152
|
+
|**500** | Unknown server error. | - |
|
|
153
|
+
|
|
154
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
155
|
+
|
|
101
156
|
# **listProductAnalytics**
|
|
102
157
|
> ProductAnalyticsResponse listProductAnalytics()
|
|
103
158
|
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Recommendation
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | Unique object identifier | [default to undefined]
|
|
9
|
+
**ref** | **string** | A reference to the recommendation resource location | [default to undefined]
|
|
10
|
+
**reason** | **string** | The reason for the recommendation | [default to undefined]
|
|
11
|
+
**recommendation** | **string** | The recommendation for the target | [default to undefined]
|
|
12
|
+
**priority** | **string** | | [default to undefined]
|
|
13
|
+
**actions** | [**Array<Action>**](Action.md) | | [default to undefined]
|
|
14
|
+
**createdAt** | **string** | | [default to undefined]
|
|
15
|
+
**updatedAt** | **string** | | [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { Recommendation } from '@teemill/product-catalog';
|
|
21
|
+
|
|
22
|
+
const instance: Recommendation = {
|
|
23
|
+
id,
|
|
24
|
+
ref,
|
|
25
|
+
reason,
|
|
26
|
+
recommendation,
|
|
27
|
+
priority,
|
|
28
|
+
actions,
|
|
29
|
+
createdAt,
|
|
30
|
+
updatedAt,
|
|
31
|
+
};
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/index.ts
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.86.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|