@financeable/aggregation 0.8.3 → 0.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (156) hide show
  1. package/FUNCTIONS.md +153 -36
  2. package/README.md +475 -94
  3. package/docs/sdks/applications/README.md +9 -15
  4. package/docs/sdks/oauthtoken/README.md +5 -9
  5. package/docs/sdks/supportingdocuments/README.md +9 -16
  6. package/funcs/applicationsCreate.d.ts +3 -3
  7. package/funcs/applicationsCreate.d.ts.map +1 -1
  8. package/funcs/applicationsCreate.js +4 -6
  9. package/funcs/applicationsCreate.js.map +1 -1
  10. package/funcs/oauthTokenGet.d.ts +3 -2
  11. package/funcs/oauthTokenGet.d.ts.map +1 -1
  12. package/funcs/oauthTokenGet.js +4 -2
  13. package/funcs/oauthTokenGet.js.map +1 -1
  14. package/funcs/supportingDocumentsCreate.d.ts +3 -3
  15. package/funcs/supportingDocumentsCreate.d.ts.map +1 -1
  16. package/funcs/supportingDocumentsCreate.js +5 -8
  17. package/funcs/supportingDocumentsCreate.js.map +1 -1
  18. package/hooks/types.d.ts +2 -0
  19. package/hooks/types.d.ts.map +1 -1
  20. package/index.d.ts +2 -0
  21. package/index.d.ts.map +1 -1
  22. package/index.js +3 -1
  23. package/index.js.map +1 -1
  24. package/jsr.json +1 -1
  25. package/lib/config.d.ts +7 -3
  26. package/lib/config.d.ts.map +1 -1
  27. package/lib/config.js +3 -3
  28. package/lib/config.js.map +1 -1
  29. package/lib/files.d.ts +5 -0
  30. package/lib/files.d.ts.map +1 -1
  31. package/lib/files.js +41 -0
  32. package/lib/files.js.map +1 -1
  33. package/lib/matchers.d.ts +3 -10
  34. package/lib/matchers.d.ts.map +1 -1
  35. package/lib/matchers.js +33 -31
  36. package/lib/matchers.js.map +1 -1
  37. package/lib/sdks.d.ts +1 -0
  38. package/lib/sdks.d.ts.map +1 -1
  39. package/lib/sdks.js +3 -3
  40. package/lib/sdks.js.map +1 -1
  41. package/lib/security.d.ts +2 -2
  42. package/lib/security.d.ts.map +1 -1
  43. package/models/components/addressattributes.d.ts +8 -8
  44. package/models/components/addressattributes.d.ts.map +1 -1
  45. package/models/components/addressattributes.js +14 -13
  46. package/models/components/addressattributes.js.map +1 -1
  47. package/models/components/badrequesterror.d.ts +24 -24
  48. package/models/components/badrequesterror.d.ts.map +1 -1
  49. package/models/components/badrequesterror.js +37 -38
  50. package/models/components/badrequesterror.js.map +1 -1
  51. package/models/components/commercialsecuredapplicationpayload.d.ts +8 -8
  52. package/models/components/commercialsecuredapplicationpayload.d.ts.map +1 -1
  53. package/models/components/commercialsecuredapplicationpayload.js +13 -14
  54. package/models/components/commercialsecuredapplicationpayload.js.map +1 -1
  55. package/models/components/commercialsecuredloancommercialapplicationrelationships.d.ts +90 -90
  56. package/models/components/commercialsecuredloancommercialapplicationrelationships.d.ts.map +1 -1
  57. package/models/components/commercialsecuredloancommercialapplicationrelationships.js +116 -118
  58. package/models/components/commercialsecuredloancommercialapplicationrelationships.js.map +1 -1
  59. package/models/components/customerattributes.d.ts +6 -0
  60. package/models/components/customerattributes.d.ts.map +1 -1
  61. package/models/components/customerattributes.js +3 -0
  62. package/models/components/customerattributes.js.map +1 -1
  63. package/models/components/forbiddenerror.d.ts +16 -16
  64. package/models/components/forbiddenerror.d.ts.map +1 -1
  65. package/models/components/forbiddenerror.js +25 -25
  66. package/models/components/forbiddenerror.js.map +1 -1
  67. package/models/components/loandetailsattributes.d.ts +8 -8
  68. package/models/components/loandetailsattributes.d.ts.map +1 -1
  69. package/models/components/loandetailsattributes.js +8 -8
  70. package/models/components/loandetailsattributes.js.map +1 -1
  71. package/models/components/supportingdocumentrelationships.d.ts +45 -45
  72. package/models/components/supportingdocumentrelationships.d.ts.map +1 -1
  73. package/models/components/supportingdocumentrelationships.js +54 -54
  74. package/models/components/supportingdocumentrelationships.js.map +1 -1
  75. package/models/components/supportingdocumentresource.d.ts +8 -8
  76. package/models/components/supportingdocumentresource.d.ts.map +1 -1
  77. package/models/components/supportingdocumentresource.js +13 -13
  78. package/models/components/supportingdocumentresource.js.map +1 -1
  79. package/models/errors/apierror.d.ts +8 -6
  80. package/models/errors/apierror.d.ts.map +1 -1
  81. package/models/errors/apierror.js +23 -10
  82. package/models/errors/apierror.js.map +1 -1
  83. package/models/errors/financeableerror.d.ts +19 -0
  84. package/models/errors/financeableerror.d.ts.map +1 -0
  85. package/models/errors/financeableerror.js +20 -0
  86. package/models/errors/financeableerror.js.map +1 -0
  87. package/models/errors/index.d.ts +1 -2
  88. package/models/errors/index.d.ts.map +1 -1
  89. package/models/errors/index.js +1 -2
  90. package/models/errors/index.js.map +1 -1
  91. package/models/errors/responsevalidationerror.d.ts +26 -0
  92. package/models/errors/responsevalidationerror.d.ts.map +1 -0
  93. package/models/errors/responsevalidationerror.js +66 -0
  94. package/models/errors/responsevalidationerror.js.map +1 -0
  95. package/models/errors/sdkvalidationerror.d.ts +1 -0
  96. package/models/errors/sdkvalidationerror.d.ts.map +1 -1
  97. package/models/errors/sdkvalidationerror.js +14 -0
  98. package/models/errors/sdkvalidationerror.js.map +1 -1
  99. package/models/operations/createapplication.d.ts +107 -30
  100. package/models/operations/createapplication.d.ts.map +1 -1
  101. package/models/operations/createapplication.js +125 -44
  102. package/models/operations/createapplication.js.map +1 -1
  103. package/models/operations/supportingdocumentscreate.d.ts +144 -0
  104. package/models/operations/supportingdocumentscreate.d.ts.map +1 -1
  105. package/models/operations/supportingdocumentscreate.js +186 -1
  106. package/models/operations/supportingdocumentscreate.js.map +1 -1
  107. package/package.json +1 -1
  108. package/sdk/applications.d.ts +1 -1
  109. package/sdk/applications.d.ts.map +1 -1
  110. package/sdk/sdk.d.ts +2 -2
  111. package/sdk/sdk.d.ts.map +1 -1
  112. package/sdk/sdk.js +3 -3
  113. package/sdk/sdk.js.map +1 -1
  114. package/sdk/supportingdocuments.d.ts +1 -1
  115. package/sdk/supportingdocuments.d.ts.map +1 -1
  116. package/src/funcs/applicationsCreate.ts +30 -40
  117. package/src/funcs/oauthTokenGet.ts +24 -20
  118. package/src/funcs/supportingDocumentsCreate.ts +31 -42
  119. package/src/hooks/types.ts +2 -0
  120. package/src/index.ts +2 -0
  121. package/src/lib/config.ts +7 -3
  122. package/src/lib/files.ts +42 -0
  123. package/src/lib/matchers.ts +44 -41
  124. package/src/lib/sdks.ts +10 -4
  125. package/src/lib/security.ts +2 -2
  126. package/src/models/components/addressattributes.ts +14 -18
  127. package/src/models/components/badrequesterror.ts +48 -44
  128. package/src/models/components/commercialsecuredapplicationpayload.ts +15 -20
  129. package/src/models/components/commercialsecuredloancommercialapplicationrelationships.ts +178 -238
  130. package/src/models/components/customerattributes.ts +12 -0
  131. package/src/models/components/forbiddenerror.ts +30 -32
  132. package/src/models/components/loandetailsattributes.ts +16 -16
  133. package/src/models/components/supportingdocumentrelationships.ts +117 -82
  134. package/src/models/components/supportingdocumentresource.ts +18 -15
  135. package/src/models/errors/apierror.ts +29 -16
  136. package/src/models/errors/financeableerror.ts +35 -0
  137. package/src/models/errors/index.ts +1 -2
  138. package/src/models/errors/responsevalidationerror.ts +50 -0
  139. package/src/models/errors/sdkvalidationerror.ts +12 -0
  140. package/src/models/operations/createapplication.ts +299 -64
  141. package/src/models/operations/supportingdocumentscreate.ts +386 -0
  142. package/src/sdk/applications.ts +1 -1
  143. package/src/sdk/sdk.ts +7 -7
  144. package/src/sdk/supportingdocuments.ts +1 -1
  145. package/src/types/constdatetime.ts +1 -1
  146. package/types/constdatetime.js +1 -1
  147. package/models/errors/createapplication.d.ts +0 -73
  148. package/models/errors/createapplication.d.ts.map +0 -1
  149. package/models/errors/createapplication.js +0 -120
  150. package/models/errors/createapplication.js.map +0 -1
  151. package/models/errors/supportingdocumentscreate.d.ts +0 -143
  152. package/models/errors/supportingdocumentscreate.d.ts.map +0 -1
  153. package/models/errors/supportingdocumentscreate.js +0 -225
  154. package/models/errors/supportingdocumentscreate.js.map +0 -1
  155. package/src/models/errors/createapplication.ts +0 -149
  156. package/src/models/errors/supportingdocumentscreate.ts +0 -342
@@ -1,342 +0,0 @@
1
- /*
2
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
- */
4
-
5
- import * as z from "zod";
6
- import { safeParse } from "../../lib/schemas.js";
7
- import { Result as SafeParseResult } from "../../types/fp.js";
8
- import * as components from "../components/index.js";
9
- import { SDKValidationError } from "./sdkvalidationerror.js";
10
-
11
- export type TwoData = {
12
- errors: Array<components.RelationshipResourceNotFound>;
13
- };
14
-
15
- export class Two extends Error {
16
- errors: Array<components.RelationshipResourceNotFound>;
17
-
18
- /** The original data that was passed to this error instance. */
19
- data$: TwoData;
20
-
21
- constructor(err: TwoData) {
22
- const message = "message" in err && typeof err.message === "string"
23
- ? err.message
24
- : `API error occurred: ${JSON.stringify(err)}`;
25
- super(message);
26
- this.data$ = err;
27
-
28
- this.errors = err.errors;
29
-
30
- this.name = "Two";
31
- }
32
- }
33
-
34
- export type OneData = {
35
- errors: Array<components.ResourceNotFound>;
36
- };
37
-
38
- export class One extends Error {
39
- errors: Array<components.ResourceNotFound>;
40
-
41
- /** The original data that was passed to this error instance. */
42
- data$: OneData;
43
-
44
- constructor(err: OneData) {
45
- const message = "message" in err && typeof err.message === "string"
46
- ? err.message
47
- : `API error occurred: ${JSON.stringify(err)}`;
48
- super(message);
49
- this.data$ = err;
50
-
51
- this.errors = err.errors;
52
-
53
- this.name = "One";
54
- }
55
- }
56
-
57
- /**
58
- * The server cannot find the requested resource.
59
- */
60
- export type SupportingDocumentsCreateSupportingDocumentsResponseBody =
61
- | One
62
- | Two;
63
-
64
- export type Errors =
65
- | components.BadRequestError
66
- | components.RelationshipResourceNotFound;
67
-
68
- /**
69
- * The server could not understand the request due to invalid syntax.
70
- */
71
- export type SupportingDocumentsCreateResponseBodyData = {
72
- errors: Array<
73
- components.BadRequestError | components.RelationshipResourceNotFound
74
- >;
75
- };
76
-
77
- /**
78
- * The server could not understand the request due to invalid syntax.
79
- */
80
- export class SupportingDocumentsCreateResponseBody extends Error {
81
- errors: Array<
82
- components.BadRequestError | components.RelationshipResourceNotFound
83
- >;
84
-
85
- /** The original data that was passed to this error instance. */
86
- data$: SupportingDocumentsCreateResponseBodyData;
87
-
88
- constructor(err: SupportingDocumentsCreateResponseBodyData) {
89
- const message = "message" in err && typeof err.message === "string"
90
- ? err.message
91
- : `API error occurred: ${JSON.stringify(err)}`;
92
- super(message);
93
- this.data$ = err;
94
-
95
- this.errors = err.errors;
96
-
97
- this.name = "SupportingDocumentsCreateResponseBody";
98
- }
99
- }
100
-
101
- /** @internal */
102
- export const Two$inboundSchema: z.ZodType<Two, z.ZodTypeDef, unknown> = z
103
- .object({
104
- errors: z.array(components.RelationshipResourceNotFound$inboundSchema),
105
- })
106
- .transform((v) => {
107
- return new Two(v);
108
- });
109
-
110
- /** @internal */
111
- export type Two$Outbound = {
112
- errors: Array<components.RelationshipResourceNotFound$Outbound>;
113
- };
114
-
115
- /** @internal */
116
- export const Two$outboundSchema: z.ZodType<Two$Outbound, z.ZodTypeDef, Two> = z
117
- .instanceof(Two)
118
- .transform(v => v.data$)
119
- .pipe(z.object({
120
- errors: z.array(components.RelationshipResourceNotFound$outboundSchema),
121
- }));
122
-
123
- /**
124
- * @internal
125
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
126
- */
127
- export namespace Two$ {
128
- /** @deprecated use `Two$inboundSchema` instead. */
129
- export const inboundSchema = Two$inboundSchema;
130
- /** @deprecated use `Two$outboundSchema` instead. */
131
- export const outboundSchema = Two$outboundSchema;
132
- /** @deprecated use `Two$Outbound` instead. */
133
- export type Outbound = Two$Outbound;
134
- }
135
-
136
- /** @internal */
137
- export const One$inboundSchema: z.ZodType<One, z.ZodTypeDef, unknown> = z
138
- .object({
139
- errors: z.array(components.ResourceNotFound$inboundSchema),
140
- })
141
- .transform((v) => {
142
- return new One(v);
143
- });
144
-
145
- /** @internal */
146
- export type One$Outbound = {
147
- errors: Array<components.ResourceNotFound$Outbound>;
148
- };
149
-
150
- /** @internal */
151
- export const One$outboundSchema: z.ZodType<One$Outbound, z.ZodTypeDef, One> = z
152
- .instanceof(One)
153
- .transform(v => v.data$)
154
- .pipe(z.object({
155
- errors: z.array(components.ResourceNotFound$outboundSchema),
156
- }));
157
-
158
- /**
159
- * @internal
160
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
161
- */
162
- export namespace One$ {
163
- /** @deprecated use `One$inboundSchema` instead. */
164
- export const inboundSchema = One$inboundSchema;
165
- /** @deprecated use `One$outboundSchema` instead. */
166
- export const outboundSchema = One$outboundSchema;
167
- /** @deprecated use `One$Outbound` instead. */
168
- export type Outbound = One$Outbound;
169
- }
170
-
171
- /** @internal */
172
- export const SupportingDocumentsCreateSupportingDocumentsResponseBody$inboundSchema:
173
- z.ZodType<
174
- SupportingDocumentsCreateSupportingDocumentsResponseBody,
175
- z.ZodTypeDef,
176
- unknown
177
- > = z.union([
178
- z.lazy(() => One$inboundSchema),
179
- z.lazy(() => Two$inboundSchema),
180
- ]);
181
-
182
- /** @internal */
183
- export type SupportingDocumentsCreateSupportingDocumentsResponseBody$Outbound =
184
- | One$Outbound
185
- | Two$Outbound;
186
-
187
- /** @internal */
188
- export const SupportingDocumentsCreateSupportingDocumentsResponseBody$outboundSchema:
189
- z.ZodType<
190
- SupportingDocumentsCreateSupportingDocumentsResponseBody$Outbound,
191
- z.ZodTypeDef,
192
- SupportingDocumentsCreateSupportingDocumentsResponseBody
193
- > = z.union([
194
- z.lazy(() => One$outboundSchema),
195
- z.lazy(() => Two$outboundSchema),
196
- ]);
197
-
198
- /**
199
- * @internal
200
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
201
- */
202
- export namespace SupportingDocumentsCreateSupportingDocumentsResponseBody$ {
203
- /** @deprecated use `SupportingDocumentsCreateSupportingDocumentsResponseBody$inboundSchema` instead. */
204
- export const inboundSchema =
205
- SupportingDocumentsCreateSupportingDocumentsResponseBody$inboundSchema;
206
- /** @deprecated use `SupportingDocumentsCreateSupportingDocumentsResponseBody$outboundSchema` instead. */
207
- export const outboundSchema =
208
- SupportingDocumentsCreateSupportingDocumentsResponseBody$outboundSchema;
209
- /** @deprecated use `SupportingDocumentsCreateSupportingDocumentsResponseBody$Outbound` instead. */
210
- export type Outbound =
211
- SupportingDocumentsCreateSupportingDocumentsResponseBody$Outbound;
212
- }
213
-
214
- export function supportingDocumentsCreateSupportingDocumentsResponseBodyToJSON(
215
- supportingDocumentsCreateSupportingDocumentsResponseBody:
216
- SupportingDocumentsCreateSupportingDocumentsResponseBody,
217
- ): string {
218
- return JSON.stringify(
219
- SupportingDocumentsCreateSupportingDocumentsResponseBody$outboundSchema
220
- .parse(supportingDocumentsCreateSupportingDocumentsResponseBody),
221
- );
222
- }
223
-
224
- export function supportingDocumentsCreateSupportingDocumentsResponseBodyFromJSON(
225
- jsonString: string,
226
- ): SafeParseResult<
227
- SupportingDocumentsCreateSupportingDocumentsResponseBody,
228
- SDKValidationError
229
- > {
230
- return safeParse(
231
- jsonString,
232
- (x) =>
233
- SupportingDocumentsCreateSupportingDocumentsResponseBody$inboundSchema
234
- .parse(JSON.parse(x)),
235
- `Failed to parse 'SupportingDocumentsCreateSupportingDocumentsResponseBody' from JSON`,
236
- );
237
- }
238
-
239
- /** @internal */
240
- export const Errors$inboundSchema: z.ZodType<Errors, z.ZodTypeDef, unknown> = z
241
- .union([
242
- components.BadRequestError$inboundSchema,
243
- components.RelationshipResourceNotFound$inboundSchema,
244
- ]);
245
-
246
- /** @internal */
247
- export type Errors$Outbound =
248
- | components.BadRequestError$Outbound
249
- | components.RelationshipResourceNotFound$Outbound;
250
-
251
- /** @internal */
252
- export const Errors$outboundSchema: z.ZodType<
253
- Errors$Outbound,
254
- z.ZodTypeDef,
255
- Errors
256
- > = z.union([
257
- components.BadRequestError$outboundSchema,
258
- components.RelationshipResourceNotFound$outboundSchema,
259
- ]);
260
-
261
- /**
262
- * @internal
263
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
264
- */
265
- export namespace Errors$ {
266
- /** @deprecated use `Errors$inboundSchema` instead. */
267
- export const inboundSchema = Errors$inboundSchema;
268
- /** @deprecated use `Errors$outboundSchema` instead. */
269
- export const outboundSchema = Errors$outboundSchema;
270
- /** @deprecated use `Errors$Outbound` instead. */
271
- export type Outbound = Errors$Outbound;
272
- }
273
-
274
- export function errorsToJSON(errors: Errors): string {
275
- return JSON.stringify(Errors$outboundSchema.parse(errors));
276
- }
277
-
278
- export function errorsFromJSON(
279
- jsonString: string,
280
- ): SafeParseResult<Errors, SDKValidationError> {
281
- return safeParse(
282
- jsonString,
283
- (x) => Errors$inboundSchema.parse(JSON.parse(x)),
284
- `Failed to parse 'Errors' from JSON`,
285
- );
286
- }
287
-
288
- /** @internal */
289
- export const SupportingDocumentsCreateResponseBody$inboundSchema: z.ZodType<
290
- SupportingDocumentsCreateResponseBody,
291
- z.ZodTypeDef,
292
- unknown
293
- > = z.object({
294
- errors: z.array(
295
- z.union([
296
- components.BadRequestError$inboundSchema,
297
- components.RelationshipResourceNotFound$inboundSchema,
298
- ]),
299
- ),
300
- })
301
- .transform((v) => {
302
- return new SupportingDocumentsCreateResponseBody(v);
303
- });
304
-
305
- /** @internal */
306
- export type SupportingDocumentsCreateResponseBody$Outbound = {
307
- errors: Array<
308
- | components.BadRequestError$Outbound
309
- | components.RelationshipResourceNotFound$Outbound
310
- >;
311
- };
312
-
313
- /** @internal */
314
- export const SupportingDocumentsCreateResponseBody$outboundSchema: z.ZodType<
315
- SupportingDocumentsCreateResponseBody$Outbound,
316
- z.ZodTypeDef,
317
- SupportingDocumentsCreateResponseBody
318
- > = z.instanceof(SupportingDocumentsCreateResponseBody)
319
- .transform(v => v.data$)
320
- .pipe(z.object({
321
- errors: z.array(
322
- z.union([
323
- components.BadRequestError$outboundSchema,
324
- components.RelationshipResourceNotFound$outboundSchema,
325
- ]),
326
- ),
327
- }));
328
-
329
- /**
330
- * @internal
331
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
332
- */
333
- export namespace SupportingDocumentsCreateResponseBody$ {
334
- /** @deprecated use `SupportingDocumentsCreateResponseBody$inboundSchema` instead. */
335
- export const inboundSchema =
336
- SupportingDocumentsCreateResponseBody$inboundSchema;
337
- /** @deprecated use `SupportingDocumentsCreateResponseBody$outboundSchema` instead. */
338
- export const outboundSchema =
339
- SupportingDocumentsCreateResponseBody$outboundSchema;
340
- /** @deprecated use `SupportingDocumentsCreateResponseBody$Outbound` instead. */
341
- export type Outbound = SupportingDocumentsCreateResponseBody$Outbound;
342
- }