@emilgroup/document-sdk-node 1.16.0 → 1.20.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.20.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.20.0
25
25
  ```
26
26
 
27
27
  And then you can import `DocumentsApi`.
@@ -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
@@ -200,8 +201,86 @@ export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Co
200
201
  * @param {*} [options] Override http request option.
201
202
  * @throws {RequiredError}
202
203
  */
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`;
204
+ listProductDocuments: async (productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
205
+ // verify required parameter 'productSlug' is not null or undefined
206
+ assertParamExists('listProductDocuments', 'productSlug', productSlug)
207
+ const localVarPath = `/documentservice/v1/documents/product/{productSlug}`
208
+ .replace(`{${"productSlug"}}`, encodeURIComponent(String(productSlug)));
209
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
210
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
211
+ let baseOptions;
212
+ let baseAccessToken;
213
+ if (configuration) {
214
+ baseOptions = configuration.baseOptions;
215
+ baseAccessToken = configuration.accessToken;
216
+ }
217
+
218
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
219
+ const localVarHeaderParameter = {} as any;
220
+ const localVarQueryParameter = {} as any;
221
+
222
+ // authentication bearer required
223
+ // http bearer authentication required
224
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
225
+
226
+ if (pageSize !== undefined) {
227
+ localVarQueryParameter['pageSize'] = pageSize;
228
+ }
229
+
230
+ if (pageToken !== undefined) {
231
+ localVarQueryParameter['pageToken'] = pageToken;
232
+ }
233
+
234
+ if (filter !== undefined) {
235
+ localVarQueryParameter['filter'] = filter;
236
+ }
237
+
238
+ if (search !== undefined) {
239
+ localVarQueryParameter['search'] = search;
240
+ }
241
+
242
+ if (order !== undefined) {
243
+ localVarQueryParameter['order'] = order;
244
+ }
245
+
246
+ if (expand !== undefined) {
247
+ localVarQueryParameter['expand'] = expand;
248
+ }
249
+
250
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
251
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
252
+ }
253
+
254
+
255
+
256
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
257
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
258
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
259
+
260
+ return {
261
+ url: toPathString(localVarUrlObj),
262
+ options: localVarRequestOptions,
263
+ };
264
+ },
265
+ /**
266
+ * 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.
267
+ * @summary List product documents
268
+ * @param {string} productSlug
269
+ * @param {string} [authorization] Bearer Token
270
+ * @param {number} [pageSize] Page size
271
+ * @param {string} [pageToken] Page token
272
+ * @param {string} [filter] List filter
273
+ * @param {string} [search] Search query
274
+ * @param {string} [order] Ordering criteria
275
+ * @param {string} [expand] Extra fields to fetch
276
+ * @param {*} [options] Override http request option.
277
+ * @throws {RequiredError}
278
+ */
279
+ listProductDocuments_1: async (productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
280
+ // verify required parameter 'productSlug' is not null or undefined
281
+ assertParamExists('listProductDocuments_1', 'productSlug', productSlug)
282
+ const localVarPath = `/documentservice/v1/documents/product`
283
+ .replace(`{${"productSlug"}}`, encodeURIComponent(String(productSlug)));
205
284
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
206
285
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
207
286
  let baseOptions;
@@ -361,6 +440,7 @@ export const ProductDocumentsApiFp = function(configuration?: Configuration) {
361
440
  /**
362
441
  * 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
442
  * @summary List product documents
443
+ * @param {string} productSlug
364
444
  * @param {string} [authorization] Bearer Token
365
445
  * @param {number} [pageSize] Page size
366
446
  * @param {string} [pageToken] Page token
@@ -371,8 +451,26 @@ export const ProductDocumentsApiFp = function(configuration?: Configuration) {
371
451
  * @param {*} [options] Override http request option.
372
452
  * @throws {RequiredError}
373
453
  */
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);
454
+ async listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductDocumentsResponseClass>> {
455
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listProductDocuments(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, options);
456
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
457
+ },
458
+ /**
459
+ * 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.
460
+ * @summary List product documents
461
+ * @param {string} productSlug
462
+ * @param {string} [authorization] Bearer Token
463
+ * @param {number} [pageSize] Page size
464
+ * @param {string} [pageToken] Page token
465
+ * @param {string} [filter] List filter
466
+ * @param {string} [search] Search query
467
+ * @param {string} [order] Ordering criteria
468
+ * @param {string} [expand] Extra fields to fetch
469
+ * @param {*} [options] Override http request option.
470
+ * @throws {RequiredError}
471
+ */
472
+ async listProductDocuments_1(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductDocumentsResponseClass>> {
473
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listProductDocuments_1(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, options);
376
474
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
377
475
  },
378
476
  /**
@@ -437,6 +535,24 @@ export const ProductDocumentsApiFactory = function (configuration?: Configuratio
437
535
  /**
438
536
  * 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
537
  * @summary List product documents
538
+ * @param {string} productSlug
539
+ * @param {string} [authorization] Bearer Token
540
+ * @param {number} [pageSize] Page size
541
+ * @param {string} [pageToken] Page token
542
+ * @param {string} [filter] List filter
543
+ * @param {string} [search] Search query
544
+ * @param {string} [order] Ordering criteria
545
+ * @param {string} [expand] Extra fields to fetch
546
+ * @param {*} [options] Override http request option.
547
+ * @throws {RequiredError}
548
+ */
549
+ listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass> {
550
+ return localVarFp.listProductDocuments(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
551
+ },
552
+ /**
553
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
554
+ * @summary List product documents
555
+ * @param {string} productSlug
440
556
  * @param {string} [authorization] Bearer Token
441
557
  * @param {number} [pageSize] Page size
442
558
  * @param {string} [pageToken] Page token
@@ -447,8 +563,8 @@ export const ProductDocumentsApiFactory = function (configuration?: Configuratio
447
563
  * @param {*} [options] Override http request option.
448
564
  * @throws {RequiredError}
449
565
  */
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));
566
+ listProductDocuments_1(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass> {
567
+ return localVarFp.listProductDocuments_1(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
452
568
  },
453
569
  /**
454
570
  * Upload a product document.
@@ -555,6 +671,13 @@ export interface ProductDocumentsApiGetProductDocumentRequest {
555
671
  * @interface ProductDocumentsApiListProductDocumentsRequest
556
672
  */
557
673
  export interface ProductDocumentsApiListProductDocumentsRequest {
674
+ /**
675
+ *
676
+ * @type {string}
677
+ * @memberof ProductDocumentsApiListProductDocuments
678
+ */
679
+ readonly productSlug: string
680
+
558
681
  /**
559
682
  * Bearer Token
560
683
  * @type {string}
@@ -605,6 +728,69 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
605
728
  readonly expand?: string
606
729
  }
607
730
 
731
+ /**
732
+ * Request parameters for listProductDocuments_1 operation in ProductDocumentsApi.
733
+ * @export
734
+ * @interface ProductDocumentsApiListProductDocuments0Request
735
+ */
736
+ export interface ProductDocumentsApiListProductDocuments0Request {
737
+ /**
738
+ *
739
+ * @type {string}
740
+ * @memberof ProductDocumentsApiListProductDocuments0
741
+ */
742
+ readonly productSlug: string
743
+
744
+ /**
745
+ * Bearer Token
746
+ * @type {string}
747
+ * @memberof ProductDocumentsApiListProductDocuments0
748
+ */
749
+ readonly authorization?: string
750
+
751
+ /**
752
+ * Page size
753
+ * @type {number}
754
+ * @memberof ProductDocumentsApiListProductDocuments0
755
+ */
756
+ readonly pageSize?: number
757
+
758
+ /**
759
+ * Page token
760
+ * @type {string}
761
+ * @memberof ProductDocumentsApiListProductDocuments0
762
+ */
763
+ readonly pageToken?: string
764
+
765
+ /**
766
+ * List filter
767
+ * @type {string}
768
+ * @memberof ProductDocumentsApiListProductDocuments0
769
+ */
770
+ readonly filter?: string
771
+
772
+ /**
773
+ * Search query
774
+ * @type {string}
775
+ * @memberof ProductDocumentsApiListProductDocuments0
776
+ */
777
+ readonly search?: string
778
+
779
+ /**
780
+ * Ordering criteria
781
+ * @type {string}
782
+ * @memberof ProductDocumentsApiListProductDocuments0
783
+ */
784
+ readonly order?: string
785
+
786
+ /**
787
+ * Extra fields to fetch
788
+ * @type {string}
789
+ * @memberof ProductDocumentsApiListProductDocuments0
790
+ */
791
+ readonly expand?: string
792
+ }
793
+
608
794
  /**
609
795
  * Request parameters for uploadProductDocument operation in ProductDocumentsApi.
610
796
  * @export
@@ -684,8 +870,20 @@ export class ProductDocumentsApi extends BaseAPI {
684
870
  * @throws {RequiredError}
685
871
  * @memberof ProductDocumentsApi
686
872
  */
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));
873
+ public listProductDocuments(requestParameters: ProductDocumentsApiListProductDocumentsRequest, options?: AxiosRequestConfig) {
874
+ return ProductDocumentsApiFp(this.configuration).listProductDocuments(requestParameters.productSlug, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
875
+ }
876
+
877
+ /**
878
+ * 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.
879
+ * @summary List product documents
880
+ * @param {ProductDocumentsApiListProductDocuments0Request} requestParameters Request parameters.
881
+ * @param {*} [options] Override http request option.
882
+ * @throws {RequiredError}
883
+ * @memberof ProductDocumentsApi
884
+ */
885
+ public listProductDocuments_1(requestParameters: ProductDocumentsApiListProductDocuments0Request, options?: AxiosRequestConfig) {
886
+ return ProductDocumentsApiFp(this.configuration).listProductDocuments_1(requestParameters.productSlug, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
689
887
  }
690
888
 
691
889
  /**
@@ -55,6 +55,22 @@ export declare const ProductDocumentsApiAxiosParamCreator: (configuration?: Conf
55
55
  /**
56
56
  * 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
57
  * @summary List product documents
58
+ * @param {string} productSlug
59
+ * @param {string} [authorization] Bearer Token
60
+ * @param {number} [pageSize] Page size
61
+ * @param {string} [pageToken] Page token
62
+ * @param {string} [filter] List filter
63
+ * @param {string} [search] Search query
64
+ * @param {string} [order] Ordering criteria
65
+ * @param {string} [expand] Extra fields to fetch
66
+ * @param {*} [options] Override http request option.
67
+ * @throws {RequiredError}
68
+ */
69
+ listProductDocuments: (productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
70
+ /**
71
+ * 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.
72
+ * @summary List product documents
73
+ * @param {string} productSlug
58
74
  * @param {string} [authorization] Bearer Token
59
75
  * @param {number} [pageSize] Page size
60
76
  * @param {string} [pageToken] Page token
@@ -65,7 +81,7 @@ export declare const ProductDocumentsApiAxiosParamCreator: (configuration?: Conf
65
81
  * @param {*} [options] Override http request option.
66
82
  * @throws {RequiredError}
67
83
  */
68
- listProductDocuments: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
84
+ listProductDocuments_1: (productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
69
85
  /**
70
86
  * Upload a product document.
71
87
  * @summary Create the product document
@@ -115,6 +131,7 @@ export declare const ProductDocumentsApiFp: (configuration?: Configuration) => {
115
131
  /**
116
132
  * 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.
117
133
  * @summary List product documents
134
+ * @param {string} productSlug
118
135
  * @param {string} [authorization] Bearer Token
119
136
  * @param {number} [pageSize] Page size
120
137
  * @param {string} [pageToken] Page token
@@ -125,7 +142,22 @@ export declare const ProductDocumentsApiFp: (configuration?: Configuration) => {
125
142
  * @param {*} [options] Override http request option.
126
143
  * @throws {RequiredError}
127
144
  */
128
- listProductDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductDocumentsResponseClass>>;
145
+ listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductDocumentsResponseClass>>;
146
+ /**
147
+ * 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.
148
+ * @summary List product documents
149
+ * @param {string} productSlug
150
+ * @param {string} [authorization] Bearer Token
151
+ * @param {number} [pageSize] Page size
152
+ * @param {string} [pageToken] Page token
153
+ * @param {string} [filter] List filter
154
+ * @param {string} [search] Search query
155
+ * @param {string} [order] Ordering criteria
156
+ * @param {string} [expand] Extra fields to fetch
157
+ * @param {*} [options] Override http request option.
158
+ * @throws {RequiredError}
159
+ */
160
+ listProductDocuments_1(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductDocumentsResponseClass>>;
129
161
  /**
130
162
  * Upload a product document.
131
163
  * @summary Create the product document
@@ -175,6 +207,7 @@ export declare const ProductDocumentsApiFactory: (configuration?: Configuration,
175
207
  /**
176
208
  * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
177
209
  * @summary List product documents
210
+ * @param {string} productSlug
178
211
  * @param {string} [authorization] Bearer Token
179
212
  * @param {number} [pageSize] Page size
180
213
  * @param {string} [pageToken] Page token
@@ -185,7 +218,22 @@ export declare const ProductDocumentsApiFactory: (configuration?: Configuration,
185
218
  * @param {*} [options] Override http request option.
186
219
  * @throws {RequiredError}
187
220
  */
188
- listProductDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass>;
221
+ listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass>;
222
+ /**
223
+ * 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.
224
+ * @summary List product documents
225
+ * @param {string} productSlug
226
+ * @param {string} [authorization] Bearer Token
227
+ * @param {number} [pageSize] Page size
228
+ * @param {string} [pageToken] Page token
229
+ * @param {string} [filter] List filter
230
+ * @param {string} [search] Search query
231
+ * @param {string} [order] Ordering criteria
232
+ * @param {string} [expand] Extra fields to fetch
233
+ * @param {*} [options] Override http request option.
234
+ * @throws {RequiredError}
235
+ */
236
+ listProductDocuments_1(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass>;
189
237
  /**
190
238
  * Upload a product document.
191
239
  * @summary Create the product document
@@ -278,6 +326,12 @@ export interface ProductDocumentsApiGetProductDocumentRequest {
278
326
  * @interface ProductDocumentsApiListProductDocumentsRequest
279
327
  */
280
328
  export interface ProductDocumentsApiListProductDocumentsRequest {
329
+ /**
330
+ *
331
+ * @type {string}
332
+ * @memberof ProductDocumentsApiListProductDocuments
333
+ */
334
+ readonly productSlug: string;
281
335
  /**
282
336
  * Bearer Token
283
337
  * @type {string}
@@ -321,6 +375,61 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
321
375
  */
322
376
  readonly expand?: string;
323
377
  }
378
+ /**
379
+ * Request parameters for listProductDocuments_1 operation in ProductDocumentsApi.
380
+ * @export
381
+ * @interface ProductDocumentsApiListProductDocuments0Request
382
+ */
383
+ export interface ProductDocumentsApiListProductDocuments0Request {
384
+ /**
385
+ *
386
+ * @type {string}
387
+ * @memberof ProductDocumentsApiListProductDocuments0
388
+ */
389
+ readonly productSlug: string;
390
+ /**
391
+ * Bearer Token
392
+ * @type {string}
393
+ * @memberof ProductDocumentsApiListProductDocuments0
394
+ */
395
+ readonly authorization?: string;
396
+ /**
397
+ * Page size
398
+ * @type {number}
399
+ * @memberof ProductDocumentsApiListProductDocuments0
400
+ */
401
+ readonly pageSize?: number;
402
+ /**
403
+ * Page token
404
+ * @type {string}
405
+ * @memberof ProductDocumentsApiListProductDocuments0
406
+ */
407
+ readonly pageToken?: string;
408
+ /**
409
+ * List filter
410
+ * @type {string}
411
+ * @memberof ProductDocumentsApiListProductDocuments0
412
+ */
413
+ readonly filter?: string;
414
+ /**
415
+ * Search query
416
+ * @type {string}
417
+ * @memberof ProductDocumentsApiListProductDocuments0
418
+ */
419
+ readonly search?: string;
420
+ /**
421
+ * Ordering criteria
422
+ * @type {string}
423
+ * @memberof ProductDocumentsApiListProductDocuments0
424
+ */
425
+ readonly order?: string;
426
+ /**
427
+ * Extra fields to fetch
428
+ * @type {string}
429
+ * @memberof ProductDocumentsApiListProductDocuments0
430
+ */
431
+ readonly expand?: string;
432
+ }
324
433
  /**
325
434
  * Request parameters for uploadProductDocument operation in ProductDocumentsApi.
326
435
  * @export
@@ -388,7 +497,16 @@ export declare class ProductDocumentsApi extends BaseAPI {
388
497
  * @throws {RequiredError}
389
498
  * @memberof ProductDocumentsApi
390
499
  */
391
- listProductDocuments(requestParameters?: ProductDocumentsApiListProductDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProductDocumentsResponseClass, any>>;
500
+ listProductDocuments(requestParameters: ProductDocumentsApiListProductDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProductDocumentsResponseClass, any>>;
501
+ /**
502
+ * 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.
503
+ * @summary List product documents
504
+ * @param {ProductDocumentsApiListProductDocuments0Request} requestParameters Request parameters.
505
+ * @param {*} [options] Override http request option.
506
+ * @throws {RequiredError}
507
+ * @memberof ProductDocumentsApi
508
+ */
509
+ listProductDocuments_1(requestParameters: ProductDocumentsApiListProductDocuments0Request, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProductDocumentsResponseClass, any>>;
392
510
  /**
393
511
  * Upload a product document.
394
512
  * @summary Create the product document
@@ -255,6 +255,79 @@ var ProductDocumentsApiAxiosParamCreator = function (configuration) {
255
255
  /**
256
256
  * 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.
257
257
  * @summary List product documents
258
+ * @param {string} productSlug
259
+ * @param {string} [authorization] Bearer Token
260
+ * @param {number} [pageSize] Page size
261
+ * @param {string} [pageToken] Page token
262
+ * @param {string} [filter] List filter
263
+ * @param {string} [search] Search query
264
+ * @param {string} [order] Ordering criteria
265
+ * @param {string} [expand] Extra fields to fetch
266
+ * @param {*} [options] Override http request option.
267
+ * @throws {RequiredError}
268
+ */
269
+ listProductDocuments: function (productSlug, authorization, pageSize, pageToken, filter, search, order, expand, options) {
270
+ if (options === void 0) { options = {}; }
271
+ return __awaiter(_this, void 0, void 0, function () {
272
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
273
+ return __generator(this, function (_a) {
274
+ switch (_a.label) {
275
+ case 0:
276
+ // verify required parameter 'productSlug' is not null or undefined
277
+ (0, common_1.assertParamExists)('listProductDocuments', 'productSlug', productSlug);
278
+ localVarPath = "/documentservice/v1/documents/product/{productSlug}"
279
+ .replace("{".concat("productSlug", "}"), encodeURIComponent(String(productSlug)));
280
+ localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
281
+ if (configuration) {
282
+ baseOptions = configuration.baseOptions;
283
+ baseAccessToken = configuration.accessToken;
284
+ }
285
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
286
+ localVarHeaderParameter = {};
287
+ localVarQueryParameter = {};
288
+ // authentication bearer required
289
+ // http bearer authentication required
290
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
291
+ case 1:
292
+ // authentication bearer required
293
+ // http bearer authentication required
294
+ _a.sent();
295
+ if (pageSize !== undefined) {
296
+ localVarQueryParameter['pageSize'] = pageSize;
297
+ }
298
+ if (pageToken !== undefined) {
299
+ localVarQueryParameter['pageToken'] = pageToken;
300
+ }
301
+ if (filter !== undefined) {
302
+ localVarQueryParameter['filter'] = filter;
303
+ }
304
+ if (search !== undefined) {
305
+ localVarQueryParameter['search'] = search;
306
+ }
307
+ if (order !== undefined) {
308
+ localVarQueryParameter['order'] = order;
309
+ }
310
+ if (expand !== undefined) {
311
+ localVarQueryParameter['expand'] = expand;
312
+ }
313
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
314
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
315
+ }
316
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
317
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
318
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
319
+ return [2 /*return*/, {
320
+ url: (0, common_1.toPathString)(localVarUrlObj),
321
+ options: localVarRequestOptions,
322
+ }];
323
+ }
324
+ });
325
+ });
326
+ },
327
+ /**
328
+ * 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.
329
+ * @summary List product documents
330
+ * @param {string} productSlug
258
331
  * @param {string} [authorization] Bearer Token
259
332
  * @param {number} [pageSize] Page size
260
333
  * @param {string} [pageToken] Page token
@@ -265,14 +338,17 @@ var ProductDocumentsApiAxiosParamCreator = function (configuration) {
265
338
  * @param {*} [options] Override http request option.
266
339
  * @throws {RequiredError}
267
340
  */
268
- listProductDocuments: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
341
+ listProductDocuments_1: function (productSlug, authorization, pageSize, pageToken, filter, search, order, expand, options) {
269
342
  if (options === void 0) { options = {}; }
270
343
  return __awaiter(_this, void 0, void 0, function () {
271
344
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
272
345
  return __generator(this, function (_a) {
273
346
  switch (_a.label) {
274
347
  case 0:
275
- localVarPath = "/documentservice/v1/documents/product";
348
+ // verify required parameter 'productSlug' is not null or undefined
349
+ (0, common_1.assertParamExists)('listProductDocuments_1', 'productSlug', productSlug);
350
+ localVarPath = "/documentservice/v1/documents/product"
351
+ .replace("{".concat("productSlug", "}"), encodeURIComponent(String(productSlug)));
276
352
  localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
277
353
  if (configuration) {
278
354
  baseOptions = configuration.baseOptions;
@@ -452,6 +528,34 @@ var ProductDocumentsApiFp = function (configuration) {
452
528
  /**
453
529
  * 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.
454
530
  * @summary List product documents
531
+ * @param {string} productSlug
532
+ * @param {string} [authorization] Bearer Token
533
+ * @param {number} [pageSize] Page size
534
+ * @param {string} [pageToken] Page token
535
+ * @param {string} [filter] List filter
536
+ * @param {string} [search] Search query
537
+ * @param {string} [order] Ordering criteria
538
+ * @param {string} [expand] Extra fields to fetch
539
+ * @param {*} [options] Override http request option.
540
+ * @throws {RequiredError}
541
+ */
542
+ listProductDocuments: function (productSlug, authorization, pageSize, pageToken, filter, search, order, expand, options) {
543
+ return __awaiter(this, void 0, void 0, function () {
544
+ var localVarAxiosArgs;
545
+ return __generator(this, function (_a) {
546
+ switch (_a.label) {
547
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listProductDocuments(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, options)];
548
+ case 1:
549
+ localVarAxiosArgs = _a.sent();
550
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
551
+ }
552
+ });
553
+ });
554
+ },
555
+ /**
556
+ * 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.
557
+ * @summary List product documents
558
+ * @param {string} productSlug
455
559
  * @param {string} [authorization] Bearer Token
456
560
  * @param {number} [pageSize] Page size
457
561
  * @param {string} [pageToken] Page token
@@ -462,12 +566,12 @@ var ProductDocumentsApiFp = function (configuration) {
462
566
  * @param {*} [options] Override http request option.
463
567
  * @throws {RequiredError}
464
568
  */
465
- listProductDocuments: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
569
+ listProductDocuments_1: function (productSlug, authorization, pageSize, pageToken, filter, search, order, expand, options) {
466
570
  return __awaiter(this, void 0, void 0, function () {
467
571
  var localVarAxiosArgs;
468
572
  return __generator(this, function (_a) {
469
573
  switch (_a.label) {
470
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.listProductDocuments(authorization, pageSize, pageToken, filter, search, order, expand, options)];
574
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listProductDocuments_1(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, options)];
471
575
  case 1:
472
576
  localVarAxiosArgs = _a.sent();
473
577
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -546,6 +650,7 @@ var ProductDocumentsApiFactory = function (configuration, basePath, axios) {
546
650
  /**
547
651
  * 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.
548
652
  * @summary List product documents
653
+ * @param {string} productSlug
549
654
  * @param {string} [authorization] Bearer Token
550
655
  * @param {number} [pageSize] Page size
551
656
  * @param {string} [pageToken] Page token
@@ -556,8 +661,25 @@ var ProductDocumentsApiFactory = function (configuration, basePath, axios) {
556
661
  * @param {*} [options] Override http request option.
557
662
  * @throws {RequiredError}
558
663
  */
559
- listProductDocuments: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
560
- return localVarFp.listProductDocuments(authorization, pageSize, pageToken, filter, search, order, expand, options).then(function (request) { return request(axios, basePath); });
664
+ listProductDocuments: function (productSlug, authorization, pageSize, pageToken, filter, search, order, expand, options) {
665
+ return localVarFp.listProductDocuments(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, options).then(function (request) { return request(axios, basePath); });
666
+ },
667
+ /**
668
+ * 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.
669
+ * @summary List product documents
670
+ * @param {string} productSlug
671
+ * @param {string} [authorization] Bearer Token
672
+ * @param {number} [pageSize] Page size
673
+ * @param {string} [pageToken] Page token
674
+ * @param {string} [filter] List filter
675
+ * @param {string} [search] Search query
676
+ * @param {string} [order] Ordering criteria
677
+ * @param {string} [expand] Extra fields to fetch
678
+ * @param {*} [options] Override http request option.
679
+ * @throws {RequiredError}
680
+ */
681
+ listProductDocuments_1: function (productSlug, authorization, pageSize, pageToken, filter, search, order, expand, options) {
682
+ return localVarFp.listProductDocuments_1(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, options).then(function (request) { return request(axios, basePath); });
561
683
  },
562
684
  /**
563
685
  * Upload a product document.
@@ -631,8 +753,19 @@ var ProductDocumentsApi = /** @class */ (function (_super) {
631
753
  */
632
754
  ProductDocumentsApi.prototype.listProductDocuments = function (requestParameters, options) {
633
755
  var _this = this;
634
- if (requestParameters === void 0) { requestParameters = {}; }
635
- return (0, exports.ProductDocumentsApiFp)(this.configuration).listProductDocuments(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
756
+ return (0, exports.ProductDocumentsApiFp)(this.configuration).listProductDocuments(requestParameters.productSlug, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
757
+ };
758
+ /**
759
+ * 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.
760
+ * @summary List product documents
761
+ * @param {ProductDocumentsApiListProductDocuments0Request} requestParameters Request parameters.
762
+ * @param {*} [options] Override http request option.
763
+ * @throws {RequiredError}
764
+ * @memberof ProductDocumentsApi
765
+ */
766
+ ProductDocumentsApi.prototype.listProductDocuments_1 = function (requestParameters, options) {
767
+ var _this = this;
768
+ return (0, exports.ProductDocumentsApiFp)(this.configuration).listProductDocuments_1(requestParameters.productSlug, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
636
769
  };
637
770
  /**
638
771
  * Upload a product document.
@@ -64,7 +64,7 @@ export interface DocxTemplateClass {
64
64
  */
65
65
  'entityType': string;
66
66
  /**
67
- * Name of the file the end user will see when they downloads it.
67
+ * Name of the file the end user will see when he downloads it.
68
68
  * @type {string}
69
69
  * @memberof DocxTemplateClass
70
70
  */
@@ -23,32 +23,32 @@ export interface InlineResponse200 {
23
23
  'status'?: string;
24
24
  /**
25
25
  *
26
- * @type {{ [key: string]: { [key: string]: string; }; }}
26
+ * @type {{ [key: string]: { [key: string]: object; }; }}
27
27
  * @memberof InlineResponse200
28
28
  */
29
29
  'info'?: {
30
30
  [key: string]: {
31
- [key: string]: string;
31
+ [key: string]: object;
32
32
  };
33
33
  } | null;
34
34
  /**
35
35
  *
36
- * @type {{ [key: string]: { [key: string]: string; }; }}
36
+ * @type {{ [key: string]: { [key: string]: object; }; }}
37
37
  * @memberof InlineResponse200
38
38
  */
39
39
  'error'?: {
40
40
  [key: string]: {
41
- [key: string]: string;
41
+ [key: string]: object;
42
42
  };
43
43
  } | null;
44
44
  /**
45
45
  *
46
- * @type {{ [key: string]: { [key: string]: string; }; }}
46
+ * @type {{ [key: string]: { [key: string]: object; }; }}
47
47
  * @memberof InlineResponse200
48
48
  */
49
49
  'details'?: {
50
50
  [key: string]: {
51
- [key: string]: string;
51
+ [key: string]: object;
52
52
  };
53
53
  };
54
54
  }
@@ -23,32 +23,32 @@ export interface InlineResponse503 {
23
23
  'status'?: string;
24
24
  /**
25
25
  *
26
- * @type {{ [key: string]: { [key: string]: string; }; }}
26
+ * @type {{ [key: string]: { [key: string]: object; }; }}
27
27
  * @memberof InlineResponse503
28
28
  */
29
29
  'info'?: {
30
30
  [key: string]: {
31
- [key: string]: string;
31
+ [key: string]: object;
32
32
  };
33
33
  } | null;
34
34
  /**
35
35
  *
36
- * @type {{ [key: string]: { [key: string]: string; }; }}
36
+ * @type {{ [key: string]: { [key: string]: object; }; }}
37
37
  * @memberof InlineResponse503
38
38
  */
39
39
  'error'?: {
40
40
  [key: string]: {
41
- [key: string]: string;
41
+ [key: string]: object;
42
42
  };
43
43
  } | null;
44
44
  /**
45
45
  *
46
- * @type {{ [key: string]: { [key: string]: string; }; }}
46
+ * @type {{ [key: string]: { [key: string]: object; }; }}
47
47
  * @memberof InlineResponse503
48
48
  */
49
49
  'details'?: {
50
50
  [key: string]: {
51
- [key: string]: string;
51
+ [key: string]: object;
52
52
  };
53
53
  };
54
54
  }
@@ -76,7 +76,7 @@ export interface ProductDocumentClass {
76
76
  */
77
77
  'entityType': string;
78
78
  /**
79
- * Name of the file the end user will see when they downloads it.
79
+ * The file name the end user will see when downloading it.
80
80
  * @type {string}
81
81
  * @memberof ProductDocumentClass
82
82
  */
@@ -69,7 +69,7 @@ export interface DocxTemplateClass {
69
69
  */
70
70
  'entityType': string;
71
71
  /**
72
- * Name of the file the end user will see when they downloads it.
72
+ * Name of the file the end user will see when he downloads it.
73
73
  * @type {string}
74
74
  * @memberof DocxTemplateClass
75
75
  */
@@ -28,21 +28,21 @@ export interface InlineResponse200 {
28
28
  'status'?: string;
29
29
  /**
30
30
  *
31
- * @type {{ [key: string]: { [key: string]: string; }; }}
31
+ * @type {{ [key: string]: { [key: string]: object; }; }}
32
32
  * @memberof InlineResponse200
33
33
  */
34
- 'info'?: { [key: string]: { [key: string]: string; }; } | null;
34
+ 'info'?: { [key: string]: { [key: string]: object; }; } | null;
35
35
  /**
36
36
  *
37
- * @type {{ [key: string]: { [key: string]: string; }; }}
37
+ * @type {{ [key: string]: { [key: string]: object; }; }}
38
38
  * @memberof InlineResponse200
39
39
  */
40
- 'error'?: { [key: string]: { [key: string]: string; }; } | null;
40
+ 'error'?: { [key: string]: { [key: string]: object; }; } | null;
41
41
  /**
42
42
  *
43
- * @type {{ [key: string]: { [key: string]: string; }; }}
43
+ * @type {{ [key: string]: { [key: string]: object; }; }}
44
44
  * @memberof InlineResponse200
45
45
  */
46
- 'details'?: { [key: string]: { [key: string]: string; }; };
46
+ 'details'?: { [key: string]: { [key: string]: object; }; };
47
47
  }
48
48
 
@@ -28,21 +28,21 @@ export interface InlineResponse503 {
28
28
  'status'?: string;
29
29
  /**
30
30
  *
31
- * @type {{ [key: string]: { [key: string]: string; }; }}
31
+ * @type {{ [key: string]: { [key: string]: object; }; }}
32
32
  * @memberof InlineResponse503
33
33
  */
34
- 'info'?: { [key: string]: { [key: string]: string; }; } | null;
34
+ 'info'?: { [key: string]: { [key: string]: object; }; } | null;
35
35
  /**
36
36
  *
37
- * @type {{ [key: string]: { [key: string]: string; }; }}
37
+ * @type {{ [key: string]: { [key: string]: object; }; }}
38
38
  * @memberof InlineResponse503
39
39
  */
40
- 'error'?: { [key: string]: { [key: string]: string; }; } | null;
40
+ 'error'?: { [key: string]: { [key: string]: object; }; } | null;
41
41
  /**
42
42
  *
43
- * @type {{ [key: string]: { [key: string]: string; }; }}
43
+ * @type {{ [key: string]: { [key: string]: object; }; }}
44
44
  * @memberof InlineResponse503
45
45
  */
46
- 'details'?: { [key: string]: { [key: string]: string; }; };
46
+ 'details'?: { [key: string]: { [key: string]: object; }; };
47
47
  }
48
48
 
@@ -81,7 +81,7 @@ export interface ProductDocumentClass {
81
81
  */
82
82
  'entityType': string;
83
83
  /**
84
- * Name of the file the end user will see when they downloads it.
84
+ * The file name the end user will see when downloading it.
85
85
  * @type {string}
86
86
  * @memberof ProductDocumentClass
87
87
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/document-sdk-node",
3
- "version": "1.16.0",
3
+ "version": "1.20.0",
4
4
  "description": "OpenAPI client for @emilgroup/document-sdk-node",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [