@teemill/product-catalog 1.86.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 +6 -2
- package/api.ts +266 -17
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +144 -11
- package/dist/api.js +178 -17
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +144 -11
- package/dist/esm/api.js +172 -15
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/ProductAnalyticsApi.md +30 -6
- package/docs/ProductCreatorsApi.md +63 -0
- package/docs/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/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/product-catalog@1.
|
|
1
|
+
## @teemill/product-catalog@1.87.0
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @teemill/product-catalog@1.
|
|
39
|
+
npm install @teemill/product-catalog@1.87.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -65,6 +65,7 @@ Class | Method | HTTP request | Description
|
|
|
65
65
|
*ProductAnalyticsApi* | [**exportProductAnalytics**](docs/ProductAnalyticsApi.md#exportproductanalytics) | **GET** /v1/catalog/analytics/export | Export product analytics
|
|
66
66
|
*ProductAnalyticsApi* | [**getProductAnalyticsSummary**](docs/ProductAnalyticsApi.md#getproductanalyticssummary) | **GET** /v1/catalog/analytics/summary | Get product analytics summary
|
|
67
67
|
*ProductAnalyticsApi* | [**listProductAnalytics**](docs/ProductAnalyticsApi.md#listproductanalytics) | **GET** /v1/catalog/analytics | List product analytics
|
|
68
|
+
*ProductCreatorsApi* | [**listProductCreators**](docs/ProductCreatorsApi.md#listproductcreators) | **GET** /v1/catalog/creators | List product creators
|
|
68
69
|
*ProductTypesApi* | [**listProductTypes**](docs/ProductTypesApi.md#listproducttypes) | **GET** /v1/catalog/product-types | List product types
|
|
69
70
|
*ProductsApi* | [**createProduct**](docs/ProductsApi.md#createproduct) | **POST** /v1/catalog/products | Create product
|
|
70
71
|
*ProductsApi* | [**deleteProduct**](docs/ProductsApi.md#deleteproduct) | **DELETE** /v1/catalog/products/{productId} | Delete catalog product
|
|
@@ -182,6 +183,9 @@ Class | Method | HTTP request | Description
|
|
|
182
183
|
- [UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner](docs/UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner.md)
|
|
183
184
|
- [UpdateProductsRequestProductsInnerVariantsInnerRetailPrice](docs/UpdateProductsRequestProductsInnerVariantsInnerRetailPrice.md)
|
|
184
185
|
- [UpdateProductsRequestProductsInnerVariantsInnerSalePrice](docs/UpdateProductsRequestProductsInnerVariantsInnerSalePrice.md)
|
|
186
|
+
- [UserList](docs/UserList.md)
|
|
187
|
+
- [UserListCreatorsInner](docs/UserListCreatorsInner.md)
|
|
188
|
+
- [UserListCreatorsInnerAvatar](docs/UserListCreatorsInnerAvatar.md)
|
|
185
189
|
- [Variant](docs/Variant.md)
|
|
186
190
|
- [VariantIntegrationConnectionsInner](docs/VariantIntegrationConnectionsInner.md)
|
|
187
191
|
- [VariantProduct](docs/VariantProduct.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.87.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1896,6 +1896,30 @@ export const UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCod
|
|
|
1896
1896
|
|
|
1897
1897
|
export type UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum = typeof UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum[keyof typeof UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum];
|
|
1898
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
|
+
}
|
|
1899
1923
|
export interface Variant {
|
|
1900
1924
|
/**
|
|
1901
1925
|
* Unique object identifier
|
|
@@ -3254,7 +3278,7 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration?: Co
|
|
|
3254
3278
|
* @summary Export product analytics
|
|
3255
3279
|
* @param {string} project What project it is
|
|
3256
3280
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
3257
|
-
* @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.\'
|
|
3258
3282
|
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
3259
3283
|
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
3260
3284
|
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
@@ -3265,10 +3289,14 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration?: Co
|
|
|
3265
3289
|
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
3266
3290
|
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
3267
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
|
|
3268
3296
|
* @param {*} [options] Override http request option.
|
|
3269
3297
|
* @throws {RequiredError}
|
|
3270
3298
|
*/
|
|
3271
|
-
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> => {
|
|
3272
3300
|
// verify required parameter 'project' is not null or undefined
|
|
3273
3301
|
assertParamExists('exportProductAnalytics', 'project', project)
|
|
3274
3302
|
const localVarPath = `/v1/catalog/analytics/export`;
|
|
@@ -3346,6 +3374,30 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration?: Co
|
|
|
3346
3374
|
localVarQueryParameter['maximumTraffic'] = maximumTraffic;
|
|
3347
3375
|
}
|
|
3348
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
|
+
|
|
3349
3401
|
localVarHeaderParameter['Accept'] = 'text/csv; charset=utf-8,application/json';
|
|
3350
3402
|
|
|
3351
3403
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3407,7 +3459,7 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration?: Co
|
|
|
3407
3459
|
* @param {string} project What project it is
|
|
3408
3460
|
* @param {number} [pageToken] Page reference token
|
|
3409
3461
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3410
|
-
* @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.\'
|
|
3411
3463
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
3412
3464
|
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
3413
3465
|
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
@@ -3419,10 +3471,14 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration?: Co
|
|
|
3419
3471
|
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
3420
3472
|
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
3421
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
|
|
3422
3478
|
* @param {*} [options] Override http request option.
|
|
3423
3479
|
* @throws {RequiredError}
|
|
3424
3480
|
*/
|
|
3425
|
-
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> => {
|
|
3426
3482
|
// verify required parameter 'project' is not null or undefined
|
|
3427
3483
|
assertParamExists('listProductAnalytics', 'project', project)
|
|
3428
3484
|
const localVarPath = `/v1/catalog/analytics`;
|
|
@@ -3508,6 +3564,30 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration?: Co
|
|
|
3508
3564
|
localVarQueryParameter['maximumTraffic'] = maximumTraffic;
|
|
3509
3565
|
}
|
|
3510
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
|
+
|
|
3511
3591
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
3512
3592
|
|
|
3513
3593
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3533,7 +3613,7 @@ export const ProductAnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
3533
3613
|
* @summary Export product analytics
|
|
3534
3614
|
* @param {string} project What project it is
|
|
3535
3615
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
3536
|
-
* @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.\'
|
|
3537
3617
|
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
3538
3618
|
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
3539
3619
|
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
@@ -3544,11 +3624,15 @@ export const ProductAnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
3544
3624
|
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
3545
3625
|
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
3546
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
|
|
3547
3631
|
* @param {*} [options] Override http request option.
|
|
3548
3632
|
* @throws {RequiredError}
|
|
3549
3633
|
*/
|
|
3550
|
-
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>> {
|
|
3551
|
-
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);
|
|
3552
3636
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3553
3637
|
const localVarOperationServerBasePath = operationServerMap['ProductAnalyticsApi.exportProductAnalytics']?.[localVarOperationServerIndex]?.url;
|
|
3554
3638
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -3572,7 +3656,7 @@ export const ProductAnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
3572
3656
|
* @param {string} project What project it is
|
|
3573
3657
|
* @param {number} [pageToken] Page reference token
|
|
3574
3658
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3575
|
-
* @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.\'
|
|
3576
3660
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
3577
3661
|
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
3578
3662
|
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
@@ -3584,11 +3668,15 @@ export const ProductAnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
3584
3668
|
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
3585
3669
|
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
3586
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
|
|
3587
3675
|
* @param {*} [options] Override http request option.
|
|
3588
3676
|
* @throws {RequiredError}
|
|
3589
3677
|
*/
|
|
3590
|
-
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>> {
|
|
3591
|
-
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);
|
|
3592
3680
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3593
3681
|
const localVarOperationServerBasePath = operationServerMap['ProductAnalyticsApi.listProductAnalytics']?.[localVarOperationServerIndex]?.url;
|
|
3594
3682
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -3610,7 +3698,7 @@ export const ProductAnalyticsApiFactory = function (configuration?: Configuratio
|
|
|
3610
3698
|
* @throws {RequiredError}
|
|
3611
3699
|
*/
|
|
3612
3700
|
exportProductAnalytics(requestParameters: ProductAnalyticsApiExportProductAnalyticsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
3613
|
-
return localVarFp.exportProductAnalytics(requestParameters.project, requestParameters.sortBy, requestParameters.search, requestParameters.dateRangeStartDate, requestParameters.dateRangeEndDate, requestParameters.minimumRevenue, requestParameters.maximumRevenue, requestParameters.minimumSales, requestParameters.maximumSales, requestParameters.minimumBasketPercent, requestParameters.maximumBasketPercent, requestParameters.minimumTraffic, requestParameters.maximumTraffic, options).then((request) => request(axios, basePath));
|
|
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));
|
|
3614
3702
|
},
|
|
3615
3703
|
/**
|
|
3616
3704
|
* Get the AI-generated summary of the product analytics for the given project.
|
|
@@ -3630,7 +3718,7 @@ export const ProductAnalyticsApiFactory = function (configuration?: Configuratio
|
|
|
3630
3718
|
* @throws {RequiredError}
|
|
3631
3719
|
*/
|
|
3632
3720
|
listProductAnalytics(requestParameters: ProductAnalyticsApiListProductAnalyticsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductAnalyticsResponse> {
|
|
3633
|
-
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));
|
|
3634
3722
|
},
|
|
3635
3723
|
};
|
|
3636
3724
|
};
|
|
@@ -3650,7 +3738,7 @@ export interface ProductAnalyticsApiExportProductAnalyticsRequest {
|
|
|
3650
3738
|
readonly sortBy?: Array<string>
|
|
3651
3739
|
|
|
3652
3740
|
/**
|
|
3653
|
-
* 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.\'
|
|
3654
3742
|
*/
|
|
3655
3743
|
readonly search?: string
|
|
3656
3744
|
|
|
@@ -3703,6 +3791,26 @@ export interface ProductAnalyticsApiExportProductAnalyticsRequest {
|
|
|
3703
3791
|
* Filter to only include products with total traffic less than or equal to this number
|
|
3704
3792
|
*/
|
|
3705
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
|
|
3706
3814
|
}
|
|
3707
3815
|
|
|
3708
3816
|
/**
|
|
@@ -3735,7 +3843,7 @@ export interface ProductAnalyticsApiListProductAnalyticsRequest {
|
|
|
3735
3843
|
readonly pageSize?: number
|
|
3736
3844
|
|
|
3737
3845
|
/**
|
|
3738
|
-
* 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.\'
|
|
3739
3847
|
*/
|
|
3740
3848
|
readonly search?: string
|
|
3741
3849
|
|
|
@@ -3793,6 +3901,26 @@ export interface ProductAnalyticsApiListProductAnalyticsRequest {
|
|
|
3793
3901
|
* Filter to only include products with total traffic less than or equal to this number
|
|
3794
3902
|
*/
|
|
3795
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
|
|
3796
3924
|
}
|
|
3797
3925
|
|
|
3798
3926
|
/**
|
|
@@ -3807,7 +3935,7 @@ export class ProductAnalyticsApi extends BaseAPI {
|
|
|
3807
3935
|
* @throws {RequiredError}
|
|
3808
3936
|
*/
|
|
3809
3937
|
public exportProductAnalytics(requestParameters: ProductAnalyticsApiExportProductAnalyticsRequest, options?: RawAxiosRequestConfig) {
|
|
3810
|
-
return ProductAnalyticsApiFp(this.configuration).exportProductAnalytics(requestParameters.project, requestParameters.sortBy, requestParameters.search, requestParameters.dateRangeStartDate, requestParameters.dateRangeEndDate, requestParameters.minimumRevenue, requestParameters.maximumRevenue, requestParameters.minimumSales, requestParameters.maximumSales, requestParameters.minimumBasketPercent, requestParameters.maximumBasketPercent, requestParameters.minimumTraffic, requestParameters.maximumTraffic, options).then((request) => request(this.axios, this.basePath));
|
|
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));
|
|
3811
3939
|
}
|
|
3812
3940
|
|
|
3813
3941
|
/**
|
|
@@ -3829,7 +3957,128 @@ export class ProductAnalyticsApi extends BaseAPI {
|
|
|
3829
3957
|
* @throws {RequiredError}
|
|
3830
3958
|
*/
|
|
3831
3959
|
public listProductAnalytics(requestParameters: ProductAnalyticsApiListProductAnalyticsRequest, options?: RawAxiosRequestConfig) {
|
|
3832
|
-
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));
|
|
3833
4082
|
}
|
|
3834
4083
|
}
|
|
3835
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).
|
package/configuration.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Product Catalog API
|
|
4
4
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 1.
|
|
6
|
+
* The version of the OpenAPI document: 1.87.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|