@matech/thebigpos-sdk 2.36.4 → 2.36.5-pr-3852-5.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/.husky/pre-commit +2 -2
- package/LICENSE +21 -21
- package/README.md +73 -73
- package/dist/index.d.ts +6601 -3946
- package/dist/index.js +2063 -569
- package/dist/index.js.map +1 -1
- package/docs/sdk_generation.md +149 -149
- package/package.json +45 -39
- package/scripts/apply-json-patch-content-type.js +56 -56
- package/src/index.ts +10304 -5589
- package/tsconfig.json +27 -27
package/dist/index.js
CHANGED
|
@@ -30,15 +30,6 @@ var __rest = (this && this.__rest) || function (s, e) {
|
|
|
30
30
|
return t;
|
|
31
31
|
};
|
|
32
32
|
import axios from "axios";
|
|
33
|
-
export var ContentType;
|
|
34
|
-
(function (ContentType) {
|
|
35
|
-
ContentType["JsonPatch"] = "application/json-patch+json";
|
|
36
|
-
ContentType["Json"] = "application/json";
|
|
37
|
-
ContentType["JsonApi"] = "application/vnd.api+json";
|
|
38
|
-
ContentType["FormData"] = "multipart/form-data";
|
|
39
|
-
ContentType["UrlEncoded"] = "application/x-www-form-urlencoded";
|
|
40
|
-
ContentType["Text"] = "text/plain";
|
|
41
|
-
})(ContentType || (ContentType = {}));
|
|
42
33
|
export class HttpClient {
|
|
43
34
|
constructor(_a = {}) {
|
|
44
35
|
var { securityWorker, secure, format } = _a, axiosConfig = __rest(_a, ["securityWorker", "secure", "format"]);
|
|
@@ -54,13 +45,13 @@ export class HttpClient {
|
|
|
54
45
|
{};
|
|
55
46
|
const requestParams = this.mergeRequestParams(params, secureParams);
|
|
56
47
|
const responseFormat = format || this.format || undefined;
|
|
57
|
-
if (type ===
|
|
48
|
+
if (type === "multipart/form-data" &&
|
|
58
49
|
body &&
|
|
59
50
|
body !== null &&
|
|
60
51
|
typeof body === "object") {
|
|
61
52
|
body = this.createFormData(body);
|
|
62
53
|
}
|
|
63
|
-
if (type ===
|
|
54
|
+
if (type === "text/plain" &&
|
|
64
55
|
body &&
|
|
65
56
|
body !== null &&
|
|
66
57
|
typeof body !== "string") {
|
|
@@ -104,7 +95,7 @@ export class HttpClient {
|
|
|
104
95
|
}
|
|
105
96
|
/**
|
|
106
97
|
* @title The Big POS API
|
|
107
|
-
* @version v2.
|
|
98
|
+
* @version v2.49.0
|
|
108
99
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
109
100
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
110
101
|
*/
|
|
@@ -118,7 +109,7 @@ export class Api extends HttpClient {
|
|
|
118
109
|
* @name PostRoot
|
|
119
110
|
* @request POST:/
|
|
120
111
|
* @secure
|
|
121
|
-
* @response `200` `void`
|
|
112
|
+
* @response `200` `void` OK
|
|
122
113
|
*/
|
|
123
114
|
this.postRoot = (params = {}) => this.request(Object.assign({ path: `/`, method: "POST", secure: true }, params));
|
|
124
115
|
/**
|
|
@@ -128,7 +119,7 @@ export class Api extends HttpClient {
|
|
|
128
119
|
* @name GetRoot
|
|
129
120
|
* @request GET:/
|
|
130
121
|
* @secure
|
|
131
|
-
* @response `200` `string`
|
|
122
|
+
* @response `200` `string` OK
|
|
132
123
|
*/
|
|
133
124
|
this.getRoot = (params = {}) => this.request(Object.assign({ path: `/`, method: "GET", secure: true }, params));
|
|
134
125
|
this.api = {
|
|
@@ -140,7 +131,7 @@ export class Api extends HttpClient {
|
|
|
140
131
|
* @summary Get
|
|
141
132
|
* @request GET:/api/account
|
|
142
133
|
* @secure
|
|
143
|
-
* @response `200` `Account`
|
|
134
|
+
* @response `200` `Account` OK
|
|
144
135
|
* @response `404` `ProblemDetails` Not Found
|
|
145
136
|
*/
|
|
146
137
|
getMyAccount: (params = {}) => this.request(Object.assign({ path: `/api/account`, method: "GET", secure: true, format: "json" }, params)),
|
|
@@ -152,11 +143,11 @@ export class Api extends HttpClient {
|
|
|
152
143
|
* @summary Replace
|
|
153
144
|
* @request PUT:/api/account
|
|
154
145
|
* @secure
|
|
155
|
-
* @response `200` `Account`
|
|
146
|
+
* @response `200` `Account` OK
|
|
156
147
|
* @response `404` `ProblemDetails` Not Found
|
|
157
|
-
* @response `422` `ProblemDetails`
|
|
148
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
158
149
|
*/
|
|
159
|
-
replaceMyAccount: (data, params = {}) => this.request(Object.assign({ path: `/api/account`, method: "PUT", body: data, secure: true, type:
|
|
150
|
+
replaceMyAccount: (data, params = {}) => this.request(Object.assign({ path: `/api/account`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
160
151
|
/**
|
|
161
152
|
* No description
|
|
162
153
|
*
|
|
@@ -165,7 +156,7 @@ export class Api extends HttpClient {
|
|
|
165
156
|
* @summary Get Site Configuration
|
|
166
157
|
* @request GET:/api/account/site-configurations
|
|
167
158
|
* @secure
|
|
168
|
-
* @response `200` `SiteConfiguration`
|
|
159
|
+
* @response `200` `SiteConfiguration` OK
|
|
169
160
|
*/
|
|
170
161
|
getSiteConfigurationByAccount: (params = {}) => this.request(Object.assign({ path: `/api/account/site-configurations`, method: "GET", secure: true, format: "json" }, params)),
|
|
171
162
|
/**
|
|
@@ -176,10 +167,33 @@ export class Api extends HttpClient {
|
|
|
176
167
|
* @summary Update Site Configuration
|
|
177
168
|
* @request PUT:/api/account/site-configurations
|
|
178
169
|
* @secure
|
|
179
|
-
* @response `200` `SiteConfiguration`
|
|
180
|
-
* @response `422` `UnprocessableEntity`
|
|
170
|
+
* @response `200` `SiteConfiguration` OK
|
|
171
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
181
172
|
*/
|
|
182
|
-
updateSiteConfigurationForAccount: (data, params = {}) => this.request(Object.assign({ path: `/api/account/site-configurations`, method: "PUT", body: data, secure: true, type:
|
|
173
|
+
updateSiteConfigurationForAccount: (data, params = {}) => this.request(Object.assign({ path: `/api/account/site-configurations`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
174
|
+
/**
|
|
175
|
+
* No description
|
|
176
|
+
*
|
|
177
|
+
* @tags AccountReactivation
|
|
178
|
+
* @name RequestAccountReactivation
|
|
179
|
+
* @summary Request account reactivation
|
|
180
|
+
* @request POST:/api/account/reactivation/request
|
|
181
|
+
* @secure
|
|
182
|
+
* @response `204` `void` No Content
|
|
183
|
+
*/
|
|
184
|
+
requestAccountReactivation: (data, params = {}) => this.request(Object.assign({ path: `/api/account/reactivation/request`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
|
|
185
|
+
/**
|
|
186
|
+
* No description
|
|
187
|
+
*
|
|
188
|
+
* @tags AccountReactivation
|
|
189
|
+
* @name CompleteAccountReactivation
|
|
190
|
+
* @summary Complete account reactivation with new password
|
|
191
|
+
* @request POST:/api/account/reactivation/complete
|
|
192
|
+
* @secure
|
|
193
|
+
* @response `204` `void` No Content
|
|
194
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
195
|
+
*/
|
|
196
|
+
completeAccountReactivation: (data, params = {}) => this.request(Object.assign({ path: `/api/account/reactivation/complete`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
|
|
183
197
|
/**
|
|
184
198
|
* No description
|
|
185
199
|
*
|
|
@@ -188,59 +202,842 @@ export class Api extends HttpClient {
|
|
|
188
202
|
* @summary Get All
|
|
189
203
|
* @request GET:/api/accounts
|
|
190
204
|
* @secure
|
|
191
|
-
* @response `200` `(Account)[]`
|
|
205
|
+
* @response `200` `(Account)[]` OK
|
|
206
|
+
*/
|
|
207
|
+
getAccounts: (params = {}) => this.request(Object.assign({ path: `/api/accounts`, method: "GET", secure: true, format: "json" }, params)),
|
|
208
|
+
/**
|
|
209
|
+
* No description
|
|
210
|
+
*
|
|
211
|
+
* @tags Accounts
|
|
212
|
+
* @name CreateAccount
|
|
213
|
+
* @summary Create
|
|
214
|
+
* @request POST:/api/accounts
|
|
215
|
+
* @secure
|
|
216
|
+
* @response `201` `Account` Created
|
|
217
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
218
|
+
*/
|
|
219
|
+
createAccount: (data, params = {}) => this.request(Object.assign({ path: `/api/accounts`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
220
|
+
/**
|
|
221
|
+
* No description
|
|
222
|
+
*
|
|
223
|
+
* @tags Accounts
|
|
224
|
+
* @name GetAccount
|
|
225
|
+
* @summary Get by ID
|
|
226
|
+
* @request GET:/api/accounts/{id}
|
|
227
|
+
* @secure
|
|
228
|
+
* @response `201` `Account` Created
|
|
229
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
230
|
+
*/
|
|
231
|
+
getAccount: (id, params = {}) => this.request(Object.assign({ path: `/api/accounts/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
232
|
+
/**
|
|
233
|
+
* No description
|
|
234
|
+
*
|
|
235
|
+
* @tags Accounts
|
|
236
|
+
* @name DeleteAccount
|
|
237
|
+
* @summary Delete
|
|
238
|
+
* @request DELETE:/api/accounts/{id}
|
|
239
|
+
* @secure
|
|
240
|
+
* @response `204` `Account` No Content
|
|
241
|
+
* @response `404` `ProblemDetails` Not Found
|
|
242
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
243
|
+
*/
|
|
244
|
+
deleteAccount: (id, query, params = {}) => this.request(Object.assign({ path: `/api/accounts/${id}`, method: "DELETE", query: query, secure: true, format: "json" }, params)),
|
|
245
|
+
/**
|
|
246
|
+
* No description
|
|
247
|
+
*
|
|
248
|
+
* @tags Accounts
|
|
249
|
+
* @name UpdateAccountBilling
|
|
250
|
+
* @summary Update billing configuration
|
|
251
|
+
* @request PUT:/api/accounts/{id}/billing
|
|
252
|
+
* @secure
|
|
253
|
+
* @response `200` `AccountBilling` OK
|
|
254
|
+
* @response `404` `ProblemDetails` Not Found
|
|
255
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
256
|
+
*/
|
|
257
|
+
updateAccountBilling: (id, data, params = {}) => this.request(Object.assign({ path: `/api/accounts/${id}/billing`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
258
|
+
/**
|
|
259
|
+
* No description
|
|
260
|
+
*
|
|
261
|
+
* @tags AiAccess
|
|
262
|
+
* @name GetAiAccess
|
|
263
|
+
* @summary Get whether AI is enabled for the current user's account
|
|
264
|
+
* @request GET:/api/ai/access
|
|
265
|
+
* @secure
|
|
266
|
+
* @response `200` `AiEnabled` OK
|
|
267
|
+
*/
|
|
268
|
+
getAiAccess: (params = {}) => this.request(Object.assign({ path: `/api/ai/access`, method: "GET", secure: true, format: "json" }, params)),
|
|
269
|
+
/**
|
|
270
|
+
* No description
|
|
271
|
+
*
|
|
272
|
+
* @tags AiAccount
|
|
273
|
+
* @name GetAccountAiEnabled
|
|
274
|
+
* @summary Get whether AI is enabled for an account (SuperAdmin only)
|
|
275
|
+
* @request GET:/api/ai/accounts/{accountId}/ai-enabled
|
|
276
|
+
* @secure
|
|
277
|
+
* @response `200` `AiEnabled` OK
|
|
278
|
+
*/
|
|
279
|
+
getAccountAiEnabled: (accountId, params = {}) => this.request(Object.assign({ path: `/api/ai/accounts/${accountId}/ai-enabled`, method: "GET", secure: true, format: "json" }, params)),
|
|
280
|
+
/**
|
|
281
|
+
* No description
|
|
282
|
+
*
|
|
283
|
+
* @tags AiAccount
|
|
284
|
+
* @name SetAccountAiEnabled
|
|
285
|
+
* @summary Enable or disable AI for an account (SuperAdmin only)
|
|
286
|
+
* @request PUT:/api/ai/accounts/{accountId}/ai-enabled
|
|
287
|
+
* @secure
|
|
288
|
+
* @response `204` `void` No Content
|
|
289
|
+
*/
|
|
290
|
+
setAccountAiEnabled: (accountId, data, params = {}) => this.request(Object.assign({ path: `/api/ai/accounts/${accountId}/ai-enabled`, method: "PUT", body: data, secure: true, type: "application/json" }, params)),
|
|
291
|
+
/**
|
|
292
|
+
* No description
|
|
293
|
+
*
|
|
294
|
+
* @tags AiAccountSettings
|
|
295
|
+
* @name GetAiAccountSettings
|
|
296
|
+
* @summary Get account AI settings
|
|
297
|
+
* @request GET:/api/ai/account-settings
|
|
298
|
+
* @secure
|
|
299
|
+
* @response `200` `AiAccountSettings` OK
|
|
300
|
+
*/
|
|
301
|
+
getAiAccountSettings: (params = {}) => this.request(Object.assign({ path: `/api/ai/account-settings`, method: "GET", secure: true, format: "json" }, params)),
|
|
302
|
+
/**
|
|
303
|
+
* No description
|
|
304
|
+
*
|
|
305
|
+
* @tags AiAccountSettings
|
|
306
|
+
* @name UpdateAiAccountSettings
|
|
307
|
+
* @summary Update account AI settings
|
|
308
|
+
* @request PUT:/api/ai/account-settings
|
|
309
|
+
* @secure
|
|
310
|
+
* @response `200` `AiAccountSettings` OK
|
|
311
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
312
|
+
*/
|
|
313
|
+
updateAiAccountSettings: (data, params = {}) => this.request(Object.assign({ path: `/api/ai/account-settings`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
314
|
+
/**
|
|
315
|
+
* No description
|
|
316
|
+
*
|
|
317
|
+
* @tags AiAdminPrompt
|
|
318
|
+
* @name GetAiPrompts
|
|
319
|
+
* @summary Get all prompts
|
|
320
|
+
* @request GET:/api/ai/prompts
|
|
321
|
+
* @secure
|
|
322
|
+
* @response `200` `(AiPrompt)[]` OK
|
|
323
|
+
*/
|
|
324
|
+
getAiPrompts: (params = {}) => this.request(Object.assign({ path: `/api/ai/prompts`, method: "GET", secure: true, format: "json" }, params)),
|
|
325
|
+
/**
|
|
326
|
+
* No description
|
|
327
|
+
*
|
|
328
|
+
* @tags AiAdminPrompt
|
|
329
|
+
* @name CreateAiPrompt
|
|
330
|
+
* @summary Create custom prompt
|
|
331
|
+
* @request POST:/api/ai/prompts
|
|
332
|
+
* @secure
|
|
333
|
+
* @response `201` `AiPrompt` Created
|
|
334
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
335
|
+
*/
|
|
336
|
+
createAiPrompt: (data, params = {}) => this.request(Object.assign({ path: `/api/ai/prompts`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
337
|
+
/**
|
|
338
|
+
* No description
|
|
339
|
+
*
|
|
340
|
+
* @tags AiAdminPrompt
|
|
341
|
+
* @name GetAiPrompt
|
|
342
|
+
* @summary Get prompt by ID
|
|
343
|
+
* @request GET:/api/ai/prompts/{id}
|
|
344
|
+
* @secure
|
|
345
|
+
* @response `200` `AiPrompt` OK
|
|
346
|
+
* @response `404` `ProblemDetails` Not Found
|
|
347
|
+
*/
|
|
348
|
+
getAiPrompt: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/prompts/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
349
|
+
/**
|
|
350
|
+
* No description
|
|
351
|
+
*
|
|
352
|
+
* @tags AiAdminPrompt
|
|
353
|
+
* @name UpdateAiPrompt
|
|
354
|
+
* @summary Update prompt
|
|
355
|
+
* @request PUT:/api/ai/prompts/{id}
|
|
356
|
+
* @secure
|
|
357
|
+
* @response `200` `AiPrompt` OK
|
|
358
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
359
|
+
* @response `404` `ProblemDetails` Not Found
|
|
360
|
+
*/
|
|
361
|
+
updateAiPrompt: (id, data, params = {}) => this.request(Object.assign({ path: `/api/ai/prompts/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
362
|
+
/**
|
|
363
|
+
* No description
|
|
364
|
+
*
|
|
365
|
+
* @tags AiAdminPrompt
|
|
366
|
+
* @name DeleteAiPrompt
|
|
367
|
+
* @summary Delete prompt
|
|
368
|
+
* @request DELETE:/api/ai/prompts/{id}
|
|
369
|
+
* @secure
|
|
370
|
+
* @response `204` `void` No Content
|
|
371
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
372
|
+
* @response `404` `ProblemDetails` Not Found
|
|
373
|
+
*/
|
|
374
|
+
deleteAiPrompt: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/prompts/${id}`, method: "DELETE", secure: true }, params)),
|
|
375
|
+
/**
|
|
376
|
+
* No description
|
|
377
|
+
*
|
|
378
|
+
* @tags AiAdminPrompt
|
|
379
|
+
* @name GetAiTools
|
|
380
|
+
* @summary List available agent tools and their settings schema
|
|
381
|
+
* @request GET:/api/ai/prompts/tools
|
|
382
|
+
* @secure
|
|
383
|
+
* @response `200` `(AiToolCatalogItem)[]` OK
|
|
384
|
+
*/
|
|
385
|
+
getAiTools: (params = {}) => this.request(Object.assign({ path: `/api/ai/prompts/tools`, method: "GET", secure: true, format: "json" }, params)),
|
|
386
|
+
/**
|
|
387
|
+
* No description
|
|
388
|
+
*
|
|
389
|
+
* @tags AiAdminPrompt
|
|
390
|
+
* @name UpdateAiPromptTools
|
|
391
|
+
* @summary Replace the prompt's agent tool configuration
|
|
392
|
+
* @request PUT:/api/ai/prompts/{id}/tools
|
|
393
|
+
* @secure
|
|
394
|
+
* @response `200` `AiPrompt` OK
|
|
395
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
396
|
+
* @response `404` `ProblemDetails` Not Found
|
|
397
|
+
*/
|
|
398
|
+
updateAiPromptTools: (id, data, params = {}) => this.request(Object.assign({ path: `/api/ai/prompts/${id}/tools`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
399
|
+
/**
|
|
400
|
+
* No description
|
|
401
|
+
*
|
|
402
|
+
* @tags AiAdminPrompt
|
|
403
|
+
* @name ToggleAiPrompt
|
|
404
|
+
* @summary Toggle prompt active/inactive
|
|
405
|
+
* @request PATCH:/api/ai/prompts/{id}/toggle
|
|
406
|
+
* @secure
|
|
407
|
+
* @response `200` `AiPrompt` OK
|
|
408
|
+
* @response `404` `ProblemDetails` Not Found
|
|
409
|
+
*/
|
|
410
|
+
toggleAiPrompt: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/prompts/${id}/toggle`, method: "PATCH", secure: true, format: "json" }, params)),
|
|
411
|
+
/**
|
|
412
|
+
* No description
|
|
413
|
+
*
|
|
414
|
+
* @tags AiAdminPrompt
|
|
415
|
+
* @name GenerateAiSystemPrompt
|
|
416
|
+
* @summary Generate a system prompt from description
|
|
417
|
+
* @request POST:/api/ai/prompts/generate
|
|
418
|
+
* @secure
|
|
419
|
+
* @response `200` `GenerateSystemPrompt` OK
|
|
420
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
421
|
+
*/
|
|
422
|
+
generateAiSystemPrompt: (data, params = {}) => this.request(Object.assign({ path: `/api/ai/prompts/generate`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
423
|
+
/**
|
|
424
|
+
* No description
|
|
425
|
+
*
|
|
426
|
+
* @tags AiAdminPrompt
|
|
427
|
+
* @name GetAiSupportedModels
|
|
428
|
+
* @summary Get supported LLM models
|
|
429
|
+
* @request GET:/api/ai/prompts/supported-models
|
|
430
|
+
* @secure
|
|
431
|
+
* @response `200` `(SupportedModel)[]` OK
|
|
432
|
+
*/
|
|
433
|
+
getAiSupportedModels: (params = {}) => this.request(Object.assign({ path: `/api/ai/prompts/supported-models`, method: "GET", secure: true, format: "json" }, params)),
|
|
434
|
+
/**
|
|
435
|
+
* No description
|
|
436
|
+
*
|
|
437
|
+
* @tags AiAdminSettings
|
|
438
|
+
* @name GetAiAdminSettings
|
|
439
|
+
* @summary Get global AI settings
|
|
440
|
+
* @request GET:/api/ai/settings
|
|
441
|
+
* @secure
|
|
442
|
+
* @response `200` `AiAdminSettings` OK
|
|
443
|
+
*/
|
|
444
|
+
getAiAdminSettings: (params = {}) => this.request(Object.assign({ path: `/api/ai/settings`, method: "GET", secure: true, format: "json" }, params)),
|
|
445
|
+
/**
|
|
446
|
+
* No description
|
|
447
|
+
*
|
|
448
|
+
* @tags AiAdminSettings
|
|
449
|
+
* @name UpdateAiAdminSettings
|
|
450
|
+
* @summary Update global AI settings
|
|
451
|
+
* @request PUT:/api/ai/settings
|
|
452
|
+
* @secure
|
|
453
|
+
* @response `200` `AiAdminSettings` OK
|
|
454
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
455
|
+
*/
|
|
456
|
+
updateAiAdminSettings: (data, params = {}) => this.request(Object.assign({ path: `/api/ai/settings`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
457
|
+
/**
|
|
458
|
+
* No description
|
|
459
|
+
*
|
|
460
|
+
* @tags AiAudit
|
|
461
|
+
* @name GetAiAuditLogs
|
|
462
|
+
* @summary Get paginated AI audit logs (own account, or any/all accounts for SuperAdmin)
|
|
463
|
+
* @request GET:/api/ai/audit-logs
|
|
464
|
+
* @secure
|
|
465
|
+
* @response `200` `AiAuditLogPaginated` OK
|
|
466
|
+
*/
|
|
467
|
+
getAiAuditLogs: (query, params = {}) => this.request(Object.assign({ path: `/api/ai/audit-logs`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
468
|
+
/**
|
|
469
|
+
* No description
|
|
470
|
+
*
|
|
471
|
+
* @tags AiAudit
|
|
472
|
+
* @name GetAiRequestLifecycle
|
|
473
|
+
* @summary Get the full event lifecycle of a single AI request
|
|
474
|
+
* @request GET:/api/ai/audit-logs/request/{requestId}
|
|
475
|
+
* @secure
|
|
476
|
+
* @response `200` `(AiAuditLog)[]` OK
|
|
477
|
+
*/
|
|
478
|
+
getAiRequestLifecycle: (requestId, query, params = {}) => this.request(Object.assign({ path: `/api/ai/audit-logs/request/${requestId}`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
479
|
+
/**
|
|
480
|
+
* No description
|
|
481
|
+
*
|
|
482
|
+
* @tags AiAudit
|
|
483
|
+
* @name GetAiAuditConversations
|
|
484
|
+
* @summary List conversations with their audit roll-up — origin user, turns, status, tokens
|
|
485
|
+
* @request GET:/api/ai/audit-conversations
|
|
486
|
+
* @secure
|
|
487
|
+
* @response `200` `AiConversationAuditSummaryPaginated` OK
|
|
488
|
+
*/
|
|
489
|
+
getAiAuditConversations: (query, params = {}) => this.request(Object.assign({ path: `/api/ai/audit-conversations`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
490
|
+
/**
|
|
491
|
+
* No description
|
|
492
|
+
*
|
|
493
|
+
* @tags AiAudit
|
|
494
|
+
* @name GetAiStats
|
|
495
|
+
* @summary Get AI dashboard stats (own account, or any/all accounts for SuperAdmin)
|
|
496
|
+
* @request GET:/api/ai/stats
|
|
497
|
+
* @secure
|
|
498
|
+
* @response `200` `AiAdminStats` OK
|
|
499
|
+
*/
|
|
500
|
+
getAiStats: (query, params = {}) => this.request(Object.assign({ path: `/api/ai/stats`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
501
|
+
/**
|
|
502
|
+
* No description
|
|
503
|
+
*
|
|
504
|
+
* @tags AiAudit
|
|
505
|
+
* @name GetAiConfigChanges
|
|
506
|
+
* @summary Get the AI configuration change history (who changed prompts, guardrails, fields, sources)
|
|
507
|
+
* @request GET:/api/ai/config-changes
|
|
508
|
+
* @secure
|
|
509
|
+
* @response `200` `AuditLogEntryPaginated` OK
|
|
510
|
+
*/
|
|
511
|
+
getAiConfigChanges: (query, params = {}) => this.request(Object.assign({ path: `/api/ai/config-changes`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
512
|
+
/**
|
|
513
|
+
* No description
|
|
514
|
+
*
|
|
515
|
+
* @tags AiCanonicalField
|
|
516
|
+
* @name GetAiCanonicalFields
|
|
517
|
+
* @summary Get all canonical fields
|
|
518
|
+
* @request GET:/api/ai/canonical-fields
|
|
519
|
+
* @secure
|
|
520
|
+
* @response `200` `(AiCanonicalField)[]` OK
|
|
521
|
+
*/
|
|
522
|
+
getAiCanonicalFields: (params = {}) => this.request(Object.assign({ path: `/api/ai/canonical-fields`, method: "GET", secure: true, format: "json" }, params)),
|
|
523
|
+
/**
|
|
524
|
+
* No description
|
|
525
|
+
*
|
|
526
|
+
* @tags AiCanonicalField
|
|
527
|
+
* @name CreateAiCanonicalField
|
|
528
|
+
* @summary Create canonical field
|
|
529
|
+
* @request POST:/api/ai/canonical-fields
|
|
530
|
+
* @secure
|
|
531
|
+
* @response `201` `AiCanonicalField` Created
|
|
532
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
533
|
+
*/
|
|
534
|
+
createAiCanonicalField: (data, params = {}) => this.request(Object.assign({ path: `/api/ai/canonical-fields`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
535
|
+
/**
|
|
536
|
+
* No description
|
|
537
|
+
*
|
|
538
|
+
* @tags AiCanonicalField
|
|
539
|
+
* @name GetAiCanonicalField
|
|
540
|
+
* @summary Get canonical field by ID
|
|
541
|
+
* @request GET:/api/ai/canonical-fields/{id}
|
|
542
|
+
* @secure
|
|
543
|
+
* @response `200` `AiCanonicalField` OK
|
|
544
|
+
* @response `404` `ProblemDetails` Not Found
|
|
545
|
+
*/
|
|
546
|
+
getAiCanonicalField: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/canonical-fields/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
547
|
+
/**
|
|
548
|
+
* No description
|
|
549
|
+
*
|
|
550
|
+
* @tags AiCanonicalField
|
|
551
|
+
* @name UpdateAiCanonicalField
|
|
552
|
+
* @summary Update canonical field
|
|
553
|
+
* @request PUT:/api/ai/canonical-fields/{id}
|
|
554
|
+
* @secure
|
|
555
|
+
* @response `200` `AiCanonicalField` OK
|
|
556
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
557
|
+
* @response `404` `ProblemDetails` Not Found
|
|
558
|
+
*/
|
|
559
|
+
updateAiCanonicalField: (id, data, params = {}) => this.request(Object.assign({ path: `/api/ai/canonical-fields/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
560
|
+
/**
|
|
561
|
+
* No description
|
|
562
|
+
*
|
|
563
|
+
* @tags AiCanonicalField
|
|
564
|
+
* @name DeleteAiCanonicalField
|
|
565
|
+
* @summary Delete canonical field
|
|
566
|
+
* @request DELETE:/api/ai/canonical-fields/{id}
|
|
567
|
+
* @secure
|
|
568
|
+
* @response `204` `void` No Content
|
|
569
|
+
* @response `404` `ProblemDetails` Not Found
|
|
570
|
+
*/
|
|
571
|
+
deleteAiCanonicalField: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/canonical-fields/${id}`, method: "DELETE", secure: true }, params)),
|
|
572
|
+
/**
|
|
573
|
+
* No description
|
|
574
|
+
*
|
|
575
|
+
* @tags AiCanonicalField
|
|
576
|
+
* @name ToggleAiCanonicalField
|
|
577
|
+
* @summary Toggle canonical field active/inactive
|
|
578
|
+
* @request PATCH:/api/ai/canonical-fields/{id}/toggle
|
|
579
|
+
* @secure
|
|
580
|
+
* @response `200` `AiCanonicalField` OK
|
|
581
|
+
* @response `404` `ProblemDetails` Not Found
|
|
582
|
+
*/
|
|
583
|
+
toggleAiCanonicalField: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/canonical-fields/${id}/toggle`, method: "PATCH", secure: true, format: "json" }, params)),
|
|
584
|
+
/**
|
|
585
|
+
* No description
|
|
586
|
+
*
|
|
587
|
+
* @tags AiChat
|
|
588
|
+
* @name AiChat
|
|
589
|
+
* @summary Send AI chat message
|
|
590
|
+
* @request POST:/api/ai/chats
|
|
591
|
+
* @secure
|
|
592
|
+
* @response `200` `AiChat` OK
|
|
593
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
594
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
595
|
+
* @response `429` `ProblemDetails` Too Many Requests
|
|
596
|
+
*/
|
|
597
|
+
aiChat: (data, params = {}) => this.request(Object.assign({ path: `/api/ai/chats`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
598
|
+
/**
|
|
599
|
+
* No description
|
|
600
|
+
*
|
|
601
|
+
* @tags AiConversation
|
|
602
|
+
* @name GetAiConversations
|
|
603
|
+
* @summary Get user conversations
|
|
604
|
+
* @request GET:/api/ai/conversations
|
|
605
|
+
* @secure
|
|
606
|
+
* @response `200` `AiConversationListItemPaginated` OK
|
|
607
|
+
*/
|
|
608
|
+
getAiConversations: (query, params = {}) => this.request(Object.assign({ path: `/api/ai/conversations`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
609
|
+
/**
|
|
610
|
+
* No description
|
|
611
|
+
*
|
|
612
|
+
* @tags AiConversation
|
|
613
|
+
* @name GetAiConversation
|
|
614
|
+
* @summary Get conversation metadata
|
|
615
|
+
* @request GET:/api/ai/conversations/{id}
|
|
616
|
+
* @secure
|
|
617
|
+
* @response `200` `AiConversationDetail` OK
|
|
618
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
619
|
+
* @response `404` `ProblemDetails` Not Found
|
|
620
|
+
*/
|
|
621
|
+
getAiConversation: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/conversations/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
622
|
+
/**
|
|
623
|
+
* No description
|
|
624
|
+
*
|
|
625
|
+
* @tags AiConversation
|
|
626
|
+
* @name RenameAiConversation
|
|
627
|
+
* @summary Rename conversation
|
|
628
|
+
* @request PATCH:/api/ai/conversations/{id}
|
|
629
|
+
* @secure
|
|
630
|
+
* @response `200` `AiConversationDetail` OK
|
|
631
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
632
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
633
|
+
* @response `404` `ProblemDetails` Not Found
|
|
634
|
+
*/
|
|
635
|
+
renameAiConversation: (id, data, params = {}) => this.request(Object.assign({ path: `/api/ai/conversations/${id}`, method: "PATCH", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
636
|
+
/**
|
|
637
|
+
* No description
|
|
638
|
+
*
|
|
639
|
+
* @tags AiConversation
|
|
640
|
+
* @name DeleteAiConversation
|
|
641
|
+
* @summary Delete conversation
|
|
642
|
+
* @request DELETE:/api/ai/conversations/{id}
|
|
643
|
+
* @secure
|
|
644
|
+
* @response `204` `void` No Content
|
|
645
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
646
|
+
* @response `404` `ProblemDetails` Not Found
|
|
647
|
+
*/
|
|
648
|
+
deleteAiConversation: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/conversations/${id}`, method: "DELETE", secure: true }, params)),
|
|
649
|
+
/**
|
|
650
|
+
* No description
|
|
651
|
+
*
|
|
652
|
+
* @tags AiConversation
|
|
653
|
+
* @name GetAiConversationMessages
|
|
654
|
+
* @summary Get conversation messages
|
|
655
|
+
* @request GET:/api/ai/conversations/{id}/messages
|
|
656
|
+
* @secure
|
|
657
|
+
* @response `200` `AiChatMessagePaginated` OK
|
|
658
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
659
|
+
* @response `404` `ProblemDetails` Not Found
|
|
660
|
+
*/
|
|
661
|
+
getAiConversationMessages: (id, query, params = {}) => this.request(Object.assign({ path: `/api/ai/conversations/${id}/messages`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
662
|
+
/**
|
|
663
|
+
* No description
|
|
664
|
+
*
|
|
665
|
+
* @tags AiConversation
|
|
666
|
+
* @name ClearAiConversationHistory
|
|
667
|
+
* @summary Clear conversation history
|
|
668
|
+
* @request DELETE:/api/ai/conversations/{id}/messages
|
|
669
|
+
* @secure
|
|
670
|
+
* @response `204` `void` No Content
|
|
671
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
672
|
+
* @response `404` `ProblemDetails` Not Found
|
|
673
|
+
*/
|
|
674
|
+
clearAiConversationHistory: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/conversations/${id}/messages`, method: "DELETE", secure: true }, params)),
|
|
675
|
+
/**
|
|
676
|
+
* No description
|
|
677
|
+
*
|
|
678
|
+
* @tags AiConversation
|
|
679
|
+
* @name PinAiConversation
|
|
680
|
+
* @summary Pin or unpin conversation
|
|
681
|
+
* @request PUT:/api/ai/conversations/{id}/pin
|
|
682
|
+
* @secure
|
|
683
|
+
* @response `200` `AiConversationDetail` OK
|
|
684
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
685
|
+
* @response `404` `ProblemDetails` Not Found
|
|
686
|
+
*/
|
|
687
|
+
pinAiConversation: (id, data, params = {}) => this.request(Object.assign({ path: `/api/ai/conversations/${id}/pin`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
688
|
+
/**
|
|
689
|
+
* No description
|
|
690
|
+
*
|
|
691
|
+
* @tags AiConversationAdmin
|
|
692
|
+
* @name GetAiAccountConversations
|
|
693
|
+
* @summary List AI conversations across the account, optionally filtered by user (admin supervision)
|
|
694
|
+
* @request GET:/api/ai/conversations/all
|
|
695
|
+
* @secure
|
|
696
|
+
* @response `200` `AiConversationListItemPaginated` OK
|
|
697
|
+
*/
|
|
698
|
+
getAiAccountConversations: (query, params = {}) => this.request(Object.assign({ path: `/api/ai/conversations/all`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
699
|
+
/**
|
|
700
|
+
* No description
|
|
701
|
+
*
|
|
702
|
+
* @tags AiConversationAdmin
|
|
703
|
+
* @name GetAiAccountConversation
|
|
704
|
+
* @summary Get an account conversation's detail (admin supervision)
|
|
705
|
+
* @request GET:/api/ai/conversations/all/{id}
|
|
706
|
+
* @secure
|
|
707
|
+
* @response `200` `AiConversationDetail` OK
|
|
708
|
+
* @response `404` `ProblemDetails` Not Found
|
|
709
|
+
*/
|
|
710
|
+
getAiAccountConversation: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/conversations/all/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
711
|
+
/**
|
|
712
|
+
* No description
|
|
713
|
+
*
|
|
714
|
+
* @tags AiConversationAdmin
|
|
715
|
+
* @name GetAiAccountConversationMessages
|
|
716
|
+
* @summary Get an account conversation's messages (admin supervision)
|
|
717
|
+
* @request GET:/api/ai/conversations/all/{id}/messages
|
|
718
|
+
* @secure
|
|
719
|
+
* @response `200` `AiChatMessagePaginated` OK
|
|
720
|
+
* @response `404` `ProblemDetails` Not Found
|
|
721
|
+
*/
|
|
722
|
+
getAiAccountConversationMessages: (id, query, params = {}) => this.request(Object.assign({ path: `/api/ai/conversations/all/${id}/messages`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
723
|
+
/**
|
|
724
|
+
* No description
|
|
725
|
+
*
|
|
726
|
+
* @tags AiGuardrail
|
|
727
|
+
* @name GetAiGuardrails
|
|
728
|
+
* @summary Get all guardrails
|
|
729
|
+
* @request GET:/api/ai/guardrails
|
|
730
|
+
* @secure
|
|
731
|
+
* @response `200` `(AiGuardrail)[]` OK
|
|
732
|
+
*/
|
|
733
|
+
getAiGuardrails: (params = {}) => this.request(Object.assign({ path: `/api/ai/guardrails`, method: "GET", secure: true, format: "json" }, params)),
|
|
734
|
+
/**
|
|
735
|
+
* No description
|
|
736
|
+
*
|
|
737
|
+
* @tags AiGuardrail
|
|
738
|
+
* @name CreateAiGuardrail
|
|
739
|
+
* @summary Create custom guardrail
|
|
740
|
+
* @request POST:/api/ai/guardrails
|
|
741
|
+
* @secure
|
|
742
|
+
* @response `201` `AiGuardrail` Created
|
|
743
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
744
|
+
*/
|
|
745
|
+
createAiGuardrail: (data, params = {}) => this.request(Object.assign({ path: `/api/ai/guardrails`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
746
|
+
/**
|
|
747
|
+
* No description
|
|
748
|
+
*
|
|
749
|
+
* @tags AiGuardrail
|
|
750
|
+
* @name GetAiGuardrail
|
|
751
|
+
* @summary Get guardrail by ID
|
|
752
|
+
* @request GET:/api/ai/guardrails/{id}
|
|
753
|
+
* @secure
|
|
754
|
+
* @response `200` `AiGuardrail` OK
|
|
755
|
+
* @response `404` `ProblemDetails` Not Found
|
|
756
|
+
*/
|
|
757
|
+
getAiGuardrail: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/guardrails/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
758
|
+
/**
|
|
759
|
+
* No description
|
|
760
|
+
*
|
|
761
|
+
* @tags AiGuardrail
|
|
762
|
+
* @name UpdateAiGuardrail
|
|
763
|
+
* @summary Update guardrail
|
|
764
|
+
* @request PUT:/api/ai/guardrails/{id}
|
|
765
|
+
* @secure
|
|
766
|
+
* @response `200` `AiGuardrail` OK
|
|
767
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
768
|
+
* @response `404` `ProblemDetails` Not Found
|
|
769
|
+
*/
|
|
770
|
+
updateAiGuardrail: (id, data, params = {}) => this.request(Object.assign({ path: `/api/ai/guardrails/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
771
|
+
/**
|
|
772
|
+
* No description
|
|
773
|
+
*
|
|
774
|
+
* @tags AiGuardrail
|
|
775
|
+
* @name DeleteAiGuardrail
|
|
776
|
+
* @summary Delete guardrail
|
|
777
|
+
* @request DELETE:/api/ai/guardrails/{id}
|
|
778
|
+
* @secure
|
|
779
|
+
* @response `204` `void` No Content
|
|
780
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
781
|
+
* @response `404` `ProblemDetails` Not Found
|
|
782
|
+
*/
|
|
783
|
+
deleteAiGuardrail: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/guardrails/${id}`, method: "DELETE", secure: true }, params)),
|
|
784
|
+
/**
|
|
785
|
+
* No description
|
|
786
|
+
*
|
|
787
|
+
* @tags AiGuardrail
|
|
788
|
+
* @name ToggleAiGuardrail
|
|
789
|
+
* @summary Toggle guardrail enabled/disabled
|
|
790
|
+
* @request PATCH:/api/ai/guardrails/{id}/toggle
|
|
791
|
+
* @secure
|
|
792
|
+
* @response `200` `AiGuardrail` OK
|
|
793
|
+
* @response `404` `ProblemDetails` Not Found
|
|
794
|
+
*/
|
|
795
|
+
toggleAiGuardrail: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/guardrails/${id}/toggle`, method: "PATCH", secure: true, format: "json" }, params)),
|
|
796
|
+
/**
|
|
797
|
+
* No description
|
|
798
|
+
*
|
|
799
|
+
* @tags AiPrompt
|
|
800
|
+
* @name GetAiAvailablePrompts
|
|
801
|
+
* @summary Get available prompts for current user
|
|
802
|
+
* @request GET:/api/ai/prompts/available
|
|
803
|
+
* @secure
|
|
804
|
+
* @response `200` `(AiPromptSummary)[]` OK
|
|
805
|
+
*/
|
|
806
|
+
getAiAvailablePrompts: (query, params = {}) => this.request(Object.assign({ path: `/api/ai/prompts/available`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
807
|
+
/**
|
|
808
|
+
* No description
|
|
809
|
+
*
|
|
810
|
+
* @tags AiTokenUsageAdmin
|
|
811
|
+
* @name SearchAiAccountTokenUsage
|
|
812
|
+
* @summary Search accounts by current-month AI token usage and classification
|
|
813
|
+
* @request POST:/api/ai/token-usage/search
|
|
814
|
+
* @secure
|
|
815
|
+
* @response `200` `AiAccountUsageOverviewPaginated` OK
|
|
816
|
+
*/
|
|
817
|
+
searchAiAccountTokenUsage: (data, query, params = {}) => this.request(Object.assign({ path: `/api/ai/token-usage/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
818
|
+
/**
|
|
819
|
+
* No description
|
|
820
|
+
*
|
|
821
|
+
* @tags AiTokenUsageAdmin
|
|
822
|
+
* @name GetAiAccountTokenUsage
|
|
823
|
+
* @summary Get an account's current-month AI token usage
|
|
824
|
+
* @request GET:/api/ai/token-usage/{accountId}
|
|
825
|
+
* @secure
|
|
826
|
+
* @response `200` `AiTokenBudgetStatus` OK
|
|
827
|
+
*/
|
|
828
|
+
getAiAccountTokenUsage: (accountId, params = {}) => this.request(Object.assign({ path: `/api/ai/token-usage/${accountId}`, method: "GET", secure: true, format: "json" }, params)),
|
|
829
|
+
/**
|
|
830
|
+
* No description
|
|
831
|
+
*
|
|
832
|
+
* @tags AiTokenUsageAdmin
|
|
833
|
+
* @name GetAiAccountTokenUsageHistory
|
|
834
|
+
* @summary Get an account's monthly AI token usage history
|
|
835
|
+
* @request GET:/api/ai/token-usage/{accountId}/history
|
|
836
|
+
* @secure
|
|
837
|
+
* @response `200` `AiTokenUsageWindowPaginated` OK
|
|
838
|
+
*/
|
|
839
|
+
getAiAccountTokenUsageHistory: (accountId, query, params = {}) => this.request(Object.assign({ path: `/api/ai/token-usage/${accountId}/history`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
840
|
+
/**
|
|
841
|
+
* No description
|
|
842
|
+
*
|
|
843
|
+
* @tags AiTokenUsageAdmin
|
|
844
|
+
* @name SetAiAccountTokenLimit
|
|
845
|
+
* @summary Set or raise an account's monthly AI token limit
|
|
846
|
+
* @request PUT:/api/ai/token-usage/{accountId}/limit
|
|
847
|
+
* @secure
|
|
848
|
+
* @response `200` `AiTokenBudgetStatus` OK
|
|
849
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
850
|
+
*/
|
|
851
|
+
setAiAccountTokenLimit: (accountId, data, params = {}) => this.request(Object.assign({ path: `/api/ai/token-usage/${accountId}/limit`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
852
|
+
/**
|
|
853
|
+
* No description
|
|
854
|
+
*
|
|
855
|
+
* @tags AiUrlSource
|
|
856
|
+
* @name GetAiUrlSources
|
|
857
|
+
* @summary Get all URL sources
|
|
858
|
+
* @request GET:/api/ai/url-sources
|
|
859
|
+
* @secure
|
|
860
|
+
* @response `200` `(AiUrlSource)[]` OK
|
|
861
|
+
*/
|
|
862
|
+
getAiUrlSources: (params = {}) => this.request(Object.assign({ path: `/api/ai/url-sources`, method: "GET", secure: true, format: "json" }, params)),
|
|
863
|
+
/**
|
|
864
|
+
* No description
|
|
865
|
+
*
|
|
866
|
+
* @tags AiUrlSource
|
|
867
|
+
* @name CreateAiUrlSource
|
|
868
|
+
* @summary Create URL source
|
|
869
|
+
* @request POST:/api/ai/url-sources
|
|
870
|
+
* @secure
|
|
871
|
+
* @response `201` `AiUrlSource` Created
|
|
872
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
873
|
+
* @response `409` `ProblemDetails` Conflict
|
|
874
|
+
*/
|
|
875
|
+
createAiUrlSource: (data, params = {}) => this.request(Object.assign({ path: `/api/ai/url-sources`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
876
|
+
/**
|
|
877
|
+
* No description
|
|
878
|
+
*
|
|
879
|
+
* @tags AiUrlSource
|
|
880
|
+
* @name GetAiUrlSource
|
|
881
|
+
* @summary Get URL source by ID
|
|
882
|
+
* @request GET:/api/ai/url-sources/{id}
|
|
883
|
+
* @secure
|
|
884
|
+
* @response `200` `AiUrlSource` OK
|
|
885
|
+
* @response `404` `ProblemDetails` Not Found
|
|
886
|
+
*/
|
|
887
|
+
getAiUrlSource: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/url-sources/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
888
|
+
/**
|
|
889
|
+
* No description
|
|
890
|
+
*
|
|
891
|
+
* @tags AiUrlSource
|
|
892
|
+
* @name UpdateAiUrlSource
|
|
893
|
+
* @summary Update URL source
|
|
894
|
+
* @request PUT:/api/ai/url-sources/{id}
|
|
895
|
+
* @secure
|
|
896
|
+
* @response `200` `AiUrlSource` OK
|
|
897
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
898
|
+
* @response `404` `ProblemDetails` Not Found
|
|
899
|
+
* @response `409` `ProblemDetails` Conflict
|
|
900
|
+
*/
|
|
901
|
+
updateAiUrlSource: (id, data, params = {}) => this.request(Object.assign({ path: `/api/ai/url-sources/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
902
|
+
/**
|
|
903
|
+
* No description
|
|
904
|
+
*
|
|
905
|
+
* @tags AiUrlSource
|
|
906
|
+
* @name DeleteAiUrlSource
|
|
907
|
+
* @summary Delete URL source
|
|
908
|
+
* @request DELETE:/api/ai/url-sources/{id}
|
|
909
|
+
* @secure
|
|
910
|
+
* @response `204` `void` No Content
|
|
911
|
+
* @response `404` `ProblemDetails` Not Found
|
|
912
|
+
*/
|
|
913
|
+
deleteAiUrlSource: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/url-sources/${id}`, method: "DELETE", secure: true }, params)),
|
|
914
|
+
/**
|
|
915
|
+
* No description
|
|
916
|
+
*
|
|
917
|
+
* @tags AiUrlSource
|
|
918
|
+
* @name ToggleAiUrlSource
|
|
919
|
+
* @summary Toggle URL source active/inactive
|
|
920
|
+
* @request PATCH:/api/ai/url-sources/{id}/toggle
|
|
921
|
+
* @secure
|
|
922
|
+
* @response `200` `AiUrlSource` OK
|
|
923
|
+
* @response `404` `ProblemDetails` Not Found
|
|
924
|
+
*/
|
|
925
|
+
toggleAiUrlSource: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/url-sources/${id}/toggle`, method: "PATCH", secure: true, format: "json" }, params)),
|
|
926
|
+
/**
|
|
927
|
+
* No description
|
|
928
|
+
*
|
|
929
|
+
* @tags AiUsage
|
|
930
|
+
* @name GetAiUsage
|
|
931
|
+
* @summary Get the current account's AI token usage for the active monthly window
|
|
932
|
+
* @request GET:/api/ai/usage
|
|
933
|
+
* @secure
|
|
934
|
+
* @response `200` `AiTokenBudgetStatus` OK
|
|
935
|
+
*/
|
|
936
|
+
getAiUsage: (params = {}) => this.request(Object.assign({ path: `/api/ai/usage`, method: "GET", secure: true, format: "json" }, params)),
|
|
937
|
+
/**
|
|
938
|
+
* No description
|
|
939
|
+
*
|
|
940
|
+
* @tags AiUsage
|
|
941
|
+
* @name GetAiUsageHistory
|
|
942
|
+
* @summary Get the current account's monthly AI token usage history
|
|
943
|
+
* @request GET:/api/ai/usage/history
|
|
944
|
+
* @secure
|
|
945
|
+
* @response `200` `AiTokenUsageWindowPaginated` OK
|
|
946
|
+
*/
|
|
947
|
+
getAiUsageHistory: (query, params = {}) => this.request(Object.assign({ path: `/api/ai/usage/history`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
948
|
+
/**
|
|
949
|
+
* No description
|
|
950
|
+
*
|
|
951
|
+
* @tags AuditLog
|
|
952
|
+
* @name SearchAuditLogs
|
|
953
|
+
* @summary Search
|
|
954
|
+
* @request POST:/api/audit-logs/search
|
|
955
|
+
* @secure
|
|
956
|
+
* @response `200` `AuditLogEntryPaginated` OK
|
|
957
|
+
*/
|
|
958
|
+
searchAuditLogs: (data, query, params = {}) => this.request(Object.assign({ path: `/api/audit-logs/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
959
|
+
/**
|
|
960
|
+
* No description
|
|
961
|
+
*
|
|
962
|
+
* @tags AuditLog
|
|
963
|
+
* @name GetAuditLogEntityTypes
|
|
964
|
+
* @summary Get entity types
|
|
965
|
+
* @request GET:/api/audit-logs/entity-types
|
|
966
|
+
* @secure
|
|
967
|
+
* @response `200` `(AuditEntityType)[]` OK
|
|
968
|
+
*/
|
|
969
|
+
getAuditLogEntityTypes: (params = {}) => this.request(Object.assign({ path: `/api/audit-logs/entity-types`, method: "GET", secure: true, format: "json" }, params)),
|
|
970
|
+
/**
|
|
971
|
+
* No description
|
|
972
|
+
*
|
|
973
|
+
* @tags AuditLog
|
|
974
|
+
* @name GetAuditLogById
|
|
975
|
+
* @summary Get by ID
|
|
976
|
+
* @request GET:/api/audit-logs/{id}
|
|
977
|
+
* @secure
|
|
978
|
+
* @response `200` `AuditLogEntry` OK
|
|
979
|
+
* @response `404` `ProblemDetails` Not Found
|
|
980
|
+
*/
|
|
981
|
+
getAuditLogById: (id, params = {}) => this.request(Object.assign({ path: `/api/audit-logs/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
982
|
+
/**
|
|
983
|
+
* No description
|
|
984
|
+
*
|
|
985
|
+
* @tags Auth
|
|
986
|
+
* @name AuthForgotPassword
|
|
987
|
+
* @summary Forgot Password (branded)
|
|
988
|
+
* @request POST:/api/auth/forgot-password
|
|
989
|
+
* @secure
|
|
990
|
+
* @response `204` `void` No Content
|
|
991
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
192
992
|
*/
|
|
193
|
-
|
|
993
|
+
authForgotPassword: (data, params = {}) => this.request(Object.assign({ path: `/api/auth/forgot-password`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
|
|
194
994
|
/**
|
|
195
995
|
* No description
|
|
196
996
|
*
|
|
197
|
-
* @tags
|
|
198
|
-
* @name
|
|
199
|
-
* @summary
|
|
200
|
-
* @request POST:/api/
|
|
997
|
+
* @tags Auth
|
|
998
|
+
* @name AuthResetPassword
|
|
999
|
+
* @summary Reset Password (branded)
|
|
1000
|
+
* @request POST:/api/auth/reset-password
|
|
201
1001
|
* @secure
|
|
202
|
-
* @response `
|
|
203
|
-
* @response `422` `
|
|
1002
|
+
* @response `204` `void` No Content
|
|
1003
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
204
1004
|
*/
|
|
205
|
-
|
|
1005
|
+
authResetPassword: (data, params = {}) => this.request(Object.assign({ path: `/api/auth/reset-password`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
|
|
206
1006
|
/**
|
|
207
1007
|
* No description
|
|
208
1008
|
*
|
|
209
|
-
* @tags
|
|
210
|
-
* @name
|
|
211
|
-
* @summary
|
|
212
|
-
* @request
|
|
1009
|
+
* @tags Auth
|
|
1010
|
+
* @name AuthSetPassword
|
|
1011
|
+
* @summary Set Password (branded account setup)
|
|
1012
|
+
* @request POST:/api/auth/set-password
|
|
213
1013
|
* @secure
|
|
214
|
-
* @response `
|
|
215
|
-
* @response `422` `
|
|
1014
|
+
* @response `204` `void` No Content
|
|
1015
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
216
1016
|
*/
|
|
217
|
-
|
|
1017
|
+
authSetPassword: (data, params = {}) => this.request(Object.assign({ path: `/api/auth/set-password`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
|
|
218
1018
|
/**
|
|
219
1019
|
* No description
|
|
220
1020
|
*
|
|
221
|
-
* @tags
|
|
222
|
-
* @name
|
|
223
|
-
* @summary
|
|
224
|
-
* @request
|
|
1021
|
+
* @tags Auth
|
|
1022
|
+
* @name AuthSendVerificationEmail
|
|
1023
|
+
* @summary Send branded email-verification link to the current user
|
|
1024
|
+
* @request POST:/api/auth/send-verification-email
|
|
225
1025
|
* @secure
|
|
226
|
-
* @response `204` `
|
|
227
|
-
* @response `404` `ProblemDetails` Not Found
|
|
228
|
-
* @response `422` `ProblemDetails` Client Error
|
|
1026
|
+
* @response `204` `void` No Content
|
|
229
1027
|
*/
|
|
230
|
-
|
|
1028
|
+
authSendVerificationEmail: (params = {}) => this.request(Object.assign({ path: `/api/auth/send-verification-email`, method: "POST", secure: true }, params)),
|
|
231
1029
|
/**
|
|
232
1030
|
* No description
|
|
233
1031
|
*
|
|
234
|
-
* @tags
|
|
235
|
-
* @name
|
|
236
|
-
* @summary
|
|
237
|
-
* @request
|
|
1032
|
+
* @tags Auth
|
|
1033
|
+
* @name AuthVerifyEmail
|
|
1034
|
+
* @summary Verify Email (branded)
|
|
1035
|
+
* @request POST:/api/auth/verify-email
|
|
238
1036
|
* @secure
|
|
239
|
-
* @response `
|
|
240
|
-
* @response `
|
|
241
|
-
* @response `422` `ProblemDetails` Client Error
|
|
1037
|
+
* @response `204` `void` No Content
|
|
1038
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
242
1039
|
*/
|
|
243
|
-
|
|
1040
|
+
authVerifyEmail: (data, params = {}) => this.request(Object.assign({ path: `/api/auth/verify-email`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
|
|
244
1041
|
/**
|
|
245
1042
|
* No description
|
|
246
1043
|
*
|
|
@@ -249,11 +1046,11 @@ export class Api extends HttpClient {
|
|
|
249
1046
|
* @summary Generate Token From Refresh Token
|
|
250
1047
|
* @request POST:/api/refresh-token
|
|
251
1048
|
* @secure
|
|
252
|
-
* @response `200` `Token`
|
|
1049
|
+
* @response `200` `Token` OK
|
|
253
1050
|
* @response `401` `ProblemDetails` Unauthorized
|
|
254
|
-
* @response `422` `UnprocessableEntity`
|
|
1051
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
255
1052
|
*/
|
|
256
|
-
getTokenFromRefreshToken: (data, params = {}) => this.request(Object.assign({ path: `/api/refresh-token`, method: "POST", body: data, secure: true, type:
|
|
1053
|
+
getTokenFromRefreshToken: (data, params = {}) => this.request(Object.assign({ path: `/api/refresh-token`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
257
1054
|
/**
|
|
258
1055
|
* No description
|
|
259
1056
|
*
|
|
@@ -262,10 +1059,10 @@ export class Api extends HttpClient {
|
|
|
262
1059
|
* @summary Get Token
|
|
263
1060
|
* @request POST:/api/token
|
|
264
1061
|
* @secure
|
|
265
|
-
* @response `200` `
|
|
266
|
-
* @response `422` `UnprocessableEntity`
|
|
1062
|
+
* @response `200` `AccountDeactivated` OK
|
|
1063
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
267
1064
|
*/
|
|
268
|
-
getToken: (data, params = {}) => this.request(Object.assign({ path: `/api/token`, method: "POST", body: data, secure: true, type:
|
|
1065
|
+
getToken: (data, params = {}) => this.request(Object.assign({ path: `/api/token`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
269
1066
|
/**
|
|
270
1067
|
* No description
|
|
271
1068
|
*
|
|
@@ -274,10 +1071,10 @@ export class Api extends HttpClient {
|
|
|
274
1071
|
* @summary Get Token From Challenge Code
|
|
275
1072
|
* @request POST:/api/token/code
|
|
276
1073
|
* @secure
|
|
277
|
-
* @response `200` `
|
|
278
|
-
* @response `422` `UnprocessableEntity`
|
|
1074
|
+
* @response `200` `AccountDeactivated` OK
|
|
1075
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
279
1076
|
*/
|
|
280
|
-
getTokenFromChallengeCode: (data, params = {}) => this.request(Object.assign({ path: `/api/token/code`, method: "POST", body: data, secure: true, type:
|
|
1077
|
+
getTokenFromChallengeCode: (data, params = {}) => this.request(Object.assign({ path: `/api/token/code`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
281
1078
|
/**
|
|
282
1079
|
* No description
|
|
283
1080
|
*
|
|
@@ -286,10 +1083,10 @@ export class Api extends HttpClient {
|
|
|
286
1083
|
* @summary Get System Token
|
|
287
1084
|
* @request POST:/api/oauth2/token
|
|
288
1085
|
* @secure
|
|
289
|
-
* @response `200` `Token`
|
|
290
|
-
* @response `422` `UnprocessableEntity`
|
|
1086
|
+
* @response `200` `Token` OK
|
|
1087
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
291
1088
|
*/
|
|
292
|
-
getSystemToken: (data, params = {}) => this.request(Object.assign({ path: `/api/oauth2/token`, method: "POST", body: data, secure: true, type:
|
|
1089
|
+
getSystemToken: (data, params = {}) => this.request(Object.assign({ path: `/api/oauth2/token`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
293
1090
|
/**
|
|
294
1091
|
* No description
|
|
295
1092
|
*
|
|
@@ -298,10 +1095,10 @@ export class Api extends HttpClient {
|
|
|
298
1095
|
* @summary Get SSO Guid Token
|
|
299
1096
|
* @request POST:/api/token/sso
|
|
300
1097
|
* @secure
|
|
301
|
-
* @response `200` `SSOToken`
|
|
302
|
-
* @response `422` `UnprocessableEntity`
|
|
1098
|
+
* @response `200` `SSOToken` OK
|
|
1099
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
303
1100
|
*/
|
|
304
|
-
getSsoToken: (data, params = {}) => this.request(Object.assign({ path: `/api/token/sso`, method: "POST", body: data, secure: true, type:
|
|
1101
|
+
getSsoToken: (data, params = {}) => this.request(Object.assign({ path: `/api/token/sso`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
305
1102
|
/**
|
|
306
1103
|
* No description
|
|
307
1104
|
*
|
|
@@ -311,7 +1108,7 @@ export class Api extends HttpClient {
|
|
|
311
1108
|
* @request POST:/api/logout
|
|
312
1109
|
* @secure
|
|
313
1110
|
* @response `204` `NoContentResult` No Content
|
|
314
|
-
* @response `422` `UnprocessableEntity`
|
|
1111
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
315
1112
|
*/
|
|
316
1113
|
logOut: (params = {}) => this.request(Object.assign({ path: `/api/logout`, method: "POST", secure: true, format: "json" }, params)),
|
|
317
1114
|
/**
|
|
@@ -322,7 +1119,7 @@ export class Api extends HttpClient {
|
|
|
322
1119
|
* @summary Get All
|
|
323
1120
|
* @request GET:/api/branches
|
|
324
1121
|
* @secure
|
|
325
|
-
* @response `200` `GetBranchPaginated`
|
|
1122
|
+
* @response `200` `GetBranchPaginated` OK
|
|
326
1123
|
*/
|
|
327
1124
|
getBranches: (query, params = {}) => this.request(Object.assign({ path: `/api/branches`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
328
1125
|
/**
|
|
@@ -333,10 +1130,10 @@ export class Api extends HttpClient {
|
|
|
333
1130
|
* @summary Create
|
|
334
1131
|
* @request POST:/api/branches
|
|
335
1132
|
* @secure
|
|
336
|
-
* @response `200` `GetBranch`
|
|
337
|
-
* @response `422` `UnprocessableEntity`
|
|
1133
|
+
* @response `200` `GetBranch` OK
|
|
1134
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
338
1135
|
*/
|
|
339
|
-
createBranch: (data, params = {}) => this.request(Object.assign({ path: `/api/branches`, method: "POST", body: data, secure: true, type:
|
|
1136
|
+
createBranch: (data, params = {}) => this.request(Object.assign({ path: `/api/branches`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
340
1137
|
/**
|
|
341
1138
|
* No description
|
|
342
1139
|
*
|
|
@@ -345,9 +1142,9 @@ export class Api extends HttpClient {
|
|
|
345
1142
|
* @summary Search
|
|
346
1143
|
* @request POST:/api/branches/search
|
|
347
1144
|
* @secure
|
|
348
|
-
* @response `200` `GetBranchPaginated`
|
|
1145
|
+
* @response `200` `GetBranchPaginated` OK
|
|
349
1146
|
*/
|
|
350
|
-
searchBranches: (data, query, params = {}) => this.request(Object.assign({ path: `/api/branches/search`, method: "POST", query: query, body: data, secure: true, type:
|
|
1147
|
+
searchBranches: (data, query, params = {}) => this.request(Object.assign({ path: `/api/branches/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
351
1148
|
/**
|
|
352
1149
|
* No description
|
|
353
1150
|
*
|
|
@@ -356,7 +1153,7 @@ export class Api extends HttpClient {
|
|
|
356
1153
|
* @summary Get by ID
|
|
357
1154
|
* @request GET:/api/branches/{branchId}
|
|
358
1155
|
* @secure
|
|
359
|
-
* @response `200` `GetBranch`
|
|
1156
|
+
* @response `200` `GetBranch` OK
|
|
360
1157
|
*/
|
|
361
1158
|
getBranch: (branchId, params = {}) => this.request(Object.assign({ path: `/api/branches/${branchId}`, method: "GET", secure: true, format: "json" }, params)),
|
|
362
1159
|
/**
|
|
@@ -367,10 +1164,10 @@ export class Api extends HttpClient {
|
|
|
367
1164
|
* @summary Replace
|
|
368
1165
|
* @request PUT:/api/branches/{branchId}
|
|
369
1166
|
* @secure
|
|
370
|
-
* @response `200` `GetBranch`
|
|
371
|
-
* @response `422` `UnprocessableEntity`
|
|
1167
|
+
* @response `200` `GetBranch` OK
|
|
1168
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
372
1169
|
*/
|
|
373
|
-
replaceBranch: (branchId, data, params = {}) => this.request(Object.assign({ path: `/api/branches/${branchId}`, method: "PUT", body: data, secure: true, type:
|
|
1170
|
+
replaceBranch: (branchId, data, params = {}) => this.request(Object.assign({ path: `/api/branches/${branchId}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
374
1171
|
/**
|
|
375
1172
|
* No description
|
|
376
1173
|
*
|
|
@@ -402,10 +1199,10 @@ export class Api extends HttpClient {
|
|
|
402
1199
|
* @summary Create Branch Site Configuration
|
|
403
1200
|
* @request POST:/api/branches/{branchId}/site-configurations
|
|
404
1201
|
* @secure
|
|
405
|
-
* @response `200` `SiteConfiguration`
|
|
406
|
-
* @response `422` `UnprocessableEntity`
|
|
1202
|
+
* @response `200` `SiteConfiguration` OK
|
|
1203
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
407
1204
|
*/
|
|
408
|
-
createBranchSiteConfiguration: (branchId, data, params = {}) => this.request(Object.assign({ path: `/api/branches/${branchId}/site-configurations`, method: "POST", body: data, secure: true, type:
|
|
1205
|
+
createBranchSiteConfiguration: (branchId, data, params = {}) => this.request(Object.assign({ path: `/api/branches/${branchId}/site-configurations`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
409
1206
|
/**
|
|
410
1207
|
* No description
|
|
411
1208
|
*
|
|
@@ -414,7 +1211,7 @@ export class Api extends HttpClient {
|
|
|
414
1211
|
* @summary Get Branch Site Configuration
|
|
415
1212
|
* @request GET:/api/branches/{branchId}/site-configurations/{siteConfigurationId}
|
|
416
1213
|
* @secure
|
|
417
|
-
* @response `200` `SiteConfigurationWithInherited`
|
|
1214
|
+
* @response `200` `SiteConfigurationWithInherited` OK
|
|
418
1215
|
*/
|
|
419
1216
|
getBranchSiteConfiguration: (branchId, siteConfigurationId, params = {}) => this.request(Object.assign({ path: `/api/branches/${branchId}/site-configurations/${siteConfigurationId}`, method: "GET", secure: true, format: "json" }, params)),
|
|
420
1217
|
/**
|
|
@@ -425,10 +1222,10 @@ export class Api extends HttpClient {
|
|
|
425
1222
|
* @summary Replace Branch Site Configuration
|
|
426
1223
|
* @request PUT:/api/branches/{branchId}/site-configurations/{siteConfigurationId}
|
|
427
1224
|
* @secure
|
|
428
|
-
* @response `200` `SiteConfiguration`
|
|
429
|
-
* @response `422` `UnprocessableEntity`
|
|
1225
|
+
* @response `200` `SiteConfiguration` OK
|
|
1226
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
430
1227
|
*/
|
|
431
|
-
replaceBranchSiteConfiguration: (branchId, siteConfigurationId, data, query, params = {}) => this.request(Object.assign({ path: `/api/branches/${branchId}/site-configurations/${siteConfigurationId}`, method: "PUT", query: query, body: data, secure: true, type:
|
|
1228
|
+
replaceBranchSiteConfiguration: (branchId, siteConfigurationId, data, query, params = {}) => this.request(Object.assign({ path: `/api/branches/${branchId}/site-configurations/${siteConfigurationId}`, method: "PUT", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
432
1229
|
/**
|
|
433
1230
|
* No description
|
|
434
1231
|
*
|
|
@@ -437,7 +1234,7 @@ export class Api extends HttpClient {
|
|
|
437
1234
|
* @summary Get Branch Loan Officers
|
|
438
1235
|
* @request GET:/api/branches/{branchId}/loan-officers
|
|
439
1236
|
* @secure
|
|
440
|
-
* @response `200` `LoanOfficerPublic`
|
|
1237
|
+
* @response `200` `(LoanOfficerPublic)[]` OK
|
|
441
1238
|
*/
|
|
442
1239
|
getLoanOfficersByBranch: (branchId, params = {}) => this.request(Object.assign({ path: `/api/branches/${branchId}/loan-officers`, method: "GET", secure: true, format: "json" }, params)),
|
|
443
1240
|
/**
|
|
@@ -448,7 +1245,7 @@ export class Api extends HttpClient {
|
|
|
448
1245
|
* @summary Get All
|
|
449
1246
|
* @request GET:/api/business-rules
|
|
450
1247
|
* @secure
|
|
451
|
-
* @response `200` `(BusinessRule)[]`
|
|
1248
|
+
* @response `200` `(BusinessRule)[]` OK
|
|
452
1249
|
*/
|
|
453
1250
|
getBusinessRules: (query, params = {}) => this.request(Object.assign({ path: `/api/business-rules`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
454
1251
|
/**
|
|
@@ -459,10 +1256,10 @@ export class Api extends HttpClient {
|
|
|
459
1256
|
* @summary Create
|
|
460
1257
|
* @request POST:/api/business-rules
|
|
461
1258
|
* @secure
|
|
462
|
-
* @response `200` `BusinessRule`
|
|
463
|
-
* @response `422` `UnprocessableEntity`
|
|
1259
|
+
* @response `200` `BusinessRule` OK
|
|
1260
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
464
1261
|
*/
|
|
465
|
-
createBusinessRule: (data, params = {}) => this.request(Object.assign({ path: `/api/business-rules`, method: "POST", body: data, secure: true, type:
|
|
1262
|
+
createBusinessRule: (data, params = {}) => this.request(Object.assign({ path: `/api/business-rules`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
466
1263
|
/**
|
|
467
1264
|
* No description
|
|
468
1265
|
*
|
|
@@ -471,7 +1268,7 @@ export class Api extends HttpClient {
|
|
|
471
1268
|
* @summary Get by ID
|
|
472
1269
|
* @request GET:/api/business-rules/{id}
|
|
473
1270
|
* @secure
|
|
474
|
-
* @response `200` `BusinessRule`
|
|
1271
|
+
* @response `200` `BusinessRule` OK
|
|
475
1272
|
*/
|
|
476
1273
|
getBusinessRule: (id, params = {}) => this.request(Object.assign({ path: `/api/business-rules/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
477
1274
|
/**
|
|
@@ -482,10 +1279,10 @@ export class Api extends HttpClient {
|
|
|
482
1279
|
* @summary Replace
|
|
483
1280
|
* @request PUT:/api/business-rules/{id}
|
|
484
1281
|
* @secure
|
|
485
|
-
* @response `200` `BusinessRule`
|
|
486
|
-
* @response `422` `UnprocessableEntity`
|
|
1282
|
+
* @response `200` `BusinessRule` OK
|
|
1283
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
487
1284
|
*/
|
|
488
|
-
replaceBusinessRule: (id, data, params = {}) => this.request(Object.assign({ path: `/api/business-rules/${id}`, method: "PUT", body: data, secure: true, type:
|
|
1285
|
+
replaceBusinessRule: (id, data, params = {}) => this.request(Object.assign({ path: `/api/business-rules/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
489
1286
|
/**
|
|
490
1287
|
* No description
|
|
491
1288
|
*
|
|
@@ -505,7 +1302,7 @@ export class Api extends HttpClient {
|
|
|
505
1302
|
* @summary Restore
|
|
506
1303
|
* @request POST:/api/business-rules/{id}/restore
|
|
507
1304
|
* @secure
|
|
508
|
-
* @response `200` `BusinessRule`
|
|
1305
|
+
* @response `200` `BusinessRule` OK
|
|
509
1306
|
*/
|
|
510
1307
|
restoreBusinessRule: (id, params = {}) => this.request(Object.assign({ path: `/api/business-rules/${id}/restore`, method: "POST", secure: true, format: "json" }, params)),
|
|
511
1308
|
/**
|
|
@@ -516,9 +1313,31 @@ export class Api extends HttpClient {
|
|
|
516
1313
|
* @summary Get Closed Loans Report
|
|
517
1314
|
* @request POST:/api/loans/reports/closed-loans
|
|
518
1315
|
* @secure
|
|
519
|
-
* @response `200` `ClosedLoansReport`
|
|
1316
|
+
* @response `200` `ClosedLoansReport` OK
|
|
1317
|
+
*/
|
|
1318
|
+
getClosedLoansReport: (data, params = {}) => this.request(Object.assign({ path: `/api/loans/reports/closed-loans`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1319
|
+
/**
|
|
1320
|
+
* No description
|
|
1321
|
+
*
|
|
1322
|
+
* @tags ConsumerConnect
|
|
1323
|
+
* @name GetConsumerConnectStatus
|
|
1324
|
+
* @summary Get Consumer Connect association status for all borrowers on a loan
|
|
1325
|
+
* @request GET:/api/loans/{loanId}/consumer-connect/status
|
|
1326
|
+
* @secure
|
|
1327
|
+
* @response `200` `(ConsumerConnectStatus)[]` OK
|
|
1328
|
+
*/
|
|
1329
|
+
getConsumerConnectStatus: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/consumer-connect/status`, method: "GET", secure: true, format: "json" }, params)),
|
|
1330
|
+
/**
|
|
1331
|
+
* No description
|
|
1332
|
+
*
|
|
1333
|
+
* @tags ConsumerConnect
|
|
1334
|
+
* @name RetryConsumerConnectAssociation
|
|
1335
|
+
* @summary Manually retry Consumer Connect association for failed borrowers on a loan. Set force=true to also re-run borrowers already marked Success. Returns per-borrower results; check individual Success fields for partial failures.
|
|
1336
|
+
* @request POST:/api/loans/{loanId}/consumer-connect/retry
|
|
1337
|
+
* @secure
|
|
1338
|
+
* @response `200` `(ConsumerConnectRetry)[]` OK
|
|
520
1339
|
*/
|
|
521
|
-
|
|
1340
|
+
retryConsumerConnectAssociation: (loanId, query, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/consumer-connect/retry`, method: "POST", query: query, secure: true, format: "json" }, params)),
|
|
522
1341
|
/**
|
|
523
1342
|
* No description
|
|
524
1343
|
*
|
|
@@ -527,7 +1346,7 @@ export class Api extends HttpClient {
|
|
|
527
1346
|
* @summary Get All
|
|
528
1347
|
* @request GET:/api/corporates
|
|
529
1348
|
* @secure
|
|
530
|
-
* @response `200` `CorporatePaginated`
|
|
1349
|
+
* @response `200` `CorporatePaginated` OK
|
|
531
1350
|
*/
|
|
532
1351
|
getCorporates: (query, params = {}) => this.request(Object.assign({ path: `/api/corporates`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
533
1352
|
/**
|
|
@@ -538,10 +1357,10 @@ export class Api extends HttpClient {
|
|
|
538
1357
|
* @summary Create
|
|
539
1358
|
* @request POST:/api/corporates
|
|
540
1359
|
* @secure
|
|
541
|
-
* @response `200` `Corporate`
|
|
542
|
-
* @response `422` `UnprocessableEntity`
|
|
1360
|
+
* @response `200` `Corporate` OK
|
|
1361
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
543
1362
|
*/
|
|
544
|
-
createCorporate: (data, params = {}) => this.request(Object.assign({ path: `/api/corporates`, method: "POST", body: data, secure: true, type:
|
|
1363
|
+
createCorporate: (data, params = {}) => this.request(Object.assign({ path: `/api/corporates`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
545
1364
|
/**
|
|
546
1365
|
* No description
|
|
547
1366
|
*
|
|
@@ -550,9 +1369,9 @@ export class Api extends HttpClient {
|
|
|
550
1369
|
* @summary Search
|
|
551
1370
|
* @request POST:/api/corporates/search
|
|
552
1371
|
* @secure
|
|
553
|
-
* @response `200` `CorporatePaginated`
|
|
1372
|
+
* @response `200` `CorporatePaginated` OK
|
|
554
1373
|
*/
|
|
555
|
-
searchCorporate: (data, query, params = {}) => this.request(Object.assign({ path: `/api/corporates/search`, method: "POST", query: query, body: data, secure: true, type:
|
|
1374
|
+
searchCorporate: (data, query, params = {}) => this.request(Object.assign({ path: `/api/corporates/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
556
1375
|
/**
|
|
557
1376
|
* No description
|
|
558
1377
|
*
|
|
@@ -561,7 +1380,7 @@ export class Api extends HttpClient {
|
|
|
561
1380
|
* @summary Get by ID
|
|
562
1381
|
* @request GET:/api/corporates/{id}
|
|
563
1382
|
* @secure
|
|
564
|
-
* @response `200` `Corporate`
|
|
1383
|
+
* @response `200` `Corporate` OK
|
|
565
1384
|
*/
|
|
566
1385
|
getCorporate: (id, params = {}) => this.request(Object.assign({ path: `/api/corporates/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
567
1386
|
/**
|
|
@@ -572,10 +1391,10 @@ export class Api extends HttpClient {
|
|
|
572
1391
|
* @summary Replace
|
|
573
1392
|
* @request PUT:/api/corporates/{id}
|
|
574
1393
|
* @secure
|
|
575
|
-
* @response `200` `Corporate`
|
|
576
|
-
* @response `422` `UnprocessableEntity`
|
|
1394
|
+
* @response `200` `Corporate` OK
|
|
1395
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
577
1396
|
*/
|
|
578
|
-
replaceCorporate: (id, data, params = {}) => this.request(Object.assign({ path: `/api/corporates/${id}`, method: "PUT", body: data, secure: true, type:
|
|
1397
|
+
replaceCorporate: (id, data, params = {}) => this.request(Object.assign({ path: `/api/corporates/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
579
1398
|
/**
|
|
580
1399
|
* No description
|
|
581
1400
|
*
|
|
@@ -606,10 +1425,10 @@ export class Api extends HttpClient {
|
|
|
606
1425
|
* @summary Create Site Configuration
|
|
607
1426
|
* @request POST:/api/corporates/{corporateId}/site-configurations
|
|
608
1427
|
* @secure
|
|
609
|
-
* @response `200` `SiteConfiguration`
|
|
610
|
-
* @response `422` `UnprocessableEntity`
|
|
1428
|
+
* @response `200` `SiteConfiguration` OK
|
|
1429
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
611
1430
|
*/
|
|
612
|
-
createCorporateSiteConfiguration: (corporateId, data, params = {}) => this.request(Object.assign({ path: `/api/corporates/${corporateId}/site-configurations`, method: "POST", body: data, secure: true, type:
|
|
1431
|
+
createCorporateSiteConfiguration: (corporateId, data, params = {}) => this.request(Object.assign({ path: `/api/corporates/${corporateId}/site-configurations`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
613
1432
|
/**
|
|
614
1433
|
* No description
|
|
615
1434
|
*
|
|
@@ -618,7 +1437,7 @@ export class Api extends HttpClient {
|
|
|
618
1437
|
* @summary Get Site Configuration
|
|
619
1438
|
* @request GET:/api/corporates/{corporateId}/site-configurations/{siteConfigurationId}
|
|
620
1439
|
* @secure
|
|
621
|
-
* @response `200` `SiteConfigurationWithInherited`
|
|
1440
|
+
* @response `200` `SiteConfigurationWithInherited` OK
|
|
622
1441
|
*/
|
|
623
1442
|
getCorporateSiteConfiguration: (corporateId, siteConfigurationId, params = {}) => this.request(Object.assign({ path: `/api/corporates/${corporateId}/site-configurations/${siteConfigurationId}`, method: "GET", secure: true, format: "json" }, params)),
|
|
624
1443
|
/**
|
|
@@ -629,10 +1448,10 @@ export class Api extends HttpClient {
|
|
|
629
1448
|
* @summary Replace Site Configuration
|
|
630
1449
|
* @request PUT:/api/corporates/{corporateId}/site-configurations/{siteConfigurationId}
|
|
631
1450
|
* @secure
|
|
632
|
-
* @response `200` `SiteConfiguration`
|
|
633
|
-
* @response `422` `UnprocessableEntity`
|
|
1451
|
+
* @response `200` `SiteConfiguration` OK
|
|
1452
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
634
1453
|
*/
|
|
635
|
-
replaceCorporateSiteConfiguration: (corporateId, siteConfigurationId, data, query, params = {}) => this.request(Object.assign({ path: `/api/corporates/${corporateId}/site-configurations/${siteConfigurationId}`, method: "PUT", query: query, body: data, secure: true, type:
|
|
1454
|
+
replaceCorporateSiteConfiguration: (corporateId, siteConfigurationId, data, query, params = {}) => this.request(Object.assign({ path: `/api/corporates/${corporateId}/site-configurations/${siteConfigurationId}`, method: "PUT", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
636
1455
|
/**
|
|
637
1456
|
* No description
|
|
638
1457
|
*
|
|
@@ -641,7 +1460,7 @@ export class Api extends HttpClient {
|
|
|
641
1460
|
* @summary Get Branches
|
|
642
1461
|
* @request GET:/api/corporates/{id}/branches
|
|
643
1462
|
* @secure
|
|
644
|
-
* @response `200` `(BranchReduced)[]`
|
|
1463
|
+
* @response `200` `(BranchReduced)[]` OK
|
|
645
1464
|
*/
|
|
646
1465
|
getBranchesByCorporate: (id, params = {}) => this.request(Object.assign({ path: `/api/corporates/${id}/branches`, method: "GET", secure: true, format: "json" }, params)),
|
|
647
1466
|
/**
|
|
@@ -652,9 +1471,97 @@ export class Api extends HttpClient {
|
|
|
652
1471
|
* @summary Get Loan Officers
|
|
653
1472
|
* @request GET:/api/corporates/{id}/loan-officers
|
|
654
1473
|
* @secure
|
|
655
|
-
* @response `200` `LoanOfficerPublic`
|
|
1474
|
+
* @response `200` `(LoanOfficerPublic)[]` OK
|
|
656
1475
|
*/
|
|
657
1476
|
getLoanOfficersByCorporate: (id, params = {}) => this.request(Object.assign({ path: `/api/corporates/${id}/loan-officers`, method: "GET", secure: true, format: "json" }, params)),
|
|
1477
|
+
/**
|
|
1478
|
+
* No description
|
|
1479
|
+
*
|
|
1480
|
+
* @tags CustomFieldDefinitions
|
|
1481
|
+
* @name GetCustomFieldDefinitions
|
|
1482
|
+
* @summary Get all custom field definitions by entity type
|
|
1483
|
+
* @request GET:/api/custom-field-definitions
|
|
1484
|
+
* @secure
|
|
1485
|
+
* @response `200` `(CustomFieldDefinition)[]` OK
|
|
1486
|
+
*/
|
|
1487
|
+
getCustomFieldDefinitions: (query, params = {}) => this.request(Object.assign({ path: `/api/custom-field-definitions`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
1488
|
+
/**
|
|
1489
|
+
* No description
|
|
1490
|
+
*
|
|
1491
|
+
* @tags CustomFieldDefinitions
|
|
1492
|
+
* @name CreateCustomFieldDefinition
|
|
1493
|
+
* @summary Create a custom field definition
|
|
1494
|
+
* @request POST:/api/custom-field-definitions
|
|
1495
|
+
* @secure
|
|
1496
|
+
* @response `201` `CustomFieldDefinition` Created
|
|
1497
|
+
* @response `409` `ProblemDetails` Conflict
|
|
1498
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
1499
|
+
*/
|
|
1500
|
+
createCustomFieldDefinition: (data, params = {}) => this.request(Object.assign({ path: `/api/custom-field-definitions`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1501
|
+
/**
|
|
1502
|
+
* No description
|
|
1503
|
+
*
|
|
1504
|
+
* @tags CustomFieldDefinitions
|
|
1505
|
+
* @name GetCustomFieldDefinitionById
|
|
1506
|
+
* @summary Get a custom field definition by ID
|
|
1507
|
+
* @request GET:/api/custom-field-definitions/{id}
|
|
1508
|
+
* @secure
|
|
1509
|
+
* @response `200` `CustomFieldDefinition` OK
|
|
1510
|
+
* @response `404` `ProblemDetails` Not Found
|
|
1511
|
+
*/
|
|
1512
|
+
getCustomFieldDefinitionById: (id, params = {}) => this.request(Object.assign({ path: `/api/custom-field-definitions/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
1513
|
+
/**
|
|
1514
|
+
* No description
|
|
1515
|
+
*
|
|
1516
|
+
* @tags CustomFieldDefinitions
|
|
1517
|
+
* @name UpdateCustomFieldDefinition
|
|
1518
|
+
* @summary Update a custom field definition
|
|
1519
|
+
* @request PUT:/api/custom-field-definitions/{id}
|
|
1520
|
+
* @secure
|
|
1521
|
+
* @response `200` `CustomFieldDefinition` OK
|
|
1522
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
1523
|
+
* @response `404` `ProblemDetails` Not Found
|
|
1524
|
+
* @response `409` `ProblemDetails` Conflict
|
|
1525
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
1526
|
+
*/
|
|
1527
|
+
updateCustomFieldDefinition: (id, data, params = {}) => this.request(Object.assign({ path: `/api/custom-field-definitions/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1528
|
+
/**
|
|
1529
|
+
* No description
|
|
1530
|
+
*
|
|
1531
|
+
* @tags CustomFieldDefinitions
|
|
1532
|
+
* @name DeleteCustomFieldDefinition
|
|
1533
|
+
* @summary Delete a custom field definition
|
|
1534
|
+
* @request DELETE:/api/custom-field-definitions/{id}
|
|
1535
|
+
* @secure
|
|
1536
|
+
* @response `204` `void` No Content
|
|
1537
|
+
* @response `404` `ProblemDetails` Not Found
|
|
1538
|
+
* @response `409` `ProblemDetails` Conflict
|
|
1539
|
+
*/
|
|
1540
|
+
deleteCustomFieldDefinition: (id, params = {}) => this.request(Object.assign({ path: `/api/custom-field-definitions/${id}`, method: "DELETE", secure: true }, params)),
|
|
1541
|
+
/**
|
|
1542
|
+
* No description
|
|
1543
|
+
*
|
|
1544
|
+
* @tags CustomFieldDefinitions
|
|
1545
|
+
* @name DisableCustomFieldDefinition
|
|
1546
|
+
* @summary Disable a custom field definition
|
|
1547
|
+
* @request POST:/api/custom-field-definitions/{id}/disable
|
|
1548
|
+
* @secure
|
|
1549
|
+
* @response `204` `void` No Content
|
|
1550
|
+
* @response `404` `ProblemDetails` Not Found
|
|
1551
|
+
*/
|
|
1552
|
+
disableCustomFieldDefinition: (id, params = {}) => this.request(Object.assign({ path: `/api/custom-field-definitions/${id}/disable`, method: "POST", secure: true }, params)),
|
|
1553
|
+
/**
|
|
1554
|
+
* No description
|
|
1555
|
+
*
|
|
1556
|
+
* @tags CustomFieldDefinitions
|
|
1557
|
+
* @name EnableCustomFieldDefinition
|
|
1558
|
+
* @summary Enable a custom field definition
|
|
1559
|
+
* @request POST:/api/custom-field-definitions/{id}/enable
|
|
1560
|
+
* @secure
|
|
1561
|
+
* @response `204` `void` No Content
|
|
1562
|
+
* @response `404` `ProblemDetails` Not Found
|
|
1563
|
+
*/
|
|
1564
|
+
enableCustomFieldDefinition: (id, params = {}) => this.request(Object.assign({ path: `/api/custom-field-definitions/${id}/enable`, method: "POST", secure: true }, params)),
|
|
658
1565
|
/**
|
|
659
1566
|
* No description
|
|
660
1567
|
*
|
|
@@ -663,7 +1570,7 @@ export class Api extends HttpClient {
|
|
|
663
1570
|
* @summary Get All
|
|
664
1571
|
* @request GET:/api/devices
|
|
665
1572
|
* @secure
|
|
666
|
-
* @response `200` `DevicePaginated`
|
|
1573
|
+
* @response `200` `DevicePaginated` OK
|
|
667
1574
|
*/
|
|
668
1575
|
getDevices: (query, params = {}) => this.request(Object.assign({ path: `/api/devices`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
669
1576
|
/**
|
|
@@ -674,7 +1581,7 @@ export class Api extends HttpClient {
|
|
|
674
1581
|
* @summary Get by ID
|
|
675
1582
|
* @request GET:/api/devices/{id}
|
|
676
1583
|
* @secure
|
|
677
|
-
* @response `200` `Device`
|
|
1584
|
+
* @response `200` `Device` OK
|
|
678
1585
|
*/
|
|
679
1586
|
getDevice: (id, params = {}) => this.request(Object.assign({ path: `/api/devices/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
680
1587
|
/**
|
|
@@ -685,9 +1592,9 @@ export class Api extends HttpClient {
|
|
|
685
1592
|
* @summary Update
|
|
686
1593
|
* @request PUT:/api/devices/{id}
|
|
687
1594
|
* @secure
|
|
688
|
-
* @response `200` `Device`
|
|
1595
|
+
* @response `200` `Device` OK
|
|
689
1596
|
*/
|
|
690
|
-
updateDevice: (id, data, params = {}) => this.request(Object.assign({ path: `/api/devices/${id}`, method: "PUT", body: data, secure: true, type:
|
|
1597
|
+
updateDevice: (id, data, params = {}) => this.request(Object.assign({ path: `/api/devices/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
691
1598
|
/**
|
|
692
1599
|
* No description
|
|
693
1600
|
*
|
|
@@ -696,7 +1603,7 @@ export class Api extends HttpClient {
|
|
|
696
1603
|
* @summary Get by Serial Number
|
|
697
1604
|
* @request GET:/api/devices/{sn}/profile
|
|
698
1605
|
* @secure
|
|
699
|
-
* @response `200` `DeviceMDM`
|
|
1606
|
+
* @response `200` `DeviceMDM` OK
|
|
700
1607
|
*/
|
|
701
1608
|
getDeviceBySerialNumber: (sn, params = {}) => this.request(Object.assign({ path: `/api/devices/${sn}/profile`, method: "GET", secure: true, format: "json" }, params)),
|
|
702
1609
|
/**
|
|
@@ -707,7 +1614,7 @@ export class Api extends HttpClient {
|
|
|
707
1614
|
* @summary Create Action by Serial Number
|
|
708
1615
|
* @request POST:/api/devices/{sn}/actions/{actionName}
|
|
709
1616
|
* @secure
|
|
710
|
-
* @response `200` `Action`
|
|
1617
|
+
* @response `200` `Action` OK
|
|
711
1618
|
*/
|
|
712
1619
|
createDeviceActionBySerialNumber: (sn, actionName, params = {}) => this.request(Object.assign({ path: `/api/devices/${sn}/actions/${actionName}`, method: "POST", secure: true, format: "json" }, params)),
|
|
713
1620
|
/**
|
|
@@ -717,8 +1624,9 @@ export class Api extends HttpClient {
|
|
|
717
1624
|
* @name GetDocumentBuckets
|
|
718
1625
|
* @summary Get All
|
|
719
1626
|
* @request GET:/api/document-buckets
|
|
1627
|
+
* @deprecated
|
|
720
1628
|
* @secure
|
|
721
|
-
* @response `200` `(string)[]`
|
|
1629
|
+
* @response `200` `(string)[]` OK
|
|
722
1630
|
*/
|
|
723
1631
|
getDocumentBuckets: (query, params = {}) => this.request(Object.assign({ path: `/api/document-buckets`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
724
1632
|
/**
|
|
@@ -729,7 +1637,7 @@ export class Api extends HttpClient {
|
|
|
729
1637
|
* @summary Get All
|
|
730
1638
|
* @request GET:/api/document-templates
|
|
731
1639
|
* @secure
|
|
732
|
-
* @response `200` `(DocumentTemplateBase)[]`
|
|
1640
|
+
* @response `200` `(DocumentTemplateBase)[]` OK
|
|
733
1641
|
*/
|
|
734
1642
|
getDocumentTemplates: (query, params = {}) => this.request(Object.assign({ path: `/api/document-templates`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
735
1643
|
/**
|
|
@@ -742,9 +1650,9 @@ export class Api extends HttpClient {
|
|
|
742
1650
|
* @secure
|
|
743
1651
|
* @response `201` `DocumentTemplateBase` Created
|
|
744
1652
|
* @response `404` `ProblemDetails` Not Found
|
|
745
|
-
* @response `422` `UnprocessableEntity`
|
|
1653
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
746
1654
|
*/
|
|
747
|
-
createDocumentTemplate: (data, params = {}) => this.request(Object.assign({ path: `/api/document-templates`, method: "POST", body: data, secure: true, type:
|
|
1655
|
+
createDocumentTemplate: (data, params = {}) => this.request(Object.assign({ path: `/api/document-templates`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
748
1656
|
/**
|
|
749
1657
|
* No description
|
|
750
1658
|
*
|
|
@@ -753,7 +1661,7 @@ export class Api extends HttpClient {
|
|
|
753
1661
|
* @summary Get Custom
|
|
754
1662
|
* @request GET:/api/document-templates/{type}
|
|
755
1663
|
* @secure
|
|
756
|
-
* @response `200` `(DocumentTemplateBase)[]`
|
|
1664
|
+
* @response `200` `(DocumentTemplateBase)[]` OK
|
|
757
1665
|
*/
|
|
758
1666
|
getCustomDocumentTemplates: (type, query, params = {}) => this.request(Object.assign({ path: `/api/document-templates/${type}`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
759
1667
|
/**
|
|
@@ -764,7 +1672,7 @@ export class Api extends HttpClient {
|
|
|
764
1672
|
* @summary Get By ID
|
|
765
1673
|
* @request GET:/api/document-templates/{id}
|
|
766
1674
|
* @secure
|
|
767
|
-
* @response `200` `DocumentTemplate`
|
|
1675
|
+
* @response `200` `DocumentTemplate` OK
|
|
768
1676
|
* @response `404` `ProblemDetails` Not Found
|
|
769
1677
|
*/
|
|
770
1678
|
getDocumentTemplate: (id, params = {}) => this.request(Object.assign({ path: `/api/document-templates/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
@@ -776,12 +1684,12 @@ export class Api extends HttpClient {
|
|
|
776
1684
|
* @summary Replace
|
|
777
1685
|
* @request PUT:/api/document-templates/{id}
|
|
778
1686
|
* @secure
|
|
779
|
-
* @response `200` `DocumentTemplateBase`
|
|
1687
|
+
* @response `200` `DocumentTemplateBase` OK
|
|
780
1688
|
* @response `401` `ProblemDetails` Unauthorized
|
|
781
1689
|
* @response `404` `ProblemDetails` Not Found
|
|
782
|
-
* @response `422` `UnprocessableEntity`
|
|
1690
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
783
1691
|
*/
|
|
784
|
-
replaceDocumentTemplate: (id, data, params = {}) => this.request(Object.assign({ path: `/api/document-templates/${id}`, method: "PUT", body: data, secure: true, type:
|
|
1692
|
+
replaceDocumentTemplate: (id, data, params = {}) => this.request(Object.assign({ path: `/api/document-templates/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
785
1693
|
/**
|
|
786
1694
|
* No description
|
|
787
1695
|
*
|
|
@@ -816,7 +1724,7 @@ export class Api extends HttpClient {
|
|
|
816
1724
|
* @summary Get All
|
|
817
1725
|
* @request GET:/api/document-templates/{documentId}/versions
|
|
818
1726
|
* @secure
|
|
819
|
-
* @response `200` `(DocumentTemplateVersion)[]`
|
|
1727
|
+
* @response `200` `(DocumentTemplateVersion)[]` OK
|
|
820
1728
|
*/
|
|
821
1729
|
getDocumentTemplateVersions: (documentId, params = {}) => this.request(Object.assign({ path: `/api/document-templates/${documentId}/versions`, method: "GET", secure: true, format: "json" }, params)),
|
|
822
1730
|
/**
|
|
@@ -827,9 +1735,9 @@ export class Api extends HttpClient {
|
|
|
827
1735
|
* @summary Create
|
|
828
1736
|
* @request POST:/api/document-templates/{documentId}/versions
|
|
829
1737
|
* @secure
|
|
830
|
-
* @response `200` `DocumentTemplateVersion`
|
|
1738
|
+
* @response `200` `DocumentTemplateVersion` OK
|
|
831
1739
|
*/
|
|
832
|
-
createDocumentTemplateVersion: (documentId, data, params = {}) => this.request(Object.assign({ path: `/api/document-templates/${documentId}/versions`, method: "POST", body: data, secure: true, type:
|
|
1740
|
+
createDocumentTemplateVersion: (documentId, data, params = {}) => this.request(Object.assign({ path: `/api/document-templates/${documentId}/versions`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
833
1741
|
/**
|
|
834
1742
|
* No description
|
|
835
1743
|
*
|
|
@@ -838,7 +1746,7 @@ export class Api extends HttpClient {
|
|
|
838
1746
|
* @summary Get by ID
|
|
839
1747
|
* @request GET:/api/document-templates/{documentId}/versions/{id}
|
|
840
1748
|
* @secure
|
|
841
|
-
* @response `200` `DocumentTemplateVersion`
|
|
1749
|
+
* @response `200` `DocumentTemplateVersion` OK
|
|
842
1750
|
*/
|
|
843
1751
|
getDocumentTemplateVersion: (documentId, id, params = {}) => this.request(Object.assign({ path: `/api/document-templates/${documentId}/versions/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
844
1752
|
/**
|
|
@@ -849,9 +1757,9 @@ export class Api extends HttpClient {
|
|
|
849
1757
|
* @summary Replace
|
|
850
1758
|
* @request PUT:/api/document-templates/{documentId}/versions/{id}
|
|
851
1759
|
* @secure
|
|
852
|
-
* @response `200` `DocumentTemplateVersion`
|
|
1760
|
+
* @response `200` `DocumentTemplateVersion` OK
|
|
853
1761
|
*/
|
|
854
|
-
replaceDocumentTemplateVersion: (documentId, id, data, params = {}) => this.request(Object.assign({ path: `/api/document-templates/${documentId}/versions/${id}`, method: "PUT", body: data, secure: true, type:
|
|
1762
|
+
replaceDocumentTemplateVersion: (documentId, id, data, params = {}) => this.request(Object.assign({ path: `/api/document-templates/${documentId}/versions/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
855
1763
|
/**
|
|
856
1764
|
* No description
|
|
857
1765
|
*
|
|
@@ -860,9 +1768,85 @@ export class Api extends HttpClient {
|
|
|
860
1768
|
* @summary Delete
|
|
861
1769
|
* @request DELETE:/api/document-templates/{documentId}/versions/{id}
|
|
862
1770
|
* @secure
|
|
863
|
-
* @response `200` `DocumentTemplateVersion`
|
|
1771
|
+
* @response `200` `DocumentTemplateVersion` OK
|
|
864
1772
|
*/
|
|
865
1773
|
deleteDocumentTemplateVersion: (documentId, id, params = {}) => this.request(Object.assign({ path: `/api/document-templates/${documentId}/versions/${id}`, method: "DELETE", secure: true, format: "json" }, params)),
|
|
1774
|
+
/**
|
|
1775
|
+
* No description
|
|
1776
|
+
*
|
|
1777
|
+
* @tags Encompass Custom Field Mappings
|
|
1778
|
+
* @name GetEncompassCustomFieldMapping
|
|
1779
|
+
* @summary Get Encompass field mapping for a custom field definition
|
|
1780
|
+
* @request GET:/api/los/encompass/custom-field-mappings/{definitionId}
|
|
1781
|
+
* @secure
|
|
1782
|
+
* @response `200` `EncompassCustomFieldMapping` OK
|
|
1783
|
+
* @response `404` `void` Not Found
|
|
1784
|
+
*/
|
|
1785
|
+
getEncompassCustomFieldMapping: (definitionId, params = {}) => this.request(Object.assign({ path: `/api/los/encompass/custom-field-mappings/${definitionId}`, method: "GET", secure: true, format: "json" }, params)),
|
|
1786
|
+
/**
|
|
1787
|
+
* No description
|
|
1788
|
+
*
|
|
1789
|
+
* @tags Encompass Custom Field Mappings
|
|
1790
|
+
* @name AddEncompassCustomFieldMapping
|
|
1791
|
+
* @summary Add an Encompass field mapping to a custom field definition
|
|
1792
|
+
* @request POST:/api/los/encompass/custom-field-mappings/{definitionId}
|
|
1793
|
+
* @secure
|
|
1794
|
+
* @response `201` `EncompassCustomFieldMapping` Created
|
|
1795
|
+
* @response `400` `void` Bad Request
|
|
1796
|
+
* @response `404` `void` Not Found
|
|
1797
|
+
* @response `409` `void` Conflict
|
|
1798
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
1799
|
+
*/
|
|
1800
|
+
addEncompassCustomFieldMapping: (definitionId, data, params = {}) => this.request(Object.assign({ path: `/api/los/encompass/custom-field-mappings/${definitionId}`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1801
|
+
/**
|
|
1802
|
+
* No description
|
|
1803
|
+
*
|
|
1804
|
+
* @tags Encompass Custom Field Mappings
|
|
1805
|
+
* @name DeleteEncompassCustomFieldMapping
|
|
1806
|
+
* @summary Delete the Encompass field mapping (only if no values exist)
|
|
1807
|
+
* @request DELETE:/api/los/encompass/custom-field-mappings/{definitionId}
|
|
1808
|
+
* @secure
|
|
1809
|
+
* @response `204` `void` No Content
|
|
1810
|
+
* @response `404` `void` Not Found
|
|
1811
|
+
* @response `409` `void` Conflict
|
|
1812
|
+
*/
|
|
1813
|
+
deleteEncompassCustomFieldMapping: (definitionId, params = {}) => this.request(Object.assign({ path: `/api/los/encompass/custom-field-mappings/${definitionId}`, method: "DELETE", secure: true }, params)),
|
|
1814
|
+
/**
|
|
1815
|
+
* No description
|
|
1816
|
+
*
|
|
1817
|
+
* @tags Encompass Custom Field Mappings
|
|
1818
|
+
* @name DisableEncompassCustomFieldMapping
|
|
1819
|
+
* @summary Disable the Encompass field mapping (stops sync)
|
|
1820
|
+
* @request POST:/api/los/encompass/custom-field-mappings/{definitionId}/disable
|
|
1821
|
+
* @secure
|
|
1822
|
+
* @response `204` `void` No Content
|
|
1823
|
+
* @response `404` `void` Not Found
|
|
1824
|
+
*/
|
|
1825
|
+
disableEncompassCustomFieldMapping: (definitionId, params = {}) => this.request(Object.assign({ path: `/api/los/encompass/custom-field-mappings/${definitionId}/disable`, method: "POST", secure: true }, params)),
|
|
1826
|
+
/**
|
|
1827
|
+
* No description
|
|
1828
|
+
*
|
|
1829
|
+
* @tags Encompass Custom Field Mappings
|
|
1830
|
+
* @name EnableEncompassCustomFieldMapping
|
|
1831
|
+
* @summary Re-enable the Encompass field mapping (resumes sync)
|
|
1832
|
+
* @request POST:/api/los/encompass/custom-field-mappings/{definitionId}/enable
|
|
1833
|
+
* @secure
|
|
1834
|
+
* @response `204` `void` No Content
|
|
1835
|
+
* @response `404` `void` Not Found
|
|
1836
|
+
*/
|
|
1837
|
+
enableEncompassCustomFieldMapping: (definitionId, params = {}) => this.request(Object.assign({ path: `/api/los/encompass/custom-field-mappings/${definitionId}/enable`, method: "POST", secure: true }, params)),
|
|
1838
|
+
/**
|
|
1839
|
+
* No description
|
|
1840
|
+
*
|
|
1841
|
+
* @tags Encompass Custom Fields
|
|
1842
|
+
* @name GetEncompassFields
|
|
1843
|
+
* @summary Fetch available Encompass custom fields with type metadata
|
|
1844
|
+
* @request GET:/api/los/encompass/custom-fields
|
|
1845
|
+
* @secure
|
|
1846
|
+
* @response `200` `(EncompassFieldListItem)[]` OK
|
|
1847
|
+
* @response `502` `ProblemDetails` Bad Gateway
|
|
1848
|
+
*/
|
|
1849
|
+
getEncompassFields: (params = {}) => this.request(Object.assign({ path: `/api/los/encompass/custom-fields`, method: "GET", secure: true, format: "json" }, params)),
|
|
866
1850
|
/**
|
|
867
1851
|
* No description
|
|
868
1852
|
*
|
|
@@ -870,12 +1854,38 @@ export class Api extends HttpClient {
|
|
|
870
1854
|
* @name GetUserPackages
|
|
871
1855
|
* @request GET:/api/los/encompass/eclose/packages
|
|
872
1856
|
* @secure
|
|
873
|
-
* @response `200` `EncompassPackageList`
|
|
1857
|
+
* @response `200` `EncompassPackageList` OK
|
|
874
1858
|
* @response `400` `EncompassError` Bad Request
|
|
875
1859
|
* @response `401` `EncompassError` Unauthorized
|
|
876
|
-
* @response `500` `EncompassError` Server Error
|
|
1860
|
+
* @response `500` `EncompassError` Internal Server Error
|
|
877
1861
|
*/
|
|
878
1862
|
getUserPackages: (query, params = {}) => this.request(Object.assign({ path: `/api/los/encompass/eclose/packages`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
1863
|
+
/**
|
|
1864
|
+
* No description
|
|
1865
|
+
*
|
|
1866
|
+
* @tags Encompass Packages
|
|
1867
|
+
* @name GetLoanPackages
|
|
1868
|
+
* @request GET:/api/los/encompass/eclose/loans/{loanId}/packages
|
|
1869
|
+
* @secure
|
|
1870
|
+
* @response `200` `EncompassPackageList` OK
|
|
1871
|
+
* @response `400` `EncompassError` Bad Request
|
|
1872
|
+
* @response `401` `EncompassError` Unauthorized
|
|
1873
|
+
* @response `403` `EncompassError` Forbidden
|
|
1874
|
+
* @response `500` `EncompassError` Internal Server Error
|
|
1875
|
+
*/
|
|
1876
|
+
getLoanPackages: (loanId, query, params = {}) => this.request(Object.assign({ path: `/api/los/encompass/eclose/loans/${loanId}/packages`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
1877
|
+
/**
|
|
1878
|
+
* No description
|
|
1879
|
+
*
|
|
1880
|
+
* @tags Encompass Recipients
|
|
1881
|
+
* @name GetUserRecipients
|
|
1882
|
+
* @request GET:/api/los/encompass/eclose/recipients
|
|
1883
|
+
* @secure
|
|
1884
|
+
* @response `200` `(EncompassRecipientItem)[]` OK
|
|
1885
|
+
* @response `401` `EncompassError` Unauthorized
|
|
1886
|
+
* @response `500` `EncompassError` Internal Server Error
|
|
1887
|
+
*/
|
|
1888
|
+
getUserRecipients: (params = {}) => this.request(Object.assign({ path: `/api/los/encompass/eclose/recipients`, method: "GET", secure: true, format: "json" }, params)),
|
|
879
1889
|
/**
|
|
880
1890
|
* No description
|
|
881
1891
|
*
|
|
@@ -883,14 +1893,14 @@ export class Api extends HttpClient {
|
|
|
883
1893
|
* @name CreateEncompassSession
|
|
884
1894
|
* @request POST:/api/los/encompass/eclose/sessions
|
|
885
1895
|
* @secure
|
|
886
|
-
* @response `200` `CreateSession`
|
|
1896
|
+
* @response `200` `CreateSession` OK
|
|
887
1897
|
* @response `400` `EncompassError` Bad Request
|
|
888
1898
|
* @response `401` `EncompassError` Unauthorized
|
|
889
1899
|
* @response `403` `EncompassError` Forbidden
|
|
890
1900
|
* @response `404` `EncompassError` Not Found
|
|
891
|
-
* @response `500` `EncompassError` Server Error
|
|
1901
|
+
* @response `500` `EncompassError` Internal Server Error
|
|
892
1902
|
*/
|
|
893
|
-
createEncompassSession: (data, params = {}) => this.request(Object.assign({ path: `/api/los/encompass/eclose/sessions`, method: "POST", body: data, secure: true, type:
|
|
1903
|
+
createEncompassSession: (data, params = {}) => this.request(Object.assign({ path: `/api/los/encompass/eclose/sessions`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
894
1904
|
/**
|
|
895
1905
|
* No description
|
|
896
1906
|
*
|
|
@@ -899,7 +1909,7 @@ export class Api extends HttpClient {
|
|
|
899
1909
|
* @summary Get All
|
|
900
1910
|
* @request GET:/api/files
|
|
901
1911
|
* @secure
|
|
902
|
-
* @response `200` `FilePaginated`
|
|
1912
|
+
* @response `200` `FilePaginated` OK
|
|
903
1913
|
*/
|
|
904
1914
|
getAllFiles: (query, params = {}) => this.request(Object.assign({ path: `/api/files`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
905
1915
|
/**
|
|
@@ -911,9 +1921,9 @@ export class Api extends HttpClient {
|
|
|
911
1921
|
* @request POST:/api/files
|
|
912
1922
|
* @secure
|
|
913
1923
|
* @response `201` `File` Created
|
|
914
|
-
* @response `422` `UnprocessableEntity`
|
|
1924
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
915
1925
|
*/
|
|
916
|
-
uploadFile: (data, params = {}) => this.request(Object.assign({ path: `/api/files`, method: "POST", body: data, secure: true, type:
|
|
1926
|
+
uploadFile: (data, params = {}) => this.request(Object.assign({ path: `/api/files`, method: "POST", body: data, secure: true, type: "multipart/form-data", format: "json" }, params)),
|
|
917
1927
|
/**
|
|
918
1928
|
* No description
|
|
919
1929
|
*
|
|
@@ -933,10 +1943,10 @@ export class Api extends HttpClient {
|
|
|
933
1943
|
* @summary Replace
|
|
934
1944
|
* @request PUT:/api/files/{id}
|
|
935
1945
|
* @secure
|
|
936
|
-
* @response `200` `string`
|
|
937
|
-
* @response `422` `UnprocessableEntity`
|
|
1946
|
+
* @response `200` `string` OK
|
|
1947
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
938
1948
|
*/
|
|
939
|
-
replaceFile: (id, data, params = {}) => this.request(Object.assign({ path: `/api/files/${id}`, method: "PUT", body: data, secure: true, type:
|
|
1949
|
+
replaceFile: (id, data, params = {}) => this.request(Object.assign({ path: `/api/files/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
940
1950
|
/**
|
|
941
1951
|
* No description
|
|
942
1952
|
*
|
|
@@ -956,9 +1966,9 @@ export class Api extends HttpClient {
|
|
|
956
1966
|
* @summary Search
|
|
957
1967
|
* @request POST:/api/files/search
|
|
958
1968
|
* @secure
|
|
959
|
-
* @response `200` `FilePaginated`
|
|
1969
|
+
* @response `200` `FilePaginated` OK
|
|
960
1970
|
*/
|
|
961
|
-
searchFiles: (data, query, params = {}) => this.request(Object.assign({ path: `/api/files/search`, method: "POST", query: query, body: data, secure: true, type:
|
|
1971
|
+
searchFiles: (data, query, params = {}) => this.request(Object.assign({ path: `/api/files/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
962
1972
|
/**
|
|
963
1973
|
* No description
|
|
964
1974
|
*
|
|
@@ -967,7 +1977,7 @@ export class Api extends HttpClient {
|
|
|
967
1977
|
* @summary Get All
|
|
968
1978
|
* @request GET:/api/forms
|
|
969
1979
|
* @secure
|
|
970
|
-
* @response `200` `(AdminAccessGetForms)[]`
|
|
1980
|
+
* @response `200` `(AdminAccessGetForms)[]` OK
|
|
971
1981
|
*/
|
|
972
1982
|
getForms: (query, params = {}) => this.request(Object.assign({ path: `/api/forms`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
973
1983
|
/**
|
|
@@ -979,9 +1989,9 @@ export class Api extends HttpClient {
|
|
|
979
1989
|
* @request POST:/api/forms
|
|
980
1990
|
* @secure
|
|
981
1991
|
* @response `201` `Form` Created
|
|
982
|
-
* @response `422` `UnprocessableEntity`
|
|
1992
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
983
1993
|
*/
|
|
984
|
-
createForm: (data, params = {}) => this.request(Object.assign({ path: `/api/forms`, method: "POST", body: data, secure: true, type:
|
|
1994
|
+
createForm: (data, params = {}) => this.request(Object.assign({ path: `/api/forms`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
985
1995
|
/**
|
|
986
1996
|
* No description
|
|
987
1997
|
*
|
|
@@ -990,7 +2000,7 @@ export class Api extends HttpClient {
|
|
|
990
2000
|
* @summary Get By ID
|
|
991
2001
|
* @request GET:/api/forms/{id}
|
|
992
2002
|
* @secure
|
|
993
|
-
* @response `200` `Form`
|
|
2003
|
+
* @response `200` `Form` OK
|
|
994
2004
|
*/
|
|
995
2005
|
getForm: (id, params = {}) => this.request(Object.assign({ path: `/api/forms/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
996
2006
|
/**
|
|
@@ -1001,10 +2011,10 @@ export class Api extends HttpClient {
|
|
|
1001
2011
|
* @summary Replace
|
|
1002
2012
|
* @request PUT:/api/forms/{id}
|
|
1003
2013
|
* @secure
|
|
1004
|
-
* @response `200` `Form`
|
|
1005
|
-
* @response `422` `UnprocessableEntity`
|
|
2014
|
+
* @response `200` `Form` OK
|
|
2015
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
1006
2016
|
*/
|
|
1007
|
-
replaceForm: (id, data, params = {}) => this.request(Object.assign({ path: `/api/forms/${id}`, method: "PUT", body: data, secure: true, type:
|
|
2017
|
+
replaceForm: (id, data, params = {}) => this.request(Object.assign({ path: `/api/forms/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1008
2018
|
/**
|
|
1009
2019
|
* No description
|
|
1010
2020
|
*
|
|
@@ -1024,7 +2034,7 @@ export class Api extends HttpClient {
|
|
|
1024
2034
|
* @summary Restore
|
|
1025
2035
|
* @request POST:/api/forms/{id}/restore
|
|
1026
2036
|
* @secure
|
|
1027
|
-
* @response `200` `Form`
|
|
2037
|
+
* @response `200` `Form` OK
|
|
1028
2038
|
*/
|
|
1029
2039
|
restoreForm: (id, params = {}) => this.request(Object.assign({ path: `/api/forms/${id}/restore`, method: "POST", secure: true, format: "json" }, params)),
|
|
1030
2040
|
/**
|
|
@@ -1035,9 +2045,9 @@ export class Api extends HttpClient {
|
|
|
1035
2045
|
* @summary Add
|
|
1036
2046
|
* @request POST:/api/form-submissions/{formSubmissionId}/files
|
|
1037
2047
|
* @secure
|
|
1038
|
-
* @response `200` `FormSubmissionFile`
|
|
2048
|
+
* @response `200` `FormSubmissionFile` OK
|
|
1039
2049
|
*/
|
|
1040
|
-
addFormSubmissionFile: (formSubmissionId, data, params = {}) => this.request(Object.assign({ path: `/api/form-submissions/${formSubmissionId}/files`, method: "POST", body: data, secure: true, type:
|
|
2050
|
+
addFormSubmissionFile: (formSubmissionId, data, params = {}) => this.request(Object.assign({ path: `/api/form-submissions/${formSubmissionId}/files`, method: "POST", body: data, secure: true, type: "multipart/form-data", format: "json" }, params)),
|
|
1041
2051
|
/**
|
|
1042
2052
|
* No description
|
|
1043
2053
|
*
|
|
@@ -1057,7 +2067,7 @@ export class Api extends HttpClient {
|
|
|
1057
2067
|
* @summary Download by Id
|
|
1058
2068
|
* @request GET:/api/form-submissions/{formSubmissionId}/files/{formSubmissionFileId}/download
|
|
1059
2069
|
* @secure
|
|
1060
|
-
* @response `200` `FileWithBytes`
|
|
2070
|
+
* @response `200` `FileWithBytes` OK
|
|
1061
2071
|
*/
|
|
1062
2072
|
downloadFormSubmissionFile: (formSubmissionFileId, formSubmissionId, query, params = {}) => this.request(Object.assign({ path: `/api/form-submissions/${formSubmissionId}/files/${formSubmissionFileId}/download`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
1063
2073
|
/**
|
|
@@ -1068,7 +2078,7 @@ export class Api extends HttpClient {
|
|
|
1068
2078
|
* @summary Get All
|
|
1069
2079
|
* @request GET:/api/form-submissions
|
|
1070
2080
|
* @secure
|
|
1071
|
-
* @response `200` `FormSubmissionPaginated`
|
|
2081
|
+
* @response `200` `FormSubmissionPaginated` OK
|
|
1072
2082
|
*/
|
|
1073
2083
|
getFormSubmissions: (query, params = {}) => this.request(Object.assign({ path: `/api/form-submissions`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
1074
2084
|
/**
|
|
@@ -1081,7 +2091,7 @@ export class Api extends HttpClient {
|
|
|
1081
2091
|
* @secure
|
|
1082
2092
|
* @response `201` `FormSubmission` Created
|
|
1083
2093
|
*/
|
|
1084
|
-
createFormSubmission: (data, query, params = {}) => this.request(Object.assign({ path: `/api/form-submissions`, method: "POST", query: query, body: data, secure: true, type:
|
|
2094
|
+
createFormSubmission: (data, query, params = {}) => this.request(Object.assign({ path: `/api/form-submissions`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1085
2095
|
/**
|
|
1086
2096
|
* No description
|
|
1087
2097
|
*
|
|
@@ -1090,7 +2100,7 @@ export class Api extends HttpClient {
|
|
|
1090
2100
|
* @summary Get by ID
|
|
1091
2101
|
* @request GET:/api/form-submissions/{id}
|
|
1092
2102
|
* @secure
|
|
1093
|
-
* @response `200` `FormSubmission`
|
|
2103
|
+
* @response `200` `FormSubmission` OK
|
|
1094
2104
|
*/
|
|
1095
2105
|
getFormSubmission: (id, params = {}) => this.request(Object.assign({ path: `/api/form-submissions/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
1096
2106
|
/**
|
|
@@ -1101,9 +2111,9 @@ export class Api extends HttpClient {
|
|
|
1101
2111
|
* @summary Replace
|
|
1102
2112
|
* @request PUT:/api/form-submissions/{id}
|
|
1103
2113
|
* @secure
|
|
1104
|
-
* @response `200` `FormSubmission`
|
|
2114
|
+
* @response `200` `FormSubmission` OK
|
|
1105
2115
|
*/
|
|
1106
|
-
replaceFormSubmission: (id, data, params = {}) => this.request(Object.assign({ path: `/api/form-submissions/${id}`, method: "PUT", body: data, secure: true, type:
|
|
2116
|
+
replaceFormSubmission: (id, data, params = {}) => this.request(Object.assign({ path: `/api/form-submissions/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1107
2117
|
/**
|
|
1108
2118
|
* No description
|
|
1109
2119
|
*
|
|
@@ -1123,9 +2133,9 @@ export class Api extends HttpClient {
|
|
|
1123
2133
|
* @summary Search
|
|
1124
2134
|
* @request POST:/api/form-submissions/search
|
|
1125
2135
|
* @secure
|
|
1126
|
-
* @response `200` `FormSubmissionPaginated`
|
|
2136
|
+
* @response `200` `FormSubmissionPaginated` OK
|
|
1127
2137
|
*/
|
|
1128
|
-
searchFormSubmissions: (data, query, params = {}) => this.request(Object.assign({ path: `/api/form-submissions/search`, method: "POST", query: query, body: data, secure: true, type:
|
|
2138
|
+
searchFormSubmissions: (data, query, params = {}) => this.request(Object.assign({ path: `/api/form-submissions/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1129
2139
|
/**
|
|
1130
2140
|
* No description
|
|
1131
2141
|
*
|
|
@@ -1134,7 +2144,7 @@ export class Api extends HttpClient {
|
|
|
1134
2144
|
* @summary Get All
|
|
1135
2145
|
* @request GET:/api/forms/{formId}/versions
|
|
1136
2146
|
* @secure
|
|
1137
|
-
* @response `200` `(FormVersion)[]`
|
|
2147
|
+
* @response `200` `(FormVersion)[]` OK
|
|
1138
2148
|
*/
|
|
1139
2149
|
getFormVersions: (formId, params = {}) => this.request(Object.assign({ path: `/api/forms/${formId}/versions`, method: "GET", secure: true, format: "json" }, params)),
|
|
1140
2150
|
/**
|
|
@@ -1145,9 +2155,9 @@ export class Api extends HttpClient {
|
|
|
1145
2155
|
* @summary Create
|
|
1146
2156
|
* @request POST:/api/forms/{formId}/versions
|
|
1147
2157
|
* @secure
|
|
1148
|
-
* @response `200` `FormVersion`
|
|
2158
|
+
* @response `200` `FormVersion` OK
|
|
1149
2159
|
*/
|
|
1150
|
-
createFormVersion: (formId, data, params = {}) => this.request(Object.assign({ path: `/api/forms/${formId}/versions`, method: "POST", body: data, secure: true, type:
|
|
2160
|
+
createFormVersion: (formId, data, params = {}) => this.request(Object.assign({ path: `/api/forms/${formId}/versions`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1151
2161
|
/**
|
|
1152
2162
|
* No description
|
|
1153
2163
|
*
|
|
@@ -1156,7 +2166,7 @@ export class Api extends HttpClient {
|
|
|
1156
2166
|
* @summary Get by ID
|
|
1157
2167
|
* @request GET:/api/forms/{formId}/versions/{id}
|
|
1158
2168
|
* @secure
|
|
1159
|
-
* @response `200` `FormVersion`
|
|
2169
|
+
* @response `200` `FormVersion` OK
|
|
1160
2170
|
*/
|
|
1161
2171
|
getFormVersion: (formId, id, params = {}) => this.request(Object.assign({ path: `/api/forms/${formId}/versions/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
1162
2172
|
/**
|
|
@@ -1167,9 +2177,9 @@ export class Api extends HttpClient {
|
|
|
1167
2177
|
* @summary Replace
|
|
1168
2178
|
* @request PUT:/api/forms/{formId}/versions/{id}
|
|
1169
2179
|
* @secure
|
|
1170
|
-
* @response `200` `FormVersion`
|
|
2180
|
+
* @response `200` `FormVersion` OK
|
|
1171
2181
|
*/
|
|
1172
|
-
replaceFormVersion: (formId, id, data, params = {}) => this.request(Object.assign({ path: `/api/forms/${formId}/versions/${id}`, method: "PUT", body: data, secure: true, type:
|
|
2182
|
+
replaceFormVersion: (formId, id, data, params = {}) => this.request(Object.assign({ path: `/api/forms/${formId}/versions/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1173
2183
|
/**
|
|
1174
2184
|
* No description
|
|
1175
2185
|
*
|
|
@@ -1178,9 +2188,20 @@ export class Api extends HttpClient {
|
|
|
1178
2188
|
* @summary Delete
|
|
1179
2189
|
* @request DELETE:/api/forms/{formId}/versions/{id}
|
|
1180
2190
|
* @secure
|
|
1181
|
-
* @response `200` `FormVersion`
|
|
2191
|
+
* @response `200` `FormVersion` OK
|
|
1182
2192
|
*/
|
|
1183
2193
|
deleteFormVersion: (formId, id, params = {}) => this.request(Object.assign({ path: `/api/forms/${formId}/versions/${id}`, method: "DELETE", secure: true, format: "json" }, params)),
|
|
2194
|
+
/**
|
|
2195
|
+
* No description
|
|
2196
|
+
*
|
|
2197
|
+
* @tags IntegrationSettings
|
|
2198
|
+
* @name GetIntegrationSettings
|
|
2199
|
+
* @summary Get Integration Settings
|
|
2200
|
+
* @request GET:/api/integrations/settings
|
|
2201
|
+
* @secure
|
|
2202
|
+
* @response `200` `IntegrationSettings` OK
|
|
2203
|
+
*/
|
|
2204
|
+
getIntegrationSettings: (params = {}) => this.request(Object.assign({ path: `/api/integrations/settings`, method: "GET", secure: true, format: "json" }, params)),
|
|
1184
2205
|
/**
|
|
1185
2206
|
* No description
|
|
1186
2207
|
*
|
|
@@ -1189,7 +2210,7 @@ export class Api extends HttpClient {
|
|
|
1189
2210
|
* @summary Get By ID
|
|
1190
2211
|
* @request GET:/api/los/loan/application/{loanID}
|
|
1191
2212
|
* @secure
|
|
1192
|
-
* @response `200` `Record<string,any>`
|
|
2213
|
+
* @response `200` `Record<string,any>` OK
|
|
1193
2214
|
*/
|
|
1194
2215
|
getLoanData: (loanId, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}`, method: "GET", secure: true, format: "json" }, params)),
|
|
1195
2216
|
/**
|
|
@@ -1201,10 +2222,10 @@ export class Api extends HttpClient {
|
|
|
1201
2222
|
* @request PATCH:/api/los/loan/application/{loanID}
|
|
1202
2223
|
* @deprecated
|
|
1203
2224
|
* @secure
|
|
1204
|
-
* @response `200` `string`
|
|
1205
|
-
* @response `422` `UnprocessableEntity`
|
|
2225
|
+
* @response `200` `string` OK
|
|
2226
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
1206
2227
|
*/
|
|
1207
|
-
updateLoanConsentAndCustomFieldsObsolete: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}`, method: "PATCH", body: data, secure: true, type:
|
|
2228
|
+
updateLoanConsentAndCustomFieldsObsolete: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}`, method: "PATCH", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1208
2229
|
/**
|
|
1209
2230
|
* No description
|
|
1210
2231
|
*
|
|
@@ -1213,9 +2234,9 @@ export class Api extends HttpClient {
|
|
|
1213
2234
|
* @summary Get Report
|
|
1214
2235
|
* @request POST:/api/los/loan/reports
|
|
1215
2236
|
* @secure
|
|
1216
|
-
* @response `200` `GetReport`
|
|
2237
|
+
* @response `200` `GetReport` OK
|
|
1217
2238
|
*/
|
|
1218
|
-
getLoansReport: (data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/reports`, method: "POST", body: data, secure: true, type:
|
|
2239
|
+
getLoansReport: (data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/reports`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1219
2240
|
/**
|
|
1220
2241
|
* No description
|
|
1221
2242
|
*
|
|
@@ -1225,11 +2246,11 @@ export class Api extends HttpClient {
|
|
|
1225
2246
|
* @request POST:/api/los/loan/application
|
|
1226
2247
|
* @deprecated
|
|
1227
2248
|
* @secure
|
|
1228
|
-
* @response `200` `string`
|
|
1229
|
-
* @response `422` `UnprocessableEntity`
|
|
1230
|
-
* @response `423` `UnprocessableEntity`
|
|
2249
|
+
* @response `200` `string` OK
|
|
2250
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
2251
|
+
* @response `423` `UnprocessableEntity` Locked
|
|
1231
2252
|
*/
|
|
1232
|
-
createLoan: (data, query, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application`, method: "POST", query: query, body: data, secure: true, type:
|
|
2253
|
+
createLoan: (data, query, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1233
2254
|
/**
|
|
1234
2255
|
* No description
|
|
1235
2256
|
*
|
|
@@ -1238,11 +2259,11 @@ export class Api extends HttpClient {
|
|
|
1238
2259
|
* @summary Create Loan Returning Internal Loan ID
|
|
1239
2260
|
* @request POST:/api/los/loan/application/internal
|
|
1240
2261
|
* @secure
|
|
1241
|
-
* @response `200` `string`
|
|
1242
|
-
* @response `422` `UnprocessableEntity`
|
|
1243
|
-
* @response `423` `UnprocessableEntity`
|
|
2262
|
+
* @response `200` `string` OK
|
|
2263
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
2264
|
+
* @response `423` `UnprocessableEntity` Locked
|
|
1244
2265
|
*/
|
|
1245
|
-
createLoanInternal: (data, query, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/internal`, method: "POST", query: query, body: data, secure: true, type:
|
|
2266
|
+
createLoanInternal: (data, query, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/internal`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1246
2267
|
/**
|
|
1247
2268
|
* No description
|
|
1248
2269
|
*
|
|
@@ -1251,10 +2272,10 @@ export class Api extends HttpClient {
|
|
|
1251
2272
|
* @summary Update Loan Custom Fields
|
|
1252
2273
|
* @request PATCH:/api/los/loan/application/{loanID}/custom-fields
|
|
1253
2274
|
* @secure
|
|
1254
|
-
* @response `200` `string`
|
|
1255
|
-
* @response `422` `UnprocessableEntity`
|
|
2275
|
+
* @response `200` `string` OK
|
|
2276
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
1256
2277
|
*/
|
|
1257
|
-
updateLoanCustomFields: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}/custom-fields`, method: "PATCH", body: data, secure: true, type:
|
|
2278
|
+
updateLoanCustomFields: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}/custom-fields`, method: "PATCH", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1258
2279
|
/**
|
|
1259
2280
|
* No description
|
|
1260
2281
|
*
|
|
@@ -1263,22 +2284,11 @@ export class Api extends HttpClient {
|
|
|
1263
2284
|
* @summary Update Loan Consent and Custom Fields
|
|
1264
2285
|
* @request PATCH:/api/los/loan/application/{loanID}/consent
|
|
1265
2286
|
* @secure
|
|
1266
|
-
* @response `200` `string`
|
|
2287
|
+
* @response `200` `string` OK
|
|
1267
2288
|
* @response `202` `string` Accepted
|
|
1268
|
-
* @response `422` `UnprocessableEntity`
|
|
2289
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
1269
2290
|
*/
|
|
1270
|
-
updateLoanConsent: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}/consent`, method: "PATCH", body: data, secure: true, type:
|
|
1271
|
-
/**
|
|
1272
|
-
* No description
|
|
1273
|
-
*
|
|
1274
|
-
* @tags LegacyLoan
|
|
1275
|
-
* @name GetTaskDocumentsByLoan
|
|
1276
|
-
* @summary Get Documents
|
|
1277
|
-
* @request GET:/api/los/loan/tasks/documents/{loanID}
|
|
1278
|
-
* @secure
|
|
1279
|
-
* @response `200` `(DocumentData)[]` Success
|
|
1280
|
-
*/
|
|
1281
|
-
getTaskDocumentsByLoan: (loanId, params = {}) => this.request(Object.assign({ path: `/api/los/loan/tasks/documents/${loanId}`, method: "GET", secure: true, format: "json" }, params)),
|
|
2291
|
+
updateLoanConsent: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}/consent`, method: "PATCH", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1282
2292
|
/**
|
|
1283
2293
|
* No description
|
|
1284
2294
|
*
|
|
@@ -1287,7 +2297,7 @@ export class Api extends HttpClient {
|
|
|
1287
2297
|
* @summary Get Document Content
|
|
1288
2298
|
* @request GET:/api/los/loan/{loanID}/document/{documentId}/content
|
|
1289
2299
|
* @secure
|
|
1290
|
-
* @response `200` `void`
|
|
2300
|
+
* @response `200` `void` OK
|
|
1291
2301
|
*/
|
|
1292
2302
|
getLoanDocumentContent: (loanId, documentId, query, params = {}) => this.request(Object.assign({ path: `/api/los/loan/${loanId}/document/${documentId}/content`, method: "GET", query: query, secure: true }, params)),
|
|
1293
2303
|
/**
|
|
@@ -1309,7 +2319,7 @@ export class Api extends HttpClient {
|
|
|
1309
2319
|
* @summary Get Preliminary Conditions
|
|
1310
2320
|
* @request GET:/api/los/loan/{loanID}/conditions/preliminary
|
|
1311
2321
|
* @secure
|
|
1312
|
-
* @response `200` `(PreliminaryCondition)[]`
|
|
2322
|
+
* @response `200` `(PreliminaryCondition)[]` OK
|
|
1313
2323
|
*/
|
|
1314
2324
|
getPreliminaryConditionsForLoan: (loanId, params = {}) => this.request(Object.assign({ path: `/api/los/loan/${loanId}/conditions/preliminary`, method: "GET", secure: true, format: "json" }, params)),
|
|
1315
2325
|
/**
|
|
@@ -1320,7 +2330,7 @@ export class Api extends HttpClient {
|
|
|
1320
2330
|
* @summary Get Underwriting Conditions
|
|
1321
2331
|
* @request GET:/api/los/loan/{loanID}/conditions/underwriting
|
|
1322
2332
|
* @secure
|
|
1323
|
-
* @response `200` `(UnderwritingCondition)[]`
|
|
2333
|
+
* @response `200` `(UnderwritingCondition)[]` OK
|
|
1324
2334
|
*/
|
|
1325
2335
|
getUnderwritingConditionsForLoan: (loanId, params = {}) => this.request(Object.assign({ path: `/api/los/loan/${loanId}/conditions/underwriting`, method: "GET", secure: true, format: "json" }, params)),
|
|
1326
2336
|
/**
|
|
@@ -1331,21 +2341,9 @@ export class Api extends HttpClient {
|
|
|
1331
2341
|
* @summary Get Embedded Signing Link
|
|
1332
2342
|
* @request POST:/api/los/loan/embeddedsigning/{envelopeId}/{userName}/{email}
|
|
1333
2343
|
* @secure
|
|
1334
|
-
* @response `200` `string`
|
|
2344
|
+
* @response `200` `string` OK
|
|
1335
2345
|
*/
|
|
1336
2346
|
getLoanEmbeddedSigningLink: (envelopeId, userName, email, params = {}) => this.request(Object.assign({ path: `/api/los/loan/embeddedsigning/${envelopeId}/${userName}/${email}`, method: "POST", secure: true, format: "json" }, params)),
|
|
1337
|
-
/**
|
|
1338
|
-
* No description
|
|
1339
|
-
*
|
|
1340
|
-
* @tags LegacyLoan
|
|
1341
|
-
* @name CreateLegacyLoanDocument
|
|
1342
|
-
* @summary Create Document
|
|
1343
|
-
* @request POST:/api/los/loan/generatedocument
|
|
1344
|
-
* @deprecated
|
|
1345
|
-
* @secure
|
|
1346
|
-
* @response `200` `DocumentDataRequest` Success
|
|
1347
|
-
*/
|
|
1348
|
-
createLegacyLoanDocument: (data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/generatedocument`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
1349
2347
|
/**
|
|
1350
2348
|
* No description
|
|
1351
2349
|
*
|
|
@@ -1354,10 +2352,10 @@ export class Api extends HttpClient {
|
|
|
1354
2352
|
* @summary Create Edit Draft for Loan
|
|
1355
2353
|
* @request PUT:/api/los/loan/{loanID}/edit
|
|
1356
2354
|
* @secure
|
|
1357
|
-
* @response `200` `Draft`
|
|
2355
|
+
* @response `200` `Draft` OK
|
|
1358
2356
|
* @response `400` `ProblemDetails` Bad Request
|
|
1359
2357
|
* @response `404` `ProblemDetails` Not Found
|
|
1360
|
-
* @response `423` `ProblemDetails`
|
|
2358
|
+
* @response `423` `ProblemDetails` Locked
|
|
1361
2359
|
*/
|
|
1362
2360
|
createEditDraftForLoan: (loanId, query, params = {}) => this.request(Object.assign({ path: `/api/los/loan/${loanId}/edit`, method: "PUT", query: query, secure: true, format: "json" }, params)),
|
|
1363
2361
|
/**
|
|
@@ -1368,9 +2366,9 @@ export class Api extends HttpClient {
|
|
|
1368
2366
|
* @summary Add
|
|
1369
2367
|
* @request POST:/api/listings/{listingId}/files
|
|
1370
2368
|
* @secure
|
|
1371
|
-
* @response `200` `ListingFile`
|
|
2369
|
+
* @response `200` `ListingFile` OK
|
|
1372
2370
|
*/
|
|
1373
|
-
addListingFile: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/files`, method: "POST", body: data, secure: true, type:
|
|
2371
|
+
addListingFile: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/files`, method: "POST", body: data, secure: true, type: "multipart/form-data", format: "json" }, params)),
|
|
1374
2372
|
/**
|
|
1375
2373
|
* No description
|
|
1376
2374
|
*
|
|
@@ -1379,9 +2377,9 @@ export class Api extends HttpClient {
|
|
|
1379
2377
|
* @summary Update
|
|
1380
2378
|
* @request PATCH:/api/listings/{listingId}/files
|
|
1381
2379
|
* @secure
|
|
1382
|
-
* @response `200` `ListingFile`
|
|
2380
|
+
* @response `200` `ListingFile` OK
|
|
1383
2381
|
*/
|
|
1384
|
-
updateListingFiles: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/files`, method: "PATCH", body: data, secure: true, type:
|
|
2382
|
+
updateListingFiles: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/files`, method: "PATCH", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1385
2383
|
/**
|
|
1386
2384
|
* No description
|
|
1387
2385
|
*
|
|
@@ -1401,9 +2399,9 @@ export class Api extends HttpClient {
|
|
|
1401
2399
|
* @summary Add
|
|
1402
2400
|
* @request POST:/api/listings/{listingId}/photos
|
|
1403
2401
|
* @secure
|
|
1404
|
-
* @response `200` `ListingPhoto`
|
|
2402
|
+
* @response `200` `ListingPhoto` OK
|
|
1405
2403
|
*/
|
|
1406
|
-
addListingPhoto: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/photos`, method: "POST", body: data, secure: true, type:
|
|
2404
|
+
addListingPhoto: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/photos`, method: "POST", body: data, secure: true, type: "multipart/form-data", format: "json" }, params)),
|
|
1407
2405
|
/**
|
|
1408
2406
|
* No description
|
|
1409
2407
|
*
|
|
@@ -1412,9 +2410,9 @@ export class Api extends HttpClient {
|
|
|
1412
2410
|
* @summary Update
|
|
1413
2411
|
* @request PATCH:/api/listings/{listingId}/photos
|
|
1414
2412
|
* @secure
|
|
1415
|
-
* @response `200` `(ListingPhoto)[]`
|
|
2413
|
+
* @response `200` `(ListingPhoto)[]` OK
|
|
1416
2414
|
*/
|
|
1417
|
-
updateListingPhotos: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/photos`, method: "PATCH", body: data, secure: true, type:
|
|
2415
|
+
updateListingPhotos: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/photos`, method: "PATCH", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1418
2416
|
/**
|
|
1419
2417
|
* No description
|
|
1420
2418
|
*
|
|
@@ -1434,7 +2432,7 @@ export class Api extends HttpClient {
|
|
|
1434
2432
|
* @summary Get All
|
|
1435
2433
|
* @request GET:/api/listings
|
|
1436
2434
|
* @secure
|
|
1437
|
-
* @response `200` `ListingPaginated`
|
|
2435
|
+
* @response `200` `ListingPaginated` OK
|
|
1438
2436
|
*/
|
|
1439
2437
|
getListings: (query, params = {}) => this.request(Object.assign({ path: `/api/listings`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
1440
2438
|
/**
|
|
@@ -1447,7 +2445,7 @@ export class Api extends HttpClient {
|
|
|
1447
2445
|
* @secure
|
|
1448
2446
|
* @response `201` `Listing` Created
|
|
1449
2447
|
*/
|
|
1450
|
-
createListing: (data, params = {}) => this.request(Object.assign({ path: `/api/listings`, method: "POST", body: data, secure: true, type:
|
|
2448
|
+
createListing: (data, params = {}) => this.request(Object.assign({ path: `/api/listings`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1451
2449
|
/**
|
|
1452
2450
|
* No description
|
|
1453
2451
|
*
|
|
@@ -1456,7 +2454,7 @@ export class Api extends HttpClient {
|
|
|
1456
2454
|
* @summary Get by Slug
|
|
1457
2455
|
* @request GET:/api/listings/slug/{slug}
|
|
1458
2456
|
* @secure
|
|
1459
|
-
* @response `200` `Listing`
|
|
2457
|
+
* @response `200` `Listing` OK
|
|
1460
2458
|
*/
|
|
1461
2459
|
getListingBySlug: (slug, params = {}) => this.request(Object.assign({ path: `/api/listings/slug/${slug}`, method: "GET", secure: true, format: "json" }, params)),
|
|
1462
2460
|
/**
|
|
@@ -1467,7 +2465,7 @@ export class Api extends HttpClient {
|
|
|
1467
2465
|
* @summary Get by ID
|
|
1468
2466
|
* @request GET:/api/listings/{id}
|
|
1469
2467
|
* @secure
|
|
1470
|
-
* @response `200` `Listing`
|
|
2468
|
+
* @response `200` `Listing` OK
|
|
1471
2469
|
*/
|
|
1472
2470
|
getListing: (id, params = {}) => this.request(Object.assign({ path: `/api/listings/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
1473
2471
|
/**
|
|
@@ -1478,9 +2476,9 @@ export class Api extends HttpClient {
|
|
|
1478
2476
|
* @summary Replace
|
|
1479
2477
|
* @request PUT:/api/listings/{id}
|
|
1480
2478
|
* @secure
|
|
1481
|
-
* @response `200` `Listing`
|
|
2479
|
+
* @response `200` `Listing` OK
|
|
1482
2480
|
*/
|
|
1483
|
-
replaceListing: (id, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${id}`, method: "PUT", body: data, secure: true, type:
|
|
2481
|
+
replaceListing: (id, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1484
2482
|
/**
|
|
1485
2483
|
* No description
|
|
1486
2484
|
*
|
|
@@ -1500,9 +2498,9 @@ export class Api extends HttpClient {
|
|
|
1500
2498
|
* @summary Search
|
|
1501
2499
|
* @request POST:/api/listings/search
|
|
1502
2500
|
* @secure
|
|
1503
|
-
* @response `200` `ListingPaginated`
|
|
2501
|
+
* @response `200` `ListingPaginated` OK
|
|
1504
2502
|
*/
|
|
1505
|
-
searchListings: (data, query, params = {}) => this.request(Object.assign({ path: `/api/listings/search`, method: "POST", query: query, body: data, secure: true, type:
|
|
2503
|
+
searchListings: (data, query, params = {}) => this.request(Object.assign({ path: `/api/listings/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1506
2504
|
/**
|
|
1507
2505
|
* No description
|
|
1508
2506
|
*
|
|
@@ -1511,9 +2509,9 @@ export class Api extends HttpClient {
|
|
|
1511
2509
|
* @summary Update Background Image
|
|
1512
2510
|
* @request PUT:/api/listings/{id}/background-image
|
|
1513
2511
|
* @secure
|
|
1514
|
-
* @response `200` `File`
|
|
2512
|
+
* @response `200` `File` OK
|
|
1515
2513
|
*/
|
|
1516
|
-
updateListingBackgroundImage: (id, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${id}/background-image`, method: "PUT", body: data, secure: true, type:
|
|
2514
|
+
updateListingBackgroundImage: (id, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${id}/background-image`, method: "PUT", body: data, secure: true, type: "multipart/form-data", format: "json" }, params)),
|
|
1517
2515
|
/**
|
|
1518
2516
|
* No description
|
|
1519
2517
|
*
|
|
@@ -1533,7 +2531,7 @@ export class Api extends HttpClient {
|
|
|
1533
2531
|
* @summary Get Open House Flyer
|
|
1534
2532
|
* @request GET:/api/listings/{id}/open-house-flyer
|
|
1535
2533
|
* @secure
|
|
1536
|
-
* @response `200` `File`
|
|
2534
|
+
* @response `200` `File` OK
|
|
1537
2535
|
*/
|
|
1538
2536
|
getListingOpenHouseFlyer: (id, params = {}) => this.request(Object.assign({ path: `/api/listings/${id}/open-house-flyer`, method: "GET", secure: true, format: "json" }, params)),
|
|
1539
2537
|
/**
|
|
@@ -1544,7 +2542,7 @@ export class Api extends HttpClient {
|
|
|
1544
2542
|
* @summary Get
|
|
1545
2543
|
* @request GET:/api/loans/{loanID}/calculators/loan-calculator
|
|
1546
2544
|
* @secure
|
|
1547
|
-
* @response `200` `RunLOCalculation`
|
|
2545
|
+
* @response `200` `RunLOCalculation` OK
|
|
1548
2546
|
*/
|
|
1549
2547
|
getLoanCalculator: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/calculators/loan-calculator`, method: "GET", secure: true, format: "json" }, params)),
|
|
1550
2548
|
/**
|
|
@@ -1555,11 +2553,11 @@ export class Api extends HttpClient {
|
|
|
1555
2553
|
* @summary Run
|
|
1556
2554
|
* @request POST:/api/loans/{loanID}/calculators/loan-calculator
|
|
1557
2555
|
* @secure
|
|
1558
|
-
* @response `200` `RunLOCalculation`
|
|
1559
|
-
* @response `422` `UnprocessableEntity`
|
|
1560
|
-
* @response `423` `UnprocessableEntity`
|
|
2556
|
+
* @response `200` `RunLOCalculation` OK
|
|
2557
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
2558
|
+
* @response `423` `UnprocessableEntity` Locked
|
|
1561
2559
|
*/
|
|
1562
|
-
runLoanCalculator: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/calculators/loan-calculator`, method: "POST", body: data, secure: true, type:
|
|
2560
|
+
runLoanCalculator: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/calculators/loan-calculator`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1563
2561
|
/**
|
|
1564
2562
|
* No description
|
|
1565
2563
|
*
|
|
@@ -1568,7 +2566,7 @@ export class Api extends HttpClient {
|
|
|
1568
2566
|
* @summary Get All
|
|
1569
2567
|
* @request GET:/api/loans/{loanID}/loan-comparison
|
|
1570
2568
|
* @secure
|
|
1571
|
-
* @response `200` `LoanComparison`
|
|
2569
|
+
* @response `200` `LoanComparison` OK
|
|
1572
2570
|
*/
|
|
1573
2571
|
getLoanComparisons: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/loan-comparison`, method: "GET", secure: true, format: "json" }, params)),
|
|
1574
2572
|
/**
|
|
@@ -1580,10 +2578,10 @@ export class Api extends HttpClient {
|
|
|
1580
2578
|
* @request POST:/api/loans/{loanID}/loan-comparison/{index}
|
|
1581
2579
|
* @secure
|
|
1582
2580
|
* @response `201` `LoanComparisonScenario` Created
|
|
1583
|
-
* @response `422` `UnprocessableEntity`
|
|
1584
|
-
* @response `423` `UnprocessableEntity`
|
|
2581
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
2582
|
+
* @response `423` `UnprocessableEntity` Locked
|
|
1585
2583
|
*/
|
|
1586
|
-
createLoanComparison: (loanId, index, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/loan-comparison/${index}`, method: "POST", body: data, secure: true, type:
|
|
2584
|
+
createLoanComparison: (loanId, index, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/loan-comparison/${index}`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1587
2585
|
/**
|
|
1588
2586
|
* No description
|
|
1589
2587
|
*
|
|
@@ -1604,31 +2602,209 @@ export class Api extends HttpClient {
|
|
|
1604
2602
|
* @request POST:/api/loans/{loanID}/loan-comparison/pdf
|
|
1605
2603
|
* @secure
|
|
1606
2604
|
* @response `204` `void` No Content
|
|
1607
|
-
* @response `422` `UnprocessableEntity`
|
|
2605
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
2606
|
+
*/
|
|
2607
|
+
createLoanComparisonPdf: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/loan-comparison/pdf`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
|
|
2608
|
+
/**
|
|
2609
|
+
* No description
|
|
2610
|
+
*
|
|
2611
|
+
* @tags LoanConsents
|
|
2612
|
+
* @name ResyncLoanConsents
|
|
2613
|
+
* @summary Resync loan consents to LOS
|
|
2614
|
+
* @request POST:/api/loans/{loanId}/consents/resync
|
|
2615
|
+
* @secure
|
|
2616
|
+
* @response `204` `void` No Content
|
|
2617
|
+
* @response `404` `ProblemDetails` Not Found
|
|
2618
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
2619
|
+
*/
|
|
2620
|
+
resyncLoanConsents: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/consents/resync`, method: "POST", secure: true }, params)),
|
|
2621
|
+
/**
|
|
2622
|
+
* No description
|
|
2623
|
+
*
|
|
2624
|
+
* @tags LoanCustomFieldValues
|
|
2625
|
+
* @name GetLoanCustomFieldValues
|
|
2626
|
+
* @summary Get all custom field values for a loan
|
|
2627
|
+
* @request GET:/api/loans/{loanId}/custom-fields
|
|
2628
|
+
* @secure
|
|
2629
|
+
* @response `200` `(CustomFieldValue)[]` OK
|
|
2630
|
+
*/
|
|
2631
|
+
getLoanCustomFieldValues: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/custom-fields`, method: "GET", secure: true, format: "json" }, params)),
|
|
2632
|
+
/**
|
|
2633
|
+
* No description
|
|
2634
|
+
*
|
|
2635
|
+
* @tags LoanCustomFieldValues
|
|
2636
|
+
* @name BulkSetLoanCustomFieldValues
|
|
2637
|
+
* @summary Bulk set custom field values for a loan
|
|
2638
|
+
* @request PUT:/api/loans/{loanId}/custom-fields
|
|
2639
|
+
* @secure
|
|
2640
|
+
* @response `204` `void` No Content
|
|
2641
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
2642
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
2643
|
+
*/
|
|
2644
|
+
bulkSetLoanCustomFieldValues: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/custom-fields`, method: "PUT", body: data, secure: true, type: "application/json" }, params)),
|
|
2645
|
+
/**
|
|
2646
|
+
* No description
|
|
2647
|
+
*
|
|
2648
|
+
* @tags LoanCustomFieldValues
|
|
2649
|
+
* @name SetLoanCustomFieldValue
|
|
2650
|
+
* @summary Set a single custom field value
|
|
2651
|
+
* @request PUT:/api/loans/{loanId}/custom-fields/{definitionId}
|
|
2652
|
+
* @secure
|
|
2653
|
+
* @response `204` `void` No Content
|
|
2654
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
2655
|
+
* @response `404` `ProblemDetails` Not Found
|
|
2656
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
2657
|
+
*/
|
|
2658
|
+
setLoanCustomFieldValue: (loanId, definitionId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/custom-fields/${definitionId}`, method: "PUT", body: data, secure: true, type: "application/json" }, params)),
|
|
2659
|
+
/**
|
|
2660
|
+
* No description
|
|
2661
|
+
*
|
|
2662
|
+
* @tags LoanCustomFieldValues
|
|
2663
|
+
* @name DeleteLoanCustomFieldValue
|
|
2664
|
+
* @summary Remove a custom field value
|
|
2665
|
+
* @request DELETE:/api/loans/{loanId}/custom-fields/{definitionId}
|
|
2666
|
+
* @secure
|
|
2667
|
+
* @response `204` `void` No Content
|
|
2668
|
+
* @response `404` `ProblemDetails` Not Found
|
|
2669
|
+
*/
|
|
2670
|
+
deleteLoanCustomFieldValue: (loanId, definitionId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/custom-fields/${definitionId}`, method: "DELETE", secure: true }, params)),
|
|
2671
|
+
/**
|
|
2672
|
+
* No description
|
|
2673
|
+
*
|
|
2674
|
+
* @tags LoanDocumentBuckets
|
|
2675
|
+
* @name GetLoanDocumentBuckets
|
|
2676
|
+
* @summary Get All
|
|
2677
|
+
* @request GET:/api/loans/{loanId}/documents/buckets
|
|
2678
|
+
* @deprecated
|
|
2679
|
+
* @secure
|
|
2680
|
+
* @response `200` `(string)[]` OK
|
|
2681
|
+
*/
|
|
2682
|
+
getLoanDocumentBuckets: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/buckets`, method: "GET", secure: true, format: "json" }, params)),
|
|
2683
|
+
/**
|
|
2684
|
+
* No description
|
|
2685
|
+
*
|
|
2686
|
+
* @tags LoanDocumentFolders
|
|
2687
|
+
* @name SearchLoanDocumentFolders
|
|
2688
|
+
* @summary Search loan document folders for the current account
|
|
2689
|
+
* @request POST:/api/loan-document-folders/search
|
|
2690
|
+
* @secure
|
|
2691
|
+
* @response `200` `LoanDocumentFolderPaginated` OK
|
|
2692
|
+
*/
|
|
2693
|
+
searchLoanDocumentFolders: (data, query, params = {}) => this.request(Object.assign({ path: `/api/loan-document-folders/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2694
|
+
/**
|
|
2695
|
+
* No description
|
|
2696
|
+
*
|
|
2697
|
+
* @tags LoanDocumentFolders
|
|
2698
|
+
* @name GetLoanDocumentFolderById
|
|
2699
|
+
* @summary Get a loan document folder by ID
|
|
2700
|
+
* @request GET:/api/loan-document-folders/{id}
|
|
2701
|
+
* @secure
|
|
2702
|
+
* @response `200` `LoanDocumentFolder` OK
|
|
2703
|
+
* @response `404` `ProblemDetails` Not Found
|
|
2704
|
+
*/
|
|
2705
|
+
getLoanDocumentFolderById: (id, params = {}) => this.request(Object.assign({ path: `/api/loan-document-folders/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
2706
|
+
/**
|
|
2707
|
+
* No description
|
|
2708
|
+
*
|
|
2709
|
+
* @tags LoanDocumentFolders
|
|
2710
|
+
* @name UpdateLoanDocumentFolder
|
|
2711
|
+
* @summary Update a loan document folder. Blocked when folder has ever been referenced, except for permission edits on the system-default Unassigned folder.
|
|
2712
|
+
* @request PUT:/api/loan-document-folders/{id}
|
|
2713
|
+
* @secure
|
|
2714
|
+
* @response `200` `LoanDocumentFolder` OK
|
|
2715
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
2716
|
+
* @response `404` `ProblemDetails` Not Found
|
|
2717
|
+
* @response `409` `ProblemDetails` Conflict
|
|
2718
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
2719
|
+
*/
|
|
2720
|
+
updateLoanDocumentFolder: (id, data, params = {}) => this.request(Object.assign({ path: `/api/loan-document-folders/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2721
|
+
/**
|
|
2722
|
+
* No description
|
|
2723
|
+
*
|
|
2724
|
+
* @tags LoanDocumentFolders
|
|
2725
|
+
* @name DeleteLoanDocumentFolder
|
|
2726
|
+
* @summary Delete a loan document folder. Allowed only when the folder has never been referenced and is not the system-default Unassigned folder.
|
|
2727
|
+
* @request DELETE:/api/loan-document-folders/{id}
|
|
2728
|
+
* @secure
|
|
2729
|
+
* @response `204` `void` No Content
|
|
2730
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
2731
|
+
* @response `404` `ProblemDetails` Not Found
|
|
2732
|
+
* @response `409` `ProblemDetails` Conflict
|
|
2733
|
+
*/
|
|
2734
|
+
deleteLoanDocumentFolder: (id, params = {}) => this.request(Object.assign({ path: `/api/loan-document-folders/${id}`, method: "DELETE", secure: true }, params)),
|
|
2735
|
+
/**
|
|
2736
|
+
* No description
|
|
2737
|
+
*
|
|
2738
|
+
* @tags LoanDocumentFolders
|
|
2739
|
+
* @name CreateLoanDocumentFolder
|
|
2740
|
+
* @summary Create a loan document folder
|
|
2741
|
+
* @request POST:/api/loan-document-folders
|
|
2742
|
+
* @secure
|
|
2743
|
+
* @response `201` `LoanDocumentFolder` Created
|
|
2744
|
+
* @response `409` `ProblemDetails` Conflict
|
|
2745
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
2746
|
+
*/
|
|
2747
|
+
createLoanDocumentFolder: (data, params = {}) => this.request(Object.assign({ path: `/api/loan-document-folders`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2748
|
+
/**
|
|
2749
|
+
* No description
|
|
2750
|
+
*
|
|
2751
|
+
* @tags LoanDocumentFolders
|
|
2752
|
+
* @name DeactivateLoanDocumentFolder
|
|
2753
|
+
* @summary Deactivate a loan document folder. Rejected for the system-default Unassigned folder.
|
|
2754
|
+
* @request POST:/api/loan-document-folders/{id}/deactivate
|
|
2755
|
+
* @secure
|
|
2756
|
+
* @response `204` `void` No Content
|
|
2757
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
2758
|
+
* @response `404` `ProblemDetails` Not Found
|
|
2759
|
+
*/
|
|
2760
|
+
deactivateLoanDocumentFolder: (id, params = {}) => this.request(Object.assign({ path: `/api/loan-document-folders/${id}/deactivate`, method: "POST", secure: true }, params)),
|
|
2761
|
+
/**
|
|
2762
|
+
* No description
|
|
2763
|
+
*
|
|
2764
|
+
* @tags LoanDocumentFolders
|
|
2765
|
+
* @name ReactivateLoanDocumentFolder
|
|
2766
|
+
* @summary Reactivate a loan document folder.
|
|
2767
|
+
* @request POST:/api/loan-document-folders/{id}/reactivate
|
|
2768
|
+
* @secure
|
|
2769
|
+
* @response `204` `void` No Content
|
|
2770
|
+
* @response `404` `ProblemDetails` Not Found
|
|
2771
|
+
*/
|
|
2772
|
+
reactivateLoanDocumentFolder: (id, params = {}) => this.request(Object.assign({ path: `/api/loan-document-folders/${id}/reactivate`, method: "POST", secure: true }, params)),
|
|
2773
|
+
/**
|
|
2774
|
+
* No description
|
|
2775
|
+
*
|
|
2776
|
+
* @tags LoanDocumentFolders
|
|
2777
|
+
* @name GetLoanDocumentFolderUsage
|
|
2778
|
+
* @summary Get folder usage. Returns HasEverBeenReferenced including soft-deleted documents and tasks.
|
|
2779
|
+
* @request GET:/api/loan-document-folders/{id}/usage
|
|
2780
|
+
* @secure
|
|
2781
|
+
* @response `200` `LoanDocumentFolderUsage` OK
|
|
2782
|
+
* @response `404` `ProblemDetails` Not Found
|
|
1608
2783
|
*/
|
|
1609
|
-
|
|
2784
|
+
getLoanDocumentFolderUsage: (id, params = {}) => this.request(Object.assign({ path: `/api/loan-document-folders/${id}/usage`, method: "GET", secure: true, format: "json" }, params)),
|
|
1610
2785
|
/**
|
|
1611
|
-
*
|
|
2786
|
+
* @description Returns each folder that holds at least one document the caller can read, with the document count per folder. Documents that are not assigned to a folder are returned as a synthetic 'Unassigned' folder (ID = empty GUID).
|
|
1612
2787
|
*
|
|
1613
|
-
* @tags
|
|
1614
|
-
* @name
|
|
1615
|
-
* @summary Get
|
|
1616
|
-
* @request GET:/api/loans/{loanId}/
|
|
2788
|
+
* @tags LoanDocumentFoldersForSingleLoan
|
|
2789
|
+
* @name ListLoanDocumentFolders
|
|
2790
|
+
* @summary Get the loan's document folders
|
|
2791
|
+
* @request GET:/api/loans/{loanId}/document-folders
|
|
1617
2792
|
* @secure
|
|
1618
|
-
* @response `200` `(
|
|
2793
|
+
* @response `200` `(LoanDocumentFolderWithCount)[]` OK
|
|
1619
2794
|
*/
|
|
1620
|
-
|
|
2795
|
+
listLoanDocumentFolders: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/document-folders`, method: "GET", secure: true, format: "json" }, params)),
|
|
1621
2796
|
/**
|
|
1622
|
-
*
|
|
2797
|
+
* @description Deprecated — use GET documents/folders. Returns all documents grouped by folder for sidebar display. Use folderNamesOnly=true to get a simplified response with folder names and counts for mobile (Files array will be empty).
|
|
1623
2798
|
*
|
|
1624
|
-
* @tags
|
|
1625
|
-
* @name
|
|
1626
|
-
* @summary
|
|
1627
|
-
* @request POST:/api/loans/{loanId}/documents/
|
|
2799
|
+
* @tags LoanDocumentFoldersForSingleLoan
|
|
2800
|
+
* @name GetLoanDocumentFolders
|
|
2801
|
+
* @summary [Deprecated] Get document folder hierarchy
|
|
2802
|
+
* @request POST:/api/loans/{loanId}/documents/folders
|
|
2803
|
+
* @deprecated
|
|
1628
2804
|
* @secure
|
|
1629
|
-
* @response `
|
|
2805
|
+
* @response `200` `(DocumentFolder)[]` OK
|
|
1630
2806
|
*/
|
|
1631
|
-
|
|
2807
|
+
getLoanDocumentFolders: (loanId, data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/folders`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1632
2808
|
/**
|
|
1633
2809
|
* No description
|
|
1634
2810
|
*
|
|
@@ -1637,7 +2813,7 @@ export class Api extends HttpClient {
|
|
|
1637
2813
|
* @summary Get By ID
|
|
1638
2814
|
* @request GET:/api/loans/{loanId}/documents/{documentId}
|
|
1639
2815
|
* @secure
|
|
1640
|
-
* @response `200` `LoanDocument`
|
|
2816
|
+
* @response `200` `LoanDocument` OK
|
|
1641
2817
|
* @response `404` `ProblemDetails` Not Found
|
|
1642
2818
|
*/
|
|
1643
2819
|
getLoanDocument: (loanId, documentId, query, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/${documentId}`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
@@ -1645,24 +2821,25 @@ export class Api extends HttpClient {
|
|
|
1645
2821
|
* No description
|
|
1646
2822
|
*
|
|
1647
2823
|
* @tags LoanDocuments
|
|
1648
|
-
* @name
|
|
1649
|
-
* @summary
|
|
1650
|
-
* @request POST:/api/loans/{loanId}/documents/
|
|
2824
|
+
* @name GetLoanDocumentPreviews
|
|
2825
|
+
* @summary Get document previews in batch
|
|
2826
|
+
* @request POST:/api/loans/{loanId}/documents/previews
|
|
1651
2827
|
* @secure
|
|
1652
|
-
* @response `200` `
|
|
2828
|
+
* @response `200` `Record<string,string>` OK
|
|
2829
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
1653
2830
|
*/
|
|
1654
|
-
|
|
2831
|
+
getLoanDocumentPreviews: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/previews`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1655
2832
|
/**
|
|
1656
|
-
*
|
|
2833
|
+
* No description
|
|
1657
2834
|
*
|
|
1658
2835
|
* @tags LoanDocuments
|
|
1659
|
-
* @name
|
|
1660
|
-
* @summary
|
|
1661
|
-
* @request POST:/api/loans/{loanId}/documents/
|
|
2836
|
+
* @name SearchLoanDocuments
|
|
2837
|
+
* @summary Search loan documents
|
|
2838
|
+
* @request POST:/api/loans/{loanId}/documents/search
|
|
1662
2839
|
* @secure
|
|
1663
|
-
* @response `200` `
|
|
2840
|
+
* @response `200` `LoanDocumentSearchPaginated` OK
|
|
1664
2841
|
*/
|
|
1665
|
-
|
|
2842
|
+
searchLoanDocuments: (loanId, data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1666
2843
|
/**
|
|
1667
2844
|
* No description
|
|
1668
2845
|
*
|
|
@@ -1671,7 +2848,7 @@ export class Api extends HttpClient {
|
|
|
1671
2848
|
* @summary Download By ID
|
|
1672
2849
|
* @request GET:/api/loans/{loanId}/documents/{documentId}/download
|
|
1673
2850
|
* @secure
|
|
1674
|
-
* @response `200` `
|
|
2851
|
+
* @response `200` `Blob` OK
|
|
1675
2852
|
* @response `404` `ProblemDetails` Not Found
|
|
1676
2853
|
*/
|
|
1677
2854
|
downloadLoanDocument: (loanId, documentId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/${documentId}/download`, method: "GET", secure: true, format: "json" }, params)),
|
|
@@ -1685,9 +2862,9 @@ export class Api extends HttpClient {
|
|
|
1685
2862
|
* @secure
|
|
1686
2863
|
* @response `201` `LoanDocument` Created
|
|
1687
2864
|
* @response `404` `ProblemDetails` Not Found
|
|
1688
|
-
* @response `422` `UnprocessableEntity`
|
|
2865
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
1689
2866
|
*/
|
|
1690
|
-
createLoanDocument: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents`, method: "POST", body: data, secure: true, type:
|
|
2867
|
+
createLoanDocument: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents`, method: "POST", body: data, secure: true, type: "multipart/form-data", format: "json" }, params)),
|
|
1691
2868
|
/**
|
|
1692
2869
|
* No description
|
|
1693
2870
|
*
|
|
@@ -1696,9 +2873,9 @@ export class Api extends HttpClient {
|
|
|
1696
2873
|
* @summary Retry
|
|
1697
2874
|
* @request POST:/api/loans/{loanId}/documents/{documentId}/retry
|
|
1698
2875
|
* @secure
|
|
1699
|
-
* @response `200` `LoanDocument`
|
|
2876
|
+
* @response `200` `LoanDocument` OK
|
|
1700
2877
|
* @response `404` `ProblemDetails` Not Found
|
|
1701
|
-
* @response `422` `UnprocessableEntity`
|
|
2878
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
1702
2879
|
*/
|
|
1703
2880
|
retryFailedLoanDocument: (loanId, documentId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/${documentId}/retry`, method: "POST", secure: true, format: "json" }, params)),
|
|
1704
2881
|
/**
|
|
@@ -1709,9 +2886,9 @@ export class Api extends HttpClient {
|
|
|
1709
2886
|
* @summary Generate PDF Document
|
|
1710
2887
|
* @request POST:/api/loans/{loanId}/documents/generate
|
|
1711
2888
|
* @secure
|
|
1712
|
-
* @response `200` `DocumentDataRequest`
|
|
2889
|
+
* @response `200` `DocumentDataRequest` OK
|
|
1713
2890
|
*/
|
|
1714
|
-
generateLoanDocument: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/generate`, method: "POST", body: data, secure: true, type:
|
|
2891
|
+
generateLoanDocument: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/generate`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1715
2892
|
/**
|
|
1716
2893
|
* No description
|
|
1717
2894
|
*
|
|
@@ -1720,11 +2897,11 @@ export class Api extends HttpClient {
|
|
|
1720
2897
|
* @summary Send existing documents to loan users or external emails
|
|
1721
2898
|
* @request POST:/api/loans/{loanId}/documents/distribute
|
|
1722
2899
|
* @secure
|
|
1723
|
-
* @response `200` `void`
|
|
2900
|
+
* @response `200` `void` OK
|
|
1724
2901
|
* @response `400` `ProblemDetails` Bad Request
|
|
1725
2902
|
* @response `404` `ProblemDetails` Not Found
|
|
1726
2903
|
*/
|
|
1727
|
-
sendLoanDocuments: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/distribute`, method: "POST", body: data, secure: true, type:
|
|
2904
|
+
sendLoanDocuments: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/distribute`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
|
|
1728
2905
|
/**
|
|
1729
2906
|
* @description Fetches all documents from Encompass that don't exist locally and stores them in S3
|
|
1730
2907
|
*
|
|
@@ -1733,10 +2910,23 @@ export class Api extends HttpClient {
|
|
|
1733
2910
|
* @summary Sync documents from LOS
|
|
1734
2911
|
* @request POST:/api/loans/{loanId}/documents/sync
|
|
1735
2912
|
* @secure
|
|
1736
|
-
* @response `200` `DocumentSync`
|
|
2913
|
+
* @response `200` `DocumentSync` OK
|
|
1737
2914
|
* @response `404` `ProblemDetails` Not Found
|
|
1738
2915
|
*/
|
|
1739
2916
|
syncLoanDocumentsFromLos: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/sync`, method: "POST", secure: true, format: "json" }, params)),
|
|
2917
|
+
/**
|
|
2918
|
+
* No description
|
|
2919
|
+
*
|
|
2920
|
+
* @tags LoanDocuments
|
|
2921
|
+
* @name ClassifyLoanDocumentManually
|
|
2922
|
+
* @summary Manually classify a loan document
|
|
2923
|
+
* @request POST:/api/loans/{loanId}/documents/{documentId}/classify-manual
|
|
2924
|
+
* @secure
|
|
2925
|
+
* @response `200` `LoanDocument` OK
|
|
2926
|
+
* @response `404` `ProblemDetails` Not Found
|
|
2927
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
2928
|
+
*/
|
|
2929
|
+
classifyLoanDocumentManually: (loanId, documentId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/${documentId}/classify-manual`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1740
2930
|
/**
|
|
1741
2931
|
* @description Re-attempts to push a failed document to LOS
|
|
1742
2932
|
*
|
|
@@ -1745,9 +2935,9 @@ export class Api extends HttpClient {
|
|
|
1745
2935
|
* @summary Retry syncing a document to LOS
|
|
1746
2936
|
* @request POST:/api/loans/{loanId}/documents/{documentId}/sync/retry
|
|
1747
2937
|
* @secure
|
|
1748
|
-
* @response `200` `void`
|
|
2938
|
+
* @response `200` `void` OK
|
|
1749
2939
|
* @response `404` `ProblemDetails` Not Found
|
|
1750
|
-
* @response `423` `ProblemDetails`
|
|
2940
|
+
* @response `423` `ProblemDetails` Locked
|
|
1751
2941
|
*/
|
|
1752
2942
|
retrySyncLoanDocumentToLos: (loanId, documentId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/${documentId}/sync/retry`, method: "POST", secure: true }, params)),
|
|
1753
2943
|
/**
|
|
@@ -1760,7 +2950,7 @@ export class Api extends HttpClient {
|
|
|
1760
2950
|
* @secure
|
|
1761
2951
|
* @response `201` `Draft` Created
|
|
1762
2952
|
*/
|
|
1763
|
-
createLoanDraft: (data, params = {}) => this.request(Object.assign({ path: `/api/loans/drafts`, method: "POST", body: data, secure: true, type:
|
|
2953
|
+
createLoanDraft: (data, params = {}) => this.request(Object.assign({ path: `/api/loans/drafts`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1764
2954
|
/**
|
|
1765
2955
|
* No description
|
|
1766
2956
|
*
|
|
@@ -1769,7 +2959,7 @@ export class Api extends HttpClient {
|
|
|
1769
2959
|
* @summary Get All
|
|
1770
2960
|
* @request GET:/api/loans/drafts
|
|
1771
2961
|
* @secure
|
|
1772
|
-
* @response `200` `(DraftContent)[]`
|
|
2962
|
+
* @response `200` `(DraftContent)[]` OK
|
|
1773
2963
|
*/
|
|
1774
2964
|
getLoanDrafts: (params = {}) => this.request(Object.assign({ path: `/api/loans/drafts`, method: "GET", secure: true, format: "json" }, params)),
|
|
1775
2965
|
/**
|
|
@@ -1780,7 +2970,7 @@ export class Api extends HttpClient {
|
|
|
1780
2970
|
* @summary Get by ID
|
|
1781
2971
|
* @request GET:/api/loans/drafts/{draftId}
|
|
1782
2972
|
* @secure
|
|
1783
|
-
* @response `200` `DraftContent`
|
|
2973
|
+
* @response `200` `DraftContent` OK
|
|
1784
2974
|
*/
|
|
1785
2975
|
getLoanDraft: (draftId, params = {}) => this.request(Object.assign({ path: `/api/loans/drafts/${draftId}`, method: "GET", secure: true, format: "json" }, params)),
|
|
1786
2976
|
/**
|
|
@@ -1791,9 +2981,9 @@ export class Api extends HttpClient {
|
|
|
1791
2981
|
* @summary Replace
|
|
1792
2982
|
* @request PUT:/api/loans/drafts/{draftId}
|
|
1793
2983
|
* @secure
|
|
1794
|
-
* @response `200` `Draft`
|
|
2984
|
+
* @response `200` `Draft` OK
|
|
1795
2985
|
*/
|
|
1796
|
-
replaceLoanDraft: (draftId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/drafts/${draftId}`, method: "PUT", body: data, secure: true, type:
|
|
2986
|
+
replaceLoanDraft: (draftId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/drafts/${draftId}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1797
2987
|
/**
|
|
1798
2988
|
* No description
|
|
1799
2989
|
*
|
|
@@ -1815,7 +3005,7 @@ export class Api extends HttpClient {
|
|
|
1815
3005
|
* @secure
|
|
1816
3006
|
* @response `201` `DraftContentPaginated` Created
|
|
1817
3007
|
*/
|
|
1818
|
-
searchLoanDrafts: (data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/drafts/search`, method: "POST", query: query, body: data, secure: true, type:
|
|
3008
|
+
searchLoanDrafts: (data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/drafts/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1819
3009
|
/**
|
|
1820
3010
|
* No description
|
|
1821
3011
|
*
|
|
@@ -1824,9 +3014,9 @@ export class Api extends HttpClient {
|
|
|
1824
3014
|
* @summary Reassign Loan officer
|
|
1825
3015
|
* @request PUT:/api/loans/drafts/{draftId}/reassign
|
|
1826
3016
|
* @secure
|
|
1827
|
-
* @response `200` `Draft`
|
|
3017
|
+
* @response `200` `Draft` OK
|
|
1828
3018
|
*/
|
|
1829
|
-
reassignLoanOfficer: (draftId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/drafts/${draftId}/reassign`, method: "PUT", body: data, secure: true, type:
|
|
3019
|
+
reassignLoanOfficer: (draftId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/drafts/${draftId}/reassign`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1830
3020
|
/**
|
|
1831
3021
|
* No description
|
|
1832
3022
|
*
|
|
@@ -1835,7 +3025,7 @@ export class Api extends HttpClient {
|
|
|
1835
3025
|
* @summary Restore deleted draft
|
|
1836
3026
|
* @request POST:/api/loans/drafts/{draftId}/restore
|
|
1837
3027
|
* @secure
|
|
1838
|
-
* @response `200` `Draft`
|
|
3028
|
+
* @response `200` `Draft` OK
|
|
1839
3029
|
*/
|
|
1840
3030
|
restoreLoanDraft: (draftId, params = {}) => this.request(Object.assign({ path: `/api/loans/drafts/${draftId}/restore`, method: "POST", secure: true, format: "json" }, params)),
|
|
1841
3031
|
/**
|
|
@@ -1846,7 +3036,7 @@ export class Api extends HttpClient {
|
|
|
1846
3036
|
* @summary Get Loan Imports
|
|
1847
3037
|
* @request GET:/api/loan-imports
|
|
1848
3038
|
* @secure
|
|
1849
|
-
* @response `200` `LoanImportPaginated`
|
|
3039
|
+
* @response `200` `LoanImportPaginated` OK
|
|
1850
3040
|
*/
|
|
1851
3041
|
getLoanImports: (query, params = {}) => this.request(Object.assign({ path: `/api/loan-imports`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
1852
3042
|
/**
|
|
@@ -1859,7 +3049,7 @@ export class Api extends HttpClient {
|
|
|
1859
3049
|
* @secure
|
|
1860
3050
|
* @response `201` `LoanImport` Created
|
|
1861
3051
|
*/
|
|
1862
|
-
createLoanImport: (data, params = {}) => this.request(Object.assign({ path: `/api/loan-imports`, method: "POST", body: data, secure: true, type:
|
|
3052
|
+
createLoanImport: (data, params = {}) => this.request(Object.assign({ path: `/api/loan-imports`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1863
3053
|
/**
|
|
1864
3054
|
* No description
|
|
1865
3055
|
*
|
|
@@ -1868,7 +3058,7 @@ export class Api extends HttpClient {
|
|
|
1868
3058
|
* @summary Get Loan Import
|
|
1869
3059
|
* @request GET:/api/loan-imports/{id}
|
|
1870
3060
|
* @secure
|
|
1871
|
-
* @response `200` `LoanImport`
|
|
3061
|
+
* @response `200` `LoanImport` OK
|
|
1872
3062
|
*/
|
|
1873
3063
|
getLoanImport: (id, params = {}) => this.request(Object.assign({ path: `/api/loan-imports/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
1874
3064
|
/**
|
|
@@ -1879,7 +3069,7 @@ export class Api extends HttpClient {
|
|
|
1879
3069
|
* @summary Get Loan Import Logs
|
|
1880
3070
|
* @request GET:/api/loan-imports/{id}/logs
|
|
1881
3071
|
* @secure
|
|
1882
|
-
* @response `200` `LoanImportLogPaginated`
|
|
3072
|
+
* @response `200` `LoanImportLogPaginated` OK
|
|
1883
3073
|
*/
|
|
1884
3074
|
getLoanImportLogs: (id, query, params = {}) => this.request(Object.assign({ path: `/api/loan-imports/${id}/logs`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
1885
3075
|
/**
|
|
@@ -1890,7 +3080,7 @@ export class Api extends HttpClient {
|
|
|
1890
3080
|
* @summary Get Invites
|
|
1891
3081
|
* @request GET:/api/loans/{loanId}/invites
|
|
1892
3082
|
* @secure
|
|
1893
|
-
* @response `200` `(Invite)[]`
|
|
3083
|
+
* @response `200` `(Invite)[]` OK
|
|
1894
3084
|
* @response `404` `ProblemDetails` Not Found
|
|
1895
3085
|
*/
|
|
1896
3086
|
getLoanInvites: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/invites`, method: "GET", secure: true, format: "json" }, params)),
|
|
@@ -1902,10 +3092,10 @@ export class Api extends HttpClient {
|
|
|
1902
3092
|
* @summary Invite Contacts
|
|
1903
3093
|
* @request POST:/api/loans/{loanId}/invites
|
|
1904
3094
|
* @secure
|
|
1905
|
-
* @response `200` `(Invite)[]`
|
|
3095
|
+
* @response `200` `(Invite)[]` OK
|
|
1906
3096
|
* @response `404` `ProblemDetails` Not Found
|
|
1907
3097
|
*/
|
|
1908
|
-
inviteLoanContacts: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/invites`, method: "POST", body: data, secure: true, type:
|
|
3098
|
+
inviteLoanContacts: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/invites`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1909
3099
|
/**
|
|
1910
3100
|
* No description
|
|
1911
3101
|
*
|
|
@@ -1914,9 +3104,47 @@ export class Api extends HttpClient {
|
|
|
1914
3104
|
* @summary Search loan logs
|
|
1915
3105
|
* @request POST:/api/loans/{loanId}/logs/search
|
|
1916
3106
|
* @secure
|
|
1917
|
-
* @response `200` `LoanLogPaginated`
|
|
3107
|
+
* @response `200` `LoanLogPaginated` OK
|
|
3108
|
+
*/
|
|
3109
|
+
searchLoanLogs: (loanId, data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/logs/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
3110
|
+
/**
|
|
3111
|
+
* No description
|
|
3112
|
+
*
|
|
3113
|
+
* @tags LoanLogs
|
|
3114
|
+
* @name GetLoanLogById
|
|
3115
|
+
* @summary Get loan log by ID
|
|
3116
|
+
* @request GET:/api/loans/{loanId}/logs/{loanLogId}
|
|
3117
|
+
* @secure
|
|
3118
|
+
* @response `200` `LoanLogDetail` OK
|
|
3119
|
+
* @response `404` `ProblemDetails` Not Found
|
|
3120
|
+
*/
|
|
3121
|
+
getLoanLogById: (loanId, loanLogId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/logs/${loanLogId}`, method: "GET", secure: true, format: "json" }, params)),
|
|
3122
|
+
/**
|
|
3123
|
+
* No description
|
|
3124
|
+
*
|
|
3125
|
+
* @tags LoanNotification
|
|
3126
|
+
* @name SendLoanOptInReminder
|
|
3127
|
+
* @summary Send Loan Opt-In Reminder
|
|
3128
|
+
* @request POST:/api/loans/{loanID}/notifications/opt-in-reminders
|
|
3129
|
+
* @secure
|
|
3130
|
+
* @response `204` `void` No Content
|
|
3131
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
3132
|
+
* @response `404` `ProblemDetails` Not Found
|
|
3133
|
+
*/
|
|
3134
|
+
sendLoanOptInReminder: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/notifications/opt-in-reminders`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
|
|
3135
|
+
/**
|
|
3136
|
+
* No description
|
|
3137
|
+
*
|
|
3138
|
+
* @tags LoanNotification
|
|
3139
|
+
* @name SendESignatureReminder
|
|
3140
|
+
* @summary Send eSignature Reminder
|
|
3141
|
+
* @request POST:/api/loans/{loanID}/notifications/esignature-reminders
|
|
3142
|
+
* @secure
|
|
3143
|
+
* @response `204` `void` No Content
|
|
3144
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
3145
|
+
* @response `404` `ProblemDetails` Not Found
|
|
1918
3146
|
*/
|
|
1919
|
-
|
|
3147
|
+
sendESignatureReminder: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/notifications/esignature-reminders`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
|
|
1920
3148
|
/**
|
|
1921
3149
|
* No description
|
|
1922
3150
|
*
|
|
@@ -1925,7 +3153,7 @@ export class Api extends HttpClient {
|
|
|
1925
3153
|
* @summary Get All
|
|
1926
3154
|
* @request GET:/api/loan-officers
|
|
1927
3155
|
* @secure
|
|
1928
|
-
* @response `200` `BranchUserPaginated`
|
|
3156
|
+
* @response `200` `BranchUserPaginated` OK
|
|
1929
3157
|
*/
|
|
1930
3158
|
getLoanOfficers: (query, params = {}) => this.request(Object.assign({ path: `/api/loan-officers`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
1931
3159
|
/**
|
|
@@ -1936,9 +3164,9 @@ export class Api extends HttpClient {
|
|
|
1936
3164
|
* @summary Search
|
|
1937
3165
|
* @request POST:/api/loan-officers/search
|
|
1938
3166
|
* @secure
|
|
1939
|
-
* @response `200` `BranchUserPaginated`
|
|
3167
|
+
* @response `200` `BranchUserPaginated` OK
|
|
1940
3168
|
*/
|
|
1941
|
-
searchLoanOfficers: (data, query, params = {}) => this.request(Object.assign({ path: `/api/loan-officers/search`, method: "POST", query: query, body: data, secure: true, type:
|
|
3169
|
+
searchLoanOfficers: (data, query, params = {}) => this.request(Object.assign({ path: `/api/loan-officers/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1942
3170
|
/**
|
|
1943
3171
|
* No description
|
|
1944
3172
|
*
|
|
@@ -1947,7 +3175,7 @@ export class Api extends HttpClient {
|
|
|
1947
3175
|
* @summary Get by ID
|
|
1948
3176
|
* @request GET:/api/loan-officers/{id}
|
|
1949
3177
|
* @secure
|
|
1950
|
-
* @response `200` `BranchUser`
|
|
3178
|
+
* @response `200` `BranchUser` OK
|
|
1951
3179
|
*/
|
|
1952
3180
|
getLoanOfficer: (id, params = {}) => this.request(Object.assign({ path: `/api/loan-officers/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
1953
3181
|
/**
|
|
@@ -1958,10 +3186,10 @@ export class Api extends HttpClient {
|
|
|
1958
3186
|
* @summary Create Site Configuration
|
|
1959
3187
|
* @request POST:/api/loan-officers/{loanOfficerId}/site-configurations
|
|
1960
3188
|
* @secure
|
|
1961
|
-
* @response `200` `SiteConfiguration`
|
|
1962
|
-
* @response `422` `UnprocessableEntity`
|
|
3189
|
+
* @response `200` `SiteConfiguration` OK
|
|
3190
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
1963
3191
|
*/
|
|
1964
|
-
createLoanOfficerSiteConfiguration: (loanOfficerId, data, params = {}) => this.request(Object.assign({ path: `/api/loan-officers/${loanOfficerId}/site-configurations`, method: "POST", body: data, secure: true, type:
|
|
3192
|
+
createLoanOfficerSiteConfiguration: (loanOfficerId, data, params = {}) => this.request(Object.assign({ path: `/api/loan-officers/${loanOfficerId}/site-configurations`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1965
3193
|
/**
|
|
1966
3194
|
* No description
|
|
1967
3195
|
*
|
|
@@ -1970,7 +3198,7 @@ export class Api extends HttpClient {
|
|
|
1970
3198
|
* @summary Get Site Configuration
|
|
1971
3199
|
* @request GET:/api/loan-officers/{loanOfficerId}/site-configurations/{siteConfigurationId}
|
|
1972
3200
|
* @secure
|
|
1973
|
-
* @response `200` `SiteConfigurationWithInherited`
|
|
3201
|
+
* @response `200` `SiteConfigurationWithInherited` OK
|
|
1974
3202
|
*/
|
|
1975
3203
|
getLoanOfficerSiteConfiguration: (loanOfficerId, siteConfigurationId, params = {}) => this.request(Object.assign({ path: `/api/loan-officers/${loanOfficerId}/site-configurations/${siteConfigurationId}`, method: "GET", secure: true, format: "json" }, params)),
|
|
1976
3204
|
/**
|
|
@@ -1981,10 +3209,10 @@ export class Api extends HttpClient {
|
|
|
1981
3209
|
* @summary Replace Site Configuration
|
|
1982
3210
|
* @request PUT:/api/loan-officers/{loanOfficerId}/site-configurations/{siteConfigurationId}
|
|
1983
3211
|
* @secure
|
|
1984
|
-
* @response `200` `SiteConfiguration`
|
|
1985
|
-
* @response `422` `UnprocessableEntity`
|
|
3212
|
+
* @response `200` `SiteConfiguration` OK
|
|
3213
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
1986
3214
|
*/
|
|
1987
|
-
replaceLoanOfficerSiteConfiguration: (loanOfficerId, siteConfigurationId, data, query, params = {}) => this.request(Object.assign({ path: `/api/loan-officers/${loanOfficerId}/site-configurations/${siteConfigurationId}`, method: "PUT", query: query, body: data, secure: true, type:
|
|
3215
|
+
replaceLoanOfficerSiteConfiguration: (loanOfficerId, siteConfigurationId, data, query, params = {}) => this.request(Object.assign({ path: `/api/loan-officers/${loanOfficerId}/site-configurations/${siteConfigurationId}`, method: "PUT", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1988
3216
|
/**
|
|
1989
3217
|
* No description
|
|
1990
3218
|
*
|
|
@@ -1993,9 +3221,9 @@ export class Api extends HttpClient {
|
|
|
1993
3221
|
* @summary Search
|
|
1994
3222
|
* @request POST:/api/loans/queue/search
|
|
1995
3223
|
* @secure
|
|
1996
|
-
* @response `200` `LoanQueuePaginated`
|
|
3224
|
+
* @response `200` `LoanQueuePaginated` OK
|
|
1997
3225
|
*/
|
|
1998
|
-
searchLoanQueue: (data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/queue/search`, method: "POST", query: query, body: data, secure: true, type:
|
|
3226
|
+
searchLoanQueue: (data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/queue/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
1999
3227
|
/**
|
|
2000
3228
|
* No description
|
|
2001
3229
|
*
|
|
@@ -2004,7 +3232,7 @@ export class Api extends HttpClient {
|
|
|
2004
3232
|
* @summary Get Loan Queue Record
|
|
2005
3233
|
* @request GET:/api/loans/queue/{loanQueueId}
|
|
2006
3234
|
* @secure
|
|
2007
|
-
* @response `200` `any`
|
|
3235
|
+
* @response `200` `any` OK
|
|
2008
3236
|
* @response `404` `ProblemDetails` Not Found
|
|
2009
3237
|
*/
|
|
2010
3238
|
getLoanQueue: (loanQueueId, params = {}) => this.request(Object.assign({ path: `/api/loans/queue/${loanQueueId}`, method: "GET", secure: true, format: "json" }, params)),
|
|
@@ -2016,10 +3244,10 @@ export class Api extends HttpClient {
|
|
|
2016
3244
|
* @summary Replace Loan Queue Record
|
|
2017
3245
|
* @request PUT:/api/loans/queue/{loanQueueId}
|
|
2018
3246
|
* @secure
|
|
2019
|
-
* @response `200` `LoanQueueWithData`
|
|
3247
|
+
* @response `200` `LoanQueueWithData` OK
|
|
2020
3248
|
* @response `404` `ProblemDetails` Not Found
|
|
2021
3249
|
*/
|
|
2022
|
-
replaceLoanQueue: (loanQueueId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/queue/${loanQueueId}`, method: "PUT", body: data, secure: true, type:
|
|
3250
|
+
replaceLoanQueue: (loanQueueId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/queue/${loanQueueId}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2023
3251
|
/**
|
|
2024
3252
|
* No description
|
|
2025
3253
|
*
|
|
@@ -2052,7 +3280,7 @@ export class Api extends HttpClient {
|
|
|
2052
3280
|
* @summary Get By ID
|
|
2053
3281
|
* @request GET:/api/loans/{loanID}
|
|
2054
3282
|
* @secure
|
|
2055
|
-
* @response `200` `Loan`
|
|
3283
|
+
* @response `200` `Loan` OK
|
|
2056
3284
|
* @response `404` `ProblemDetails` Not Found
|
|
2057
3285
|
*/
|
|
2058
3286
|
getLoan: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}`, method: "GET", secure: true, format: "json" }, params)),
|
|
@@ -2064,7 +3292,7 @@ export class Api extends HttpClient {
|
|
|
2064
3292
|
* @summary Get Loans
|
|
2065
3293
|
* @request GET:/api/loans
|
|
2066
3294
|
* @secure
|
|
2067
|
-
* @response `200` `GetApplications`
|
|
3295
|
+
* @response `200` `GetApplications` OK
|
|
2068
3296
|
*/
|
|
2069
3297
|
getLoans: (params = {}) => this.request(Object.assign({ path: `/api/loans`, method: "GET", secure: true, format: "json" }, params)),
|
|
2070
3298
|
/**
|
|
@@ -2080,7 +3308,7 @@ export class Api extends HttpClient {
|
|
|
2080
3308
|
* @response `401` `ProblemDetails` Unauthorized
|
|
2081
3309
|
* @response `403` `ProblemDetails` Forbidden
|
|
2082
3310
|
*/
|
|
2083
|
-
createLoanv3: (data, params = {}) => this.request(Object.assign({ path: `/api/loans`, method: "POST", body: data, secure: true, type:
|
|
3311
|
+
createLoanv3: (data, params = {}) => this.request(Object.assign({ path: `/api/loans`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2084
3312
|
/**
|
|
2085
3313
|
* No description
|
|
2086
3314
|
*
|
|
@@ -2089,9 +3317,9 @@ export class Api extends HttpClient {
|
|
|
2089
3317
|
* @summary Search
|
|
2090
3318
|
* @request POST:/api/loans/search
|
|
2091
3319
|
* @secure
|
|
2092
|
-
* @response `200` `LoanListPaginated`
|
|
3320
|
+
* @response `200` `LoanListPaginated` OK
|
|
2093
3321
|
*/
|
|
2094
|
-
searchLoans: (data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/search`, method: "POST", query: query, body: data, secure: true, type:
|
|
3322
|
+
searchLoans: (data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2095
3323
|
/**
|
|
2096
3324
|
* No description
|
|
2097
3325
|
*
|
|
@@ -2100,14 +3328,14 @@ export class Api extends HttpClient {
|
|
|
2100
3328
|
* @summary Update loan fields
|
|
2101
3329
|
* @request PATCH:/api/loans/{loanId}
|
|
2102
3330
|
* @secure
|
|
2103
|
-
* @response `200` `Loan`
|
|
3331
|
+
* @response `200` `Loan` OK
|
|
2104
3332
|
* @response `400` `any` Bad Request
|
|
2105
3333
|
* @response `401` `ProblemDetails` Unauthorized
|
|
2106
3334
|
* @response `403` `ProblemDetails` Forbidden
|
|
2107
3335
|
* @response `404` `ProblemDetails` Not Found
|
|
2108
3336
|
* @response `409` `any` Conflict
|
|
2109
3337
|
*/
|
|
2110
|
-
updateLoan: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}`, method: "PATCH", body: data, secure: true, format: "json" }, params)),
|
|
3338
|
+
updateLoan: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}`, method: "PATCH", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2111
3339
|
/**
|
|
2112
3340
|
* No description
|
|
2113
3341
|
*
|
|
@@ -2129,21 +3357,47 @@ export class Api extends HttpClient {
|
|
|
2129
3357
|
* @summary Import from LOS
|
|
2130
3358
|
* @request POST:/api/loans/import-from-los/{loanId}
|
|
2131
3359
|
* @secure
|
|
2132
|
-
* @response `200` `Loan`
|
|
3360
|
+
* @response `200` `Loan` OK
|
|
2133
3361
|
*/
|
|
2134
3362
|
importLoanFromLos: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/import-from-los/${loanId}`, method: "POST", secure: true, format: "json" }, params)),
|
|
2135
3363
|
/**
|
|
2136
3364
|
* No description
|
|
2137
3365
|
*
|
|
2138
|
-
* @tags
|
|
2139
|
-
* @name
|
|
2140
|
-
* @summary
|
|
2141
|
-
* @request POST:/api/loans/
|
|
3366
|
+
* @tags Loans
|
|
3367
|
+
* @name SyncLoanToLos
|
|
3368
|
+
* @summary Sync loan to LOS
|
|
3369
|
+
* @request POST:/api/loans/{loanId}/sync-to-los
|
|
2142
3370
|
* @secure
|
|
2143
|
-
* @response `
|
|
3371
|
+
* @response `202` `void` Accepted
|
|
3372
|
+
* @response `404` `ProblemDetails` Not Found
|
|
3373
|
+
*/
|
|
3374
|
+
syncLoanToLos: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/sync-to-los`, method: "POST", secure: true }, params)),
|
|
3375
|
+
/**
|
|
3376
|
+
* No description
|
|
3377
|
+
*
|
|
3378
|
+
* @tags Loans
|
|
3379
|
+
* @name GetLoanOutstandingItems
|
|
3380
|
+
* @summary Get outstanding items
|
|
3381
|
+
* @request GET:/api/loans/{loanId}/outstanding-items
|
|
3382
|
+
* @secure
|
|
3383
|
+
* @response `200` `LoanOutstandingItems` OK
|
|
3384
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
3385
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
3386
|
+
*/
|
|
3387
|
+
getLoanOutstandingItems: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/outstanding-items`, method: "GET", secure: true, format: "json" }, params)),
|
|
3388
|
+
/**
|
|
3389
|
+
* No description
|
|
3390
|
+
*
|
|
3391
|
+
* @tags Loans
|
|
3392
|
+
* @name TriggerAso
|
|
3393
|
+
* @summary Trigger ASO services
|
|
3394
|
+
* @request POST:/api/loans/{loanId}/aso
|
|
3395
|
+
* @secure
|
|
3396
|
+
* @response `200` `AutomatedService` OK
|
|
3397
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
2144
3398
|
* @response `404` `ProblemDetails` Not Found
|
|
2145
3399
|
*/
|
|
2146
|
-
|
|
3400
|
+
triggerAso: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/aso`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2147
3401
|
/**
|
|
2148
3402
|
* No description
|
|
2149
3403
|
*
|
|
@@ -2152,10 +3406,10 @@ export class Api extends HttpClient {
|
|
|
2152
3406
|
* @summary Search
|
|
2153
3407
|
* @request POST:/api/loans/{loanId}/tasks/{userLoanTaskId}/comments/search
|
|
2154
3408
|
* @secure
|
|
2155
|
-
* @response `200` `TaskCommentPaginated`
|
|
3409
|
+
* @response `200` `TaskCommentPaginated` OK
|
|
2156
3410
|
* @response `404` `ProblemDetails` Not Found
|
|
2157
3411
|
*/
|
|
2158
|
-
searchLoanTaskComments: (loanId, userLoanTaskId, data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments/search`, method: "POST", query: query, body: data, secure: true, type:
|
|
3412
|
+
searchLoanTaskComments: (loanId, userLoanTaskId, data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2159
3413
|
/**
|
|
2160
3414
|
* No description
|
|
2161
3415
|
*
|
|
@@ -2164,7 +3418,7 @@ export class Api extends HttpClient {
|
|
|
2164
3418
|
* @summary Get by ID
|
|
2165
3419
|
* @request GET:/api/loans/{loanId}/tasks/{userLoanTaskId}/comments/{id}
|
|
2166
3420
|
* @secure
|
|
2167
|
-
* @response `200` `TaskComment`
|
|
3421
|
+
* @response `200` `TaskComment` OK
|
|
2168
3422
|
* @response `404` `ProblemDetails` Not Found
|
|
2169
3423
|
*/
|
|
2170
3424
|
getLoanTaskComment: (id, loanId, userLoanTaskId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
@@ -2179,7 +3433,7 @@ export class Api extends HttpClient {
|
|
|
2179
3433
|
* @response `201` `TaskComment` Created
|
|
2180
3434
|
* @response `404` `ProblemDetails` Not Found
|
|
2181
3435
|
*/
|
|
2182
|
-
createLoanTaskComment: (loanId, userLoanTaskId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments`, method: "POST", body: data, secure: true, type:
|
|
3436
|
+
createLoanTaskComment: (loanId, userLoanTaskId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2183
3437
|
/**
|
|
2184
3438
|
* No description
|
|
2185
3439
|
*
|
|
@@ -2188,10 +3442,10 @@ export class Api extends HttpClient {
|
|
|
2188
3442
|
* @summary Replace
|
|
2189
3443
|
* @request PUT:/api/loans/{loanId}/tasks/{userLoanTaskId}/comments/{commentId}
|
|
2190
3444
|
* @secure
|
|
2191
|
-
* @response `200` `TaskComment`
|
|
3445
|
+
* @response `200` `TaskComment` OK
|
|
2192
3446
|
* @response `404` `ProblemDetails` Not Found
|
|
2193
3447
|
*/
|
|
2194
|
-
replaceLoanTaskComment: (loanId, userLoanTaskId, commentId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments/${commentId}`, method: "PUT", body: data, secure: true, type:
|
|
3448
|
+
replaceLoanTaskComment: (loanId, userLoanTaskId, commentId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments/${commentId}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2195
3449
|
/**
|
|
2196
3450
|
* No description
|
|
2197
3451
|
*
|
|
@@ -2214,61 +3468,99 @@ export class Api extends HttpClient {
|
|
|
2214
3468
|
* @secure
|
|
2215
3469
|
* @response `201` `UserLoanTask` Created
|
|
2216
3470
|
* @response `404` `ProblemDetails` Not Found
|
|
2217
|
-
* @response `422` `UnprocessableEntity`
|
|
3471
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
2218
3472
|
*/
|
|
2219
|
-
createLoanTaskDocument: (loanId, loanTaskId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${loanTaskId}/documents`, method: "POST", body: data, secure: true, type:
|
|
3473
|
+
createLoanTaskDocument: (loanId, loanTaskId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${loanTaskId}/documents`, method: "POST", body: data, secure: true, type: "multipart/form-data", format: "json" }, params)),
|
|
2220
3474
|
/**
|
|
2221
3475
|
* No description
|
|
2222
3476
|
*
|
|
2223
|
-
* @tags
|
|
2224
|
-
* @name
|
|
2225
|
-
* @summary
|
|
2226
|
-
* @request POST:/api/loans/{loanID}/tasks/
|
|
3477
|
+
* @tags LoanTaskNotifications
|
|
3478
|
+
* @name SendOutstandingLoanTaskNotification
|
|
3479
|
+
* @summary Send Outstanding Task Notification
|
|
3480
|
+
* @request POST:/api/loans/{loanID}/tasks/reminders/outstanding
|
|
2227
3481
|
* @secure
|
|
2228
|
-
* @response `204` `
|
|
2229
|
-
* @response `
|
|
3482
|
+
* @response `204` `void` No Content
|
|
3483
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
3484
|
+
* @response `404` `ProblemDetails` Not Found
|
|
3485
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
2230
3486
|
*/
|
|
2231
|
-
|
|
3487
|
+
sendOutstandingLoanTaskNotification: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/reminders/outstanding`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
|
|
2232
3488
|
/**
|
|
2233
3489
|
* No description
|
|
2234
3490
|
*
|
|
3491
|
+
* @tags LoanTaskNotifications
|
|
3492
|
+
* @name SendLoanTaskReminder
|
|
3493
|
+
* @summary Send Loan Task Reminder
|
|
3494
|
+
* @request POST:/api/loans/{loanID}/tasks/reminders
|
|
3495
|
+
* @secure
|
|
3496
|
+
* @response `204` `void` No Content
|
|
3497
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
3498
|
+
* @response `404` `ProblemDetails` Not Found
|
|
3499
|
+
*/
|
|
3500
|
+
sendLoanTaskReminder: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/reminders`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
|
|
3501
|
+
/**
|
|
3502
|
+
* @description Search tasks across all loans
|
|
3503
|
+
*
|
|
3504
|
+
* @tags LoanTasks
|
|
3505
|
+
* @name SearchLoanTasks
|
|
3506
|
+
* @summary Search
|
|
3507
|
+
* @request POST:/api/loans/tasks/search
|
|
3508
|
+
* @secure
|
|
3509
|
+
* @response `200` `UserLoanTaskPaginated` OK
|
|
3510
|
+
*/
|
|
3511
|
+
searchLoanTasks: (data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/tasks/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
3512
|
+
/**
|
|
3513
|
+
* @description Returns task counts grouped by status for loans accessible to the current user based on their role
|
|
3514
|
+
*
|
|
2235
3515
|
* @tags LoanTasks
|
|
3516
|
+
* @name SearchLoanTasksSummary
|
|
3517
|
+
* @summary Search Summary
|
|
3518
|
+
* @request POST:/api/loans/tasks/search/summary
|
|
3519
|
+
* @secure
|
|
3520
|
+
* @response `200` `(LoanTaskStatusSummary)[]` OK
|
|
3521
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
3522
|
+
*/
|
|
3523
|
+
searchLoanTasksSummary: (data, params = {}) => this.request(Object.assign({ path: `/api/loans/tasks/search/summary`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
3524
|
+
/**
|
|
3525
|
+
* No description
|
|
3526
|
+
*
|
|
3527
|
+
* @tags LoanTasksForSingleLoan
|
|
2236
3528
|
* @name GetLoanTasks
|
|
2237
3529
|
* @summary Get All
|
|
2238
3530
|
* @request GET:/api/loans/{loanID}/tasks
|
|
2239
3531
|
* @secure
|
|
2240
|
-
* @response `200` `(UserLoanTask)[]`
|
|
3532
|
+
* @response `200` `(UserLoanTask)[]` OK
|
|
2241
3533
|
* @response `404` `ProblemDetails` Not Found
|
|
2242
3534
|
*/
|
|
2243
3535
|
getLoanTasks: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks`, method: "GET", secure: true, format: "json" }, params)),
|
|
2244
3536
|
/**
|
|
2245
3537
|
* No description
|
|
2246
3538
|
*
|
|
2247
|
-
* @tags
|
|
3539
|
+
* @tags LoanTasksForSingleLoan
|
|
2248
3540
|
* @name GetLoanTask
|
|
2249
3541
|
* @summary Get by ID
|
|
2250
3542
|
* @request GET:/api/loans/{loanID}/tasks/{id}
|
|
2251
3543
|
* @secure
|
|
2252
|
-
* @response `200` `UserLoanTask`
|
|
3544
|
+
* @response `200` `UserLoanTask` OK
|
|
2253
3545
|
* @response `404` `ProblemDetails` Not Found
|
|
2254
3546
|
*/
|
|
2255
3547
|
getLoanTask: (id, loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
2256
3548
|
/**
|
|
2257
3549
|
* @description Get the difference between the current loan tasks and the tasks generated by business rules
|
|
2258
3550
|
*
|
|
2259
|
-
* @tags
|
|
3551
|
+
* @tags LoanTasksForSingleLoan
|
|
2260
3552
|
* @name GetLoanTaskDifference
|
|
2261
3553
|
* @summary Get Difference
|
|
2262
3554
|
* @request GET:/api/loans/{loanID}/tasks/diff
|
|
2263
3555
|
* @secure
|
|
2264
|
-
* @response `200` `(UserLoanTask)[]`
|
|
3556
|
+
* @response `200` `(UserLoanTask)[]` OK
|
|
2265
3557
|
* @response `404` `ProblemDetails` Not Found
|
|
2266
3558
|
*/
|
|
2267
3559
|
getLoanTaskDifference: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/diff`, method: "GET", secure: true, format: "json" }, params)),
|
|
2268
3560
|
/**
|
|
2269
3561
|
* No description
|
|
2270
3562
|
*
|
|
2271
|
-
* @tags
|
|
3563
|
+
* @tags LoanTasksForSingleLoan
|
|
2272
3564
|
* @name CreateLoanTask
|
|
2273
3565
|
* @summary Create
|
|
2274
3566
|
* @request POST:/api/loans/{loanID}/tasks/{taskID}
|
|
@@ -2276,11 +3568,11 @@ export class Api extends HttpClient {
|
|
|
2276
3568
|
* @response `201` `UserLoanTask` Created
|
|
2277
3569
|
* @response `404` `ProblemDetails` Not Found
|
|
2278
3570
|
*/
|
|
2279
|
-
createLoanTask: (loanId, taskId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${taskId}`, method: "POST", body: data, secure: true, type:
|
|
3571
|
+
createLoanTask: (loanId, taskId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${taskId}`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2280
3572
|
/**
|
|
2281
3573
|
* No description
|
|
2282
3574
|
*
|
|
2283
|
-
* @tags
|
|
3575
|
+
* @tags LoanTasksForSingleLoan
|
|
2284
3576
|
* @name ImportLoanTask
|
|
2285
3577
|
* @summary Import
|
|
2286
3578
|
* @request POST:/api/loans/{loanID}/tasks/import
|
|
@@ -2288,23 +3580,23 @@ export class Api extends HttpClient {
|
|
|
2288
3580
|
* @response `201` `(UserLoanTask)[]` Created
|
|
2289
3581
|
* @response `404` `ProblemDetails` Not Found
|
|
2290
3582
|
*/
|
|
2291
|
-
importLoanTask: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/import`, method: "POST", body: data, secure: true, type:
|
|
3583
|
+
importLoanTask: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/import`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2292
3584
|
/**
|
|
2293
3585
|
* No description
|
|
2294
3586
|
*
|
|
2295
|
-
* @tags
|
|
3587
|
+
* @tags LoanTasksForSingleLoan
|
|
2296
3588
|
* @name ReplaceLoanTask
|
|
2297
3589
|
* @summary Replace
|
|
2298
3590
|
* @request PUT:/api/loans/{loanID}/tasks/{userLoanTaskID}
|
|
2299
3591
|
* @secure
|
|
2300
|
-
* @response `200` `UserLoanTask`
|
|
3592
|
+
* @response `200` `UserLoanTask` OK
|
|
2301
3593
|
* @response `404` `ProblemDetails` Not Found
|
|
2302
3594
|
*/
|
|
2303
|
-
replaceLoanTask: (loanId, userLoanTaskId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${userLoanTaskId}`, method: "PUT", body: data, secure: true, type:
|
|
3595
|
+
replaceLoanTask: (loanId, userLoanTaskId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${userLoanTaskId}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2304
3596
|
/**
|
|
2305
3597
|
* No description
|
|
2306
3598
|
*
|
|
2307
|
-
* @tags
|
|
3599
|
+
* @tags LoanTasksForSingleLoan
|
|
2308
3600
|
* @name DeleteLoanTask
|
|
2309
3601
|
* @summary Delete
|
|
2310
3602
|
* @request DELETE:/api/loans/{loanID}/tasks/{userLoanTaskID}
|
|
@@ -2313,18 +3605,6 @@ export class Api extends HttpClient {
|
|
|
2313
3605
|
* @response `404` `ProblemDetails` Not Found
|
|
2314
3606
|
*/
|
|
2315
3607
|
deleteLoanTask: (loanId, userLoanTaskId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${userLoanTaskId}`, method: "DELETE", secure: true }, params)),
|
|
2316
|
-
/**
|
|
2317
|
-
* No description
|
|
2318
|
-
*
|
|
2319
|
-
* @tags LoanTasks
|
|
2320
|
-
* @name SendOutstandingLoanTaskNotification
|
|
2321
|
-
* @summary Send Outstanding Task Notification
|
|
2322
|
-
* @request POST:/api/loans/{loanID}/tasks/reminders/outstanding
|
|
2323
|
-
* @secure
|
|
2324
|
-
* @response `204` `void` No Content
|
|
2325
|
-
* @response `404` `ProblemDetails` Not Found
|
|
2326
|
-
*/
|
|
2327
|
-
sendOutstandingLoanTaskNotification: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/reminders/outstanding`, method: "POST", secure: true }, params)),
|
|
2328
3608
|
/**
|
|
2329
3609
|
* No description
|
|
2330
3610
|
*
|
|
@@ -2333,9 +3613,9 @@ export class Api extends HttpClient {
|
|
|
2333
3613
|
* @summary Create
|
|
2334
3614
|
* @request POST:/api/loans/{loanID}/tasks/{loanTaskId}/verifications
|
|
2335
3615
|
* @secure
|
|
2336
|
-
* @response `200` `UserLoanTask`
|
|
3616
|
+
* @response `200` `UserLoanTask` OK
|
|
2337
3617
|
* @response `404` `ProblemDetails` Not Found
|
|
2338
|
-
* @response `422` `UnprocessableEntity`
|
|
3618
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
2339
3619
|
*/
|
|
2340
3620
|
createLoanTaskVerification: (loanId, loanTaskId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${loanTaskId}/verifications`, method: "POST", secure: true, format: "json" }, params)),
|
|
2341
3621
|
/**
|
|
@@ -2346,7 +3626,8 @@ export class Api extends HttpClient {
|
|
|
2346
3626
|
* @summary Get User Loan Consents
|
|
2347
3627
|
* @request GET:/api/loans/{loanId}/users/{userId}/consents
|
|
2348
3628
|
* @secure
|
|
2349
|
-
* @response `200` `(UserLoanConsent)[]`
|
|
3629
|
+
* @response `200` `(UserLoanConsent)[]` OK
|
|
3630
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
2350
3631
|
*/
|
|
2351
3632
|
getLoanUserConsents: (loanId, userId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/users/${userId}/consents`, method: "GET", secure: true, format: "json" }, params)),
|
|
2352
3633
|
/**
|
|
@@ -2357,7 +3638,7 @@ export class Api extends HttpClient {
|
|
|
2357
3638
|
* @summary Get Loan User
|
|
2358
3639
|
* @request GET:/api/loans/{loanId}/users/{userId}
|
|
2359
3640
|
* @secure
|
|
2360
|
-
* @response `200` `LoanUser`
|
|
3641
|
+
* @response `200` `LoanUser` OK
|
|
2361
3642
|
*/
|
|
2362
3643
|
getLoanUser: (loanId, userId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/users/${userId}`, method: "GET", secure: true, format: "json" }, params)),
|
|
2363
3644
|
/**
|
|
@@ -2370,7 +3651,7 @@ export class Api extends HttpClient {
|
|
|
2370
3651
|
* @secure
|
|
2371
3652
|
* @response `201` `LoanUser` Created
|
|
2372
3653
|
*/
|
|
2373
|
-
addLoanUser: (loanId, userId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/users/${userId}`, method: "POST", body: data, secure: true, type:
|
|
3654
|
+
addLoanUser: (loanId, userId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/users/${userId}`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2374
3655
|
/**
|
|
2375
3656
|
* No description
|
|
2376
3657
|
*
|
|
@@ -2393,6 +3674,57 @@ export class Api extends HttpClient {
|
|
|
2393
3674
|
* @response `204` `void` No Content
|
|
2394
3675
|
*/
|
|
2395
3676
|
sendLoanUserInviteReminderNotification: (loanId, userId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/users/${userId}/invite-reminder`, method: "POST", secure: true }, params)),
|
|
3677
|
+
/**
|
|
3678
|
+
* No description
|
|
3679
|
+
*
|
|
3680
|
+
* @tags LosOperationTracking
|
|
3681
|
+
* @name SearchLosOperationTracking
|
|
3682
|
+
* @summary Search LOS operation tracking
|
|
3683
|
+
* @request POST:/api/los-operation-tracking/search
|
|
3684
|
+
* @secure
|
|
3685
|
+
* @response `200` `LosOperationTrackingPaginated` OK
|
|
3686
|
+
*/
|
|
3687
|
+
searchLosOperationTracking: (data, query, params = {}) => this.request(Object.assign({ path: `/api/los-operation-tracking/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
3688
|
+
/**
|
|
3689
|
+
* No description
|
|
3690
|
+
*
|
|
3691
|
+
* @tags LosSyncFailures
|
|
3692
|
+
* @name SearchInboundSyncFailures
|
|
3693
|
+
* @summary Search cross-account failed inbound Encompass syncs (SuperAdmin)
|
|
3694
|
+
* @request POST:/api/monitoring/inbound-sync-failures/search
|
|
3695
|
+
* @secure
|
|
3696
|
+
* @response `200` `LosSyncPaginated` OK
|
|
3697
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
3698
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
3699
|
+
*/
|
|
3700
|
+
searchInboundSyncFailures: (data, query, params = {}) => this.request(Object.assign({ path: `/api/monitoring/inbound-sync-failures/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
3701
|
+
/**
|
|
3702
|
+
* No description
|
|
3703
|
+
*
|
|
3704
|
+
* @tags LosSyncFailures
|
|
3705
|
+
* @name GetInboundSyncFailuresSummary
|
|
3706
|
+
* @summary Summarize cross-account failed inbound Encompass syncs (SuperAdmin)
|
|
3707
|
+
* @request POST:/api/monitoring/inbound-sync-failures/summary
|
|
3708
|
+
* @secure
|
|
3709
|
+
* @response `200` `LosSyncFailuresSummary` OK
|
|
3710
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
3711
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
3712
|
+
*/
|
|
3713
|
+
getInboundSyncFailuresSummary: (data, query, params = {}) => this.request(Object.assign({ path: `/api/monitoring/inbound-sync-failures/summary`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
3714
|
+
/**
|
|
3715
|
+
* No description
|
|
3716
|
+
*
|
|
3717
|
+
* @tags LosSyncFailures
|
|
3718
|
+
* @name RedriveInboundSyncFailure
|
|
3719
|
+
* @summary Manually re-drive a failed inbound Encompass sync (SuperAdmin)
|
|
3720
|
+
* @request POST:/api/monitoring/inbound-sync-failures/{correlationId}/redrive
|
|
3721
|
+
* @secure
|
|
3722
|
+
* @response `202` `void` Accepted
|
|
3723
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
3724
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
3725
|
+
* @response `404` `ProblemDetails` Not Found
|
|
3726
|
+
*/
|
|
3727
|
+
redriveInboundSyncFailure: (correlationId, query, params = {}) => this.request(Object.assign({ path: `/api/monitoring/inbound-sync-failures/${correlationId}/redrive`, method: "POST", query: query, secure: true }, params)),
|
|
2396
3728
|
/**
|
|
2397
3729
|
* No description
|
|
2398
3730
|
*
|
|
@@ -2401,7 +3733,7 @@ export class Api extends HttpClient {
|
|
|
2401
3733
|
* @summary Get All
|
|
2402
3734
|
* @request GET:/api/milestones
|
|
2403
3735
|
* @secure
|
|
2404
|
-
* @response `200` `(MilestoneConfiguration)[]`
|
|
3736
|
+
* @response `200` `(MilestoneConfiguration)[]` OK
|
|
2405
3737
|
*/
|
|
2406
3738
|
getMilestones: (params = {}) => this.request(Object.assign({ path: `/api/milestones`, method: "GET", secure: true, format: "json" }, params)),
|
|
2407
3739
|
/**
|
|
@@ -2413,9 +3745,9 @@ export class Api extends HttpClient {
|
|
|
2413
3745
|
* @request POST:/api/milestones
|
|
2414
3746
|
* @secure
|
|
2415
3747
|
* @response `201` `MilestoneConfiguration` Created
|
|
2416
|
-
* @response `422` `UnprocessableEntity`
|
|
3748
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
2417
3749
|
*/
|
|
2418
|
-
createMilestone: (data, params = {}) => this.request(Object.assign({ path: `/api/milestones`, method: "POST", body: data, secure: true, type:
|
|
3750
|
+
createMilestone: (data, params = {}) => this.request(Object.assign({ path: `/api/milestones`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2419
3751
|
/**
|
|
2420
3752
|
* No description
|
|
2421
3753
|
*
|
|
@@ -2424,7 +3756,7 @@ export class Api extends HttpClient {
|
|
|
2424
3756
|
* @summary Get By ID
|
|
2425
3757
|
* @request GET:/api/milestones/{id}
|
|
2426
3758
|
* @secure
|
|
2427
|
-
* @response `200` `MilestoneConfiguration`
|
|
3759
|
+
* @response `200` `MilestoneConfiguration` OK
|
|
2428
3760
|
* @response `404` `Error` Not Found
|
|
2429
3761
|
*/
|
|
2430
3762
|
getMilestone: (id, params = {}) => this.request(Object.assign({ path: `/api/milestones/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
@@ -2436,11 +3768,11 @@ export class Api extends HttpClient {
|
|
|
2436
3768
|
* @summary Replace
|
|
2437
3769
|
* @request PUT:/api/milestones/{id}
|
|
2438
3770
|
* @secure
|
|
2439
|
-
* @response `200` `MilestoneConfiguration`
|
|
3771
|
+
* @response `200` `MilestoneConfiguration` OK
|
|
2440
3772
|
* @response `404` `Error` Not Found
|
|
2441
|
-
* @response `422` `UnprocessableEntity`
|
|
3773
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
2442
3774
|
*/
|
|
2443
|
-
replaceMilestone: (id, data, params = {}) => this.request(Object.assign({ path: `/api/milestones/${id}`, method: "PUT", body: data, secure: true, type:
|
|
3775
|
+
replaceMilestone: (id, data, params = {}) => this.request(Object.assign({ path: `/api/milestones/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2444
3776
|
/**
|
|
2445
3777
|
* No description
|
|
2446
3778
|
*
|
|
@@ -2453,6 +3785,20 @@ export class Api extends HttpClient {
|
|
|
2453
3785
|
* @response `404` `Error` Not Found
|
|
2454
3786
|
*/
|
|
2455
3787
|
deleteMilestone: (id, params = {}) => this.request(Object.assign({ path: `/api/milestones/${id}`, method: "DELETE", secure: true }, params)),
|
|
3788
|
+
/**
|
|
3789
|
+
* No description
|
|
3790
|
+
*
|
|
3791
|
+
* @tags MobileAppReview
|
|
3792
|
+
* @name SeedMobileAppReview
|
|
3793
|
+
* @summary Idempotently seed the test loan officer, site configuration, loan and completed borrower used by mobile app store reviewers.
|
|
3794
|
+
* @request POST:/api/mobile-app-review/seed
|
|
3795
|
+
* @secure
|
|
3796
|
+
* @response `200` `MobileAppReviewSeed` OK
|
|
3797
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
3798
|
+
* @response `404` `ProblemDetails` Not Found
|
|
3799
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
3800
|
+
*/
|
|
3801
|
+
seedMobileAppReview: (data, params = {}) => this.request(Object.assign({ path: `/api/mobile-app-review/seed`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2456
3802
|
/**
|
|
2457
3803
|
* No description
|
|
2458
3804
|
*
|
|
@@ -2461,10 +3807,10 @@ export class Api extends HttpClient {
|
|
|
2461
3807
|
* @summary Calculate Monthly Payment
|
|
2462
3808
|
* @request POST:/api/mortgage-calculators/monthly-payment
|
|
2463
3809
|
* @secure
|
|
2464
|
-
* @response `200` `MonthlyPaymentCalculator`
|
|
2465
|
-
* @response `422` `ProblemDetails`
|
|
3810
|
+
* @response `200` `MonthlyPaymentCalculator` OK
|
|
3811
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
2466
3812
|
*/
|
|
2467
|
-
calculateMortgageMonthlyPayment: (data, params = {}) => this.request(Object.assign({ path: `/api/mortgage-calculators/monthly-payment`, method: "POST", body: data, secure: true, type:
|
|
3813
|
+
calculateMortgageMonthlyPayment: (data, params = {}) => this.request(Object.assign({ path: `/api/mortgage-calculators/monthly-payment`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2468
3814
|
/**
|
|
2469
3815
|
* No description
|
|
2470
3816
|
*
|
|
@@ -2473,10 +3819,10 @@ export class Api extends HttpClient {
|
|
|
2473
3819
|
* @summary Calculate Affordability
|
|
2474
3820
|
* @request POST:/api/mortgage-calculators/affordability
|
|
2475
3821
|
* @secure
|
|
2476
|
-
* @response `200` `AffordabilityCalculator`
|
|
2477
|
-
* @response `422` `ProblemDetails`
|
|
3822
|
+
* @response `200` `AffordabilityCalculator` OK
|
|
3823
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
2478
3824
|
*/
|
|
2479
|
-
calculateMortgageAffordability: (data, params = {}) => this.request(Object.assign({ path: `/api/mortgage-calculators/affordability`, method: "POST", body: data, secure: true, type:
|
|
3825
|
+
calculateMortgageAffordability: (data, params = {}) => this.request(Object.assign({ path: `/api/mortgage-calculators/affordability`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2480
3826
|
/**
|
|
2481
3827
|
* No description
|
|
2482
3828
|
*
|
|
@@ -2485,10 +3831,10 @@ export class Api extends HttpClient {
|
|
|
2485
3831
|
* @summary Calculate Loan Comparison
|
|
2486
3832
|
* @request POST:/api/mortgage-calculators/loan-comparison
|
|
2487
3833
|
* @secure
|
|
2488
|
-
* @response `200` `LoanComparisonCalculator`
|
|
2489
|
-
* @response `422` `ProblemDetails`
|
|
3834
|
+
* @response `200` `LoanComparisonCalculator` OK
|
|
3835
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
2490
3836
|
*/
|
|
2491
|
-
calculateMortgageLoanComparison: (data, params = {}) => this.request(Object.assign({ path: `/api/mortgage-calculators/loan-comparison`, method: "POST", body: data, secure: true, type:
|
|
3837
|
+
calculateMortgageLoanComparison: (data, params = {}) => this.request(Object.assign({ path: `/api/mortgage-calculators/loan-comparison`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2492
3838
|
/**
|
|
2493
3839
|
* No description
|
|
2494
3840
|
*
|
|
@@ -2497,34 +3843,10 @@ export class Api extends HttpClient {
|
|
|
2497
3843
|
* @summary Calculate Refinance
|
|
2498
3844
|
* @request POST:/api/mortgage-calculators/refinance
|
|
2499
3845
|
* @secure
|
|
2500
|
-
* @response `200` `RefinanceCalculator`
|
|
2501
|
-
* @response `422` `ProblemDetails`
|
|
2502
|
-
*/
|
|
2503
|
-
calculateMortgageRefinance: (data, params = {}) => this.request(Object.assign({ path: `/api/mortgage-calculators/refinance`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
2504
|
-
/**
|
|
2505
|
-
* No description
|
|
2506
|
-
*
|
|
2507
|
-
* @tags Notifications
|
|
2508
|
-
* @name SendNotificationForLoan
|
|
2509
|
-
* @summary Send Notification for Loan
|
|
2510
|
-
* @request POST:/api/notifications
|
|
2511
|
-
* @secure
|
|
2512
|
-
* @response `200` `void` Success
|
|
2513
|
-
* @response `422` `UnprocessableEntity` Client Error
|
|
2514
|
-
*/
|
|
2515
|
-
sendNotificationForLoan: (data, params = {}) => this.request(Object.assign({ path: `/api/notifications`, method: "POST", body: data, secure: true, type: ContentType.Json }, params)),
|
|
2516
|
-
/**
|
|
2517
|
-
* No description
|
|
2518
|
-
*
|
|
2519
|
-
* @tags Notifications
|
|
2520
|
-
* @name SendTestNotificationForLoan
|
|
2521
|
-
* @summary Send Test Notification for Loan
|
|
2522
|
-
* @request POST:/api/notifications/test
|
|
2523
|
-
* @secure
|
|
2524
|
-
* @response `200` `void` Success
|
|
2525
|
-
* @response `422` `UnprocessableEntity` Client Error
|
|
3846
|
+
* @response `200` `RefinanceCalculator` OK
|
|
3847
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
2526
3848
|
*/
|
|
2527
|
-
|
|
3849
|
+
calculateMortgageRefinance: (data, params = {}) => this.request(Object.assign({ path: `/api/mortgage-calculators/refinance`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2528
3850
|
/**
|
|
2529
3851
|
* No description
|
|
2530
3852
|
*
|
|
@@ -2533,7 +3855,7 @@ export class Api extends HttpClient {
|
|
|
2533
3855
|
* @summary Get All
|
|
2534
3856
|
* @request GET:/api/notification-templates
|
|
2535
3857
|
* @secure
|
|
2536
|
-
* @response `200` `(NotificationTemplateBase)[]`
|
|
3858
|
+
* @response `200` `(NotificationTemplateBase)[]` OK
|
|
2537
3859
|
*/
|
|
2538
3860
|
getNotificationTemplates: (query, params = {}) => this.request(Object.assign({ path: `/api/notification-templates`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
2539
3861
|
/**
|
|
@@ -2545,9 +3867,20 @@ export class Api extends HttpClient {
|
|
|
2545
3867
|
* @request POST:/api/notification-templates
|
|
2546
3868
|
* @secure
|
|
2547
3869
|
* @response `201` `NotificationTemplate` Created
|
|
2548
|
-
* @response `422` `UnprocessableEntity`
|
|
3870
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
3871
|
+
*/
|
|
3872
|
+
createNotificationTemplate: (data, params = {}) => this.request(Object.assign({ path: `/api/notification-templates`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
3873
|
+
/**
|
|
3874
|
+
* No description
|
|
3875
|
+
*
|
|
3876
|
+
* @tags NotificationTemplates
|
|
3877
|
+
* @name SearchNotificationTemplates
|
|
3878
|
+
* @summary Search
|
|
3879
|
+
* @request POST:/api/notification-templates/search
|
|
3880
|
+
* @secure
|
|
3881
|
+
* @response `200` `NotificationTemplateBasePaginated` OK
|
|
2549
3882
|
*/
|
|
2550
|
-
|
|
3883
|
+
searchNotificationTemplates: (data, query, params = {}) => this.request(Object.assign({ path: `/api/notification-templates/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2551
3884
|
/**
|
|
2552
3885
|
* No description
|
|
2553
3886
|
*
|
|
@@ -2556,7 +3889,7 @@ export class Api extends HttpClient {
|
|
|
2556
3889
|
* @summary Get by ID
|
|
2557
3890
|
* @request GET:/api/notification-templates/{id}
|
|
2558
3891
|
* @secure
|
|
2559
|
-
* @response `200` `NotificationTemplate`
|
|
3892
|
+
* @response `200` `NotificationTemplate` OK
|
|
2560
3893
|
*/
|
|
2561
3894
|
getNotificationTemplate: (id, params = {}) => this.request(Object.assign({ path: `/api/notification-templates/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
2562
3895
|
/**
|
|
@@ -2567,10 +3900,10 @@ export class Api extends HttpClient {
|
|
|
2567
3900
|
* @summary Replace
|
|
2568
3901
|
* @request PUT:/api/notification-templates/{id}
|
|
2569
3902
|
* @secure
|
|
2570
|
-
* @response `200` `NotificationTemplate`
|
|
2571
|
-
* @response `422` `UnprocessableEntity`
|
|
3903
|
+
* @response `200` `NotificationTemplate` OK
|
|
3904
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
2572
3905
|
*/
|
|
2573
|
-
replaceNotificationTemplate: (id, data, params = {}) => this.request(Object.assign({ path: `/api/notification-templates/${id}`, method: "PUT", body: data, secure: true, type:
|
|
3906
|
+
replaceNotificationTemplate: (id, data, params = {}) => this.request(Object.assign({ path: `/api/notification-templates/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2574
3907
|
/**
|
|
2575
3908
|
* No description
|
|
2576
3909
|
*
|
|
@@ -2590,7 +3923,7 @@ export class Api extends HttpClient {
|
|
|
2590
3923
|
* @summary Restore
|
|
2591
3924
|
* @request POST:/api/notification-templates/{id}/restore
|
|
2592
3925
|
* @secure
|
|
2593
|
-
* @response `200` `NotificationTemplate`
|
|
3926
|
+
* @response `200` `NotificationTemplate` OK
|
|
2594
3927
|
*/
|
|
2595
3928
|
restoreNotificationTemplate: (id, params = {}) => this.request(Object.assign({ path: `/api/notification-templates/${id}/restore`, method: "POST", secure: true, format: "json" }, params)),
|
|
2596
3929
|
/**
|
|
@@ -2601,7 +3934,7 @@ export class Api extends HttpClient {
|
|
|
2601
3934
|
* @summary Get All
|
|
2602
3935
|
* @request GET:/api/notification-templates/{notificationId}/versions
|
|
2603
3936
|
* @secure
|
|
2604
|
-
* @response `200` `(NotificationTemplateVersion)[]`
|
|
3937
|
+
* @response `200` `(NotificationTemplateVersion)[]` OK
|
|
2605
3938
|
*/
|
|
2606
3939
|
getNotificationTemplateVersions: (notificationId, params = {}) => this.request(Object.assign({ path: `/api/notification-templates/${notificationId}/versions`, method: "GET", secure: true, format: "json" }, params)),
|
|
2607
3940
|
/**
|
|
@@ -2612,9 +3945,9 @@ export class Api extends HttpClient {
|
|
|
2612
3945
|
* @summary Create
|
|
2613
3946
|
* @request POST:/api/notification-templates/{notificationId}/versions
|
|
2614
3947
|
* @secure
|
|
2615
|
-
* @response `200` `NotificationTemplateVersion`
|
|
3948
|
+
* @response `200` `NotificationTemplateVersion` OK
|
|
2616
3949
|
*/
|
|
2617
|
-
createNotificationTemplateVersion: (notificationId, data, params = {}) => this.request(Object.assign({ path: `/api/notification-templates/${notificationId}/versions`, method: "POST", body: data, secure: true, type:
|
|
3950
|
+
createNotificationTemplateVersion: (notificationId, data, params = {}) => this.request(Object.assign({ path: `/api/notification-templates/${notificationId}/versions`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2618
3951
|
/**
|
|
2619
3952
|
* No description
|
|
2620
3953
|
*
|
|
@@ -2623,7 +3956,7 @@ export class Api extends HttpClient {
|
|
|
2623
3956
|
* @summary Get by ID
|
|
2624
3957
|
* @request GET:/api/notification-templates/{notificationId}/versions/{id}
|
|
2625
3958
|
* @secure
|
|
2626
|
-
* @response `200` `NotificationTemplateVersion`
|
|
3959
|
+
* @response `200` `NotificationTemplateVersion` OK
|
|
2627
3960
|
*/
|
|
2628
3961
|
getNotificationTemplateVersion: (notificationId, id, params = {}) => this.request(Object.assign({ path: `/api/notification-templates/${notificationId}/versions/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
2629
3962
|
/**
|
|
@@ -2634,9 +3967,9 @@ export class Api extends HttpClient {
|
|
|
2634
3967
|
* @summary Replace
|
|
2635
3968
|
* @request PUT:/api/notification-templates/{notificationId}/versions/{id}
|
|
2636
3969
|
* @secure
|
|
2637
|
-
* @response `200` `NotificationTemplateVersion`
|
|
3970
|
+
* @response `200` `NotificationTemplateVersion` OK
|
|
2638
3971
|
*/
|
|
2639
|
-
replaceNotificationTemplateVersion: (notificationId, id, data, params = {}) => this.request(Object.assign({ path: `/api/notification-templates/${notificationId}/versions/${id}`, method: "PUT", body: data, secure: true, type:
|
|
3972
|
+
replaceNotificationTemplateVersion: (notificationId, id, data, params = {}) => this.request(Object.assign({ path: `/api/notification-templates/${notificationId}/versions/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2640
3973
|
/**
|
|
2641
3974
|
* No description
|
|
2642
3975
|
*
|
|
@@ -2645,7 +3978,7 @@ export class Api extends HttpClient {
|
|
|
2645
3978
|
* @summary Delete
|
|
2646
3979
|
* @request DELETE:/api/notification-templates/{notificationId}/versions/{id}
|
|
2647
3980
|
* @secure
|
|
2648
|
-
* @response `200` `NotificationTemplateVersion`
|
|
3981
|
+
* @response `200` `NotificationTemplateVersion` OK
|
|
2649
3982
|
*/
|
|
2650
3983
|
deleteNotificationTemplateVersion: (notificationId, id, params = {}) => this.request(Object.assign({ path: `/api/notification-templates/${notificationId}/versions/${id}`, method: "DELETE", secure: true, format: "json" }, params)),
|
|
2651
3984
|
/**
|
|
@@ -2656,7 +3989,7 @@ export class Api extends HttpClient {
|
|
|
2656
3989
|
* @summary Get All
|
|
2657
3990
|
* @request GET:/api/partners
|
|
2658
3991
|
* @secure
|
|
2659
|
-
* @response `200` `BranchUserPaginated`
|
|
3992
|
+
* @response `200` `BranchUserPaginated` OK
|
|
2660
3993
|
*/
|
|
2661
3994
|
getPartners: (query, params = {}) => this.request(Object.assign({ path: `/api/partners`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
2662
3995
|
/**
|
|
@@ -2667,9 +4000,9 @@ export class Api extends HttpClient {
|
|
|
2667
4000
|
* @summary Search
|
|
2668
4001
|
* @request POST:/api/partners/search
|
|
2669
4002
|
* @secure
|
|
2670
|
-
* @response `200` `BranchUserPaginated`
|
|
4003
|
+
* @response `200` `BranchUserPaginated` OK
|
|
2671
4004
|
*/
|
|
2672
|
-
searchPartners: (data, query, params = {}) => this.request(Object.assign({ path: `/api/partners/search`, method: "POST", query: query, body: data, secure: true, type:
|
|
4005
|
+
searchPartners: (data, query, params = {}) => this.request(Object.assign({ path: `/api/partners/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2673
4006
|
/**
|
|
2674
4007
|
* No description
|
|
2675
4008
|
*
|
|
@@ -2678,7 +4011,7 @@ export class Api extends HttpClient {
|
|
|
2678
4011
|
* @summary Get by ID
|
|
2679
4012
|
* @request GET:/api/partners/{id}
|
|
2680
4013
|
* @secure
|
|
2681
|
-
* @response `200` `BranchUser`
|
|
4014
|
+
* @response `200` `BranchUser` OK
|
|
2682
4015
|
*/
|
|
2683
4016
|
getPartner: (id, params = {}) => this.request(Object.assign({ path: `/api/partners/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
2684
4017
|
/**
|
|
@@ -2689,10 +4022,10 @@ export class Api extends HttpClient {
|
|
|
2689
4022
|
* @summary Create Site Configuration
|
|
2690
4023
|
* @request POST:/api/partners/{realtorId}/site-configurations
|
|
2691
4024
|
* @secure
|
|
2692
|
-
* @response `200` `SiteConfiguration`
|
|
2693
|
-
* @response `422` `UnprocessableEntity`
|
|
4025
|
+
* @response `200` `SiteConfiguration` OK
|
|
4026
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
2694
4027
|
*/
|
|
2695
|
-
createPartnerSiteConfiguration: (realtorId, data, params = {}) => this.request(Object.assign({ path: `/api/partners/${realtorId}/site-configurations`, method: "POST", body: data, secure: true, type:
|
|
4028
|
+
createPartnerSiteConfiguration: (realtorId, data, params = {}) => this.request(Object.assign({ path: `/api/partners/${realtorId}/site-configurations`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2696
4029
|
/**
|
|
2697
4030
|
* No description
|
|
2698
4031
|
*
|
|
@@ -2701,7 +4034,7 @@ export class Api extends HttpClient {
|
|
|
2701
4034
|
* @summary Get Site Configuration
|
|
2702
4035
|
* @request GET:/api/partners/{realtorId}/site-configurations/{siteConfigurationId}
|
|
2703
4036
|
* @secure
|
|
2704
|
-
* @response `200` `SiteConfigurationWithInherited`
|
|
4037
|
+
* @response `200` `SiteConfigurationWithInherited` OK
|
|
2705
4038
|
*/
|
|
2706
4039
|
getPartnerSiteConfiguration: (realtorId, siteConfigurationId, params = {}) => this.request(Object.assign({ path: `/api/partners/${realtorId}/site-configurations/${siteConfigurationId}`, method: "GET", secure: true, format: "json" }, params)),
|
|
2707
4040
|
/**
|
|
@@ -2712,10 +4045,10 @@ export class Api extends HttpClient {
|
|
|
2712
4045
|
* @summary Replace Site Configuration
|
|
2713
4046
|
* @request PUT:/api/partners/{realtorId}/site-configurations/{siteConfigurationId}
|
|
2714
4047
|
* @secure
|
|
2715
|
-
* @response `200` `SiteConfiguration`
|
|
2716
|
-
* @response `422` `UnprocessableEntity`
|
|
4048
|
+
* @response `200` `SiteConfiguration` OK
|
|
4049
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
2717
4050
|
*/
|
|
2718
|
-
replacePartnerSiteConfiguration: (realtorId, siteConfigurationId, data, query, params = {}) => this.request(Object.assign({ path: `/api/partners/${realtorId}/site-configurations/${siteConfigurationId}`, method: "PUT", query: query, body: data, secure: true, type:
|
|
4051
|
+
replacePartnerSiteConfiguration: (realtorId, siteConfigurationId, data, query, params = {}) => this.request(Object.assign({ path: `/api/partners/${realtorId}/site-configurations/${siteConfigurationId}`, method: "PUT", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2719
4052
|
/**
|
|
2720
4053
|
* No description
|
|
2721
4054
|
*
|
|
@@ -2724,7 +4057,7 @@ export class Api extends HttpClient {
|
|
|
2724
4057
|
* @summary Get By ID
|
|
2725
4058
|
* @request GET:/api/site-configurations/{id}
|
|
2726
4059
|
* @secure
|
|
2727
|
-
* @response `200` `SiteConfiguration`
|
|
4060
|
+
* @response `200` `SiteConfiguration` OK
|
|
2728
4061
|
*/
|
|
2729
4062
|
getSiteConfiguration: (id, params = {}) => this.request(Object.assign({ path: `/api/site-configurations/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
2730
4063
|
/**
|
|
@@ -2736,10 +4069,10 @@ export class Api extends HttpClient {
|
|
|
2736
4069
|
* @request POST:/api/site-configurations/url
|
|
2737
4070
|
* @deprecated
|
|
2738
4071
|
* @secure
|
|
2739
|
-
* @response `200` `SiteConfigurationByUrl`
|
|
2740
|
-
* @response `422` `UnprocessableEntity`
|
|
4072
|
+
* @response `200` `SiteConfigurationByUrl` OK
|
|
4073
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
2741
4074
|
*/
|
|
2742
|
-
searchSiteConfigurationByUrl: (data, params = {}) => this.request(Object.assign({ path: `/api/site-configurations/url`, method: "POST", body: data, secure: true, type:
|
|
4075
|
+
searchSiteConfigurationByUrl: (data, params = {}) => this.request(Object.assign({ path: `/api/site-configurations/url`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2743
4076
|
/**
|
|
2744
4077
|
* No description
|
|
2745
4078
|
*
|
|
@@ -2748,8 +4081,8 @@ export class Api extends HttpClient {
|
|
|
2748
4081
|
* @summary Get By URL
|
|
2749
4082
|
* @request GET:/api/site-configurations
|
|
2750
4083
|
* @secure
|
|
2751
|
-
* @response `200` `SiteConfigurationByUrl`
|
|
2752
|
-
* @response `422` `UnprocessableEntity`
|
|
4084
|
+
* @response `200` `SiteConfigurationByUrl` OK
|
|
4085
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
2753
4086
|
*/
|
|
2754
4087
|
getSiteConfigurationByUrl: (query, params = {}) => this.request(Object.assign({ path: `/api/site-configurations`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
2755
4088
|
/**
|
|
@@ -2761,10 +4094,10 @@ export class Api extends HttpClient {
|
|
|
2761
4094
|
* @request POST:/api/site-configurations/louser
|
|
2762
4095
|
* @deprecated
|
|
2763
4096
|
* @secure
|
|
2764
|
-
* @response `200` `SiteConfiguration`
|
|
2765
|
-
* @response `422` `UnprocessableEntity`
|
|
4097
|
+
* @response `200` `SiteConfiguration` OK
|
|
4098
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
2766
4099
|
*/
|
|
2767
|
-
searchSiteConfigurationByLoanOfficerUser: (data, params = {}) => this.request(Object.assign({ path: `/api/site-configurations/louser`, method: "POST", body: data, secure: true, type:
|
|
4100
|
+
searchSiteConfigurationByLoanOfficerUser: (data, params = {}) => this.request(Object.assign({ path: `/api/site-configurations/louser`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2768
4101
|
/**
|
|
2769
4102
|
* No description
|
|
2770
4103
|
*
|
|
@@ -2773,8 +4106,8 @@ export class Api extends HttpClient {
|
|
|
2773
4106
|
* @summary Get By Loan Officer User
|
|
2774
4107
|
* @request GET:/api/site-configurations/louser/{loUserId}
|
|
2775
4108
|
* @secure
|
|
2776
|
-
* @response `200` `SiteConfiguration`
|
|
2777
|
-
* @response `422` `UnprocessableEntity`
|
|
4109
|
+
* @response `200` `SiteConfiguration` OK
|
|
4110
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
2778
4111
|
*/
|
|
2779
4112
|
getSiteConfigurationByLoanOfficerUser: (loUserId, params = {}) => this.request(Object.assign({ path: `/api/site-configurations/louser/${loUserId}`, method: "GET", secure: true, format: "json" }, params)),
|
|
2780
4113
|
/**
|
|
@@ -2785,10 +4118,10 @@ export class Api extends HttpClient {
|
|
|
2785
4118
|
* @summary Search
|
|
2786
4119
|
* @request POST:/api/site-configurations/search
|
|
2787
4120
|
* @secure
|
|
2788
|
-
* @response `200` `SiteConfigurationSummaryPaginated`
|
|
2789
|
-
* @response `422` `UnprocessableEntity`
|
|
4121
|
+
* @response `200` `SiteConfigurationSummaryPaginated` OK
|
|
4122
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
2790
4123
|
*/
|
|
2791
|
-
searchSiteConfigurations: (data, query, params = {}) => this.request(Object.assign({ path: `/api/site-configurations/search`, method: "POST", query: query, body: data, secure: true, type:
|
|
4124
|
+
searchSiteConfigurations: (data, query, params = {}) => this.request(Object.assign({ path: `/api/site-configurations/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2792
4125
|
/**
|
|
2793
4126
|
* No description
|
|
2794
4127
|
*
|
|
@@ -2797,7 +4130,7 @@ export class Api extends HttpClient {
|
|
|
2797
4130
|
* @summary Get Forms by Site Configuration
|
|
2798
4131
|
* @request GET:/api/site-configurations/{id}/forms
|
|
2799
4132
|
* @secure
|
|
2800
|
-
* @response `200` `(AdminAccessGetForms)[]`
|
|
4133
|
+
* @response `200` `(AdminAccessGetForms)[]` OK
|
|
2801
4134
|
*/
|
|
2802
4135
|
getFormsBySiteConfiguration: (id, params = {}) => this.request(Object.assign({ path: `/api/site-configurations/${id}/forms`, method: "GET", secure: true, format: "json" }, params)),
|
|
2803
4136
|
/**
|
|
@@ -2808,7 +4141,7 @@ export class Api extends HttpClient {
|
|
|
2808
4141
|
* @summary Get Saml Metadata
|
|
2809
4142
|
* @request GET:/api/site-configurations/sso/saml/{ssoIntegration}/metadata
|
|
2810
4143
|
* @secure
|
|
2811
|
-
* @response `200` `File`
|
|
4144
|
+
* @response `200` `File` OK
|
|
2812
4145
|
* @response `404` `ProblemDetails` Not Found
|
|
2813
4146
|
*/
|
|
2814
4147
|
getSamlMetadata: (sSoIntegration, ssoIntegration, params = {}) => this.request(Object.assign({ path: `/api/site-configurations/sso/saml/${ssoIntegration}/metadata`, method: "GET", secure: true }, params)),
|
|
@@ -2820,7 +4153,7 @@ export class Api extends HttpClient {
|
|
|
2820
4153
|
* @summary Create or Replace Saml Metadata
|
|
2821
4154
|
* @request POST:/api/site-configurations/sso/saml/{ssoIntegration}/metadata
|
|
2822
4155
|
* @secure
|
|
2823
|
-
* @response `200` `File`
|
|
4156
|
+
* @response `200` `File` OK
|
|
2824
4157
|
*/
|
|
2825
4158
|
createOrReplaceSamlMetadata: (sSoIntegration, ssoIntegration, params = {}) => this.request(Object.assign({ path: `/api/site-configurations/sso/saml/${ssoIntegration}/metadata`, method: "POST", secure: true }, params)),
|
|
2826
4159
|
/**
|
|
@@ -2831,7 +4164,7 @@ export class Api extends HttpClient {
|
|
|
2831
4164
|
* @summary List all site configurations assigned to a workflow
|
|
2832
4165
|
* @request GET:/api/workflows/{workflowId}/site-configurations
|
|
2833
4166
|
* @secure
|
|
2834
|
-
* @response `200` `(SiteConfigurationForm)[]`
|
|
4167
|
+
* @response `200` `(SiteConfigurationForm)[]` OK
|
|
2835
4168
|
*/
|
|
2836
4169
|
getWorkflowSiteConfigurations: (workflowId, params = {}) => this.request(Object.assign({ path: `/api/workflows/${workflowId}/site-configurations`, method: "GET", secure: true, format: "json" }, params)),
|
|
2837
4170
|
/**
|
|
@@ -2842,7 +4175,7 @@ export class Api extends HttpClient {
|
|
|
2842
4175
|
* @summary Get the workflow-site configuration assignment by composite key
|
|
2843
4176
|
* @request GET:/api/workflows/{workflowId}/site-configurations/{siteConfigurationId}
|
|
2844
4177
|
* @secure
|
|
2845
|
-
* @response `200` `SiteConfigurationForm`
|
|
4178
|
+
* @response `200` `SiteConfigurationForm` OK
|
|
2846
4179
|
* @response `404` `ProblemDetails` Not Found
|
|
2847
4180
|
*/
|
|
2848
4181
|
getWorkflowSiteConfiguration: (workflowId, siteConfigurationId, params = {}) => this.request(Object.assign({ path: `/api/workflows/${workflowId}/site-configurations/${siteConfigurationId}`, method: "GET", secure: true, format: "json" }, params)),
|
|
@@ -2856,7 +4189,7 @@ export class Api extends HttpClient {
|
|
|
2856
4189
|
* @secure
|
|
2857
4190
|
* @response `201` `SiteConfigurationForm` Created
|
|
2858
4191
|
* @response `409` `ProblemDetails` Conflict
|
|
2859
|
-
* @response `422` `UnprocessableEntity`
|
|
4192
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
2860
4193
|
*/
|
|
2861
4194
|
createWorkflowSiteConfiguration: (workflowId, siteConfigurationId, params = {}) => this.request(Object.assign({ path: `/api/workflows/${workflowId}/site-configurations/${siteConfigurationId}`, method: "POST", secure: true, format: "json" }, params)),
|
|
2862
4195
|
/**
|
|
@@ -2878,9 +4211,87 @@ export class Api extends HttpClient {
|
|
|
2878
4211
|
* @summary Get By Site Configuration Slug
|
|
2879
4212
|
* @request POST:/api/site-forms
|
|
2880
4213
|
* @secure
|
|
2881
|
-
* @response `200` `GetForm`
|
|
4214
|
+
* @response `200` `GetForm` OK
|
|
4215
|
+
*/
|
|
4216
|
+
getFormBySiteConfigurationSlug: (data, params = {}) => this.request(Object.assign({ path: `/api/site-forms`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
4217
|
+
/**
|
|
4218
|
+
* No description
|
|
4219
|
+
*
|
|
4220
|
+
* @tags SiteTiles
|
|
4221
|
+
* @name SearchSiteTiles
|
|
4222
|
+
* @summary Search Site Tiles
|
|
4223
|
+
* @request POST:/api/site-tiles/search
|
|
4224
|
+
* @secure
|
|
4225
|
+
* @response `200` `SiteTilePaginated` OK
|
|
4226
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
4227
|
+
*/
|
|
4228
|
+
searchSiteTiles: (data, query, params = {}) => this.request(Object.assign({ path: `/api/site-tiles/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
4229
|
+
/**
|
|
4230
|
+
* No description
|
|
4231
|
+
*
|
|
4232
|
+
* @tags SiteTiles
|
|
4233
|
+
* @name GetSiteTilesBySiteConfiguration
|
|
4234
|
+
* @summary Get Site Tiles by site configuration and location
|
|
4235
|
+
* @request GET:/api/site-tiles/by-site-configuration
|
|
4236
|
+
* @secure
|
|
4237
|
+
* @response `200` `(SiteTileView)[]` OK
|
|
4238
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
4239
|
+
* @response `404` `ProblemDetails` Not Found
|
|
4240
|
+
*/
|
|
4241
|
+
getSiteTilesBySiteConfiguration: (query, params = {}) => this.request(Object.assign({ path: `/api/site-tiles/by-site-configuration`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
4242
|
+
/**
|
|
4243
|
+
* No description
|
|
4244
|
+
*
|
|
4245
|
+
* @tags SiteTiles
|
|
4246
|
+
* @name GetSiteTile
|
|
4247
|
+
* @summary Get Site Tile by ID
|
|
4248
|
+
* @request GET:/api/site-tiles/{siteTileId}
|
|
4249
|
+
* @secure
|
|
4250
|
+
* @response `200` `SiteTile` OK
|
|
4251
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
4252
|
+
* @response `404` `ProblemDetails` Not Found
|
|
4253
|
+
*/
|
|
4254
|
+
getSiteTile: (siteTileId, params = {}) => this.request(Object.assign({ path: `/api/site-tiles/${siteTileId}`, method: "GET", secure: true, format: "json" }, params)),
|
|
4255
|
+
/**
|
|
4256
|
+
* No description
|
|
4257
|
+
*
|
|
4258
|
+
* @tags SiteTiles
|
|
4259
|
+
* @name UpdateSiteTile
|
|
4260
|
+
* @summary Update Site Tile
|
|
4261
|
+
* @request PUT:/api/site-tiles/{siteTileId}
|
|
4262
|
+
* @secure
|
|
4263
|
+
* @response `200` `SiteTile` OK
|
|
4264
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
4265
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
4266
|
+
* @response `404` `ProblemDetails` Not Found
|
|
4267
|
+
*/
|
|
4268
|
+
updateSiteTile: (siteTileId, data, params = {}) => this.request(Object.assign({ path: `/api/site-tiles/${siteTileId}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
4269
|
+
/**
|
|
4270
|
+
* No description
|
|
4271
|
+
*
|
|
4272
|
+
* @tags SiteTiles
|
|
4273
|
+
* @name DeleteSiteTile
|
|
4274
|
+
* @summary Delete Site Tile
|
|
4275
|
+
* @request DELETE:/api/site-tiles/{siteTileId}
|
|
4276
|
+
* @secure
|
|
4277
|
+
* @response `204` `void` No Content
|
|
4278
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
4279
|
+
* @response `404` `ProblemDetails` Not Found
|
|
4280
|
+
*/
|
|
4281
|
+
deleteSiteTile: (siteTileId, params = {}) => this.request(Object.assign({ path: `/api/site-tiles/${siteTileId}`, method: "DELETE", secure: true }, params)),
|
|
4282
|
+
/**
|
|
4283
|
+
* No description
|
|
4284
|
+
*
|
|
4285
|
+
* @tags SiteTiles
|
|
4286
|
+
* @name CreateSiteTile
|
|
4287
|
+
* @summary Create Site Tile
|
|
4288
|
+
* @request POST:/api/site-tiles
|
|
4289
|
+
* @secure
|
|
4290
|
+
* @response `201` `SiteTile` Created
|
|
4291
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
4292
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
2882
4293
|
*/
|
|
2883
|
-
|
|
4294
|
+
createSiteTile: (data, params = {}) => this.request(Object.assign({ path: `/api/site-tiles`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2884
4295
|
/**
|
|
2885
4296
|
* No description
|
|
2886
4297
|
*
|
|
@@ -2889,7 +4300,7 @@ export class Api extends HttpClient {
|
|
|
2889
4300
|
* @summary Get by Users
|
|
2890
4301
|
* @request GET:/api/surveys
|
|
2891
4302
|
* @secure
|
|
2892
|
-
* @response `200` `(SocialSurveyRecord)[]`
|
|
4303
|
+
* @response `200` `(SocialSurveyRecord)[]` OK
|
|
2893
4304
|
*/
|
|
2894
4305
|
getSurveysByUsers: (query, params = {}) => this.request(Object.assign({ path: `/api/surveys`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
2895
4306
|
/**
|
|
@@ -2900,10 +4311,10 @@ export class Api extends HttpClient {
|
|
|
2900
4311
|
* @summary Get by User
|
|
2901
4312
|
* @request POST:/api/surveys
|
|
2902
4313
|
* @secure
|
|
2903
|
-
* @response `200` `(SocialSurveyRecord)[]`
|
|
2904
|
-
* @response `422` `UnprocessableEntity`
|
|
4314
|
+
* @response `200` `(SocialSurveyRecord)[]` OK
|
|
4315
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
2905
4316
|
*/
|
|
2906
|
-
getSurveysByUser: (data, params = {}) => this.request(Object.assign({ path: `/api/surveys`, method: "POST", body: data, secure: true, type:
|
|
4317
|
+
getSurveysByUser: (data, params = {}) => this.request(Object.assign({ path: `/api/surveys`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2907
4318
|
/**
|
|
2908
4319
|
* No description
|
|
2909
4320
|
*
|
|
@@ -2912,7 +4323,7 @@ export class Api extends HttpClient {
|
|
|
2912
4323
|
* @summary Get All
|
|
2913
4324
|
* @request GET:/api/tasks
|
|
2914
4325
|
* @secure
|
|
2915
|
-
* @response `200` `Task`
|
|
4326
|
+
* @response `200` `Task` OK
|
|
2916
4327
|
* @response `404` `ProblemDetails` Not Found
|
|
2917
4328
|
*/
|
|
2918
4329
|
getTasks: (query, params = {}) => this.request(Object.assign({ path: `/api/tasks`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
@@ -2926,7 +4337,7 @@ export class Api extends HttpClient {
|
|
|
2926
4337
|
* @secure
|
|
2927
4338
|
* @response `201` `Task` Created
|
|
2928
4339
|
*/
|
|
2929
|
-
createTask: (data, params = {}) => this.request(Object.assign({ path: `/api/tasks`, method: "POST", body: data, secure: true, type:
|
|
4340
|
+
createTask: (data, params = {}) => this.request(Object.assign({ path: `/api/tasks`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2930
4341
|
/**
|
|
2931
4342
|
* No description
|
|
2932
4343
|
*
|
|
@@ -2935,7 +4346,7 @@ export class Api extends HttpClient {
|
|
|
2935
4346
|
* @summary Get By ID
|
|
2936
4347
|
* @request GET:/api/tasks/{id}
|
|
2937
4348
|
* @secure
|
|
2938
|
-
* @response `200` `Task`
|
|
4349
|
+
* @response `200` `Task` OK
|
|
2939
4350
|
* @response `404` `ProblemDetails` Not Found
|
|
2940
4351
|
*/
|
|
2941
4352
|
getTask: (id, params = {}) => this.request(Object.assign({ path: `/api/tasks/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
@@ -2947,10 +4358,10 @@ export class Api extends HttpClient {
|
|
|
2947
4358
|
* @summary Replace
|
|
2948
4359
|
* @request PUT:/api/tasks/{id}
|
|
2949
4360
|
* @secure
|
|
2950
|
-
* @response `200` `
|
|
4361
|
+
* @response `200` `Task` OK
|
|
2951
4362
|
* @response `404` `ProblemDetails` Not Found
|
|
2952
4363
|
*/
|
|
2953
|
-
replaceTask: (id, data, params = {}) => this.request(Object.assign({ path: `/api/tasks/${id}`, method: "PUT", body: data, secure: true, type:
|
|
4364
|
+
replaceTask: (id, data, params = {}) => this.request(Object.assign({ path: `/api/tasks/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2954
4365
|
/**
|
|
2955
4366
|
* No description
|
|
2956
4367
|
*
|
|
@@ -2971,9 +4382,9 @@ export class Api extends HttpClient {
|
|
|
2971
4382
|
* @summary Search
|
|
2972
4383
|
* @request POST:/api/tasks/search
|
|
2973
4384
|
* @secure
|
|
2974
|
-
* @response `200` `TaskPaginated`
|
|
4385
|
+
* @response `200` `TaskPaginated` OK
|
|
2975
4386
|
*/
|
|
2976
|
-
searchTasks: (data, query, params = {}) => this.request(Object.assign({ path: `/api/tasks/search`, method: "POST", query: query, body: data, secure: true, type:
|
|
4387
|
+
searchTasks: (data, query, params = {}) => this.request(Object.assign({ path: `/api/tasks/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2977
4388
|
/**
|
|
2978
4389
|
* No description
|
|
2979
4390
|
*
|
|
@@ -2981,19 +4392,98 @@ export class Api extends HttpClient {
|
|
|
2981
4392
|
* @name IntegrationsLosLoansCreate
|
|
2982
4393
|
* @request POST:/api/integrations/los/loans
|
|
2983
4394
|
* @secure
|
|
2984
|
-
* @response `200` `void`
|
|
4395
|
+
* @response `200` `void` OK
|
|
2985
4396
|
*/
|
|
2986
|
-
integrationsLosLoansCreate: (data, params = {}) => this.request(Object.assign({ path: `/api/integrations/los/loans`, method: "POST", body: data, secure: true, type:
|
|
4397
|
+
integrationsLosLoansCreate: (data, params = {}) => this.request(Object.assign({ path: `/api/integrations/los/loans`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
|
|
2987
4398
|
/**
|
|
2988
4399
|
* No description
|
|
2989
4400
|
*
|
|
2990
4401
|
* @tags TheBigPOS
|
|
2991
4402
|
* @name SearchEncompassLogs
|
|
4403
|
+
* @summary Search Encompass Logs
|
|
2992
4404
|
* @request POST:/api/los/encompass/logs/{losId}/search
|
|
2993
4405
|
* @secure
|
|
2994
|
-
* @response `200` `EncompassRequestLogPaginated`
|
|
4406
|
+
* @response `200` `EncompassRequestLogPaginated` OK
|
|
4407
|
+
*/
|
|
4408
|
+
searchEncompassLogs: (losId, query, data, params = {}) => this.request(Object.assign({ path: `/api/los/encompass/logs/${losId}/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
4409
|
+
/**
|
|
4410
|
+
* No description
|
|
4411
|
+
*
|
|
4412
|
+
* @tags TheBigPOS
|
|
4413
|
+
* @name GetEncompassCredentials
|
|
4414
|
+
* @summary Get Encompass Credentials for the current account
|
|
4415
|
+
* @request GET:/api/los/encompass/credentials
|
|
4416
|
+
* @secure
|
|
4417
|
+
* @response `200` `EncompassCredentialsDetail` OK
|
|
4418
|
+
* @response `204` `void` No Content
|
|
4419
|
+
*/
|
|
4420
|
+
getEncompassCredentials: (params = {}) => this.request(Object.assign({ path: `/api/los/encompass/credentials`, method: "GET", secure: true, format: "json" }, params)),
|
|
4421
|
+
/**
|
|
4422
|
+
* No description
|
|
4423
|
+
*
|
|
4424
|
+
* @tags TheBigPOS
|
|
4425
|
+
* @name CreateEncompassCredentials
|
|
4426
|
+
* @summary Create Encompass Credentials for the current account
|
|
4427
|
+
* @request POST:/api/los/encompass/credentials
|
|
4428
|
+
* @secure
|
|
4429
|
+
* @response `201` `LosCredentials` Created
|
|
4430
|
+
*/
|
|
4431
|
+
createEncompassCredentials: (data, params = {}) => this.request(Object.assign({ path: `/api/los/encompass/credentials`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
4432
|
+
/**
|
|
4433
|
+
* No description
|
|
4434
|
+
*
|
|
4435
|
+
* @tags TheBigPOS
|
|
4436
|
+
* @name UpdateEncompassCredentials
|
|
4437
|
+
* @summary Update Encompass Credentials for the current account
|
|
4438
|
+
* @request PUT:/api/los/encompass/credentials
|
|
4439
|
+
* @secure
|
|
4440
|
+
* @response `200` `EncompassCredentialsDetail` OK
|
|
4441
|
+
*/
|
|
4442
|
+
updateEncompassCredentials: (data, params = {}) => this.request(Object.assign({ path: `/api/los/encompass/credentials`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
4443
|
+
/**
|
|
4444
|
+
* No description
|
|
4445
|
+
*
|
|
4446
|
+
* @tags TheBigPOS
|
|
4447
|
+
* @name GetEncompassWebhooks
|
|
4448
|
+
* @summary Get Encompass webhooks filtered by current domain
|
|
4449
|
+
* @request GET:/api/los/encompass/webhooks
|
|
4450
|
+
* @secure
|
|
4451
|
+
* @response `200` `(LosWebhook)[]` OK
|
|
4452
|
+
*/
|
|
4453
|
+
getEncompassWebhooks: (params = {}) => this.request(Object.assign({ path: `/api/los/encompass/webhooks`, method: "GET", secure: true, format: "json" }, params)),
|
|
4454
|
+
/**
|
|
4455
|
+
* No description
|
|
4456
|
+
*
|
|
4457
|
+
* @tags TheBigPOS
|
|
4458
|
+
* @name CreateEncompassWebhook
|
|
4459
|
+
* @summary Register a webhook in Encompass
|
|
4460
|
+
* @request POST:/api/los/encompass/webhooks
|
|
4461
|
+
* @secure
|
|
4462
|
+
* @response `201` `LosWebhook` Created
|
|
4463
|
+
*/
|
|
4464
|
+
createEncompassWebhook: (data, params = {}) => this.request(Object.assign({ path: `/api/los/encompass/webhooks`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
4465
|
+
/**
|
|
4466
|
+
* No description
|
|
4467
|
+
*
|
|
4468
|
+
* @tags TheBigPOS
|
|
4469
|
+
* @name DeleteEncompassWebhook
|
|
4470
|
+
* @summary Delete a webhook from Encompass
|
|
4471
|
+
* @request DELETE:/api/los/encompass/webhooks/{webhookId}
|
|
4472
|
+
* @secure
|
|
4473
|
+
* @response `204` `void` No Content
|
|
4474
|
+
*/
|
|
4475
|
+
deleteEncompassWebhook: (webhookId, params = {}) => this.request(Object.assign({ path: `/api/los/encompass/webhooks/${webhookId}`, method: "DELETE", secure: true }, params)),
|
|
4476
|
+
/**
|
|
4477
|
+
* No description
|
|
4478
|
+
*
|
|
4479
|
+
* @tags TheBigPOS
|
|
4480
|
+
* @name SearchLosSyncs
|
|
4481
|
+
* @summary Search LOS Sync History
|
|
4482
|
+
* @request POST:/api/los/encompass/syncs/{loanId}/search
|
|
4483
|
+
* @secure
|
|
4484
|
+
* @response `200` `LosSyncPaginated` OK
|
|
2995
4485
|
*/
|
|
2996
|
-
|
|
4486
|
+
searchLosSyncs: (loanId, query, data, params = {}) => this.request(Object.assign({ path: `/api/los/encompass/syncs/${loanId}/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2997
4487
|
/**
|
|
2998
4488
|
* No description
|
|
2999
4489
|
*
|
|
@@ -3002,7 +4492,7 @@ export class Api extends HttpClient {
|
|
|
3002
4492
|
* @summary Get usage report by ID
|
|
3003
4493
|
* @request GET:/api/usage-reports/{id}
|
|
3004
4494
|
* @secure
|
|
3005
|
-
* @response `200` `UsageReport`
|
|
4495
|
+
* @response `200` `UsageReport` OK
|
|
3006
4496
|
* @response `404` `ProblemDetails` Not Found
|
|
3007
4497
|
*/
|
|
3008
4498
|
getUsageReportById: (id, params = {}) => this.request(Object.assign({ path: `/api/usage-reports/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
@@ -3014,7 +4504,7 @@ export class Api extends HttpClient {
|
|
|
3014
4504
|
* @summary Get usage reports by month and year
|
|
3015
4505
|
* @request GET:/api/usage-reports
|
|
3016
4506
|
* @secure
|
|
3017
|
-
* @response `200` `(UsageReport)[]`
|
|
4507
|
+
* @response `200` `(UsageReport)[]` OK
|
|
3018
4508
|
* @response `400` `ProblemDetails` Bad Request
|
|
3019
4509
|
*/
|
|
3020
4510
|
getUsageReportsByPeriod: (query, params = {}) => this.request(Object.assign({ path: `/api/usage-reports`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
@@ -3038,7 +4528,7 @@ export class Api extends HttpClient {
|
|
|
3038
4528
|
* @summary Get usage report execution dashboard with active execution, recent history, and statistics
|
|
3039
4529
|
* @request GET:/api/usage-reports/dashboard
|
|
3040
4530
|
* @secure
|
|
3041
|
-
* @response `200` `UsageReportDashboard`
|
|
4531
|
+
* @response `200` `UsageReportDashboard` OK
|
|
3042
4532
|
*/
|
|
3043
4533
|
getUsageReportDashboard: (params = {}) => this.request(Object.assign({ path: `/api/usage-reports/dashboard`, method: "GET", secure: true, format: "json" }, params)),
|
|
3044
4534
|
/**
|
|
@@ -3049,7 +4539,7 @@ export class Api extends HttpClient {
|
|
|
3049
4539
|
* @summary Get usage report execution status by correlation ID
|
|
3050
4540
|
* @request GET:/api/usage-reports/executions/{correlationId}
|
|
3051
4541
|
* @secure
|
|
3052
|
-
* @response `200` `UsageReportExecution`
|
|
4542
|
+
* @response `200` `UsageReportExecution` OK
|
|
3053
4543
|
* @response `404` `ProblemDetails` Not Found
|
|
3054
4544
|
*/
|
|
3055
4545
|
getUsageReportExecution: (correlationId, params = {}) => this.request(Object.assign({ path: `/api/usage-reports/executions/${correlationId}`, method: "GET", secure: true, format: "json" }, params)),
|
|
@@ -3061,7 +4551,7 @@ export class Api extends HttpClient {
|
|
|
3061
4551
|
* @summary Get usage report executions by month and year
|
|
3062
4552
|
* @request GET:/api/usage-reports/executions
|
|
3063
4553
|
* @secure
|
|
3064
|
-
* @response `200` `(UsageReportExecution)[]`
|
|
4554
|
+
* @response `200` `(UsageReportExecution)[]` OK
|
|
3065
4555
|
* @response `400` `ProblemDetails` Bad Request
|
|
3066
4556
|
*/
|
|
3067
4557
|
getUsageReportExecutionsByPeriod: (query, params = {}) => this.request(Object.assign({ path: `/api/usage-reports/executions`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
@@ -3076,7 +4566,7 @@ export class Api extends HttpClient {
|
|
|
3076
4566
|
* @response `201` `UserDevice` Created
|
|
3077
4567
|
* @response `400` `ProblemDetails` Bad Request
|
|
3078
4568
|
*/
|
|
3079
|
-
createUserDevice: (data, params = {}) => this.request(Object.assign({ path: `/api/userdevices`, method: "POST", body: data, secure: true, type:
|
|
4569
|
+
createUserDevice: (data, params = {}) => this.request(Object.assign({ path: `/api/userdevices`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
3080
4570
|
/**
|
|
3081
4571
|
* No description
|
|
3082
4572
|
*
|
|
@@ -3097,7 +4587,7 @@ export class Api extends HttpClient {
|
|
|
3097
4587
|
* @summary Get draft users
|
|
3098
4588
|
* @request GET:/api/loans/drafts/{draftId}/users
|
|
3099
4589
|
* @secure
|
|
3100
|
-
* @response `200` `UserDraftPaginated`
|
|
4590
|
+
* @response `200` `UserDraftPaginated` OK
|
|
3101
4591
|
*/
|
|
3102
4592
|
getDraftUsers: (draftId, query, params = {}) => this.request(Object.assign({ path: `/api/loans/drafts/${draftId}/users`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
3103
4593
|
/**
|
|
@@ -3108,7 +4598,7 @@ export class Api extends HttpClient {
|
|
|
3108
4598
|
* @summary Get draft user
|
|
3109
4599
|
* @request GET:/api/loans/drafts/{draftId}/users/{userId}
|
|
3110
4600
|
* @secure
|
|
3111
|
-
* @response `200` `UserDraft`
|
|
4601
|
+
* @response `200` `UserDraft` OK
|
|
3112
4602
|
*/
|
|
3113
4603
|
getDraftUser: (draftId, userId, params = {}) => this.request(Object.assign({ path: `/api/loans/drafts/${draftId}/users/${userId}`, method: "GET", secure: true, format: "json" }, params)),
|
|
3114
4604
|
/**
|
|
@@ -3119,9 +4609,11 @@ export class Api extends HttpClient {
|
|
|
3119
4609
|
* @summary Add draft user
|
|
3120
4610
|
* @request POST:/api/loans/drafts/{draftId}/users/{userId}
|
|
3121
4611
|
* @secure
|
|
3122
|
-
* @response `200` `UserDraft`
|
|
4612
|
+
* @response `200` `UserDraft` OK
|
|
4613
|
+
* @response `404` `ProblemDetails` Not Found
|
|
4614
|
+
* @response `409` `ProblemDetails` Conflict
|
|
3123
4615
|
*/
|
|
3124
|
-
addDraftUsers: (draftId, userId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/drafts/${draftId}/users/${userId}`, method: "POST", body: data, secure: true, type:
|
|
4616
|
+
addDraftUsers: (draftId, userId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/drafts/${draftId}/users/${userId}`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
3125
4617
|
/**
|
|
3126
4618
|
* No description
|
|
3127
4619
|
*
|
|
@@ -3141,7 +4633,7 @@ export class Api extends HttpClient {
|
|
|
3141
4633
|
* @summary Get All
|
|
3142
4634
|
* @request GET:/api/user-groups/{groupId}/scopes
|
|
3143
4635
|
* @secure
|
|
3144
|
-
* @response `200` `(UserGroupAccessScope)[]`
|
|
4636
|
+
* @response `200` `(UserGroupAccessScope)[]` OK
|
|
3145
4637
|
*/
|
|
3146
4638
|
getUserGroupAccessScopes: (groupId, params = {}) => this.request(Object.assign({ path: `/api/user-groups/${groupId}/scopes`, method: "GET", secure: true, format: "json" }, params)),
|
|
3147
4639
|
/**
|
|
@@ -3152,9 +4644,9 @@ export class Api extends HttpClient {
|
|
|
3152
4644
|
* @summary Create a new scope
|
|
3153
4645
|
* @request POST:/api/user-groups/{groupId}/scopes
|
|
3154
4646
|
* @secure
|
|
3155
|
-
* @response `200` `UserGroupAccessScope`
|
|
4647
|
+
* @response `200` `UserGroupAccessScope` OK
|
|
3156
4648
|
*/
|
|
3157
|
-
createUserGroupAccessScope: (groupId, data, params = {}) => this.request(Object.assign({ path: `/api/user-groups/${groupId}/scopes`, method: "POST", body: data, secure: true, type:
|
|
4649
|
+
createUserGroupAccessScope: (groupId, data, params = {}) => this.request(Object.assign({ path: `/api/user-groups/${groupId}/scopes`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
3158
4650
|
/**
|
|
3159
4651
|
* No description
|
|
3160
4652
|
*
|
|
@@ -3174,7 +4666,7 @@ export class Api extends HttpClient {
|
|
|
3174
4666
|
* @summary Get All
|
|
3175
4667
|
* @request GET:/api/user-groups/{groupId}/members
|
|
3176
4668
|
* @secure
|
|
3177
|
-
* @response `200` `(UserGroupMember)[]`
|
|
4669
|
+
* @response `200` `(UserGroupMember)[]` OK
|
|
3178
4670
|
*/
|
|
3179
4671
|
getUserGroupMembers: (groupId, params = {}) => this.request(Object.assign({ path: `/api/user-groups/${groupId}/members`, method: "GET", secure: true, format: "json" }, params)),
|
|
3180
4672
|
/**
|
|
@@ -3185,9 +4677,9 @@ export class Api extends HttpClient {
|
|
|
3185
4677
|
* @summary Create User Group Member
|
|
3186
4678
|
* @request POST:/api/user-groups/{groupId}/members
|
|
3187
4679
|
* @secure
|
|
3188
|
-
* @response `200` `UserGroupMember`
|
|
4680
|
+
* @response `200` `UserGroupMember` OK
|
|
3189
4681
|
*/
|
|
3190
|
-
createUserGroupMember: (groupId, data, query, params = {}) => this.request(Object.assign({ path: `/api/user-groups/${groupId}/members`, method: "POST", query: query, body: data, secure: true, type:
|
|
4682
|
+
createUserGroupMember: (groupId, data, query, params = {}) => this.request(Object.assign({ path: `/api/user-groups/${groupId}/members`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
3191
4683
|
/**
|
|
3192
4684
|
* No description
|
|
3193
4685
|
*
|
|
@@ -3207,7 +4699,7 @@ export class Api extends HttpClient {
|
|
|
3207
4699
|
* @summary Get All
|
|
3208
4700
|
* @request POST:/api/user-groups/search
|
|
3209
4701
|
* @secure
|
|
3210
|
-
* @response `200` `UserGroupPaginated`
|
|
4702
|
+
* @response `200` `UserGroupPaginated` OK
|
|
3211
4703
|
*/
|
|
3212
4704
|
searchUserGroups: (query, params = {}) => this.request(Object.assign({ path: `/api/user-groups/search`, method: "POST", query: query, secure: true, format: "json" }, params)),
|
|
3213
4705
|
/**
|
|
@@ -3218,7 +4710,7 @@ export class Api extends HttpClient {
|
|
|
3218
4710
|
* @summary Get User Group by ID
|
|
3219
4711
|
* @request GET:/api/user-groups/{groupId}
|
|
3220
4712
|
* @secure
|
|
3221
|
-
* @response `200` `UserGroup`
|
|
4713
|
+
* @response `200` `UserGroup` OK
|
|
3222
4714
|
*/
|
|
3223
4715
|
getUserGroup: (groupId, params = {}) => this.request(Object.assign({ path: `/api/user-groups/${groupId}`, method: "GET", secure: true, format: "json" }, params)),
|
|
3224
4716
|
/**
|
|
@@ -3229,9 +4721,9 @@ export class Api extends HttpClient {
|
|
|
3229
4721
|
* @summary Update User Group
|
|
3230
4722
|
* @request PUT:/api/user-groups/{groupId}
|
|
3231
4723
|
* @secure
|
|
3232
|
-
* @response `200` `UserGroup`
|
|
4724
|
+
* @response `200` `UserGroup` OK
|
|
3233
4725
|
*/
|
|
3234
|
-
updateUserGroup: (groupId, data, params = {}) => this.request(Object.assign({ path: `/api/user-groups/${groupId}`, method: "PUT", body: data, secure: true, type:
|
|
4726
|
+
updateUserGroup: (groupId, data, params = {}) => this.request(Object.assign({ path: `/api/user-groups/${groupId}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
3235
4727
|
/**
|
|
3236
4728
|
* No description
|
|
3237
4729
|
*
|
|
@@ -3253,7 +4745,7 @@ export class Api extends HttpClient {
|
|
|
3253
4745
|
* @secure
|
|
3254
4746
|
* @response `201` `UserGroup` Created
|
|
3255
4747
|
*/
|
|
3256
|
-
createUserGroup: (data, params = {}) => this.request(Object.assign({ path: `/api/user-groups`, method: "POST", body: data, secure: true, type:
|
|
4748
|
+
createUserGroup: (data, params = {}) => this.request(Object.assign({ path: `/api/user-groups`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
3257
4749
|
/**
|
|
3258
4750
|
* No description
|
|
3259
4751
|
*
|
|
@@ -3264,9 +4756,9 @@ export class Api extends HttpClient {
|
|
|
3264
4756
|
* @secure
|
|
3265
4757
|
* @response `204` `void` No Content
|
|
3266
4758
|
* @response `404` `Error` Not Found
|
|
3267
|
-
* @response `422` `UnprocessableEntity`
|
|
4759
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
3268
4760
|
*/
|
|
3269
|
-
requestImpersonation: (data, params = {}) => this.request(Object.assign({ path: `/api/users/impersonation/request`, method: "POST", body: data, secure: true, type:
|
|
4761
|
+
requestImpersonation: (data, params = {}) => this.request(Object.assign({ path: `/api/users/impersonation/request`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
|
|
3270
4762
|
/**
|
|
3271
4763
|
* No description
|
|
3272
4764
|
*
|
|
@@ -3277,9 +4769,9 @@ export class Api extends HttpClient {
|
|
|
3277
4769
|
* @secure
|
|
3278
4770
|
* @response `204` `void` No Content
|
|
3279
4771
|
* @response `404` `Error` Not Found
|
|
3280
|
-
* @response `422` `UnprocessableEntity`
|
|
4772
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
3281
4773
|
*/
|
|
3282
|
-
allowImpersonation: (data, params = {}) => this.request(Object.assign({ path: `/api/users/impersonation/allow`, method: "POST", body: data, secure: true, type:
|
|
4774
|
+
allowImpersonation: (data, params = {}) => this.request(Object.assign({ path: `/api/users/impersonation/allow`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
|
|
3283
4775
|
/**
|
|
3284
4776
|
* No description
|
|
3285
4777
|
*
|
|
@@ -3290,7 +4782,7 @@ export class Api extends HttpClient {
|
|
|
3290
4782
|
* @secure
|
|
3291
4783
|
* @response `204` `void` No Content
|
|
3292
4784
|
* @response `404` `Error` Not Found
|
|
3293
|
-
* @response `422` `UnprocessableEntity`
|
|
4785
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
3294
4786
|
*/
|
|
3295
4787
|
allowImpersonationWithGuid: (allowToken, params = {}) => this.request(Object.assign({ path: `/api/users/impersonation/allow/${allowToken}`, method: "POST", secure: true }, params)),
|
|
3296
4788
|
/**
|
|
@@ -3302,7 +4794,7 @@ export class Api extends HttpClient {
|
|
|
3302
4794
|
* @request POST:/api/users/impersonation
|
|
3303
4795
|
* @secure
|
|
3304
4796
|
* @response `204` `void` No Content
|
|
3305
|
-
* @response `422` `UnprocessableEntity`
|
|
4797
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
3306
4798
|
*/
|
|
3307
4799
|
beginImpersonation: (params = {}) => this.request(Object.assign({ path: `/api/users/impersonation`, method: "POST", secure: true }, params)),
|
|
3308
4800
|
/**
|
|
@@ -3314,7 +4806,7 @@ export class Api extends HttpClient {
|
|
|
3314
4806
|
* @request DELETE:/api/users/impersonation
|
|
3315
4807
|
* @secure
|
|
3316
4808
|
* @response `204` `void` No Content
|
|
3317
|
-
* @response `422` `UnprocessableEntity`
|
|
4809
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
3318
4810
|
*/
|
|
3319
4811
|
stopImpersonation: (params = {}) => this.request(Object.assign({ path: `/api/users/impersonation`, method: "DELETE", secure: true }, params)),
|
|
3320
4812
|
/**
|
|
@@ -3327,9 +4819,9 @@ export class Api extends HttpClient {
|
|
|
3327
4819
|
* @secure
|
|
3328
4820
|
* @response `204` `void` No Content
|
|
3329
4821
|
* @response `404` `Error` Not Found
|
|
3330
|
-
* @response `422` `UnprocessableEntity`
|
|
4822
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
3331
4823
|
*/
|
|
3332
|
-
forceImpersonation: (data, params = {}) => this.request(Object.assign({ path: `/api/users/impersonation/force`, method: "POST", body: data, secure: true, type:
|
|
4824
|
+
forceImpersonation: (data, params = {}) => this.request(Object.assign({ path: `/api/users/impersonation/force`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
|
|
3333
4825
|
/**
|
|
3334
4826
|
* No description
|
|
3335
4827
|
*
|
|
@@ -3339,7 +4831,7 @@ export class Api extends HttpClient {
|
|
|
3339
4831
|
* @request POST:/api/users/impersonation/extend
|
|
3340
4832
|
* @secure
|
|
3341
4833
|
* @response `204` `void` No Content
|
|
3342
|
-
* @response `422` `UnprocessableEntity`
|
|
4834
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
3343
4835
|
*/
|
|
3344
4836
|
extendImpersonation: (params = {}) => this.request(Object.assign({ path: `/api/users/impersonation/extend`, method: "POST", secure: true }, params)),
|
|
3345
4837
|
/**
|
|
@@ -3351,9 +4843,9 @@ export class Api extends HttpClient {
|
|
|
3351
4843
|
* @request POST:/api/users/invites
|
|
3352
4844
|
* @secure
|
|
3353
4845
|
* @response `204` `void` No Content
|
|
3354
|
-
* @response `422` `UnprocessableEntity`
|
|
4846
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
3355
4847
|
*/
|
|
3356
|
-
inviteUser: (data, params = {}) => this.request(Object.assign({ path: `/api/users/invites`, method: "POST", body: data, secure: true, type:
|
|
4848
|
+
inviteUser: (data, params = {}) => this.request(Object.assign({ path: `/api/users/invites`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
|
|
3357
4849
|
/**
|
|
3358
4850
|
* No description
|
|
3359
4851
|
*
|
|
@@ -3375,8 +4867,8 @@ export class Api extends HttpClient {
|
|
|
3375
4867
|
* @summary Verify
|
|
3376
4868
|
* @request GET:/api/users/invites/{token}/verify
|
|
3377
4869
|
* @secure
|
|
3378
|
-
* @response `200` `Invite`
|
|
3379
|
-
* @response `422` `UnprocessableEntity`
|
|
4870
|
+
* @response `200` `Invite` OK
|
|
4871
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
3380
4872
|
*/
|
|
3381
4873
|
verifyUserInvite: (token, params = {}) => this.request(Object.assign({ path: `/api/users/invites/${token}/verify`, method: "GET", secure: true, format: "json" }, params)),
|
|
3382
4874
|
/**
|
|
@@ -3387,7 +4879,7 @@ export class Api extends HttpClient {
|
|
|
3387
4879
|
* @summary Get All
|
|
3388
4880
|
* @request GET:/api/users/{userID}/relations
|
|
3389
4881
|
* @secure
|
|
3390
|
-
* @response `200` `(UserRelation)[]`
|
|
4882
|
+
* @response `200` `(UserRelation)[]` OK
|
|
3391
4883
|
*/
|
|
3392
4884
|
getUserRelations: (userId, params = {}) => this.request(Object.assign({ path: `/api/users/${userId}/relations`, method: "GET", secure: true, format: "json" }, params)),
|
|
3393
4885
|
/**
|
|
@@ -3400,7 +4892,7 @@ export class Api extends HttpClient {
|
|
|
3400
4892
|
* @secure
|
|
3401
4893
|
* @response `204` `void` No Content
|
|
3402
4894
|
*/
|
|
3403
|
-
createUserRelation: (userId, data, params = {}) => this.request(Object.assign({ path: `/api/users/${userId}/relations`, method: "POST", body: data, secure: true, type:
|
|
4895
|
+
createUserRelation: (userId, data, params = {}) => this.request(Object.assign({ path: `/api/users/${userId}/relations`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
|
|
3404
4896
|
/**
|
|
3405
4897
|
* No description
|
|
3406
4898
|
*
|
|
@@ -3409,7 +4901,7 @@ export class Api extends HttpClient {
|
|
|
3409
4901
|
* @summary Get by ID
|
|
3410
4902
|
* @request GET:/api/users/{userID}/relations/{id}
|
|
3411
4903
|
* @secure
|
|
3412
|
-
* @response `200` `UserRelation`
|
|
4904
|
+
* @response `200` `UserRelation` OK
|
|
3413
4905
|
*/
|
|
3414
4906
|
getUserRelation: (userId, id, params = {}) => this.request(Object.assign({ path: `/api/users/${userId}/relations/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
3415
4907
|
/**
|
|
@@ -3431,7 +4923,7 @@ export class Api extends HttpClient {
|
|
|
3431
4923
|
* @summary Get All
|
|
3432
4924
|
* @request GET:/api/users
|
|
3433
4925
|
* @secure
|
|
3434
|
-
* @response `200` `(User)[]`
|
|
4926
|
+
* @response `200` `(User)[]` OK
|
|
3435
4927
|
*/
|
|
3436
4928
|
getUsers: (query, params = {}) => this.request(Object.assign({ path: `/api/users`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
3437
4929
|
/**
|
|
@@ -3442,10 +4934,10 @@ export class Api extends HttpClient {
|
|
|
3442
4934
|
* @summary Create
|
|
3443
4935
|
* @request POST:/api/users
|
|
3444
4936
|
* @secure
|
|
3445
|
-
* @response `200` `DetailedUser`
|
|
3446
|
-
* @response `422` `UnprocessableEntity`
|
|
4937
|
+
* @response `200` `DetailedUser` OK
|
|
4938
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
3447
4939
|
*/
|
|
3448
|
-
createUser: (data, params = {}) => this.request(Object.assign({ path: `/api/users`, method: "POST", body: data, secure: true, type:
|
|
4940
|
+
createUser: (data, params = {}) => this.request(Object.assign({ path: `/api/users`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
3449
4941
|
/**
|
|
3450
4942
|
* No description
|
|
3451
4943
|
*
|
|
@@ -3454,9 +4946,9 @@ export class Api extends HttpClient {
|
|
|
3454
4946
|
* @summary Search
|
|
3455
4947
|
* @request POST:/api/users/search
|
|
3456
4948
|
* @secure
|
|
3457
|
-
* @response `200` `UserPaginated`
|
|
4949
|
+
* @response `200` `UserPaginated` OK
|
|
3458
4950
|
*/
|
|
3459
|
-
searchUsers: (data, query, params = {}) => this.request(Object.assign({ path: `/api/users/search`, method: "POST", query: query, body: data, secure: true, type:
|
|
4951
|
+
searchUsers: (data, query, params = {}) => this.request(Object.assign({ path: `/api/users/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
3460
4952
|
/**
|
|
3461
4953
|
* No description
|
|
3462
4954
|
*
|
|
@@ -3465,9 +4957,9 @@ export class Api extends HttpClient {
|
|
|
3465
4957
|
* @summary Get by Email
|
|
3466
4958
|
* @request POST:/api/users/byemail
|
|
3467
4959
|
* @secure
|
|
3468
|
-
* @response `200` `AdminAccessUser`
|
|
4960
|
+
* @response `200` `AdminAccessUser` OK
|
|
3469
4961
|
*/
|
|
3470
|
-
getUserByEmail: (data, params = {}) => this.request(Object.assign({ path: `/api/users/byemail`, method: "POST", body: data, secure: true, type:
|
|
4962
|
+
getUserByEmail: (data, params = {}) => this.request(Object.assign({ path: `/api/users/byemail`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
3471
4963
|
/**
|
|
3472
4964
|
* No description
|
|
3473
4965
|
*
|
|
@@ -3476,10 +4968,10 @@ export class Api extends HttpClient {
|
|
|
3476
4968
|
* @summary Sign Up
|
|
3477
4969
|
* @request POST:/api/users/register
|
|
3478
4970
|
* @secure
|
|
3479
|
-
* @response `200` `User`
|
|
3480
|
-
* @response `422` `UnprocessableEntity`
|
|
4971
|
+
* @response `200` `User` OK
|
|
4972
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
3481
4973
|
*/
|
|
3482
|
-
signUp: (data, params = {}) => this.request(Object.assign({ path: `/api/users/register`, method: "POST", body: data, secure: true, type:
|
|
4974
|
+
signUp: (data, params = {}) => this.request(Object.assign({ path: `/api/users/register`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
3483
4975
|
/**
|
|
3484
4976
|
* No description
|
|
3485
4977
|
*
|
|
@@ -3488,10 +4980,10 @@ export class Api extends HttpClient {
|
|
|
3488
4980
|
* @summary Update
|
|
3489
4981
|
* @request PUT:/api/users/{id}
|
|
3490
4982
|
* @secure
|
|
3491
|
-
* @response `200` `DetailedUser`
|
|
3492
|
-
* @response `422` `UnprocessableEntity`
|
|
4983
|
+
* @response `200` `DetailedUser` OK
|
|
4984
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
3493
4985
|
*/
|
|
3494
|
-
replaceUser: (id, data, params = {}) => this.request(Object.assign({ path: `/api/users/${id}`, method: "PUT", body: data, secure: true, type:
|
|
4986
|
+
replaceUser: (id, data, params = {}) => this.request(Object.assign({ path: `/api/users/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
3495
4987
|
/**
|
|
3496
4988
|
* No description
|
|
3497
4989
|
*
|
|
@@ -3523,21 +5015,22 @@ export class Api extends HttpClient {
|
|
|
3523
5015
|
* @request POST:/api/users/change-password
|
|
3524
5016
|
* @secure
|
|
3525
5017
|
* @response `204` `void` No Content
|
|
3526
|
-
* @response `422` `UnprocessableEntity`
|
|
5018
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
3527
5019
|
*/
|
|
3528
|
-
changePassword: (data, params = {}) => this.request(Object.assign({ path: `/api/users/change-password`, method: "POST", body: data, secure: true, type:
|
|
5020
|
+
changePassword: (data, params = {}) => this.request(Object.assign({ path: `/api/users/change-password`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
|
|
3529
5021
|
/**
|
|
3530
5022
|
* No description
|
|
3531
5023
|
*
|
|
3532
5024
|
* @tags Users
|
|
3533
5025
|
* @name VerifyPassword
|
|
3534
|
-
* @summary Verify Password
|
|
5026
|
+
* @summary Verify Password (deprecated; use api/auth/reset-password)
|
|
3535
5027
|
* @request POST:/api/users/verify-password
|
|
5028
|
+
* @deprecated
|
|
3536
5029
|
* @secure
|
|
3537
5030
|
* @response `204` `void` No Content
|
|
3538
|
-
* @response `422` `UnprocessableEntity`
|
|
5031
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
3539
5032
|
*/
|
|
3540
|
-
verifyPassword: (data, params = {}) => this.request(Object.assign({ path: `/api/users/verify-password`, method: "POST", body: data, secure: true, type:
|
|
5033
|
+
verifyPassword: (data, params = {}) => this.request(Object.assign({ path: `/api/users/verify-password`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
|
|
3541
5034
|
/**
|
|
3542
5035
|
* No description
|
|
3543
5036
|
*
|
|
@@ -3547,21 +5040,22 @@ export class Api extends HttpClient {
|
|
|
3547
5040
|
* @request POST:/api/users/{id}/override-password
|
|
3548
5041
|
* @secure
|
|
3549
5042
|
* @response `204` `void` No Content
|
|
3550
|
-
* @response `422` `UnprocessableEntity`
|
|
5043
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
3551
5044
|
*/
|
|
3552
|
-
overridePassword: (id, data, params = {}) => this.request(Object.assign({ path: `/api/users/${id}/override-password`, method: "POST", body: data, secure: true, type:
|
|
5045
|
+
overridePassword: (id, data, params = {}) => this.request(Object.assign({ path: `/api/users/${id}/override-password`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
|
|
3553
5046
|
/**
|
|
3554
5047
|
* No description
|
|
3555
5048
|
*
|
|
3556
5049
|
* @tags Users
|
|
3557
5050
|
* @name ForgotPassword
|
|
3558
|
-
* @summary Forgot Password
|
|
5051
|
+
* @summary Forgot Password (deprecated; use api/auth/forgot-password)
|
|
3559
5052
|
* @request POST:/api/users/forgot-password
|
|
5053
|
+
* @deprecated
|
|
3560
5054
|
* @secure
|
|
3561
5055
|
* @response `204` `void` No Content
|
|
3562
|
-
* @response `422` `UnprocessableEntity`
|
|
5056
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
3563
5057
|
*/
|
|
3564
|
-
forgotPassword: (data, params = {}) => this.request(Object.assign({ path: `/api/users/forgot-password`, method: "POST", body: data, secure: true, type:
|
|
5058
|
+
forgotPassword: (data, params = {}) => this.request(Object.assign({ path: `/api/users/forgot-password`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
|
|
3565
5059
|
/**
|
|
3566
5060
|
* No description
|
|
3567
5061
|
*
|
|
@@ -3571,7 +5065,7 @@ export class Api extends HttpClient {
|
|
|
3571
5065
|
* @request POST:/api/users/mobile-phone/send-code
|
|
3572
5066
|
* @secure
|
|
3573
5067
|
* @response `204` `void` No Content
|
|
3574
|
-
* @response `422` `UnprocessableEntity`
|
|
5068
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
3575
5069
|
*/
|
|
3576
5070
|
sendMobilePhoneVerificationCode: (params = {}) => this.request(Object.assign({ path: `/api/users/mobile-phone/send-code`, method: "POST", secure: true }, params)),
|
|
3577
5071
|
/**
|
|
@@ -3583,9 +5077,9 @@ export class Api extends HttpClient {
|
|
|
3583
5077
|
* @request PUT:/api/users/mobile-phone/verify-code
|
|
3584
5078
|
* @secure
|
|
3585
5079
|
* @response `204` `void` No Content
|
|
3586
|
-
* @response `422` `UnprocessableEntity`
|
|
5080
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
3587
5081
|
*/
|
|
3588
|
-
verifyUserMobilePhone: (data, params = {}) => this.request(Object.assign({ path: `/api/users/mobile-phone/verify-code`, method: "PUT", body: data, secure: true, type:
|
|
5082
|
+
verifyUserMobilePhone: (data, params = {}) => this.request(Object.assign({ path: `/api/users/mobile-phone/verify-code`, method: "PUT", body: data, secure: true, type: "application/json" }, params)),
|
|
3589
5083
|
/**
|
|
3590
5084
|
* No description
|
|
3591
5085
|
*
|
|
@@ -3594,7 +5088,7 @@ export class Api extends HttpClient {
|
|
|
3594
5088
|
* @summary Get
|
|
3595
5089
|
* @request GET:/api/users/me
|
|
3596
5090
|
* @secure
|
|
3597
|
-
* @response `200` `ImpersonatedDetailedUser`
|
|
5091
|
+
* @response `200` `ImpersonatedDetailedUser` OK
|
|
3598
5092
|
* @response `401` `ProblemDetails` Unauthorized
|
|
3599
5093
|
*/
|
|
3600
5094
|
getMe: (params = {}) => this.request(Object.assign({ path: `/api/users/me`, method: "GET", secure: true, format: "json" }, params)),
|
|
@@ -3606,9 +5100,9 @@ export class Api extends HttpClient {
|
|
|
3606
5100
|
* @summary Replace
|
|
3607
5101
|
* @request PUT:/api/users/me
|
|
3608
5102
|
* @secure
|
|
3609
|
-
* @response `200` `DetailedUser`
|
|
5103
|
+
* @response `200` `DetailedUser` OK
|
|
3610
5104
|
*/
|
|
3611
|
-
replaceMe: (data, params = {}) => this.request(Object.assign({ path: `/api/users/me`, method: "PUT", body: data, secure: true, type:
|
|
5105
|
+
replaceMe: (data, params = {}) => this.request(Object.assign({ path: `/api/users/me`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
3612
5106
|
/**
|
|
3613
5107
|
* @description Update the phone number If changed will send a verification code to the new number
|
|
3614
5108
|
*
|
|
@@ -3619,7 +5113,7 @@ export class Api extends HttpClient {
|
|
|
3619
5113
|
* @secure
|
|
3620
5114
|
* @response `204` `DetailedUser` No Content
|
|
3621
5115
|
*/
|
|
3622
|
-
updateMyPhone: (data, params = {}) => this.request(Object.assign({ path: `/api/users/me/phone-number`, method: "PUT", body: data, secure: true, type:
|
|
5116
|
+
updateMyPhone: (data, params = {}) => this.request(Object.assign({ path: `/api/users/me/phone-number`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
3623
5117
|
/**
|
|
3624
5118
|
* No description
|
|
3625
5119
|
*
|
|
@@ -3628,7 +5122,7 @@ export class Api extends HttpClient {
|
|
|
3628
5122
|
* @summary Get Relationships
|
|
3629
5123
|
* @request GET:/api/users/me/relationships
|
|
3630
5124
|
* @secure
|
|
3631
|
-
* @response `200` `(UserRelationship)[]`
|
|
5125
|
+
* @response `200` `(UserRelationship)[]` OK
|
|
3632
5126
|
*/
|
|
3633
5127
|
getMyRelationships: (params = {}) => this.request(Object.assign({ path: `/api/users/me/relationships`, method: "GET", secure: true, format: "json" }, params)),
|
|
3634
5128
|
/**
|
|
@@ -3639,7 +5133,7 @@ export class Api extends HttpClient {
|
|
|
3639
5133
|
* @summary Get Relationship Prospects
|
|
3640
5134
|
* @request GET:/api/users/me/relationships/prospects
|
|
3641
5135
|
* @secure
|
|
3642
|
-
* @response `200` `(UserRelationshipProspect)[]`
|
|
5136
|
+
* @response `200` `(UserRelationshipProspect)[]` OK
|
|
3643
5137
|
*/
|
|
3644
5138
|
getMyRelationshipProspects: (params = {}) => this.request(Object.assign({ path: `/api/users/me/relationships/prospects`, method: "GET", secure: true, format: "json" }, params)),
|
|
3645
5139
|
/**
|
|
@@ -3663,7 +5157,7 @@ export class Api extends HttpClient {
|
|
|
3663
5157
|
* @secure
|
|
3664
5158
|
* @response `204` `void` No Content
|
|
3665
5159
|
*/
|
|
3666
|
-
deleteMe: (data, params = {}) => this.request(Object.assign({ path: `/api/users/me/delete`, method: "POST", body: data, secure: true, type:
|
|
5160
|
+
deleteMe: (data, params = {}) => this.request(Object.assign({ path: `/api/users/me/delete`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
|
|
3667
5161
|
/**
|
|
3668
5162
|
* No description
|
|
3669
5163
|
*
|
|
@@ -3672,9 +5166,9 @@ export class Api extends HttpClient {
|
|
|
3672
5166
|
* @summary Get Workflow
|
|
3673
5167
|
* @request POST:/api/workflow
|
|
3674
5168
|
* @secure
|
|
3675
|
-
* @response `200` `GetForm`
|
|
5169
|
+
* @response `200` `GetForm` OK
|
|
3676
5170
|
*/
|
|
3677
|
-
getWorkflow: (data, params = {}) => this.request(Object.assign({ path: `/api/workflow`, method: "POST", body: data, secure: true, type:
|
|
5171
|
+
getWorkflow: (data, params = {}) => this.request(Object.assign({ path: `/api/workflow`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
3678
5172
|
};
|
|
3679
5173
|
this.sso = {
|
|
3680
5174
|
/**
|
|
@@ -3684,7 +5178,7 @@ export class Api extends HttpClient {
|
|
|
3684
5178
|
* @name LogoutList
|
|
3685
5179
|
* @request GET:/sso/logout
|
|
3686
5180
|
* @secure
|
|
3687
|
-
* @response `200` `void`
|
|
5181
|
+
* @response `200` `void` OK
|
|
3688
5182
|
*/
|
|
3689
5183
|
logoutList: (params = {}) => this.request(Object.assign({ path: `/sso/logout`, method: "GET", secure: true }, params)),
|
|
3690
5184
|
};
|