@emilgroup/document-sdk 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +61 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/README.md +68 -0
- package/api/document-templates-api.ts +669 -0
- package/api/documents-api.ts +880 -0
- package/api/layouts-api.ts +685 -0
- package/api/search-keywords-api.ts +168 -0
- package/api/searchable-document-owners-api.ts +236 -0
- package/api/searchable-documents-api.ts +184 -0
- package/api.ts +41 -0
- package/base.ts +284 -0
- package/common.ts +199 -0
- package/configuration.ts +109 -0
- package/dist/api/document-templates-api.d.ts +376 -0
- package/dist/api/document-templates-api.js +634 -0
- package/dist/api/documents-api.d.ts +488 -0
- package/dist/api/documents-api.js +821 -0
- package/dist/api/layouts-api.d.ts +385 -0
- package/dist/api/layouts-api.js +642 -0
- package/dist/api/search-keywords-api.d.ts +96 -0
- package/dist/api/search-keywords-api.js +229 -0
- package/dist/api/searchable-document-owners-api.d.ts +141 -0
- package/dist/api/searchable-document-owners-api.js +258 -0
- package/dist/api/searchable-documents-api.d.ts +105 -0
- package/dist/api/searchable-documents-api.js +237 -0
- package/dist/api.d.ts +17 -0
- package/dist/api.js +35 -0
- package/dist/base.d.ts +77 -0
- package/dist/base.js +393 -0
- package/dist/common.d.ts +92 -0
- package/dist/common.js +277 -0
- package/dist/configuration.d.ts +90 -0
- package/dist/configuration.js +44 -0
- package/dist/index.d.ts +15 -0
- package/dist/index.js +36 -0
- package/dist/models/create-doc-template-request-dto.d.ts +49 -0
- package/dist/models/create-doc-template-request-dto.js +15 -0
- package/dist/models/create-doc-template-response-class.d.ts +25 -0
- package/dist/models/create-doc-template-response-class.js +15 -0
- package/dist/models/create-document-request-dto.d.ts +155 -0
- package/dist/models/create-document-request-dto.js +65 -0
- package/dist/models/create-document-sync-response-class.d.ts +25 -0
- package/dist/models/create-document-sync-response-class.js +15 -0
- package/dist/models/create-html-template-dto.d.ts +24 -0
- package/dist/models/create-html-template-dto.js +15 -0
- package/dist/models/create-layout-request-dto.d.ts +49 -0
- package/dist/models/create-layout-request-dto.js +15 -0
- package/dist/models/create-layout-response-class.d.ts +25 -0
- package/dist/models/create-layout-response-class.js +15 -0
- package/dist/models/create-presigned-post-request-dto.d.ts +127 -0
- package/dist/models/create-presigned-post-request-dto.js +51 -0
- package/dist/models/create-presigned-post-response-class.d.ts +30 -0
- package/dist/models/create-presigned-post-response-class.js +15 -0
- package/dist/models/delete-layout-request-dto.d.ts +24 -0
- package/dist/models/delete-layout-request-dto.js +15 -0
- package/dist/models/delete-request-dto.d.ts +24 -0
- package/dist/models/delete-request-dto.js +15 -0
- package/dist/models/delete-response-class.d.ts +24 -0
- package/dist/models/delete-response-class.js +15 -0
- package/dist/models/doc-template-class.d.ts +86 -0
- package/dist/models/doc-template-class.js +15 -0
- package/dist/models/document-class.d.ts +162 -0
- package/dist/models/document-class.js +61 -0
- package/dist/models/download-document-request-dto.d.ts +30 -0
- package/dist/models/download-document-request-dto.js +15 -0
- package/dist/models/get-doc-template-request-dto.d.ts +30 -0
- package/dist/models/get-doc-template-request-dto.js +15 -0
- package/dist/models/get-doc-template-response-class.d.ts +25 -0
- package/dist/models/get-doc-template-response-class.js +15 -0
- package/dist/models/get-document-download-url-response-class.d.ts +24 -0
- package/dist/models/get-document-download-url-response-class.js +15 -0
- package/dist/models/get-layout-request-dto.d.ts +24 -0
- package/dist/models/get-layout-request-dto.js +15 -0
- package/dist/models/get-layout-response-class.d.ts +25 -0
- package/dist/models/get-layout-response-class.js +15 -0
- package/dist/models/get-signed-s3-key-url-response-class.d.ts +24 -0
- package/dist/models/get-signed-s3-key-url-response-class.js +15 -0
- package/dist/models/html-template-class.d.ts +66 -0
- package/dist/models/html-template-class.js +21 -0
- package/dist/models/index.d.ts +42 -0
- package/dist/models/index.js +58 -0
- package/dist/models/layout-class.d.ts +79 -0
- package/dist/models/layout-class.js +15 -0
- package/dist/models/list-doc-template-request-dto.d.ts +48 -0
- package/dist/models/list-doc-template-request-dto.js +15 -0
- package/dist/models/list-doc-templates-response-class.d.ts +31 -0
- package/dist/models/list-doc-templates-response-class.js +15 -0
- package/dist/models/list-documents-response-class.d.ts +31 -0
- package/dist/models/list-documents-response-class.js +15 -0
- package/dist/models/list-layouts-response-class.d.ts +31 -0
- package/dist/models/list-layouts-response-class.js +15 -0
- package/dist/models/list-request-dto.d.ts +54 -0
- package/dist/models/list-request-dto.js +15 -0
- package/dist/models/list-search-keywords-request-dto.d.ts +24 -0
- package/dist/models/list-search-keywords-request-dto.js +15 -0
- package/dist/models/list-search-keywords-response-class.d.ts +24 -0
- package/dist/models/list-search-keywords-response-class.js +15 -0
- package/dist/models/list-searchable-document-owners-response-class.d.ts +25 -0
- package/dist/models/list-searchable-document-owners-response-class.js +15 -0
- package/dist/models/list-searchable-documents-request-dto.d.ts +30 -0
- package/dist/models/list-searchable-documents-request-dto.js +15 -0
- package/dist/models/list-searchable-documents-response-class.d.ts +31 -0
- package/dist/models/list-searchable-documents-response-class.js +15 -0
- package/dist/models/searchable-document-class.d.ts +66 -0
- package/dist/models/searchable-document-class.js +15 -0
- package/dist/models/searchable-document-owner-class.d.ts +30 -0
- package/dist/models/searchable-document-owner-class.js +15 -0
- package/dist/models/update-doc-template-request-dto.d.ts +55 -0
- package/dist/models/update-doc-template-request-dto.js +15 -0
- package/dist/models/update-doc-template-response-class.d.ts +25 -0
- package/dist/models/update-doc-template-response-class.js +15 -0
- package/dist/models/update-document-request-dto.d.ts +54 -0
- package/dist/models/update-document-request-dto.js +15 -0
- package/dist/models/update-document-response-class.d.ts +25 -0
- package/dist/models/update-document-response-class.js +15 -0
- package/dist/models/update-html-template-dto.d.ts +42 -0
- package/dist/models/update-html-template-dto.js +21 -0
- package/dist/models/update-layout-request-dto.d.ts +55 -0
- package/dist/models/update-layout-request-dto.js +15 -0
- package/dist/models/update-layout-response-class.d.ts +25 -0
- package/dist/models/update-layout-response-class.js +15 -0
- package/git_push.sh +57 -0
- package/index.ts +19 -0
- package/models/create-doc-template-request-dto.ts +55 -0
- package/models/create-doc-template-response-class.ts +31 -0
- package/models/create-document-request-dto.ts +167 -0
- package/models/create-document-sync-response-class.ts +31 -0
- package/models/create-html-template-dto.ts +30 -0
- package/models/create-layout-request-dto.ts +55 -0
- package/models/create-layout-response-class.ts +31 -0
- package/models/create-presigned-post-request-dto.ts +137 -0
- package/models/create-presigned-post-response-class.ts +36 -0
- package/models/delete-layout-request-dto.ts +30 -0
- package/models/delete-request-dto.ts +30 -0
- package/models/delete-response-class.ts +30 -0
- package/models/doc-template-class.ts +92 -0
- package/models/document-class.ts +173 -0
- package/models/download-document-request-dto.ts +36 -0
- package/models/get-doc-template-request-dto.ts +36 -0
- package/models/get-doc-template-response-class.ts +31 -0
- package/models/get-document-download-url-response-class.ts +30 -0
- package/models/get-layout-request-dto.ts +30 -0
- package/models/get-layout-response-class.ts +31 -0
- package/models/get-signed-s3-key-url-response-class.ts +30 -0
- package/models/html-template-class.ts +75 -0
- package/models/index.ts +42 -0
- package/models/layout-class.ts +85 -0
- package/models/list-doc-template-request-dto.ts +54 -0
- package/models/list-doc-templates-response-class.ts +37 -0
- package/models/list-documents-response-class.ts +37 -0
- package/models/list-layouts-response-class.ts +37 -0
- package/models/list-request-dto.ts +60 -0
- package/models/list-search-keywords-request-dto.ts +30 -0
- package/models/list-search-keywords-response-class.ts +30 -0
- package/models/list-searchable-document-owners-response-class.ts +31 -0
- package/models/list-searchable-documents-request-dto.ts +36 -0
- package/models/list-searchable-documents-response-class.ts +37 -0
- package/models/searchable-document-class.ts +72 -0
- package/models/searchable-document-owner-class.ts +36 -0
- package/models/update-doc-template-request-dto.ts +61 -0
- package/models/update-doc-template-response-class.ts +31 -0
- package/models/update-document-request-dto.ts +60 -0
- package/models/update-document-response-class.ts +31 -0
- package/models/update-html-template-dto.ts +51 -0
- package/models/update-layout-request-dto.ts +61 -0
- package/models/update-layout-response-class.ts +31 -0
- package/package.json +29 -0
- package/tsconfig.json +22 -0
|
@@ -0,0 +1,669 @@
|
|
|
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
|
+
*
|
|
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 globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
17
|
+
import { Configuration } from '../configuration';
|
|
18
|
+
// Some imports not used depending on template conditions
|
|
19
|
+
// @ts-ignore
|
|
20
|
+
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
|
|
21
|
+
// @ts-ignore
|
|
22
|
+
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
|
|
23
|
+
// @ts-ignore
|
|
24
|
+
import { CreateDocTemplateRequestDto } from '../models';
|
|
25
|
+
// @ts-ignore
|
|
26
|
+
import { CreateDocTemplateResponseClass } from '../models';
|
|
27
|
+
// @ts-ignore
|
|
28
|
+
import { DeleteResponseClass } from '../models';
|
|
29
|
+
// @ts-ignore
|
|
30
|
+
import { GetDocTemplateResponseClass } from '../models';
|
|
31
|
+
// @ts-ignore
|
|
32
|
+
import { ListDocTemplatesResponseClass } from '../models';
|
|
33
|
+
// @ts-ignore
|
|
34
|
+
import { UpdateDocTemplateRequestDto } from '../models';
|
|
35
|
+
// @ts-ignore
|
|
36
|
+
import { UpdateDocTemplateResponseClass } from '../models';
|
|
37
|
+
// URLSearchParams not necessarily used
|
|
38
|
+
// @ts-ignore
|
|
39
|
+
import { URL, URLSearchParams } from 'url';
|
|
40
|
+
const FormData = require('form-data');
|
|
41
|
+
/**
|
|
42
|
+
* DocumentTemplatesApi - axios parameter creator
|
|
43
|
+
* @export
|
|
44
|
+
*/
|
|
45
|
+
export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
46
|
+
return {
|
|
47
|
+
/**
|
|
48
|
+
* This will create a document template.
|
|
49
|
+
* @summary Create the document template
|
|
50
|
+
* @param {CreateDocTemplateRequestDto} createDocTemplateRequestDto
|
|
51
|
+
* @param {string} [authorization] Bearer Token
|
|
52
|
+
* @param {*} [options] Override http request option.
|
|
53
|
+
* @throws {RequiredError}
|
|
54
|
+
*/
|
|
55
|
+
createDocTemplate: async (createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
56
|
+
// verify required parameter 'createDocTemplateRequestDto' is not null or undefined
|
|
57
|
+
assertParamExists('createDocTemplate', 'createDocTemplateRequestDto', createDocTemplateRequestDto)
|
|
58
|
+
const localVarPath = `/documentservice/v1/doc-templates`;
|
|
59
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
60
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
61
|
+
let baseOptions;
|
|
62
|
+
let baseAccessToken;
|
|
63
|
+
if (configuration) {
|
|
64
|
+
baseOptions = configuration.baseOptions;
|
|
65
|
+
baseAccessToken = configuration.accessToken;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
69
|
+
const localVarHeaderParameter = {} as any;
|
|
70
|
+
const localVarQueryParameter = {} as any;
|
|
71
|
+
|
|
72
|
+
// authentication bearer required
|
|
73
|
+
// http bearer authentication required
|
|
74
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
75
|
+
|
|
76
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
77
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
83
|
+
|
|
84
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
85
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
86
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
87
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createDocTemplateRequestDto, localVarRequestOptions, configuration)
|
|
88
|
+
|
|
89
|
+
return {
|
|
90
|
+
url: toPathString(localVarUrlObj),
|
|
91
|
+
options: localVarRequestOptions,
|
|
92
|
+
};
|
|
93
|
+
},
|
|
94
|
+
/**
|
|
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
|
|
97
|
+
* @param {number} id
|
|
98
|
+
* @param {string} [authorization] Bearer Token
|
|
99
|
+
* @param {*} [options] Override http request option.
|
|
100
|
+
* @throws {RequiredError}
|
|
101
|
+
*/
|
|
102
|
+
deleteDocTemplate: async (id: number, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
103
|
+
// verify required parameter 'id' is not null or undefined
|
|
104
|
+
assertParamExists('deleteDocTemplate', 'id', id)
|
|
105
|
+
const localVarPath = `/documentservice/v1/doc-templates/{id}`
|
|
106
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
107
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
108
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
109
|
+
let baseOptions;
|
|
110
|
+
let baseAccessToken;
|
|
111
|
+
if (configuration) {
|
|
112
|
+
baseOptions = configuration.baseOptions;
|
|
113
|
+
baseAccessToken = configuration.accessToken;
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
117
|
+
const localVarHeaderParameter = {} as any;
|
|
118
|
+
const localVarQueryParameter = {} as any;
|
|
119
|
+
|
|
120
|
+
// authentication bearer required
|
|
121
|
+
// http bearer authentication required
|
|
122
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
123
|
+
|
|
124
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
125
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
131
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
132
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
133
|
+
|
|
134
|
+
return {
|
|
135
|
+
url: toPathString(localVarUrlObj),
|
|
136
|
+
options: localVarRequestOptions,
|
|
137
|
+
};
|
|
138
|
+
},
|
|
139
|
+
/**
|
|
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
|
|
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.
|
|
145
|
+
* @param {*} [options] Override http request option.
|
|
146
|
+
* @throws {RequiredError}
|
|
147
|
+
*/
|
|
148
|
+
getDocTemplate: async (id: number, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
149
|
+
// verify required parameter 'id' is not null or undefined
|
|
150
|
+
assertParamExists('getDocTemplate', 'id', id)
|
|
151
|
+
const localVarPath = `/documentservice/v1/doc-templates/{id}`
|
|
152
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
153
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
154
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
155
|
+
let baseOptions;
|
|
156
|
+
let baseAccessToken;
|
|
157
|
+
if (configuration) {
|
|
158
|
+
baseOptions = configuration.baseOptions;
|
|
159
|
+
baseAccessToken = configuration.accessToken;
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
163
|
+
const localVarHeaderParameter = {} as any;
|
|
164
|
+
const localVarQueryParameter = {} as any;
|
|
165
|
+
|
|
166
|
+
// authentication bearer required
|
|
167
|
+
// http bearer authentication required
|
|
168
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
169
|
+
|
|
170
|
+
if (expand !== undefined) {
|
|
171
|
+
localVarQueryParameter['expand'] = expand;
|
|
172
|
+
}
|
|
173
|
+
|
|
174
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
175
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
181
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
182
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
183
|
+
|
|
184
|
+
return {
|
|
185
|
+
url: toPathString(localVarUrlObj),
|
|
186
|
+
options: localVarRequestOptions,
|
|
187
|
+
};
|
|
188
|
+
},
|
|
189
|
+
/**
|
|
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
|
|
192
|
+
* @param {string} [authorization] Bearer Token
|
|
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.
|
|
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
|
+
* @param {*} [options] Override http request option.
|
|
199
|
+
* @throws {RequiredError}
|
|
200
|
+
*/
|
|
201
|
+
listDocTemplates: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
202
|
+
const localVarPath = `/documentservice/v1/doc-templates`;
|
|
203
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
204
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
205
|
+
let baseOptions;
|
|
206
|
+
let baseAccessToken;
|
|
207
|
+
if (configuration) {
|
|
208
|
+
baseOptions = configuration.baseOptions;
|
|
209
|
+
baseAccessToken = configuration.accessToken;
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
213
|
+
const localVarHeaderParameter = {} as any;
|
|
214
|
+
const localVarQueryParameter = {} as any;
|
|
215
|
+
|
|
216
|
+
// authentication bearer required
|
|
217
|
+
// http bearer authentication required
|
|
218
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
219
|
+
|
|
220
|
+
if (pageSize !== undefined) {
|
|
221
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
if (pageToken !== undefined) {
|
|
225
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
226
|
+
}
|
|
227
|
+
|
|
228
|
+
if (filter !== undefined) {
|
|
229
|
+
localVarQueryParameter['filter'] = filter;
|
|
230
|
+
}
|
|
231
|
+
|
|
232
|
+
if (order !== undefined) {
|
|
233
|
+
localVarQueryParameter['order'] = order;
|
|
234
|
+
}
|
|
235
|
+
|
|
236
|
+
if (expand !== undefined) {
|
|
237
|
+
localVarQueryParameter['expand'] = expand;
|
|
238
|
+
}
|
|
239
|
+
|
|
240
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
241
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
242
|
+
}
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
247
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
248
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
249
|
+
|
|
250
|
+
return {
|
|
251
|
+
url: toPathString(localVarUrlObj),
|
|
252
|
+
options: localVarRequestOptions,
|
|
253
|
+
};
|
|
254
|
+
},
|
|
255
|
+
/**
|
|
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
|
|
258
|
+
* @param {number} id
|
|
259
|
+
* @param {UpdateDocTemplateRequestDto} updateDocTemplateRequestDto
|
|
260
|
+
* @param {string} [authorization] Bearer Token
|
|
261
|
+
* @param {*} [options] Override http request option.
|
|
262
|
+
* @throws {RequiredError}
|
|
263
|
+
*/
|
|
264
|
+
updateDocTemplate: async (id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
265
|
+
// verify required parameter 'id' is not null or undefined
|
|
266
|
+
assertParamExists('updateDocTemplate', 'id', id)
|
|
267
|
+
// verify required parameter 'updateDocTemplateRequestDto' is not null or undefined
|
|
268
|
+
assertParamExists('updateDocTemplate', 'updateDocTemplateRequestDto', updateDocTemplateRequestDto)
|
|
269
|
+
const localVarPath = `/documentservice/v1/doc-templates/{id}`
|
|
270
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
271
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
272
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
273
|
+
let baseOptions;
|
|
274
|
+
let baseAccessToken;
|
|
275
|
+
if (configuration) {
|
|
276
|
+
baseOptions = configuration.baseOptions;
|
|
277
|
+
baseAccessToken = configuration.accessToken;
|
|
278
|
+
}
|
|
279
|
+
|
|
280
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
281
|
+
const localVarHeaderParameter = {} as any;
|
|
282
|
+
const localVarQueryParameter = {} as any;
|
|
283
|
+
|
|
284
|
+
// authentication bearer required
|
|
285
|
+
// http bearer authentication required
|
|
286
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
287
|
+
|
|
288
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
289
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
290
|
+
}
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
295
|
+
|
|
296
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
297
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
298
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
299
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateDocTemplateRequestDto, localVarRequestOptions, configuration)
|
|
300
|
+
|
|
301
|
+
return {
|
|
302
|
+
url: toPathString(localVarUrlObj),
|
|
303
|
+
options: localVarRequestOptions,
|
|
304
|
+
};
|
|
305
|
+
},
|
|
306
|
+
}
|
|
307
|
+
};
|
|
308
|
+
|
|
309
|
+
/**
|
|
310
|
+
* DocumentTemplatesApi - functional programming interface
|
|
311
|
+
* @export
|
|
312
|
+
*/
|
|
313
|
+
export const DocumentTemplatesApiFp = function(configuration?: Configuration) {
|
|
314
|
+
const localVarAxiosParamCreator = DocumentTemplatesApiAxiosParamCreator(configuration)
|
|
315
|
+
return {
|
|
316
|
+
/**
|
|
317
|
+
* This will create a document template.
|
|
318
|
+
* @summary Create the document template
|
|
319
|
+
* @param {CreateDocTemplateRequestDto} createDocTemplateRequestDto
|
|
320
|
+
* @param {string} [authorization] Bearer Token
|
|
321
|
+
* @param {*} [options] Override http request option.
|
|
322
|
+
* @throws {RequiredError}
|
|
323
|
+
*/
|
|
324
|
+
async createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDocTemplateResponseClass>> {
|
|
325
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createDocTemplate(createDocTemplateRequestDto, authorization, options);
|
|
326
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
327
|
+
},
|
|
328
|
+
/**
|
|
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
|
|
331
|
+
* @param {number} id
|
|
332
|
+
* @param {string} [authorization] Bearer Token
|
|
333
|
+
* @param {*} [options] Override http request option.
|
|
334
|
+
* @throws {RequiredError}
|
|
335
|
+
*/
|
|
336
|
+
async deleteDocTemplate(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>> {
|
|
337
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDocTemplate(id, authorization, options);
|
|
338
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
339
|
+
},
|
|
340
|
+
/**
|
|
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
|
|
344
|
+
* @param {string} [authorization] Bearer Token
|
|
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.
|
|
346
|
+
* @param {*} [options] Override http request option.
|
|
347
|
+
* @throws {RequiredError}
|
|
348
|
+
*/
|
|
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);
|
|
351
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
352
|
+
},
|
|
353
|
+
/**
|
|
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
|
+
* @param {string} [authorization] Bearer Token
|
|
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=1, your subsequent call can include pageToken=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.
|
|
362
|
+
* @param {*} [options] Override http request option.
|
|
363
|
+
* @throws {RequiredError}
|
|
364
|
+
*/
|
|
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);
|
|
367
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
368
|
+
},
|
|
369
|
+
/**
|
|
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
|
+
* @param {number} id
|
|
373
|
+
* @param {UpdateDocTemplateRequestDto} updateDocTemplateRequestDto
|
|
374
|
+
* @param {string} [authorization] Bearer Token
|
|
375
|
+
* @param {*} [options] Override http request option.
|
|
376
|
+
* @throws {RequiredError}
|
|
377
|
+
*/
|
|
378
|
+
async updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateDocTemplateResponseClass>> {
|
|
379
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateDocTemplate(id, updateDocTemplateRequestDto, authorization, options);
|
|
380
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
381
|
+
},
|
|
382
|
+
}
|
|
383
|
+
};
|
|
384
|
+
|
|
385
|
+
/**
|
|
386
|
+
* DocumentTemplatesApi - factory interface
|
|
387
|
+
* @export
|
|
388
|
+
*/
|
|
389
|
+
export const DocumentTemplatesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
390
|
+
const localVarFp = DocumentTemplatesApiFp(configuration)
|
|
391
|
+
return {
|
|
392
|
+
/**
|
|
393
|
+
* This will create a document template.
|
|
394
|
+
* @summary Create the document template
|
|
395
|
+
* @param {CreateDocTemplateRequestDto} createDocTemplateRequestDto
|
|
396
|
+
* @param {string} [authorization] Bearer Token
|
|
397
|
+
* @param {*} [options] Override http request option.
|
|
398
|
+
* @throws {RequiredError}
|
|
399
|
+
*/
|
|
400
|
+
createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<CreateDocTemplateResponseClass> {
|
|
401
|
+
return localVarFp.createDocTemplate(createDocTemplateRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
402
|
+
},
|
|
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
|
|
406
|
+
* @param {number} id
|
|
407
|
+
* @param {string} [authorization] Bearer Token
|
|
408
|
+
* @param {*} [options] Override http request option.
|
|
409
|
+
* @throws {RequiredError}
|
|
410
|
+
*/
|
|
411
|
+
deleteDocTemplate(id: number, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass> {
|
|
412
|
+
return localVarFp.deleteDocTemplate(id, authorization, options).then((request) => request(axios, basePath));
|
|
413
|
+
},
|
|
414
|
+
/**
|
|
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
|
|
418
|
+
* @param {string} [authorization] Bearer Token
|
|
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.
|
|
420
|
+
* @param {*} [options] Override http request option.
|
|
421
|
+
* @throws {RequiredError}
|
|
422
|
+
*/
|
|
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));
|
|
425
|
+
},
|
|
426
|
+
/**
|
|
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
|
|
429
|
+
* @param {string} [authorization] Bearer Token
|
|
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=1, your subsequent call can include pageToken=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.
|
|
435
|
+
* @param {*} [options] Override http request option.
|
|
436
|
+
* @throws {RequiredError}
|
|
437
|
+
*/
|
|
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));
|
|
440
|
+
},
|
|
441
|
+
/**
|
|
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
|
|
444
|
+
* @param {number} id
|
|
445
|
+
* @param {UpdateDocTemplateRequestDto} updateDocTemplateRequestDto
|
|
446
|
+
* @param {string} [authorization] Bearer Token
|
|
447
|
+
* @param {*} [options] Override http request option.
|
|
448
|
+
* @throws {RequiredError}
|
|
449
|
+
*/
|
|
450
|
+
updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateDocTemplateResponseClass> {
|
|
451
|
+
return localVarFp.updateDocTemplate(id, updateDocTemplateRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
452
|
+
},
|
|
453
|
+
};
|
|
454
|
+
};
|
|
455
|
+
|
|
456
|
+
/**
|
|
457
|
+
* Request parameters for createDocTemplate operation in DocumentTemplatesApi.
|
|
458
|
+
* @export
|
|
459
|
+
* @interface DocumentTemplatesApiCreateDocTemplateRequest
|
|
460
|
+
*/
|
|
461
|
+
export interface DocumentTemplatesApiCreateDocTemplateRequest {
|
|
462
|
+
/**
|
|
463
|
+
*
|
|
464
|
+
* @type {CreateDocTemplateRequestDto}
|
|
465
|
+
* @memberof DocumentTemplatesApiCreateDocTemplate
|
|
466
|
+
*/
|
|
467
|
+
readonly createDocTemplateRequestDto: CreateDocTemplateRequestDto
|
|
468
|
+
|
|
469
|
+
/**
|
|
470
|
+
* Bearer Token
|
|
471
|
+
* @type {string}
|
|
472
|
+
* @memberof DocumentTemplatesApiCreateDocTemplate
|
|
473
|
+
*/
|
|
474
|
+
readonly authorization?: string
|
|
475
|
+
}
|
|
476
|
+
|
|
477
|
+
/**
|
|
478
|
+
* Request parameters for deleteDocTemplate operation in DocumentTemplatesApi.
|
|
479
|
+
* @export
|
|
480
|
+
* @interface DocumentTemplatesApiDeleteDocTemplateRequest
|
|
481
|
+
*/
|
|
482
|
+
export interface DocumentTemplatesApiDeleteDocTemplateRequest {
|
|
483
|
+
/**
|
|
484
|
+
*
|
|
485
|
+
* @type {number}
|
|
486
|
+
* @memberof DocumentTemplatesApiDeleteDocTemplate
|
|
487
|
+
*/
|
|
488
|
+
readonly id: number
|
|
489
|
+
|
|
490
|
+
/**
|
|
491
|
+
* Bearer Token
|
|
492
|
+
* @type {string}
|
|
493
|
+
* @memberof DocumentTemplatesApiDeleteDocTemplate
|
|
494
|
+
*/
|
|
495
|
+
readonly authorization?: string
|
|
496
|
+
}
|
|
497
|
+
|
|
498
|
+
/**
|
|
499
|
+
* Request parameters for getDocTemplate operation in DocumentTemplatesApi.
|
|
500
|
+
* @export
|
|
501
|
+
* @interface DocumentTemplatesApiGetDocTemplateRequest
|
|
502
|
+
*/
|
|
503
|
+
export interface DocumentTemplatesApiGetDocTemplateRequest {
|
|
504
|
+
/**
|
|
505
|
+
*
|
|
506
|
+
* @type {number}
|
|
507
|
+
* @memberof DocumentTemplatesApiGetDocTemplate
|
|
508
|
+
*/
|
|
509
|
+
readonly id: number
|
|
510
|
+
|
|
511
|
+
/**
|
|
512
|
+
* Bearer Token
|
|
513
|
+
* @type {string}
|
|
514
|
+
* @memberof DocumentTemplatesApiGetDocTemplate
|
|
515
|
+
*/
|
|
516
|
+
readonly authorization?: string
|
|
517
|
+
|
|
518
|
+
/**
|
|
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.
|
|
520
|
+
* @type {string}
|
|
521
|
+
* @memberof DocumentTemplatesApiGetDocTemplate
|
|
522
|
+
*/
|
|
523
|
+
readonly expand?: string
|
|
524
|
+
}
|
|
525
|
+
|
|
526
|
+
/**
|
|
527
|
+
* Request parameters for listDocTemplates operation in DocumentTemplatesApi.
|
|
528
|
+
* @export
|
|
529
|
+
* @interface DocumentTemplatesApiListDocTemplatesRequest
|
|
530
|
+
*/
|
|
531
|
+
export interface DocumentTemplatesApiListDocTemplatesRequest {
|
|
532
|
+
/**
|
|
533
|
+
* Bearer Token
|
|
534
|
+
* @type {string}
|
|
535
|
+
* @memberof DocumentTemplatesApiListDocTemplates
|
|
536
|
+
*/
|
|
537
|
+
readonly authorization?: string
|
|
538
|
+
|
|
539
|
+
/**
|
|
540
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
541
|
+
* @type {number}
|
|
542
|
+
* @memberof DocumentTemplatesApiListDocTemplates
|
|
543
|
+
*/
|
|
544
|
+
readonly pageSize?: number
|
|
545
|
+
|
|
546
|
+
/**
|
|
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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
548
|
+
* @type {string}
|
|
549
|
+
* @memberof DocumentTemplatesApiListDocTemplates
|
|
550
|
+
*/
|
|
551
|
+
readonly pageToken?: string
|
|
552
|
+
|
|
553
|
+
/**
|
|
554
|
+
* Filter response by productSlug, slug and name.
|
|
555
|
+
* @type {string}
|
|
556
|
+
* @memberof DocumentTemplatesApiListDocTemplates
|
|
557
|
+
*/
|
|
558
|
+
readonly filter?: string
|
|
559
|
+
|
|
560
|
+
/**
|
|
561
|
+
* Order response by createdAt.
|
|
562
|
+
* @type {string}
|
|
563
|
+
* @memberof DocumentTemplatesApiListDocTemplates
|
|
564
|
+
*/
|
|
565
|
+
readonly order?: string
|
|
566
|
+
|
|
567
|
+
/**
|
|
568
|
+
* Expand response by bodyTemplate.
|
|
569
|
+
* @type {string}
|
|
570
|
+
* @memberof DocumentTemplatesApiListDocTemplates
|
|
571
|
+
*/
|
|
572
|
+
readonly expand?: string
|
|
573
|
+
}
|
|
574
|
+
|
|
575
|
+
/**
|
|
576
|
+
* Request parameters for updateDocTemplate operation in DocumentTemplatesApi.
|
|
577
|
+
* @export
|
|
578
|
+
* @interface DocumentTemplatesApiUpdateDocTemplateRequest
|
|
579
|
+
*/
|
|
580
|
+
export interface DocumentTemplatesApiUpdateDocTemplateRequest {
|
|
581
|
+
/**
|
|
582
|
+
*
|
|
583
|
+
* @type {number}
|
|
584
|
+
* @memberof DocumentTemplatesApiUpdateDocTemplate
|
|
585
|
+
*/
|
|
586
|
+
readonly id: number
|
|
587
|
+
|
|
588
|
+
/**
|
|
589
|
+
*
|
|
590
|
+
* @type {UpdateDocTemplateRequestDto}
|
|
591
|
+
* @memberof DocumentTemplatesApiUpdateDocTemplate
|
|
592
|
+
*/
|
|
593
|
+
readonly updateDocTemplateRequestDto: UpdateDocTemplateRequestDto
|
|
594
|
+
|
|
595
|
+
/**
|
|
596
|
+
* Bearer Token
|
|
597
|
+
* @type {string}
|
|
598
|
+
* @memberof DocumentTemplatesApiUpdateDocTemplate
|
|
599
|
+
*/
|
|
600
|
+
readonly authorization?: string
|
|
601
|
+
}
|
|
602
|
+
|
|
603
|
+
/**
|
|
604
|
+
* DocumentTemplatesApi - object-oriented interface
|
|
605
|
+
* @export
|
|
606
|
+
* @class DocumentTemplatesApi
|
|
607
|
+
* @extends {BaseAPI}
|
|
608
|
+
*/
|
|
609
|
+
export class DocumentTemplatesApi extends BaseAPI {
|
|
610
|
+
/**
|
|
611
|
+
* This will create a document template.
|
|
612
|
+
* @summary Create the document template
|
|
613
|
+
* @param {DocumentTemplatesApiCreateDocTemplateRequest} requestParameters Request parameters.
|
|
614
|
+
* @param {*} [options] Override http request option.
|
|
615
|
+
* @throws {RequiredError}
|
|
616
|
+
* @memberof DocumentTemplatesApi
|
|
617
|
+
*/
|
|
618
|
+
public createDocTemplate(requestParameters: DocumentTemplatesApiCreateDocTemplateRequest, options?: AxiosRequestConfig) {
|
|
619
|
+
return DocumentTemplatesApiFp(this.configuration).createDocTemplate(requestParameters.createDocTemplateRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
620
|
+
}
|
|
621
|
+
|
|
622
|
+
/**
|
|
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
|
|
625
|
+
* @param {DocumentTemplatesApiDeleteDocTemplateRequest} requestParameters Request parameters.
|
|
626
|
+
* @param {*} [options] Override http request option.
|
|
627
|
+
* @throws {RequiredError}
|
|
628
|
+
* @memberof DocumentTemplatesApi
|
|
629
|
+
*/
|
|
630
|
+
public deleteDocTemplate(requestParameters: DocumentTemplatesApiDeleteDocTemplateRequest, options?: AxiosRequestConfig) {
|
|
631
|
+
return DocumentTemplatesApiFp(this.configuration).deleteDocTemplate(requestParameters.id, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
632
|
+
}
|
|
633
|
+
|
|
634
|
+
/**
|
|
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
|
|
637
|
+
* @param {DocumentTemplatesApiGetDocTemplateRequest} requestParameters Request parameters.
|
|
638
|
+
* @param {*} [options] Override http request option.
|
|
639
|
+
* @throws {RequiredError}
|
|
640
|
+
* @memberof DocumentTemplatesApi
|
|
641
|
+
*/
|
|
642
|
+
public getDocTemplate(requestParameters: DocumentTemplatesApiGetDocTemplateRequest, options?: AxiosRequestConfig) {
|
|
643
|
+
return DocumentTemplatesApiFp(this.configuration).getDocTemplate(requestParameters.id, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
644
|
+
}
|
|
645
|
+
|
|
646
|
+
/**
|
|
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
|
|
649
|
+
* @param {DocumentTemplatesApiListDocTemplatesRequest} requestParameters Request parameters.
|
|
650
|
+
* @param {*} [options] Override http request option.
|
|
651
|
+
* @throws {RequiredError}
|
|
652
|
+
* @memberof DocumentTemplatesApi
|
|
653
|
+
*/
|
|
654
|
+
public listDocTemplates(requestParameters: DocumentTemplatesApiListDocTemplatesRequest = {}, options?: AxiosRequestConfig) {
|
|
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));
|
|
656
|
+
}
|
|
657
|
+
|
|
658
|
+
/**
|
|
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
|
|
661
|
+
* @param {DocumentTemplatesApiUpdateDocTemplateRequest} requestParameters Request parameters.
|
|
662
|
+
* @param {*} [options] Override http request option.
|
|
663
|
+
* @throws {RequiredError}
|
|
664
|
+
* @memberof DocumentTemplatesApi
|
|
665
|
+
*/
|
|
666
|
+
public updateDocTemplate(requestParameters: DocumentTemplatesApiUpdateDocTemplateRequest, options?: AxiosRequestConfig) {
|
|
667
|
+
return DocumentTemplatesApiFp(this.configuration).updateDocTemplate(requestParameters.id, requestParameters.updateDocTemplateRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
668
|
+
}
|
|
669
|
+
}
|