@teemill/product-catalog 1.85.0 → 1.87.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -2
- package/api.ts +424 -17
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +249 -11
- package/dist/api.js +261 -16
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +249 -11
- package/dist/esm/api.js +255 -15
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/Action.md +32 -0
- package/docs/AnalyticsSummary.md +26 -0
- package/docs/ProductAnalyticsApi.md +85 -6
- package/docs/ProductCreatorsApi.md +63 -0
- package/docs/Recommendation.md +34 -0
- package/docs/UserList.md +20 -0
- package/docs/UserListCreatorsInner.md +24 -0
- package/docs/UserListCreatorsInnerAvatar.md +22 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/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.87.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
|
*/
|
|
@@ -1826,6 +1896,30 @@ export const UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCod
|
|
|
1826
1896
|
|
|
1827
1897
|
export type UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum = typeof UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum[keyof typeof UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum];
|
|
1828
1898
|
|
|
1899
|
+
export interface UserList {
|
|
1900
|
+
'creators': Array<UserListCreatorsInner>;
|
|
1901
|
+
}
|
|
1902
|
+
export interface UserListCreatorsInner {
|
|
1903
|
+
/**
|
|
1904
|
+
* Unique object identifier
|
|
1905
|
+
*/
|
|
1906
|
+
'id': string;
|
|
1907
|
+
/**
|
|
1908
|
+
* The username of the product creator
|
|
1909
|
+
*/
|
|
1910
|
+
'username': string;
|
|
1911
|
+
'avatar': UserListCreatorsInnerAvatar;
|
|
1912
|
+
}
|
|
1913
|
+
export interface UserListCreatorsInnerAvatar {
|
|
1914
|
+
/**
|
|
1915
|
+
* URL to the thumbnail version of the avatar
|
|
1916
|
+
*/
|
|
1917
|
+
'thumbnail': string | null;
|
|
1918
|
+
/**
|
|
1919
|
+
* URL to the original avatar image
|
|
1920
|
+
*/
|
|
1921
|
+
'original': string | null;
|
|
1922
|
+
}
|
|
1829
1923
|
export interface Variant {
|
|
1830
1924
|
/**
|
|
1831
1925
|
* Unique object identifier
|
|
@@ -3184,7 +3278,7 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration?: Co
|
|
|
3184
3278
|
* @summary Export product analytics
|
|
3185
3279
|
* @param {string} project What project it is
|
|
3186
3280
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
3187
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'
|
|
3281
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'productType:<id>\', \'Multiple filters can be combined with spaces and commas.\'
|
|
3188
3282
|
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
3189
3283
|
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
3190
3284
|
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
@@ -3195,10 +3289,14 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration?: Co
|
|
|
3195
3289
|
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
3196
3290
|
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
3197
3291
|
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
3292
|
+
* @param {string} [createdBefore] Filter to only include products created before the given date
|
|
3293
|
+
* @param {string} [createdAfter] Filter to only include products created after the given date
|
|
3294
|
+
* @param {string} [updatedBefore] Filter to only include products updated before the given date
|
|
3295
|
+
* @param {string} [updatedAfter] Filter to only include products updated after the given date
|
|
3198
3296
|
* @param {*} [options] Override http request option.
|
|
3199
3297
|
* @throws {RequiredError}
|
|
3200
3298
|
*/
|
|
3201
|
-
exportProductAnalytics: async (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> => {
|
|
3299
|
+
exportProductAnalytics: async (project: string, sortBy?: Array<string>, search?: string, dateRangeStartDate?: string, dateRangeEndDate?: string, minimumRevenue?: number, maximumRevenue?: number, minimumSales?: number, maximumSales?: number, minimumBasketPercent?: number, maximumBasketPercent?: number, minimumTraffic?: number, maximumTraffic?: number, createdBefore?: string, createdAfter?: string, updatedBefore?: string, updatedAfter?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3202
3300
|
// verify required parameter 'project' is not null or undefined
|
|
3203
3301
|
assertParamExists('exportProductAnalytics', 'project', project)
|
|
3204
3302
|
const localVarPath = `/v1/catalog/analytics/export`;
|
|
@@ -3276,6 +3374,30 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration?: Co
|
|
|
3276
3374
|
localVarQueryParameter['maximumTraffic'] = maximumTraffic;
|
|
3277
3375
|
}
|
|
3278
3376
|
|
|
3377
|
+
if (createdBefore !== undefined) {
|
|
3378
|
+
localVarQueryParameter['createdBefore'] = (createdBefore as any instanceof Date) ?
|
|
3379
|
+
(createdBefore as any).toISOString() :
|
|
3380
|
+
createdBefore;
|
|
3381
|
+
}
|
|
3382
|
+
|
|
3383
|
+
if (createdAfter !== undefined) {
|
|
3384
|
+
localVarQueryParameter['createdAfter'] = (createdAfter as any instanceof Date) ?
|
|
3385
|
+
(createdAfter as any).toISOString() :
|
|
3386
|
+
createdAfter;
|
|
3387
|
+
}
|
|
3388
|
+
|
|
3389
|
+
if (updatedBefore !== undefined) {
|
|
3390
|
+
localVarQueryParameter['updatedBefore'] = (updatedBefore as any instanceof Date) ?
|
|
3391
|
+
(updatedBefore as any).toISOString() :
|
|
3392
|
+
updatedBefore;
|
|
3393
|
+
}
|
|
3394
|
+
|
|
3395
|
+
if (updatedAfter !== undefined) {
|
|
3396
|
+
localVarQueryParameter['updatedAfter'] = (updatedAfter as any instanceof Date) ?
|
|
3397
|
+
(updatedAfter as any).toISOString() :
|
|
3398
|
+
updatedAfter;
|
|
3399
|
+
}
|
|
3400
|
+
|
|
3279
3401
|
localVarHeaderParameter['Accept'] = 'text/csv; charset=utf-8,application/json';
|
|
3280
3402
|
|
|
3281
3403
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3287,13 +3409,57 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration?: Co
|
|
|
3287
3409
|
options: localVarRequestOptions,
|
|
3288
3410
|
};
|
|
3289
3411
|
},
|
|
3412
|
+
/**
|
|
3413
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
3414
|
+
* @summary Get product analytics summary
|
|
3415
|
+
* @param {string} project What project it is
|
|
3416
|
+
* @param {*} [options] Override http request option.
|
|
3417
|
+
* @throws {RequiredError}
|
|
3418
|
+
*/
|
|
3419
|
+
getProductAnalyticsSummary: async (project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3420
|
+
// verify required parameter 'project' is not null or undefined
|
|
3421
|
+
assertParamExists('getProductAnalyticsSummary', 'project', project)
|
|
3422
|
+
const localVarPath = `/v1/catalog/analytics/summary`;
|
|
3423
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3424
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3425
|
+
let baseOptions;
|
|
3426
|
+
if (configuration) {
|
|
3427
|
+
baseOptions = configuration.baseOptions;
|
|
3428
|
+
}
|
|
3429
|
+
|
|
3430
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
3431
|
+
const localVarHeaderParameter = {} as any;
|
|
3432
|
+
const localVarQueryParameter = {} as any;
|
|
3433
|
+
|
|
3434
|
+
// authentication session-oauth required
|
|
3435
|
+
// oauth required
|
|
3436
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3437
|
+
|
|
3438
|
+
// authentication api-key required
|
|
3439
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3440
|
+
|
|
3441
|
+
if (project !== undefined) {
|
|
3442
|
+
localVarQueryParameter['project'] = project;
|
|
3443
|
+
}
|
|
3444
|
+
|
|
3445
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
3446
|
+
|
|
3447
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3448
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3449
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3450
|
+
|
|
3451
|
+
return {
|
|
3452
|
+
url: toPathString(localVarUrlObj),
|
|
3453
|
+
options: localVarRequestOptions,
|
|
3454
|
+
};
|
|
3455
|
+
},
|
|
3290
3456
|
/**
|
|
3291
3457
|
* Lists all product analytics items.
|
|
3292
3458
|
* @summary List product analytics
|
|
3293
3459
|
* @param {string} project What project it is
|
|
3294
3460
|
* @param {number} [pageToken] Page reference token
|
|
3295
3461
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3296
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'
|
|
3462
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'productType:<id>\', \'Multiple filters can be combined with spaces and commas.\'
|
|
3297
3463
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
3298
3464
|
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
3299
3465
|
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
@@ -3305,10 +3471,14 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration?: Co
|
|
|
3305
3471
|
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
3306
3472
|
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
3307
3473
|
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
3474
|
+
* @param {string} [createdBefore] Filter to only include products created before the given date
|
|
3475
|
+
* @param {string} [createdAfter] Filter to only include products created after the given date
|
|
3476
|
+
* @param {string} [updatedBefore] Filter to only include products updated before the given date
|
|
3477
|
+
* @param {string} [updatedAfter] Filter to only include products updated after the given date
|
|
3308
3478
|
* @param {*} [options] Override http request option.
|
|
3309
3479
|
* @throws {RequiredError}
|
|
3310
3480
|
*/
|
|
3311
|
-
listProductAnalytics: async (project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, dateRangeStartDate?: string, dateRangeEndDate?: string, minimumRevenue?: number, maximumRevenue?: number, minimumSales?: number, maximumSales?: number, minimumBasketPercent?: number, maximumBasketPercent?: number, minimumTraffic?: number, maximumTraffic?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3481
|
+
listProductAnalytics: async (project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, dateRangeStartDate?: string, dateRangeEndDate?: string, minimumRevenue?: number, maximumRevenue?: number, minimumSales?: number, maximumSales?: number, minimumBasketPercent?: number, maximumBasketPercent?: number, minimumTraffic?: number, maximumTraffic?: number, createdBefore?: string, createdAfter?: string, updatedBefore?: string, updatedAfter?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3312
3482
|
// verify required parameter 'project' is not null or undefined
|
|
3313
3483
|
assertParamExists('listProductAnalytics', 'project', project)
|
|
3314
3484
|
const localVarPath = `/v1/catalog/analytics`;
|
|
@@ -3394,6 +3564,30 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration?: Co
|
|
|
3394
3564
|
localVarQueryParameter['maximumTraffic'] = maximumTraffic;
|
|
3395
3565
|
}
|
|
3396
3566
|
|
|
3567
|
+
if (createdBefore !== undefined) {
|
|
3568
|
+
localVarQueryParameter['createdBefore'] = (createdBefore as any instanceof Date) ?
|
|
3569
|
+
(createdBefore as any).toISOString() :
|
|
3570
|
+
createdBefore;
|
|
3571
|
+
}
|
|
3572
|
+
|
|
3573
|
+
if (createdAfter !== undefined) {
|
|
3574
|
+
localVarQueryParameter['createdAfter'] = (createdAfter as any instanceof Date) ?
|
|
3575
|
+
(createdAfter as any).toISOString() :
|
|
3576
|
+
createdAfter;
|
|
3577
|
+
}
|
|
3578
|
+
|
|
3579
|
+
if (updatedBefore !== undefined) {
|
|
3580
|
+
localVarQueryParameter['updatedBefore'] = (updatedBefore as any instanceof Date) ?
|
|
3581
|
+
(updatedBefore as any).toISOString() :
|
|
3582
|
+
updatedBefore;
|
|
3583
|
+
}
|
|
3584
|
+
|
|
3585
|
+
if (updatedAfter !== undefined) {
|
|
3586
|
+
localVarQueryParameter['updatedAfter'] = (updatedAfter as any instanceof Date) ?
|
|
3587
|
+
(updatedAfter as any).toISOString() :
|
|
3588
|
+
updatedAfter;
|
|
3589
|
+
}
|
|
3590
|
+
|
|
3397
3591
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
3398
3592
|
|
|
3399
3593
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3419,7 +3613,7 @@ export const ProductAnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
3419
3613
|
* @summary Export product analytics
|
|
3420
3614
|
* @param {string} project What project it is
|
|
3421
3615
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
3422
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'
|
|
3616
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'productType:<id>\', \'Multiple filters can be combined with spaces and commas.\'
|
|
3423
3617
|
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
3424
3618
|
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
3425
3619
|
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
@@ -3430,22 +3624,39 @@ export const ProductAnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
3430
3624
|
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
3431
3625
|
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
3432
3626
|
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
3627
|
+
* @param {string} [createdBefore] Filter to only include products created before the given date
|
|
3628
|
+
* @param {string} [createdAfter] Filter to only include products created after the given date
|
|
3629
|
+
* @param {string} [updatedBefore] Filter to only include products updated before the given date
|
|
3630
|
+
* @param {string} [updatedAfter] Filter to only include products updated after the given date
|
|
3433
3631
|
* @param {*} [options] Override http request option.
|
|
3434
3632
|
* @throws {RequiredError}
|
|
3435
3633
|
*/
|
|
3436
|
-
async 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>> {
|
|
3437
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.exportProductAnalytics(project, sortBy, search, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, options);
|
|
3634
|
+
async exportProductAnalytics(project: string, sortBy?: Array<string>, search?: string, dateRangeStartDate?: string, dateRangeEndDate?: string, minimumRevenue?: number, maximumRevenue?: number, minimumSales?: number, maximumSales?: number, minimumBasketPercent?: number, maximumBasketPercent?: number, minimumTraffic?: number, maximumTraffic?: number, createdBefore?: string, createdAfter?: string, updatedBefore?: string, updatedAfter?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
3635
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.exportProductAnalytics(project, sortBy, search, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, createdBefore, createdAfter, updatedBefore, updatedAfter, options);
|
|
3438
3636
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3439
3637
|
const localVarOperationServerBasePath = operationServerMap['ProductAnalyticsApi.exportProductAnalytics']?.[localVarOperationServerIndex]?.url;
|
|
3440
3638
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3441
3639
|
},
|
|
3640
|
+
/**
|
|
3641
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
3642
|
+
* @summary Get product analytics summary
|
|
3643
|
+
* @param {string} project What project it is
|
|
3644
|
+
* @param {*} [options] Override http request option.
|
|
3645
|
+
* @throws {RequiredError}
|
|
3646
|
+
*/
|
|
3647
|
+
async getProductAnalyticsSummary(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnalyticsSummary>> {
|
|
3648
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getProductAnalyticsSummary(project, options);
|
|
3649
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3650
|
+
const localVarOperationServerBasePath = operationServerMap['ProductAnalyticsApi.getProductAnalyticsSummary']?.[localVarOperationServerIndex]?.url;
|
|
3651
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3652
|
+
},
|
|
3442
3653
|
/**
|
|
3443
3654
|
* Lists all product analytics items.
|
|
3444
3655
|
* @summary List product analytics
|
|
3445
3656
|
* @param {string} project What project it is
|
|
3446
3657
|
* @param {number} [pageToken] Page reference token
|
|
3447
3658
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3448
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'
|
|
3659
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'productType:<id>\', \'Multiple filters can be combined with spaces and commas.\'
|
|
3449
3660
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
3450
3661
|
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
3451
3662
|
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
@@ -3457,11 +3668,15 @@ export const ProductAnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
3457
3668
|
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
3458
3669
|
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
3459
3670
|
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
3671
|
+
* @param {string} [createdBefore] Filter to only include products created before the given date
|
|
3672
|
+
* @param {string} [createdAfter] Filter to only include products created after the given date
|
|
3673
|
+
* @param {string} [updatedBefore] Filter to only include products updated before the given date
|
|
3674
|
+
* @param {string} [updatedAfter] Filter to only include products updated after the given date
|
|
3460
3675
|
* @param {*} [options] Override http request option.
|
|
3461
3676
|
* @throws {RequiredError}
|
|
3462
3677
|
*/
|
|
3463
|
-
async listProductAnalytics(project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, dateRangeStartDate?: string, dateRangeEndDate?: string, minimumRevenue?: number, maximumRevenue?: number, minimumSales?: number, maximumSales?: number, minimumBasketPercent?: number, maximumBasketPercent?: number, minimumTraffic?: number, maximumTraffic?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductAnalyticsResponse>> {
|
|
3464
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listProductAnalytics(project, pageToken, pageSize, search, sortBy, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, options);
|
|
3678
|
+
async listProductAnalytics(project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, dateRangeStartDate?: string, dateRangeEndDate?: string, minimumRevenue?: number, maximumRevenue?: number, minimumSales?: number, maximumSales?: number, minimumBasketPercent?: number, maximumBasketPercent?: number, minimumTraffic?: number, maximumTraffic?: number, createdBefore?: string, createdAfter?: string, updatedBefore?: string, updatedAfter?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductAnalyticsResponse>> {
|
|
3679
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listProductAnalytics(project, pageToken, pageSize, search, sortBy, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, createdBefore, createdAfter, updatedBefore, updatedAfter, options);
|
|
3465
3680
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3466
3681
|
const localVarOperationServerBasePath = operationServerMap['ProductAnalyticsApi.listProductAnalytics']?.[localVarOperationServerIndex]?.url;
|
|
3467
3682
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -3483,7 +3698,17 @@ export const ProductAnalyticsApiFactory = function (configuration?: Configuratio
|
|
|
3483
3698
|
* @throws {RequiredError}
|
|
3484
3699
|
*/
|
|
3485
3700
|
exportProductAnalytics(requestParameters: ProductAnalyticsApiExportProductAnalyticsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
3486
|
-
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));
|
|
3701
|
+
return localVarFp.exportProductAnalytics(requestParameters.project, requestParameters.sortBy, requestParameters.search, requestParameters.dateRangeStartDate, requestParameters.dateRangeEndDate, requestParameters.minimumRevenue, requestParameters.maximumRevenue, requestParameters.minimumSales, requestParameters.maximumSales, requestParameters.minimumBasketPercent, requestParameters.maximumBasketPercent, requestParameters.minimumTraffic, requestParameters.maximumTraffic, requestParameters.createdBefore, requestParameters.createdAfter, requestParameters.updatedBefore, requestParameters.updatedAfter, options).then((request) => request(axios, basePath));
|
|
3702
|
+
},
|
|
3703
|
+
/**
|
|
3704
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
3705
|
+
* @summary Get product analytics summary
|
|
3706
|
+
* @param {ProductAnalyticsApiGetProductAnalyticsSummaryRequest} requestParameters Request parameters.
|
|
3707
|
+
* @param {*} [options] Override http request option.
|
|
3708
|
+
* @throws {RequiredError}
|
|
3709
|
+
*/
|
|
3710
|
+
getProductAnalyticsSummary(requestParameters: ProductAnalyticsApiGetProductAnalyticsSummaryRequest, options?: RawAxiosRequestConfig): AxiosPromise<AnalyticsSummary> {
|
|
3711
|
+
return localVarFp.getProductAnalyticsSummary(requestParameters.project, options).then((request) => request(axios, basePath));
|
|
3487
3712
|
},
|
|
3488
3713
|
/**
|
|
3489
3714
|
* Lists all product analytics items.
|
|
@@ -3493,7 +3718,7 @@ export const ProductAnalyticsApiFactory = function (configuration?: Configuratio
|
|
|
3493
3718
|
* @throws {RequiredError}
|
|
3494
3719
|
*/
|
|
3495
3720
|
listProductAnalytics(requestParameters: ProductAnalyticsApiListProductAnalyticsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductAnalyticsResponse> {
|
|
3496
|
-
return localVarFp.listProductAnalytics(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.dateRangeStartDate, requestParameters.dateRangeEndDate, requestParameters.minimumRevenue, requestParameters.maximumRevenue, requestParameters.minimumSales, requestParameters.maximumSales, requestParameters.minimumBasketPercent, requestParameters.maximumBasketPercent, requestParameters.minimumTraffic, requestParameters.maximumTraffic, options).then((request) => request(axios, basePath));
|
|
3721
|
+
return localVarFp.listProductAnalytics(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.dateRangeStartDate, requestParameters.dateRangeEndDate, requestParameters.minimumRevenue, requestParameters.maximumRevenue, requestParameters.minimumSales, requestParameters.maximumSales, requestParameters.minimumBasketPercent, requestParameters.maximumBasketPercent, requestParameters.minimumTraffic, requestParameters.maximumTraffic, requestParameters.createdBefore, requestParameters.createdAfter, requestParameters.updatedBefore, requestParameters.updatedAfter, options).then((request) => request(axios, basePath));
|
|
3497
3722
|
},
|
|
3498
3723
|
};
|
|
3499
3724
|
};
|
|
@@ -3513,7 +3738,7 @@ export interface ProductAnalyticsApiExportProductAnalyticsRequest {
|
|
|
3513
3738
|
readonly sortBy?: Array<string>
|
|
3514
3739
|
|
|
3515
3740
|
/**
|
|
3516
|
-
* Search query string to filter results. Supports field-specific filters like: \'
|
|
3741
|
+
* Search query string to filter results. Supports field-specific filters like: \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'productType:<id>\', \'Multiple filters can be combined with spaces and commas.\'
|
|
3517
3742
|
*/
|
|
3518
3743
|
readonly search?: string
|
|
3519
3744
|
|
|
@@ -3566,6 +3791,36 @@ export interface ProductAnalyticsApiExportProductAnalyticsRequest {
|
|
|
3566
3791
|
* Filter to only include products with total traffic less than or equal to this number
|
|
3567
3792
|
*/
|
|
3568
3793
|
readonly maximumTraffic?: number
|
|
3794
|
+
|
|
3795
|
+
/**
|
|
3796
|
+
* Filter to only include products created before the given date
|
|
3797
|
+
*/
|
|
3798
|
+
readonly createdBefore?: string
|
|
3799
|
+
|
|
3800
|
+
/**
|
|
3801
|
+
* Filter to only include products created after the given date
|
|
3802
|
+
*/
|
|
3803
|
+
readonly createdAfter?: string
|
|
3804
|
+
|
|
3805
|
+
/**
|
|
3806
|
+
* Filter to only include products updated before the given date
|
|
3807
|
+
*/
|
|
3808
|
+
readonly updatedBefore?: string
|
|
3809
|
+
|
|
3810
|
+
/**
|
|
3811
|
+
* Filter to only include products updated after the given date
|
|
3812
|
+
*/
|
|
3813
|
+
readonly updatedAfter?: string
|
|
3814
|
+
}
|
|
3815
|
+
|
|
3816
|
+
/**
|
|
3817
|
+
* Request parameters for getProductAnalyticsSummary operation in ProductAnalyticsApi.
|
|
3818
|
+
*/
|
|
3819
|
+
export interface ProductAnalyticsApiGetProductAnalyticsSummaryRequest {
|
|
3820
|
+
/**
|
|
3821
|
+
* What project it is
|
|
3822
|
+
*/
|
|
3823
|
+
readonly project: string
|
|
3569
3824
|
}
|
|
3570
3825
|
|
|
3571
3826
|
/**
|
|
@@ -3588,7 +3843,7 @@ export interface ProductAnalyticsApiListProductAnalyticsRequest {
|
|
|
3588
3843
|
readonly pageSize?: number
|
|
3589
3844
|
|
|
3590
3845
|
/**
|
|
3591
|
-
* Search query string to filter results. Supports field-specific filters like: \'
|
|
3846
|
+
* Search query string to filter results. Supports field-specific filters like: \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'productType:<id>\', \'Multiple filters can be combined with spaces and commas.\'
|
|
3592
3847
|
*/
|
|
3593
3848
|
readonly search?: string
|
|
3594
3849
|
|
|
@@ -3646,6 +3901,26 @@ export interface ProductAnalyticsApiListProductAnalyticsRequest {
|
|
|
3646
3901
|
* Filter to only include products with total traffic less than or equal to this number
|
|
3647
3902
|
*/
|
|
3648
3903
|
readonly maximumTraffic?: number
|
|
3904
|
+
|
|
3905
|
+
/**
|
|
3906
|
+
* Filter to only include products created before the given date
|
|
3907
|
+
*/
|
|
3908
|
+
readonly createdBefore?: string
|
|
3909
|
+
|
|
3910
|
+
/**
|
|
3911
|
+
* Filter to only include products created after the given date
|
|
3912
|
+
*/
|
|
3913
|
+
readonly createdAfter?: string
|
|
3914
|
+
|
|
3915
|
+
/**
|
|
3916
|
+
* Filter to only include products updated before the given date
|
|
3917
|
+
*/
|
|
3918
|
+
readonly updatedBefore?: string
|
|
3919
|
+
|
|
3920
|
+
/**
|
|
3921
|
+
* Filter to only include products updated after the given date
|
|
3922
|
+
*/
|
|
3923
|
+
readonly updatedAfter?: string
|
|
3649
3924
|
}
|
|
3650
3925
|
|
|
3651
3926
|
/**
|
|
@@ -3660,7 +3935,18 @@ export class ProductAnalyticsApi extends BaseAPI {
|
|
|
3660
3935
|
* @throws {RequiredError}
|
|
3661
3936
|
*/
|
|
3662
3937
|
public exportProductAnalytics(requestParameters: ProductAnalyticsApiExportProductAnalyticsRequest, options?: RawAxiosRequestConfig) {
|
|
3663
|
-
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));
|
|
3938
|
+
return ProductAnalyticsApiFp(this.configuration).exportProductAnalytics(requestParameters.project, requestParameters.sortBy, requestParameters.search, requestParameters.dateRangeStartDate, requestParameters.dateRangeEndDate, requestParameters.minimumRevenue, requestParameters.maximumRevenue, requestParameters.minimumSales, requestParameters.maximumSales, requestParameters.minimumBasketPercent, requestParameters.maximumBasketPercent, requestParameters.minimumTraffic, requestParameters.maximumTraffic, requestParameters.createdBefore, requestParameters.createdAfter, requestParameters.updatedBefore, requestParameters.updatedAfter, options).then((request) => request(this.axios, this.basePath));
|
|
3939
|
+
}
|
|
3940
|
+
|
|
3941
|
+
/**
|
|
3942
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
3943
|
+
* @summary Get product analytics summary
|
|
3944
|
+
* @param {ProductAnalyticsApiGetProductAnalyticsSummaryRequest} requestParameters Request parameters.
|
|
3945
|
+
* @param {*} [options] Override http request option.
|
|
3946
|
+
* @throws {RequiredError}
|
|
3947
|
+
*/
|
|
3948
|
+
public getProductAnalyticsSummary(requestParameters: ProductAnalyticsApiGetProductAnalyticsSummaryRequest, options?: RawAxiosRequestConfig) {
|
|
3949
|
+
return ProductAnalyticsApiFp(this.configuration).getProductAnalyticsSummary(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
|
|
3664
3950
|
}
|
|
3665
3951
|
|
|
3666
3952
|
/**
|
|
@@ -3671,7 +3957,128 @@ export class ProductAnalyticsApi extends BaseAPI {
|
|
|
3671
3957
|
* @throws {RequiredError}
|
|
3672
3958
|
*/
|
|
3673
3959
|
public listProductAnalytics(requestParameters: ProductAnalyticsApiListProductAnalyticsRequest, options?: RawAxiosRequestConfig) {
|
|
3674
|
-
return ProductAnalyticsApiFp(this.configuration).listProductAnalytics(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.dateRangeStartDate, requestParameters.dateRangeEndDate, requestParameters.minimumRevenue, requestParameters.maximumRevenue, requestParameters.minimumSales, requestParameters.maximumSales, requestParameters.minimumBasketPercent, requestParameters.maximumBasketPercent, requestParameters.minimumTraffic, requestParameters.maximumTraffic, options).then((request) => request(this.axios, this.basePath));
|
|
3960
|
+
return ProductAnalyticsApiFp(this.configuration).listProductAnalytics(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.dateRangeStartDate, requestParameters.dateRangeEndDate, requestParameters.minimumRevenue, requestParameters.maximumRevenue, requestParameters.minimumSales, requestParameters.maximumSales, requestParameters.minimumBasketPercent, requestParameters.maximumBasketPercent, requestParameters.minimumTraffic, requestParameters.maximumTraffic, requestParameters.createdBefore, requestParameters.createdAfter, requestParameters.updatedBefore, requestParameters.updatedAfter, options).then((request) => request(this.axios, this.basePath));
|
|
3961
|
+
}
|
|
3962
|
+
}
|
|
3963
|
+
|
|
3964
|
+
|
|
3965
|
+
|
|
3966
|
+
/**
|
|
3967
|
+
* ProductCreatorsApi - axios parameter creator
|
|
3968
|
+
*/
|
|
3969
|
+
export const ProductCreatorsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
3970
|
+
return {
|
|
3971
|
+
/**
|
|
3972
|
+
* Lists all the unique users that have created products for the given project.
|
|
3973
|
+
* @summary List product creators
|
|
3974
|
+
* @param {string} project What project it is
|
|
3975
|
+
* @param {*} [options] Override http request option.
|
|
3976
|
+
* @throws {RequiredError}
|
|
3977
|
+
*/
|
|
3978
|
+
listProductCreators: async (project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3979
|
+
// verify required parameter 'project' is not null or undefined
|
|
3980
|
+
assertParamExists('listProductCreators', 'project', project)
|
|
3981
|
+
const localVarPath = `/v1/catalog/creators`;
|
|
3982
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3983
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3984
|
+
let baseOptions;
|
|
3985
|
+
if (configuration) {
|
|
3986
|
+
baseOptions = configuration.baseOptions;
|
|
3987
|
+
}
|
|
3988
|
+
|
|
3989
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
3990
|
+
const localVarHeaderParameter = {} as any;
|
|
3991
|
+
const localVarQueryParameter = {} as any;
|
|
3992
|
+
|
|
3993
|
+
// authentication session-oauth required
|
|
3994
|
+
// oauth required
|
|
3995
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3996
|
+
|
|
3997
|
+
// authentication api-key required
|
|
3998
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3999
|
+
|
|
4000
|
+
if (project !== undefined) {
|
|
4001
|
+
localVarQueryParameter['project'] = project;
|
|
4002
|
+
}
|
|
4003
|
+
|
|
4004
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
4005
|
+
|
|
4006
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4007
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4008
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
4009
|
+
|
|
4010
|
+
return {
|
|
4011
|
+
url: toPathString(localVarUrlObj),
|
|
4012
|
+
options: localVarRequestOptions,
|
|
4013
|
+
};
|
|
4014
|
+
},
|
|
4015
|
+
}
|
|
4016
|
+
};
|
|
4017
|
+
|
|
4018
|
+
/**
|
|
4019
|
+
* ProductCreatorsApi - functional programming interface
|
|
4020
|
+
*/
|
|
4021
|
+
export const ProductCreatorsApiFp = function(configuration?: Configuration) {
|
|
4022
|
+
const localVarAxiosParamCreator = ProductCreatorsApiAxiosParamCreator(configuration)
|
|
4023
|
+
return {
|
|
4024
|
+
/**
|
|
4025
|
+
* Lists all the unique users that have created products for the given project.
|
|
4026
|
+
* @summary List product creators
|
|
4027
|
+
* @param {string} project What project it is
|
|
4028
|
+
* @param {*} [options] Override http request option.
|
|
4029
|
+
* @throws {RequiredError}
|
|
4030
|
+
*/
|
|
4031
|
+
async listProductCreators(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserList>> {
|
|
4032
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listProductCreators(project, options);
|
|
4033
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4034
|
+
const localVarOperationServerBasePath = operationServerMap['ProductCreatorsApi.listProductCreators']?.[localVarOperationServerIndex]?.url;
|
|
4035
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4036
|
+
},
|
|
4037
|
+
}
|
|
4038
|
+
};
|
|
4039
|
+
|
|
4040
|
+
/**
|
|
4041
|
+
* ProductCreatorsApi - factory interface
|
|
4042
|
+
*/
|
|
4043
|
+
export const ProductCreatorsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
4044
|
+
const localVarFp = ProductCreatorsApiFp(configuration)
|
|
4045
|
+
return {
|
|
4046
|
+
/**
|
|
4047
|
+
* Lists all the unique users that have created products for the given project.
|
|
4048
|
+
* @summary List product creators
|
|
4049
|
+
* @param {ProductCreatorsApiListProductCreatorsRequest} requestParameters Request parameters.
|
|
4050
|
+
* @param {*} [options] Override http request option.
|
|
4051
|
+
* @throws {RequiredError}
|
|
4052
|
+
*/
|
|
4053
|
+
listProductCreators(requestParameters: ProductCreatorsApiListProductCreatorsRequest, options?: RawAxiosRequestConfig): AxiosPromise<UserList> {
|
|
4054
|
+
return localVarFp.listProductCreators(requestParameters.project, options).then((request) => request(axios, basePath));
|
|
4055
|
+
},
|
|
4056
|
+
};
|
|
4057
|
+
};
|
|
4058
|
+
|
|
4059
|
+
/**
|
|
4060
|
+
* Request parameters for listProductCreators operation in ProductCreatorsApi.
|
|
4061
|
+
*/
|
|
4062
|
+
export interface ProductCreatorsApiListProductCreatorsRequest {
|
|
4063
|
+
/**
|
|
4064
|
+
* What project it is
|
|
4065
|
+
*/
|
|
4066
|
+
readonly project: string
|
|
4067
|
+
}
|
|
4068
|
+
|
|
4069
|
+
/**
|
|
4070
|
+
* ProductCreatorsApi - object-oriented interface
|
|
4071
|
+
*/
|
|
4072
|
+
export class ProductCreatorsApi extends BaseAPI {
|
|
4073
|
+
/**
|
|
4074
|
+
* Lists all the unique users that have created products for the given project.
|
|
4075
|
+
* @summary List product creators
|
|
4076
|
+
* @param {ProductCreatorsApiListProductCreatorsRequest} requestParameters Request parameters.
|
|
4077
|
+
* @param {*} [options] Override http request option.
|
|
4078
|
+
* @throws {RequiredError}
|
|
4079
|
+
*/
|
|
4080
|
+
public listProductCreators(requestParameters: ProductCreatorsApiListProductCreatorsRequest, options?: RawAxiosRequestConfig) {
|
|
4081
|
+
return ProductCreatorsApiFp(this.configuration).listProductCreators(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
|
|
3675
4082
|
}
|
|
3676
4083
|
}
|
|
3677
4084
|
|
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.87.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.87.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|