@emilgroup/document-sdk-node 1.16.0 → 1.21.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-node@1.16.0 --save
20
+ npm install @emilgroup/document-sdk-node@1.21.0 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/document-sdk-node@1.16.0
24
+ yarn add @emilgroup/document-sdk-node@1.21.0
25
25
  ```
26
26
 
27
27
  And then you can import `DocumentsApi`.
@@ -290,10 +290,11 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
290
290
  * @param {string} [search] Search query
291
291
  * @param {string} [order] Ordering criteria
292
292
  * @param {string} [expand] Extra fields to fetch
293
+ * @param {string} [filters] List filters
293
294
  * @param {*} [options] Override http request option.
294
295
  * @throws {RequiredError}
295
296
  */
296
- listDocuments: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
297
+ listDocuments: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
297
298
  const localVarPath = `/documentservice/v1/documents`;
298
299
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
299
300
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -336,6 +337,10 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
336
337
  localVarQueryParameter['expand'] = expand;
337
338
  }
338
339
 
340
+ if (filters !== undefined) {
341
+ localVarQueryParameter['filters'] = filters;
342
+ }
343
+
339
344
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
340
345
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
341
346
  }
@@ -482,11 +487,12 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
482
487
  * @param {string} [search] Search query
483
488
  * @param {string} [order] Ordering criteria
484
489
  * @param {string} [expand] Extra fields to fetch
490
+ * @param {string} [filters] List filters
485
491
  * @param {*} [options] Override http request option.
486
492
  * @throws {RequiredError}
487
493
  */
488
- async listDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocumentsResponseClass>> {
489
- const localVarAxiosArgs = await localVarAxiosParamCreator.listDocuments(authorization, pageSize, pageToken, filter, search, order, expand, options);
494
+ async listDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocumentsResponseClass>> {
495
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listDocuments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
490
496
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
491
497
  },
492
498
  /**
@@ -577,11 +583,12 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
577
583
  * @param {string} [search] Search query
578
584
  * @param {string} [order] Ordering criteria
579
585
  * @param {string} [expand] Extra fields to fetch
586
+ * @param {string} [filters] List filters
580
587
  * @param {*} [options] Override http request option.
581
588
  * @throws {RequiredError}
582
589
  */
583
- listDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListDocumentsResponseClass> {
584
- return localVarFp.listDocuments(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
590
+ listDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListDocumentsResponseClass> {
591
+ return localVarFp.listDocuments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
585
592
  },
586
593
  /**
587
594
  * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
@@ -757,6 +764,13 @@ export interface DocumentsApiListDocumentsRequest {
757
764
  * @memberof DocumentsApiListDocuments
758
765
  */
759
766
  readonly expand?: string
767
+
768
+ /**
769
+ * List filters
770
+ * @type {string}
771
+ * @memberof DocumentsApiListDocuments
772
+ */
773
+ readonly filters?: string
760
774
  }
761
775
 
762
776
  /**
@@ -863,7 +877,7 @@ export class DocumentsApi extends BaseAPI {
863
877
  * @memberof DocumentsApi
864
878
  */
865
879
  public listDocuments(requestParameters: DocumentsApiListDocumentsRequest = {}, options?: AxiosRequestConfig) {
866
- return DocumentsApiFp(this.configuration).listDocuments(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
880
+ return DocumentsApiFp(this.configuration).listDocuments(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
867
881
  }
868
882
 
869
883
  /**
@@ -191,10 +191,11 @@ export const DocxTemplatesApiAxiosParamCreator = function (configuration?: Confi
191
191
  * @param {string} [search] Search query
192
192
  * @param {string} [order] Ordering criteria
193
193
  * @param {string} [expand] Extra fields to fetch
194
+ * @param {string} [filters] List filters
194
195
  * @param {*} [options] Override http request option.
195
196
  * @throws {RequiredError}
196
197
  */
197
- listDocxTemplates: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
198
+ listDocxTemplates: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
198
199
  const localVarPath = `/documentservice/v1/docx-templates`;
199
200
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
200
201
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -237,6 +238,10 @@ export const DocxTemplatesApiAxiosParamCreator = function (configuration?: Confi
237
238
  localVarQueryParameter['expand'] = expand;
238
239
  }
239
240
 
241
+ if (filters !== undefined) {
242
+ localVarQueryParameter['filters'] = filters;
243
+ }
244
+
240
245
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
241
246
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
242
247
  }
@@ -406,11 +411,12 @@ export const DocxTemplatesApiFp = function(configuration?: Configuration) {
406
411
  * @param {string} [search] Search query
407
412
  * @param {string} [order] Ordering criteria
408
413
  * @param {string} [expand] Extra fields to fetch
414
+ * @param {string} [filters] List filters
409
415
  * @param {*} [options] Override http request option.
410
416
  * @throws {RequiredError}
411
417
  */
412
- async listDocxTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocxTemplatesResponseClass>> {
413
- const localVarAxiosArgs = await localVarAxiosParamCreator.listDocxTemplates(authorization, pageSize, pageToken, filter, search, order, expand, options);
418
+ async listDocxTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocxTemplatesResponseClass>> {
419
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listDocxTemplates(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
414
420
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
415
421
  },
416
422
  /**
@@ -491,11 +497,12 @@ export const DocxTemplatesApiFactory = function (configuration?: Configuration,
491
497
  * @param {string} [search] Search query
492
498
  * @param {string} [order] Ordering criteria
493
499
  * @param {string} [expand] Extra fields to fetch
500
+ * @param {string} [filters] List filters
494
501
  * @param {*} [options] Override http request option.
495
502
  * @throws {RequiredError}
496
503
  */
497
- listDocxTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListDocxTemplatesResponseClass> {
498
- return localVarFp.listDocxTemplates(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
504
+ listDocxTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListDocxTemplatesResponseClass> {
505
+ return localVarFp.listDocxTemplates(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
499
506
  },
500
507
  /**
501
508
  * Updates a docx template metadata.
@@ -640,6 +647,13 @@ export interface DocxTemplatesApiListDocxTemplatesRequest {
640
647
  * @memberof DocxTemplatesApiListDocxTemplates
641
648
  */
642
649
  readonly expand?: string
650
+
651
+ /**
652
+ * List filters
653
+ * @type {string}
654
+ * @memberof DocxTemplatesApiListDocxTemplates
655
+ */
656
+ readonly filters?: string
643
657
  }
644
658
 
645
659
  /**
@@ -743,7 +757,7 @@ export class DocxTemplatesApi extends BaseAPI {
743
757
  * @memberof DocxTemplatesApi
744
758
  */
745
759
  public listDocxTemplates(requestParameters: DocxTemplatesApiListDocxTemplatesRequest = {}, options?: AxiosRequestConfig) {
746
- return DocxTemplatesApiFp(this.configuration).listDocxTemplates(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
760
+ return DocxTemplatesApiFp(this.configuration).listDocxTemplates(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
747
761
  }
748
762
 
749
763
  /**
@@ -198,10 +198,11 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
198
198
  * @param {string} [search] Search query
199
199
  * @param {string} [order] Ordering criteria
200
200
  * @param {string} [expand] Extra fields to fetch
201
+ * @param {string} [filters] List filters
201
202
  * @param {*} [options] Override http request option.
202
203
  * @throws {RequiredError}
203
204
  */
204
- listLayouts: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
205
+ listLayouts: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
205
206
  const localVarPath = `/documentservice/v1/layouts`;
206
207
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
207
208
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -244,6 +245,10 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
244
245
  localVarQueryParameter['expand'] = expand;
245
246
  }
246
247
 
248
+ if (filters !== undefined) {
249
+ localVarQueryParameter['filters'] = filters;
250
+ }
251
+
247
252
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
248
253
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
249
254
  }
@@ -367,11 +372,12 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
367
372
  * @param {string} [search] Search query
368
373
  * @param {string} [order] Ordering criteria
369
374
  * @param {string} [expand] Extra fields to fetch
375
+ * @param {string} [filters] List filters
370
376
  * @param {*} [options] Override http request option.
371
377
  * @throws {RequiredError}
372
378
  */
373
- async listLayouts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListLayoutsResponseClass>> {
374
- const localVarAxiosArgs = await localVarAxiosParamCreator.listLayouts(authorization, pageSize, pageToken, filter, search, order, expand, options);
379
+ async listLayouts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListLayoutsResponseClass>> {
380
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listLayouts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
375
381
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
376
382
  },
377
383
  /**
@@ -441,11 +447,12 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
441
447
  * @param {string} [search] Search query
442
448
  * @param {string} [order] Ordering criteria
443
449
  * @param {string} [expand] Extra fields to fetch
450
+ * @param {string} [filters] List filters
444
451
  * @param {*} [options] Override http request option.
445
452
  * @throws {RequiredError}
446
453
  */
447
- listLayouts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListLayoutsResponseClass> {
448
- return localVarFp.listLayouts(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
454
+ listLayouts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListLayoutsResponseClass> {
455
+ return localVarFp.listLayouts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
449
456
  },
450
457
  /**
451
458
  * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
@@ -586,6 +593,13 @@ export interface LayoutsApiListLayoutsRequest {
586
593
  * @memberof LayoutsApiListLayouts
587
594
  */
588
595
  readonly expand?: string
596
+
597
+ /**
598
+ * List filters
599
+ * @type {string}
600
+ * @memberof LayoutsApiListLayouts
601
+ */
602
+ readonly filters?: string
589
603
  }
590
604
 
591
605
  /**
@@ -668,7 +682,7 @@ export class LayoutsApi extends BaseAPI {
668
682
  * @memberof LayoutsApi
669
683
  */
670
684
  public listLayouts(requestParameters: LayoutsApiListLayoutsRequest = {}, options?: AxiosRequestConfig) {
671
- return LayoutsApiFp(this.configuration).listLayouts(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
685
+ return LayoutsApiFp(this.configuration).listLayouts(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
672
686
  }
673
687
 
674
688
  /**
@@ -190,6 +190,7 @@ export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Co
190
190
  /**
191
191
  * 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.
192
192
  * @summary List product documents
193
+ * @param {string} productSlug
193
194
  * @param {string} [authorization] Bearer Token
194
195
  * @param {number} [pageSize] Page size
195
196
  * @param {string} [pageToken] Page token
@@ -197,11 +198,15 @@ export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Co
197
198
  * @param {string} [search] Search query
198
199
  * @param {string} [order] Ordering criteria
199
200
  * @param {string} [expand] Extra fields to fetch
201
+ * @param {string} [filters] List filters
200
202
  * @param {*} [options] Override http request option.
201
203
  * @throws {RequiredError}
202
204
  */
203
- listProductDocuments: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
204
- const localVarPath = `/documentservice/v1/documents/product`;
205
+ listProductDocuments: async (productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
206
+ // verify required parameter 'productSlug' is not null or undefined
207
+ assertParamExists('listProductDocuments', 'productSlug', productSlug)
208
+ const localVarPath = `/documentservice/v1/documents/product/{productSlug}`
209
+ .replace(`{${"productSlug"}}`, encodeURIComponent(String(productSlug)));
205
210
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
206
211
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
207
212
  let baseOptions;
@@ -243,6 +248,90 @@ export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Co
243
248
  localVarQueryParameter['expand'] = expand;
244
249
  }
245
250
 
251
+ if (filters !== undefined) {
252
+ localVarQueryParameter['filters'] = filters;
253
+ }
254
+
255
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
256
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
257
+ }
258
+
259
+
260
+
261
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
262
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
263
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
264
+
265
+ return {
266
+ url: toPathString(localVarUrlObj),
267
+ options: localVarRequestOptions,
268
+ };
269
+ },
270
+ /**
271
+ * 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.
272
+ * @summary List product documents
273
+ * @param {string} productSlug
274
+ * @param {string} [authorization] Bearer Token
275
+ * @param {number} [pageSize] Page size
276
+ * @param {string} [pageToken] Page token
277
+ * @param {string} [filter] List filter
278
+ * @param {string} [search] Search query
279
+ * @param {string} [order] Ordering criteria
280
+ * @param {string} [expand] Extra fields to fetch
281
+ * @param {string} [filters] List filters
282
+ * @param {*} [options] Override http request option.
283
+ * @throws {RequiredError}
284
+ */
285
+ listProductDocuments_1: async (productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
286
+ // verify required parameter 'productSlug' is not null or undefined
287
+ assertParamExists('listProductDocuments_1', 'productSlug', productSlug)
288
+ const localVarPath = `/documentservice/v1/documents/product`
289
+ .replace(`{${"productSlug"}}`, encodeURIComponent(String(productSlug)));
290
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
291
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
292
+ let baseOptions;
293
+ let baseAccessToken;
294
+ if (configuration) {
295
+ baseOptions = configuration.baseOptions;
296
+ baseAccessToken = configuration.accessToken;
297
+ }
298
+
299
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
300
+ const localVarHeaderParameter = {} as any;
301
+ const localVarQueryParameter = {} as any;
302
+
303
+ // authentication bearer required
304
+ // http bearer authentication required
305
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
306
+
307
+ if (pageSize !== undefined) {
308
+ localVarQueryParameter['pageSize'] = pageSize;
309
+ }
310
+
311
+ if (pageToken !== undefined) {
312
+ localVarQueryParameter['pageToken'] = pageToken;
313
+ }
314
+
315
+ if (filter !== undefined) {
316
+ localVarQueryParameter['filter'] = filter;
317
+ }
318
+
319
+ if (search !== undefined) {
320
+ localVarQueryParameter['search'] = search;
321
+ }
322
+
323
+ if (order !== undefined) {
324
+ localVarQueryParameter['order'] = order;
325
+ }
326
+
327
+ if (expand !== undefined) {
328
+ localVarQueryParameter['expand'] = expand;
329
+ }
330
+
331
+ if (filters !== undefined) {
332
+ localVarQueryParameter['filters'] = filters;
333
+ }
334
+
246
335
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
247
336
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
248
337
  }
@@ -361,6 +450,26 @@ export const ProductDocumentsApiFp = function(configuration?: Configuration) {
361
450
  /**
362
451
  * 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.
363
452
  * @summary List product documents
453
+ * @param {string} productSlug
454
+ * @param {string} [authorization] Bearer Token
455
+ * @param {number} [pageSize] Page size
456
+ * @param {string} [pageToken] Page token
457
+ * @param {string} [filter] List filter
458
+ * @param {string} [search] Search query
459
+ * @param {string} [order] Ordering criteria
460
+ * @param {string} [expand] Extra fields to fetch
461
+ * @param {string} [filters] List filters
462
+ * @param {*} [options] Override http request option.
463
+ * @throws {RequiredError}
464
+ */
465
+ 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>> {
466
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listProductDocuments(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
467
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
468
+ },
469
+ /**
470
+ * 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.
471
+ * @summary List product documents
472
+ * @param {string} productSlug
364
473
  * @param {string} [authorization] Bearer Token
365
474
  * @param {number} [pageSize] Page size
366
475
  * @param {string} [pageToken] Page token
@@ -368,11 +477,12 @@ export const ProductDocumentsApiFp = function(configuration?: Configuration) {
368
477
  * @param {string} [search] Search query
369
478
  * @param {string} [order] Ordering criteria
370
479
  * @param {string} [expand] Extra fields to fetch
480
+ * @param {string} [filters] List filters
371
481
  * @param {*} [options] Override http request option.
372
482
  * @throws {RequiredError}
373
483
  */
374
- async listProductDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductDocumentsResponseClass>> {
375
- const localVarAxiosArgs = await localVarAxiosParamCreator.listProductDocuments(authorization, pageSize, pageToken, filter, search, order, expand, options);
484
+ async listProductDocuments_1(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>> {
485
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listProductDocuments_1(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
376
486
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
377
487
  },
378
488
  /**
@@ -437,6 +547,25 @@ export const ProductDocumentsApiFactory = function (configuration?: Configuratio
437
547
  /**
438
548
  * 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
549
  * @summary List product documents
550
+ * @param {string} productSlug
551
+ * @param {string} [authorization] Bearer Token
552
+ * @param {number} [pageSize] Page size
553
+ * @param {string} [pageToken] Page token
554
+ * @param {string} [filter] List filter
555
+ * @param {string} [search] Search query
556
+ * @param {string} [order] Ordering criteria
557
+ * @param {string} [expand] Extra fields to fetch
558
+ * @param {string} [filters] List filters
559
+ * @param {*} [options] Override http request option.
560
+ * @throws {RequiredError}
561
+ */
562
+ listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass> {
563
+ return localVarFp.listProductDocuments(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
564
+ },
565
+ /**
566
+ * 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.
567
+ * @summary List product documents
568
+ * @param {string} productSlug
440
569
  * @param {string} [authorization] Bearer Token
441
570
  * @param {number} [pageSize] Page size
442
571
  * @param {string} [pageToken] Page token
@@ -444,11 +573,12 @@ export const ProductDocumentsApiFactory = function (configuration?: Configuratio
444
573
  * @param {string} [search] Search query
445
574
  * @param {string} [order] Ordering criteria
446
575
  * @param {string} [expand] Extra fields to fetch
576
+ * @param {string} [filters] List filters
447
577
  * @param {*} [options] Override http request option.
448
578
  * @throws {RequiredError}
449
579
  */
450
- listProductDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass> {
451
- return localVarFp.listProductDocuments(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
580
+ listProductDocuments_1(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass> {
581
+ return localVarFp.listProductDocuments_1(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
452
582
  },
453
583
  /**
454
584
  * Upload a product document.
@@ -555,6 +685,13 @@ export interface ProductDocumentsApiGetProductDocumentRequest {
555
685
  * @interface ProductDocumentsApiListProductDocumentsRequest
556
686
  */
557
687
  export interface ProductDocumentsApiListProductDocumentsRequest {
688
+ /**
689
+ *
690
+ * @type {string}
691
+ * @memberof ProductDocumentsApiListProductDocuments
692
+ */
693
+ readonly productSlug: string
694
+
558
695
  /**
559
696
  * Bearer Token
560
697
  * @type {string}
@@ -603,6 +740,83 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
603
740
  * @memberof ProductDocumentsApiListProductDocuments
604
741
  */
605
742
  readonly expand?: string
743
+
744
+ /**
745
+ * List filters
746
+ * @type {string}
747
+ * @memberof ProductDocumentsApiListProductDocuments
748
+ */
749
+ readonly filters?: string
750
+ }
751
+
752
+ /**
753
+ * Request parameters for listProductDocuments_1 operation in ProductDocumentsApi.
754
+ * @export
755
+ * @interface ProductDocumentsApiListProductDocuments0Request
756
+ */
757
+ export interface ProductDocumentsApiListProductDocuments0Request {
758
+ /**
759
+ *
760
+ * @type {string}
761
+ * @memberof ProductDocumentsApiListProductDocuments0
762
+ */
763
+ readonly productSlug: string
764
+
765
+ /**
766
+ * Bearer Token
767
+ * @type {string}
768
+ * @memberof ProductDocumentsApiListProductDocuments0
769
+ */
770
+ readonly authorization?: string
771
+
772
+ /**
773
+ * Page size
774
+ * @type {number}
775
+ * @memberof ProductDocumentsApiListProductDocuments0
776
+ */
777
+ readonly pageSize?: number
778
+
779
+ /**
780
+ * Page token
781
+ * @type {string}
782
+ * @memberof ProductDocumentsApiListProductDocuments0
783
+ */
784
+ readonly pageToken?: string
785
+
786
+ /**
787
+ * List filter
788
+ * @type {string}
789
+ * @memberof ProductDocumentsApiListProductDocuments0
790
+ */
791
+ readonly filter?: string
792
+
793
+ /**
794
+ * Search query
795
+ * @type {string}
796
+ * @memberof ProductDocumentsApiListProductDocuments0
797
+ */
798
+ readonly search?: string
799
+
800
+ /**
801
+ * Ordering criteria
802
+ * @type {string}
803
+ * @memberof ProductDocumentsApiListProductDocuments0
804
+ */
805
+ readonly order?: string
806
+
807
+ /**
808
+ * Extra fields to fetch
809
+ * @type {string}
810
+ * @memberof ProductDocumentsApiListProductDocuments0
811
+ */
812
+ readonly expand?: string
813
+
814
+ /**
815
+ * List filters
816
+ * @type {string}
817
+ * @memberof ProductDocumentsApiListProductDocuments0
818
+ */
819
+ readonly filters?: string
606
820
  }
607
821
 
608
822
  /**
@@ -684,8 +898,20 @@ export class ProductDocumentsApi extends BaseAPI {
684
898
  * @throws {RequiredError}
685
899
  * @memberof ProductDocumentsApi
686
900
  */
687
- public listProductDocuments(requestParameters: ProductDocumentsApiListProductDocumentsRequest = {}, options?: AxiosRequestConfig) {
688
- return ProductDocumentsApiFp(this.configuration).listProductDocuments(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
901
+ public listProductDocuments(requestParameters: ProductDocumentsApiListProductDocumentsRequest, options?: AxiosRequestConfig) {
902
+ return ProductDocumentsApiFp(this.configuration).listProductDocuments(requestParameters.productSlug, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
903
+ }
904
+
905
+ /**
906
+ * 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.
907
+ * @summary List product documents
908
+ * @param {ProductDocumentsApiListProductDocuments0Request} requestParameters Request parameters.
909
+ * @param {*} [options] Override http request option.
910
+ * @throws {RequiredError}
911
+ * @memberof ProductDocumentsApi
912
+ */
913
+ public listProductDocuments_1(requestParameters: ProductDocumentsApiListProductDocuments0Request, options?: AxiosRequestConfig) {
914
+ return ProductDocumentsApiFp(this.configuration).listProductDocuments_1(requestParameters.productSlug, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
689
915
  }
690
916
 
691
917
  /**
@@ -42,10 +42,11 @@ export const SearchableDocumentOwnersApiAxiosParamCreator = function (configurat
42
42
  * @param {string} [search] Search query
43
43
  * @param {string} [order] Ordering criteria
44
44
  * @param {string} [expand] Extra fields to fetch
45
+ * @param {string} [filters] List filters
45
46
  * @param {*} [options] Override http request option.
46
47
  * @throws {RequiredError}
47
48
  */
48
- listSearchableDocumentOwners: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
49
+ listSearchableDocumentOwners: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
49
50
  const localVarPath = `/documentservice/v1/searchable-document-owners`;
50
51
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
51
52
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -88,6 +89,10 @@ export const SearchableDocumentOwnersApiAxiosParamCreator = function (configurat
88
89
  localVarQueryParameter['expand'] = expand;
89
90
  }
90
91
 
92
+ if (filters !== undefined) {
93
+ localVarQueryParameter['filters'] = filters;
94
+ }
95
+
91
96
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
92
97
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
93
98
  }
@@ -123,11 +128,12 @@ export const SearchableDocumentOwnersApiFp = function(configuration?: Configurat
123
128
  * @param {string} [search] Search query
124
129
  * @param {string} [order] Ordering criteria
125
130
  * @param {string} [expand] Extra fields to fetch
131
+ * @param {string} [filters] List filters
126
132
  * @param {*} [options] Override http request option.
127
133
  * @throws {RequiredError}
128
134
  */
129
- async listSearchableDocumentOwners(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListSearchableDocumentOwnersResponseClass>> {
130
- const localVarAxiosArgs = await localVarAxiosParamCreator.listSearchableDocumentOwners(authorization, pageSize, pageToken, filter, search, order, expand, options);
135
+ async listSearchableDocumentOwners(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListSearchableDocumentOwnersResponseClass>> {
136
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listSearchableDocumentOwners(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
131
137
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
132
138
  },
133
139
  }
@@ -150,11 +156,12 @@ export const SearchableDocumentOwnersApiFactory = function (configuration?: Conf
150
156
  * @param {string} [search] Search query
151
157
  * @param {string} [order] Ordering criteria
152
158
  * @param {string} [expand] Extra fields to fetch
159
+ * @param {string} [filters] List filters
153
160
  * @param {*} [options] Override http request option.
154
161
  * @throws {RequiredError}
155
162
  */
156
- listSearchableDocumentOwners(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListSearchableDocumentOwnersResponseClass> {
157
- return localVarFp.listSearchableDocumentOwners(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
163
+ listSearchableDocumentOwners(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListSearchableDocumentOwnersResponseClass> {
164
+ return localVarFp.listSearchableDocumentOwners(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
158
165
  },
159
166
  };
160
167
  };
@@ -213,6 +220,13 @@ export interface SearchableDocumentOwnersApiListSearchableDocumentOwnersRequest
213
220
  * @memberof SearchableDocumentOwnersApiListSearchableDocumentOwners
214
221
  */
215
222
  readonly expand?: string
223
+
224
+ /**
225
+ * List filters
226
+ * @type {string}
227
+ * @memberof SearchableDocumentOwnersApiListSearchableDocumentOwners
228
+ */
229
+ readonly filters?: string
216
230
  }
217
231
 
218
232
  /**
@@ -231,6 +245,6 @@ export class SearchableDocumentOwnersApi extends BaseAPI {
231
245
  * @memberof SearchableDocumentOwnersApi
232
246
  */
233
247
  public listSearchableDocumentOwners(requestParameters: SearchableDocumentOwnersApiListSearchableDocumentOwnersRequest = {}, options?: AxiosRequestConfig) {
234
- return SearchableDocumentOwnersApiFp(this.configuration).listSearchableDocumentOwners(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
248
+ return SearchableDocumentOwnersApiFp(this.configuration).listSearchableDocumentOwners(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
235
249
  }
236
250
  }