@teemill/product-catalog 1.82.0 → 1.83.1
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 +5 -2
- package/api.ts +199 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +119 -1
- package/dist/api.js +127 -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 +119 -1
- package/dist/esm/api.js +122 -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/AnalyticsItem.md +30 -0
- package/docs/Product.md +2 -0
- package/docs/ProductAnalyticsApi.md +75 -0
- package/docs/ProductAnalyticsResponse.md +20 -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.83.1
|
|
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.83.1 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -62,6 +62,7 @@ Class | Method | HTTP request | Description
|
|
|
62
62
|
*ApplicationSetsApi* | [**listApplicationSets**](docs/ApplicationSetsApi.md#listapplicationsets) | **GET** /v1/catalog/applications/sets | List application sets
|
|
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
|
+
*ProductAnalyticsApi* | [**listProductAnalytics**](docs/ProductAnalyticsApi.md#listproductanalytics) | **GET** /v1/catalog/analytics | List product analytics
|
|
65
66
|
*ProductsApi* | [**createProduct**](docs/ProductsApi.md#createproduct) | **POST** /v1/catalog/products | Create product
|
|
66
67
|
*ProductsApi* | [**deleteProduct**](docs/ProductsApi.md#deleteproduct) | **DELETE** /v1/catalog/products/{productId} | Delete catalog product
|
|
67
68
|
*ProductsApi* | [**deleteProducts**](docs/ProductsApi.md#deleteproducts) | **DELETE** /v1/catalog/products | Delete products
|
|
@@ -80,6 +81,7 @@ Class | Method | HTTP request | Description
|
|
|
80
81
|
### Documentation For Models
|
|
81
82
|
|
|
82
83
|
- [AdditionalFile](docs/AdditionalFile.md)
|
|
84
|
+
- [AnalyticsItem](docs/AnalyticsItem.md)
|
|
83
85
|
- [ApiError](docs/ApiError.md)
|
|
84
86
|
- [Application](docs/Application.md)
|
|
85
87
|
- [ApplicationGroup](docs/ApplicationGroup.md)
|
|
@@ -136,6 +138,7 @@ Class | Method | HTTP request | Description
|
|
|
136
138
|
- [Price](docs/Price.md)
|
|
137
139
|
- [Product](docs/Product.md)
|
|
138
140
|
- [ProductAdditionalFilesInner](docs/ProductAdditionalFilesInner.md)
|
|
141
|
+
- [ProductAnalyticsResponse](docs/ProductAnalyticsResponse.md)
|
|
139
142
|
- [ProductApplicationSetsInner](docs/ProductApplicationSetsInner.md)
|
|
140
143
|
- [ProductBundleItemsInner](docs/ProductBundleItemsInner.md)
|
|
141
144
|
- [ProductWarehouseProduct](docs/ProductWarehouseProduct.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.83.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -29,6 +29,32 @@ export interface AdditionalFile {
|
|
|
29
29
|
*/
|
|
30
30
|
'src'?: string;
|
|
31
31
|
}
|
|
32
|
+
export interface AnalyticsItem {
|
|
33
|
+
/**
|
|
34
|
+
* Unique object identifier
|
|
35
|
+
*/
|
|
36
|
+
'id': string;
|
|
37
|
+
/**
|
|
38
|
+
* The number of sales in the last 30 days.
|
|
39
|
+
*/
|
|
40
|
+
'sales': number;
|
|
41
|
+
/**
|
|
42
|
+
* The traffic of the product.
|
|
43
|
+
*/
|
|
44
|
+
'traffic': number;
|
|
45
|
+
/**
|
|
46
|
+
* The conversion rate of the product.
|
|
47
|
+
*/
|
|
48
|
+
'conversionRate': number;
|
|
49
|
+
/**
|
|
50
|
+
* The add to basket rate of the product.
|
|
51
|
+
*/
|
|
52
|
+
'basketRate': number;
|
|
53
|
+
/**
|
|
54
|
+
* The revenue of the product.
|
|
55
|
+
*/
|
|
56
|
+
'revenue': number;
|
|
57
|
+
}
|
|
32
58
|
export interface ApiError {
|
|
33
59
|
'code'?: string;
|
|
34
60
|
'message': string;
|
|
@@ -1097,6 +1123,10 @@ export interface Product {
|
|
|
1097
1123
|
*/
|
|
1098
1124
|
'showSaleBadge'?: boolean;
|
|
1099
1125
|
'license'?: License;
|
|
1126
|
+
/**
|
|
1127
|
+
* The user ID of the user who created the product
|
|
1128
|
+
*/
|
|
1129
|
+
'createdBy'?: string | null;
|
|
1100
1130
|
}
|
|
1101
1131
|
export interface ProductAdditionalFilesInner {
|
|
1102
1132
|
/**
|
|
@@ -1108,6 +1138,9 @@ export interface ProductAdditionalFilesInner {
|
|
|
1108
1138
|
*/
|
|
1109
1139
|
'src'?: string;
|
|
1110
1140
|
}
|
|
1141
|
+
export interface ProductAnalyticsResponse {
|
|
1142
|
+
'analytics'?: Array<AnalyticsItem>;
|
|
1143
|
+
}
|
|
1111
1144
|
export interface ProductApplicationSetsInner {
|
|
1112
1145
|
/**
|
|
1113
1146
|
* Unique object identifier
|
|
@@ -3124,6 +3157,171 @@ export class ApplicationTechnologiesApi extends BaseAPI {
|
|
|
3124
3157
|
|
|
3125
3158
|
|
|
3126
3159
|
|
|
3160
|
+
/**
|
|
3161
|
+
* ProductAnalyticsApi - axios parameter creator
|
|
3162
|
+
*/
|
|
3163
|
+
export const ProductAnalyticsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
3164
|
+
return {
|
|
3165
|
+
/**
|
|
3166
|
+
* Lists all product analytics items.
|
|
3167
|
+
* @summary List product analytics
|
|
3168
|
+
* @param {string} project What project it is
|
|
3169
|
+
* @param {number} [pageToken] Page reference token
|
|
3170
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', \'tag:\"tag name\"\', and \'type:product,template,bundle\'. Multiple filters can be combined with spaces and commas.
|
|
3171
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
3172
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3173
|
+
* @param {*} [options] Override http request option.
|
|
3174
|
+
* @throws {RequiredError}
|
|
3175
|
+
*/
|
|
3176
|
+
listProductAnalytics: async (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3177
|
+
// verify required parameter 'project' is not null or undefined
|
|
3178
|
+
assertParamExists('listProductAnalytics', 'project', project)
|
|
3179
|
+
const localVarPath = `/v1/catalog/analytics`;
|
|
3180
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3181
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3182
|
+
let baseOptions;
|
|
3183
|
+
if (configuration) {
|
|
3184
|
+
baseOptions = configuration.baseOptions;
|
|
3185
|
+
}
|
|
3186
|
+
|
|
3187
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
3188
|
+
const localVarHeaderParameter = {} as any;
|
|
3189
|
+
const localVarQueryParameter = {} as any;
|
|
3190
|
+
|
|
3191
|
+
// authentication session-oauth required
|
|
3192
|
+
// oauth required
|
|
3193
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3194
|
+
|
|
3195
|
+
// authentication api-key required
|
|
3196
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3197
|
+
|
|
3198
|
+
if (project !== undefined) {
|
|
3199
|
+
localVarQueryParameter['project'] = project;
|
|
3200
|
+
}
|
|
3201
|
+
|
|
3202
|
+
if (pageToken !== undefined) {
|
|
3203
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
3204
|
+
}
|
|
3205
|
+
|
|
3206
|
+
if (search !== undefined) {
|
|
3207
|
+
localVarQueryParameter['search'] = search;
|
|
3208
|
+
}
|
|
3209
|
+
|
|
3210
|
+
if (sortBy) {
|
|
3211
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
3212
|
+
}
|
|
3213
|
+
|
|
3214
|
+
if (pageSize !== undefined) {
|
|
3215
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
3216
|
+
}
|
|
3217
|
+
|
|
3218
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
3219
|
+
|
|
3220
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3221
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3222
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3223
|
+
|
|
3224
|
+
return {
|
|
3225
|
+
url: toPathString(localVarUrlObj),
|
|
3226
|
+
options: localVarRequestOptions,
|
|
3227
|
+
};
|
|
3228
|
+
},
|
|
3229
|
+
}
|
|
3230
|
+
};
|
|
3231
|
+
|
|
3232
|
+
/**
|
|
3233
|
+
* ProductAnalyticsApi - functional programming interface
|
|
3234
|
+
*/
|
|
3235
|
+
export const ProductAnalyticsApiFp = function(configuration?: Configuration) {
|
|
3236
|
+
const localVarAxiosParamCreator = ProductAnalyticsApiAxiosParamCreator(configuration)
|
|
3237
|
+
return {
|
|
3238
|
+
/**
|
|
3239
|
+
* Lists all product analytics items.
|
|
3240
|
+
* @summary List product analytics
|
|
3241
|
+
* @param {string} project What project it is
|
|
3242
|
+
* @param {number} [pageToken] Page reference token
|
|
3243
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', \'tag:\"tag name\"\', and \'type:product,template,bundle\'. Multiple filters can be combined with spaces and commas.
|
|
3244
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
3245
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3246
|
+
* @param {*} [options] Override http request option.
|
|
3247
|
+
* @throws {RequiredError}
|
|
3248
|
+
*/
|
|
3249
|
+
async listProductAnalytics(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductAnalyticsResponse>> {
|
|
3250
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listProductAnalytics(project, pageToken, search, sortBy, pageSize, options);
|
|
3251
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3252
|
+
const localVarOperationServerBasePath = operationServerMap['ProductAnalyticsApi.listProductAnalytics']?.[localVarOperationServerIndex]?.url;
|
|
3253
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3254
|
+
},
|
|
3255
|
+
}
|
|
3256
|
+
};
|
|
3257
|
+
|
|
3258
|
+
/**
|
|
3259
|
+
* ProductAnalyticsApi - factory interface
|
|
3260
|
+
*/
|
|
3261
|
+
export const ProductAnalyticsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
3262
|
+
const localVarFp = ProductAnalyticsApiFp(configuration)
|
|
3263
|
+
return {
|
|
3264
|
+
/**
|
|
3265
|
+
* Lists all product analytics items.
|
|
3266
|
+
* @summary List product analytics
|
|
3267
|
+
* @param {ProductAnalyticsApiListProductAnalyticsRequest} requestParameters Request parameters.
|
|
3268
|
+
* @param {*} [options] Override http request option.
|
|
3269
|
+
* @throws {RequiredError}
|
|
3270
|
+
*/
|
|
3271
|
+
listProductAnalytics(requestParameters: ProductAnalyticsApiListProductAnalyticsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductAnalyticsResponse> {
|
|
3272
|
+
return localVarFp.listProductAnalytics(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, options).then((request) => request(axios, basePath));
|
|
3273
|
+
},
|
|
3274
|
+
};
|
|
3275
|
+
};
|
|
3276
|
+
|
|
3277
|
+
/**
|
|
3278
|
+
* Request parameters for listProductAnalytics operation in ProductAnalyticsApi.
|
|
3279
|
+
*/
|
|
3280
|
+
export interface ProductAnalyticsApiListProductAnalyticsRequest {
|
|
3281
|
+
/**
|
|
3282
|
+
* What project it is
|
|
3283
|
+
*/
|
|
3284
|
+
readonly project: string
|
|
3285
|
+
|
|
3286
|
+
/**
|
|
3287
|
+
* Page reference token
|
|
3288
|
+
*/
|
|
3289
|
+
readonly pageToken?: number
|
|
3290
|
+
|
|
3291
|
+
/**
|
|
3292
|
+
* Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', \'tag:\"tag name\"\', and \'type:product,template,bundle\'. Multiple filters can be combined with spaces and commas.
|
|
3293
|
+
*/
|
|
3294
|
+
readonly search?: string
|
|
3295
|
+
|
|
3296
|
+
/**
|
|
3297
|
+
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
3298
|
+
*/
|
|
3299
|
+
readonly sortBy?: Array<string>
|
|
3300
|
+
|
|
3301
|
+
/**
|
|
3302
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3303
|
+
*/
|
|
3304
|
+
readonly pageSize?: number
|
|
3305
|
+
}
|
|
3306
|
+
|
|
3307
|
+
/**
|
|
3308
|
+
* ProductAnalyticsApi - object-oriented interface
|
|
3309
|
+
*/
|
|
3310
|
+
export class ProductAnalyticsApi extends BaseAPI {
|
|
3311
|
+
/**
|
|
3312
|
+
* Lists all product analytics items.
|
|
3313
|
+
* @summary List product analytics
|
|
3314
|
+
* @param {ProductAnalyticsApiListProductAnalyticsRequest} requestParameters Request parameters.
|
|
3315
|
+
* @param {*} [options] Override http request option.
|
|
3316
|
+
* @throws {RequiredError}
|
|
3317
|
+
*/
|
|
3318
|
+
public listProductAnalytics(requestParameters: ProductAnalyticsApiListProductAnalyticsRequest, options?: RawAxiosRequestConfig) {
|
|
3319
|
+
return ProductAnalyticsApiFp(this.configuration).listProductAnalytics(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
3320
|
+
}
|
|
3321
|
+
}
|
|
3322
|
+
|
|
3323
|
+
|
|
3324
|
+
|
|
3127
3325
|
/**
|
|
3128
3326
|
* ProductsApi - axios parameter creator
|
|
3129
3327
|
*/
|
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.83.1
|
|
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.83.1
|
|
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.83.1
|
|
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.83.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -19,6 +19,32 @@ export interface AdditionalFile {
|
|
|
19
19
|
*/
|
|
20
20
|
'src'?: string;
|
|
21
21
|
}
|
|
22
|
+
export interface AnalyticsItem {
|
|
23
|
+
/**
|
|
24
|
+
* Unique object identifier
|
|
25
|
+
*/
|
|
26
|
+
'id': string;
|
|
27
|
+
/**
|
|
28
|
+
* The number of sales in the last 30 days.
|
|
29
|
+
*/
|
|
30
|
+
'sales': number;
|
|
31
|
+
/**
|
|
32
|
+
* The traffic of the product.
|
|
33
|
+
*/
|
|
34
|
+
'traffic': number;
|
|
35
|
+
/**
|
|
36
|
+
* The conversion rate of the product.
|
|
37
|
+
*/
|
|
38
|
+
'conversionRate': number;
|
|
39
|
+
/**
|
|
40
|
+
* The add to basket rate of the product.
|
|
41
|
+
*/
|
|
42
|
+
'basketRate': number;
|
|
43
|
+
/**
|
|
44
|
+
* The revenue of the product.
|
|
45
|
+
*/
|
|
46
|
+
'revenue': number;
|
|
47
|
+
}
|
|
22
48
|
export interface ApiError {
|
|
23
49
|
'code'?: string;
|
|
24
50
|
'message': string;
|
|
@@ -1060,6 +1086,10 @@ export interface Product {
|
|
|
1060
1086
|
*/
|
|
1061
1087
|
'showSaleBadge'?: boolean;
|
|
1062
1088
|
'license'?: License;
|
|
1089
|
+
/**
|
|
1090
|
+
* The user ID of the user who created the product
|
|
1091
|
+
*/
|
|
1092
|
+
'createdBy'?: string | null;
|
|
1063
1093
|
}
|
|
1064
1094
|
export interface ProductAdditionalFilesInner {
|
|
1065
1095
|
/**
|
|
@@ -1071,6 +1101,9 @@ export interface ProductAdditionalFilesInner {
|
|
|
1071
1101
|
*/
|
|
1072
1102
|
'src'?: string;
|
|
1073
1103
|
}
|
|
1104
|
+
export interface ProductAnalyticsResponse {
|
|
1105
|
+
'analytics'?: Array<AnalyticsItem>;
|
|
1106
|
+
}
|
|
1074
1107
|
export interface ProductApplicationSetsInner {
|
|
1075
1108
|
/**
|
|
1076
1109
|
* Unique object identifier
|
|
@@ -2442,6 +2475,91 @@ export declare class ApplicationTechnologiesApi extends BaseAPI {
|
|
|
2442
2475
|
*/
|
|
2443
2476
|
listTechnologies(requestParameters: ApplicationTechnologiesApiListTechnologiesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicationTechnologiesResponse, any, {}>>;
|
|
2444
2477
|
}
|
|
2478
|
+
/**
|
|
2479
|
+
* ProductAnalyticsApi - axios parameter creator
|
|
2480
|
+
*/
|
|
2481
|
+
export declare const ProductAnalyticsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2482
|
+
/**
|
|
2483
|
+
* Lists all product analytics items.
|
|
2484
|
+
* @summary List product analytics
|
|
2485
|
+
* @param {string} project What project it is
|
|
2486
|
+
* @param {number} [pageToken] Page reference token
|
|
2487
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', \'tag:\"tag name\"\', and \'type:product,template,bundle\'. Multiple filters can be combined with spaces and commas.
|
|
2488
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2489
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2490
|
+
* @param {*} [options] Override http request option.
|
|
2491
|
+
* @throws {RequiredError}
|
|
2492
|
+
*/
|
|
2493
|
+
listProductAnalytics: (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2494
|
+
};
|
|
2495
|
+
/**
|
|
2496
|
+
* ProductAnalyticsApi - functional programming interface
|
|
2497
|
+
*/
|
|
2498
|
+
export declare const ProductAnalyticsApiFp: (configuration?: Configuration) => {
|
|
2499
|
+
/**
|
|
2500
|
+
* Lists all product analytics items.
|
|
2501
|
+
* @summary List product analytics
|
|
2502
|
+
* @param {string} project What project it is
|
|
2503
|
+
* @param {number} [pageToken] Page reference token
|
|
2504
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', \'tag:\"tag name\"\', and \'type:product,template,bundle\'. Multiple filters can be combined with spaces and commas.
|
|
2505
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2506
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2507
|
+
* @param {*} [options] Override http request option.
|
|
2508
|
+
* @throws {RequiredError}
|
|
2509
|
+
*/
|
|
2510
|
+
listProductAnalytics(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductAnalyticsResponse>>;
|
|
2511
|
+
};
|
|
2512
|
+
/**
|
|
2513
|
+
* ProductAnalyticsApi - factory interface
|
|
2514
|
+
*/
|
|
2515
|
+
export declare const ProductAnalyticsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2516
|
+
/**
|
|
2517
|
+
* Lists all product analytics items.
|
|
2518
|
+
* @summary List product analytics
|
|
2519
|
+
* @param {ProductAnalyticsApiListProductAnalyticsRequest} requestParameters Request parameters.
|
|
2520
|
+
* @param {*} [options] Override http request option.
|
|
2521
|
+
* @throws {RequiredError}
|
|
2522
|
+
*/
|
|
2523
|
+
listProductAnalytics(requestParameters: ProductAnalyticsApiListProductAnalyticsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductAnalyticsResponse>;
|
|
2524
|
+
};
|
|
2525
|
+
/**
|
|
2526
|
+
* Request parameters for listProductAnalytics operation in ProductAnalyticsApi.
|
|
2527
|
+
*/
|
|
2528
|
+
export interface ProductAnalyticsApiListProductAnalyticsRequest {
|
|
2529
|
+
/**
|
|
2530
|
+
* What project it is
|
|
2531
|
+
*/
|
|
2532
|
+
readonly project: string;
|
|
2533
|
+
/**
|
|
2534
|
+
* Page reference token
|
|
2535
|
+
*/
|
|
2536
|
+
readonly pageToken?: number;
|
|
2537
|
+
/**
|
|
2538
|
+
* Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', \'tag:\"tag name\"\', and \'type:product,template,bundle\'. Multiple filters can be combined with spaces and commas.
|
|
2539
|
+
*/
|
|
2540
|
+
readonly search?: string;
|
|
2541
|
+
/**
|
|
2542
|
+
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2543
|
+
*/
|
|
2544
|
+
readonly sortBy?: Array<string>;
|
|
2545
|
+
/**
|
|
2546
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2547
|
+
*/
|
|
2548
|
+
readonly pageSize?: number;
|
|
2549
|
+
}
|
|
2550
|
+
/**
|
|
2551
|
+
* ProductAnalyticsApi - object-oriented interface
|
|
2552
|
+
*/
|
|
2553
|
+
export declare class ProductAnalyticsApi extends BaseAPI {
|
|
2554
|
+
/**
|
|
2555
|
+
* Lists all product analytics items.
|
|
2556
|
+
* @summary List product analytics
|
|
2557
|
+
* @param {ProductAnalyticsApiListProductAnalyticsRequest} requestParameters Request parameters.
|
|
2558
|
+
* @param {*} [options] Override http request option.
|
|
2559
|
+
* @throws {RequiredError}
|
|
2560
|
+
*/
|
|
2561
|
+
listProductAnalytics(requestParameters: ProductAnalyticsApiListProductAnalyticsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductAnalyticsResponse, any, {}>>;
|
|
2562
|
+
}
|
|
2445
2563
|
/**
|
|
2446
2564
|
* ProductsApi - axios parameter creator
|
|
2447
2565
|
*/
|
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.83.1
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.VariantsApi = exports.VariantsApiFactory = exports.VariantsApiFp = exports.VariantsApiAxiosParamCreator = exports.ListProductsDateFilterTypeEnum = exports.ProductsApi = exports.ProductsApiFactory = exports.ProductsApiFp = exports.ProductsApiAxiosParamCreator = 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.PriceCurrencyCodeEnum = exports.CreateApplicationPropertiesFontStyleEnum = exports.CreateApplicationPropertiesFontWeightEnum = exports.CreateApplicationPlacementEnum = exports.CreateApplicationTechnologyEnum = exports.AttributeThumbnailTypeEnum = exports.ApplicationPropertiesPropertiesFontStyleEnum = exports.ApplicationPropertiesPropertiesFontWeightEnum = exports.ApplicationPropertiesPersonalizationRulesFitEnum = exports.ApplicationPlacementEnum = exports.ApplicationTechnologyEnum = void 0;
|
|
25
|
+
exports.VariantsApi = exports.VariantsApiFactory = exports.VariantsApiFp = exports.VariantsApiAxiosParamCreator = exports.ListProductsDateFilterTypeEnum = exports.ProductsApi = exports.ProductsApiFactory = exports.ProductsApiFp = exports.ProductsApiAxiosParamCreator = 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.PriceCurrencyCodeEnum = exports.CreateApplicationPropertiesFontStyleEnum = exports.CreateApplicationPropertiesFontWeightEnum = exports.CreateApplicationPlacementEnum = exports.CreateApplicationTechnologyEnum = exports.AttributeThumbnailTypeEnum = exports.ApplicationPropertiesPropertiesFontStyleEnum = exports.ApplicationPropertiesPropertiesFontWeightEnum = exports.ApplicationPropertiesPersonalizationRulesFitEnum = exports.ApplicationPlacementEnum = exports.ApplicationTechnologyEnum = void 0;
|
|
26
26
|
const axios_1 = require("axios");
|
|
27
27
|
// Some imports not used depending on template conditions
|
|
28
28
|
// @ts-ignore
|
|
@@ -1109,6 +1109,131 @@ class ApplicationTechnologiesApi extends base_1.BaseAPI {
|
|
|
1109
1109
|
}
|
|
1110
1110
|
}
|
|
1111
1111
|
exports.ApplicationTechnologiesApi = ApplicationTechnologiesApi;
|
|
1112
|
+
/**
|
|
1113
|
+
* ProductAnalyticsApi - axios parameter creator
|
|
1114
|
+
*/
|
|
1115
|
+
const ProductAnalyticsApiAxiosParamCreator = function (configuration) {
|
|
1116
|
+
return {
|
|
1117
|
+
/**
|
|
1118
|
+
* Lists all product analytics items.
|
|
1119
|
+
* @summary List product analytics
|
|
1120
|
+
* @param {string} project What project it is
|
|
1121
|
+
* @param {number} [pageToken] Page reference token
|
|
1122
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', \'tag:\"tag name\"\', and \'type:product,template,bundle\'. Multiple filters can be combined with spaces and commas.
|
|
1123
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1124
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1125
|
+
* @param {*} [options] Override http request option.
|
|
1126
|
+
* @throws {RequiredError}
|
|
1127
|
+
*/
|
|
1128
|
+
listProductAnalytics: (project_1, pageToken_1, search_1, sortBy_1, pageSize_1, ...args_1) => __awaiter(this, [project_1, pageToken_1, search_1, sortBy_1, pageSize_1, ...args_1], void 0, function* (project, pageToken, search, sortBy, pageSize, options = {}) {
|
|
1129
|
+
// verify required parameter 'project' is not null or undefined
|
|
1130
|
+
(0, common_1.assertParamExists)('listProductAnalytics', 'project', project);
|
|
1131
|
+
const localVarPath = `/v1/catalog/analytics`;
|
|
1132
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1133
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1134
|
+
let baseOptions;
|
|
1135
|
+
if (configuration) {
|
|
1136
|
+
baseOptions = configuration.baseOptions;
|
|
1137
|
+
}
|
|
1138
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1139
|
+
const localVarHeaderParameter = {};
|
|
1140
|
+
const localVarQueryParameter = {};
|
|
1141
|
+
// authentication session-oauth required
|
|
1142
|
+
// oauth required
|
|
1143
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1144
|
+
// authentication api-key required
|
|
1145
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
1146
|
+
if (project !== undefined) {
|
|
1147
|
+
localVarQueryParameter['project'] = project;
|
|
1148
|
+
}
|
|
1149
|
+
if (pageToken !== undefined) {
|
|
1150
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
1151
|
+
}
|
|
1152
|
+
if (search !== undefined) {
|
|
1153
|
+
localVarQueryParameter['search'] = search;
|
|
1154
|
+
}
|
|
1155
|
+
if (sortBy) {
|
|
1156
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
1157
|
+
}
|
|
1158
|
+
if (pageSize !== undefined) {
|
|
1159
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
1160
|
+
}
|
|
1161
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1162
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1163
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1164
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1165
|
+
return {
|
|
1166
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1167
|
+
options: localVarRequestOptions,
|
|
1168
|
+
};
|
|
1169
|
+
}),
|
|
1170
|
+
};
|
|
1171
|
+
};
|
|
1172
|
+
exports.ProductAnalyticsApiAxiosParamCreator = ProductAnalyticsApiAxiosParamCreator;
|
|
1173
|
+
/**
|
|
1174
|
+
* ProductAnalyticsApi - functional programming interface
|
|
1175
|
+
*/
|
|
1176
|
+
const ProductAnalyticsApiFp = function (configuration) {
|
|
1177
|
+
const localVarAxiosParamCreator = (0, exports.ProductAnalyticsApiAxiosParamCreator)(configuration);
|
|
1178
|
+
return {
|
|
1179
|
+
/**
|
|
1180
|
+
* Lists all product analytics items.
|
|
1181
|
+
* @summary List product analytics
|
|
1182
|
+
* @param {string} project What project it is
|
|
1183
|
+
* @param {number} [pageToken] Page reference token
|
|
1184
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', \'tag:\"tag name\"\', and \'type:product,template,bundle\'. Multiple filters can be combined with spaces and commas.
|
|
1185
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1186
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1187
|
+
* @param {*} [options] Override http request option.
|
|
1188
|
+
* @throws {RequiredError}
|
|
1189
|
+
*/
|
|
1190
|
+
listProductAnalytics(project, pageToken, search, sortBy, pageSize, options) {
|
|
1191
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1192
|
+
var _a, _b, _c;
|
|
1193
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listProductAnalytics(project, pageToken, search, sortBy, pageSize, options);
|
|
1194
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1195
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProductAnalyticsApi.listProductAnalytics']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1196
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1197
|
+
});
|
|
1198
|
+
},
|
|
1199
|
+
};
|
|
1200
|
+
};
|
|
1201
|
+
exports.ProductAnalyticsApiFp = ProductAnalyticsApiFp;
|
|
1202
|
+
/**
|
|
1203
|
+
* ProductAnalyticsApi - factory interface
|
|
1204
|
+
*/
|
|
1205
|
+
const ProductAnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
1206
|
+
const localVarFp = (0, exports.ProductAnalyticsApiFp)(configuration);
|
|
1207
|
+
return {
|
|
1208
|
+
/**
|
|
1209
|
+
* Lists all product analytics items.
|
|
1210
|
+
* @summary List product analytics
|
|
1211
|
+
* @param {ProductAnalyticsApiListProductAnalyticsRequest} requestParameters Request parameters.
|
|
1212
|
+
* @param {*} [options] Override http request option.
|
|
1213
|
+
* @throws {RequiredError}
|
|
1214
|
+
*/
|
|
1215
|
+
listProductAnalytics(requestParameters, options) {
|
|
1216
|
+
return localVarFp.listProductAnalytics(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, options).then((request) => request(axios, basePath));
|
|
1217
|
+
},
|
|
1218
|
+
};
|
|
1219
|
+
};
|
|
1220
|
+
exports.ProductAnalyticsApiFactory = ProductAnalyticsApiFactory;
|
|
1221
|
+
/**
|
|
1222
|
+
* ProductAnalyticsApi - object-oriented interface
|
|
1223
|
+
*/
|
|
1224
|
+
class ProductAnalyticsApi extends base_1.BaseAPI {
|
|
1225
|
+
/**
|
|
1226
|
+
* Lists all product analytics items.
|
|
1227
|
+
* @summary List product analytics
|
|
1228
|
+
* @param {ProductAnalyticsApiListProductAnalyticsRequest} requestParameters Request parameters.
|
|
1229
|
+
* @param {*} [options] Override http request option.
|
|
1230
|
+
* @throws {RequiredError}
|
|
1231
|
+
*/
|
|
1232
|
+
listProductAnalytics(requestParameters, options) {
|
|
1233
|
+
return (0, exports.ProductAnalyticsApiFp)(this.configuration).listProductAnalytics(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
1234
|
+
}
|
|
1235
|
+
}
|
|
1236
|
+
exports.ProductAnalyticsApi = ProductAnalyticsApi;
|
|
1112
1237
|
/**
|
|
1113
1238
|
* ProductsApi - axios parameter creator
|
|
1114
1239
|
*/
|
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.83.1
|
|
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.83.1
|
|
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.83.1
|
|
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.83.1
|
|
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.83.1
|
|
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.83.1
|
|
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.83.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -19,6 +19,32 @@ export interface AdditionalFile {
|
|
|
19
19
|
*/
|
|
20
20
|
'src'?: string;
|
|
21
21
|
}
|
|
22
|
+
export interface AnalyticsItem {
|
|
23
|
+
/**
|
|
24
|
+
* Unique object identifier
|
|
25
|
+
*/
|
|
26
|
+
'id': string;
|
|
27
|
+
/**
|
|
28
|
+
* The number of sales in the last 30 days.
|
|
29
|
+
*/
|
|
30
|
+
'sales': number;
|
|
31
|
+
/**
|
|
32
|
+
* The traffic of the product.
|
|
33
|
+
*/
|
|
34
|
+
'traffic': number;
|
|
35
|
+
/**
|
|
36
|
+
* The conversion rate of the product.
|
|
37
|
+
*/
|
|
38
|
+
'conversionRate': number;
|
|
39
|
+
/**
|
|
40
|
+
* The add to basket rate of the product.
|
|
41
|
+
*/
|
|
42
|
+
'basketRate': number;
|
|
43
|
+
/**
|
|
44
|
+
* The revenue of the product.
|
|
45
|
+
*/
|
|
46
|
+
'revenue': number;
|
|
47
|
+
}
|
|
22
48
|
export interface ApiError {
|
|
23
49
|
'code'?: string;
|
|
24
50
|
'message': string;
|
|
@@ -1060,6 +1086,10 @@ export interface Product {
|
|
|
1060
1086
|
*/
|
|
1061
1087
|
'showSaleBadge'?: boolean;
|
|
1062
1088
|
'license'?: License;
|
|
1089
|
+
/**
|
|
1090
|
+
* The user ID of the user who created the product
|
|
1091
|
+
*/
|
|
1092
|
+
'createdBy'?: string | null;
|
|
1063
1093
|
}
|
|
1064
1094
|
export interface ProductAdditionalFilesInner {
|
|
1065
1095
|
/**
|
|
@@ -1071,6 +1101,9 @@ export interface ProductAdditionalFilesInner {
|
|
|
1071
1101
|
*/
|
|
1072
1102
|
'src'?: string;
|
|
1073
1103
|
}
|
|
1104
|
+
export interface ProductAnalyticsResponse {
|
|
1105
|
+
'analytics'?: Array<AnalyticsItem>;
|
|
1106
|
+
}
|
|
1074
1107
|
export interface ProductApplicationSetsInner {
|
|
1075
1108
|
/**
|
|
1076
1109
|
* Unique object identifier
|
|
@@ -2442,6 +2475,91 @@ export declare class ApplicationTechnologiesApi extends BaseAPI {
|
|
|
2442
2475
|
*/
|
|
2443
2476
|
listTechnologies(requestParameters: ApplicationTechnologiesApiListTechnologiesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicationTechnologiesResponse, any, {}>>;
|
|
2444
2477
|
}
|
|
2478
|
+
/**
|
|
2479
|
+
* ProductAnalyticsApi - axios parameter creator
|
|
2480
|
+
*/
|
|
2481
|
+
export declare const ProductAnalyticsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2482
|
+
/**
|
|
2483
|
+
* Lists all product analytics items.
|
|
2484
|
+
* @summary List product analytics
|
|
2485
|
+
* @param {string} project What project it is
|
|
2486
|
+
* @param {number} [pageToken] Page reference token
|
|
2487
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', \'tag:\"tag name\"\', and \'type:product,template,bundle\'. Multiple filters can be combined with spaces and commas.
|
|
2488
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2489
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2490
|
+
* @param {*} [options] Override http request option.
|
|
2491
|
+
* @throws {RequiredError}
|
|
2492
|
+
*/
|
|
2493
|
+
listProductAnalytics: (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2494
|
+
};
|
|
2495
|
+
/**
|
|
2496
|
+
* ProductAnalyticsApi - functional programming interface
|
|
2497
|
+
*/
|
|
2498
|
+
export declare const ProductAnalyticsApiFp: (configuration?: Configuration) => {
|
|
2499
|
+
/**
|
|
2500
|
+
* Lists all product analytics items.
|
|
2501
|
+
* @summary List product analytics
|
|
2502
|
+
* @param {string} project What project it is
|
|
2503
|
+
* @param {number} [pageToken] Page reference token
|
|
2504
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', \'tag:\"tag name\"\', and \'type:product,template,bundle\'. Multiple filters can be combined with spaces and commas.
|
|
2505
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2506
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2507
|
+
* @param {*} [options] Override http request option.
|
|
2508
|
+
* @throws {RequiredError}
|
|
2509
|
+
*/
|
|
2510
|
+
listProductAnalytics(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductAnalyticsResponse>>;
|
|
2511
|
+
};
|
|
2512
|
+
/**
|
|
2513
|
+
* ProductAnalyticsApi - factory interface
|
|
2514
|
+
*/
|
|
2515
|
+
export declare const ProductAnalyticsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2516
|
+
/**
|
|
2517
|
+
* Lists all product analytics items.
|
|
2518
|
+
* @summary List product analytics
|
|
2519
|
+
* @param {ProductAnalyticsApiListProductAnalyticsRequest} requestParameters Request parameters.
|
|
2520
|
+
* @param {*} [options] Override http request option.
|
|
2521
|
+
* @throws {RequiredError}
|
|
2522
|
+
*/
|
|
2523
|
+
listProductAnalytics(requestParameters: ProductAnalyticsApiListProductAnalyticsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductAnalyticsResponse>;
|
|
2524
|
+
};
|
|
2525
|
+
/**
|
|
2526
|
+
* Request parameters for listProductAnalytics operation in ProductAnalyticsApi.
|
|
2527
|
+
*/
|
|
2528
|
+
export interface ProductAnalyticsApiListProductAnalyticsRequest {
|
|
2529
|
+
/**
|
|
2530
|
+
* What project it is
|
|
2531
|
+
*/
|
|
2532
|
+
readonly project: string;
|
|
2533
|
+
/**
|
|
2534
|
+
* Page reference token
|
|
2535
|
+
*/
|
|
2536
|
+
readonly pageToken?: number;
|
|
2537
|
+
/**
|
|
2538
|
+
* Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', \'tag:\"tag name\"\', and \'type:product,template,bundle\'. Multiple filters can be combined with spaces and commas.
|
|
2539
|
+
*/
|
|
2540
|
+
readonly search?: string;
|
|
2541
|
+
/**
|
|
2542
|
+
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2543
|
+
*/
|
|
2544
|
+
readonly sortBy?: Array<string>;
|
|
2545
|
+
/**
|
|
2546
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2547
|
+
*/
|
|
2548
|
+
readonly pageSize?: number;
|
|
2549
|
+
}
|
|
2550
|
+
/**
|
|
2551
|
+
* ProductAnalyticsApi - object-oriented interface
|
|
2552
|
+
*/
|
|
2553
|
+
export declare class ProductAnalyticsApi extends BaseAPI {
|
|
2554
|
+
/**
|
|
2555
|
+
* Lists all product analytics items.
|
|
2556
|
+
* @summary List product analytics
|
|
2557
|
+
* @param {ProductAnalyticsApiListProductAnalyticsRequest} requestParameters Request parameters.
|
|
2558
|
+
* @param {*} [options] Override http request option.
|
|
2559
|
+
* @throws {RequiredError}
|
|
2560
|
+
*/
|
|
2561
|
+
listProductAnalytics(requestParameters: ProductAnalyticsApiListProductAnalyticsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductAnalyticsResponse, any, {}>>;
|
|
2562
|
+
}
|
|
2445
2563
|
/**
|
|
2446
2564
|
* ProductsApi - axios parameter creator
|
|
2447
2565
|
*/
|
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.83.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1094,6 +1094,127 @@ export class ApplicationTechnologiesApi extends BaseAPI {
|
|
|
1094
1094
|
return ApplicationTechnologiesApiFp(this.configuration).listTechnologies(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
|
|
1095
1095
|
}
|
|
1096
1096
|
}
|
|
1097
|
+
/**
|
|
1098
|
+
* ProductAnalyticsApi - axios parameter creator
|
|
1099
|
+
*/
|
|
1100
|
+
export const ProductAnalyticsApiAxiosParamCreator = function (configuration) {
|
|
1101
|
+
return {
|
|
1102
|
+
/**
|
|
1103
|
+
* Lists all product analytics items.
|
|
1104
|
+
* @summary List product analytics
|
|
1105
|
+
* @param {string} project What project it is
|
|
1106
|
+
* @param {number} [pageToken] Page reference token
|
|
1107
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', \'tag:\"tag name\"\', and \'type:product,template,bundle\'. Multiple filters can be combined with spaces and commas.
|
|
1108
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1109
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1110
|
+
* @param {*} [options] Override http request option.
|
|
1111
|
+
* @throws {RequiredError}
|
|
1112
|
+
*/
|
|
1113
|
+
listProductAnalytics: (project_1, pageToken_1, search_1, sortBy_1, pageSize_1, ...args_1) => __awaiter(this, [project_1, pageToken_1, search_1, sortBy_1, pageSize_1, ...args_1], void 0, function* (project, pageToken, search, sortBy, pageSize, options = {}) {
|
|
1114
|
+
// verify required parameter 'project' is not null or undefined
|
|
1115
|
+
assertParamExists('listProductAnalytics', 'project', project);
|
|
1116
|
+
const localVarPath = `/v1/catalog/analytics`;
|
|
1117
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1118
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1119
|
+
let baseOptions;
|
|
1120
|
+
if (configuration) {
|
|
1121
|
+
baseOptions = configuration.baseOptions;
|
|
1122
|
+
}
|
|
1123
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1124
|
+
const localVarHeaderParameter = {};
|
|
1125
|
+
const localVarQueryParameter = {};
|
|
1126
|
+
// authentication session-oauth required
|
|
1127
|
+
// oauth required
|
|
1128
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1129
|
+
// authentication api-key required
|
|
1130
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
1131
|
+
if (project !== undefined) {
|
|
1132
|
+
localVarQueryParameter['project'] = project;
|
|
1133
|
+
}
|
|
1134
|
+
if (pageToken !== undefined) {
|
|
1135
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
1136
|
+
}
|
|
1137
|
+
if (search !== undefined) {
|
|
1138
|
+
localVarQueryParameter['search'] = search;
|
|
1139
|
+
}
|
|
1140
|
+
if (sortBy) {
|
|
1141
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
1142
|
+
}
|
|
1143
|
+
if (pageSize !== undefined) {
|
|
1144
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
1145
|
+
}
|
|
1146
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1147
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1148
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1149
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1150
|
+
return {
|
|
1151
|
+
url: toPathString(localVarUrlObj),
|
|
1152
|
+
options: localVarRequestOptions,
|
|
1153
|
+
};
|
|
1154
|
+
}),
|
|
1155
|
+
};
|
|
1156
|
+
};
|
|
1157
|
+
/**
|
|
1158
|
+
* ProductAnalyticsApi - functional programming interface
|
|
1159
|
+
*/
|
|
1160
|
+
export const ProductAnalyticsApiFp = function (configuration) {
|
|
1161
|
+
const localVarAxiosParamCreator = ProductAnalyticsApiAxiosParamCreator(configuration);
|
|
1162
|
+
return {
|
|
1163
|
+
/**
|
|
1164
|
+
* Lists all product analytics items.
|
|
1165
|
+
* @summary List product analytics
|
|
1166
|
+
* @param {string} project What project it is
|
|
1167
|
+
* @param {number} [pageToken] Page reference token
|
|
1168
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', \'tag:\"tag name\"\', and \'type:product,template,bundle\'. Multiple filters can be combined with spaces and commas.
|
|
1169
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1170
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1171
|
+
* @param {*} [options] Override http request option.
|
|
1172
|
+
* @throws {RequiredError}
|
|
1173
|
+
*/
|
|
1174
|
+
listProductAnalytics(project, pageToken, search, sortBy, pageSize, options) {
|
|
1175
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1176
|
+
var _a, _b, _c;
|
|
1177
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listProductAnalytics(project, pageToken, search, sortBy, pageSize, options);
|
|
1178
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1179
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductAnalyticsApi.listProductAnalytics']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1180
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1181
|
+
});
|
|
1182
|
+
},
|
|
1183
|
+
};
|
|
1184
|
+
};
|
|
1185
|
+
/**
|
|
1186
|
+
* ProductAnalyticsApi - factory interface
|
|
1187
|
+
*/
|
|
1188
|
+
export const ProductAnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
1189
|
+
const localVarFp = ProductAnalyticsApiFp(configuration);
|
|
1190
|
+
return {
|
|
1191
|
+
/**
|
|
1192
|
+
* Lists all product analytics items.
|
|
1193
|
+
* @summary List product analytics
|
|
1194
|
+
* @param {ProductAnalyticsApiListProductAnalyticsRequest} requestParameters Request parameters.
|
|
1195
|
+
* @param {*} [options] Override http request option.
|
|
1196
|
+
* @throws {RequiredError}
|
|
1197
|
+
*/
|
|
1198
|
+
listProductAnalytics(requestParameters, options) {
|
|
1199
|
+
return localVarFp.listProductAnalytics(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, options).then((request) => request(axios, basePath));
|
|
1200
|
+
},
|
|
1201
|
+
};
|
|
1202
|
+
};
|
|
1203
|
+
/**
|
|
1204
|
+
* ProductAnalyticsApi - object-oriented interface
|
|
1205
|
+
*/
|
|
1206
|
+
export class ProductAnalyticsApi extends BaseAPI {
|
|
1207
|
+
/**
|
|
1208
|
+
* Lists all product analytics items.
|
|
1209
|
+
* @summary List product analytics
|
|
1210
|
+
* @param {ProductAnalyticsApiListProductAnalyticsRequest} requestParameters Request parameters.
|
|
1211
|
+
* @param {*} [options] Override http request option.
|
|
1212
|
+
* @throws {RequiredError}
|
|
1213
|
+
*/
|
|
1214
|
+
listProductAnalytics(requestParameters, options) {
|
|
1215
|
+
return ProductAnalyticsApiFp(this.configuration).listProductAnalytics(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
1216
|
+
}
|
|
1217
|
+
}
|
|
1097
1218
|
/**
|
|
1098
1219
|
* ProductsApi - axios parameter creator
|
|
1099
1220
|
*/
|
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.83.1
|
|
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.83.1
|
|
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.83.1
|
|
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.83.1
|
|
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.83.1
|
|
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.83.1
|
|
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.83.1
|
|
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.83.1
|
|
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.83.1
|
|
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.83.1
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# AnalyticsItem
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | Unique object identifier | [default to undefined]
|
|
9
|
+
**sales** | **number** | The number of sales in the last 30 days. | [default to undefined]
|
|
10
|
+
**traffic** | **number** | The traffic of the product. | [default to undefined]
|
|
11
|
+
**conversionRate** | **number** | The conversion rate of the product. | [default to undefined]
|
|
12
|
+
**basketRate** | **number** | The add to basket rate of the product. | [default to undefined]
|
|
13
|
+
**revenue** | **number** | The revenue of the product. | [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { AnalyticsItem } from '@teemill/product-catalog';
|
|
19
|
+
|
|
20
|
+
const instance: AnalyticsItem = {
|
|
21
|
+
id,
|
|
22
|
+
sales,
|
|
23
|
+
traffic,
|
|
24
|
+
conversionRate,
|
|
25
|
+
basketRate,
|
|
26
|
+
revenue,
|
|
27
|
+
};
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
[[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/docs/Product.md
CHANGED
|
@@ -42,6 +42,7 @@ Name | Type | Description | Notes
|
|
|
42
42
|
**integrationConnections** | [**Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>**](UpdateProductsRequestProductsInnerIntegrationConnectionsInner.md) | | [optional] [default to undefined]
|
|
43
43
|
**showSaleBadge** | **boolean** | Whether to show a sale badge on the product | [optional] [default to undefined]
|
|
44
44
|
**license** | [**License**](License.md) | | [optional] [default to undefined]
|
|
45
|
+
**createdBy** | **string** | The user ID of the user who created the product | [optional] [default to undefined]
|
|
45
46
|
|
|
46
47
|
## Example
|
|
47
48
|
|
|
@@ -86,6 +87,7 @@ const instance: Product = {
|
|
|
86
87
|
integrationConnections,
|
|
87
88
|
showSaleBadge,
|
|
88
89
|
license,
|
|
90
|
+
createdBy,
|
|
89
91
|
};
|
|
90
92
|
```
|
|
91
93
|
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
# ProductAnalyticsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.podos.io*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**listProductAnalytics**](#listproductanalytics) | **GET** /v1/catalog/analytics | List product analytics|
|
|
8
|
+
|
|
9
|
+
# **listProductAnalytics**
|
|
10
|
+
> ProductAnalyticsResponse listProductAnalytics()
|
|
11
|
+
|
|
12
|
+
Lists all product analytics items.
|
|
13
|
+
|
|
14
|
+
### Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import {
|
|
18
|
+
ProductAnalyticsApi,
|
|
19
|
+
Configuration
|
|
20
|
+
} from '@teemill/product-catalog';
|
|
21
|
+
|
|
22
|
+
const configuration = new Configuration();
|
|
23
|
+
const apiInstance = new ProductAnalyticsApi(configuration);
|
|
24
|
+
|
|
25
|
+
let project: string; //What project it is (default to undefined)
|
|
26
|
+
let pageToken: number; //Page reference token (optional) (default to 1)
|
|
27
|
+
let search: string; //Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', \'tag:\"tag name\"\', and \'type:product,template,bundle\'. Multiple filters can be combined with spaces and commas. (optional) (default to 'enabled:true')
|
|
28
|
+
let sortBy: Array<string>; //An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending. (optional) (default to undefined)
|
|
29
|
+
let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 100)
|
|
30
|
+
|
|
31
|
+
const { status, data } = await apiInstance.listProductAnalytics(
|
|
32
|
+
project,
|
|
33
|
+
pageToken,
|
|
34
|
+
search,
|
|
35
|
+
sortBy,
|
|
36
|
+
pageSize
|
|
37
|
+
);
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### Parameters
|
|
41
|
+
|
|
42
|
+
|Name | Type | Description | Notes|
|
|
43
|
+
|------------- | ------------- | ------------- | -------------|
|
|
44
|
+
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
45
|
+
| **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
|
|
46
|
+
| **search** | [**string**] | Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', \'tag:\"tag name\"\', and \'type:product,template,bundle\'. Multiple filters can be combined with spaces and commas. | (optional) defaults to 'enabled:true'|
|
|
47
|
+
| **sortBy** | **Array<string>** | An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending. | (optional) defaults to undefined|
|
|
48
|
+
| **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
### Return type
|
|
52
|
+
|
|
53
|
+
**ProductAnalyticsResponse**
|
|
54
|
+
|
|
55
|
+
### Authorization
|
|
56
|
+
|
|
57
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
58
|
+
|
|
59
|
+
### HTTP request headers
|
|
60
|
+
|
|
61
|
+
- **Content-Type**: Not defined
|
|
62
|
+
- **Accept**: application/json
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
### HTTP response details
|
|
66
|
+
| Status code | Description | Response headers |
|
|
67
|
+
|-------------|-------------|------------------|
|
|
68
|
+
|**200** | Successfully retrieved product analytics items. | - |
|
|
69
|
+
|**400** | Failed validation. | - |
|
|
70
|
+
|**401** | Not authorised to access this resource. | - |
|
|
71
|
+
|**403** | Refuse to authorize. | - |
|
|
72
|
+
|**500** | Unknown server error. | - |
|
|
73
|
+
|
|
74
|
+
[[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)
|
|
75
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# ProductAnalyticsResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**analytics** | [**Array<AnalyticsItem>**](AnalyticsItem.md) | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { ProductAnalyticsResponse } from '@teemill/product-catalog';
|
|
14
|
+
|
|
15
|
+
const instance: ProductAnalyticsResponse = {
|
|
16
|
+
analytics,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[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.83.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|