@emilgroup/document-sdk 1.23.0 → 1.24.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.
@@ -29,10 +29,12 @@ models/get-layout-request-dto.ts
29
29
  models/index.ts
30
30
  models/inline-response200.ts
31
31
  models/inline-response503.ts
32
+ models/list-product-documents-response-class.ts
32
33
  models/list-request-dto.ts
33
34
  models/list-search-keywords-request-dto.ts
34
35
  models/list-searchable-document-owners-request-dto.ts
35
36
  models/list-searchable-documents-request-dto.ts
37
+ models/product-document-class.ts
36
38
  models/shared-update-docx-template-request-dto.ts
37
39
  models/update-doc-template-request-dto.ts
38
40
  models/update-document-request-dto.ts
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/document-sdk@1.23.0 --save
20
+ npm install @emilgroup/document-sdk@1.24.0 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/document-sdk@1.23.0
24
+ yarn add @emilgroup/document-sdk@1.24.0
25
25
  ```
26
26
 
27
27
  And then you can import `DocumentsApi`.
@@ -21,6 +21,8 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
21
21
  // @ts-ignore
22
22
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
23
  // @ts-ignore
24
+ import { ListProductDocumentsResponseClass } from '../models';
25
+ // @ts-ignore
24
26
  import { UploadProductDocumentRequestDto } from '../models';
25
27
  /**
26
28
  * ProductDocumentsApi - axios parameter creator
@@ -176,17 +178,17 @@ export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Co
176
178
  };
177
179
  },
178
180
  /**
179
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
181
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
180
182
  * @summary List product documents
181
183
  * @param {string} productSlug
182
184
  * @param {string} [authorization] Bearer Token
183
185
  * @param {number} [pageSize] Page size
184
186
  * @param {string} [pageToken] Page token
185
- * @param {string} [filter] List filter
187
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, productSlug, productCode, type, createdAt</i>
186
188
  * @param {string} [search] Search query
187
- * @param {string} [order] Ordering criteria
189
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, filename</i>
188
190
  * @param {string} [expand] Extra fields to fetch
189
- * @param {string} [filters] List filters
191
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, productSlug, productCode, type, createdAt</i>
190
192
  * @param {*} [options] Override http request option.
191
193
  * @throws {RequiredError}
192
194
  */
@@ -356,21 +358,21 @@ export const ProductDocumentsApiFp = function(configuration?: Configuration) {
356
358
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
357
359
  },
358
360
  /**
359
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
361
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
360
362
  * @summary List product documents
361
363
  * @param {string} productSlug
362
364
  * @param {string} [authorization] Bearer Token
363
365
  * @param {number} [pageSize] Page size
364
366
  * @param {string} [pageToken] Page token
365
- * @param {string} [filter] List filter
367
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, productSlug, productCode, type, createdAt</i>
366
368
  * @param {string} [search] Search query
367
- * @param {string} [order] Ordering criteria
369
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, filename</i>
368
370
  * @param {string} [expand] Extra fields to fetch
369
- * @param {string} [filters] List filters
371
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, productSlug, productCode, type, createdAt</i>
370
372
  * @param {*} [options] Override http request option.
371
373
  * @throws {RequiredError}
372
374
  */
373
- async listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
375
+ async listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductDocumentsResponseClass>> {
374
376
  const localVarAxiosArgs = await localVarAxiosParamCreator.listProductDocuments(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
375
377
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
376
378
  },
@@ -434,21 +436,21 @@ export const ProductDocumentsApiFactory = function (configuration?: Configuratio
434
436
  return localVarFp.getProductDocument(productSlug, code, authorization, options).then((request) => request(axios, basePath));
435
437
  },
436
438
  /**
437
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
439
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
438
440
  * @summary List product documents
439
441
  * @param {string} productSlug
440
442
  * @param {string} [authorization] Bearer Token
441
443
  * @param {number} [pageSize] Page size
442
444
  * @param {string} [pageToken] Page token
443
- * @param {string} [filter] List filter
445
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
444
446
  * @param {string} [search] Search query
445
- * @param {string} [order] Ordering criteria
447
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, filename&lt;/i&gt;
446
448
  * @param {string} [expand] Extra fields to fetch
447
- * @param {string} [filters] List filters
449
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
448
450
  * @param {*} [options] Override http request option.
449
451
  * @throws {RequiredError}
450
452
  */
451
- listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<void> {
453
+ listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass> {
452
454
  return localVarFp.listProductDocuments(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
453
455
  },
454
456
  /**
@@ -585,7 +587,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
585
587
  readonly pageToken?: string
586
588
 
587
589
  /**
588
- * List filter
590
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
589
591
  * @type {string}
590
592
  * @memberof ProductDocumentsApiListProductDocuments
591
593
  */
@@ -599,7 +601,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
599
601
  readonly search?: string
600
602
 
601
603
  /**
602
- * Ordering criteria
604
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, filename&lt;/i&gt;
603
605
  * @type {string}
604
606
  * @memberof ProductDocumentsApiListProductDocuments
605
607
  */
@@ -613,7 +615,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
613
615
  readonly expand?: string
614
616
 
615
617
  /**
616
- * List filters
618
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
617
619
  * @type {string}
618
620
  * @memberof ProductDocumentsApiListProductDocuments
619
621
  */
@@ -692,7 +694,7 @@ export class ProductDocumentsApi extends BaseAPI {
692
694
  }
693
695
 
694
696
  /**
695
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
697
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
696
698
  * @summary List product documents
697
699
  * @param {ProductDocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
698
700
  * @param {*} [options] Override http request option.
@@ -12,6 +12,7 @@
12
12
  import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
13
  import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
+ import { ListProductDocumentsResponseClass } from '../models';
15
16
  import { UploadProductDocumentRequestDto } from '../models';
16
17
  /**
17
18
  * ProductDocumentsApi - axios parameter creator
@@ -49,17 +50,17 @@ export declare const ProductDocumentsApiAxiosParamCreator: (configuration?: Conf
49
50
  */
50
51
  getProductDocument: (productSlug: string, code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
51
52
  /**
52
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
53
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
53
54
  * @summary List product documents
54
55
  * @param {string} productSlug
55
56
  * @param {string} [authorization] Bearer Token
56
57
  * @param {number} [pageSize] Page size
57
58
  * @param {string} [pageToken] Page token
58
- * @param {string} [filter] List filter
59
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
59
60
  * @param {string} [search] Search query
60
- * @param {string} [order] Ordering criteria
61
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, filename&lt;/i&gt;
61
62
  * @param {string} [expand] Extra fields to fetch
62
- * @param {string} [filters] List filters
63
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
63
64
  * @param {*} [options] Override http request option.
64
65
  * @throws {RequiredError}
65
66
  */
@@ -111,21 +112,21 @@ export declare const ProductDocumentsApiFp: (configuration?: Configuration) => {
111
112
  */
112
113
  getProductDocument(productSlug: string, code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
113
114
  /**
114
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
115
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
115
116
  * @summary List product documents
116
117
  * @param {string} productSlug
117
118
  * @param {string} [authorization] Bearer Token
118
119
  * @param {number} [pageSize] Page size
119
120
  * @param {string} [pageToken] Page token
120
- * @param {string} [filter] List filter
121
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
121
122
  * @param {string} [search] Search query
122
- * @param {string} [order] Ordering criteria
123
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, filename&lt;/i&gt;
123
124
  * @param {string} [expand] Extra fields to fetch
124
- * @param {string} [filters] List filters
125
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
125
126
  * @param {*} [options] Override http request option.
126
127
  * @throws {RequiredError}
127
128
  */
128
- listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
129
+ listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductDocumentsResponseClass>>;
129
130
  /**
130
131
  * Upload a product document.
131
132
  * @summary Create the product document
@@ -173,21 +174,21 @@ export declare const ProductDocumentsApiFactory: (configuration?: Configuration,
173
174
  */
174
175
  getProductDocument(productSlug: string, code: string, authorization?: string, options?: any): AxiosPromise<void>;
175
176
  /**
176
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
177
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
177
178
  * @summary List product documents
178
179
  * @param {string} productSlug
179
180
  * @param {string} [authorization] Bearer Token
180
181
  * @param {number} [pageSize] Page size
181
182
  * @param {string} [pageToken] Page token
182
- * @param {string} [filter] List filter
183
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
183
184
  * @param {string} [search] Search query
184
- * @param {string} [order] Ordering criteria
185
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, filename&lt;/i&gt;
185
186
  * @param {string} [expand] Extra fields to fetch
186
- * @param {string} [filters] List filters
187
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
187
188
  * @param {*} [options] Override http request option.
188
189
  * @throws {RequiredError}
189
190
  */
190
- listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<void>;
191
+ listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass>;
191
192
  /**
192
193
  * Upload a product document.
193
194
  * @summary Create the product document
@@ -305,7 +306,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
305
306
  */
306
307
  readonly pageToken?: string;
307
308
  /**
308
- * List filter
309
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
309
310
  * @type {string}
310
311
  * @memberof ProductDocumentsApiListProductDocuments
311
312
  */
@@ -317,7 +318,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
317
318
  */
318
319
  readonly search?: string;
319
320
  /**
320
- * Ordering criteria
321
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, filename&lt;/i&gt;
321
322
  * @type {string}
322
323
  * @memberof ProductDocumentsApiListProductDocuments
323
324
  */
@@ -329,7 +330,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
329
330
  */
330
331
  readonly expand?: string;
331
332
  /**
332
- * List filters
333
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
333
334
  * @type {string}
334
335
  * @memberof ProductDocumentsApiListProductDocuments
335
336
  */
@@ -395,14 +396,14 @@ export declare class ProductDocumentsApi extends BaseAPI {
395
396
  */
396
397
  getProductDocument(requestParameters: ProductDocumentsApiGetProductDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
397
398
  /**
398
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
399
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
399
400
  * @summary List product documents
400
401
  * @param {ProductDocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
401
402
  * @param {*} [options] Override http request option.
402
403
  * @throws {RequiredError}
403
404
  * @memberof ProductDocumentsApi
404
405
  */
405
- listProductDocuments(requestParameters: ProductDocumentsApiListProductDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
406
+ listProductDocuments(requestParameters: ProductDocumentsApiListProductDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProductDocumentsResponseClass, any>>;
406
407
  /**
407
408
  * Upload a product document.
408
409
  * @summary Create the product document
@@ -249,17 +249,17 @@ var ProductDocumentsApiAxiosParamCreator = function (configuration) {
249
249
  });
250
250
  },
251
251
  /**
252
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
252
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
253
253
  * @summary List product documents
254
254
  * @param {string} productSlug
255
255
  * @param {string} [authorization] Bearer Token
256
256
  * @param {number} [pageSize] Page size
257
257
  * @param {string} [pageToken] Page token
258
- * @param {string} [filter] List filter
258
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
259
259
  * @param {string} [search] Search query
260
- * @param {string} [order] Ordering criteria
260
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, filename&lt;/i&gt;
261
261
  * @param {string} [expand] Extra fields to fetch
262
- * @param {string} [filters] List filters
262
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
263
263
  * @param {*} [options] Override http request option.
264
264
  * @throws {RequiredError}
265
265
  */
@@ -454,17 +454,17 @@ var ProductDocumentsApiFp = function (configuration) {
454
454
  });
455
455
  },
456
456
  /**
457
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
457
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
458
458
  * @summary List product documents
459
459
  * @param {string} productSlug
460
460
  * @param {string} [authorization] Bearer Token
461
461
  * @param {number} [pageSize] Page size
462
462
  * @param {string} [pageToken] Page token
463
- * @param {string} [filter] List filter
463
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
464
464
  * @param {string} [search] Search query
465
- * @param {string} [order] Ordering criteria
465
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, filename&lt;/i&gt;
466
466
  * @param {string} [expand] Extra fields to fetch
467
- * @param {string} [filters] List filters
467
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
468
468
  * @param {*} [options] Override http request option.
469
469
  * @throws {RequiredError}
470
470
  */
@@ -550,17 +550,17 @@ var ProductDocumentsApiFactory = function (configuration, basePath, axios) {
550
550
  return localVarFp.getProductDocument(productSlug, code, authorization, options).then(function (request) { return request(axios, basePath); });
551
551
  },
552
552
  /**
553
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
553
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
554
554
  * @summary List product documents
555
555
  * @param {string} productSlug
556
556
  * @param {string} [authorization] Bearer Token
557
557
  * @param {number} [pageSize] Page size
558
558
  * @param {string} [pageToken] Page token
559
- * @param {string} [filter] List filter
559
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
560
560
  * @param {string} [search] Search query
561
- * @param {string} [order] Ordering criteria
561
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, filename&lt;/i&gt;
562
562
  * @param {string} [expand] Extra fields to fetch
563
- * @param {string} [filters] List filters
563
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
564
564
  * @param {*} [options] Override http request option.
565
565
  * @throws {RequiredError}
566
566
  */
@@ -630,7 +630,7 @@ var ProductDocumentsApi = /** @class */ (function (_super) {
630
630
  return (0, exports.ProductDocumentsApiFp)(this.configuration).getProductDocument(requestParameters.productSlug, requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
631
631
  };
632
632
  /**
633
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
633
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
634
634
  * @summary List product documents
635
635
  * @param {ProductDocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
636
636
  * @param {*} [options] Override http request option.
@@ -9,10 +9,12 @@ export * from './delete-request-dto';
9
9
  export * from './get-layout-request-dto';
10
10
  export * from './inline-response200';
11
11
  export * from './inline-response503';
12
+ export * from './list-product-documents-response-class';
12
13
  export * from './list-request-dto';
13
14
  export * from './list-search-keywords-request-dto';
14
15
  export * from './list-searchable-document-owners-request-dto';
15
16
  export * from './list-searchable-documents-request-dto';
17
+ export * from './product-document-class';
16
18
  export * from './shared-update-docx-template-request-dto';
17
19
  export * from './update-doc-template-request-dto';
18
20
  export * from './update-document-request-dto';
@@ -25,10 +25,12 @@ __exportStar(require("./delete-request-dto"), exports);
25
25
  __exportStar(require("./get-layout-request-dto"), exports);
26
26
  __exportStar(require("./inline-response200"), exports);
27
27
  __exportStar(require("./inline-response503"), exports);
28
+ __exportStar(require("./list-product-documents-response-class"), exports);
28
29
  __exportStar(require("./list-request-dto"), exports);
29
30
  __exportStar(require("./list-search-keywords-request-dto"), exports);
30
31
  __exportStar(require("./list-searchable-document-owners-request-dto"), exports);
31
32
  __exportStar(require("./list-searchable-documents-request-dto"), exports);
33
+ __exportStar(require("./product-document-class"), exports);
32
34
  __exportStar(require("./shared-update-docx-template-request-dto"), exports);
33
35
  __exportStar(require("./update-doc-template-request-dto"), exports);
34
36
  __exportStar(require("./update-document-request-dto"), exports);
@@ -0,0 +1,31 @@
1
+ /**
2
+ * EMIL DocumentService
3
+ * The EMIL DocumentService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { ProductDocumentClass } from './product-document-class';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface ListProductDocumentsResponseClass
17
+ */
18
+ export interface ListProductDocumentsResponseClass {
19
+ /**
20
+ * The list of documents.
21
+ * @type {Array<ProductDocumentClass>}
22
+ * @memberof ListProductDocumentsResponseClass
23
+ */
24
+ 'items': Array<ProductDocumentClass>;
25
+ /**
26
+ * Next page token.
27
+ * @type {string}
28
+ * @memberof ListProductDocumentsResponseClass
29
+ */
30
+ 'nextPageToken': string;
31
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * EMIL DocumentService
6
+ * The EMIL DocumentService API description
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,117 @@
1
+ /**
2
+ * EMIL DocumentService
3
+ * The EMIL DocumentService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface ProductDocumentClass
16
+ */
17
+ export interface ProductDocumentClass {
18
+ /**
19
+ * Internal unique identifier for the object. You should not have to use this, use code instead.
20
+ * @type {number}
21
+ * @memberof ProductDocumentClass
22
+ */
23
+ 'id': number;
24
+ /**
25
+ * Unique identifier for the object.
26
+ * @type {string}
27
+ * @memberof ProductDocumentClass
28
+ */
29
+ 'code': string;
30
+ /**
31
+ * Unique identifier of the product that this object belongs to.
32
+ * @type {string}
33
+ * @memberof ProductDocumentClass
34
+ */
35
+ 'productCode': string;
36
+ /**
37
+ * Unique identifier referencing the product.
38
+ * @type {number}
39
+ * @memberof ProductDocumentClass
40
+ */
41
+ 'productVersionId': number;
42
+ /**
43
+ * A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
44
+ * @type {string}
45
+ * @memberof ProductDocumentClass
46
+ */
47
+ 'slug': string;
48
+ /**
49
+ * Type of the product document.
50
+ * @type {string}
51
+ * @memberof ProductDocumentClass
52
+ */
53
+ 'type': string;
54
+ /**
55
+ * Description of the document. Usually a short summary about the context in which the document is being used.
56
+ * @type {string}
57
+ * @memberof ProductDocumentClass
58
+ */
59
+ 'description': string;
60
+ /**
61
+ * The unique key used by Amazon Simple Storage Service (S3).
62
+ * @type {string}
63
+ * @memberof ProductDocumentClass
64
+ */
65
+ 's3Key': string;
66
+ /**
67
+ * Extension of the file.
68
+ * @type {string}
69
+ * @memberof ProductDocumentClass
70
+ */
71
+ 'contentType': ProductDocumentClassContentTypeEnum;
72
+ /**
73
+ * Product Document entity type.
74
+ * @type {string}
75
+ * @memberof ProductDocumentClass
76
+ */
77
+ 'entityType': string;
78
+ /**
79
+ * The file name the end user will see when downloading it.
80
+ * @type {string}
81
+ * @memberof ProductDocumentClass
82
+ */
83
+ 'filename': string;
84
+ /**
85
+ * A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
86
+ * @type {string}
87
+ * @memberof ProductDocumentClass
88
+ */
89
+ 'productSlug': string;
90
+ /**
91
+ * The current version number of the product document.
92
+ * @type {number}
93
+ * @memberof ProductDocumentClass
94
+ */
95
+ 'versionNumber': number;
96
+ /**
97
+ * Time at which the object was created.
98
+ * @type {string}
99
+ * @memberof ProductDocumentClass
100
+ */
101
+ 'createdAt': string;
102
+ /**
103
+ * Time at which the object was created.
104
+ * @type {string}
105
+ * @memberof ProductDocumentClass
106
+ */
107
+ 'updated': string;
108
+ }
109
+ export declare const ProductDocumentClassContentTypeEnum: {
110
+ readonly Pdf: "pdf";
111
+ readonly Jpg: "jpg";
112
+ readonly Png: "png";
113
+ readonly Csv: "csv";
114
+ readonly Doc: "doc";
115
+ readonly Docx: "docx";
116
+ };
117
+ export type ProductDocumentClassContentTypeEnum = typeof ProductDocumentClassContentTypeEnum[keyof typeof ProductDocumentClassContentTypeEnum];
@@ -0,0 +1,24 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * EMIL DocumentService
6
+ * The EMIL DocumentService API description
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.ProductDocumentClassContentTypeEnum = void 0;
17
+ exports.ProductDocumentClassContentTypeEnum = {
18
+ Pdf: 'pdf',
19
+ Jpg: 'jpg',
20
+ Png: 'png',
21
+ Csv: 'csv',
22
+ Doc: 'doc',
23
+ Docx: 'docx'
24
+ };
package/models/index.ts CHANGED
@@ -9,10 +9,12 @@ export * from './delete-request-dto';
9
9
  export * from './get-layout-request-dto';
10
10
  export * from './inline-response200';
11
11
  export * from './inline-response503';
12
+ export * from './list-product-documents-response-class';
12
13
  export * from './list-request-dto';
13
14
  export * from './list-search-keywords-request-dto';
14
15
  export * from './list-searchable-document-owners-request-dto';
15
16
  export * from './list-searchable-documents-request-dto';
17
+ export * from './product-document-class';
16
18
  export * from './shared-update-docx-template-request-dto';
17
19
  export * from './update-doc-template-request-dto';
18
20
  export * from './update-document-request-dto';
@@ -0,0 +1,37 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL DocumentService
5
+ * The EMIL DocumentService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import { ProductDocumentClass } from './product-document-class';
17
+
18
+ /**
19
+ *
20
+ * @export
21
+ * @interface ListProductDocumentsResponseClass
22
+ */
23
+ export interface ListProductDocumentsResponseClass {
24
+ /**
25
+ * The list of documents.
26
+ * @type {Array<ProductDocumentClass>}
27
+ * @memberof ListProductDocumentsResponseClass
28
+ */
29
+ 'items': Array<ProductDocumentClass>;
30
+ /**
31
+ * Next page token.
32
+ * @type {string}
33
+ * @memberof ListProductDocumentsResponseClass
34
+ */
35
+ 'nextPageToken': string;
36
+ }
37
+
@@ -0,0 +1,126 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL DocumentService
5
+ * The EMIL DocumentService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface ProductDocumentClass
21
+ */
22
+ export interface ProductDocumentClass {
23
+ /**
24
+ * Internal unique identifier for the object. You should not have to use this, use code instead.
25
+ * @type {number}
26
+ * @memberof ProductDocumentClass
27
+ */
28
+ 'id': number;
29
+ /**
30
+ * Unique identifier for the object.
31
+ * @type {string}
32
+ * @memberof ProductDocumentClass
33
+ */
34
+ 'code': string;
35
+ /**
36
+ * Unique identifier of the product that this object belongs to.
37
+ * @type {string}
38
+ * @memberof ProductDocumentClass
39
+ */
40
+ 'productCode': string;
41
+ /**
42
+ * Unique identifier referencing the product.
43
+ * @type {number}
44
+ * @memberof ProductDocumentClass
45
+ */
46
+ 'productVersionId': number;
47
+ /**
48
+ * A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
49
+ * @type {string}
50
+ * @memberof ProductDocumentClass
51
+ */
52
+ 'slug': string;
53
+ /**
54
+ * Type of the product document.
55
+ * @type {string}
56
+ * @memberof ProductDocumentClass
57
+ */
58
+ 'type': string;
59
+ /**
60
+ * Description of the document. Usually a short summary about the context in which the document is being used.
61
+ * @type {string}
62
+ * @memberof ProductDocumentClass
63
+ */
64
+ 'description': string;
65
+ /**
66
+ * The unique key used by Amazon Simple Storage Service (S3).
67
+ * @type {string}
68
+ * @memberof ProductDocumentClass
69
+ */
70
+ 's3Key': string;
71
+ /**
72
+ * Extension of the file.
73
+ * @type {string}
74
+ * @memberof ProductDocumentClass
75
+ */
76
+ 'contentType': ProductDocumentClassContentTypeEnum;
77
+ /**
78
+ * Product Document entity type.
79
+ * @type {string}
80
+ * @memberof ProductDocumentClass
81
+ */
82
+ 'entityType': string;
83
+ /**
84
+ * The file name the end user will see when downloading it.
85
+ * @type {string}
86
+ * @memberof ProductDocumentClass
87
+ */
88
+ 'filename': string;
89
+ /**
90
+ * A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
91
+ * @type {string}
92
+ * @memberof ProductDocumentClass
93
+ */
94
+ 'productSlug': string;
95
+ /**
96
+ * The current version number of the product document.
97
+ * @type {number}
98
+ * @memberof ProductDocumentClass
99
+ */
100
+ 'versionNumber': number;
101
+ /**
102
+ * Time at which the object was created.
103
+ * @type {string}
104
+ * @memberof ProductDocumentClass
105
+ */
106
+ 'createdAt': string;
107
+ /**
108
+ * Time at which the object was created.
109
+ * @type {string}
110
+ * @memberof ProductDocumentClass
111
+ */
112
+ 'updated': string;
113
+ }
114
+
115
+ export const ProductDocumentClassContentTypeEnum = {
116
+ Pdf: 'pdf',
117
+ Jpg: 'jpg',
118
+ Png: 'png',
119
+ Csv: 'csv',
120
+ Doc: 'doc',
121
+ Docx: 'docx'
122
+ } as const;
123
+
124
+ export type ProductDocumentClassContentTypeEnum = typeof ProductDocumentClassContentTypeEnum[keyof typeof ProductDocumentClassContentTypeEnum];
125
+
126
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/document-sdk",
3
- "version": "1.23.0",
3
+ "version": "1.24.0",
4
4
  "description": "OpenAPI client for @emilgroup/document-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [