@emilgroup/document-sdk 1.31.0 → 1.31.1-beta.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 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.31.0 --save
20
+ npm install @emilgroup/document-sdk@1.31.1-beta.0 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/document-sdk@1.31.0
24
+ yarn add @emilgroup/document-sdk@1.31.1-beta.0
25
25
  ```
26
26
 
27
27
  And then you can import `DocumentsApi`.
@@ -198,7 +198,7 @@ export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Co
198
198
  * @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, slug</i>
199
199
  * @param {string} [search] Search query
200
200
  * @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>
201
- * @param {string} [expand] Extra fields to fetch
201
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
202
202
  * @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, slug</i>
203
203
  * @param {*} [options] Override http request option.
204
204
  * @throws {RequiredError}
@@ -379,7 +379,7 @@ export const ProductDocumentsApiFp = function(configuration?: Configuration) {
379
379
  * @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, slug</i>
380
380
  * @param {string} [search] Search query
381
381
  * @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>
382
- * @param {string} [expand] Extra fields to fetch
382
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
383
383
  * @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, slug</i>
384
384
  * @param {*} [options] Override http request option.
385
385
  * @throws {RequiredError}
@@ -458,7 +458,7 @@ export const ProductDocumentsApiFactory = function (configuration?: Configuratio
458
458
  * @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, slug</i>
459
459
  * @param {string} [search] Search query
460
460
  * @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>
461
- * @param {string} [expand] Extra fields to fetch
461
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
462
462
  * @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, slug</i>
463
463
  * @param {*} [options] Override http request option.
464
464
  * @throws {RequiredError}
@@ -628,7 +628,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
628
628
  readonly order?: string
629
629
 
630
630
  /**
631
- * Extra fields to fetch
631
+ * Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
632
632
  * @type {string}
633
633
  * @memberof ProductDocumentsApiListProductDocuments
634
634
  */
@@ -63,7 +63,7 @@ export declare const ProductDocumentsApiAxiosParamCreator: (configuration?: Conf
63
63
  * @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, slug</i>
64
64
  * @param {string} [search] Search query
65
65
  * @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>
66
- * @param {string} [expand] Extra fields to fetch
66
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
67
67
  * @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, slug</i>
68
68
  * @param {*} [options] Override http request option.
69
69
  * @throws {RequiredError}
@@ -126,7 +126,7 @@ export declare const ProductDocumentsApiFp: (configuration?: Configuration) => {
126
126
  * @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, slug</i>
127
127
  * @param {string} [search] Search query
128
128
  * @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>
129
- * @param {string} [expand] Extra fields to fetch
129
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
130
130
  * @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, slug</i>
131
131
  * @param {*} [options] Override http request option.
132
132
  * @throws {RequiredError}
@@ -189,7 +189,7 @@ export declare const ProductDocumentsApiFactory: (configuration?: Configuration,
189
189
  * @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, slug</i>
190
190
  * @param {string} [search] Search query
191
191
  * @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>
192
- * @param {string} [expand] Extra fields to fetch
192
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
193
193
  * @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, slug</i>
194
194
  * @param {*} [options] Override http request option.
195
195
  * @throws {RequiredError}
@@ -336,7 +336,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
336
336
  */
337
337
  readonly order?: string;
338
338
  /**
339
- * Extra fields to fetch
339
+ * Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
340
340
  * @type {string}
341
341
  * @memberof ProductDocumentsApiListProductDocuments
342
342
  */
@@ -262,7 +262,7 @@ var ProductDocumentsApiAxiosParamCreator = function (configuration) {
262
262
  * @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, slug</i>
263
263
  * @param {string} [search] Search query
264
264
  * @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>
265
- * @param {string} [expand] Extra fields to fetch
265
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
266
266
  * @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, slug</i>
267
267
  * @param {*} [options] Override http request option.
268
268
  * @throws {RequiredError}
@@ -468,7 +468,7 @@ var ProductDocumentsApiFp = function (configuration) {
468
468
  * @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, slug</i>
469
469
  * @param {string} [search] Search query
470
470
  * @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>
471
- * @param {string} [expand] Extra fields to fetch
471
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
472
472
  * @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, slug</i>
473
473
  * @param {*} [options] Override http request option.
474
474
  * @throws {RequiredError}
@@ -565,7 +565,7 @@ var ProductDocumentsApiFactory = function (configuration, basePath, axios) {
565
565
  * @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, slug</i>
566
566
  * @param {string} [search] Search query
567
567
  * @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>
568
- * @param {string} [expand] Extra fields to fetch
568
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
569
569
  * @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, slug</i>
570
570
  * @param {*} [options] Override http request option.
571
571
  * @throws {RequiredError}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/document-sdk",
3
- "version": "1.31.0",
3
+ "version": "1.31.1-beta.0",
4
4
  "description": "OpenAPI client for @emilgroup/document-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [