@emilgroup/document-sdk-node 1.4.2 → 1.6.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.
@@ -36,8 +36,11 @@ models/get-doc-template-response-class.ts
36
36
  models/get-document-download-url-response-class.ts
37
37
  models/get-layout-request-dto.ts
38
38
  models/get-layout-response-class.ts
39
+ models/get-product-document-download-url-response-class.ts
39
40
  models/get-product-document-response-class.ts
40
41
  models/get-signed-s3-key-url-response-class.ts
42
+ models/grpc-create-doc-template-request-dto.ts
43
+ models/grpc-update-doc-template-request-dto.ts
41
44
  models/html-template-class.ts
42
45
  models/index.ts
43
46
  models/layout-class.ts
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/document-sdk-node@1.4.2 --save
20
+ npm install @emilgroup/document-sdk-node@1.6.0 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/document-sdk-node@1.4.2
24
+ yarn add @emilgroup/document-sdk-node@1.6.0
25
25
  ```
26
26
 
27
27
  And then you can import `DocumentsApi`.
@@ -141,7 +141,7 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
141
141
  * @summary Retrieve the document template
142
142
  * @param {number} id
143
143
  * @param {string} [authorization] Bearer Token
144
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
144
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
145
145
  * @param {*} [options] Override http request option.
146
146
  * @throws {RequiredError}
147
147
  */
@@ -191,7 +191,7 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
191
191
  * @summary List document templates
192
192
  * @param {string} [authorization] Bearer Token
193
193
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
194
- * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
194
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
195
195
  * @param {string} [filter] Filter response by productSlug, slug and name.
196
196
  * @param {string} [search] Search document templates by name | slug
197
197
  * @param {string} [order] Order response by createdAt.
@@ -347,7 +347,7 @@ export const DocumentTemplatesApiFp = function(configuration?: Configuration) {
347
347
  * @summary Retrieve the document template
348
348
  * @param {number} id
349
349
  * @param {string} [authorization] Bearer Token
350
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
350
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
351
351
  * @param {*} [options] Override http request option.
352
352
  * @throws {RequiredError}
353
353
  */
@@ -360,7 +360,7 @@ export const DocumentTemplatesApiFp = function(configuration?: Configuration) {
360
360
  * @summary List document templates
361
361
  * @param {string} [authorization] Bearer Token
362
362
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
363
- * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
363
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
364
364
  * @param {string} [filter] Filter response by productSlug, slug and name.
365
365
  * @param {string} [search] Search document templates by name | slug
366
366
  * @param {string} [order] Order response by createdAt.
@@ -422,7 +422,7 @@ export const DocumentTemplatesApiFactory = function (configuration?: Configurati
422
422
  * @summary Retrieve the document template
423
423
  * @param {number} id
424
424
  * @param {string} [authorization] Bearer Token
425
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
425
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
426
426
  * @param {*} [options] Override http request option.
427
427
  * @throws {RequiredError}
428
428
  */
@@ -434,7 +434,7 @@ export const DocumentTemplatesApiFactory = function (configuration?: Configurati
434
434
  * @summary List document templates
435
435
  * @param {string} [authorization] Bearer Token
436
436
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
437
- * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
437
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
438
438
  * @param {string} [filter] Filter response by productSlug, slug and name.
439
439
  * @param {string} [search] Search document templates by name | slug
440
440
  * @param {string} [order] Order response by createdAt.
@@ -523,7 +523,7 @@ export interface DocumentTemplatesApiGetDocTemplateRequest {
523
523
  readonly authorization?: string
524
524
 
525
525
  /**
526
- * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
526
+ * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
527
527
  * @type {string}
528
528
  * @memberof DocumentTemplatesApiGetDocTemplate
529
529
  */
@@ -551,7 +551,7 @@ export interface DocumentTemplatesApiListDocTemplatesRequest {
551
551
  readonly pageSize?: number
552
552
 
553
553
  /**
554
- * A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
554
+ * A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
555
555
  * @type {string}
556
556
  * @memberof DocumentTemplatesApiListDocTemplates
557
557
  */
@@ -21,6 +21,8 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
21
21
  // @ts-ignore
22
22
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
23
  // @ts-ignore
24
+ import { GetProductDocumentDownloadUrlResponseClass } from '../models';
25
+ // @ts-ignore
24
26
  import { GetProductDocumentResponseClass } from '../models';
25
27
  // @ts-ignore
26
28
  import { ListProductDocumentsResponseClass } from '../models';
@@ -78,6 +80,55 @@ export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Co
78
80
 
79
81
 
80
82
 
83
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
84
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
85
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
86
+
87
+ return {
88
+ url: toPathString(localVarUrlObj),
89
+ options: localVarRequestOptions,
90
+ };
91
+ },
92
+ /**
93
+ * Get a pre-signed download url for the given product document.
94
+ * @summary Get pre-signed url for downloading product document
95
+ * @param {string} productSlug
96
+ * @param {string} code
97
+ * @param {string} [authorization] Bearer Token
98
+ * @param {*} [options] Override http request option.
99
+ * @throws {RequiredError}
100
+ */
101
+ downloadProductDocument: async (productSlug: string, code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
102
+ // verify required parameter 'productSlug' is not null or undefined
103
+ assertParamExists('downloadProductDocument', 'productSlug', productSlug)
104
+ // verify required parameter 'code' is not null or undefined
105
+ assertParamExists('downloadProductDocument', 'code', code)
106
+ const localVarPath = `/documentservice/v1/documents/product/{productSlug}/{code}/download-url`
107
+ .replace(`{${"productSlug"}}`, encodeURIComponent(String(productSlug)))
108
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
109
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
110
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
111
+ let baseOptions;
112
+ let baseAccessToken;
113
+ if (configuration) {
114
+ baseOptions = configuration.baseOptions;
115
+ baseAccessToken = configuration.accessToken;
116
+ }
117
+
118
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
119
+ const localVarHeaderParameter = {} as any;
120
+ const localVarQueryParameter = {} as any;
121
+
122
+ // authentication bearer required
123
+ // http bearer authentication required
124
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
125
+
126
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
127
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
128
+ }
129
+
130
+
131
+
81
132
  setSearchParams(localVarUrlObj, localVarQueryParameter);
82
133
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
83
134
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -285,6 +336,19 @@ export const ProductDocumentsApiFp = function(configuration?: Configuration) {
285
336
  const localVarAxiosArgs = await localVarAxiosParamCreator.deleteProductDocument(code, productSlug, authorization, options);
286
337
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
287
338
  },
339
+ /**
340
+ * Get a pre-signed download url for the given product document.
341
+ * @summary Get pre-signed url for downloading product document
342
+ * @param {string} productSlug
343
+ * @param {string} code
344
+ * @param {string} [authorization] Bearer Token
345
+ * @param {*} [options] Override http request option.
346
+ * @throws {RequiredError}
347
+ */
348
+ async downloadProductDocument(productSlug: string, code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductDocumentDownloadUrlResponseClass>> {
349
+ const localVarAxiosArgs = await localVarAxiosParamCreator.downloadProductDocument(productSlug, code, authorization, options);
350
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
351
+ },
288
352
  /**
289
353
  * Get a product document.
290
354
  * @summary Retrieve the product document
@@ -351,6 +415,18 @@ export const ProductDocumentsApiFactory = function (configuration?: Configuratio
351
415
  deleteProductDocument(code: string, productSlug: string, authorization?: string, options?: any): AxiosPromise<object> {
352
416
  return localVarFp.deleteProductDocument(code, productSlug, authorization, options).then((request) => request(axios, basePath));
353
417
  },
418
+ /**
419
+ * Get a pre-signed download url for the given product document.
420
+ * @summary Get pre-signed url for downloading product document
421
+ * @param {string} productSlug
422
+ * @param {string} code
423
+ * @param {string} [authorization] Bearer Token
424
+ * @param {*} [options] Override http request option.
425
+ * @throws {RequiredError}
426
+ */
427
+ downloadProductDocument(productSlug: string, code: string, authorization?: string, options?: any): AxiosPromise<GetProductDocumentDownloadUrlResponseClass> {
428
+ return localVarFp.downloadProductDocument(productSlug, code, authorization, options).then((request) => request(axios, basePath));
429
+ },
354
430
  /**
355
431
  * Get a product document.
356
432
  * @summary Retrieve the product document
@@ -423,6 +499,34 @@ export interface ProductDocumentsApiDeleteProductDocumentRequest {
423
499
  readonly authorization?: string
424
500
  }
425
501
 
502
+ /**
503
+ * Request parameters for downloadProductDocument operation in ProductDocumentsApi.
504
+ * @export
505
+ * @interface ProductDocumentsApiDownloadProductDocumentRequest
506
+ */
507
+ export interface ProductDocumentsApiDownloadProductDocumentRequest {
508
+ /**
509
+ *
510
+ * @type {string}
511
+ * @memberof ProductDocumentsApiDownloadProductDocument
512
+ */
513
+ readonly productSlug: string
514
+
515
+ /**
516
+ *
517
+ * @type {string}
518
+ * @memberof ProductDocumentsApiDownloadProductDocument
519
+ */
520
+ readonly code: string
521
+
522
+ /**
523
+ * Bearer Token
524
+ * @type {string}
525
+ * @memberof ProductDocumentsApiDownloadProductDocument
526
+ */
527
+ readonly authorization?: string
528
+ }
529
+
426
530
  /**
427
531
  * Request parameters for getProductDocument operation in ProductDocumentsApi.
428
532
  * @export
@@ -561,6 +665,18 @@ export class ProductDocumentsApi extends BaseAPI {
561
665
  return ProductDocumentsApiFp(this.configuration).deleteProductDocument(requestParameters.code, requestParameters.productSlug, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
562
666
  }
563
667
 
668
+ /**
669
+ * Get a pre-signed download url for the given product document.
670
+ * @summary Get pre-signed url for downloading product document
671
+ * @param {ProductDocumentsApiDownloadProductDocumentRequest} requestParameters Request parameters.
672
+ * @param {*} [options] Override http request option.
673
+ * @throws {RequiredError}
674
+ * @memberof ProductDocumentsApi
675
+ */
676
+ public downloadProductDocument(requestParameters: ProductDocumentsApiDownloadProductDocumentRequest, options?: AxiosRequestConfig) {
677
+ return ProductDocumentsApiFp(this.configuration).downloadProductDocument(requestParameters.productSlug, requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
678
+ }
679
+
564
680
  /**
565
681
  * Get a product document.
566
682
  * @summary Retrieve the product document
@@ -47,7 +47,7 @@ export declare const DocumentTemplatesApiAxiosParamCreator: (configuration?: Con
47
47
  * @summary Retrieve the document template
48
48
  * @param {number} id
49
49
  * @param {string} [authorization] Bearer Token
50
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
50
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
51
51
  * @param {*} [options] Override http request option.
52
52
  * @throws {RequiredError}
53
53
  */
@@ -57,7 +57,7 @@ export declare const DocumentTemplatesApiAxiosParamCreator: (configuration?: Con
57
57
  * @summary List document templates
58
58
  * @param {string} [authorization] Bearer Token
59
59
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
60
- * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
60
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
61
61
  * @param {string} [filter] Filter response by productSlug, slug and name.
62
62
  * @param {string} [search] Search document templates by name | slug
63
63
  * @param {string} [order] Order response by createdAt.
@@ -105,7 +105,7 @@ export declare const DocumentTemplatesApiFp: (configuration?: Configuration) =>
105
105
  * @summary Retrieve the document template
106
106
  * @param {number} id
107
107
  * @param {string} [authorization] Bearer Token
108
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
108
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
109
109
  * @param {*} [options] Override http request option.
110
110
  * @throws {RequiredError}
111
111
  */
@@ -115,7 +115,7 @@ export declare const DocumentTemplatesApiFp: (configuration?: Configuration) =>
115
115
  * @summary List document templates
116
116
  * @param {string} [authorization] Bearer Token
117
117
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
118
- * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
118
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
119
119
  * @param {string} [filter] Filter response by productSlug, slug and name.
120
120
  * @param {string} [search] Search document templates by name | slug
121
121
  * @param {string} [order] Order response by createdAt.
@@ -163,7 +163,7 @@ export declare const DocumentTemplatesApiFactory: (configuration?: Configuration
163
163
  * @summary Retrieve the document template
164
164
  * @param {number} id
165
165
  * @param {string} [authorization] Bearer Token
166
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
166
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
167
167
  * @param {*} [options] Override http request option.
168
168
  * @throws {RequiredError}
169
169
  */
@@ -173,7 +173,7 @@ export declare const DocumentTemplatesApiFactory: (configuration?: Configuration
173
173
  * @summary List document templates
174
174
  * @param {string} [authorization] Bearer Token
175
175
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
176
- * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
176
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
177
177
  * @param {string} [filter] Filter response by productSlug, slug and name.
178
178
  * @param {string} [search] Search document templates by name | slug
179
179
  * @param {string} [order] Order response by createdAt.
@@ -250,7 +250,7 @@ export interface DocumentTemplatesApiGetDocTemplateRequest {
250
250
  */
251
251
  readonly authorization?: string;
252
252
  /**
253
- * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
253
+ * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
254
254
  * @type {string}
255
255
  * @memberof DocumentTemplatesApiGetDocTemplate
256
256
  */
@@ -275,7 +275,7 @@ export interface DocumentTemplatesApiListDocTemplatesRequest {
275
275
  */
276
276
  readonly pageSize?: number;
277
277
  /**
278
- * A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
278
+ * A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
279
279
  * @type {string}
280
280
  * @memberof DocumentTemplatesApiListDocTemplates
281
281
  */
@@ -198,7 +198,7 @@ var DocumentTemplatesApiAxiosParamCreator = function (configuration) {
198
198
  * @summary Retrieve the document template
199
199
  * @param {number} id
200
200
  * @param {string} [authorization] Bearer Token
201
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
201
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
202
202
  * @param {*} [options] Override http request option.
203
203
  * @throws {RequiredError}
204
204
  */
@@ -250,7 +250,7 @@ var DocumentTemplatesApiAxiosParamCreator = function (configuration) {
250
250
  * @summary List document templates
251
251
  * @param {string} [authorization] Bearer Token
252
252
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
253
- * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
253
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
254
254
  * @param {string} [filter] Filter response by productSlug, slug and name.
255
255
  * @param {string} [search] Search document templates by name | slug
256
256
  * @param {string} [order] Order response by createdAt.
@@ -423,7 +423,7 @@ var DocumentTemplatesApiFp = function (configuration) {
423
423
  * @summary Retrieve the document template
424
424
  * @param {number} id
425
425
  * @param {string} [authorization] Bearer Token
426
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
426
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
427
427
  * @param {*} [options] Override http request option.
428
428
  * @throws {RequiredError}
429
429
  */
@@ -445,7 +445,7 @@ var DocumentTemplatesApiFp = function (configuration) {
445
445
  * @summary List document templates
446
446
  * @param {string} [authorization] Bearer Token
447
447
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
448
- * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
448
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
449
449
  * @param {string} [filter] Filter response by productSlug, slug and name.
450
450
  * @param {string} [search] Search document templates by name | slug
451
451
  * @param {string} [order] Order response by createdAt.
@@ -525,7 +525,7 @@ var DocumentTemplatesApiFactory = function (configuration, basePath, axios) {
525
525
  * @summary Retrieve the document template
526
526
  * @param {number} id
527
527
  * @param {string} [authorization] Bearer Token
528
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
528
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
529
529
  * @param {*} [options] Override http request option.
530
530
  * @throws {RequiredError}
531
531
  */
@@ -537,7 +537,7 @@ var DocumentTemplatesApiFactory = function (configuration, basePath, axios) {
537
537
  * @summary List document templates
538
538
  * @param {string} [authorization] Bearer Token
539
539
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
540
- * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
540
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
541
541
  * @param {string} [filter] Filter response by productSlug, slug and name.
542
542
  * @param {string} [search] Search document templates by name | slug
543
543
  * @param {string} [order] Order response by createdAt.
@@ -12,6 +12,7 @@
12
12
  import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
13
  import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
+ import { GetProductDocumentDownloadUrlResponseClass } from '../models';
15
16
  import { GetProductDocumentResponseClass } from '../models';
16
17
  import { ListProductDocumentsResponseClass } from '../models';
17
18
  import { ProductDocumentClass } from '../models';
@@ -31,6 +32,16 @@ export declare const ProductDocumentsApiAxiosParamCreator: (configuration?: Conf
31
32
  * @throws {RequiredError}
32
33
  */
33
34
  deleteProductDocument: (code: string, productSlug: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
35
+ /**
36
+ * Get a pre-signed download url for the given product document.
37
+ * @summary Get pre-signed url for downloading product document
38
+ * @param {string} productSlug
39
+ * @param {string} code
40
+ * @param {string} [authorization] Bearer Token
41
+ * @param {*} [options] Override http request option.
42
+ * @throws {RequiredError}
43
+ */
44
+ downloadProductDocument: (productSlug: string, code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
34
45
  /**
35
46
  * Get a product document.
36
47
  * @summary Retrieve the product document
@@ -82,6 +93,16 @@ export declare const ProductDocumentsApiFp: (configuration?: Configuration) => {
82
93
  * @throws {RequiredError}
83
94
  */
84
95
  deleteProductDocument(code: string, productSlug: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
96
+ /**
97
+ * Get a pre-signed download url for the given product document.
98
+ * @summary Get pre-signed url for downloading product document
99
+ * @param {string} productSlug
100
+ * @param {string} code
101
+ * @param {string} [authorization] Bearer Token
102
+ * @param {*} [options] Override http request option.
103
+ * @throws {RequiredError}
104
+ */
105
+ downloadProductDocument(productSlug: string, code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductDocumentDownloadUrlResponseClass>>;
85
106
  /**
86
107
  * Get a product document.
87
108
  * @summary Retrieve the product document
@@ -133,6 +154,16 @@ export declare const ProductDocumentsApiFactory: (configuration?: Configuration,
133
154
  * @throws {RequiredError}
134
155
  */
135
156
  deleteProductDocument(code: string, productSlug: string, authorization?: string, options?: any): AxiosPromise<object>;
157
+ /**
158
+ * Get a pre-signed download url for the given product document.
159
+ * @summary Get pre-signed url for downloading product document
160
+ * @param {string} productSlug
161
+ * @param {string} code
162
+ * @param {string} [authorization] Bearer Token
163
+ * @param {*} [options] Override http request option.
164
+ * @throws {RequiredError}
165
+ */
166
+ downloadProductDocument(productSlug: string, code: string, authorization?: string, options?: any): AxiosPromise<GetProductDocumentDownloadUrlResponseClass>;
136
167
  /**
137
168
  * Get a product document.
138
169
  * @summary Retrieve the product document
@@ -194,6 +225,31 @@ export interface ProductDocumentsApiDeleteProductDocumentRequest {
194
225
  */
195
226
  readonly authorization?: string;
196
227
  }
228
+ /**
229
+ * Request parameters for downloadProductDocument operation in ProductDocumentsApi.
230
+ * @export
231
+ * @interface ProductDocumentsApiDownloadProductDocumentRequest
232
+ */
233
+ export interface ProductDocumentsApiDownloadProductDocumentRequest {
234
+ /**
235
+ *
236
+ * @type {string}
237
+ * @memberof ProductDocumentsApiDownloadProductDocument
238
+ */
239
+ readonly productSlug: string;
240
+ /**
241
+ *
242
+ * @type {string}
243
+ * @memberof ProductDocumentsApiDownloadProductDocument
244
+ */
245
+ readonly code: string;
246
+ /**
247
+ * Bearer Token
248
+ * @type {string}
249
+ * @memberof ProductDocumentsApiDownloadProductDocument
250
+ */
251
+ readonly authorization?: string;
252
+ }
197
253
  /**
198
254
  * Request parameters for getProductDocument operation in ProductDocumentsApi.
199
255
  * @export
@@ -315,6 +371,15 @@ export declare class ProductDocumentsApi extends BaseAPI {
315
371
  * @memberof ProductDocumentsApi
316
372
  */
317
373
  deleteProductDocument(requestParameters: ProductDocumentsApiDeleteProductDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
374
+ /**
375
+ * Get a pre-signed download url for the given product document.
376
+ * @summary Get pre-signed url for downloading product document
377
+ * @param {ProductDocumentsApiDownloadProductDocumentRequest} requestParameters Request parameters.
378
+ * @param {*} [options] Override http request option.
379
+ * @throws {RequiredError}
380
+ * @memberof ProductDocumentsApi
381
+ */
382
+ downloadProductDocument(requestParameters: ProductDocumentsApiDownloadProductDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetProductDocumentDownloadUrlResponseClass, any>>;
318
383
  /**
319
384
  * Get a product document.
320
385
  * @summary Retrieve the product document
@@ -148,6 +148,58 @@ var ProductDocumentsApiAxiosParamCreator = function (configuration) {
148
148
  });
149
149
  });
150
150
  },
151
+ /**
152
+ * Get a pre-signed download url for the given product document.
153
+ * @summary Get pre-signed url for downloading product document
154
+ * @param {string} productSlug
155
+ * @param {string} code
156
+ * @param {string} [authorization] Bearer Token
157
+ * @param {*} [options] Override http request option.
158
+ * @throws {RequiredError}
159
+ */
160
+ downloadProductDocument: function (productSlug, code, authorization, options) {
161
+ if (options === void 0) { options = {}; }
162
+ return __awaiter(_this, void 0, void 0, function () {
163
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
164
+ return __generator(this, function (_a) {
165
+ switch (_a.label) {
166
+ case 0:
167
+ // verify required parameter 'productSlug' is not null or undefined
168
+ (0, common_1.assertParamExists)('downloadProductDocument', 'productSlug', productSlug);
169
+ // verify required parameter 'code' is not null or undefined
170
+ (0, common_1.assertParamExists)('downloadProductDocument', 'code', code);
171
+ localVarPath = "/documentservice/v1/documents/product/{productSlug}/{code}/download-url"
172
+ .replace("{".concat("productSlug", "}"), encodeURIComponent(String(productSlug)))
173
+ .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
174
+ localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
175
+ if (configuration) {
176
+ baseOptions = configuration.baseOptions;
177
+ baseAccessToken = configuration.accessToken;
178
+ }
179
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
180
+ localVarHeaderParameter = {};
181
+ localVarQueryParameter = {};
182
+ // authentication bearer required
183
+ // http bearer authentication required
184
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
185
+ case 1:
186
+ // authentication bearer required
187
+ // http bearer authentication required
188
+ _a.sent();
189
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
190
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
191
+ }
192
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
193
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
194
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
195
+ return [2 /*return*/, {
196
+ url: (0, common_1.toPathString)(localVarUrlObj),
197
+ options: localVarRequestOptions,
198
+ }];
199
+ }
200
+ });
201
+ });
202
+ },
151
203
  /**
152
204
  * Get a product document.
153
205
  * @summary Retrieve the product document
@@ -357,6 +409,28 @@ var ProductDocumentsApiFp = function (configuration) {
357
409
  });
358
410
  });
359
411
  },
412
+ /**
413
+ * Get a pre-signed download url for the given product document.
414
+ * @summary Get pre-signed url for downloading product document
415
+ * @param {string} productSlug
416
+ * @param {string} code
417
+ * @param {string} [authorization] Bearer Token
418
+ * @param {*} [options] Override http request option.
419
+ * @throws {RequiredError}
420
+ */
421
+ downloadProductDocument: function (productSlug, code, authorization, options) {
422
+ return __awaiter(this, void 0, void 0, function () {
423
+ var localVarAxiosArgs;
424
+ return __generator(this, function (_a) {
425
+ switch (_a.label) {
426
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.downloadProductDocument(productSlug, code, authorization, options)];
427
+ case 1:
428
+ localVarAxiosArgs = _a.sent();
429
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
430
+ }
431
+ });
432
+ });
433
+ },
360
434
  /**
361
435
  * Get a product document.
362
436
  * @summary Retrieve the product document
@@ -450,6 +524,18 @@ var ProductDocumentsApiFactory = function (configuration, basePath, axios) {
450
524
  deleteProductDocument: function (code, productSlug, authorization, options) {
451
525
  return localVarFp.deleteProductDocument(code, productSlug, authorization, options).then(function (request) { return request(axios, basePath); });
452
526
  },
527
+ /**
528
+ * Get a pre-signed download url for the given product document.
529
+ * @summary Get pre-signed url for downloading product document
530
+ * @param {string} productSlug
531
+ * @param {string} code
532
+ * @param {string} [authorization] Bearer Token
533
+ * @param {*} [options] Override http request option.
534
+ * @throws {RequiredError}
535
+ */
536
+ downloadProductDocument: function (productSlug, code, authorization, options) {
537
+ return localVarFp.downloadProductDocument(productSlug, code, authorization, options).then(function (request) { return request(axios, basePath); });
538
+ },
453
539
  /**
454
540
  * Get a product document.
455
541
  * @summary Retrieve the product document
@@ -517,6 +603,18 @@ var ProductDocumentsApi = /** @class */ (function (_super) {
517
603
  var _this = this;
518
604
  return (0, exports.ProductDocumentsApiFp)(this.configuration).deleteProductDocument(requestParameters.code, requestParameters.productSlug, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
519
605
  };
606
+ /**
607
+ * Get a pre-signed download url for the given product document.
608
+ * @summary Get pre-signed url for downloading product document
609
+ * @param {ProductDocumentsApiDownloadProductDocumentRequest} requestParameters Request parameters.
610
+ * @param {*} [options] Override http request option.
611
+ * @throws {RequiredError}
612
+ * @memberof ProductDocumentsApi
613
+ */
614
+ ProductDocumentsApi.prototype.downloadProductDocument = function (requestParameters, options) {
615
+ var _this = this;
616
+ return (0, exports.ProductDocumentsApiFp)(this.configuration).downloadProductDocument(requestParameters.productSlug, requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
617
+ };
520
618
  /**
521
619
  * Get a product document.
522
620
  * @summary Retrieve the product document
@@ -46,4 +46,10 @@ export interface CreateDocTemplateRequestDto {
46
46
  * @memberof CreateDocTemplateRequestDto
47
47
  */
48
48
  'productSlug'?: string;
49
+ /**
50
+ * The filename of the document template as it appears when sent to customers.
51
+ * @type {string}
52
+ * @memberof CreateDocTemplateRequestDto
53
+ */
54
+ 'label'?: string;
49
55
  }
@@ -41,6 +41,12 @@ export interface DocTemplateClass {
41
41
  * @memberof DocTemplateClass
42
42
  */
43
43
  'slug': string;
44
+ /**
45
+ * The filename of the document template as it appears when sent to customers.
46
+ * @type {string}
47
+ * @memberof DocTemplateClass
48
+ */
49
+ 'label'?: string;
44
50
  /**
45
51
  * Unique identifier referencing the layout.
46
52
  * @type {number}
@@ -0,0 +1,24 @@
1
+ /**
2
+ * EMIL DocumentService
3
+ * The EMIL DocumentService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface GetProductDocumentDownloadUrlResponseClass
16
+ */
17
+ export interface GetProductDocumentDownloadUrlResponseClass {
18
+ /**
19
+ * Pre-signed url for downloading product documents.
20
+ * @type {string}
21
+ * @memberof GetProductDocumentDownloadUrlResponseClass
22
+ */
23
+ 'url': string;
24
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * EMIL DocumentService
6
+ * The EMIL DocumentService API description
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,55 @@
1
+ /**
2
+ * EMIL DocumentService
3
+ * The EMIL DocumentService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { CreateHtmlTemplateDto } from './create-html-template-dto';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface GrpcCreateDocTemplateRequestDto
17
+ */
18
+ export interface GrpcCreateDocTemplateRequestDto {
19
+ /**
20
+ *
21
+ * @type {string}
22
+ * @memberof GrpcCreateDocTemplateRequestDto
23
+ */
24
+ 'name': string;
25
+ /**
26
+ *
27
+ * @type {string}
28
+ * @memberof GrpcCreateDocTemplateRequestDto
29
+ */
30
+ 'slug': string;
31
+ /**
32
+ *
33
+ * @type {number}
34
+ * @memberof GrpcCreateDocTemplateRequestDto
35
+ */
36
+ 'layoutId': number;
37
+ /**
38
+ *
39
+ * @type {CreateHtmlTemplateDto}
40
+ * @memberof GrpcCreateDocTemplateRequestDto
41
+ */
42
+ 'bodyTemplate': CreateHtmlTemplateDto;
43
+ /**
44
+ *
45
+ * @type {string}
46
+ * @memberof GrpcCreateDocTemplateRequestDto
47
+ */
48
+ 'productSlug'?: string;
49
+ /**
50
+ *
51
+ * @type {string}
52
+ * @memberof GrpcCreateDocTemplateRequestDto
53
+ */
54
+ 'label'?: string;
55
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * EMIL DocumentService
6
+ * The EMIL DocumentService API description
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,61 @@
1
+ /**
2
+ * EMIL DocumentService
3
+ * The EMIL DocumentService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { CreateHtmlTemplateDto } from './create-html-template-dto';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface GrpcUpdateDocTemplateRequestDto
17
+ */
18
+ export interface GrpcUpdateDocTemplateRequestDto {
19
+ /**
20
+ *
21
+ * @type {string}
22
+ * @memberof GrpcUpdateDocTemplateRequestDto
23
+ */
24
+ 'name': string;
25
+ /**
26
+ *
27
+ * @type {string}
28
+ * @memberof GrpcUpdateDocTemplateRequestDto
29
+ */
30
+ 'slug': string;
31
+ /**
32
+ *
33
+ * @type {number}
34
+ * @memberof GrpcUpdateDocTemplateRequestDto
35
+ */
36
+ 'layoutId': number;
37
+ /**
38
+ *
39
+ * @type {CreateHtmlTemplateDto}
40
+ * @memberof GrpcUpdateDocTemplateRequestDto
41
+ */
42
+ 'bodyTemplate': CreateHtmlTemplateDto;
43
+ /**
44
+ *
45
+ * @type {string}
46
+ * @memberof GrpcUpdateDocTemplateRequestDto
47
+ */
48
+ 'productSlug'?: string;
49
+ /**
50
+ *
51
+ * @type {string}
52
+ * @memberof GrpcUpdateDocTemplateRequestDto
53
+ */
54
+ 'label'?: string;
55
+ /**
56
+ *
57
+ * @type {number}
58
+ * @memberof GrpcUpdateDocTemplateRequestDto
59
+ */
60
+ 'id': number;
61
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * EMIL DocumentService
6
+ * The EMIL DocumentService API description
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -19,8 +19,11 @@ export * from './get-doc-template-response-class';
19
19
  export * from './get-document-download-url-response-class';
20
20
  export * from './get-layout-request-dto';
21
21
  export * from './get-layout-response-class';
22
+ export * from './get-product-document-download-url-response-class';
22
23
  export * from './get-product-document-response-class';
23
24
  export * from './get-signed-s3-key-url-response-class';
25
+ export * from './grpc-create-doc-template-request-dto';
26
+ export * from './grpc-update-doc-template-request-dto';
24
27
  export * from './html-template-class';
25
28
  export * from './layout-class';
26
29
  export * from './list-doc-template-request-dto';
@@ -35,8 +35,11 @@ __exportStar(require("./get-doc-template-response-class"), exports);
35
35
  __exportStar(require("./get-document-download-url-response-class"), exports);
36
36
  __exportStar(require("./get-layout-request-dto"), exports);
37
37
  __exportStar(require("./get-layout-response-class"), exports);
38
+ __exportStar(require("./get-product-document-download-url-response-class"), exports);
38
39
  __exportStar(require("./get-product-document-response-class"), exports);
39
40
  __exportStar(require("./get-signed-s3-key-url-response-class"), exports);
41
+ __exportStar(require("./grpc-create-doc-template-request-dto"), exports);
42
+ __exportStar(require("./grpc-update-doc-template-request-dto"), exports);
40
43
  __exportStar(require("./html-template-class"), exports);
41
44
  __exportStar(require("./layout-class"), exports);
42
45
  __exportStar(require("./list-doc-template-request-dto"), exports);
@@ -46,6 +46,12 @@ export interface UpdateDocTemplateRequestDto {
46
46
  * @memberof UpdateDocTemplateRequestDto
47
47
  */
48
48
  'productSlug'?: string;
49
+ /**
50
+ * The filename of the document template as it appears when sent to customers.
51
+ * @type {string}
52
+ * @memberof UpdateDocTemplateRequestDto
53
+ */
54
+ 'label'?: string;
49
55
  /**
50
56
  * Internal unique identifier for the object. You should not have to use this, use code instead.
51
57
  * @type {number}
@@ -51,5 +51,11 @@ export interface CreateDocTemplateRequestDto {
51
51
  * @memberof CreateDocTemplateRequestDto
52
52
  */
53
53
  'productSlug'?: string;
54
+ /**
55
+ * The filename of the document template as it appears when sent to customers.
56
+ * @type {string}
57
+ * @memberof CreateDocTemplateRequestDto
58
+ */
59
+ 'label'?: string;
54
60
  }
55
61
 
@@ -46,6 +46,12 @@ export interface DocTemplateClass {
46
46
  * @memberof DocTemplateClass
47
47
  */
48
48
  'slug': string;
49
+ /**
50
+ * The filename of the document template as it appears when sent to customers.
51
+ * @type {string}
52
+ * @memberof DocTemplateClass
53
+ */
54
+ 'label'?: string;
49
55
  /**
50
56
  * Unique identifier referencing the layout.
51
57
  * @type {number}
@@ -0,0 +1,30 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL DocumentService
5
+ * The EMIL DocumentService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface GetProductDocumentDownloadUrlResponseClass
21
+ */
22
+ export interface GetProductDocumentDownloadUrlResponseClass {
23
+ /**
24
+ * Pre-signed url for downloading product documents.
25
+ * @type {string}
26
+ * @memberof GetProductDocumentDownloadUrlResponseClass
27
+ */
28
+ 'url': string;
29
+ }
30
+
@@ -0,0 +1,61 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL DocumentService
5
+ * The EMIL DocumentService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import { CreateHtmlTemplateDto } from './create-html-template-dto';
17
+
18
+ /**
19
+ *
20
+ * @export
21
+ * @interface GrpcCreateDocTemplateRequestDto
22
+ */
23
+ export interface GrpcCreateDocTemplateRequestDto {
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof GrpcCreateDocTemplateRequestDto
28
+ */
29
+ 'name': string;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof GrpcCreateDocTemplateRequestDto
34
+ */
35
+ 'slug': string;
36
+ /**
37
+ *
38
+ * @type {number}
39
+ * @memberof GrpcCreateDocTemplateRequestDto
40
+ */
41
+ 'layoutId': number;
42
+ /**
43
+ *
44
+ * @type {CreateHtmlTemplateDto}
45
+ * @memberof GrpcCreateDocTemplateRequestDto
46
+ */
47
+ 'bodyTemplate': CreateHtmlTemplateDto;
48
+ /**
49
+ *
50
+ * @type {string}
51
+ * @memberof GrpcCreateDocTemplateRequestDto
52
+ */
53
+ 'productSlug'?: string;
54
+ /**
55
+ *
56
+ * @type {string}
57
+ * @memberof GrpcCreateDocTemplateRequestDto
58
+ */
59
+ 'label'?: string;
60
+ }
61
+
@@ -0,0 +1,67 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL DocumentService
5
+ * The EMIL DocumentService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import { CreateHtmlTemplateDto } from './create-html-template-dto';
17
+
18
+ /**
19
+ *
20
+ * @export
21
+ * @interface GrpcUpdateDocTemplateRequestDto
22
+ */
23
+ export interface GrpcUpdateDocTemplateRequestDto {
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof GrpcUpdateDocTemplateRequestDto
28
+ */
29
+ 'name': string;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof GrpcUpdateDocTemplateRequestDto
34
+ */
35
+ 'slug': string;
36
+ /**
37
+ *
38
+ * @type {number}
39
+ * @memberof GrpcUpdateDocTemplateRequestDto
40
+ */
41
+ 'layoutId': number;
42
+ /**
43
+ *
44
+ * @type {CreateHtmlTemplateDto}
45
+ * @memberof GrpcUpdateDocTemplateRequestDto
46
+ */
47
+ 'bodyTemplate': CreateHtmlTemplateDto;
48
+ /**
49
+ *
50
+ * @type {string}
51
+ * @memberof GrpcUpdateDocTemplateRequestDto
52
+ */
53
+ 'productSlug'?: string;
54
+ /**
55
+ *
56
+ * @type {string}
57
+ * @memberof GrpcUpdateDocTemplateRequestDto
58
+ */
59
+ 'label'?: string;
60
+ /**
61
+ *
62
+ * @type {number}
63
+ * @memberof GrpcUpdateDocTemplateRequestDto
64
+ */
65
+ 'id': number;
66
+ }
67
+
package/models/index.ts CHANGED
@@ -19,8 +19,11 @@ export * from './get-doc-template-response-class';
19
19
  export * from './get-document-download-url-response-class';
20
20
  export * from './get-layout-request-dto';
21
21
  export * from './get-layout-response-class';
22
+ export * from './get-product-document-download-url-response-class';
22
23
  export * from './get-product-document-response-class';
23
24
  export * from './get-signed-s3-key-url-response-class';
25
+ export * from './grpc-create-doc-template-request-dto';
26
+ export * from './grpc-update-doc-template-request-dto';
24
27
  export * from './html-template-class';
25
28
  export * from './layout-class';
26
29
  export * from './list-doc-template-request-dto';
@@ -51,6 +51,12 @@ export interface UpdateDocTemplateRequestDto {
51
51
  * @memberof UpdateDocTemplateRequestDto
52
52
  */
53
53
  'productSlug'?: string;
54
+ /**
55
+ * The filename of the document template as it appears when sent to customers.
56
+ * @type {string}
57
+ * @memberof UpdateDocTemplateRequestDto
58
+ */
59
+ 'label'?: string;
54
60
  /**
55
61
  * Internal unique identifier for the object. You should not have to use this, use code instead.
56
62
  * @type {number}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/document-sdk-node",
3
- "version": "1.4.2",
3
+ "version": "1.6.0",
4
4
  "description": "OpenAPI client for @emilgroup/document-sdk-node",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [
@@ -23,7 +23,7 @@
23
23
  "url": "^0.11.0"
24
24
  },
25
25
  "devDependencies": {
26
- "@types/node": "^12.11.5",
26
+ "@types/node": "^12.11.5",
27
27
  "typescript": "^4.0"
28
28
  }
29
29
  }