@emilgroup/document-sdk-node 1.2.0 → 1.2.1

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.
Files changed (123) hide show
  1. package/.openapi-generator/FILES +15 -0
  2. package/README.md +2 -2
  3. package/api/document-templates-api.ts +88 -94
  4. package/api/documents-api.ts +152 -34
  5. package/api/layouts-api.ts +52 -28
  6. package/api/search-keywords-api.ts +168 -0
  7. package/api/searchable-document-owners-api.ts +26 -22
  8. package/api/searchable-documents-api.ts +16 -12
  9. package/api.ts +2 -0
  10. package/base.ts +1 -1
  11. package/dist/api/document-templates-api.d.ts +82 -78
  12. package/dist/api/document-templates-api.js +73 -67
  13. package/dist/api/documents-api.d.ts +93 -29
  14. package/dist/api/documents-api.js +121 -23
  15. package/dist/api/layouts-api.d.ts +52 -30
  16. package/dist/api/layouts-api.js +43 -23
  17. package/dist/api/search-keywords-api.d.ts +96 -0
  18. package/dist/api/search-keywords-api.js +229 -0
  19. package/dist/api/searchable-document-owners-api.d.ts +23 -19
  20. package/dist/api/searchable-document-owners-api.js +16 -12
  21. package/dist/api/searchable-documents-api.d.ts +16 -12
  22. package/dist/api/searchable-documents-api.js +14 -10
  23. package/dist/api.d.ts +1 -0
  24. package/dist/api.js +1 -0
  25. package/dist/base.js +1 -1
  26. package/dist/models/create-doc-template-request-dto.d.ts +10 -4
  27. package/dist/models/create-doc-template-response-class.d.ts +25 -0
  28. package/dist/models/create-doc-template-response-class.js +15 -0
  29. package/dist/models/create-document-request-dto.d.ts +20 -8
  30. package/dist/models/create-document-sync-response-class.d.ts +25 -0
  31. package/dist/models/create-document-sync-response-class.js +15 -0
  32. package/dist/models/create-html-template-dto.d.ts +1 -1
  33. package/dist/models/create-layout-request-dto.d.ts +10 -10
  34. package/dist/models/create-layout-response-class.d.ts +25 -0
  35. package/dist/models/create-layout-response-class.js +15 -0
  36. package/dist/models/create-presigned-post-request-dto.d.ts +127 -0
  37. package/dist/models/create-presigned-post-request-dto.js +51 -0
  38. package/dist/models/create-presigned-post-response-class.d.ts +30 -0
  39. package/dist/models/create-presigned-post-response-class.js +15 -0
  40. package/dist/models/delete-layout-request-dto.d.ts +1 -1
  41. package/dist/models/delete-request-dto.d.ts +1 -1
  42. package/dist/models/delete-response-class.d.ts +24 -0
  43. package/dist/models/delete-response-class.js +15 -0
  44. package/dist/models/doc-template-class.d.ts +25 -19
  45. package/dist/models/document-class.d.ts +20 -8
  46. package/dist/models/download-document-request-dto.d.ts +2 -2
  47. package/dist/models/get-doc-template-request-dto.d.ts +1 -1
  48. package/dist/models/get-doc-template-response-class.d.ts +1 -1
  49. package/dist/models/get-document-download-url-response-class.d.ts +1 -1
  50. package/dist/models/get-layout-request-dto.d.ts +1 -1
  51. package/dist/models/get-signed-s3-key-url-response-class.d.ts +24 -0
  52. package/dist/models/get-signed-s3-key-url-response-class.js +15 -0
  53. package/dist/models/html-template-class.d.ts +7 -7
  54. package/dist/models/index.d.ts +14 -0
  55. package/dist/models/index.js +14 -0
  56. package/dist/models/layout-class.d.ts +11 -11
  57. package/dist/models/list-doc-template-request-dto.d.ts +48 -0
  58. package/dist/models/list-doc-template-request-dto.js +15 -0
  59. package/dist/models/list-doc-templates-response-class.d.ts +1 -1
  60. package/dist/models/list-documents-response-class.d.ts +1 -1
  61. package/dist/models/list-layouts-response-class.d.ts +1 -1
  62. package/dist/models/list-search-keywords-request-dto.d.ts +24 -0
  63. package/dist/models/list-search-keywords-request-dto.js +15 -0
  64. package/dist/models/list-search-keywords-response-class.d.ts +24 -0
  65. package/dist/models/list-search-keywords-response-class.js +15 -0
  66. package/dist/models/list-searchable-document-owners-response-class.d.ts +3 -2
  67. package/dist/models/list-searchable-documents-request-dto.d.ts +2 -2
  68. package/dist/models/list-searchable-documents-response-class.d.ts +5 -4
  69. package/dist/models/searchable-document-class.d.ts +66 -0
  70. package/dist/models/searchable-document-class.js +15 -0
  71. package/dist/models/searchable-document-owner-class.d.ts +30 -0
  72. package/dist/models/searchable-document-owner-class.js +15 -0
  73. package/dist/models/update-doc-template-request-dto.d.ts +16 -10
  74. package/dist/models/update-doc-template-response-class.d.ts +1 -1
  75. package/dist/models/update-document-request-dto.d.ts +10 -4
  76. package/dist/models/update-document-response-class.d.ts +25 -0
  77. package/dist/models/update-document-response-class.js +15 -0
  78. package/dist/models/update-html-template-dto.d.ts +42 -0
  79. package/dist/models/update-html-template-dto.js +21 -0
  80. package/dist/models/update-layout-request-dto.d.ts +15 -15
  81. package/dist/models/update-layout-response-class.d.ts +1 -1
  82. package/models/create-doc-template-request-dto.ts +10 -4
  83. package/models/create-doc-template-response-class.ts +31 -0
  84. package/models/create-document-request-dto.ts +20 -8
  85. package/models/create-document-sync-response-class.ts +31 -0
  86. package/models/create-html-template-dto.ts +1 -1
  87. package/models/create-layout-request-dto.ts +10 -10
  88. package/models/create-layout-response-class.ts +31 -0
  89. package/models/create-presigned-post-request-dto.ts +137 -0
  90. package/models/create-presigned-post-response-class.ts +36 -0
  91. package/models/delete-layout-request-dto.ts +1 -1
  92. package/models/delete-request-dto.ts +1 -1
  93. package/models/delete-response-class.ts +30 -0
  94. package/models/doc-template-class.ts +25 -19
  95. package/models/document-class.ts +20 -8
  96. package/models/download-document-request-dto.ts +2 -2
  97. package/models/get-doc-template-request-dto.ts +1 -1
  98. package/models/get-doc-template-response-class.ts +1 -1
  99. package/models/get-document-download-url-response-class.ts +1 -1
  100. package/models/get-layout-request-dto.ts +1 -1
  101. package/models/get-signed-s3-key-url-response-class.ts +30 -0
  102. package/models/html-template-class.ts +7 -7
  103. package/models/index.ts +14 -0
  104. package/models/layout-class.ts +11 -11
  105. package/models/list-doc-template-request-dto.ts +54 -0
  106. package/models/list-doc-templates-response-class.ts +1 -1
  107. package/models/list-documents-response-class.ts +1 -1
  108. package/models/list-layouts-response-class.ts +1 -1
  109. package/models/list-search-keywords-request-dto.ts +30 -0
  110. package/models/list-search-keywords-response-class.ts +30 -0
  111. package/models/list-searchable-document-owners-response-class.ts +3 -2
  112. package/models/list-searchable-documents-request-dto.ts +2 -2
  113. package/models/list-searchable-documents-response-class.ts +5 -4
  114. package/models/searchable-document-class.ts +72 -0
  115. package/models/searchable-document-owner-class.ts +36 -0
  116. package/models/update-doc-template-request-dto.ts +16 -10
  117. package/models/update-doc-template-response-class.ts +1 -1
  118. package/models/update-document-request-dto.ts +10 -4
  119. package/models/update-document-response-class.ts +31 -0
  120. package/models/update-html-template-dto.ts +51 -0
  121. package/models/update-layout-request-dto.ts +15 -15
  122. package/models/update-layout-response-class.ts +1 -1
  123. package/package.json +1 -1
@@ -6,6 +6,7 @@ api.ts
6
6
  api/document-templates-api.ts
7
7
  api/documents-api.ts
8
8
  api/layouts-api.ts
9
+ api/search-keywords-api.ts
9
10
  api/searchable-document-owners-api.ts
10
11
  api/searchable-documents-api.ts
11
12
  base.ts
@@ -14,11 +15,17 @@ configuration.ts
14
15
  git_push.sh
15
16
  index.ts
16
17
  models/create-doc-template-request-dto.ts
18
+ models/create-doc-template-response-class.ts
17
19
  models/create-document-request-dto.ts
20
+ models/create-document-sync-response-class.ts
18
21
  models/create-html-template-dto.ts
19
22
  models/create-layout-request-dto.ts
23
+ models/create-layout-response-class.ts
24
+ models/create-presigned-post-request-dto.ts
25
+ models/create-presigned-post-response-class.ts
20
26
  models/delete-layout-request-dto.ts
21
27
  models/delete-request-dto.ts
28
+ models/delete-response-class.ts
22
29
  models/doc-template-class.ts
23
30
  models/document-class.ts
24
31
  models/download-document-request-dto.ts
@@ -27,19 +34,27 @@ models/get-doc-template-response-class.ts
27
34
  models/get-document-download-url-response-class.ts
28
35
  models/get-layout-request-dto.ts
29
36
  models/get-layout-response-class.ts
37
+ models/get-signed-s3-key-url-response-class.ts
30
38
  models/html-template-class.ts
31
39
  models/index.ts
32
40
  models/layout-class.ts
41
+ models/list-doc-template-request-dto.ts
33
42
  models/list-doc-templates-response-class.ts
34
43
  models/list-documents-response-class.ts
35
44
  models/list-layouts-response-class.ts
36
45
  models/list-request-dto.ts
46
+ models/list-search-keywords-request-dto.ts
47
+ models/list-search-keywords-response-class.ts
37
48
  models/list-searchable-document-owners-response-class.ts
38
49
  models/list-searchable-documents-request-dto.ts
39
50
  models/list-searchable-documents-response-class.ts
51
+ models/searchable-document-class.ts
52
+ models/searchable-document-owner-class.ts
40
53
  models/update-doc-template-request-dto.ts
41
54
  models/update-doc-template-response-class.ts
42
55
  models/update-document-request-dto.ts
56
+ models/update-document-response-class.ts
57
+ models/update-html-template-dto.ts
43
58
  models/update-layout-request-dto.ts
44
59
  models/update-layout-response-class.ts
45
60
  package.json
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.2.0 --save
20
+ npm install @emilgroup/document-sdk-node@1.2.1 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/document-sdk-node@1.2.0
24
+ yarn add @emilgroup/document-sdk-node@1.2.1
25
25
  ```
26
26
 
27
27
  And then you can import `DocumentsApi`.
@@ -23,6 +23,10 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
23
23
  // @ts-ignore
24
24
  import { CreateDocTemplateRequestDto } from '../models';
25
25
  // @ts-ignore
26
+ import { CreateDocTemplateResponseClass } from '../models';
27
+ // @ts-ignore
28
+ import { DeleteResponseClass } from '../models';
29
+ // @ts-ignore
26
30
  import { GetDocTemplateResponseClass } from '../models';
27
31
  // @ts-ignore
28
32
  import { ListDocTemplatesResponseClass } from '../models';
@@ -41,7 +45,8 @@ const FormData = require('form-data');
41
45
  export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: Configuration) {
42
46
  return {
43
47
  /**
44
- *
48
+ * This will create a document template.
49
+ * @summary Create the document template
45
50
  * @param {CreateDocTemplateRequestDto} createDocTemplateRequestDto
46
51
  * @param {string} [authorization] Bearer Token
47
52
  * @param {*} [options] Override http request option.
@@ -87,7 +92,8 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
87
92
  };
88
93
  },
89
94
  /**
90
- *
95
+ * Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it.
96
+ * @summary Delete the document template
91
97
  * @param {number} id
92
98
  * @param {string} [authorization] Bearer Token
93
99
  * @param {*} [options] Override http request option.
@@ -131,19 +137,17 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
131
137
  };
132
138
  },
133
139
  /**
134
- *
135
- * @param {string} id
136
- * @param {number} id2 Template id
140
+ * Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
141
+ * @summary Retrieve the document template
142
+ * @param {number} id
137
143
  * @param {string} [authorization] Bearer Token
138
- * @param {string} [expand]
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.
139
145
  * @param {*} [options] Override http request option.
140
146
  * @throws {RequiredError}
141
147
  */
142
- getDocTemplate: async (id: string, id2: number, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
148
+ getDocTemplate: async (id: number, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
143
149
  // verify required parameter 'id' is not null or undefined
144
150
  assertParamExists('getDocTemplate', 'id', id)
145
- // verify required parameter 'id2' is not null or undefined
146
- assertParamExists('getDocTemplate', 'id2', id2)
147
151
  const localVarPath = `/documentservice/v1/doc-templates/{id}`
148
152
  .replace(`{${"id"}}`, encodeURIComponent(String(id)));
149
153
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -163,10 +167,6 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
163
167
  // http bearer authentication required
164
168
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
165
169
 
166
- if (id2 !== undefined) {
167
- localVarQueryParameter['id'] = id2;
168
- }
169
-
170
170
  if (expand !== undefined) {
171
171
  localVarQueryParameter['expand'] = expand;
172
172
  }
@@ -187,18 +187,18 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
187
187
  };
188
188
  },
189
189
  /**
190
- *
190
+ * Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
191
+ * @summary List document templates
191
192
  * @param {string} [authorization] Bearer Token
192
- * @param {number} [pageSize] Page size
193
- * @param {string} [pageToken] Page token
194
- * @param {string} [filter] List filter
195
- * @param {string} [search] Search query
196
- * @param {string} [order] Ordering criteria
197
- * @param {string} [expand] Extra fields to fetch
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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
195
+ * @param {string} [filter] Filter response by productSlug, slug and name.
196
+ * @param {string} [order] Order response by createdAt.
197
+ * @param {string} [expand] Expand response by bodyTemplate.
198
198
  * @param {*} [options] Override http request option.
199
199
  * @throws {RequiredError}
200
200
  */
201
- listDocTemplates: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
201
+ listDocTemplates: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
202
202
  const localVarPath = `/documentservice/v1/doc-templates`;
203
203
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
204
204
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -229,10 +229,6 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
229
229
  localVarQueryParameter['filter'] = filter;
230
230
  }
231
231
 
232
- if (search !== undefined) {
233
- localVarQueryParameter['search'] = search;
234
- }
235
-
236
232
  if (order !== undefined) {
237
233
  localVarQueryParameter['order'] = order;
238
234
  }
@@ -257,7 +253,8 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
257
253
  };
258
254
  },
259
255
  /**
260
- *
256
+ * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
257
+ * @summary Update the document template
261
258
  * @param {number} id
262
259
  * @param {UpdateDocTemplateRequestDto} updateDocTemplateRequestDto
263
260
  * @param {string} [authorization] Bearer Token
@@ -317,58 +314,61 @@ export const DocumentTemplatesApiFp = function(configuration?: Configuration) {
317
314
  const localVarAxiosParamCreator = DocumentTemplatesApiAxiosParamCreator(configuration)
318
315
  return {
319
316
  /**
320
- *
317
+ * This will create a document template.
318
+ * @summary Create the document template
321
319
  * @param {CreateDocTemplateRequestDto} createDocTemplateRequestDto
322
320
  * @param {string} [authorization] Bearer Token
323
321
  * @param {*} [options] Override http request option.
324
322
  * @throws {RequiredError}
325
323
  */
326
- async createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
324
+ async createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDocTemplateResponseClass>> {
327
325
  const localVarAxiosArgs = await localVarAxiosParamCreator.createDocTemplate(createDocTemplateRequestDto, authorization, options);
328
326
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
329
327
  },
330
328
  /**
331
- *
329
+ * Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it.
330
+ * @summary Delete the document template
332
331
  * @param {number} id
333
332
  * @param {string} [authorization] Bearer Token
334
333
  * @param {*} [options] Override http request option.
335
334
  * @throws {RequiredError}
336
335
  */
337
- async deleteDocTemplate(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
336
+ async deleteDocTemplate(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>> {
338
337
  const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDocTemplate(id, authorization, options);
339
338
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
340
339
  },
341
340
  /**
342
- *
343
- * @param {string} id
344
- * @param {number} id2 Template id
341
+ * Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
342
+ * @summary Retrieve the document template
343
+ * @param {number} id
345
344
  * @param {string} [authorization] Bearer Token
346
- * @param {string} [expand]
345
+ * @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.
347
346
  * @param {*} [options] Override http request option.
348
347
  * @throws {RequiredError}
349
348
  */
350
- async getDocTemplate(id: string, id2: number, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocTemplateResponseClass>> {
351
- const localVarAxiosArgs = await localVarAxiosParamCreator.getDocTemplate(id, id2, authorization, expand, options);
349
+ async getDocTemplate(id: number, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocTemplateResponseClass>> {
350
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getDocTemplate(id, authorization, expand, options);
352
351
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
353
352
  },
354
353
  /**
355
- *
354
+ * Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
355
+ * @summary List document templates
356
356
  * @param {string} [authorization] Bearer Token
357
- * @param {number} [pageSize] Page size
358
- * @param {string} [pageToken] Page token
359
- * @param {string} [filter] List filter
360
- * @param {string} [search] Search query
361
- * @param {string} [order] Ordering criteria
362
- * @param {string} [expand] Extra fields to fetch
357
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
358
+ * @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.
359
+ * @param {string} [filter] Filter response by productSlug, slug and name.
360
+ * @param {string} [order] Order response by createdAt.
361
+ * @param {string} [expand] Expand response by bodyTemplate.
363
362
  * @param {*} [options] Override http request option.
364
363
  * @throws {RequiredError}
365
364
  */
366
- async listDocTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocTemplatesResponseClass>> {
367
- const localVarAxiosArgs = await localVarAxiosParamCreator.listDocTemplates(authorization, pageSize, pageToken, filter, search, order, expand, options);
365
+ async listDocTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocTemplatesResponseClass>> {
366
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listDocTemplates(authorization, pageSize, pageToken, filter, order, expand, options);
368
367
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
369
368
  },
370
369
  /**
371
- *
370
+ * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
371
+ * @summary Update the document template
372
372
  * @param {number} id
373
373
  * @param {UpdateDocTemplateRequestDto} updateDocTemplateRequestDto
374
374
  * @param {string} [authorization] Bearer Token
@@ -390,54 +390,57 @@ export const DocumentTemplatesApiFactory = function (configuration?: Configurati
390
390
  const localVarFp = DocumentTemplatesApiFp(configuration)
391
391
  return {
392
392
  /**
393
- *
393
+ * This will create a document template.
394
+ * @summary Create the document template
394
395
  * @param {CreateDocTemplateRequestDto} createDocTemplateRequestDto
395
396
  * @param {string} [authorization] Bearer Token
396
397
  * @param {*} [options] Override http request option.
397
398
  * @throws {RequiredError}
398
399
  */
399
- createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<object> {
400
+ createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<CreateDocTemplateResponseClass> {
400
401
  return localVarFp.createDocTemplate(createDocTemplateRequestDto, authorization, options).then((request) => request(axios, basePath));
401
402
  },
402
403
  /**
403
- *
404
+ * Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it.
405
+ * @summary Delete the document template
404
406
  * @param {number} id
405
407
  * @param {string} [authorization] Bearer Token
406
408
  * @param {*} [options] Override http request option.
407
409
  * @throws {RequiredError}
408
410
  */
409
- deleteDocTemplate(id: number, authorization?: string, options?: any): AxiosPromise<object> {
411
+ deleteDocTemplate(id: number, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass> {
410
412
  return localVarFp.deleteDocTemplate(id, authorization, options).then((request) => request(axios, basePath));
411
413
  },
412
414
  /**
413
- *
414
- * @param {string} id
415
- * @param {number} id2 Template id
415
+ * Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
416
+ * @summary Retrieve the document template
417
+ * @param {number} id
416
418
  * @param {string} [authorization] Bearer Token
417
- * @param {string} [expand]
419
+ * @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.
418
420
  * @param {*} [options] Override http request option.
419
421
  * @throws {RequiredError}
420
422
  */
421
- getDocTemplate(id: string, id2: number, authorization?: string, expand?: string, options?: any): AxiosPromise<GetDocTemplateResponseClass> {
422
- return localVarFp.getDocTemplate(id, id2, authorization, expand, options).then((request) => request(axios, basePath));
423
+ getDocTemplate(id: number, authorization?: string, expand?: string, options?: any): AxiosPromise<GetDocTemplateResponseClass> {
424
+ return localVarFp.getDocTemplate(id, authorization, expand, options).then((request) => request(axios, basePath));
423
425
  },
424
426
  /**
425
- *
427
+ * Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
428
+ * @summary List document templates
426
429
  * @param {string} [authorization] Bearer Token
427
- * @param {number} [pageSize] Page size
428
- * @param {string} [pageToken] Page token
429
- * @param {string} [filter] List filter
430
- * @param {string} [search] Search query
431
- * @param {string} [order] Ordering criteria
432
- * @param {string} [expand] Extra fields to fetch
430
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
431
+ * @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.
432
+ * @param {string} [filter] Filter response by productSlug, slug and name.
433
+ * @param {string} [order] Order response by createdAt.
434
+ * @param {string} [expand] Expand response by bodyTemplate.
433
435
  * @param {*} [options] Override http request option.
434
436
  * @throws {RequiredError}
435
437
  */
436
- listDocTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListDocTemplatesResponseClass> {
437
- return localVarFp.listDocTemplates(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
438
+ listDocTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListDocTemplatesResponseClass> {
439
+ return localVarFp.listDocTemplates(authorization, pageSize, pageToken, filter, order, expand, options).then((request) => request(axios, basePath));
438
440
  },
439
441
  /**
440
- *
442
+ * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
443
+ * @summary Update the document template
441
444
  * @param {number} id
442
445
  * @param {UpdateDocTemplateRequestDto} updateDocTemplateRequestDto
443
446
  * @param {string} [authorization] Bearer Token
@@ -500,17 +503,10 @@ export interface DocumentTemplatesApiDeleteDocTemplateRequest {
500
503
  export interface DocumentTemplatesApiGetDocTemplateRequest {
501
504
  /**
502
505
  *
503
- * @type {string}
504
- * @memberof DocumentTemplatesApiGetDocTemplate
505
- */
506
- readonly id: string
507
-
508
- /**
509
- * Template id
510
506
  * @type {number}
511
507
  * @memberof DocumentTemplatesApiGetDocTemplate
512
508
  */
513
- readonly id2: number
509
+ readonly id: number
514
510
 
515
511
  /**
516
512
  * Bearer Token
@@ -520,7 +516,7 @@ export interface DocumentTemplatesApiGetDocTemplateRequest {
520
516
  readonly authorization?: string
521
517
 
522
518
  /**
523
- *
519
+ * 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.
524
520
  * @type {string}
525
521
  * @memberof DocumentTemplatesApiGetDocTemplate
526
522
  */
@@ -541,42 +537,35 @@ export interface DocumentTemplatesApiListDocTemplatesRequest {
541
537
  readonly authorization?: string
542
538
 
543
539
  /**
544
- * Page size
540
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
545
541
  * @type {number}
546
542
  * @memberof DocumentTemplatesApiListDocTemplates
547
543
  */
548
544
  readonly pageSize?: number
549
545
 
550
546
  /**
551
- * Page token
547
+ * 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.
552
548
  * @type {string}
553
549
  * @memberof DocumentTemplatesApiListDocTemplates
554
550
  */
555
551
  readonly pageToken?: string
556
552
 
557
553
  /**
558
- * List filter
554
+ * Filter response by productSlug, slug and name.
559
555
  * @type {string}
560
556
  * @memberof DocumentTemplatesApiListDocTemplates
561
557
  */
562
558
  readonly filter?: string
563
559
 
564
560
  /**
565
- * Search query
566
- * @type {string}
567
- * @memberof DocumentTemplatesApiListDocTemplates
568
- */
569
- readonly search?: string
570
-
571
- /**
572
- * Ordering criteria
561
+ * Order response by createdAt.
573
562
  * @type {string}
574
563
  * @memberof DocumentTemplatesApiListDocTemplates
575
564
  */
576
565
  readonly order?: string
577
566
 
578
567
  /**
579
- * Extra fields to fetch
568
+ * Expand response by bodyTemplate.
580
569
  * @type {string}
581
570
  * @memberof DocumentTemplatesApiListDocTemplates
582
571
  */
@@ -619,7 +608,8 @@ export interface DocumentTemplatesApiUpdateDocTemplateRequest {
619
608
  */
620
609
  export class DocumentTemplatesApi extends BaseAPI {
621
610
  /**
622
- *
611
+ * This will create a document template.
612
+ * @summary Create the document template
623
613
  * @param {DocumentTemplatesApiCreateDocTemplateRequest} requestParameters Request parameters.
624
614
  * @param {*} [options] Override http request option.
625
615
  * @throws {RequiredError}
@@ -630,7 +620,8 @@ export class DocumentTemplatesApi extends BaseAPI {
630
620
  }
631
621
 
632
622
  /**
633
- *
623
+ * Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it.
624
+ * @summary Delete the document template
634
625
  * @param {DocumentTemplatesApiDeleteDocTemplateRequest} requestParameters Request parameters.
635
626
  * @param {*} [options] Override http request option.
636
627
  * @throws {RequiredError}
@@ -641,29 +632,32 @@ export class DocumentTemplatesApi extends BaseAPI {
641
632
  }
642
633
 
643
634
  /**
644
- *
635
+ * Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
636
+ * @summary Retrieve the document template
645
637
  * @param {DocumentTemplatesApiGetDocTemplateRequest} requestParameters Request parameters.
646
638
  * @param {*} [options] Override http request option.
647
639
  * @throws {RequiredError}
648
640
  * @memberof DocumentTemplatesApi
649
641
  */
650
642
  public getDocTemplate(requestParameters: DocumentTemplatesApiGetDocTemplateRequest, options?: AxiosRequestConfig) {
651
- return DocumentTemplatesApiFp(this.configuration).getDocTemplate(requestParameters.id, requestParameters.id2, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
643
+ return DocumentTemplatesApiFp(this.configuration).getDocTemplate(requestParameters.id, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
652
644
  }
653
645
 
654
646
  /**
655
- *
647
+ * Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
648
+ * @summary List document templates
656
649
  * @param {DocumentTemplatesApiListDocTemplatesRequest} requestParameters Request parameters.
657
650
  * @param {*} [options] Override http request option.
658
651
  * @throws {RequiredError}
659
652
  * @memberof DocumentTemplatesApi
660
653
  */
661
654
  public listDocTemplates(requestParameters: DocumentTemplatesApiListDocTemplatesRequest = {}, options?: AxiosRequestConfig) {
662
- return DocumentTemplatesApiFp(this.configuration).listDocTemplates(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
655
+ return DocumentTemplatesApiFp(this.configuration).listDocTemplates(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
663
656
  }
664
657
 
665
658
  /**
666
- *
659
+ * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
660
+ * @summary Update the document template
667
661
  * @param {DocumentTemplatesApiUpdateDocTemplateRequest} requestParameters Request parameters.
668
662
  * @param {*} [options] Override http request option.
669
663
  * @throws {RequiredError}