@emilgroup/document-sdk-node 1.37.0 → 1.37.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.
@@ -97,7 +97,7 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
97
97
  var _this = this;
98
98
  return {
99
99
  /**
100
- * This will create a layout.
100
+ * This will create a layout. **Required Permissions** \"document-management.layouts.create\"
101
101
  * @summary Create the layout
102
102
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
103
103
  * @param {string} [authorization] Bearer Token
@@ -146,7 +146,7 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
146
146
  });
147
147
  },
148
148
  /**
149
- * Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it.
149
+ * Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it. **Required Permissions** \"document-management.layouts.delete\"
150
150
  * @summary Delete the layout
151
151
  * @param {number} id
152
152
  * @param {string} [authorization] Bearer Token
@@ -194,7 +194,7 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
194
194
  });
195
195
  },
196
196
  /**
197
- * Retrieves the details of the layout that was previously created. Supply the unique layout id that was returned when you created it and Emil Api will return the corresponding layout information.
197
+ * Retrieves the details of the layout that was previously created. Supply the unique layout id that was returned when you created it and Emil Api will return the corresponding layout information. **Required Permissions** \"document-management.layouts.view\"
198
198
  * @summary Retrieve the layout
199
199
  * @param {string} id
200
200
  * @param {number} id2 Internal unique identifier for the object. You should not have to use this, use code instead.
@@ -248,7 +248,7 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
248
248
  });
249
249
  },
250
250
  /**
251
- * Returns a list of layouts you have previously created. The layouts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
251
+ * Returns a list of layouts you have previously created. The layouts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"document-management.layouts.view\"
252
252
  * @summary List layouts
253
253
  * @param {string} [authorization] Bearer Token
254
254
  * @param {number} [pageSize] Page size
@@ -320,7 +320,7 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
320
320
  });
321
321
  },
322
322
  /**
323
- * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
323
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"document-management.layouts.update\"
324
324
  * @summary Update the layout
325
325
  * @param {number} id
326
326
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
@@ -383,7 +383,7 @@ var LayoutsApiFp = function (configuration) {
383
383
  var localVarAxiosParamCreator = (0, exports.LayoutsApiAxiosParamCreator)(configuration);
384
384
  return {
385
385
  /**
386
- * This will create a layout.
386
+ * This will create a layout. **Required Permissions** \"document-management.layouts.create\"
387
387
  * @summary Create the layout
388
388
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
389
389
  * @param {string} [authorization] Bearer Token
@@ -404,7 +404,7 @@ var LayoutsApiFp = function (configuration) {
404
404
  });
405
405
  },
406
406
  /**
407
- * Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it.
407
+ * Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it. **Required Permissions** \"document-management.layouts.delete\"
408
408
  * @summary Delete the layout
409
409
  * @param {number} id
410
410
  * @param {string} [authorization] Bearer Token
@@ -425,7 +425,7 @@ var LayoutsApiFp = function (configuration) {
425
425
  });
426
426
  },
427
427
  /**
428
- * Retrieves the details of the layout that was previously created. Supply the unique layout id that was returned when you created it and Emil Api will return the corresponding layout information.
428
+ * Retrieves the details of the layout that was previously created. Supply the unique layout id that was returned when you created it and Emil Api will return the corresponding layout information. **Required Permissions** \"document-management.layouts.view\"
429
429
  * @summary Retrieve the layout
430
430
  * @param {string} id
431
431
  * @param {number} id2 Internal unique identifier for the object. You should not have to use this, use code instead.
@@ -447,7 +447,7 @@ var LayoutsApiFp = function (configuration) {
447
447
  });
448
448
  },
449
449
  /**
450
- * Returns a list of layouts you have previously created. The layouts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
450
+ * Returns a list of layouts you have previously created. The layouts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"document-management.layouts.view\"
451
451
  * @summary List layouts
452
452
  * @param {string} [authorization] Bearer Token
453
453
  * @param {number} [pageSize] Page size
@@ -474,7 +474,7 @@ var LayoutsApiFp = function (configuration) {
474
474
  });
475
475
  },
476
476
  /**
477
- * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
477
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"document-management.layouts.update\"
478
478
  * @summary Update the layout
479
479
  * @param {number} id
480
480
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
@@ -506,7 +506,7 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
506
506
  var localVarFp = (0, exports.LayoutsApiFp)(configuration);
507
507
  return {
508
508
  /**
509
- * This will create a layout.
509
+ * This will create a layout. **Required Permissions** \"document-management.layouts.create\"
510
510
  * @summary Create the layout
511
511
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
512
512
  * @param {string} [authorization] Bearer Token
@@ -517,7 +517,7 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
517
517
  return localVarFp.createLayout(createLayoutRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
518
518
  },
519
519
  /**
520
- * Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it.
520
+ * Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it. **Required Permissions** \"document-management.layouts.delete\"
521
521
  * @summary Delete the layout
522
522
  * @param {number} id
523
523
  * @param {string} [authorization] Bearer Token
@@ -528,7 +528,7 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
528
528
  return localVarFp.deleteLayout(id, authorization, options).then(function (request) { return request(axios, basePath); });
529
529
  },
530
530
  /**
531
- * Retrieves the details of the layout that was previously created. Supply the unique layout id that was returned when you created it and Emil Api will return the corresponding layout information.
531
+ * Retrieves the details of the layout that was previously created. Supply the unique layout id that was returned when you created it and Emil Api will return the corresponding layout information. **Required Permissions** \"document-management.layouts.view\"
532
532
  * @summary Retrieve the layout
533
533
  * @param {string} id
534
534
  * @param {number} id2 Internal unique identifier for the object. You should not have to use this, use code instead.
@@ -540,7 +540,7 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
540
540
  return localVarFp.getLayout(id, id2, authorization, options).then(function (request) { return request(axios, basePath); });
541
541
  },
542
542
  /**
543
- * Returns a list of layouts you have previously created. The layouts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
543
+ * Returns a list of layouts you have previously created. The layouts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"document-management.layouts.view\"
544
544
  * @summary List layouts
545
545
  * @param {string} [authorization] Bearer Token
546
546
  * @param {number} [pageSize] Page size
@@ -557,7 +557,7 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
557
557
  return localVarFp.listLayouts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
558
558
  },
559
559
  /**
560
- * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
560
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"document-management.layouts.update\"
561
561
  * @summary Update the layout
562
562
  * @param {number} id
563
563
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
@@ -583,7 +583,7 @@ var LayoutsApi = /** @class */ (function (_super) {
583
583
  return _super !== null && _super.apply(this, arguments) || this;
584
584
  }
585
585
  /**
586
- * This will create a layout.
586
+ * This will create a layout. **Required Permissions** \"document-management.layouts.create\"
587
587
  * @summary Create the layout
588
588
  * @param {LayoutsApiCreateLayoutRequest} requestParameters Request parameters.
589
589
  * @param {*} [options] Override http request option.
@@ -595,7 +595,7 @@ var LayoutsApi = /** @class */ (function (_super) {
595
595
  return (0, exports.LayoutsApiFp)(this.configuration).createLayout(requestParameters.createLayoutRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
596
596
  };
597
597
  /**
598
- * Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it.
598
+ * Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it. **Required Permissions** \"document-management.layouts.delete\"
599
599
  * @summary Delete the layout
600
600
  * @param {LayoutsApiDeleteLayoutRequest} requestParameters Request parameters.
601
601
  * @param {*} [options] Override http request option.
@@ -607,7 +607,7 @@ var LayoutsApi = /** @class */ (function (_super) {
607
607
  return (0, exports.LayoutsApiFp)(this.configuration).deleteLayout(requestParameters.id, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
608
608
  };
609
609
  /**
610
- * Retrieves the details of the layout that was previously created. Supply the unique layout id that was returned when you created it and Emil Api will return the corresponding layout information.
610
+ * Retrieves the details of the layout that was previously created. Supply the unique layout id that was returned when you created it and Emil Api will return the corresponding layout information. **Required Permissions** \"document-management.layouts.view\"
611
611
  * @summary Retrieve the layout
612
612
  * @param {LayoutsApiGetLayoutRequest} requestParameters Request parameters.
613
613
  * @param {*} [options] Override http request option.
@@ -619,7 +619,7 @@ var LayoutsApi = /** @class */ (function (_super) {
619
619
  return (0, exports.LayoutsApiFp)(this.configuration).getLayout(requestParameters.id, requestParameters.id2, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
620
620
  };
621
621
  /**
622
- * Returns a list of layouts you have previously created. The layouts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
622
+ * Returns a list of layouts you have previously created. The layouts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"document-management.layouts.view\"
623
623
  * @summary List layouts
624
624
  * @param {LayoutsApiListLayoutsRequest} requestParameters Request parameters.
625
625
  * @param {*} [options] Override http request option.
@@ -632,7 +632,7 @@ var LayoutsApi = /** @class */ (function (_super) {
632
632
  return (0, exports.LayoutsApiFp)(this.configuration).listLayouts(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
633
633
  };
634
634
  /**
635
- * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
635
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"document-management.layouts.update\"
636
636
  * @summary Update the layout
637
637
  * @param {LayoutsApiUpdateLayoutRequest} requestParameters Request parameters.
638
638
  * @param {*} [options] Override http request option.
@@ -23,7 +23,7 @@ import { UploadProductDocumentRequestDto } from '../models';
23
23
  */
24
24
  export declare const ProductDocumentsApiAxiosParamCreator: (configuration?: Configuration) => {
25
25
  /**
26
- * Permanently deletes the product document. Supply the unique code that was returned when you created the product document and this will delete it.
26
+ * Permanently deletes the product document. Supply the unique code that was returned when you created the product document and this will delete it. **Required Permissions** \"document-management.documents.delete\"
27
27
  * @summary Delete the product document
28
28
  * @param {string} code
29
29
  * @param {string} productSlug
@@ -33,7 +33,7 @@ export declare const ProductDocumentsApiAxiosParamCreator: (configuration?: Conf
33
33
  */
34
34
  deleteProductDocument: (code: string, productSlug: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
35
35
  /**
36
- * Get a pre-signed download url for the given product document.
36
+ * Get a pre-signed download url for the given product document. **Required Permissions** \"document-management.documents.view\"
37
37
  * @summary Get pre-signed url for downloading product document
38
38
  * @param {string} productSlug Product slug
39
39
  * @param {string} code Product document code
@@ -44,7 +44,7 @@ export declare const ProductDocumentsApiAxiosParamCreator: (configuration?: Conf
44
44
  */
45
45
  downloadProductDocument: (productSlug: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig) => Promise<RequestArgs>;
46
46
  /**
47
- * Get a product document.
47
+ * Get a product document. **Required Permissions** \"document-management.documents.view\"
48
48
  * @summary Retrieve the product document
49
49
  * @param {string} productSlug
50
50
  * @param {string} code
@@ -54,7 +54,7 @@ export declare const ProductDocumentsApiAxiosParamCreator: (configuration?: Conf
54
54
  */
55
55
  getProductDocument: (productSlug: string, code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
56
56
  /**
57
- * 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.
57
+ * 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. **Required Permissions** \"document-management.documents.view\"
58
58
  * @summary List product documents
59
59
  * @param {string} productSlug
60
60
  * @param {string} [authorization] Bearer Token
@@ -70,7 +70,7 @@ export declare const ProductDocumentsApiAxiosParamCreator: (configuration?: Conf
70
70
  */
71
71
  listProductDocuments: (productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
72
72
  /**
73
- * Upload a product document.
73
+ * Upload a product document. **Required Permissions** \"document-management.documents.update\"
74
74
  * @summary Create the product document
75
75
  * @param {string} productSlug
76
76
  * @param {UploadProductDocumentRequestDto} uploadProductDocumentRequestDto
@@ -86,7 +86,7 @@ export declare const ProductDocumentsApiAxiosParamCreator: (configuration?: Conf
86
86
  */
87
87
  export declare const ProductDocumentsApiFp: (configuration?: Configuration) => {
88
88
  /**
89
- * Permanently deletes the product document. Supply the unique code that was returned when you created the product document and this will delete it.
89
+ * Permanently deletes the product document. Supply the unique code that was returned when you created the product document and this will delete it. **Required Permissions** \"document-management.documents.delete\"
90
90
  * @summary Delete the product document
91
91
  * @param {string} code
92
92
  * @param {string} productSlug
@@ -96,7 +96,7 @@ export declare const ProductDocumentsApiFp: (configuration?: Configuration) => {
96
96
  */
97
97
  deleteProductDocument(code: string, productSlug: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
98
98
  /**
99
- * Get a pre-signed download url for the given product document.
99
+ * Get a pre-signed download url for the given product document. **Required Permissions** \"document-management.documents.view\"
100
100
  * @summary Get pre-signed url for downloading product document
101
101
  * @param {string} productSlug Product slug
102
102
  * @param {string} code Product document code
@@ -107,7 +107,7 @@ export declare const ProductDocumentsApiFp: (configuration?: Configuration) => {
107
107
  */
108
108
  downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductDocumentDownloadUrlResponseClass>>;
109
109
  /**
110
- * Get a product document.
110
+ * Get a product document. **Required Permissions** \"document-management.documents.view\"
111
111
  * @summary Retrieve the product document
112
112
  * @param {string} productSlug
113
113
  * @param {string} code
@@ -117,7 +117,7 @@ export declare const ProductDocumentsApiFp: (configuration?: Configuration) => {
117
117
  */
118
118
  getProductDocument(productSlug: string, code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductDocumentResponseClass>>;
119
119
  /**
120
- * 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.
120
+ * 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. **Required Permissions** \"document-management.documents.view\"
121
121
  * @summary List product documents
122
122
  * @param {string} productSlug
123
123
  * @param {string} [authorization] Bearer Token
@@ -133,7 +133,7 @@ export declare const ProductDocumentsApiFp: (configuration?: Configuration) => {
133
133
  */
134
134
  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>>;
135
135
  /**
136
- * Upload a product document.
136
+ * Upload a product document. **Required Permissions** \"document-management.documents.update\"
137
137
  * @summary Create the product document
138
138
  * @param {string} productSlug
139
139
  * @param {UploadProductDocumentRequestDto} uploadProductDocumentRequestDto
@@ -149,7 +149,7 @@ export declare const ProductDocumentsApiFp: (configuration?: Configuration) => {
149
149
  */
150
150
  export declare const ProductDocumentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
151
151
  /**
152
- * Permanently deletes the product document. Supply the unique code that was returned when you created the product document and this will delete it.
152
+ * Permanently deletes the product document. Supply the unique code that was returned when you created the product document and this will delete it. **Required Permissions** \"document-management.documents.delete\"
153
153
  * @summary Delete the product document
154
154
  * @param {string} code
155
155
  * @param {string} productSlug
@@ -159,7 +159,7 @@ export declare const ProductDocumentsApiFactory: (configuration?: Configuration,
159
159
  */
160
160
  deleteProductDocument(code: string, productSlug: string, authorization?: string, options?: any): AxiosPromise<object>;
161
161
  /**
162
- * Get a pre-signed download url for the given product document.
162
+ * Get a pre-signed download url for the given product document. **Required Permissions** \"document-management.documents.view\"
163
163
  * @summary Get pre-signed url for downloading product document
164
164
  * @param {string} productSlug Product slug
165
165
  * @param {string} code Product document code
@@ -170,7 +170,7 @@ export declare const ProductDocumentsApiFactory: (configuration?: Configuration,
170
170
  */
171
171
  downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<GetProductDocumentDownloadUrlResponseClass>;
172
172
  /**
173
- * Get a product document.
173
+ * Get a product document. **Required Permissions** \"document-management.documents.view\"
174
174
  * @summary Retrieve the product document
175
175
  * @param {string} productSlug
176
176
  * @param {string} code
@@ -180,7 +180,7 @@ export declare const ProductDocumentsApiFactory: (configuration?: Configuration,
180
180
  */
181
181
  getProductDocument(productSlug: string, code: string, authorization?: string, options?: any): AxiosPromise<GetProductDocumentResponseClass>;
182
182
  /**
183
- * 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.
183
+ * 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. **Required Permissions** \"document-management.documents.view\"
184
184
  * @summary List product documents
185
185
  * @param {string} productSlug
186
186
  * @param {string} [authorization] Bearer Token
@@ -196,7 +196,7 @@ export declare const ProductDocumentsApiFactory: (configuration?: Configuration,
196
196
  */
197
197
  listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass>;
198
198
  /**
199
- * Upload a product document.
199
+ * Upload a product document. **Required Permissions** \"document-management.documents.update\"
200
200
  * @summary Create the product document
201
201
  * @param {string} productSlug
202
202
  * @param {UploadProductDocumentRequestDto} uploadProductDocumentRequestDto
@@ -381,7 +381,7 @@ export interface ProductDocumentsApiUploadProductDocumentRequest {
381
381
  */
382
382
  export declare class ProductDocumentsApi extends BaseAPI {
383
383
  /**
384
- * Permanently deletes the product document. Supply the unique code that was returned when you created the product document and this will delete it.
384
+ * Permanently deletes the product document. Supply the unique code that was returned when you created the product document and this will delete it. **Required Permissions** \"document-management.documents.delete\"
385
385
  * @summary Delete the product document
386
386
  * @param {ProductDocumentsApiDeleteProductDocumentRequest} requestParameters Request parameters.
387
387
  * @param {*} [options] Override http request option.
@@ -390,7 +390,7 @@ export declare class ProductDocumentsApi extends BaseAPI {
390
390
  */
391
391
  deleteProductDocument(requestParameters: ProductDocumentsApiDeleteProductDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
392
392
  /**
393
- * Get a pre-signed download url for the given product document.
393
+ * Get a pre-signed download url for the given product document. **Required Permissions** \"document-management.documents.view\"
394
394
  * @summary Get pre-signed url for downloading product document
395
395
  * @param {ProductDocumentsApiDownloadProductDocumentRequest} requestParameters Request parameters.
396
396
  * @param {*} [options] Override http request option.
@@ -399,7 +399,7 @@ export declare class ProductDocumentsApi extends BaseAPI {
399
399
  */
400
400
  downloadProductDocument(requestParameters: ProductDocumentsApiDownloadProductDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetProductDocumentDownloadUrlResponseClass, any>>;
401
401
  /**
402
- * Get a product document.
402
+ * Get a product document. **Required Permissions** \"document-management.documents.view\"
403
403
  * @summary Retrieve the product document
404
404
  * @param {ProductDocumentsApiGetProductDocumentRequest} requestParameters Request parameters.
405
405
  * @param {*} [options] Override http request option.
@@ -408,7 +408,7 @@ export declare class ProductDocumentsApi extends BaseAPI {
408
408
  */
409
409
  getProductDocument(requestParameters: ProductDocumentsApiGetProductDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetProductDocumentResponseClass, any>>;
410
410
  /**
411
- * 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.
411
+ * 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. **Required Permissions** \"document-management.documents.view\"
412
412
  * @summary List product documents
413
413
  * @param {ProductDocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
414
414
  * @param {*} [options] Override http request option.
@@ -417,7 +417,7 @@ export declare class ProductDocumentsApi extends BaseAPI {
417
417
  */
418
418
  listProductDocuments(requestParameters: ProductDocumentsApiListProductDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProductDocumentsResponseClass, any>>;
419
419
  /**
420
- * Upload a product document.
420
+ * Upload a product document. **Required Permissions** \"document-management.documents.update\"
421
421
  * @summary Create the product document
422
422
  * @param {ProductDocumentsApiUploadProductDocumentRequest} requestParameters Request parameters.
423
423
  * @param {*} [options] Override http request option.
@@ -97,7 +97,7 @@ var ProductDocumentsApiAxiosParamCreator = function (configuration) {
97
97
  var _this = this;
98
98
  return {
99
99
  /**
100
- * Permanently deletes the product document. Supply the unique code that was returned when you created the product document and this will delete it.
100
+ * Permanently deletes the product document. Supply the unique code that was returned when you created the product document and this will delete it. **Required Permissions** \"document-management.documents.delete\"
101
101
  * @summary Delete the product document
102
102
  * @param {string} code
103
103
  * @param {string} productSlug
@@ -149,7 +149,7 @@ var ProductDocumentsApiAxiosParamCreator = function (configuration) {
149
149
  });
150
150
  },
151
151
  /**
152
- * Get a pre-signed download url for the given product document.
152
+ * Get a pre-signed download url for the given product document. **Required Permissions** \"document-management.documents.view\"
153
153
  * @summary Get pre-signed url for downloading product document
154
154
  * @param {string} productSlug Product slug
155
155
  * @param {string} code Product document code
@@ -205,7 +205,7 @@ var ProductDocumentsApiAxiosParamCreator = function (configuration) {
205
205
  });
206
206
  },
207
207
  /**
208
- * Get a product document.
208
+ * Get a product document. **Required Permissions** \"document-management.documents.view\"
209
209
  * @summary Retrieve the product document
210
210
  * @param {string} productSlug
211
211
  * @param {string} code
@@ -257,7 +257,7 @@ var ProductDocumentsApiAxiosParamCreator = function (configuration) {
257
257
  });
258
258
  },
259
259
  /**
260
- * 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.
260
+ * 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. **Required Permissions** \"document-management.documents.view\"
261
261
  * @summary List product documents
262
262
  * @param {string} productSlug
263
263
  * @param {string} [authorization] Bearer Token
@@ -333,7 +333,7 @@ var ProductDocumentsApiAxiosParamCreator = function (configuration) {
333
333
  });
334
334
  },
335
335
  /**
336
- * Upload a product document.
336
+ * Upload a product document. **Required Permissions** \"document-management.documents.update\"
337
337
  * @summary Create the product document
338
338
  * @param {string} productSlug
339
339
  * @param {UploadProductDocumentRequestDto} uploadProductDocumentRequestDto
@@ -396,7 +396,7 @@ var ProductDocumentsApiFp = function (configuration) {
396
396
  var localVarAxiosParamCreator = (0, exports.ProductDocumentsApiAxiosParamCreator)(configuration);
397
397
  return {
398
398
  /**
399
- * Permanently deletes the product document. Supply the unique code that was returned when you created the product document and this will delete it.
399
+ * Permanently deletes the product document. Supply the unique code that was returned when you created the product document and this will delete it. **Required Permissions** \"document-management.documents.delete\"
400
400
  * @summary Delete the product document
401
401
  * @param {string} code
402
402
  * @param {string} productSlug
@@ -418,7 +418,7 @@ var ProductDocumentsApiFp = function (configuration) {
418
418
  });
419
419
  },
420
420
  /**
421
- * Get a pre-signed download url for the given product document.
421
+ * Get a pre-signed download url for the given product document. **Required Permissions** \"document-management.documents.view\"
422
422
  * @summary Get pre-signed url for downloading product document
423
423
  * @param {string} productSlug Product slug
424
424
  * @param {string} code Product document code
@@ -441,7 +441,7 @@ var ProductDocumentsApiFp = function (configuration) {
441
441
  });
442
442
  },
443
443
  /**
444
- * Get a product document.
444
+ * Get a product document. **Required Permissions** \"document-management.documents.view\"
445
445
  * @summary Retrieve the product document
446
446
  * @param {string} productSlug
447
447
  * @param {string} code
@@ -463,7 +463,7 @@ var ProductDocumentsApiFp = function (configuration) {
463
463
  });
464
464
  },
465
465
  /**
466
- * 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.
466
+ * 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. **Required Permissions** \"document-management.documents.view\"
467
467
  * @summary List product documents
468
468
  * @param {string} productSlug
469
469
  * @param {string} [authorization] Bearer Token
@@ -491,7 +491,7 @@ var ProductDocumentsApiFp = function (configuration) {
491
491
  });
492
492
  },
493
493
  /**
494
- * Upload a product document.
494
+ * Upload a product document. **Required Permissions** \"document-management.documents.update\"
495
495
  * @summary Create the product document
496
496
  * @param {string} productSlug
497
497
  * @param {UploadProductDocumentRequestDto} uploadProductDocumentRequestDto
@@ -523,7 +523,7 @@ var ProductDocumentsApiFactory = function (configuration, basePath, axios) {
523
523
  var localVarFp = (0, exports.ProductDocumentsApiFp)(configuration);
524
524
  return {
525
525
  /**
526
- * Permanently deletes the product document. Supply the unique code that was returned when you created the product document and this will delete it.
526
+ * Permanently deletes the product document. Supply the unique code that was returned when you created the product document and this will delete it. **Required Permissions** \"document-management.documents.delete\"
527
527
  * @summary Delete the product document
528
528
  * @param {string} code
529
529
  * @param {string} productSlug
@@ -535,7 +535,7 @@ var ProductDocumentsApiFactory = function (configuration, basePath, axios) {
535
535
  return localVarFp.deleteProductDocument(code, productSlug, authorization, options).then(function (request) { return request(axios, basePath); });
536
536
  },
537
537
  /**
538
- * Get a pre-signed download url for the given product document.
538
+ * Get a pre-signed download url for the given product document. **Required Permissions** \"document-management.documents.view\"
539
539
  * @summary Get pre-signed url for downloading product document
540
540
  * @param {string} productSlug Product slug
541
541
  * @param {string} code Product document code
@@ -548,7 +548,7 @@ var ProductDocumentsApiFactory = function (configuration, basePath, axios) {
548
548
  return localVarFp.downloadProductDocument(productSlug, code, authorization, contentDisposition, options).then(function (request) { return request(axios, basePath); });
549
549
  },
550
550
  /**
551
- * Get a product document.
551
+ * Get a product document. **Required Permissions** \"document-management.documents.view\"
552
552
  * @summary Retrieve the product document
553
553
  * @param {string} productSlug
554
554
  * @param {string} code
@@ -560,7 +560,7 @@ var ProductDocumentsApiFactory = function (configuration, basePath, axios) {
560
560
  return localVarFp.getProductDocument(productSlug, code, authorization, options).then(function (request) { return request(axios, basePath); });
561
561
  },
562
562
  /**
563
- * 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.
563
+ * 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. **Required Permissions** \"document-management.documents.view\"
564
564
  * @summary List product documents
565
565
  * @param {string} productSlug
566
566
  * @param {string} [authorization] Bearer Token
@@ -578,7 +578,7 @@ var ProductDocumentsApiFactory = function (configuration, basePath, axios) {
578
578
  return localVarFp.listProductDocuments(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
579
579
  },
580
580
  /**
581
- * Upload a product document.
581
+ * Upload a product document. **Required Permissions** \"document-management.documents.update\"
582
582
  * @summary Create the product document
583
583
  * @param {string} productSlug
584
584
  * @param {UploadProductDocumentRequestDto} uploadProductDocumentRequestDto
@@ -604,7 +604,7 @@ var ProductDocumentsApi = /** @class */ (function (_super) {
604
604
  return _super !== null && _super.apply(this, arguments) || this;
605
605
  }
606
606
  /**
607
- * Permanently deletes the product document. Supply the unique code that was returned when you created the product document and this will delete it.
607
+ * Permanently deletes the product document. Supply the unique code that was returned when you created the product document and this will delete it. **Required Permissions** \"document-management.documents.delete\"
608
608
  * @summary Delete the product document
609
609
  * @param {ProductDocumentsApiDeleteProductDocumentRequest} requestParameters Request parameters.
610
610
  * @param {*} [options] Override http request option.
@@ -616,7 +616,7 @@ var ProductDocumentsApi = /** @class */ (function (_super) {
616
616
  return (0, exports.ProductDocumentsApiFp)(this.configuration).deleteProductDocument(requestParameters.code, requestParameters.productSlug, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
617
617
  };
618
618
  /**
619
- * Get a pre-signed download url for the given product document.
619
+ * Get a pre-signed download url for the given product document. **Required Permissions** \"document-management.documents.view\"
620
620
  * @summary Get pre-signed url for downloading product document
621
621
  * @param {ProductDocumentsApiDownloadProductDocumentRequest} requestParameters Request parameters.
622
622
  * @param {*} [options] Override http request option.
@@ -628,7 +628,7 @@ var ProductDocumentsApi = /** @class */ (function (_super) {
628
628
  return (0, exports.ProductDocumentsApiFp)(this.configuration).downloadProductDocument(requestParameters.productSlug, requestParameters.code, requestParameters.authorization, requestParameters.contentDisposition, options).then(function (request) { return request(_this.axios, _this.basePath); });
629
629
  };
630
630
  /**
631
- * Get a product document.
631
+ * Get a product document. **Required Permissions** \"document-management.documents.view\"
632
632
  * @summary Retrieve the product document
633
633
  * @param {ProductDocumentsApiGetProductDocumentRequest} requestParameters Request parameters.
634
634
  * @param {*} [options] Override http request option.
@@ -640,7 +640,7 @@ var ProductDocumentsApi = /** @class */ (function (_super) {
640
640
  return (0, exports.ProductDocumentsApiFp)(this.configuration).getProductDocument(requestParameters.productSlug, requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
641
641
  };
642
642
  /**
643
- * 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.
643
+ * 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. **Required Permissions** \"document-management.documents.view\"
644
644
  * @summary List product documents
645
645
  * @param {ProductDocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
646
646
  * @param {*} [options] Override http request option.
@@ -652,7 +652,7 @@ var ProductDocumentsApi = /** @class */ (function (_super) {
652
652
  return (0, exports.ProductDocumentsApiFp)(this.configuration).listProductDocuments(requestParameters.productSlug, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
653
653
  };
654
654
  /**
655
- * Upload a product document.
655
+ * Upload a product document. **Required Permissions** \"document-management.documents.update\"
656
656
  * @summary Create the product document
657
657
  * @param {ProductDocumentsApiUploadProductDocumentRequest} requestParameters Request parameters.
658
658
  * @param {*} [options] Override http request option.
@@ -19,7 +19,7 @@ import { ListSearchKeywordsResponseClass } from '../models';
19
19
  */
20
20
  export declare const SearchKeywordsApiAxiosParamCreator: (configuration?: Configuration) => {
21
21
  /**
22
- * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text.
22
+ * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text. **Required Permissions** \"document-management.documents.view\"
23
23
  * @summary List keywords
24
24
  * @param {string} searchText Text to search in the documents.
25
25
  * @param {string} [authorization] Bearer Token
@@ -34,7 +34,7 @@ export declare const SearchKeywordsApiAxiosParamCreator: (configuration?: Config
34
34
  */
35
35
  export declare const SearchKeywordsApiFp: (configuration?: Configuration) => {
36
36
  /**
37
- * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text.
37
+ * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text. **Required Permissions** \"document-management.documents.view\"
38
38
  * @summary List keywords
39
39
  * @param {string} searchText Text to search in the documents.
40
40
  * @param {string} [authorization] Bearer Token
@@ -49,7 +49,7 @@ export declare const SearchKeywordsApiFp: (configuration?: Configuration) => {
49
49
  */
50
50
  export declare const SearchKeywordsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
51
51
  /**
52
- * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text.
52
+ * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text. **Required Permissions** \"document-management.documents.view\"
53
53
  * @summary List keywords
54
54
  * @param {string} searchText Text to search in the documents.
55
55
  * @param {string} [authorization] Bearer Token
@@ -85,7 +85,7 @@ export interface SearchKeywordsApiListSearchKeywordsRequest {
85
85
  */
86
86
  export declare class SearchKeywordsApi extends BaseAPI {
87
87
  /**
88
- * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text.
88
+ * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text. **Required Permissions** \"document-management.documents.view\"
89
89
  * @summary List keywords
90
90
  * @param {SearchKeywordsApiListSearchKeywordsRequest} requestParameters Request parameters.
91
91
  * @param {*} [options] Override http request option.
@@ -97,7 +97,7 @@ var SearchKeywordsApiAxiosParamCreator = function (configuration) {
97
97
  var _this = this;
98
98
  return {
99
99
  /**
100
- * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text.
100
+ * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text. **Required Permissions** \"document-management.documents.view\"
101
101
  * @summary List keywords
102
102
  * @param {string} searchText Text to search in the documents.
103
103
  * @param {string} [authorization] Bearer Token
@@ -157,7 +157,7 @@ var SearchKeywordsApiFp = function (configuration) {
157
157
  var localVarAxiosParamCreator = (0, exports.SearchKeywordsApiAxiosParamCreator)(configuration);
158
158
  return {
159
159
  /**
160
- * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text.
160
+ * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text. **Required Permissions** \"document-management.documents.view\"
161
161
  * @summary List keywords
162
162
  * @param {string} searchText Text to search in the documents.
163
163
  * @param {string} [authorization] Bearer Token
@@ -188,7 +188,7 @@ var SearchKeywordsApiFactory = function (configuration, basePath, axios) {
188
188
  var localVarFp = (0, exports.SearchKeywordsApiFp)(configuration);
189
189
  return {
190
190
  /**
191
- * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text.
191
+ * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text. **Required Permissions** \"document-management.documents.view\"
192
192
  * @summary List keywords
193
193
  * @param {string} searchText Text to search in the documents.
194
194
  * @param {string} [authorization] Bearer Token
@@ -213,7 +213,7 @@ var SearchKeywordsApi = /** @class */ (function (_super) {
213
213
  return _super !== null && _super.apply(this, arguments) || this;
214
214
  }
215
215
  /**
216
- * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text.
216
+ * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text. **Required Permissions** \"document-management.documents.view\"
217
217
  * @summary List keywords
218
218
  * @param {SearchKeywordsApiListSearchKeywordsRequest} requestParameters Request parameters.
219
219
  * @param {*} [options] Override http request option.