@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
@@ -20,27 +20,27 @@ import {
20
20
  ErrorSource$outboundSchema,
21
21
  } from "./errorsource.js";
22
22
 
23
- export const Status = {
23
+ export const BadRequestErrorStatus = {
24
24
  FourHundred: "400",
25
25
  } as const;
26
- export type Status = ClosedEnum<typeof Status>;
26
+ export type BadRequestErrorStatus = ClosedEnum<typeof BadRequestErrorStatus>;
27
27
 
28
- export const Code = {
28
+ export const BadRequestErrorCode = {
29
29
  BadRequest: "BadRequest",
30
30
  } as const;
31
- export type Code = ClosedEnum<typeof Code>;
31
+ export type BadRequestErrorCode = ClosedEnum<typeof BadRequestErrorCode>;
32
32
 
33
- export const Title = {
33
+ export const BadRequestErrorTitle = {
34
34
  BadRequest: "Bad Request",
35
35
  } as const;
36
- export type Title = ClosedEnum<typeof Title>;
36
+ export type BadRequestErrorTitle = ClosedEnum<typeof BadRequestErrorTitle>;
37
37
 
38
38
  export type BadRequestError = {
39
39
  id?: string | undefined;
40
40
  links?: APIErrorLinks | undefined;
41
- status: Status;
42
- code: Code;
43
- title: Title;
41
+ status: BadRequestErrorStatus;
42
+ code: BadRequestErrorCode;
43
+ title: BadRequestErrorTitle;
44
44
  detail: string;
45
45
  /**
46
46
  * An object describing the source of the error from the request
@@ -50,62 +50,66 @@ export type BadRequestError = {
50
50
  };
51
51
 
52
52
  /** @internal */
53
- export const Status$inboundSchema: z.ZodNativeEnum<typeof Status> = z
54
- .nativeEnum(Status);
53
+ export const BadRequestErrorStatus$inboundSchema: z.ZodNativeEnum<
54
+ typeof BadRequestErrorStatus
55
+ > = z.nativeEnum(BadRequestErrorStatus);
55
56
 
56
57
  /** @internal */
57
- export const Status$outboundSchema: z.ZodNativeEnum<typeof Status> =
58
- Status$inboundSchema;
58
+ export const BadRequestErrorStatus$outboundSchema: z.ZodNativeEnum<
59
+ typeof BadRequestErrorStatus
60
+ > = BadRequestErrorStatus$inboundSchema;
59
61
 
60
62
  /**
61
63
  * @internal
62
64
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
63
65
  */
64
- export namespace Status$ {
65
- /** @deprecated use `Status$inboundSchema` instead. */
66
- export const inboundSchema = Status$inboundSchema;
67
- /** @deprecated use `Status$outboundSchema` instead. */
68
- export const outboundSchema = Status$outboundSchema;
66
+ export namespace BadRequestErrorStatus$ {
67
+ /** @deprecated use `BadRequestErrorStatus$inboundSchema` instead. */
68
+ export const inboundSchema = BadRequestErrorStatus$inboundSchema;
69
+ /** @deprecated use `BadRequestErrorStatus$outboundSchema` instead. */
70
+ export const outboundSchema = BadRequestErrorStatus$outboundSchema;
69
71
  }
70
72
 
71
73
  /** @internal */
72
- export const Code$inboundSchema: z.ZodNativeEnum<typeof Code> = z.nativeEnum(
73
- Code,
74
- );
74
+ export const BadRequestErrorCode$inboundSchema: z.ZodNativeEnum<
75
+ typeof BadRequestErrorCode
76
+ > = z.nativeEnum(BadRequestErrorCode);
75
77
 
76
78
  /** @internal */
77
- export const Code$outboundSchema: z.ZodNativeEnum<typeof Code> =
78
- Code$inboundSchema;
79
+ export const BadRequestErrorCode$outboundSchema: z.ZodNativeEnum<
80
+ typeof BadRequestErrorCode
81
+ > = BadRequestErrorCode$inboundSchema;
79
82
 
80
83
  /**
81
84
  * @internal
82
85
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
83
86
  */
84
- export namespace Code$ {
85
- /** @deprecated use `Code$inboundSchema` instead. */
86
- export const inboundSchema = Code$inboundSchema;
87
- /** @deprecated use `Code$outboundSchema` instead. */
88
- export const outboundSchema = Code$outboundSchema;
87
+ export namespace BadRequestErrorCode$ {
88
+ /** @deprecated use `BadRequestErrorCode$inboundSchema` instead. */
89
+ export const inboundSchema = BadRequestErrorCode$inboundSchema;
90
+ /** @deprecated use `BadRequestErrorCode$outboundSchema` instead. */
91
+ export const outboundSchema = BadRequestErrorCode$outboundSchema;
89
92
  }
90
93
 
91
94
  /** @internal */
92
- export const Title$inboundSchema: z.ZodNativeEnum<typeof Title> = z.nativeEnum(
93
- Title,
94
- );
95
+ export const BadRequestErrorTitle$inboundSchema: z.ZodNativeEnum<
96
+ typeof BadRequestErrorTitle
97
+ > = z.nativeEnum(BadRequestErrorTitle);
95
98
 
96
99
  /** @internal */
97
- export const Title$outboundSchema: z.ZodNativeEnum<typeof Title> =
98
- Title$inboundSchema;
100
+ export const BadRequestErrorTitle$outboundSchema: z.ZodNativeEnum<
101
+ typeof BadRequestErrorTitle
102
+ > = BadRequestErrorTitle$inboundSchema;
99
103
 
100
104
  /**
101
105
  * @internal
102
106
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
103
107
  */
104
- export namespace Title$ {
105
- /** @deprecated use `Title$inboundSchema` instead. */
106
- export const inboundSchema = Title$inboundSchema;
107
- /** @deprecated use `Title$outboundSchema` instead. */
108
- export const outboundSchema = Title$outboundSchema;
108
+ export namespace BadRequestErrorTitle$ {
109
+ /** @deprecated use `BadRequestErrorTitle$inboundSchema` instead. */
110
+ export const inboundSchema = BadRequestErrorTitle$inboundSchema;
111
+ /** @deprecated use `BadRequestErrorTitle$outboundSchema` instead. */
112
+ export const outboundSchema = BadRequestErrorTitle$outboundSchema;
109
113
  }
110
114
 
111
115
  /** @internal */
@@ -116,9 +120,9 @@ export const BadRequestError$inboundSchema: z.ZodType<
116
120
  > = z.object({
117
121
  id: z.string().optional(),
118
122
  links: APIErrorLinks$inboundSchema.optional(),
119
- status: Status$inboundSchema,
120
- code: Code$inboundSchema,
121
- title: Title$inboundSchema,
123
+ status: BadRequestErrorStatus$inboundSchema,
124
+ code: BadRequestErrorCode$inboundSchema,
125
+ title: BadRequestErrorTitle$inboundSchema,
122
126
  detail: z.string(),
123
127
  source: ErrorSource$inboundSchema.optional(),
124
128
  meta: z.record(z.any()).optional(),
@@ -144,9 +148,9 @@ export const BadRequestError$outboundSchema: z.ZodType<
144
148
  > = z.object({
145
149
  id: z.string().optional(),
146
150
  links: APIErrorLinks$outboundSchema.optional(),
147
- status: Status$outboundSchema,
148
- code: Code$outboundSchema,
149
- title: Title$outboundSchema,
151
+ status: BadRequestErrorStatus$outboundSchema,
152
+ code: BadRequestErrorCode$outboundSchema,
153
+ title: BadRequestErrorTitle$outboundSchema,
150
154
  detail: z.string(),
151
155
  source: ErrorSource$outboundSchema.optional(),
152
156
  meta: z.record(z.any()).optional(),
@@ -23,7 +23,7 @@ import {
23
23
  /**
24
24
  * Resource types used in the API
25
25
  */
26
- export const CommercialSecuredApplicationPayloadType = {
26
+ export const Type = {
27
27
  ConsumerSecuredApplications: "consumer-secured-applications",
28
28
  CommercialSecuredApplications: "commercial-secured-applications",
29
29
  SupportingDocuments: "supporting-documents",
@@ -36,9 +36,7 @@ export const CommercialSecuredApplicationPayloadType = {
36
36
  /**
37
37
  * Resource types used in the API
38
38
  */
39
- export type CommercialSecuredApplicationPayloadType = ClosedEnum<
40
- typeof CommercialSecuredApplicationPayloadType
41
- >;
39
+ export type Type = ClosedEnum<typeof Type>;
42
40
 
43
41
  /**
44
42
  * Type of the loan application
@@ -66,7 +64,7 @@ export type Attributes = {
66
64
  };
67
65
 
68
66
  export type CommercialSecuredApplicationPayload = {
69
- type: CommercialSecuredApplicationPayloadType;
67
+ type: Type;
70
68
  /**
71
69
  * Application resource attributes
72
70
  */
@@ -79,26 +77,23 @@ export type CommercialSecuredApplicationPayload = {
79
77
  };
80
78
 
81
79
  /** @internal */
82
- export const CommercialSecuredApplicationPayloadType$inboundSchema:
83
- z.ZodNativeEnum<typeof CommercialSecuredApplicationPayloadType> = z
84
- .nativeEnum(CommercialSecuredApplicationPayloadType);
80
+ export const Type$inboundSchema: z.ZodNativeEnum<typeof Type> = z.nativeEnum(
81
+ Type,
82
+ );
85
83
 
86
84
  /** @internal */
87
- export const CommercialSecuredApplicationPayloadType$outboundSchema:
88
- z.ZodNativeEnum<typeof CommercialSecuredApplicationPayloadType> =
89
- CommercialSecuredApplicationPayloadType$inboundSchema;
85
+ export const Type$outboundSchema: z.ZodNativeEnum<typeof Type> =
86
+ Type$inboundSchema;
90
87
 
91
88
  /**
92
89
  * @internal
93
90
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
94
91
  */
95
- export namespace CommercialSecuredApplicationPayloadType$ {
96
- /** @deprecated use `CommercialSecuredApplicationPayloadType$inboundSchema` instead. */
97
- export const inboundSchema =
98
- CommercialSecuredApplicationPayloadType$inboundSchema;
99
- /** @deprecated use `CommercialSecuredApplicationPayloadType$outboundSchema` instead. */
100
- export const outboundSchema =
101
- CommercialSecuredApplicationPayloadType$outboundSchema;
92
+ export namespace Type$ {
93
+ /** @deprecated use `Type$inboundSchema` instead. */
94
+ export const inboundSchema = Type$inboundSchema;
95
+ /** @deprecated use `Type$outboundSchema` instead. */
96
+ export const outboundSchema = Type$outboundSchema;
102
97
  }
103
98
 
104
99
  /** @internal */
@@ -181,7 +176,7 @@ export const CommercialSecuredApplicationPayload$inboundSchema: z.ZodType<
181
176
  z.ZodTypeDef,
182
177
  unknown
183
178
  > = z.object({
184
- type: CommercialSecuredApplicationPayloadType$inboundSchema,
179
+ type: Type$inboundSchema,
185
180
  attributes: z.lazy(() => Attributes$inboundSchema),
186
181
  relationships:
187
182
  CommercialSecuredLoanCommercialApplicationRelationships$inboundSchema
@@ -207,7 +202,7 @@ export const CommercialSecuredApplicationPayload$outboundSchema: z.ZodType<
207
202
  z.ZodTypeDef,
208
203
  CommercialSecuredApplicationPayload
209
204
  > = z.object({
210
- type: CommercialSecuredApplicationPayloadType$outboundSchema,
205
+ type: Type$outboundSchema,
211
206
  attributes: z.lazy(() => Attributes$outboundSchema),
212
207
  relationships:
213
208
  CommercialSecuredLoanCommercialApplicationRelationships$outboundSchema