@emilgroup/document-sdk-node 1.22.0 → 1.22.1-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (165) hide show
  1. package/.openapi-generator/FILES +0 -38
  2. package/README.md +2 -2
  3. package/api/default-api.ts +8 -4
  4. package/api/document-templates-api.ts +79 -75
  5. package/api/documents-api.ts +42 -38
  6. package/api/docx-templates-api.ts +16 -28
  7. package/api/layouts-api.ts +18 -28
  8. package/api/product-documents-api.ts +47 -238
  9. package/api/search-keywords-api.ts +2 -4
  10. package/api/searchable-document-owners-api.ts +2 -4
  11. package/api/searchable-documents-api.ts +20 -20
  12. package/dist/api/default-api.d.ts +8 -4
  13. package/dist/api/default-api.js +8 -4
  14. package/dist/api/document-templates-api.d.ts +62 -67
  15. package/dist/api/document-templates-api.js +55 -42
  16. package/dist/api/documents-api.d.ts +39 -36
  17. package/dist/api/documents-api.js +21 -13
  18. package/dist/api/docx-templates-api.d.ts +22 -28
  19. package/dist/api/docx-templates-api.js +4 -4
  20. package/dist/api/layouts-api.d.ts +23 -28
  21. package/dist/api/layouts-api.js +8 -8
  22. package/dist/api/product-documents-api.d.ts +37 -150
  23. package/dist/api/product-documents-api.js +29 -155
  24. package/dist/api/search-keywords-api.d.ts +3 -4
  25. package/dist/api/searchable-document-owners-api.d.ts +3 -4
  26. package/dist/api/searchable-documents-api.d.ts +16 -17
  27. package/dist/api/searchable-documents-api.js +15 -13
  28. package/dist/models/create-doc-template-request-dto.d.ts +2 -2
  29. package/dist/models/create-document-request-dto.d.ts +10 -10
  30. package/dist/models/create-presigned-post-request-dto.d.ts +4 -4
  31. package/dist/models/index.d.ts +0 -38
  32. package/dist/models/index.js +0 -38
  33. package/dist/models/list-searchable-document-owners-request-dto.d.ts +1 -8
  34. package/dist/models/list-searchable-document-owners-request-dto.js +0 -7
  35. package/dist/models/list-searchable-documents-request-dto.d.ts +1 -8
  36. package/dist/models/list-searchable-documents-request-dto.js +0 -7
  37. package/dist/models/update-doc-template-request-dto.d.ts +2 -2
  38. package/dist/models/update-document-request-dto.d.ts +5 -5
  39. package/dist/models/upload-docx-template-request-dto.d.ts +1 -1
  40. package/dist/models/upload-product-document-request-dto.d.ts +2 -2
  41. package/models/create-doc-template-request-dto.ts +2 -2
  42. package/models/create-document-request-dto.ts +10 -10
  43. package/models/create-presigned-post-request-dto.ts +4 -4
  44. package/models/index.ts +0 -38
  45. package/models/list-searchable-document-owners-request-dto.ts +1 -11
  46. package/models/list-searchable-documents-request-dto.ts +1 -11
  47. package/models/update-doc-template-request-dto.ts +2 -2
  48. package/models/update-document-request-dto.ts +5 -5
  49. package/models/upload-docx-template-request-dto.ts +1 -1
  50. package/models/upload-product-document-request-dto.ts +2 -2
  51. package/package.json +1 -1
  52. package/dist/models/create-doc-template-response-class.d.ts +0 -25
  53. package/dist/models/create-doc-template-response-class.js +0 -15
  54. package/dist/models/create-document-sync-response-class.d.ts +0 -25
  55. package/dist/models/create-document-sync-response-class.js +0 -15
  56. package/dist/models/create-layout-response-class.d.ts +0 -25
  57. package/dist/models/create-layout-response-class.js +0 -15
  58. package/dist/models/create-presigned-post-response-class.d.ts +0 -30
  59. package/dist/models/create-presigned-post-response-class.js +0 -15
  60. package/dist/models/delete-response-class.d.ts +0 -24
  61. package/dist/models/delete-response-class.js +0 -15
  62. package/dist/models/doc-template-class.d.ts +0 -92
  63. package/dist/models/doc-template-class.js +0 -15
  64. package/dist/models/document-class.d.ts +0 -165
  65. package/dist/models/document-class.js +0 -53
  66. package/dist/models/docx-template-class.d.ts +0 -90
  67. package/dist/models/docx-template-class.js +0 -15
  68. package/dist/models/download-document-request-dto.d.ts +0 -30
  69. package/dist/models/download-document-request-dto.js +0 -15
  70. package/dist/models/get-doc-template-request-dto.d.ts +0 -30
  71. package/dist/models/get-doc-template-request-dto.js +0 -15
  72. package/dist/models/get-doc-template-response-class.d.ts +0 -25
  73. package/dist/models/get-doc-template-response-class.js +0 -15
  74. package/dist/models/get-document-download-url-response-class.d.ts +0 -24
  75. package/dist/models/get-document-download-url-response-class.js +0 -15
  76. package/dist/models/get-docx-template-download-url-response-class.d.ts +0 -24
  77. package/dist/models/get-docx-template-download-url-response-class.js +0 -15
  78. package/dist/models/get-docx-template-response-class.d.ts +0 -25
  79. package/dist/models/get-docx-template-response-class.js +0 -15
  80. package/dist/models/get-layout-response-class.d.ts +0 -25
  81. package/dist/models/get-layout-response-class.js +0 -15
  82. package/dist/models/get-product-document-download-url-response-class.d.ts +0 -24
  83. package/dist/models/get-product-document-download-url-response-class.js +0 -15
  84. package/dist/models/get-product-document-response-class.d.ts +0 -25
  85. package/dist/models/get-product-document-response-class.js +0 -15
  86. package/dist/models/get-signed-s3-key-url-response-class.d.ts +0 -24
  87. package/dist/models/get-signed-s3-key-url-response-class.js +0 -15
  88. package/dist/models/grpc-create-doc-template-request-dto.d.ts +0 -55
  89. package/dist/models/grpc-create-doc-template-request-dto.js +0 -15
  90. package/dist/models/grpc-update-doc-template-request-dto.d.ts +0 -61
  91. package/dist/models/grpc-update-doc-template-request-dto.js +0 -15
  92. package/dist/models/html-template-class.d.ts +0 -66
  93. package/dist/models/html-template-class.js +0 -21
  94. package/dist/models/layout-class.d.ts +0 -79
  95. package/dist/models/layout-class.js +0 -15
  96. package/dist/models/list-doc-template-request-dto.d.ts +0 -54
  97. package/dist/models/list-doc-template-request-dto.js +0 -15
  98. package/dist/models/list-doc-templates-response-class.d.ts +0 -31
  99. package/dist/models/list-doc-templates-response-class.js +0 -15
  100. package/dist/models/list-documents-response-class.d.ts +0 -31
  101. package/dist/models/list-documents-response-class.js +0 -15
  102. package/dist/models/list-docx-templates-response-class.d.ts +0 -31
  103. package/dist/models/list-docx-templates-response-class.js +0 -15
  104. package/dist/models/list-layouts-response-class.d.ts +0 -31
  105. package/dist/models/list-layouts-response-class.js +0 -15
  106. package/dist/models/list-product-documents-response-class.d.ts +0 -31
  107. package/dist/models/list-product-documents-response-class.js +0 -15
  108. package/dist/models/list-search-keywords-response-class.d.ts +0 -24
  109. package/dist/models/list-search-keywords-response-class.js +0 -15
  110. package/dist/models/list-searchable-document-owners-response-class.d.ts +0 -25
  111. package/dist/models/list-searchable-document-owners-response-class.js +0 -15
  112. package/dist/models/list-searchable-documents-response-class.d.ts +0 -31
  113. package/dist/models/list-searchable-documents-response-class.js +0 -15
  114. package/dist/models/product-document-class.d.ts +0 -117
  115. package/dist/models/product-document-class.js +0 -24
  116. package/dist/models/searchable-document-class.d.ts +0 -66
  117. package/dist/models/searchable-document-class.js +0 -15
  118. package/dist/models/searchable-document-owner-class.d.ts +0 -30
  119. package/dist/models/searchable-document-owner-class.js +0 -15
  120. package/dist/models/update-doc-template-response-class.d.ts +0 -25
  121. package/dist/models/update-doc-template-response-class.js +0 -15
  122. package/dist/models/update-document-response-class.d.ts +0 -25
  123. package/dist/models/update-document-response-class.js +0 -15
  124. package/dist/models/update-docx-template-response-class.d.ts +0 -25
  125. package/dist/models/update-docx-template-response-class.js +0 -15
  126. package/dist/models/update-layout-response-class.d.ts +0 -25
  127. package/dist/models/update-layout-response-class.js +0 -15
  128. package/models/create-doc-template-response-class.ts +0 -31
  129. package/models/create-document-sync-response-class.ts +0 -31
  130. package/models/create-layout-response-class.ts +0 -31
  131. package/models/create-presigned-post-response-class.ts +0 -36
  132. package/models/delete-response-class.ts +0 -30
  133. package/models/doc-template-class.ts +0 -98
  134. package/models/document-class.ts +0 -175
  135. package/models/docx-template-class.ts +0 -96
  136. package/models/download-document-request-dto.ts +0 -36
  137. package/models/get-doc-template-request-dto.ts +0 -36
  138. package/models/get-doc-template-response-class.ts +0 -31
  139. package/models/get-document-download-url-response-class.ts +0 -30
  140. package/models/get-docx-template-download-url-response-class.ts +0 -30
  141. package/models/get-docx-template-response-class.ts +0 -31
  142. package/models/get-layout-response-class.ts +0 -31
  143. package/models/get-product-document-download-url-response-class.ts +0 -30
  144. package/models/get-product-document-response-class.ts +0 -31
  145. package/models/get-signed-s3-key-url-response-class.ts +0 -30
  146. package/models/grpc-create-doc-template-request-dto.ts +0 -61
  147. package/models/grpc-update-doc-template-request-dto.ts +0 -67
  148. package/models/html-template-class.ts +0 -75
  149. package/models/layout-class.ts +0 -85
  150. package/models/list-doc-template-request-dto.ts +0 -60
  151. package/models/list-doc-templates-response-class.ts +0 -37
  152. package/models/list-documents-response-class.ts +0 -37
  153. package/models/list-docx-templates-response-class.ts +0 -37
  154. package/models/list-layouts-response-class.ts +0 -37
  155. package/models/list-product-documents-response-class.ts +0 -37
  156. package/models/list-search-keywords-response-class.ts +0 -30
  157. package/models/list-searchable-document-owners-response-class.ts +0 -31
  158. package/models/list-searchable-documents-response-class.ts +0 -37
  159. package/models/product-document-class.ts +0 -126
  160. package/models/searchable-document-class.ts +0 -72
  161. package/models/searchable-document-owner-class.ts +0 -36
  162. package/models/update-doc-template-response-class.ts +0 -31
  163. package/models/update-document-response-class.ts +0 -31
  164. package/models/update-docx-template-response-class.ts +0 -31
  165. package/models/update-layout-response-class.ts +0 -31
@@ -20,8 +20,6 @@ import { Configuration } from '../configuration';
20
20
  import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
21
21
  // @ts-ignore
22
22
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
- // @ts-ignore
24
- import { ListSearchableDocumentsResponseClass } from '../models';
25
23
  // URLSearchParams not necessarily used
26
24
  // @ts-ignore
27
25
  import { URL, URLSearchParams } from 'url';
@@ -33,20 +31,22 @@ const FormData = require('form-data');
33
31
  export const SearchableDocumentsApiAxiosParamCreator = function (configuration?: Configuration) {
34
32
  return {
35
33
  /**
36
- * Returns a list of searchable documents you have previously created. The searchable documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
34
+ * Returns a list of searchable documents you have previously created. The searchable documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
37
35
  * @summary List searchable documents
38
36
  * @param {string} searchText Text to search in the documents.
39
37
  * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \'*\' list provided).
38
+ * @param {string} product PBM product the documents belongs to.
40
39
  * @param {string} [authorization] Bearer Token
41
- * @param {'car' | 'homeowner' | 'household' | 'privateLiability'} [product] PBM product the documents belongs to.
42
40
  * @param {*} [options] Override http request option.
43
41
  * @throws {RequiredError}
44
42
  */
45
- listSearchableDocuments: async (searchText: string, ownerIds: string, authorization?: string, product?: 'car' | 'homeowner' | 'household' | 'privateLiability', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
43
+ listSearchableDocuments: async (searchText: string, ownerIds: string, product: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
46
44
  // verify required parameter 'searchText' is not null or undefined
47
45
  assertParamExists('listSearchableDocuments', 'searchText', searchText)
48
46
  // verify required parameter 'ownerIds' is not null or undefined
49
47
  assertParamExists('listSearchableDocuments', 'ownerIds', ownerIds)
48
+ // verify required parameter 'product' is not null or undefined
49
+ assertParamExists('listSearchableDocuments', 'product', product)
50
50
  const localVarPath = `/documentservice/v1/searchable-documents`;
51
51
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
52
52
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -103,17 +103,17 @@ export const SearchableDocumentsApiFp = function(configuration?: Configuration)
103
103
  const localVarAxiosParamCreator = SearchableDocumentsApiAxiosParamCreator(configuration)
104
104
  return {
105
105
  /**
106
- * Returns a list of searchable documents you have previously created. The searchable documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
106
+ * Returns a list of searchable documents you have previously created. The searchable documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
107
107
  * @summary List searchable documents
108
108
  * @param {string} searchText Text to search in the documents.
109
109
  * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \&#39;*\&#39; list provided).
110
+ * @param {string} product PBM product the documents belongs to.
110
111
  * @param {string} [authorization] Bearer Token
111
- * @param {'car' | 'homeowner' | 'household' | 'privateLiability'} [product] PBM product the documents belongs to.
112
112
  * @param {*} [options] Override http request option.
113
113
  * @throws {RequiredError}
114
114
  */
115
- async listSearchableDocuments(searchText: string, ownerIds: string, authorization?: string, product?: 'car' | 'homeowner' | 'household' | 'privateLiability', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListSearchableDocumentsResponseClass>> {
116
- const localVarAxiosArgs = await localVarAxiosParamCreator.listSearchableDocuments(searchText, ownerIds, authorization, product, options);
115
+ async listSearchableDocuments(searchText: string, ownerIds: string, product: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
116
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listSearchableDocuments(searchText, ownerIds, product, authorization, options);
117
117
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
118
118
  },
119
119
  }
@@ -127,17 +127,17 @@ export const SearchableDocumentsApiFactory = function (configuration?: Configura
127
127
  const localVarFp = SearchableDocumentsApiFp(configuration)
128
128
  return {
129
129
  /**
130
- * Returns a list of searchable documents you have previously created. The searchable documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
130
+ * Returns a list of searchable documents you have previously created. The searchable documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
131
131
  * @summary List searchable documents
132
132
  * @param {string} searchText Text to search in the documents.
133
133
  * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \&#39;*\&#39; list provided).
134
+ * @param {string} product PBM product the documents belongs to.
134
135
  * @param {string} [authorization] Bearer Token
135
- * @param {'car' | 'homeowner' | 'household' | 'privateLiability'} [product] PBM product the documents belongs to.
136
136
  * @param {*} [options] Override http request option.
137
137
  * @throws {RequiredError}
138
138
  */
139
- listSearchableDocuments(searchText: string, ownerIds: string, authorization?: string, product?: 'car' | 'homeowner' | 'household' | 'privateLiability', options?: any): AxiosPromise<ListSearchableDocumentsResponseClass> {
140
- return localVarFp.listSearchableDocuments(searchText, ownerIds, authorization, product, options).then((request) => request(axios, basePath));
139
+ listSearchableDocuments(searchText: string, ownerIds: string, product: string, authorization?: string, options?: any): AxiosPromise<void> {
140
+ return localVarFp.listSearchableDocuments(searchText, ownerIds, product, authorization, options).then((request) => request(axios, basePath));
141
141
  },
142
142
  };
143
143
  };
@@ -163,18 +163,18 @@ export interface SearchableDocumentsApiListSearchableDocumentsRequest {
163
163
  readonly ownerIds: string
164
164
 
165
165
  /**
166
- * Bearer Token
166
+ * PBM product the documents belongs to.
167
167
  * @type {string}
168
168
  * @memberof SearchableDocumentsApiListSearchableDocuments
169
169
  */
170
- readonly authorization?: string
170
+ readonly product: string
171
171
 
172
172
  /**
173
- * PBM product the documents belongs to.
174
- * @type {'car' | 'homeowner' | 'household' | 'privateLiability'}
173
+ * Bearer Token
174
+ * @type {string}
175
175
  * @memberof SearchableDocumentsApiListSearchableDocuments
176
176
  */
177
- readonly product?: 'car' | 'homeowner' | 'household' | 'privateLiability'
177
+ readonly authorization?: string
178
178
  }
179
179
 
180
180
  /**
@@ -185,7 +185,7 @@ export interface SearchableDocumentsApiListSearchableDocumentsRequest {
185
185
  */
186
186
  export class SearchableDocumentsApi extends BaseAPI {
187
187
  /**
188
- * Returns a list of searchable documents you have previously created. The searchable documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
188
+ * Returns a list of searchable documents you have previously created. The searchable documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
189
189
  * @summary List searchable documents
190
190
  * @param {SearchableDocumentsApiListSearchableDocumentsRequest} requestParameters Request parameters.
191
191
  * @param {*} [options] Override http request option.
@@ -193,6 +193,6 @@ export class SearchableDocumentsApi extends BaseAPI {
193
193
  * @memberof SearchableDocumentsApi
194
194
  */
195
195
  public listSearchableDocuments(requestParameters: SearchableDocumentsApiListSearchableDocumentsRequest, options?: AxiosRequestConfig) {
196
- return SearchableDocumentsApiFp(this.configuration).listSearchableDocuments(requestParameters.searchText, requestParameters.ownerIds, requestParameters.authorization, requestParameters.product, options).then((request) => request(this.axios, this.basePath));
196
+ return SearchableDocumentsApiFp(this.configuration).listSearchableDocuments(requestParameters.searchText, requestParameters.ownerIds, requestParameters.product, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
197
197
  }
198
198
  }
@@ -19,7 +19,8 @@ import { InlineResponse200 } from '../models';
19
19
  */
20
20
  export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
21
21
  /**
22
- *
22
+ * Returns the health status of the document service. This endpoint is used to monitor the operational status of the document service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
23
+ * @summary Health Check
23
24
  * @param {*} [options] Override http request option.
24
25
  * @throws {RequiredError}
25
26
  */
@@ -31,7 +32,8 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
31
32
  */
32
33
  export declare const DefaultApiFp: (configuration?: Configuration) => {
33
34
  /**
34
- *
35
+ * Returns the health status of the document service. This endpoint is used to monitor the operational status of the document service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
36
+ * @summary Health Check
35
37
  * @param {*} [options] Override http request option.
36
38
  * @throws {RequiredError}
37
39
  */
@@ -43,7 +45,8 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
43
45
  */
44
46
  export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
45
47
  /**
46
- *
48
+ * Returns the health status of the document service. This endpoint is used to monitor the operational status of the document service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
49
+ * @summary Health Check
47
50
  * @param {*} [options] Override http request option.
48
51
  * @throws {RequiredError}
49
52
  */
@@ -57,7 +60,8 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
57
60
  */
58
61
  export declare class DefaultApi extends BaseAPI {
59
62
  /**
60
- *
63
+ * Returns the health status of the document service. This endpoint is used to monitor the operational status of the document service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
64
+ * @summary Health Check
61
65
  * @param {*} [options] Override http request option.
62
66
  * @throws {RequiredError}
63
67
  * @memberof DefaultApi
@@ -97,7 +97,8 @@ var DefaultApiAxiosParamCreator = function (configuration) {
97
97
  var _this = this;
98
98
  return {
99
99
  /**
100
- *
100
+ * Returns the health status of the document service. This endpoint is used to monitor the operational status of the document service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
101
+ * @summary Health Check
101
102
  * @param {*} [options] Override http request option.
102
103
  * @throws {RequiredError}
103
104
  */
@@ -136,7 +137,8 @@ var DefaultApiFp = function (configuration) {
136
137
  var localVarAxiosParamCreator = (0, exports.DefaultApiAxiosParamCreator)(configuration);
137
138
  return {
138
139
  /**
139
- *
140
+ * Returns the health status of the document service. This endpoint is used to monitor the operational status of the document service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
141
+ * @summary Health Check
140
142
  * @param {*} [options] Override http request option.
141
143
  * @throws {RequiredError}
142
144
  */
@@ -164,7 +166,8 @@ var DefaultApiFactory = function (configuration, basePath, axios) {
164
166
  var localVarFp = (0, exports.DefaultApiFp)(configuration);
165
167
  return {
166
168
  /**
167
- *
169
+ * Returns the health status of the document service. This endpoint is used to monitor the operational status of the document service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
170
+ * @summary Health Check
168
171
  * @param {*} [options] Override http request option.
169
172
  * @throws {RequiredError}
170
173
  */
@@ -186,7 +189,8 @@ var DefaultApi = /** @class */ (function (_super) {
186
189
  return _super !== null && _super.apply(this, arguments) || this;
187
190
  }
188
191
  /**
189
- *
192
+ * Returns the health status of the document service. This endpoint is used to monitor the operational status of the document service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
193
+ * @summary Health Check
190
194
  * @param {*} [options] Override http request option.
191
195
  * @throws {RequiredError}
192
196
  * @memberof DefaultApi
@@ -13,12 +13,7 @@ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
13
  import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
15
  import { CreateDocTemplateRequestDto } from '../models';
16
- import { CreateDocTemplateResponseClass } from '../models';
17
- import { DeleteResponseClass } from '../models';
18
- import { GetDocTemplateResponseClass } from '../models';
19
- import { ListDocTemplatesResponseClass } from '../models';
20
16
  import { UpdateDocTemplateRequestDto } from '../models';
21
- import { UpdateDocTemplateResponseClass } from '../models';
22
17
  /**
23
18
  * DocumentTemplatesApi - axios parameter creator
24
19
  * @export
@@ -43,29 +38,29 @@ export declare const DocumentTemplatesApiAxiosParamCreator: (configuration?: Con
43
38
  */
44
39
  deleteDocTemplate: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45
40
  /**
46
- * 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.
41
+ * 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.
47
42
  * @summary Retrieve the document template
48
43
  * @param {number} id
44
+ * @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.
49
45
  * @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.
51
46
  * @param {*} [options] Override http request option.
52
47
  * @throws {RequiredError}
53
48
  */
54
- getDocTemplate: (id: number, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
49
+ getDocTemplate: (id: number, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
55
50
  /**
56
- * 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.
51
+ * 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.
57
52
  * @summary List document templates
53
+ * @param {number} pageSize A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
54
+ * @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.
55
+ * @param {string} filter Filter response by productSlug, slug and name.
56
+ * @param {string} search Search document templates by name | slug
57
+ * @param {string} order Order response by createdAt.
58
+ * @param {string} expand Expand response by bodyTemplate.
58
59
  * @param {string} [authorization] Bearer Token
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.
61
- * @param {string} [filter] Filter response by productSlug, slug and name.
62
- * @param {string} [search] Search document templates by name | slug
63
- * @param {string} [order] Order response by createdAt.
64
- * @param {string} [expand] Expand response by bodyTemplate.
65
60
  * @param {*} [options] Override http request option.
66
61
  * @throws {RequiredError}
67
62
  */
68
- listDocTemplates: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
63
+ listDocTemplates: (pageSize: number, pageToken: string, filter: string, search: string, order: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
69
64
  /**
70
65
  * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
71
66
  * @summary Update the document template
@@ -90,7 +85,7 @@ export declare const DocumentTemplatesApiFp: (configuration?: Configuration) =>
90
85
  * @param {*} [options] Override http request option.
91
86
  * @throws {RequiredError}
92
87
  */
93
- createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDocTemplateResponseClass>>;
88
+ createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
94
89
  /**
95
90
  * Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it.
96
91
  * @summary Delete the document template
@@ -99,31 +94,31 @@ export declare const DocumentTemplatesApiFp: (configuration?: Configuration) =>
99
94
  * @param {*} [options] Override http request option.
100
95
  * @throws {RequiredError}
101
96
  */
102
- deleteDocTemplate(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
97
+ deleteDocTemplate(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
103
98
  /**
104
- * 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.
99
+ * 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.
105
100
  * @summary Retrieve the document template
106
101
  * @param {number} id
102
+ * @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.
107
103
  * @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.
109
104
  * @param {*} [options] Override http request option.
110
105
  * @throws {RequiredError}
111
106
  */
112
- getDocTemplate(id: number, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocTemplateResponseClass>>;
107
+ getDocTemplate(id: number, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
113
108
  /**
114
- * 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.
109
+ * 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.
115
110
  * @summary List document templates
111
+ * @param {number} pageSize A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
112
+ * @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.
113
+ * @param {string} filter Filter response by productSlug, slug and name.
114
+ * @param {string} search Search document templates by name | slug
115
+ * @param {string} order Order response by createdAt.
116
+ * @param {string} expand Expand response by bodyTemplate.
116
117
  * @param {string} [authorization] Bearer Token
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.
119
- * @param {string} [filter] Filter response by productSlug, slug and name.
120
- * @param {string} [search] Search document templates by name | slug
121
- * @param {string} [order] Order response by createdAt.
122
- * @param {string} [expand] Expand response by bodyTemplate.
123
118
  * @param {*} [options] Override http request option.
124
119
  * @throws {RequiredError}
125
120
  */
126
- listDocTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocTemplatesResponseClass>>;
121
+ listDocTemplates(pageSize: number, pageToken: string, filter: string, search: string, order: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
127
122
  /**
128
123
  * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
129
124
  * @summary Update the document template
@@ -133,7 +128,7 @@ export declare const DocumentTemplatesApiFp: (configuration?: Configuration) =>
133
128
  * @param {*} [options] Override http request option.
134
129
  * @throws {RequiredError}
135
130
  */
136
- updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateDocTemplateResponseClass>>;
131
+ updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
137
132
  };
138
133
  /**
139
134
  * DocumentTemplatesApi - factory interface
@@ -148,7 +143,7 @@ export declare const DocumentTemplatesApiFactory: (configuration?: Configuration
148
143
  * @param {*} [options] Override http request option.
149
144
  * @throws {RequiredError}
150
145
  */
151
- createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<CreateDocTemplateResponseClass>;
146
+ createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
152
147
  /**
153
148
  * Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it.
154
149
  * @summary Delete the document template
@@ -157,31 +152,31 @@ export declare const DocumentTemplatesApiFactory: (configuration?: Configuration
157
152
  * @param {*} [options] Override http request option.
158
153
  * @throws {RequiredError}
159
154
  */
160
- deleteDocTemplate(id: number, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
155
+ deleteDocTemplate(id: number, authorization?: string, options?: any): AxiosPromise<void>;
161
156
  /**
162
- * 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.
157
+ * 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.
163
158
  * @summary Retrieve the document template
164
159
  * @param {number} id
160
+ * @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.
165
161
  * @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.
167
162
  * @param {*} [options] Override http request option.
168
163
  * @throws {RequiredError}
169
164
  */
170
- getDocTemplate(id: number, authorization?: string, expand?: string, options?: any): AxiosPromise<GetDocTemplateResponseClass>;
165
+ getDocTemplate(id: number, expand: string, authorization?: string, options?: any): AxiosPromise<void>;
171
166
  /**
172
- * 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.
167
+ * 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.
173
168
  * @summary List document templates
169
+ * @param {number} pageSize A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
170
+ * @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.
171
+ * @param {string} filter Filter response by productSlug, slug and name.
172
+ * @param {string} search Search document templates by name | slug
173
+ * @param {string} order Order response by createdAt.
174
+ * @param {string} expand Expand response by bodyTemplate.
174
175
  * @param {string} [authorization] Bearer Token
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.
177
- * @param {string} [filter] Filter response by productSlug, slug and name.
178
- * @param {string} [search] Search document templates by name | slug
179
- * @param {string} [order] Order response by createdAt.
180
- * @param {string} [expand] Expand response by bodyTemplate.
181
176
  * @param {*} [options] Override http request option.
182
177
  * @throws {RequiredError}
183
178
  */
184
- listDocTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListDocTemplatesResponseClass>;
179
+ listDocTemplates(pageSize: number, pageToken: string, filter: string, search: string, order: string, expand: string, authorization?: string, options?: any): AxiosPromise<void>;
185
180
  /**
186
181
  * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
187
182
  * @summary Update the document template
@@ -191,7 +186,7 @@ export declare const DocumentTemplatesApiFactory: (configuration?: Configuration
191
186
  * @param {*} [options] Override http request option.
192
187
  * @throws {RequiredError}
193
188
  */
194
- updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateDocTemplateResponseClass>;
189
+ updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
195
190
  };
196
191
  /**
197
192
  * Request parameters for createDocTemplate operation in DocumentTemplatesApi.
@@ -244,17 +239,17 @@ export interface DocumentTemplatesApiGetDocTemplateRequest {
244
239
  */
245
240
  readonly id: number;
246
241
  /**
247
- * Bearer Token
242
+ * 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.
248
243
  * @type {string}
249
244
  * @memberof DocumentTemplatesApiGetDocTemplate
250
245
  */
251
- readonly authorization?: string;
246
+ readonly expand: string;
252
247
  /**
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.
248
+ * Bearer Token
254
249
  * @type {string}
255
250
  * @memberof DocumentTemplatesApiGetDocTemplate
256
251
  */
257
- readonly expand?: string;
252
+ readonly authorization?: string;
258
253
  }
259
254
  /**
260
255
  * Request parameters for listDocTemplates operation in DocumentTemplatesApi.
@@ -262,48 +257,48 @@ export interface DocumentTemplatesApiGetDocTemplateRequest {
262
257
  * @interface DocumentTemplatesApiListDocTemplatesRequest
263
258
  */
264
259
  export interface DocumentTemplatesApiListDocTemplatesRequest {
265
- /**
266
- * Bearer Token
267
- * @type {string}
268
- * @memberof DocumentTemplatesApiListDocTemplates
269
- */
270
- readonly authorization?: string;
271
260
  /**
272
261
  * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
273
262
  * @type {number}
274
263
  * @memberof DocumentTemplatesApiListDocTemplates
275
264
  */
276
- readonly pageSize?: number;
265
+ readonly pageSize: number;
277
266
  /**
278
267
  * 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
268
  * @type {string}
280
269
  * @memberof DocumentTemplatesApiListDocTemplates
281
270
  */
282
- readonly pageToken?: string;
271
+ readonly pageToken: string;
283
272
  /**
284
273
  * Filter response by productSlug, slug and name.
285
274
  * @type {string}
286
275
  * @memberof DocumentTemplatesApiListDocTemplates
287
276
  */
288
- readonly filter?: string;
277
+ readonly filter: string;
289
278
  /**
290
279
  * Search document templates by name | slug
291
280
  * @type {string}
292
281
  * @memberof DocumentTemplatesApiListDocTemplates
293
282
  */
294
- readonly search?: string;
283
+ readonly search: string;
295
284
  /**
296
285
  * Order response by createdAt.
297
286
  * @type {string}
298
287
  * @memberof DocumentTemplatesApiListDocTemplates
299
288
  */
300
- readonly order?: string;
289
+ readonly order: string;
301
290
  /**
302
291
  * Expand response by bodyTemplate.
303
292
  * @type {string}
304
293
  * @memberof DocumentTemplatesApiListDocTemplates
305
294
  */
306
- readonly expand?: string;
295
+ readonly expand: string;
296
+ /**
297
+ * Bearer Token
298
+ * @type {string}
299
+ * @memberof DocumentTemplatesApiListDocTemplates
300
+ */
301
+ readonly authorization?: string;
307
302
  }
308
303
  /**
309
304
  * Request parameters for updateDocTemplate operation in DocumentTemplatesApi.
@@ -345,7 +340,7 @@ export declare class DocumentTemplatesApi extends BaseAPI {
345
340
  * @throws {RequiredError}
346
341
  * @memberof DocumentTemplatesApi
347
342
  */
348
- createDocTemplate(requestParameters: DocumentTemplatesApiCreateDocTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateDocTemplateResponseClass, any>>;
343
+ createDocTemplate(requestParameters: DocumentTemplatesApiCreateDocTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
349
344
  /**
350
345
  * Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it.
351
346
  * @summary Delete the document template
@@ -354,25 +349,25 @@ export declare class DocumentTemplatesApi extends BaseAPI {
354
349
  * @throws {RequiredError}
355
350
  * @memberof DocumentTemplatesApi
356
351
  */
357
- deleteDocTemplate(requestParameters: DocumentTemplatesApiDeleteDocTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
352
+ deleteDocTemplate(requestParameters: DocumentTemplatesApiDeleteDocTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
358
353
  /**
359
- * 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.
354
+ * 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.
360
355
  * @summary Retrieve the document template
361
356
  * @param {DocumentTemplatesApiGetDocTemplateRequest} requestParameters Request parameters.
362
357
  * @param {*} [options] Override http request option.
363
358
  * @throws {RequiredError}
364
359
  * @memberof DocumentTemplatesApi
365
360
  */
366
- getDocTemplate(requestParameters: DocumentTemplatesApiGetDocTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDocTemplateResponseClass, any>>;
361
+ getDocTemplate(requestParameters: DocumentTemplatesApiGetDocTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
367
362
  /**
368
- * 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.
363
+ * 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.
369
364
  * @summary List document templates
370
365
  * @param {DocumentTemplatesApiListDocTemplatesRequest} requestParameters Request parameters.
371
366
  * @param {*} [options] Override http request option.
372
367
  * @throws {RequiredError}
373
368
  * @memberof DocumentTemplatesApi
374
369
  */
375
- listDocTemplates(requestParameters?: DocumentTemplatesApiListDocTemplatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDocTemplatesResponseClass, any>>;
370
+ listDocTemplates(requestParameters: DocumentTemplatesApiListDocTemplatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
376
371
  /**
377
372
  * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
378
373
  * @summary Update the document template
@@ -381,5 +376,5 @@ export declare class DocumentTemplatesApi extends BaseAPI {
381
376
  * @throws {RequiredError}
382
377
  * @memberof DocumentTemplatesApi
383
378
  */
384
- updateDocTemplate(requestParameters: DocumentTemplatesApiUpdateDocTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateDocTemplateResponseClass, any>>;
379
+ updateDocTemplate(requestParameters: DocumentTemplatesApiUpdateDocTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
385
380
  }