@financeable/aggregation 0.6.12 → 0.6.17

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 (59) hide show
  1. package/FUNCTIONS.md +2 -2
  2. package/README.md +6 -6
  3. package/docs/sdks/applications/README.md +266 -16
  4. package/docs/sdks/supportingdocuments/README.md +4 -4
  5. package/jsr.json +1 -1
  6. package/lib/config.d.ts +3 -3
  7. package/lib/config.js +3 -3
  8. package/models/components/addressattributes.d.ts +2 -2
  9. package/models/components/addressattributes.d.ts.map +1 -1
  10. package/models/components/addressattributes.js +2 -2
  11. package/models/components/addressattributes.js.map +1 -1
  12. package/models/components/commercialsecuredapplicationpayload.d.ts +2 -2
  13. package/models/components/commercialsecuredapplicationpayload.d.ts.map +1 -1
  14. package/models/components/commercialsecuredapplicationpayload.js +2 -2
  15. package/models/components/commercialsecuredapplicationpayload.js.map +1 -1
  16. package/models/components/commercialsecuredapplicationresource.d.ts +2 -7
  17. package/models/components/commercialsecuredapplicationresource.d.ts.map +1 -1
  18. package/models/components/commercialsecuredapplicationresource.js +2 -4
  19. package/models/components/commercialsecuredapplicationresource.js.map +1 -1
  20. package/models/components/consumersecuredapplicationpayload.d.ts +2 -2
  21. package/models/components/consumersecuredapplicationpayload.d.ts.map +1 -1
  22. package/models/components/consumersecuredapplicationpayload.js +2 -2
  23. package/models/components/consumersecuredapplicationpayload.js.map +1 -1
  24. package/models/components/consumersecuredapplicationresource.d.ts +2 -7
  25. package/models/components/consumersecuredapplicationresource.d.ts.map +1 -1
  26. package/models/components/consumersecuredapplicationresource.js +2 -4
  27. package/models/components/consumersecuredapplicationresource.js.map +1 -1
  28. package/models/components/consumersecuredloanassetattributes.d.ts +2 -2
  29. package/models/components/consumersecuredloanassetattributes.d.ts.map +1 -1
  30. package/models/components/consumersecuredloanassetattributes.js +2 -2
  31. package/models/components/consumersecuredloanassetattributes.js.map +1 -1
  32. package/models/components/customerattributes.d.ts +2 -2
  33. package/models/components/customerattributes.d.ts.map +1 -1
  34. package/models/components/customerattributes.js +2 -2
  35. package/models/components/customerattributes.js.map +1 -1
  36. package/models/components/entityattributes.d.ts +2 -2
  37. package/models/components/entityattributes.d.ts.map +1 -1
  38. package/models/components/entityattributes.js +2 -2
  39. package/models/components/entityattributes.js.map +1 -1
  40. package/models/components/loandetailsattributes.d.ts +2 -2
  41. package/models/components/loandetailsattributes.d.ts.map +1 -1
  42. package/models/components/loandetailsattributes.js +2 -2
  43. package/models/components/loandetailsattributes.js.map +1 -1
  44. package/models/components/supportingdocumentattributes.d.ts +2 -2
  45. package/models/components/supportingdocumentattributes.d.ts.map +1 -1
  46. package/models/components/supportingdocumentattributes.js +2 -2
  47. package/models/components/supportingdocumentattributes.js.map +1 -1
  48. package/package.json +1 -1
  49. package/src/lib/config.ts +3 -3
  50. package/src/models/components/addressattributes.ts +4 -4
  51. package/src/models/components/commercialsecuredapplicationpayload.ts +4 -4
  52. package/src/models/components/commercialsecuredapplicationresource.ts +4 -11
  53. package/src/models/components/consumersecuredapplicationpayload.ts +4 -4
  54. package/src/models/components/consumersecuredapplicationresource.ts +4 -11
  55. package/src/models/components/consumersecuredloanassetattributes.ts +4 -4
  56. package/src/models/components/customerattributes.ts +4 -4
  57. package/src/models/components/entityattributes.ts +4 -4
  58. package/src/models/components/loandetailsattributes.ts +4 -4
  59. package/src/models/components/supportingdocumentattributes.ts +4 -4
@@ -62,7 +62,7 @@ export type Attributes = {
62
62
  /**
63
63
  * Email address of the broker to be associated with this application.
64
64
  */
65
- associatedBrokerEmail?: string | undefined;
65
+ associatedBrokerEmail: string;
66
66
  };
67
67
 
68
68
  export type CommercialSecuredApplicationPayload = {
@@ -127,13 +127,13 @@ export const Attributes$inboundSchema: z.ZodType<
127
127
  unknown
128
128
  > = z.object({
129
129
  applicationType: ApplicationType$inboundSchema,
130
- associatedBrokerEmail: z.string().optional(),
130
+ associatedBrokerEmail: z.string(),
131
131
  });
132
132
 
133
133
  /** @internal */
134
134
  export type Attributes$Outbound = {
135
135
  applicationType: string;
136
- associatedBrokerEmail?: string | undefined;
136
+ associatedBrokerEmail: string;
137
137
  };
138
138
 
139
139
  /** @internal */
@@ -143,7 +143,7 @@ export const Attributes$outboundSchema: z.ZodType<
143
143
  Attributes
144
144
  > = z.object({
145
145
  applicationType: ApplicationType$outboundSchema,
146
- associatedBrokerEmail: z.string().optional(),
146
+ associatedBrokerEmail: z.string(),
147
147
  });
148
148
 
149
149
  /**
@@ -52,7 +52,7 @@ export type CommercialSecuredApplicationResourceAttributes = {
52
52
  /**
53
53
  * Full identifier of the application. Not visible within the web application.
54
54
  */
55
- id: string;
55
+ id?: string | undefined;
56
56
  /**
57
57
  * Human readable & easily communicated identifier of the application. Visible within the web application.
58
58
  */
@@ -65,10 +65,6 @@ export type CommercialSecuredApplicationResourceAttributes = {
65
65
  * Current status, must be 'workshop' for new applications
66
66
  */
67
67
  status: ApplicationStatus;
68
- /**
69
- * Email address of the broker to be associated with this application.
70
- */
71
- associatedBrokerEmail?: string | undefined;
72
68
  /**
73
69
  * Creation timestamp
74
70
  */
@@ -150,23 +146,21 @@ export const CommercialSecuredApplicationResourceAttributes$inboundSchema:
150
146
  z.ZodTypeDef,
151
147
  unknown
152
148
  > = z.object({
153
- id: z.string(),
149
+ id: z.string().optional(),
154
150
  humanId: z.string(),
155
151
  applicationType:
156
152
  CommercialSecuredApplicationResourceApplicationType$inboundSchema,
157
153
  status: ApplicationStatus$inboundSchema,
158
- associatedBrokerEmail: z.string().optional(),
159
154
  createdAt: z.string().optional(),
160
155
  updatedAt: z.string().optional(),
161
156
  });
162
157
 
163
158
  /** @internal */
164
159
  export type CommercialSecuredApplicationResourceAttributes$Outbound = {
165
- id: string;
160
+ id?: string | undefined;
166
161
  humanId: string;
167
162
  applicationType: string;
168
163
  status: string;
169
- associatedBrokerEmail?: string | undefined;
170
164
  createdAt?: string | undefined;
171
165
  updatedAt?: string | undefined;
172
166
  };
@@ -178,12 +172,11 @@ export const CommercialSecuredApplicationResourceAttributes$outboundSchema:
178
172
  z.ZodTypeDef,
179
173
  CommercialSecuredApplicationResourceAttributes
180
174
  > = z.object({
181
- id: z.string(),
175
+ id: z.string().optional(),
182
176
  humanId: z.string(),
183
177
  applicationType:
184
178
  CommercialSecuredApplicationResourceApplicationType$outboundSchema,
185
179
  status: ApplicationStatus$outboundSchema,
186
- associatedBrokerEmail: z.string().optional(),
187
180
  createdAt: z.string().optional(),
188
181
  updatedAt: z.string().optional(),
189
182
  });
@@ -64,7 +64,7 @@ export type ConsumerSecuredApplicationPayloadAttributes = {
64
64
  /**
65
65
  * Email address of the broker to be associated with this application.
66
66
  */
67
- associatedBrokerEmail?: string | undefined;
67
+ associatedBrokerEmail: string;
68
68
  };
69
69
 
70
70
  export type ConsumerSecuredApplicationPayload = {
@@ -134,13 +134,13 @@ export const ConsumerSecuredApplicationPayloadAttributes$inboundSchema:
134
134
  > = z.object({
135
135
  applicationType:
136
136
  ConsumerSecuredApplicationPayloadApplicationType$inboundSchema,
137
- associatedBrokerEmail: z.string().optional(),
137
+ associatedBrokerEmail: z.string(),
138
138
  });
139
139
 
140
140
  /** @internal */
141
141
  export type ConsumerSecuredApplicationPayloadAttributes$Outbound = {
142
142
  applicationType: string;
143
- associatedBrokerEmail?: string | undefined;
143
+ associatedBrokerEmail: string;
144
144
  };
145
145
 
146
146
  /** @internal */
@@ -152,7 +152,7 @@ export const ConsumerSecuredApplicationPayloadAttributes$outboundSchema:
152
152
  > = z.object({
153
153
  applicationType:
154
154
  ConsumerSecuredApplicationPayloadApplicationType$outboundSchema,
155
- associatedBrokerEmail: z.string().optional(),
155
+ associatedBrokerEmail: z.string(),
156
156
  });
157
157
 
158
158
  /**
@@ -52,7 +52,7 @@ export type ConsumerSecuredApplicationResourceAttributes = {
52
52
  /**
53
53
  * Full identifier of the application. Not visible within the web application.
54
54
  */
55
- id: string;
55
+ id?: string | undefined;
56
56
  /**
57
57
  * Human readable & easily communicated identifier of the application. Visible within the web application.
58
58
  */
@@ -65,10 +65,6 @@ export type ConsumerSecuredApplicationResourceAttributes = {
65
65
  * Current status, must be 'workshop' for new applications
66
66
  */
67
67
  status: ApplicationStatus;
68
- /**
69
- * Email address of the broker to be associated with this application.
70
- */
71
- associatedBrokerEmail?: string | undefined;
72
68
  /**
73
69
  * Creation timestamp
74
70
  */
@@ -151,23 +147,21 @@ export const ConsumerSecuredApplicationResourceAttributes$inboundSchema:
151
147
  z.ZodTypeDef,
152
148
  unknown
153
149
  > = z.object({
154
- id: z.string(),
150
+ id: z.string().optional(),
155
151
  humanId: z.string(),
156
152
  applicationType:
157
153
  ConsumerSecuredApplicationResourceApplicationType$inboundSchema,
158
154
  status: ApplicationStatus$inboundSchema,
159
- associatedBrokerEmail: z.string().optional(),
160
155
  createdAt: z.string().optional(),
161
156
  updatedAt: z.string().optional(),
162
157
  });
163
158
 
164
159
  /** @internal */
165
160
  export type ConsumerSecuredApplicationResourceAttributes$Outbound = {
166
- id: string;
161
+ id?: string | undefined;
167
162
  humanId: string;
168
163
  applicationType: string;
169
164
  status: string;
170
- associatedBrokerEmail?: string | undefined;
171
165
  createdAt?: string | undefined;
172
166
  updatedAt?: string | undefined;
173
167
  };
@@ -179,12 +173,11 @@ export const ConsumerSecuredApplicationResourceAttributes$outboundSchema:
179
173
  z.ZodTypeDef,
180
174
  ConsumerSecuredApplicationResourceAttributes
181
175
  > = z.object({
182
- id: z.string(),
176
+ id: z.string().optional(),
183
177
  humanId: z.string(),
184
178
  applicationType:
185
179
  ConsumerSecuredApplicationResourceApplicationType$outboundSchema,
186
180
  status: ApplicationStatus$outboundSchema,
187
- associatedBrokerEmail: z.string().optional(),
188
181
  createdAt: z.string().optional(),
189
182
  updatedAt: z.string().optional(),
190
183
  });
@@ -52,7 +52,7 @@ export type ConsumerSecuredLoanAssetAttributesRegistrationState = ClosedEnum<
52
52
  * The asset to be obtained by the customer, using the proposed loan financing.
53
53
  */
54
54
  export type ConsumerSecuredLoanAssetAttributes = {
55
- id: string;
55
+ id?: string | undefined;
56
56
  /**
57
57
  * Current age of asset as number (integer) of years
58
58
  */
@@ -205,7 +205,7 @@ export const ConsumerSecuredLoanAssetAttributes$inboundSchema: z.ZodType<
205
205
  z.ZodTypeDef,
206
206
  unknown
207
207
  > = z.object({
208
- id: z.string(),
208
+ id: z.string().optional(),
209
209
  ageOfAsset: z.number().int(),
210
210
  ageOfAssetAtEnd: z.number().int(),
211
211
  condition: ConsumerSecuredLoanAssetAttributesCondition$inboundSchema,
@@ -236,7 +236,7 @@ export const ConsumerSecuredLoanAssetAttributes$inboundSchema: z.ZodType<
236
236
 
237
237
  /** @internal */
238
238
  export type ConsumerSecuredLoanAssetAttributes$Outbound = {
239
- id: string;
239
+ id?: string | undefined;
240
240
  ageOfAsset: number;
241
241
  ageOfAssetAtEnd: number;
242
242
  condition: string;
@@ -269,7 +269,7 @@ export const ConsumerSecuredLoanAssetAttributes$outboundSchema: z.ZodType<
269
269
  z.ZodTypeDef,
270
270
  ConsumerSecuredLoanAssetAttributes
271
271
  > = z.object({
272
- id: z.string(),
272
+ id: z.string().optional(),
273
273
  ageOfAsset: z.number().int(),
274
274
  ageOfAssetAtEnd: z.number().int(),
275
275
  condition: ConsumerSecuredLoanAssetAttributesCondition$outboundSchema,
@@ -21,7 +21,7 @@ import {
21
21
  * A customer of the proposed financing
22
22
  */
23
23
  export type CustomerAttributes = {
24
- id: string;
24
+ id?: string | undefined;
25
25
  /**
26
26
  * Title of the customer
27
27
  */
@@ -70,7 +70,7 @@ export const CustomerAttributes$inboundSchema: z.ZodType<
70
70
  z.ZodTypeDef,
71
71
  unknown
72
72
  > = z.object({
73
- id: z.string(),
73
+ id: z.string().optional(),
74
74
  title: CustomerTitle$inboundSchema,
75
75
  firstName: z.string(),
76
76
  middleNames: z.string().optional(),
@@ -85,7 +85,7 @@ export const CustomerAttributes$inboundSchema: z.ZodType<
85
85
 
86
86
  /** @internal */
87
87
  export type CustomerAttributes$Outbound = {
88
- id: string;
88
+ id?: string | undefined;
89
89
  title: string;
90
90
  firstName: string;
91
91
  middleNames?: string | undefined;
@@ -104,7 +104,7 @@ export const CustomerAttributes$outboundSchema: z.ZodType<
104
104
  z.ZodTypeDef,
105
105
  CustomerAttributes
106
106
  > = z.object({
107
- id: z.string(),
107
+ id: z.string().optional(),
108
108
  title: CustomerTitle$outboundSchema,
109
109
  firstName: z.string(),
110
110
  middleNames: z.string().optional(),
@@ -8,7 +8,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
8
8
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
9
 
10
10
  export type EntityAttributes = {
11
- id: string;
11
+ id?: string | undefined;
12
12
  entityName: string;
13
13
  abn: string;
14
14
  turnover?: number | undefined;
@@ -23,7 +23,7 @@ export const EntityAttributes$inboundSchema: z.ZodType<
23
23
  z.ZodTypeDef,
24
24
  unknown
25
25
  > = z.object({
26
- id: z.string(),
26
+ id: z.string().optional(),
27
27
  entityName: z.string(),
28
28
  abn: z.string(),
29
29
  turnover: z.number().int().optional(),
@@ -34,7 +34,7 @@ export const EntityAttributes$inboundSchema: z.ZodType<
34
34
 
35
35
  /** @internal */
36
36
  export type EntityAttributes$Outbound = {
37
- id: string;
37
+ id?: string | undefined;
38
38
  entityName: string;
39
39
  abn: string;
40
40
  turnover?: number | undefined;
@@ -49,7 +49,7 @@ export const EntityAttributes$outboundSchema: z.ZodType<
49
49
  z.ZodTypeDef,
50
50
  EntityAttributes
51
51
  > = z.object({
52
- id: z.string(),
52
+ id: z.string().optional(),
53
53
  entityName: z.string(),
54
54
  abn: z.string(),
55
55
  turnover: z.number().int().optional(),
@@ -21,7 +21,7 @@ import {
21
21
  * Loan details model
22
22
  */
23
23
  export type LoanDetailsAttributes = {
24
- id: string;
24
+ id?: string | undefined;
25
25
  /**
26
26
  * Number of repayments as integer
27
27
  */
@@ -94,7 +94,7 @@ export const LoanDetailsAttributes$inboundSchema: z.ZodType<
94
94
  z.ZodTypeDef,
95
95
  unknown
96
96
  > = z.object({
97
- id: z.string(),
97
+ id: z.string().optional(),
98
98
  repayments: z.number().int().optional(),
99
99
  repaymentFrequency: FrequencyType$inboundSchema.optional(),
100
100
  repaymentStructure: RepaymentStructure$inboundSchema.optional(),
@@ -115,7 +115,7 @@ export const LoanDetailsAttributes$inboundSchema: z.ZodType<
115
115
 
116
116
  /** @internal */
117
117
  export type LoanDetailsAttributes$Outbound = {
118
- id: string;
118
+ id?: string | undefined;
119
119
  repayments?: number | undefined;
120
120
  repaymentFrequency?: string | undefined;
121
121
  repaymentStructure?: string | undefined;
@@ -140,7 +140,7 @@ export const LoanDetailsAttributes$outboundSchema: z.ZodType<
140
140
  z.ZodTypeDef,
141
141
  LoanDetailsAttributes
142
142
  > = z.object({
143
- id: z.string(),
143
+ id: z.string().optional(),
144
144
  repayments: z.number().int().optional(),
145
145
  repaymentFrequency: FrequencyType$outboundSchema.optional(),
146
146
  repaymentStructure: RepaymentStructure$outboundSchema.optional(),
@@ -13,7 +13,7 @@ import {
13
13
  } from "./documenttype.js";
14
14
 
15
15
  export type SupportingDocumentAttributes = {
16
- id: string;
16
+ id?: string | undefined;
17
17
  /**
18
18
  * Must include the extension, e.g: 'Privacy agreement.pdf'
19
19
  */
@@ -30,14 +30,14 @@ export const SupportingDocumentAttributes$inboundSchema: z.ZodType<
30
30
  z.ZodTypeDef,
31
31
  unknown
32
32
  > = z.object({
33
- id: z.string(),
33
+ id: z.string().optional(),
34
34
  filename: z.string(),
35
35
  documentType: DocumentType$inboundSchema,
36
36
  });
37
37
 
38
38
  /** @internal */
39
39
  export type SupportingDocumentAttributes$Outbound = {
40
- id: string;
40
+ id?: string | undefined;
41
41
  filename: string;
42
42
  documentType: string;
43
43
  };
@@ -48,7 +48,7 @@ export const SupportingDocumentAttributes$outboundSchema: z.ZodType<
48
48
  z.ZodTypeDef,
49
49
  SupportingDocumentAttributes
50
50
  > = z.object({
51
- id: z.string(),
51
+ id: z.string().optional(),
52
52
  filename: z.string(),
53
53
  documentType: DocumentType$outboundSchema,
54
54
  });