@teemill/product-catalog 1.56.0 → 1.58.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 +4 -2
- package/api.ts +113 -6
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +91 -3
- package/dist/api.js +33 -7
- 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 +91 -3
- package/dist/esm/api.js +32 -6
- 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/Application.md +2 -0
- package/docs/ApplicationProperties.md +25 -0
- package/docs/ApplicationPropertiesPosition.md +23 -0
- package/docs/CreateApplication.md +2 -0
- package/docs/CreateApplicationProperties.md +25 -0
- package/docs/CreateApplicationPropertiesPosition.md +23 -0
- package/docs/ProductsApi.md +9 -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.58.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.58.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -78,6 +78,8 @@ Class | Method | HTTP request | Description
|
|
|
78
78
|
- [ApiError](docs/ApiError.md)
|
|
79
79
|
- [Application](docs/Application.md)
|
|
80
80
|
- [ApplicationMockup](docs/ApplicationMockup.md)
|
|
81
|
+
- [ApplicationProperties](docs/ApplicationProperties.md)
|
|
82
|
+
- [ApplicationPropertiesPosition](docs/ApplicationPropertiesPosition.md)
|
|
81
83
|
- [ApplicationSet](docs/ApplicationSet.md)
|
|
82
84
|
- [ApplicationSet1](docs/ApplicationSet1.md)
|
|
83
85
|
- [ApplicationSetRecord](docs/ApplicationSetRecord.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.58.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -103,6 +103,12 @@ export interface Application {
|
|
|
103
103
|
* @memberof Application
|
|
104
104
|
*/
|
|
105
105
|
'stockedOnly'?: boolean;
|
|
106
|
+
/**
|
|
107
|
+
*
|
|
108
|
+
* @type {ApplicationProperties}
|
|
109
|
+
* @memberof Application
|
|
110
|
+
*/
|
|
111
|
+
'properties'?: ApplicationProperties | null;
|
|
106
112
|
}
|
|
107
113
|
|
|
108
114
|
export const ApplicationTechnologyEnum = {
|
|
@@ -147,6 +153,50 @@ export interface ApplicationMockup {
|
|
|
147
153
|
*/
|
|
148
154
|
'preview'?: string;
|
|
149
155
|
}
|
|
156
|
+
/**
|
|
157
|
+
* Optional properties for the application. Leave width, height and position empty and the system will automatically calculate the size for the application.
|
|
158
|
+
* @export
|
|
159
|
+
* @interface ApplicationProperties
|
|
160
|
+
*/
|
|
161
|
+
export interface ApplicationProperties {
|
|
162
|
+
/**
|
|
163
|
+
* Width of the application in pixels
|
|
164
|
+
* @type {number}
|
|
165
|
+
* @memberof ApplicationProperties
|
|
166
|
+
*/
|
|
167
|
+
'width'?: number | null;
|
|
168
|
+
/**
|
|
169
|
+
* Height of the application in pixels
|
|
170
|
+
* @type {number}
|
|
171
|
+
* @memberof ApplicationProperties
|
|
172
|
+
*/
|
|
173
|
+
'height'?: number | null;
|
|
174
|
+
/**
|
|
175
|
+
*
|
|
176
|
+
* @type {ApplicationPropertiesPosition}
|
|
177
|
+
* @memberof ApplicationProperties
|
|
178
|
+
*/
|
|
179
|
+
'position'?: ApplicationPropertiesPosition | null;
|
|
180
|
+
}
|
|
181
|
+
/**
|
|
182
|
+
* Position of the application
|
|
183
|
+
* @export
|
|
184
|
+
* @interface ApplicationPropertiesPosition
|
|
185
|
+
*/
|
|
186
|
+
export interface ApplicationPropertiesPosition {
|
|
187
|
+
/**
|
|
188
|
+
* X coordinate of the application in pixels relative to the bounding box of the product
|
|
189
|
+
* @type {number}
|
|
190
|
+
* @memberof ApplicationPropertiesPosition
|
|
191
|
+
*/
|
|
192
|
+
'x': number;
|
|
193
|
+
/**
|
|
194
|
+
* Y coordinate of the application in pixels relative to the bounding box of the product
|
|
195
|
+
* @type {number}
|
|
196
|
+
* @memberof ApplicationPropertiesPosition
|
|
197
|
+
*/
|
|
198
|
+
'y': number;
|
|
199
|
+
}
|
|
150
200
|
/**
|
|
151
201
|
*
|
|
152
202
|
* @export
|
|
@@ -460,6 +510,12 @@ export interface CreateApplication {
|
|
|
460
510
|
* @memberof CreateApplication
|
|
461
511
|
*/
|
|
462
512
|
'stockedOnly'?: boolean;
|
|
513
|
+
/**
|
|
514
|
+
*
|
|
515
|
+
* @type {ApplicationProperties}
|
|
516
|
+
* @memberof CreateApplication
|
|
517
|
+
*/
|
|
518
|
+
'properties'?: ApplicationProperties | null;
|
|
463
519
|
}
|
|
464
520
|
|
|
465
521
|
export const CreateApplicationTechnologyEnum = {
|
|
@@ -3433,12 +3489,15 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
3433
3489
|
* @param {number} [pageToken] Page reference token
|
|
3434
3490
|
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', and \'tag:\"tag name\"\'. Multiple filters can be combined with spaces and commas.
|
|
3435
3491
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
3492
|
+
* @param {string} [start] Start of date range to filter
|
|
3493
|
+
* @param {string} [end] End of date range to filter
|
|
3494
|
+
* @param {ListProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
3436
3495
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3437
3496
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
3438
3497
|
* @param {*} [options] Override http request option.
|
|
3439
3498
|
* @throws {RequiredError}
|
|
3440
3499
|
*/
|
|
3441
|
-
listProducts: async (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3500
|
+
listProducts: async (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, dateFilterType?: ListProductsDateFilterTypeEnum, pageSize?: number, fields?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3442
3501
|
// verify required parameter 'project' is not null or undefined
|
|
3443
3502
|
assertParamExists('listProducts', 'project', project)
|
|
3444
3503
|
const localVarPath = `/v1/catalog/products`;
|
|
@@ -3476,6 +3535,22 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
3476
3535
|
localVarQueryParameter['sortBy'] = sortBy;
|
|
3477
3536
|
}
|
|
3478
3537
|
|
|
3538
|
+
if (start !== undefined) {
|
|
3539
|
+
localVarQueryParameter['start'] = (start as any instanceof Date) ?
|
|
3540
|
+
(start as any).toISOString() :
|
|
3541
|
+
start;
|
|
3542
|
+
}
|
|
3543
|
+
|
|
3544
|
+
if (end !== undefined) {
|
|
3545
|
+
localVarQueryParameter['end'] = (end as any instanceof Date) ?
|
|
3546
|
+
(end as any).toISOString() :
|
|
3547
|
+
end;
|
|
3548
|
+
}
|
|
3549
|
+
|
|
3550
|
+
if (dateFilterType !== undefined) {
|
|
3551
|
+
localVarQueryParameter['dateFilterType'] = dateFilterType;
|
|
3552
|
+
}
|
|
3553
|
+
|
|
3479
3554
|
if (pageSize !== undefined) {
|
|
3480
3555
|
localVarQueryParameter['pageSize'] = pageSize;
|
|
3481
3556
|
}
|
|
@@ -3760,13 +3835,16 @@ export const ProductsApiFp = function(configuration?: Configuration) {
|
|
|
3760
3835
|
* @param {number} [pageToken] Page reference token
|
|
3761
3836
|
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', and \'tag:\"tag name\"\'. Multiple filters can be combined with spaces and commas.
|
|
3762
3837
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
3838
|
+
* @param {string} [start] Start of date range to filter
|
|
3839
|
+
* @param {string} [end] End of date range to filter
|
|
3840
|
+
* @param {ListProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
3763
3841
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3764
3842
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
3765
3843
|
* @param {*} [options] Override http request option.
|
|
3766
3844
|
* @throws {RequiredError}
|
|
3767
3845
|
*/
|
|
3768
|
-
async listProducts(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>> {
|
|
3769
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listProducts(project, pageToken, search, sortBy, pageSize, fields, options);
|
|
3846
|
+
async listProducts(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, dateFilterType?: ListProductsDateFilterTypeEnum, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>> {
|
|
3847
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listProducts(project, pageToken, search, sortBy, start, end, dateFilterType, pageSize, fields, options);
|
|
3770
3848
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3771
3849
|
const localVarOperationServerBasePath = operationServerMap['ProductsApi.listProducts']?.[localVarOperationServerIndex]?.url;
|
|
3772
3850
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -3902,7 +3980,7 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
|
|
|
3902
3980
|
* @throws {RequiredError}
|
|
3903
3981
|
*/
|
|
3904
3982
|
listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductsResponse> {
|
|
3905
|
-
return localVarFp.listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(axios, basePath));
|
|
3983
|
+
return localVarFp.listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(axios, basePath));
|
|
3906
3984
|
},
|
|
3907
3985
|
/**
|
|
3908
3986
|
* AI SEO optimises products by a set of given IDs.
|
|
@@ -4118,6 +4196,27 @@ export interface ProductsApiListProductsRequest {
|
|
|
4118
4196
|
*/
|
|
4119
4197
|
readonly sortBy?: Array<string>
|
|
4120
4198
|
|
|
4199
|
+
/**
|
|
4200
|
+
* Start of date range to filter
|
|
4201
|
+
* @type {string}
|
|
4202
|
+
* @memberof ProductsApiListProducts
|
|
4203
|
+
*/
|
|
4204
|
+
readonly start?: string
|
|
4205
|
+
|
|
4206
|
+
/**
|
|
4207
|
+
* End of date range to filter
|
|
4208
|
+
* @type {string}
|
|
4209
|
+
* @memberof ProductsApiListProducts
|
|
4210
|
+
*/
|
|
4211
|
+
readonly end?: string
|
|
4212
|
+
|
|
4213
|
+
/**
|
|
4214
|
+
* Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
4215
|
+
* @type {'createdAt' | 'updatedAt'}
|
|
4216
|
+
* @memberof ProductsApiListProducts
|
|
4217
|
+
*/
|
|
4218
|
+
readonly dateFilterType?: ListProductsDateFilterTypeEnum
|
|
4219
|
+
|
|
4121
4220
|
/**
|
|
4122
4221
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4123
4222
|
* @type {number}
|
|
@@ -4303,7 +4402,7 @@ export class ProductsApi extends BaseAPI {
|
|
|
4303
4402
|
* @memberof ProductsApi
|
|
4304
4403
|
*/
|
|
4305
4404
|
public listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig) {
|
|
4306
|
-
return ProductsApiFp(this.configuration).listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
4405
|
+
return ProductsApiFp(this.configuration).listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
4307
4406
|
}
|
|
4308
4407
|
|
|
4309
4408
|
/**
|
|
@@ -4343,6 +4442,14 @@ export class ProductsApi extends BaseAPI {
|
|
|
4343
4442
|
}
|
|
4344
4443
|
}
|
|
4345
4444
|
|
|
4445
|
+
/**
|
|
4446
|
+
* @export
|
|
4447
|
+
*/
|
|
4448
|
+
export const ListProductsDateFilterTypeEnum = {
|
|
4449
|
+
CreatedAt: 'createdAt',
|
|
4450
|
+
UpdatedAt: 'updatedAt'
|
|
4451
|
+
} as const;
|
|
4452
|
+
export type ListProductsDateFilterTypeEnum = typeof ListProductsDateFilterTypeEnum[keyof typeof ListProductsDateFilterTypeEnum];
|
|
4346
4453
|
|
|
4347
4454
|
|
|
4348
4455
|
/**
|
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.58.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.58.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/configuration.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.58.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* 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.58.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -93,6 +93,12 @@ export interface Application {
|
|
|
93
93
|
* @memberof Application
|
|
94
94
|
*/
|
|
95
95
|
'stockedOnly'?: boolean;
|
|
96
|
+
/**
|
|
97
|
+
*
|
|
98
|
+
* @type {ApplicationProperties}
|
|
99
|
+
* @memberof Application
|
|
100
|
+
*/
|
|
101
|
+
'properties'?: ApplicationProperties | null;
|
|
96
102
|
}
|
|
97
103
|
export declare const ApplicationTechnologyEnum: {
|
|
98
104
|
readonly Dtg: "dtg";
|
|
@@ -133,6 +139,50 @@ export interface ApplicationMockup {
|
|
|
133
139
|
*/
|
|
134
140
|
'preview'?: string;
|
|
135
141
|
}
|
|
142
|
+
/**
|
|
143
|
+
* Optional properties for the application. Leave width, height and position empty and the system will automatically calculate the size for the application.
|
|
144
|
+
* @export
|
|
145
|
+
* @interface ApplicationProperties
|
|
146
|
+
*/
|
|
147
|
+
export interface ApplicationProperties {
|
|
148
|
+
/**
|
|
149
|
+
* Width of the application in pixels
|
|
150
|
+
* @type {number}
|
|
151
|
+
* @memberof ApplicationProperties
|
|
152
|
+
*/
|
|
153
|
+
'width'?: number | null;
|
|
154
|
+
/**
|
|
155
|
+
* Height of the application in pixels
|
|
156
|
+
* @type {number}
|
|
157
|
+
* @memberof ApplicationProperties
|
|
158
|
+
*/
|
|
159
|
+
'height'?: number | null;
|
|
160
|
+
/**
|
|
161
|
+
*
|
|
162
|
+
* @type {ApplicationPropertiesPosition}
|
|
163
|
+
* @memberof ApplicationProperties
|
|
164
|
+
*/
|
|
165
|
+
'position'?: ApplicationPropertiesPosition | null;
|
|
166
|
+
}
|
|
167
|
+
/**
|
|
168
|
+
* Position of the application
|
|
169
|
+
* @export
|
|
170
|
+
* @interface ApplicationPropertiesPosition
|
|
171
|
+
*/
|
|
172
|
+
export interface ApplicationPropertiesPosition {
|
|
173
|
+
/**
|
|
174
|
+
* X coordinate of the application in pixels relative to the bounding box of the product
|
|
175
|
+
* @type {number}
|
|
176
|
+
* @memberof ApplicationPropertiesPosition
|
|
177
|
+
*/
|
|
178
|
+
'x': number;
|
|
179
|
+
/**
|
|
180
|
+
* Y coordinate of the application in pixels relative to the bounding box of the product
|
|
181
|
+
* @type {number}
|
|
182
|
+
* @memberof ApplicationPropertiesPosition
|
|
183
|
+
*/
|
|
184
|
+
'y': number;
|
|
185
|
+
}
|
|
136
186
|
/**
|
|
137
187
|
*
|
|
138
188
|
* @export
|
|
@@ -443,6 +493,12 @@ export interface CreateApplication {
|
|
|
443
493
|
* @memberof CreateApplication
|
|
444
494
|
*/
|
|
445
495
|
'stockedOnly'?: boolean;
|
|
496
|
+
/**
|
|
497
|
+
*
|
|
498
|
+
* @type {ApplicationProperties}
|
|
499
|
+
* @memberof CreateApplication
|
|
500
|
+
*/
|
|
501
|
+
'properties'?: ApplicationProperties | null;
|
|
446
502
|
}
|
|
447
503
|
export declare const CreateApplicationTechnologyEnum: {
|
|
448
504
|
readonly Dtg: "dtg";
|
|
@@ -2775,12 +2831,15 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
2775
2831
|
* @param {number} [pageToken] Page reference token
|
|
2776
2832
|
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', and \'tag:\"tag name\"\'. Multiple filters can be combined with spaces and commas.
|
|
2777
2833
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2834
|
+
* @param {string} [start] Start of date range to filter
|
|
2835
|
+
* @param {string} [end] End of date range to filter
|
|
2836
|
+
* @param {ListProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2778
2837
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2779
2838
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
2780
2839
|
* @param {*} [options] Override http request option.
|
|
2781
2840
|
* @throws {RequiredError}
|
|
2782
2841
|
*/
|
|
2783
|
-
listProducts: (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2842
|
+
listProducts: (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, dateFilterType?: ListProductsDateFilterTypeEnum, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2784
2843
|
/**
|
|
2785
2844
|
* AI SEO optimises products by a set of given IDs.
|
|
2786
2845
|
* @summary AI SEO optimise products.
|
|
@@ -2885,12 +2944,15 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
2885
2944
|
* @param {number} [pageToken] Page reference token
|
|
2886
2945
|
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', and \'tag:\"tag name\"\'. Multiple filters can be combined with spaces and commas.
|
|
2887
2946
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2947
|
+
* @param {string} [start] Start of date range to filter
|
|
2948
|
+
* @param {string} [end] End of date range to filter
|
|
2949
|
+
* @param {ListProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2888
2950
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2889
2951
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
2890
2952
|
* @param {*} [options] Override http request option.
|
|
2891
2953
|
* @throws {RequiredError}
|
|
2892
2954
|
*/
|
|
2893
|
-
listProducts(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>>;
|
|
2955
|
+
listProducts(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, dateFilterType?: ListProductsDateFilterTypeEnum, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>>;
|
|
2894
2956
|
/**
|
|
2895
2957
|
* AI SEO optimises products by a set of given IDs.
|
|
2896
2958
|
* @summary AI SEO optimise products.
|
|
@@ -3177,6 +3239,24 @@ export interface ProductsApiListProductsRequest {
|
|
|
3177
3239
|
* @memberof ProductsApiListProducts
|
|
3178
3240
|
*/
|
|
3179
3241
|
readonly sortBy?: Array<string>;
|
|
3242
|
+
/**
|
|
3243
|
+
* Start of date range to filter
|
|
3244
|
+
* @type {string}
|
|
3245
|
+
* @memberof ProductsApiListProducts
|
|
3246
|
+
*/
|
|
3247
|
+
readonly start?: string;
|
|
3248
|
+
/**
|
|
3249
|
+
* End of date range to filter
|
|
3250
|
+
* @type {string}
|
|
3251
|
+
* @memberof ProductsApiListProducts
|
|
3252
|
+
*/
|
|
3253
|
+
readonly end?: string;
|
|
3254
|
+
/**
|
|
3255
|
+
* Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
3256
|
+
* @type {'createdAt' | 'updatedAt'}
|
|
3257
|
+
* @memberof ProductsApiListProducts
|
|
3258
|
+
*/
|
|
3259
|
+
readonly dateFilterType?: ListProductsDateFilterTypeEnum;
|
|
3180
3260
|
/**
|
|
3181
3261
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3182
3262
|
* @type {number}
|
|
@@ -3360,6 +3440,14 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
3360
3440
|
*/
|
|
3361
3441
|
updateProducts(requestParameters: ProductsApiUpdateProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductsResponse, any>>;
|
|
3362
3442
|
}
|
|
3443
|
+
/**
|
|
3444
|
+
* @export
|
|
3445
|
+
*/
|
|
3446
|
+
export declare const ListProductsDateFilterTypeEnum: {
|
|
3447
|
+
readonly CreatedAt: "createdAt";
|
|
3448
|
+
readonly UpdatedAt: "updatedAt";
|
|
3449
|
+
};
|
|
3450
|
+
export type ListProductsDateFilterTypeEnum = typeof ListProductsDateFilterTypeEnum[keyof typeof ListProductsDateFilterTypeEnum];
|
|
3363
3451
|
/**
|
|
3364
3452
|
* VariantsApi - axios parameter creator
|
|
3365
3453
|
* @export
|
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.58.0
|
|
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.ProductsApi = exports.ProductsApiFactory = exports.ProductsApiFp = exports.ProductsApiAxiosParamCreator = exports.ApplicationTechnologiesApi = exports.ApplicationTechnologiesApiFactory = exports.ApplicationTechnologiesApiFp = exports.ApplicationTechnologiesApiAxiosParamCreator = exports.ApplicationSetsApi = exports.ApplicationSetsApiFactory = exports.ApplicationSetsApiFp = exports.ApplicationSetsApiAxiosParamCreator = exports.UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum = exports.UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum = exports.UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum = exports.SalePriceCurrencyCodeEnum = exports.PriceCurrencyCodeEnum = exports.CreateApplicationPlacementEnum = exports.CreateApplicationTechnologyEnum = exports.AttributeThumbnailTypeEnum = 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.ApplicationTechnologiesApi = exports.ApplicationTechnologiesApiFactory = exports.ApplicationTechnologiesApiFp = exports.ApplicationTechnologiesApiAxiosParamCreator = exports.ApplicationSetsApi = exports.ApplicationSetsApiFactory = exports.ApplicationSetsApiFp = exports.ApplicationSetsApiAxiosParamCreator = exports.UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum = exports.UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum = exports.UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum = exports.SalePriceCurrencyCodeEnum = exports.PriceCurrencyCodeEnum = exports.CreateApplicationPlacementEnum = exports.CreateApplicationTechnologyEnum = exports.AttributeThumbnailTypeEnum = 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
|
|
@@ -929,12 +929,15 @@ const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
929
929
|
* @param {number} [pageToken] Page reference token
|
|
930
930
|
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', and \'tag:\"tag name\"\'. Multiple filters can be combined with spaces and commas.
|
|
931
931
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
932
|
+
* @param {string} [start] Start of date range to filter
|
|
933
|
+
* @param {string} [end] End of date range to filter
|
|
934
|
+
* @param {ListProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
932
935
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
933
936
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
934
937
|
* @param {*} [options] Override http request option.
|
|
935
938
|
* @throws {RequiredError}
|
|
936
939
|
*/
|
|
937
|
-
listProducts: (project_1, pageToken_1, search_1, sortBy_1, pageSize_1, fields_1, ...args_1) => __awaiter(this, [project_1, pageToken_1, search_1, sortBy_1, pageSize_1, fields_1, ...args_1], void 0, function* (project, pageToken, search, sortBy, pageSize, fields, options = {}) {
|
|
940
|
+
listProducts: (project_1, pageToken_1, search_1, sortBy_1, start_1, end_1, dateFilterType_1, pageSize_1, fields_1, ...args_1) => __awaiter(this, [project_1, pageToken_1, search_1, sortBy_1, start_1, end_1, dateFilterType_1, pageSize_1, fields_1, ...args_1], void 0, function* (project, pageToken, search, sortBy, start, end, dateFilterType, pageSize, fields, options = {}) {
|
|
938
941
|
// verify required parameter 'project' is not null or undefined
|
|
939
942
|
(0, common_1.assertParamExists)('listProducts', 'project', project);
|
|
940
943
|
const localVarPath = `/v1/catalog/products`;
|
|
@@ -964,6 +967,19 @@ const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
964
967
|
if (sortBy) {
|
|
965
968
|
localVarQueryParameter['sortBy'] = sortBy;
|
|
966
969
|
}
|
|
970
|
+
if (start !== undefined) {
|
|
971
|
+
localVarQueryParameter['start'] = (start instanceof Date) ?
|
|
972
|
+
start.toISOString() :
|
|
973
|
+
start;
|
|
974
|
+
}
|
|
975
|
+
if (end !== undefined) {
|
|
976
|
+
localVarQueryParameter['end'] = (end instanceof Date) ?
|
|
977
|
+
end.toISOString() :
|
|
978
|
+
end;
|
|
979
|
+
}
|
|
980
|
+
if (dateFilterType !== undefined) {
|
|
981
|
+
localVarQueryParameter['dateFilterType'] = dateFilterType;
|
|
982
|
+
}
|
|
967
983
|
if (pageSize !== undefined) {
|
|
968
984
|
localVarQueryParameter['pageSize'] = pageSize;
|
|
969
985
|
}
|
|
@@ -1237,15 +1253,18 @@ const ProductsApiFp = function (configuration) {
|
|
|
1237
1253
|
* @param {number} [pageToken] Page reference token
|
|
1238
1254
|
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', and \'tag:\"tag name\"\'. Multiple filters can be combined with spaces and commas.
|
|
1239
1255
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1256
|
+
* @param {string} [start] Start of date range to filter
|
|
1257
|
+
* @param {string} [end] End of date range to filter
|
|
1258
|
+
* @param {ListProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1240
1259
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1241
1260
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1242
1261
|
* @param {*} [options] Override http request option.
|
|
1243
1262
|
* @throws {RequiredError}
|
|
1244
1263
|
*/
|
|
1245
|
-
listProducts(project, pageToken, search, sortBy, pageSize, fields, options) {
|
|
1264
|
+
listProducts(project, pageToken, search, sortBy, start, end, dateFilterType, pageSize, fields, options) {
|
|
1246
1265
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1247
1266
|
var _a, _b, _c;
|
|
1248
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.listProducts(project, pageToken, search, sortBy, pageSize, fields, options);
|
|
1267
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listProducts(project, pageToken, search, sortBy, start, end, dateFilterType, pageSize, fields, options);
|
|
1249
1268
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1250
1269
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProductsApi.listProducts']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1251
1270
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1391,7 +1410,7 @@ const ProductsApiFactory = function (configuration, basePath, axios) {
|
|
|
1391
1410
|
* @throws {RequiredError}
|
|
1392
1411
|
*/
|
|
1393
1412
|
listProducts(requestParameters, options) {
|
|
1394
|
-
return localVarFp.listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(axios, basePath));
|
|
1413
|
+
return localVarFp.listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(axios, basePath));
|
|
1395
1414
|
},
|
|
1396
1415
|
/**
|
|
1397
1416
|
* AI SEO optimises products by a set of given IDs.
|
|
@@ -1519,7 +1538,7 @@ class ProductsApi extends base_1.BaseAPI {
|
|
|
1519
1538
|
* @memberof ProductsApi
|
|
1520
1539
|
*/
|
|
1521
1540
|
listProducts(requestParameters, options) {
|
|
1522
|
-
return (0, exports.ProductsApiFp)(this.configuration).listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
1541
|
+
return (0, exports.ProductsApiFp)(this.configuration).listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
1523
1542
|
}
|
|
1524
1543
|
/**
|
|
1525
1544
|
* AI SEO optimises products by a set of given IDs.
|
|
@@ -1556,6 +1575,13 @@ class ProductsApi extends base_1.BaseAPI {
|
|
|
1556
1575
|
}
|
|
1557
1576
|
}
|
|
1558
1577
|
exports.ProductsApi = ProductsApi;
|
|
1578
|
+
/**
|
|
1579
|
+
* @export
|
|
1580
|
+
*/
|
|
1581
|
+
exports.ListProductsDateFilterTypeEnum = {
|
|
1582
|
+
CreatedAt: 'createdAt',
|
|
1583
|
+
UpdatedAt: 'updatedAt'
|
|
1584
|
+
};
|
|
1559
1585
|
/**
|
|
1560
1586
|
* VariantsApi - axios parameter creator
|
|
1561
1587
|
* @export
|
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.58.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/base.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Product Catalog API
|
|
6
6
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.58.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Product Catalog API
|
|
3
3
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.58.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Product Catalog API
|
|
6
6
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.58.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Product Catalog API
|
|
3
3
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.58.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.js
CHANGED
|
@@ -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.58.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* 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.58.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -93,6 +93,12 @@ export interface Application {
|
|
|
93
93
|
* @memberof Application
|
|
94
94
|
*/
|
|
95
95
|
'stockedOnly'?: boolean;
|
|
96
|
+
/**
|
|
97
|
+
*
|
|
98
|
+
* @type {ApplicationProperties}
|
|
99
|
+
* @memberof Application
|
|
100
|
+
*/
|
|
101
|
+
'properties'?: ApplicationProperties | null;
|
|
96
102
|
}
|
|
97
103
|
export declare const ApplicationTechnologyEnum: {
|
|
98
104
|
readonly Dtg: "dtg";
|
|
@@ -133,6 +139,50 @@ export interface ApplicationMockup {
|
|
|
133
139
|
*/
|
|
134
140
|
'preview'?: string;
|
|
135
141
|
}
|
|
142
|
+
/**
|
|
143
|
+
* Optional properties for the application. Leave width, height and position empty and the system will automatically calculate the size for the application.
|
|
144
|
+
* @export
|
|
145
|
+
* @interface ApplicationProperties
|
|
146
|
+
*/
|
|
147
|
+
export interface ApplicationProperties {
|
|
148
|
+
/**
|
|
149
|
+
* Width of the application in pixels
|
|
150
|
+
* @type {number}
|
|
151
|
+
* @memberof ApplicationProperties
|
|
152
|
+
*/
|
|
153
|
+
'width'?: number | null;
|
|
154
|
+
/**
|
|
155
|
+
* Height of the application in pixels
|
|
156
|
+
* @type {number}
|
|
157
|
+
* @memberof ApplicationProperties
|
|
158
|
+
*/
|
|
159
|
+
'height'?: number | null;
|
|
160
|
+
/**
|
|
161
|
+
*
|
|
162
|
+
* @type {ApplicationPropertiesPosition}
|
|
163
|
+
* @memberof ApplicationProperties
|
|
164
|
+
*/
|
|
165
|
+
'position'?: ApplicationPropertiesPosition | null;
|
|
166
|
+
}
|
|
167
|
+
/**
|
|
168
|
+
* Position of the application
|
|
169
|
+
* @export
|
|
170
|
+
* @interface ApplicationPropertiesPosition
|
|
171
|
+
*/
|
|
172
|
+
export interface ApplicationPropertiesPosition {
|
|
173
|
+
/**
|
|
174
|
+
* X coordinate of the application in pixels relative to the bounding box of the product
|
|
175
|
+
* @type {number}
|
|
176
|
+
* @memberof ApplicationPropertiesPosition
|
|
177
|
+
*/
|
|
178
|
+
'x': number;
|
|
179
|
+
/**
|
|
180
|
+
* Y coordinate of the application in pixels relative to the bounding box of the product
|
|
181
|
+
* @type {number}
|
|
182
|
+
* @memberof ApplicationPropertiesPosition
|
|
183
|
+
*/
|
|
184
|
+
'y': number;
|
|
185
|
+
}
|
|
136
186
|
/**
|
|
137
187
|
*
|
|
138
188
|
* @export
|
|
@@ -443,6 +493,12 @@ export interface CreateApplication {
|
|
|
443
493
|
* @memberof CreateApplication
|
|
444
494
|
*/
|
|
445
495
|
'stockedOnly'?: boolean;
|
|
496
|
+
/**
|
|
497
|
+
*
|
|
498
|
+
* @type {ApplicationProperties}
|
|
499
|
+
* @memberof CreateApplication
|
|
500
|
+
*/
|
|
501
|
+
'properties'?: ApplicationProperties | null;
|
|
446
502
|
}
|
|
447
503
|
export declare const CreateApplicationTechnologyEnum: {
|
|
448
504
|
readonly Dtg: "dtg";
|
|
@@ -2775,12 +2831,15 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
2775
2831
|
* @param {number} [pageToken] Page reference token
|
|
2776
2832
|
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', and \'tag:\"tag name\"\'. Multiple filters can be combined with spaces and commas.
|
|
2777
2833
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2834
|
+
* @param {string} [start] Start of date range to filter
|
|
2835
|
+
* @param {string} [end] End of date range to filter
|
|
2836
|
+
* @param {ListProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2778
2837
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2779
2838
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
2780
2839
|
* @param {*} [options] Override http request option.
|
|
2781
2840
|
* @throws {RequiredError}
|
|
2782
2841
|
*/
|
|
2783
|
-
listProducts: (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2842
|
+
listProducts: (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, dateFilterType?: ListProductsDateFilterTypeEnum, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2784
2843
|
/**
|
|
2785
2844
|
* AI SEO optimises products by a set of given IDs.
|
|
2786
2845
|
* @summary AI SEO optimise products.
|
|
@@ -2885,12 +2944,15 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
2885
2944
|
* @param {number} [pageToken] Page reference token
|
|
2886
2945
|
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', and \'tag:\"tag name\"\'. Multiple filters can be combined with spaces and commas.
|
|
2887
2946
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2947
|
+
* @param {string} [start] Start of date range to filter
|
|
2948
|
+
* @param {string} [end] End of date range to filter
|
|
2949
|
+
* @param {ListProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2888
2950
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2889
2951
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
2890
2952
|
* @param {*} [options] Override http request option.
|
|
2891
2953
|
* @throws {RequiredError}
|
|
2892
2954
|
*/
|
|
2893
|
-
listProducts(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>>;
|
|
2955
|
+
listProducts(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, dateFilterType?: ListProductsDateFilterTypeEnum, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>>;
|
|
2894
2956
|
/**
|
|
2895
2957
|
* AI SEO optimises products by a set of given IDs.
|
|
2896
2958
|
* @summary AI SEO optimise products.
|
|
@@ -3177,6 +3239,24 @@ export interface ProductsApiListProductsRequest {
|
|
|
3177
3239
|
* @memberof ProductsApiListProducts
|
|
3178
3240
|
*/
|
|
3179
3241
|
readonly sortBy?: Array<string>;
|
|
3242
|
+
/**
|
|
3243
|
+
* Start of date range to filter
|
|
3244
|
+
* @type {string}
|
|
3245
|
+
* @memberof ProductsApiListProducts
|
|
3246
|
+
*/
|
|
3247
|
+
readonly start?: string;
|
|
3248
|
+
/**
|
|
3249
|
+
* End of date range to filter
|
|
3250
|
+
* @type {string}
|
|
3251
|
+
* @memberof ProductsApiListProducts
|
|
3252
|
+
*/
|
|
3253
|
+
readonly end?: string;
|
|
3254
|
+
/**
|
|
3255
|
+
* Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
3256
|
+
* @type {'createdAt' | 'updatedAt'}
|
|
3257
|
+
* @memberof ProductsApiListProducts
|
|
3258
|
+
*/
|
|
3259
|
+
readonly dateFilterType?: ListProductsDateFilterTypeEnum;
|
|
3180
3260
|
/**
|
|
3181
3261
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3182
3262
|
* @type {number}
|
|
@@ -3360,6 +3440,14 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
3360
3440
|
*/
|
|
3361
3441
|
updateProducts(requestParameters: ProductsApiUpdateProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductsResponse, any>>;
|
|
3362
3442
|
}
|
|
3443
|
+
/**
|
|
3444
|
+
* @export
|
|
3445
|
+
*/
|
|
3446
|
+
export declare const ListProductsDateFilterTypeEnum: {
|
|
3447
|
+
readonly CreatedAt: "createdAt";
|
|
3448
|
+
readonly UpdatedAt: "updatedAt";
|
|
3449
|
+
};
|
|
3450
|
+
export type ListProductsDateFilterTypeEnum = typeof ListProductsDateFilterTypeEnum[keyof typeof ListProductsDateFilterTypeEnum];
|
|
3363
3451
|
/**
|
|
3364
3452
|
* VariantsApi - axios parameter creator
|
|
3365
3453
|
* @export
|
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.58.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -918,12 +918,15 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
918
918
|
* @param {number} [pageToken] Page reference token
|
|
919
919
|
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', and \'tag:\"tag name\"\'. Multiple filters can be combined with spaces and commas.
|
|
920
920
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
921
|
+
* @param {string} [start] Start of date range to filter
|
|
922
|
+
* @param {string} [end] End of date range to filter
|
|
923
|
+
* @param {ListProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
921
924
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
922
925
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
923
926
|
* @param {*} [options] Override http request option.
|
|
924
927
|
* @throws {RequiredError}
|
|
925
928
|
*/
|
|
926
|
-
listProducts: (project_1, pageToken_1, search_1, sortBy_1, pageSize_1, fields_1, ...args_1) => __awaiter(this, [project_1, pageToken_1, search_1, sortBy_1, pageSize_1, fields_1, ...args_1], void 0, function* (project, pageToken, search, sortBy, pageSize, fields, options = {}) {
|
|
929
|
+
listProducts: (project_1, pageToken_1, search_1, sortBy_1, start_1, end_1, dateFilterType_1, pageSize_1, fields_1, ...args_1) => __awaiter(this, [project_1, pageToken_1, search_1, sortBy_1, start_1, end_1, dateFilterType_1, pageSize_1, fields_1, ...args_1], void 0, function* (project, pageToken, search, sortBy, start, end, dateFilterType, pageSize, fields, options = {}) {
|
|
927
930
|
// verify required parameter 'project' is not null or undefined
|
|
928
931
|
assertParamExists('listProducts', 'project', project);
|
|
929
932
|
const localVarPath = `/v1/catalog/products`;
|
|
@@ -953,6 +956,19 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
953
956
|
if (sortBy) {
|
|
954
957
|
localVarQueryParameter['sortBy'] = sortBy;
|
|
955
958
|
}
|
|
959
|
+
if (start !== undefined) {
|
|
960
|
+
localVarQueryParameter['start'] = (start instanceof Date) ?
|
|
961
|
+
start.toISOString() :
|
|
962
|
+
start;
|
|
963
|
+
}
|
|
964
|
+
if (end !== undefined) {
|
|
965
|
+
localVarQueryParameter['end'] = (end instanceof Date) ?
|
|
966
|
+
end.toISOString() :
|
|
967
|
+
end;
|
|
968
|
+
}
|
|
969
|
+
if (dateFilterType !== undefined) {
|
|
970
|
+
localVarQueryParameter['dateFilterType'] = dateFilterType;
|
|
971
|
+
}
|
|
956
972
|
if (pageSize !== undefined) {
|
|
957
973
|
localVarQueryParameter['pageSize'] = pageSize;
|
|
958
974
|
}
|
|
@@ -1225,15 +1241,18 @@ export const ProductsApiFp = function (configuration) {
|
|
|
1225
1241
|
* @param {number} [pageToken] Page reference token
|
|
1226
1242
|
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', and \'tag:\"tag name\"\'. Multiple filters can be combined with spaces and commas.
|
|
1227
1243
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1244
|
+
* @param {string} [start] Start of date range to filter
|
|
1245
|
+
* @param {string} [end] End of date range to filter
|
|
1246
|
+
* @param {ListProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1228
1247
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1229
1248
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1230
1249
|
* @param {*} [options] Override http request option.
|
|
1231
1250
|
* @throws {RequiredError}
|
|
1232
1251
|
*/
|
|
1233
|
-
listProducts(project, pageToken, search, sortBy, pageSize, fields, options) {
|
|
1252
|
+
listProducts(project, pageToken, search, sortBy, start, end, dateFilterType, pageSize, fields, options) {
|
|
1234
1253
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1235
1254
|
var _a, _b, _c;
|
|
1236
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.listProducts(project, pageToken, search, sortBy, pageSize, fields, options);
|
|
1255
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listProducts(project, pageToken, search, sortBy, start, end, dateFilterType, pageSize, fields, options);
|
|
1237
1256
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1238
1257
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductsApi.listProducts']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1239
1258
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1378,7 +1397,7 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
|
|
|
1378
1397
|
* @throws {RequiredError}
|
|
1379
1398
|
*/
|
|
1380
1399
|
listProducts(requestParameters, options) {
|
|
1381
|
-
return localVarFp.listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(axios, basePath));
|
|
1400
|
+
return localVarFp.listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(axios, basePath));
|
|
1382
1401
|
},
|
|
1383
1402
|
/**
|
|
1384
1403
|
* AI SEO optimises products by a set of given IDs.
|
|
@@ -1505,7 +1524,7 @@ export class ProductsApi extends BaseAPI {
|
|
|
1505
1524
|
* @memberof ProductsApi
|
|
1506
1525
|
*/
|
|
1507
1526
|
listProducts(requestParameters, options) {
|
|
1508
|
-
return ProductsApiFp(this.configuration).listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
1527
|
+
return ProductsApiFp(this.configuration).listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
1509
1528
|
}
|
|
1510
1529
|
/**
|
|
1511
1530
|
* AI SEO optimises products by a set of given IDs.
|
|
@@ -1541,6 +1560,13 @@ export class ProductsApi extends BaseAPI {
|
|
|
1541
1560
|
return ProductsApiFp(this.configuration).updateProducts(requestParameters.project, requestParameters.updateProductsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1542
1561
|
}
|
|
1543
1562
|
}
|
|
1563
|
+
/**
|
|
1564
|
+
* @export
|
|
1565
|
+
*/
|
|
1566
|
+
export const ListProductsDateFilterTypeEnum = {
|
|
1567
|
+
CreatedAt: 'createdAt',
|
|
1568
|
+
UpdatedAt: 'updatedAt'
|
|
1569
|
+
};
|
|
1544
1570
|
/**
|
|
1545
1571
|
* VariantsApi - axios parameter creator
|
|
1546
1572
|
* @export
|
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.58.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/base.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Product Catalog API
|
|
5
5
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.58.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Product Catalog API
|
|
3
3
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.58.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Product Catalog API
|
|
5
5
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.58.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Product Catalog API
|
|
3
3
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.58.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -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.58.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* 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.58.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/index.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Product Catalog API
|
|
5
5
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.58.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Product Catalog API
|
|
3
3
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.58.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Product Catalog API
|
|
6
6
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.58.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/docs/Application.md
CHANGED
|
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**src** | **string** | Publicly available design file URL. This will fill the design area of the warehouse product. It will be centered horizontally and aligned to the top of the design area. Accepts PNG and JPEG files. | [default to undefined]
|
|
13
13
|
**mockup** | [**ApplicationMockup**](ApplicationMockup.md) | | [optional] [default to undefined]
|
|
14
14
|
**stockedOnly** | **boolean** | If set to true, transfers for this application will not be printed on demand, and will need to be stocked in trays in the factory. Note that this can only be set if the technology is stockable, such as DTF. | [optional] [default to undefined]
|
|
15
|
+
**properties** | [**ApplicationProperties**](ApplicationProperties.md) | | [optional] [default to undefined]
|
|
15
16
|
|
|
16
17
|
## Example
|
|
17
18
|
|
|
@@ -26,6 +27,7 @@ const instance: Application = {
|
|
|
26
27
|
src,
|
|
27
28
|
mockup,
|
|
28
29
|
stockedOnly,
|
|
30
|
+
properties,
|
|
29
31
|
};
|
|
30
32
|
```
|
|
31
33
|
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# ApplicationProperties
|
|
2
|
+
|
|
3
|
+
Optional properties for the application. Leave width, height and position empty and the system will automatically calculate the size for the application.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**width** | **number** | Width of the application in pixels | [optional] [default to undefined]
|
|
10
|
+
**height** | **number** | Height of the application in pixels | [optional] [default to undefined]
|
|
11
|
+
**position** | [**ApplicationPropertiesPosition**](ApplicationPropertiesPosition.md) | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { ApplicationProperties } from '@teemill/product-catalog';
|
|
17
|
+
|
|
18
|
+
const instance: ApplicationProperties = {
|
|
19
|
+
width,
|
|
20
|
+
height,
|
|
21
|
+
position,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# ApplicationPropertiesPosition
|
|
2
|
+
|
|
3
|
+
Position of the application
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**x** | **number** | X coordinate of the application in pixels relative to the bounding box of the product | [default to undefined]
|
|
10
|
+
**y** | **number** | Y coordinate of the application in pixels relative to the bounding box of the product | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ApplicationPropertiesPosition } from '@teemill/product-catalog';
|
|
16
|
+
|
|
17
|
+
const instance: ApplicationPropertiesPosition = {
|
|
18
|
+
x,
|
|
19
|
+
y,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**additionalInstructions** | **string** | Any additional instructions for the application | [optional] [default to undefined]
|
|
11
11
|
**src** | **string** | Publicly available design file URL. This will fill the design area of the warehouse product. It will be centered horizontally and aligned to the top of the design area. Accepts PNG and JPEG files. | [default to undefined]
|
|
12
12
|
**stockedOnly** | **boolean** | If set to true, transfers for this application will not be printed on demand, and will need to be stocked in trays in the factory. Note that this can only be set if the technology is stockable, such as DTF. | [optional] [default to undefined]
|
|
13
|
+
**properties** | [**ApplicationProperties**](ApplicationProperties.md) | | [optional] [default to undefined]
|
|
13
14
|
|
|
14
15
|
## Example
|
|
15
16
|
|
|
@@ -22,6 +23,7 @@ const instance: CreateApplication = {
|
|
|
22
23
|
additionalInstructions,
|
|
23
24
|
src,
|
|
24
25
|
stockedOnly,
|
|
26
|
+
properties,
|
|
25
27
|
};
|
|
26
28
|
```
|
|
27
29
|
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# CreateApplicationProperties
|
|
2
|
+
|
|
3
|
+
Optional properties for the application. Leave width, height and position empty and the system will automatically calculate the size for the application.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**width** | **number** | Width of the application in pixels | [optional] [default to undefined]
|
|
10
|
+
**height** | **number** | Height of the application in pixels | [optional] [default to undefined]
|
|
11
|
+
**position** | [**CreateApplicationPropertiesPosition**](CreateApplicationPropertiesPosition.md) | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { CreateApplicationProperties } from '@teemill/product-catalog';
|
|
17
|
+
|
|
18
|
+
const instance: CreateApplicationProperties = {
|
|
19
|
+
width,
|
|
20
|
+
height,
|
|
21
|
+
position,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# CreateApplicationPropertiesPosition
|
|
2
|
+
|
|
3
|
+
Position of the application
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**x** | **number** | X coordinate of the application in pixels relative to the bounding box of the product | [default to undefined]
|
|
10
|
+
**y** | **number** | Y coordinate of the application in pixels relative to the bounding box of the product | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { CreateApplicationPropertiesPosition } from '@teemill/product-catalog';
|
|
16
|
+
|
|
17
|
+
const instance: CreateApplicationPropertiesPosition = {
|
|
18
|
+
x,
|
|
19
|
+
y,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[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/ProductsApi.md
CHANGED
|
@@ -452,6 +452,9 @@ let project: string; //What project it is (default to undefined)
|
|
|
452
452
|
let pageToken: number; //Page reference token (optional) (default to 1)
|
|
453
453
|
let search: string; //Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', and \'tag:\"tag name\"\'. Multiple filters can be combined with spaces and commas. (optional) (default to 'enabled:true')
|
|
454
454
|
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)
|
|
455
|
+
let start: string; //Start of date range to filter (optional) (default to undefined)
|
|
456
|
+
let end: string; //End of date range to filter (optional) (default to undefined)
|
|
457
|
+
let dateFilterType: 'createdAt' | 'updatedAt'; //Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query. (optional) (default to 'createdAt')
|
|
455
458
|
let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 10)
|
|
456
459
|
let fields: string; //Filter response fields to only include a subset of the resource. (optional) (default to undefined)
|
|
457
460
|
|
|
@@ -460,6 +463,9 @@ const { status, data } = await apiInstance.listProducts(
|
|
|
460
463
|
pageToken,
|
|
461
464
|
search,
|
|
462
465
|
sortBy,
|
|
466
|
+
start,
|
|
467
|
+
end,
|
|
468
|
+
dateFilterType,
|
|
463
469
|
pageSize,
|
|
464
470
|
fields
|
|
465
471
|
);
|
|
@@ -473,6 +479,9 @@ const { status, data } = await apiInstance.listProducts(
|
|
|
473
479
|
| **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
|
|
474
480
|
| **search** | [**string**] | Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', and \'tag:\"tag name\"\'. Multiple filters can be combined with spaces and commas. | (optional) defaults to 'enabled:true'|
|
|
475
481
|
| **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|
|
|
482
|
+
| **start** | [**string**] | Start of date range to filter | (optional) defaults to undefined|
|
|
483
|
+
| **end** | [**string**] | End of date range to filter | (optional) defaults to undefined|
|
|
484
|
+
| **dateFilterType** | [**'createdAt' | 'updatedAt'**]**Array<'createdAt' | 'updatedAt'>** | Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query. | (optional) defaults to 'createdAt'|
|
|
476
485
|
| **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 10|
|
|
477
486
|
| **fields** | [**string**] | Filter response fields to only include a subset of the resource. | (optional) defaults to undefined|
|
|
478
487
|
|
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.58.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|