@lendi/act-credit-decisions-transform 2.0.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 (204) hide show
  1. package/README.md +31 -0
  2. package/lib/index.d.ts +11 -0
  3. package/lib/index.js +28 -0
  4. package/lib/logger.d.ts +1 -0
  5. package/lib/logger.js +5 -0
  6. package/lib/schemas/application-workflow-event.json +240 -0
  7. package/lib/schemas/credit-report-retrieved-event.json +57 -0
  8. package/lib/schemas/public-applicant-event.json +910 -0
  9. package/lib/schemas/public-application-event.json +250 -0
  10. package/lib/schemas/public-asset-event.json +679 -0
  11. package/lib/schemas/public-asset-liability-relation-delete-event.json +74 -0
  12. package/lib/schemas/public-asset-liability-relation-event.json +73 -0
  13. package/lib/schemas/public-create-applicant-event.json +609 -0
  14. package/lib/schemas/public-delete-applicant-event.json +66 -0
  15. package/lib/schemas/public-delete-asset-event.json +53 -0
  16. package/lib/schemas/public-delete-income-event.json +55 -0
  17. package/lib/schemas/public-employment-delete-event.json +31 -0
  18. package/lib/schemas/public-employment-event.json +278 -0
  19. package/lib/schemas/public-expense-delete-event.json +41 -0
  20. package/lib/schemas/public-expense-event.json +133 -0
  21. package/lib/schemas/public-funding-position-event.json +419 -0
  22. package/lib/schemas/public-income-event.json +242 -0
  23. package/lib/schemas/public-liability-delete-event.json +37 -0
  24. package/lib/schemas/public-liability-event.json +262 -0
  25. package/lib/schemas/public-required-document-event.json +366 -0
  26. package/lib/schemas/public-update-applicant-event.json +606 -0
  27. package/lib/schemas/sf-opportunity-event-out.json +138 -0
  28. package/lib/transform-events/generate-asset-liability-link.d.ts +10 -0
  29. package/lib/transform-events/generate-asset-liability-link.js +29 -0
  30. package/lib/transform-events/generate-credit-report-rebuilt.d.ts +8 -0
  31. package/lib/transform-events/generate-credit-report-rebuilt.js +41 -0
  32. package/lib/transform-events/transform-applicant.d.ts +8 -0
  33. package/lib/transform-events/transform-applicant.js +180 -0
  34. package/lib/transform-events/transform-application-workflow.d.ts +8 -0
  35. package/lib/transform-events/transform-application-workflow.js +30 -0
  36. package/lib/transform-events/transform-application.d.ts +20 -0
  37. package/lib/transform-events/transform-application.js +67 -0
  38. package/lib/transform-events/transform-asset-address.d.ts +25 -0
  39. package/lib/transform-events/transform-asset-address.js +87 -0
  40. package/lib/transform-events/transform-asset.d.ts +58 -0
  41. package/lib/transform-events/transform-asset.js +337 -0
  42. package/lib/transform-events/transform-employment.d.ts +9 -0
  43. package/lib/transform-events/transform-employment.js +107 -0
  44. package/lib/transform-events/transform-expenses.d.ts +41 -0
  45. package/lib/transform-events/transform-expenses.js +121 -0
  46. package/lib/transform-events/transform-funding-position.d.ts +21 -0
  47. package/lib/transform-events/transform-funding-position.js +107 -0
  48. package/lib/transform-events/transform-income.d.ts +48 -0
  49. package/lib/transform-events/transform-income.js +260 -0
  50. package/lib/transform-events/transform-liability.d.ts +12 -0
  51. package/lib/transform-events/transform-liability.js +117 -0
  52. package/lib/transform-events/transform-percent-owned.d.ts +10 -0
  53. package/lib/transform-events/transform-percent-owned.js +22 -0
  54. package/lib/transform-events/transform-required-document.d.ts +67 -0
  55. package/lib/transform-events/transform-required-document.js +148 -0
  56. package/lib/types/enum-mappings/alieo-frequency.d.ts +15 -0
  57. package/lib/types/enum-mappings/alieo-frequency.js +25 -0
  58. package/lib/types/enum-mappings/applicant-gender.d.ts +6 -0
  59. package/lib/types/enum-mappings/applicant-gender.js +11 -0
  60. package/lib/types/enum-mappings/applicant-type.d.ts +6 -0
  61. package/lib/types/enum-mappings/applicant-type.js +10 -0
  62. package/lib/types/enum-mappings/asset-type.d.ts +3 -0
  63. package/lib/types/enum-mappings/asset-type.js +17 -0
  64. package/lib/types/enum-mappings/builder-type.d.ts +7 -0
  65. package/lib/types/enum-mappings/builder-type.js +9 -0
  66. package/lib/types/enum-mappings/company-structure.d.ts +7 -0
  67. package/lib/types/enum-mappings/company-structure.js +10 -0
  68. package/lib/types/enum-mappings/company-type.d.ts +7 -0
  69. package/lib/types/enum-mappings/company-type.js +11 -0
  70. package/lib/types/enum-mappings/construction-type.d.ts +7 -0
  71. package/lib/types/enum-mappings/construction-type.js +10 -0
  72. package/lib/types/enum-mappings/country-code.d.ts +7 -0
  73. package/lib/types/enum-mappings/country-code.js +246 -0
  74. package/lib/types/enum-mappings/employment-basis.d.ts +7 -0
  75. package/lib/types/enum-mappings/employment-basis.js +12 -0
  76. package/lib/types/enum-mappings/expense-frequency.d.ts +7 -0
  77. package/lib/types/enum-mappings/expense-frequency.js +11 -0
  78. package/lib/types/enum-mappings/funding-position.d.ts +18 -0
  79. package/lib/types/enum-mappings/funding-position.js +36 -0
  80. package/lib/types/enum-mappings/government-benefits.d.ts +7 -0
  81. package/lib/types/enum-mappings/government-benefits.js +10 -0
  82. package/lib/types/enum-mappings/guarantor-relationship-type.d.ts +3 -0
  83. package/lib/types/enum-mappings/guarantor-relationship-type.js +16 -0
  84. package/lib/types/enum-mappings/housing-status.d.ts +7 -0
  85. package/lib/types/enum-mappings/housing-status.js +15 -0
  86. package/lib/types/enum-mappings/income-type.d.ts +7 -0
  87. package/lib/types/enum-mappings/income-type.js +16 -0
  88. package/lib/types/enum-mappings/index.d.ts +27 -0
  89. package/lib/types/enum-mappings/index.js +43 -0
  90. package/lib/types/enum-mappings/liability-payment-type.d.ts +7 -0
  91. package/lib/types/enum-mappings/liability-payment-type.js +9 -0
  92. package/lib/types/enum-mappings/liability-type.d.ts +7 -0
  93. package/lib/types/enum-mappings/liability-type.js +21 -0
  94. package/lib/types/enum-mappings/living-expense.d.ts +7 -0
  95. package/lib/types/enum-mappings/living-expense.js +31 -0
  96. package/lib/types/enum-mappings/marital-status.d.ts +7 -0
  97. package/lib/types/enum-mappings/marital-status.js +12 -0
  98. package/lib/types/enum-mappings/postcode.d.ts +6 -0
  99. package/lib/types/enum-mappings/postcode.js +15 -0
  100. package/lib/types/enum-mappings/preferred-repayment.d.ts +7 -0
  101. package/lib/types/enum-mappings/preferred-repayment.js +10 -0
  102. package/lib/types/enum-mappings/proof-of-identity.d.ts +7 -0
  103. package/lib/types/enum-mappings/proof-of-identity.js +10 -0
  104. package/lib/types/enum-mappings/property-expense-category.d.ts +7 -0
  105. package/lib/types/enum-mappings/property-expense-category.js +11 -0
  106. package/lib/types/enum-mappings/public-financial-asset.d.ts +7 -0
  107. package/lib/types/enum-mappings/public-financial-asset.js +12 -0
  108. package/lib/types/enum-mappings/public-primary-purpose.d.ts +7 -0
  109. package/lib/types/enum-mappings/public-primary-purpose.js +9 -0
  110. package/lib/types/enum-mappings/public-property-status.d.ts +7 -0
  111. package/lib/types/enum-mappings/public-property-status.js +11 -0
  112. package/lib/types/enum-mappings/public-property-type.d.ts +7 -0
  113. package/lib/types/enum-mappings/public-property-type.js +23 -0
  114. package/lib/types/enum-mappings/residency-status.d.ts +7 -0
  115. package/lib/types/enum-mappings/residency-status.js +11 -0
  116. package/lib/types/enum-mappings/title-gender.d.ts +7 -0
  117. package/lib/types/enum-mappings/title-gender.js +13 -0
  118. package/lib/types/enum-mappings/title.d.ts +7 -0
  119. package/lib/types/enum-mappings/title.js +13 -0
  120. package/lib/types/enum-mappings/to-be-purchased.d.ts +5 -0
  121. package/lib/types/enum-mappings/to-be-purchased.js +8 -0
  122. package/lib/types/enum-mappings/to-be-used-as-security.d.ts +5 -0
  123. package/lib/types/enum-mappings/to-be-used-as-security.js +8 -0
  124. package/lib/types/enum-mappings/transaction-type.d.ts +7 -0
  125. package/lib/types/enum-mappings/transaction-type.js +9 -0
  126. package/lib/types/enum-mappings/trust.d.ts +7 -0
  127. package/lib/types/enum-mappings/trust.js +14 -0
  128. package/lib/types/enum-mappings/verification.d.ts +3 -0
  129. package/lib/types/enum-mappings/verification.js +13 -0
  130. package/lib/types/events/applicant-delete.d.ts +42 -0
  131. package/lib/types/events/applicant-delete.js +15 -0
  132. package/lib/types/events/application-workflow.d.ts +233 -0
  133. package/lib/types/events/application-workflow.js +172 -0
  134. package/lib/types/events/asset-delete.d.ts +33 -0
  135. package/lib/types/events/asset-delete.js +15 -0
  136. package/lib/types/events/asset-liability-relation-delete.d.ts +52 -0
  137. package/lib/types/events/asset-liability-relation-delete.js +15 -0
  138. package/lib/types/events/credit-report-retrieved.d.ts +36 -0
  139. package/lib/types/events/credit-report-retrieved.js +15 -0
  140. package/lib/types/events/employment-delete.d.ts +19 -0
  141. package/lib/types/events/employment-delete.js +7 -0
  142. package/lib/types/events/expense-delete.d.ts +21 -0
  143. package/lib/types/events/expense-delete.js +7 -0
  144. package/lib/types/events/funding-position.d.ts +116 -0
  145. package/lib/types/events/funding-position.js +34 -0
  146. package/lib/types/events/income-delete.d.ts +33 -0
  147. package/lib/types/events/income-delete.js +15 -0
  148. package/lib/types/events/liability-delete.d.ts +17 -0
  149. package/lib/types/events/liability-delete.js +7 -0
  150. package/lib/types/events/opportunity.d.ts +102 -0
  151. package/lib/types/events/opportunity.js +47 -0
  152. package/lib/types/events/public-applicant.d.ts +628 -0
  153. package/lib/types/events/public-applicant.js +411 -0
  154. package/lib/types/events/public-application.d.ts +151 -0
  155. package/lib/types/events/public-application.js +103 -0
  156. package/lib/types/events/public-asset-liability-relation.d.ts +52 -0
  157. package/lib/types/events/public-asset-liability-relation.js +15 -0
  158. package/lib/types/events/public-asset.d.ts +502 -0
  159. package/lib/types/events/public-asset.js +348 -0
  160. package/lib/types/events/public-employment.d.ts +121 -0
  161. package/lib/types/events/public-employment.js +46 -0
  162. package/lib/types/events/public-expense.d.ts +84 -0
  163. package/lib/types/events/public-expense.js +51 -0
  164. package/lib/types/events/public-funding-position.d.ts +341 -0
  165. package/lib/types/events/public-funding-position.js +20 -0
  166. package/lib/types/events/public-income.d.ts +144 -0
  167. package/lib/types/events/public-income.js +65 -0
  168. package/lib/types/events/public-liability.d.ts +140 -0
  169. package/lib/types/events/public-liability.js +68 -0
  170. package/lib/types/events/public-required-document.d.ts +374 -0
  171. package/lib/types/events/public-required-document.js +297 -0
  172. package/lib/types/partial-application.d.ts +3 -0
  173. package/lib/types/partial-application.js +2 -0
  174. package/lib/types/recursive-partial.d.ts +3 -0
  175. package/lib/types/recursive-partial.js +2 -0
  176. package/lib/update-application/merge-application.d.ts +14 -0
  177. package/lib/update-application/merge-application.js +175 -0
  178. package/lib/update-application/remove-ids-not-required.d.ts +11 -0
  179. package/lib/update-application/remove-ids-not-required.js +63 -0
  180. package/lib/update-application/update-primary-applicant.d.ts +27 -0
  181. package/lib/update-application/update-primary-applicant.js +46 -0
  182. package/lib/utils/address-tools.d.ts +84 -0
  183. package/lib/utils/address-tools.js +176 -0
  184. package/lib/utils/clean-up.d.ts +7 -0
  185. package/lib/utils/clean-up.js +24 -0
  186. package/lib/utils/errors.d.ts +28 -0
  187. package/lib/utils/errors.js +43 -0
  188. package/lib/utils/formatYesNo.d.ts +8 -0
  189. package/lib/utils/formatYesNo.js +12 -0
  190. package/lib/utils/generate-address.d.ts +19 -0
  191. package/lib/utils/generate-address.js +97 -0
  192. package/lib/utils/get-financial-institution.d.ts +8 -0
  193. package/lib/utils/get-financial-institution.js +17 -0
  194. package/lib/utils/is-asset-type.d.ts +25 -0
  195. package/lib/utils/is-asset-type.js +46 -0
  196. package/lib/utils/is-income-type.d.ts +73 -0
  197. package/lib/utils/is-income-type.js +134 -0
  198. package/lib/utils/iso-date.d.ts +7 -0
  199. package/lib/utils/iso-date.js +12 -0
  200. package/lib/utils/normalise-date.d.ts +8 -0
  201. package/lib/utils/normalise-date.js +17 -0
  202. package/lib/utils/round-decimal.d.ts +6 -0
  203. package/lib/utils/round-decimal.js +12 -0
  204. package/package.json +79 -0
@@ -0,0 +1,52 @@
1
+ /**
2
+ * The AssetAndLiabilityRelationCreated event schema
3
+ */
4
+ export interface PublicAssetLiabilityRelation {
5
+ payload: AssetAndLiabilityRelation;
6
+ type: Type;
7
+ /**
8
+ * schema version
9
+ */
10
+ version: string;
11
+ }
12
+ /**
13
+ * create Asset And Liability Relation payload
14
+ */
15
+ export interface AssetAndLiabilityRelation {
16
+ applicationId: string;
17
+ meta?: Meta;
18
+ relation: Relation;
19
+ }
20
+ /**
21
+ * The metadata of the alieo
22
+ */
23
+ export interface Meta {
24
+ /**
25
+ * uuid of user who made the action (create/update/delete)
26
+ */
27
+ actionedBy: string;
28
+ /**
29
+ * role of the user that made the action
30
+ */
31
+ actionedByRole: ActionedByRole;
32
+ }
33
+ /**
34
+ * role of the user that made the action
35
+ */
36
+ export declare enum ActionedByRole {
37
+ Customer = "customer",
38
+ Team = "team"
39
+ }
40
+ export interface Relation {
41
+ /**
42
+ * uuid of asset
43
+ */
44
+ assetId: string;
45
+ /**
46
+ * uuid of liability
47
+ */
48
+ liabilityId: string;
49
+ }
50
+ export declare enum Type {
51
+ AssetAndLiabilityRelationCreated = "AssetAndLiabilityRelationCreated"
52
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.Type = exports.ActionedByRole = void 0;
4
+ /**
5
+ * role of the user that made the action
6
+ */
7
+ var ActionedByRole;
8
+ (function (ActionedByRole) {
9
+ ActionedByRole["Customer"] = "customer";
10
+ ActionedByRole["Team"] = "team";
11
+ })(ActionedByRole = exports.ActionedByRole || (exports.ActionedByRole = {}));
12
+ var Type;
13
+ (function (Type) {
14
+ Type["AssetAndLiabilityRelationCreated"] = "AssetAndLiabilityRelationCreated";
15
+ })(Type = exports.Type || (exports.Type = {}));
@@ -0,0 +1,502 @@
1
+ /**
2
+ * Create or update
3
+ */
4
+ export interface PublicAsset {
5
+ payload: Payload;
6
+ /**
7
+ * schema version
8
+ */
9
+ type: PublicAssetType;
10
+ version: string;
11
+ }
12
+ /**
13
+ * create Asset payload
14
+ */
15
+ export interface Payload {
16
+ applicationId: string;
17
+ asset: Asset;
18
+ /**
19
+ * uuid of asset
20
+ */
21
+ id: string;
22
+ meta?: Meta;
23
+ }
24
+ export interface Asset {
25
+ address?: Address;
26
+ constructionDetails?: ConstructionDetails;
27
+ contractDetails?: ContractDetails;
28
+ contractPriceAmount?: number;
29
+ dataType?: string;
30
+ description?: string;
31
+ estimatedValue?: number;
32
+ financialInstitution?: string;
33
+ financialInstitutionAccountNumber?: string;
34
+ financialInstitutionBsb?: string;
35
+ financialInstitutionShortName?: string;
36
+ isConstruction?: boolean;
37
+ knockDownToRebuild?: boolean;
38
+ make?: string;
39
+ model?: string;
40
+ percentOwned?: PercentOwned;
41
+ primaryPurpose?: PrimaryPurpose;
42
+ propertyExpenses?: PropertyExpense[];
43
+ propertyStatus?: PropertyStatus;
44
+ propertyType?: PropertyType;
45
+ relationId?: string;
46
+ toBePurchased?: boolean;
47
+ toBeSold?: boolean;
48
+ toBeUsedAsSecurity?: boolean;
49
+ type: AssetType;
50
+ year?: number;
51
+ zoneType?: ZoneType;
52
+ }
53
+ export interface Address {
54
+ /**
55
+ * The suburb name
56
+ */
57
+ city?: string;
58
+ country?: Countries;
59
+ /**
60
+ * A formatted version of the address
61
+ */
62
+ formatted?: string;
63
+ /**
64
+ * A 4 digit postcode
65
+ */
66
+ postcode?: string;
67
+ standard?: AddressStandard;
68
+ /**
69
+ * One our great nation's states
70
+ */
71
+ state?: string;
72
+ }
73
+ export declare enum Countries {
74
+ Afghanistan = "Afghanistan",
75
+ Albania = "Albania",
76
+ Algeria = "Algeria",
77
+ AmericanSamoa = "American Samoa",
78
+ Andorra = "Andorra",
79
+ Angola = "Angola",
80
+ Anguilla = "Anguilla",
81
+ Antarctica = "Antarctica",
82
+ AntiguaAndBarbuda = "Antigua And Barbuda",
83
+ Argentina = "Argentina",
84
+ Armenia = "Armenia",
85
+ Aruba = "Aruba",
86
+ Australia = "Australia",
87
+ Austria = "Austria",
88
+ Azerbaijan = "Azerbaijan",
89
+ Bahamas = "Bahamas",
90
+ Bahrain = "Bahrain",
91
+ Bangladesh = "Bangladesh",
92
+ Barbados = "Barbados",
93
+ Belarus = "Belarus",
94
+ Belgium = "Belgium",
95
+ Belize = "Belize",
96
+ Benin = "Benin",
97
+ Bermuda = "Bermuda",
98
+ Bhutan = "Bhutan",
99
+ Bolivia = "Bolivia",
100
+ BosniaAndHerzegovina = "Bosnia And Herzegovina",
101
+ Botswana = "Botswana",
102
+ BouvetIsland = "Bouvet Island",
103
+ Brazil = "Brazil",
104
+ BritishIndianOceanTerritory = "British Indian Ocean Territory",
105
+ BritishVirginIslands = "British Virgin Islands",
106
+ BruneiDarussalam = "Brunei Darussalam",
107
+ Bulgaria = "Bulgaria",
108
+ BurkinaFaso = "Burkina Faso",
109
+ Burundi = "Burundi",
110
+ Cambodia = "Cambodia",
111
+ Cameroon = "Cameroon",
112
+ Canada = "Canada",
113
+ CapeVerde = "Cape Verde",
114
+ CaymanIslands = "Cayman Islands",
115
+ CentralAfricanRepublic = "Central African Republic",
116
+ Chad = "Chad",
117
+ Chile = "Chile",
118
+ China = "China",
119
+ ChristmasIsland = "Christmas Island",
120
+ CocosKeelingIslands = "Cocos (Keeling) Islands",
121
+ Colombia = "Colombia",
122
+ Comoros = "Comoros",
123
+ CookIslands = "Cook Islands",
124
+ CostaRica = "Costa Rica",
125
+ CoteDIvoire = "Cote D'ivoire",
126
+ Croatia = "Croatia",
127
+ Cuba = "Cuba",
128
+ Cyprus = "Cyprus",
129
+ CzechRepublic = "Czech Republic",
130
+ DemocraticPeopleSRepublicOfKorea = "Democratic People's Republic of Korea",
131
+ DemocraticRepublicOfTheCongo = "Democratic Republic Of The Congo",
132
+ Denmark = "Denmark",
133
+ Djibouti = "Djibouti",
134
+ Dominica = "Dominica",
135
+ DominicanRepublic = "Dominican Republic",
136
+ EastTimor = "East Timor",
137
+ Ecuador = "Ecuador",
138
+ Egypt = "Egypt",
139
+ ElSalvador = "El Salvador",
140
+ EquatorialGuinea = "Equatorial Guinea",
141
+ Eritrea = "Eritrea",
142
+ Estonia = "Estonia",
143
+ Ethiopia = "Ethiopia",
144
+ FalklandIslands = "Falkland Islands",
145
+ FaroeIslands = "Faroe Islands",
146
+ FederatedStatesOfMicronesia = "Federated States Of Micronesia",
147
+ Fiji = "Fiji",
148
+ Finland = "Finland",
149
+ France = "France",
150
+ FrenchGuiana = "French Guiana",
151
+ FrenchPolynesia = "French Polynesia",
152
+ FrenchSouthernTerritories = "French Southern Territories",
153
+ Gabon = "Gabon",
154
+ Gambia = "Gambia",
155
+ Georgia = "Georgia",
156
+ Germany = "Germany",
157
+ Ghana = "Ghana",
158
+ Gibraltar = "Gibraltar",
159
+ Greece = "Greece",
160
+ Greenland = "Greenland",
161
+ Grenada = "Grenada",
162
+ Guadeloupe = "Guadeloupe",
163
+ Guam = "Guam",
164
+ Guatemala = "Guatemala",
165
+ Guinea = "Guinea",
166
+ GuineaBissau = "Guinea-bissau",
167
+ Guyana = "Guyana",
168
+ Haiti = "Haiti",
169
+ HeardIslandAndMcdonaldIslands = "Heard Island And Mcdonald Islands",
170
+ HolySeeVaticanCityState = "Holy See (Vatican City State)",
171
+ Honduras = "Honduras",
172
+ HongKong = "Hong Kong",
173
+ Hungary = "Hungary",
174
+ Iceland = "Iceland",
175
+ India = "India",
176
+ Indonesia = "Indonesia",
177
+ Iran = "Iran",
178
+ Iraq = "Iraq",
179
+ Ireland = "Ireland",
180
+ Israel = "Israel",
181
+ Italy = "Italy",
182
+ Jamaica = "Jamaica",
183
+ Japan = "Japan",
184
+ Jordan = "Jordan",
185
+ Kazakstan = "Kazakstan",
186
+ Kenya = "Kenya",
187
+ Kiribati = "Kiribati",
188
+ Kosovo = "Kosovo",
189
+ Kuwait = "Kuwait",
190
+ Kyrgyzstan = "Kyrgyzstan",
191
+ Laos = "Laos",
192
+ Latvia = "Latvia",
193
+ Lebanon = "Lebanon",
194
+ Lesotho = "Lesotho",
195
+ Liberia = "Liberia",
196
+ LibyanArabJamahiriya = "Libyan Arab Jamahiriya",
197
+ Liechtenstein = "Liechtenstein",
198
+ Lithuania = "Lithuania",
199
+ Luxembourg = "Luxembourg",
200
+ Macau = "Macau",
201
+ Macedonia = "Macedonia",
202
+ Madagascar = "Madagascar",
203
+ Malawi = "Malawi",
204
+ Malaysia = "Malaysia",
205
+ Maldives = "Maldives",
206
+ Mali = "Mali",
207
+ Malta = "Malta",
208
+ MarshallIslands = "Marshall Islands",
209
+ Martinique = "Martinique",
210
+ Mauritania = "Mauritania",
211
+ Mauritius = "Mauritius",
212
+ Mayotte = "Mayotte",
213
+ Mexico = "Mexico",
214
+ Monaco = "Monaco",
215
+ Mongolia = "Mongolia",
216
+ Montenegro = "Montenegro",
217
+ Montserrat = "Montserrat",
218
+ Morocco = "Morocco",
219
+ Mozambique = "Mozambique",
220
+ Myanmar = "Myanmar",
221
+ Namibia = "Namibia",
222
+ Nauru = "Nauru",
223
+ Nepal = "Nepal",
224
+ Netherlands = "Netherlands",
225
+ NetherlandsAntilles = "Netherlands Antilles",
226
+ NewCaledonia = "New Caledonia",
227
+ NewZealand = "New Zealand",
228
+ Nicaragua = "Nicaragua",
229
+ Niger = "Niger",
230
+ Nigeria = "Nigeria",
231
+ Niue = "Niue",
232
+ NorfolkIsland = "Norfolk Island",
233
+ NorthernMarianaIslands = "Northern Mariana Islands",
234
+ Norway = "Norway",
235
+ Oman = "Oman",
236
+ Pakistan = "Pakistan",
237
+ Palau = "Palau",
238
+ PalestinianTerritory = "Palestinian Territory",
239
+ Panama = "Panama",
240
+ PapuaNewGuinea = "Papua New Guinea",
241
+ Paraguay = "Paraguay",
242
+ Peru = "Peru",
243
+ Philippines = "Philippines",
244
+ Pitcairn = "Pitcairn",
245
+ Poland = "Poland",
246
+ Portugal = "Portugal",
247
+ PuertoRico = "Puerto Rico",
248
+ Qatar = "Qatar",
249
+ RepublicOfMoldova = "Republic Of Moldova",
250
+ Romania = "Romania",
251
+ RussianFederation = "Russian Federation",
252
+ Rwanda = "Rwanda",
253
+ SANMarino = "San Marino",
254
+ SaintHelena = "Saint Helena",
255
+ SaintKittsAndNevis = "Saint Kitts And Nevis",
256
+ SaintLucia = "Saint Lucia",
257
+ SaintPierreAndMiquelon = "Saint Pierre And Miquelon",
258
+ SaintVincentAndTheGrenadines = "Saint Vincent And The Grenadines",
259
+ Samoa = "Samoa",
260
+ SaoTomeAndPrincipe = "Sao Tome And Principe",
261
+ SaudiArabia = "Saudi Arabia",
262
+ Senegal = "Senegal",
263
+ Serbia = "Serbia",
264
+ Seychelles = "Seychelles",
265
+ SierraLeone = "Sierra Leone",
266
+ Singapore = "Singapore",
267
+ Slovakia = "Slovakia",
268
+ Slovenia = "Slovenia",
269
+ SolomonIslands = "Solomon Islands",
270
+ Somalia = "Somalia",
271
+ SouthAfrica = "South Africa",
272
+ SouthGeorgiaAndTheSouthSandwichIslands = "South Georgia And The South Sandwich Islands",
273
+ Spain = "Spain",
274
+ SriLanka = "Sri Lanka",
275
+ Sudan = "Sudan",
276
+ Suriname = "Suriname",
277
+ SvalbardAndJanMayen = "Svalbard And Jan Mayen",
278
+ Swaziland = "Swaziland",
279
+ Sweden = "Sweden",
280
+ Switzerland = "Switzerland",
281
+ SyrianArabRepublic = "Syrian Arab Republic",
282
+ Taiwan = "Taiwan",
283
+ Tajikistan = "Tajikistan",
284
+ Tanzania = "Tanzania",
285
+ Thailand = "Thailand",
286
+ TheRepublicOfSouthKorea = "The Republic of South Korea",
287
+ Togo = "Togo",
288
+ Tokelau = "Tokelau",
289
+ Tonga = "Tonga",
290
+ TrinidadAndTobago = "Trinidad And Tobago",
291
+ Tunisia = "Tunisia",
292
+ Turkey = "Turkey",
293
+ Turkmenistan = "Turkmenistan",
294
+ TurksAndCaicosIslands = "Turks And Caicos Islands",
295
+ Tuvalu = "Tuvalu",
296
+ USVirginIslands = "US Virgin Islands",
297
+ Uganda = "Uganda",
298
+ Ukraine = "Ukraine",
299
+ UnitedArabEmirates = "United Arab Emirates",
300
+ UnitedKingdom = "United Kingdom",
301
+ UnitedStatesMinorOutlyingIslands = "United States Minor Outlying Islands",
302
+ UnitedStatesOfAmerica = "United States of America",
303
+ Uruguay = "Uruguay",
304
+ Uzbekistan = "Uzbekistan",
305
+ Vanuatu = "Vanuatu",
306
+ Venezuela = "Venezuela",
307
+ Vietnam = "Vietnam",
308
+ WallisAndFutuna = "Wallis And Futuna",
309
+ WesternSahara = "Western Sahara",
310
+ Yemen = "Yemen",
311
+ Zambia = "Zambia",
312
+ Zimbabwe = "Zimbabwe"
313
+ }
314
+ export interface AddressStandard {
315
+ /**
316
+ * The building name
317
+ */
318
+ buildingName?: string;
319
+ /**
320
+ * The level of the unit/apartment
321
+ */
322
+ level?: string;
323
+ /**
324
+ * The lot number
325
+ */
326
+ lotSection?: string;
327
+ /**
328
+ * The street name
329
+ */
330
+ streetName?: string;
331
+ /**
332
+ * The street number
333
+ */
334
+ streetNumber?: string;
335
+ /**
336
+ * The type of the street i.e. road
337
+ */
338
+ streetType?: string;
339
+ /**
340
+ * The unit number
341
+ */
342
+ unit?: string;
343
+ }
344
+ export interface ConstructionDetails {
345
+ /**
346
+ * Indicates whether it should be coded as vacant land loan or a construction loan
347
+ */
348
+ buildIn6Months?: boolean;
349
+ buildPriceAmount?: number;
350
+ builderType?: BuilderType;
351
+ constructionType?: ConstructionType;
352
+ isFixedPriceContract?: boolean;
353
+ landEstimatedValue?: number;
354
+ otherConstructionCosts?: number;
355
+ }
356
+ export declare enum BuilderType {
357
+ LicensedBuilder = "LICENSED_BUILDER",
358
+ OwnerBuilder = "OWNER_BUILDER"
359
+ }
360
+ export declare enum ConstructionType {
361
+ BuildAProperty = "BUILD_A_PROPERTY",
362
+ KnockdownRebuild = "KNOCKDOWN_REBUILD",
363
+ StructuralRenovations = "STRUCTURAL_RENOVATIONS"
364
+ }
365
+ /**
366
+ * Details of the purchase/sale price as specified in the Contract of Sale
367
+ */
368
+ export interface ContractDetails {
369
+ /**
370
+ * The date of the Contract of Sale.
371
+ */
372
+ contractDate?: string;
373
+ /**
374
+ * Captures the total purchase/sale price as specified in the Contract of Sale.
375
+ */
376
+ contractPriceAmount?: number;
377
+ /**
378
+ * The purchase date of the property, or the proposed settlement date for a property being
379
+ * purchased or sold
380
+ */
381
+ estimatedSettlementDate?: string;
382
+ }
383
+ export interface PercentOwned {
384
+ owners: ApplicantOwnership[];
385
+ /**
386
+ * Indicate whether ownership proportions are equal, specified individually for each one or
387
+ * not specified.
388
+ */
389
+ proportions?: Proportions;
390
+ }
391
+ export interface ApplicantOwnership {
392
+ /**
393
+ * The applicant Identifier
394
+ */
395
+ applicantId: string;
396
+ customerId?: string;
397
+ /**
398
+ * how much percent for the corresponding applicant
399
+ */
400
+ percent: number;
401
+ }
402
+ /**
403
+ * Indicate whether ownership proportions are equal, specified individually for each one or
404
+ * not specified.
405
+ */
406
+ export declare enum Proportions {
407
+ Equal = "EQUAL",
408
+ NotSpecified = "NOT_SPECIFIED",
409
+ Specified = "SPECIFIED"
410
+ }
411
+ export declare enum PrimaryPurpose {
412
+ Investment = "INVESTMENT",
413
+ OwnerOccupied = "OWNER_OCCUPIED"
414
+ }
415
+ export interface PropertyExpense {
416
+ amount?: number;
417
+ comments?: string;
418
+ frequency?: Frequency;
419
+ type: PropertyExpenseType;
420
+ }
421
+ export declare enum Frequency {
422
+ Fortnightly = "FORTNIGHTLY",
423
+ Monthly = "MONTHLY",
424
+ Quarterly = "QUARTERLY",
425
+ Weekly = "WEEKLY",
426
+ Yearly = "YEARLY"
427
+ }
428
+ export declare enum PropertyExpenseType {
429
+ BodyCorporateFeesStrataFeesAndLandTax = "BODY_CORPORATE_FEES_STRATA_FEES_AND_LAND_TAX",
430
+ InvestmentPropertyRunningCosts = "INVESTMENT_PROPERTY_RUNNING_COSTS",
431
+ PrimaryResidenceRunningCosts = "PRIMARY_RESIDENCE_RUNNING_COSTS",
432
+ SecondaryResidenceRunningCosts = "SECONDARY_RESIDENCE_RUNNING_COSTS"
433
+ }
434
+ export declare enum PropertyStatus {
435
+ Established = "ESTABLISHED",
436
+ NewBuilding = "NEW_BUILDING",
437
+ OffThePlan = "OFF_THE_PLAN",
438
+ VacantLand = "VACANT_LAND"
439
+ }
440
+ export declare enum PropertyType {
441
+ ApartmentUnitLessThan50M2 = "APARTMENT_UNIT_LESS_THAN_50M2",
442
+ ApartmentUnitMoreThan50M2 = "APARTMENT_UNIT_MORE_THAN_50M2",
443
+ Duplex = "DUPLEX",
444
+ FullyDetachedHouse = "FULLY_DETACHED_HOUSE",
445
+ KitHome = "KIT_HOME",
446
+ Land = "LAND",
447
+ MultiDwellingSingleTitle = "MULTI_DWELLING_SINGLE_TITLE",
448
+ PropertyOver10_Ha = "PROPERTY_OVER_10_HA",
449
+ SemiDetachedHouse = "SEMI_DETACHED_HOUSE",
450
+ ServicedApartment = "SERVICED_APARTMENT",
451
+ StudentAccommodation = "STUDENT_ACCOMMODATION",
452
+ Studio = "STUDIO",
453
+ Terrace = "TERRACE",
454
+ Townhouse = "TOWNHOUSE",
455
+ Villa = "VILLA",
456
+ WarehouseApartment = "WAREHOUSE_APARTMENT"
457
+ }
458
+ export declare enum AssetType {
459
+ Gifts = "GIFTS",
460
+ HomeContents = "HOME_CONTENTS",
461
+ ManagedFunds = "MANAGED_FUNDS",
462
+ OtherAsset = "OTHER_ASSET",
463
+ Property = "PROPERTY",
464
+ SavingCheckAccount = "SAVING_CHECK_ACCOUNT",
465
+ Shares = "SHARES",
466
+ Superannuation = "SUPERANNUATION",
467
+ TermDeposit = "TERM_DEPOSIT",
468
+ Vehicle = "VEHICLE"
469
+ }
470
+ export declare enum ZoneType {
471
+ Commercial = "COMMERCIAL",
472
+ Industrial = "INDUSTRIAL",
473
+ Residential = "RESIDENTIAL",
474
+ Rural = "RURAL"
475
+ }
476
+ /**
477
+ * The metadata of the alieo
478
+ */
479
+ export interface Meta {
480
+ /**
481
+ * uuid of user who made the action (create/update/delete)
482
+ */
483
+ actionedBy: string;
484
+ /**
485
+ * role of the user that made the action
486
+ */
487
+ actionedByRole: ActionedByRole;
488
+ }
489
+ /**
490
+ * role of the user that made the action
491
+ */
492
+ export declare enum ActionedByRole {
493
+ Customer = "customer",
494
+ Team = "team"
495
+ }
496
+ /**
497
+ * schema version
498
+ */
499
+ export declare enum PublicAssetType {
500
+ AssetCreated = "AssetCreated",
501
+ AssetUpdated = "AssetUpdated"
502
+ }