@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
@@ -6,6 +6,11 @@ import * as z from "zod";
6
6
  import { safeParse } from "../../lib/schemas.js";
7
7
  import { Result as SafeParseResult } from "../../types/fp.js";
8
8
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
+ import {
10
+ AustralianStatesAndTerritories,
11
+ AustralianStatesAndTerritories$inboundSchema,
12
+ AustralianStatesAndTerritories$outboundSchema,
13
+ } from "./australianstatesandterritories.js";
9
14
  import {
10
15
  CustomerIDType,
11
16
  CustomerIDType$inboundSchema,
@@ -71,6 +76,10 @@ export type CustomerAttributes = {
71
76
  * Type of ID, either drivers' license or passport
72
77
  */
73
78
  idType?: CustomerIDType | undefined;
79
+ /**
80
+ * THe state in which the ID was issued, currently limited to AUS states.
81
+ */
82
+ idState?: AustralianStatesAndTerritories | undefined;
74
83
  /**
75
84
  * Number of the ID
76
85
  */
@@ -107,6 +116,7 @@ export const CustomerAttributes$inboundSchema: z.ZodType<
107
116
  dateOfBirth: z.string(),
108
117
  idExpiryDate: z.string(),
109
118
  idType: CustomerIDType$inboundSchema.optional(),
119
+ idState: AustralianStatesAndTerritories$inboundSchema.optional(),
110
120
  idNumber: z.string().optional(),
111
121
  emailAddresses: z.array(z.string()).optional(),
112
122
  phoneNumbers: z.array(z.string()).optional(),
@@ -127,6 +137,7 @@ export type CustomerAttributes$Outbound = {
127
137
  dateOfBirth: string;
128
138
  idExpiryDate: string;
129
139
  idType?: string | undefined;
140
+ idState?: string | undefined;
130
141
  idNumber?: string | undefined;
131
142
  emailAddresses?: Array<string> | undefined;
132
143
  phoneNumbers?: Array<string> | undefined;
@@ -151,6 +162,7 @@ export const CustomerAttributes$outboundSchema: z.ZodType<
151
162
  dateOfBirth: z.string(),
152
163
  idExpiryDate: z.string(),
153
164
  idType: CustomerIDType$outboundSchema.optional(),
165
+ idState: AustralianStatesAndTerritories$outboundSchema.optional(),
154
166
  idNumber: z.string().optional(),
155
167
  emailAddresses: z.array(z.string()).optional(),
156
168
  phoneNumbers: z.array(z.string()).optional(),
@@ -25,22 +25,22 @@ export const ForbiddenErrorStatus = {
25
25
  } as const;
26
26
  export type ForbiddenErrorStatus = ClosedEnum<typeof ForbiddenErrorStatus>;
27
27
 
28
- export const ForbiddenErrorCode = {
28
+ export const Code = {
29
29
  Unauthorised: "Unauthorised",
30
30
  } as const;
31
- export type ForbiddenErrorCode = ClosedEnum<typeof ForbiddenErrorCode>;
31
+ export type Code = ClosedEnum<typeof Code>;
32
32
 
33
- export const ForbiddenErrorTitle = {
33
+ export const Title = {
34
34
  Unauthorised: "Unauthorised",
35
35
  } as const;
36
- export type ForbiddenErrorTitle = ClosedEnum<typeof ForbiddenErrorTitle>;
36
+ export type Title = ClosedEnum<typeof Title>;
37
37
 
38
38
  export type ForbiddenError = {
39
39
  id?: string | undefined;
40
40
  links?: APIErrorLinks | undefined;
41
41
  status: ForbiddenErrorStatus;
42
- code: ForbiddenErrorCode;
43
- title: ForbiddenErrorTitle;
42
+ code: Code;
43
+ title: Title;
44
44
  detail: string;
45
45
  /**
46
46
  * An object describing the source of the error from the request
@@ -71,45 +71,43 @@ export namespace ForbiddenErrorStatus$ {
71
71
  }
72
72
 
73
73
  /** @internal */
74
- export const ForbiddenErrorCode$inboundSchema: z.ZodNativeEnum<
75
- typeof ForbiddenErrorCode
76
- > = z.nativeEnum(ForbiddenErrorCode);
74
+ export const Code$inboundSchema: z.ZodNativeEnum<typeof Code> = z.nativeEnum(
75
+ Code,
76
+ );
77
77
 
78
78
  /** @internal */
79
- export const ForbiddenErrorCode$outboundSchema: z.ZodNativeEnum<
80
- typeof ForbiddenErrorCode
81
- > = ForbiddenErrorCode$inboundSchema;
79
+ export const Code$outboundSchema: z.ZodNativeEnum<typeof Code> =
80
+ Code$inboundSchema;
82
81
 
83
82
  /**
84
83
  * @internal
85
84
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
86
85
  */
87
- export namespace ForbiddenErrorCode$ {
88
- /** @deprecated use `ForbiddenErrorCode$inboundSchema` instead. */
89
- export const inboundSchema = ForbiddenErrorCode$inboundSchema;
90
- /** @deprecated use `ForbiddenErrorCode$outboundSchema` instead. */
91
- export const outboundSchema = ForbiddenErrorCode$outboundSchema;
86
+ export namespace Code$ {
87
+ /** @deprecated use `Code$inboundSchema` instead. */
88
+ export const inboundSchema = Code$inboundSchema;
89
+ /** @deprecated use `Code$outboundSchema` instead. */
90
+ export const outboundSchema = Code$outboundSchema;
92
91
  }
93
92
 
94
93
  /** @internal */
95
- export const ForbiddenErrorTitle$inboundSchema: z.ZodNativeEnum<
96
- typeof ForbiddenErrorTitle
97
- > = z.nativeEnum(ForbiddenErrorTitle);
94
+ export const Title$inboundSchema: z.ZodNativeEnum<typeof Title> = z.nativeEnum(
95
+ Title,
96
+ );
98
97
 
99
98
  /** @internal */
100
- export const ForbiddenErrorTitle$outboundSchema: z.ZodNativeEnum<
101
- typeof ForbiddenErrorTitle
102
- > = ForbiddenErrorTitle$inboundSchema;
99
+ export const Title$outboundSchema: z.ZodNativeEnum<typeof Title> =
100
+ Title$inboundSchema;
103
101
 
104
102
  /**
105
103
  * @internal
106
104
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
107
105
  */
108
- export namespace ForbiddenErrorTitle$ {
109
- /** @deprecated use `ForbiddenErrorTitle$inboundSchema` instead. */
110
- export const inboundSchema = ForbiddenErrorTitle$inboundSchema;
111
- /** @deprecated use `ForbiddenErrorTitle$outboundSchema` instead. */
112
- export const outboundSchema = ForbiddenErrorTitle$outboundSchema;
106
+ export namespace Title$ {
107
+ /** @deprecated use `Title$inboundSchema` instead. */
108
+ export const inboundSchema = Title$inboundSchema;
109
+ /** @deprecated use `Title$outboundSchema` instead. */
110
+ export const outboundSchema = Title$outboundSchema;
113
111
  }
114
112
 
115
113
  /** @internal */
@@ -121,8 +119,8 @@ export const ForbiddenError$inboundSchema: z.ZodType<
121
119
  id: z.string().optional(),
122
120
  links: APIErrorLinks$inboundSchema.optional(),
123
121
  status: ForbiddenErrorStatus$inboundSchema,
124
- code: ForbiddenErrorCode$inboundSchema,
125
- title: ForbiddenErrorTitle$inboundSchema,
122
+ code: Code$inboundSchema,
123
+ title: Title$inboundSchema,
126
124
  detail: z.string(),
127
125
  source: ErrorSource$inboundSchema.optional(),
128
126
  meta: z.record(z.any()).optional(),
@@ -149,8 +147,8 @@ export const ForbiddenError$outboundSchema: z.ZodType<
149
147
  id: z.string().optional(),
150
148
  links: APIErrorLinks$outboundSchema.optional(),
151
149
  status: ForbiddenErrorStatus$outboundSchema,
152
- code: ForbiddenErrorCode$outboundSchema,
153
- title: ForbiddenErrorTitle$outboundSchema,
150
+ code: Code$outboundSchema,
151
+ title: Title$outboundSchema,
154
152
  detail: z.string(),
155
153
  source: ErrorSource$outboundSchema.optional(),
156
154
  meta: z.record(z.any()).optional(),
@@ -37,12 +37,12 @@ export type LoanAmount = MonetaryQuantity | string;
37
37
  /**
38
38
  * Brokerage quantity as either BrokerageQuantity model (preferred) or floating point dollars as string. The latter will be deprecated. Only applicable to commercialSecured loans.
39
39
  */
40
- export type Brokerage = PercentageQuantity | MonetaryQuantity | string;
40
+ export type Brokerage = MonetaryQuantity | PercentageQuantity | string;
41
41
 
42
42
  /**
43
43
  * Balloon quantity as either BalloonQuantity model (preferred) or dollar integer as int32 (the latter will be deprecated)
44
44
  */
45
- export type Balloon = PercentageQuantity | MonetaryQuantity | number;
45
+ export type Balloon = MonetaryQuantity | PercentageQuantity | number;
46
46
 
47
47
  /**
48
48
  * Either MonetaryQuantity model (preferred) or floating point AUD dollars as string. The latter will be deprecated.
@@ -106,7 +106,7 @@ export type LoanDetailsAttributes = {
106
106
  /**
107
107
  * Brokerage quantity as either BrokerageQuantity model (preferred) or floating point dollars as string. The latter will be deprecated. Only applicable to commercialSecured loans.
108
108
  */
109
- brokerage?: PercentageQuantity | MonetaryQuantity | string | undefined;
109
+ brokerage?: MonetaryQuantity | PercentageQuantity | string | undefined;
110
110
  /**
111
111
  * Broker amount as floating point dollars string. Will be deprecated in the future, use brokerage instead. Only applicable to commercialSecured loans.
112
112
  *
@@ -116,7 +116,7 @@ export type LoanDetailsAttributes = {
116
116
  /**
117
117
  * Balloon quantity as either BalloonQuantity model (preferred) or dollar integer as int32 (the latter will be deprecated)
118
118
  */
119
- balloon?: PercentageQuantity | MonetaryQuantity | number | undefined;
119
+ balloon?: MonetaryQuantity | PercentageQuantity | number | undefined;
120
120
  /**
121
121
  * Balloon amount, floating point AUD dollars as string. Will be deprecated in the future, use balloon instead
122
122
  *
@@ -199,15 +199,15 @@ export const Brokerage$inboundSchema: z.ZodType<
199
199
  z.ZodTypeDef,
200
200
  unknown
201
201
  > = z.union([
202
- PercentageQuantity$inboundSchema,
203
202
  MonetaryQuantity$inboundSchema,
203
+ PercentageQuantity$inboundSchema,
204
204
  z.string(),
205
205
  ]);
206
206
 
207
207
  /** @internal */
208
208
  export type Brokerage$Outbound =
209
- | PercentageQuantity$Outbound
210
209
  | MonetaryQuantity$Outbound
210
+ | PercentageQuantity$Outbound
211
211
  | string;
212
212
 
213
213
  /** @internal */
@@ -216,8 +216,8 @@ export const Brokerage$outboundSchema: z.ZodType<
216
216
  z.ZodTypeDef,
217
217
  Brokerage
218
218
  > = z.union([
219
- PercentageQuantity$outboundSchema,
220
219
  MonetaryQuantity$outboundSchema,
220
+ PercentageQuantity$outboundSchema,
221
221
  z.string(),
222
222
  ]);
223
223
 
@@ -251,15 +251,15 @@ export function brokerageFromJSON(
251
251
  /** @internal */
252
252
  export const Balloon$inboundSchema: z.ZodType<Balloon, z.ZodTypeDef, unknown> =
253
253
  z.union([
254
- PercentageQuantity$inboundSchema,
255
254
  MonetaryQuantity$inboundSchema,
255
+ PercentageQuantity$inboundSchema,
256
256
  z.number().int(),
257
257
  ]);
258
258
 
259
259
  /** @internal */
260
260
  export type Balloon$Outbound =
261
- | PercentageQuantity$Outbound
262
261
  | MonetaryQuantity$Outbound
262
+ | PercentageQuantity$Outbound
263
263
  | number;
264
264
 
265
265
  /** @internal */
@@ -268,8 +268,8 @@ export const Balloon$outboundSchema: z.ZodType<
268
268
  z.ZodTypeDef,
269
269
  Balloon
270
270
  > = z.union([
271
- PercentageQuantity$outboundSchema,
272
271
  MonetaryQuantity$outboundSchema,
272
+ PercentageQuantity$outboundSchema,
273
273
  z.number().int(),
274
274
  ]);
275
275
 
@@ -563,14 +563,14 @@ export const LoanDetailsAttributes$inboundSchema: z.ZodType<
563
563
  purpose: z.string().optional(),
564
564
  term: z.number().int().optional(),
565
565
  brokerage: z.union([
566
- PercentageQuantity$inboundSchema,
567
566
  MonetaryQuantity$inboundSchema,
567
+ PercentageQuantity$inboundSchema,
568
568
  z.string(),
569
569
  ]).optional(),
570
570
  brokerageAmount: z.string().optional(),
571
571
  balloon: z.union([
572
- PercentageQuantity$inboundSchema,
573
572
  MonetaryQuantity$inboundSchema,
573
+ PercentageQuantity$inboundSchema,
574
574
  z.number().int(),
575
575
  ]).optional(),
576
576
  balloonAmount: z.string().optional(),
@@ -594,14 +594,14 @@ export type LoanDetailsAttributes$Outbound = {
594
594
  purpose?: string | undefined;
595
595
  term?: number | undefined;
596
596
  brokerage?:
597
- | PercentageQuantity$Outbound
598
597
  | MonetaryQuantity$Outbound
598
+ | PercentageQuantity$Outbound
599
599
  | string
600
600
  | undefined;
601
601
  brokerageAmount?: string | undefined;
602
602
  balloon?:
603
- | PercentageQuantity$Outbound
604
603
  | MonetaryQuantity$Outbound
604
+ | PercentageQuantity$Outbound
605
605
  | number
606
606
  | undefined;
607
607
  balloonAmount?: string | undefined;
@@ -627,14 +627,14 @@ export const LoanDetailsAttributes$outboundSchema: z.ZodType<
627
627
  purpose: z.string().optional(),
628
628
  term: z.number().int().optional(),
629
629
  brokerage: z.union([
630
- PercentageQuantity$outboundSchema,
631
630
  MonetaryQuantity$outboundSchema,
631
+ PercentageQuantity$outboundSchema,
632
632
  z.string(),
633
633
  ]).optional(),
634
634
  brokerageAmount: z.string().optional(),
635
635
  balloon: z.union([
636
- PercentageQuantity$outboundSchema,
637
636
  MonetaryQuantity$outboundSchema,
637
+ PercentageQuantity$outboundSchema,
638
638
  z.number().int(),
639
639
  ]).optional(),
640
640
  balloonAmount: z.string().optional(),
@@ -21,7 +21,7 @@ export type SupportingDocumentRelationshipsType = ClosedEnum<
21
21
  typeof SupportingDocumentRelationshipsType
22
22
  >;
23
23
 
24
- export type Data = {
24
+ export type SupportingDocumentRelationshipsData = {
25
25
  type: SupportingDocumentRelationshipsType;
26
26
  id: string;
27
27
  };
@@ -30,7 +30,7 @@ export type Data = {
30
30
  * Reference to the ID of the customer record this support document relates to.
31
31
  */
32
32
  export type Customer = {
33
- data: Data;
33
+ data: SupportingDocumentRelationshipsData;
34
34
  links?: { [k: string]: LinkObject } | undefined;
35
35
  meta?: { [k: string]: any } | undefined;
36
36
  };
@@ -42,7 +42,7 @@ export type SupportingDocumentRelationshipsAssetType = ClosedEnum<
42
42
  typeof SupportingDocumentRelationshipsAssetType
43
43
  >;
44
44
 
45
- export type SupportingDocumentRelationshipsData = {
45
+ export type SupportingDocumentRelationshipsAssetData = {
46
46
  type: SupportingDocumentRelationshipsAssetType;
47
47
  id: string;
48
48
  };
@@ -50,8 +50,8 @@ export type SupportingDocumentRelationshipsData = {
50
50
  /**
51
51
  * Reference to the ID of the asset record this support document relates to.
52
52
  */
53
- export type Asset = {
54
- data: SupportingDocumentRelationshipsData;
53
+ export type SupportingDocumentRelationshipsAsset = {
54
+ data: SupportingDocumentRelationshipsAssetData;
55
55
  links?: { [k: string]: LinkObject } | undefined;
56
56
  meta?: { [k: string]: any } | undefined;
57
57
  };
@@ -111,7 +111,7 @@ export type SupportingDocumentRelationships = {
111
111
  /**
112
112
  * Reference to the ID of the asset record this support document relates to.
113
113
  */
114
- asset?: Asset | undefined;
114
+ asset?: SupportingDocumentRelationshipsAsset | undefined;
115
115
  /**
116
116
  * Reference to the ID of the entity record this support document relates to. One of: customer,asset or entity relationship must be provided.
117
117
  */
@@ -146,49 +146,64 @@ export namespace SupportingDocumentRelationshipsType$ {
146
146
  }
147
147
 
148
148
  /** @internal */
149
- export const Data$inboundSchema: z.ZodType<Data, z.ZodTypeDef, unknown> = z
150
- .object({
151
- type: SupportingDocumentRelationshipsType$inboundSchema,
152
- id: z.string(),
153
- });
149
+ export const SupportingDocumentRelationshipsData$inboundSchema: z.ZodType<
150
+ SupportingDocumentRelationshipsData,
151
+ z.ZodTypeDef,
152
+ unknown
153
+ > = z.object({
154
+ type: SupportingDocumentRelationshipsType$inboundSchema,
155
+ id: z.string(),
156
+ });
154
157
 
155
158
  /** @internal */
156
- export type Data$Outbound = {
159
+ export type SupportingDocumentRelationshipsData$Outbound = {
157
160
  type: string;
158
161
  id: string;
159
162
  };
160
163
 
161
164
  /** @internal */
162
- export const Data$outboundSchema: z.ZodType<Data$Outbound, z.ZodTypeDef, Data> =
163
- z.object({
164
- type: SupportingDocumentRelationshipsType$outboundSchema,
165
- id: z.string(),
166
- });
165
+ export const SupportingDocumentRelationshipsData$outboundSchema: z.ZodType<
166
+ SupportingDocumentRelationshipsData$Outbound,
167
+ z.ZodTypeDef,
168
+ SupportingDocumentRelationshipsData
169
+ > = z.object({
170
+ type: SupportingDocumentRelationshipsType$outboundSchema,
171
+ id: z.string(),
172
+ });
167
173
 
168
174
  /**
169
175
  * @internal
170
176
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
171
177
  */
172
- export namespace Data$ {
173
- /** @deprecated use `Data$inboundSchema` instead. */
174
- export const inboundSchema = Data$inboundSchema;
175
- /** @deprecated use `Data$outboundSchema` instead. */
176
- export const outboundSchema = Data$outboundSchema;
177
- /** @deprecated use `Data$Outbound` instead. */
178
- export type Outbound = Data$Outbound;
178
+ export namespace SupportingDocumentRelationshipsData$ {
179
+ /** @deprecated use `SupportingDocumentRelationshipsData$inboundSchema` instead. */
180
+ export const inboundSchema =
181
+ SupportingDocumentRelationshipsData$inboundSchema;
182
+ /** @deprecated use `SupportingDocumentRelationshipsData$outboundSchema` instead. */
183
+ export const outboundSchema =
184
+ SupportingDocumentRelationshipsData$outboundSchema;
185
+ /** @deprecated use `SupportingDocumentRelationshipsData$Outbound` instead. */
186
+ export type Outbound = SupportingDocumentRelationshipsData$Outbound;
179
187
  }
180
188
 
181
- export function dataToJSON(data: Data): string {
182
- return JSON.stringify(Data$outboundSchema.parse(data));
189
+ export function supportingDocumentRelationshipsDataToJSON(
190
+ supportingDocumentRelationshipsData: SupportingDocumentRelationshipsData,
191
+ ): string {
192
+ return JSON.stringify(
193
+ SupportingDocumentRelationshipsData$outboundSchema.parse(
194
+ supportingDocumentRelationshipsData,
195
+ ),
196
+ );
183
197
  }
184
198
 
185
- export function dataFromJSON(
199
+ export function supportingDocumentRelationshipsDataFromJSON(
186
200
  jsonString: string,
187
- ): SafeParseResult<Data, SDKValidationError> {
201
+ ): SafeParseResult<SupportingDocumentRelationshipsData, SDKValidationError> {
188
202
  return safeParse(
189
203
  jsonString,
190
- (x) => Data$inboundSchema.parse(JSON.parse(x)),
191
- `Failed to parse 'Data' from JSON`,
204
+ (x) =>
205
+ SupportingDocumentRelationshipsData$inboundSchema.parse(JSON.parse(x)),
206
+ `Failed to parse 'SupportingDocumentRelationshipsData' from JSON`,
192
207
  );
193
208
  }
194
209
 
@@ -198,14 +213,14 @@ export const Customer$inboundSchema: z.ZodType<
198
213
  z.ZodTypeDef,
199
214
  unknown
200
215
  > = z.object({
201
- data: z.lazy(() => Data$inboundSchema),
216
+ data: z.lazy(() => SupportingDocumentRelationshipsData$inboundSchema),
202
217
  links: z.record(LinkObject$inboundSchema).optional(),
203
218
  meta: z.record(z.any()).optional(),
204
219
  });
205
220
 
206
221
  /** @internal */
207
222
  export type Customer$Outbound = {
208
- data: Data$Outbound;
223
+ data: SupportingDocumentRelationshipsData$Outbound;
209
224
  links?: { [k: string]: LinkObject$Outbound } | undefined;
210
225
  meta?: { [k: string]: any } | undefined;
211
226
  };
@@ -216,7 +231,7 @@ export const Customer$outboundSchema: z.ZodType<
216
231
  z.ZodTypeDef,
217
232
  Customer
218
233
  > = z.object({
219
- data: z.lazy(() => Data$outboundSchema),
234
+ data: z.lazy(() => SupportingDocumentRelationshipsData$outboundSchema),
220
235
  links: z.record(LinkObject$outboundSchema).optional(),
221
236
  meta: z.record(z.any()).optional(),
222
237
  });
@@ -272,8 +287,8 @@ export namespace SupportingDocumentRelationshipsAssetType$ {
272
287
  }
273
288
 
274
289
  /** @internal */
275
- export const SupportingDocumentRelationshipsData$inboundSchema: z.ZodType<
276
- SupportingDocumentRelationshipsData,
290
+ export const SupportingDocumentRelationshipsAssetData$inboundSchema: z.ZodType<
291
+ SupportingDocumentRelationshipsAssetData,
277
292
  z.ZodTypeDef,
278
293
  unknown
279
294
  > = z.object({
@@ -282,16 +297,16 @@ export const SupportingDocumentRelationshipsData$inboundSchema: z.ZodType<
282
297
  });
283
298
 
284
299
  /** @internal */
285
- export type SupportingDocumentRelationshipsData$Outbound = {
300
+ export type SupportingDocumentRelationshipsAssetData$Outbound = {
286
301
  type: string;
287
302
  id: string;
288
303
  };
289
304
 
290
305
  /** @internal */
291
- export const SupportingDocumentRelationshipsData$outboundSchema: z.ZodType<
292
- SupportingDocumentRelationshipsData$Outbound,
306
+ export const SupportingDocumentRelationshipsAssetData$outboundSchema: z.ZodType<
307
+ SupportingDocumentRelationshipsAssetData$Outbound,
293
308
  z.ZodTypeDef,
294
- SupportingDocumentRelationshipsData
309
+ SupportingDocumentRelationshipsAssetData
295
310
  > = z.object({
296
311
  type: SupportingDocumentRelationshipsAssetType$outboundSchema,
297
312
  id: z.string(),
@@ -301,60 +316,69 @@ export const SupportingDocumentRelationshipsData$outboundSchema: z.ZodType<
301
316
  * @internal
302
317
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
303
318
  */
304
- export namespace SupportingDocumentRelationshipsData$ {
305
- /** @deprecated use `SupportingDocumentRelationshipsData$inboundSchema` instead. */
319
+ export namespace SupportingDocumentRelationshipsAssetData$ {
320
+ /** @deprecated use `SupportingDocumentRelationshipsAssetData$inboundSchema` instead. */
306
321
  export const inboundSchema =
307
- SupportingDocumentRelationshipsData$inboundSchema;
308
- /** @deprecated use `SupportingDocumentRelationshipsData$outboundSchema` instead. */
322
+ SupportingDocumentRelationshipsAssetData$inboundSchema;
323
+ /** @deprecated use `SupportingDocumentRelationshipsAssetData$outboundSchema` instead. */
309
324
  export const outboundSchema =
310
- SupportingDocumentRelationshipsData$outboundSchema;
311
- /** @deprecated use `SupportingDocumentRelationshipsData$Outbound` instead. */
312
- export type Outbound = SupportingDocumentRelationshipsData$Outbound;
325
+ SupportingDocumentRelationshipsAssetData$outboundSchema;
326
+ /** @deprecated use `SupportingDocumentRelationshipsAssetData$Outbound` instead. */
327
+ export type Outbound = SupportingDocumentRelationshipsAssetData$Outbound;
313
328
  }
314
329
 
315
- export function supportingDocumentRelationshipsDataToJSON(
316
- supportingDocumentRelationshipsData: SupportingDocumentRelationshipsData,
330
+ export function supportingDocumentRelationshipsAssetDataToJSON(
331
+ supportingDocumentRelationshipsAssetData:
332
+ SupportingDocumentRelationshipsAssetData,
317
333
  ): string {
318
334
  return JSON.stringify(
319
- SupportingDocumentRelationshipsData$outboundSchema.parse(
320
- supportingDocumentRelationshipsData,
335
+ SupportingDocumentRelationshipsAssetData$outboundSchema.parse(
336
+ supportingDocumentRelationshipsAssetData,
321
337
  ),
322
338
  );
323
339
  }
324
340
 
325
- export function supportingDocumentRelationshipsDataFromJSON(
341
+ export function supportingDocumentRelationshipsAssetDataFromJSON(
326
342
  jsonString: string,
327
- ): SafeParseResult<SupportingDocumentRelationshipsData, SDKValidationError> {
343
+ ): SafeParseResult<
344
+ SupportingDocumentRelationshipsAssetData,
345
+ SDKValidationError
346
+ > {
328
347
  return safeParse(
329
348
  jsonString,
330
349
  (x) =>
331
- SupportingDocumentRelationshipsData$inboundSchema.parse(JSON.parse(x)),
332
- `Failed to parse 'SupportingDocumentRelationshipsData' from JSON`,
350
+ SupportingDocumentRelationshipsAssetData$inboundSchema.parse(
351
+ JSON.parse(x),
352
+ ),
353
+ `Failed to parse 'SupportingDocumentRelationshipsAssetData' from JSON`,
333
354
  );
334
355
  }
335
356
 
336
357
  /** @internal */
337
- export const Asset$inboundSchema: z.ZodType<Asset, z.ZodTypeDef, unknown> = z
338
- .object({
339
- data: z.lazy(() => SupportingDocumentRelationshipsData$inboundSchema),
340
- links: z.record(LinkObject$inboundSchema).optional(),
341
- meta: z.record(z.any()).optional(),
342
- });
358
+ export const SupportingDocumentRelationshipsAsset$inboundSchema: z.ZodType<
359
+ SupportingDocumentRelationshipsAsset,
360
+ z.ZodTypeDef,
361
+ unknown
362
+ > = z.object({
363
+ data: z.lazy(() => SupportingDocumentRelationshipsAssetData$inboundSchema),
364
+ links: z.record(LinkObject$inboundSchema).optional(),
365
+ meta: z.record(z.any()).optional(),
366
+ });
343
367
 
344
368
  /** @internal */
345
- export type Asset$Outbound = {
346
- data: SupportingDocumentRelationshipsData$Outbound;
369
+ export type SupportingDocumentRelationshipsAsset$Outbound = {
370
+ data: SupportingDocumentRelationshipsAssetData$Outbound;
347
371
  links?: { [k: string]: LinkObject$Outbound } | undefined;
348
372
  meta?: { [k: string]: any } | undefined;
349
373
  };
350
374
 
351
375
  /** @internal */
352
- export const Asset$outboundSchema: z.ZodType<
353
- Asset$Outbound,
376
+ export const SupportingDocumentRelationshipsAsset$outboundSchema: z.ZodType<
377
+ SupportingDocumentRelationshipsAsset$Outbound,
354
378
  z.ZodTypeDef,
355
- Asset
379
+ SupportingDocumentRelationshipsAsset
356
380
  > = z.object({
357
- data: z.lazy(() => SupportingDocumentRelationshipsData$outboundSchema),
381
+ data: z.lazy(() => SupportingDocumentRelationshipsAssetData$outboundSchema),
358
382
  links: z.record(LinkObject$outboundSchema).optional(),
359
383
  meta: z.record(z.any()).optional(),
360
384
  });
@@ -363,26 +387,35 @@ export const Asset$outboundSchema: z.ZodType<
363
387
  * @internal
364
388
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
365
389
  */
366
- export namespace Asset$ {
367
- /** @deprecated use `Asset$inboundSchema` instead. */
368
- export const inboundSchema = Asset$inboundSchema;
369
- /** @deprecated use `Asset$outboundSchema` instead. */
370
- export const outboundSchema = Asset$outboundSchema;
371
- /** @deprecated use `Asset$Outbound` instead. */
372
- export type Outbound = Asset$Outbound;
390
+ export namespace SupportingDocumentRelationshipsAsset$ {
391
+ /** @deprecated use `SupportingDocumentRelationshipsAsset$inboundSchema` instead. */
392
+ export const inboundSchema =
393
+ SupportingDocumentRelationshipsAsset$inboundSchema;
394
+ /** @deprecated use `SupportingDocumentRelationshipsAsset$outboundSchema` instead. */
395
+ export const outboundSchema =
396
+ SupportingDocumentRelationshipsAsset$outboundSchema;
397
+ /** @deprecated use `SupportingDocumentRelationshipsAsset$Outbound` instead. */
398
+ export type Outbound = SupportingDocumentRelationshipsAsset$Outbound;
373
399
  }
374
400
 
375
- export function assetToJSON(asset: Asset): string {
376
- return JSON.stringify(Asset$outboundSchema.parse(asset));
401
+ export function supportingDocumentRelationshipsAssetToJSON(
402
+ supportingDocumentRelationshipsAsset: SupportingDocumentRelationshipsAsset,
403
+ ): string {
404
+ return JSON.stringify(
405
+ SupportingDocumentRelationshipsAsset$outboundSchema.parse(
406
+ supportingDocumentRelationshipsAsset,
407
+ ),
408
+ );
377
409
  }
378
410
 
379
- export function assetFromJSON(
411
+ export function supportingDocumentRelationshipsAssetFromJSON(
380
412
  jsonString: string,
381
- ): SafeParseResult<Asset, SDKValidationError> {
413
+ ): SafeParseResult<SupportingDocumentRelationshipsAsset, SDKValidationError> {
382
414
  return safeParse(
383
415
  jsonString,
384
- (x) => Asset$inboundSchema.parse(JSON.parse(x)),
385
- `Failed to parse 'Asset' from JSON`,
416
+ (x) =>
417
+ SupportingDocumentRelationshipsAsset$inboundSchema.parse(JSON.parse(x)),
418
+ `Failed to parse 'SupportingDocumentRelationshipsAsset' from JSON`,
386
419
  );
387
420
  }
388
421
 
@@ -769,7 +802,8 @@ export const SupportingDocumentRelationships$inboundSchema: z.ZodType<
769
802
  unknown
770
803
  > = z.object({
771
804
  customer: z.lazy(() => Customer$inboundSchema).optional(),
772
- asset: z.lazy(() => Asset$inboundSchema).optional(),
805
+ asset: z.lazy(() => SupportingDocumentRelationshipsAsset$inboundSchema)
806
+ .optional(),
773
807
  entity: z.lazy(() => Entity$inboundSchema).optional(),
774
808
  application: z.lazy(() => Application$inboundSchema),
775
809
  });
@@ -777,7 +811,7 @@ export const SupportingDocumentRelationships$inboundSchema: z.ZodType<
777
811
  /** @internal */
778
812
  export type SupportingDocumentRelationships$Outbound = {
779
813
  customer?: Customer$Outbound | undefined;
780
- asset?: Asset$Outbound | undefined;
814
+ asset?: SupportingDocumentRelationshipsAsset$Outbound | undefined;
781
815
  entity?: Entity$Outbound | undefined;
782
816
  application: Application$Outbound;
783
817
  };
@@ -789,7 +823,8 @@ export const SupportingDocumentRelationships$outboundSchema: z.ZodType<
789
823
  SupportingDocumentRelationships
790
824
  > = z.object({
791
825
  customer: z.lazy(() => Customer$outboundSchema).optional(),
792
- asset: z.lazy(() => Asset$outboundSchema).optional(),
826
+ asset: z.lazy(() => SupportingDocumentRelationshipsAsset$outboundSchema)
827
+ .optional(),
793
828
  entity: z.lazy(() => Entity$outboundSchema).optional(),
794
829
  application: z.lazy(() => Application$outboundSchema),
795
830
  });