@openinherit/sdk 1.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.
- package/LICENSE +191 -0
- package/dist/estate/client/client.gen.d.ts +3 -0
- package/dist/estate/client/client.gen.d.ts.map +1 -0
- package/dist/estate/client/client.gen.js +236 -0
- package/dist/estate/client/client.gen.js.map +1 -0
- package/dist/estate/client/index.d.ts +9 -0
- package/dist/estate/client/index.d.ts.map +1 -0
- package/dist/estate/client/index.js +7 -0
- package/dist/estate/client/index.js.map +1 -0
- package/dist/estate/client/types.gen.d.ts +118 -0
- package/dist/estate/client/types.gen.d.ts.map +1 -0
- package/dist/estate/client/types.gen.js +3 -0
- package/dist/estate/client/types.gen.js.map +1 -0
- package/dist/estate/client/utils.gen.d.ts +34 -0
- package/dist/estate/client/utils.gen.d.ts.map +1 -0
- package/dist/estate/client/utils.gen.js +229 -0
- package/dist/estate/client/utils.gen.js.map +1 -0
- package/dist/estate/client.gen.d.ts +13 -0
- package/dist/estate/client.gen.d.ts.map +1 -0
- package/dist/estate/client.gen.js +4 -0
- package/dist/estate/client.gen.js.map +1 -0
- package/dist/estate/core/auth.gen.d.ts +19 -0
- package/dist/estate/core/auth.gen.d.ts.map +1 -0
- package/dist/estate/core/auth.gen.js +15 -0
- package/dist/estate/core/auth.gen.js.map +1 -0
- package/dist/estate/core/bodySerializer.gen.d.ts +26 -0
- package/dist/estate/core/bodySerializer.gen.d.ts.map +1 -0
- package/dist/estate/core/bodySerializer.gen.js +58 -0
- package/dist/estate/core/bodySerializer.gen.js.map +1 -0
- package/dist/estate/core/params.gen.d.ts +44 -0
- package/dist/estate/core/params.gen.d.ts.map +1 -0
- package/dist/estate/core/params.gen.js +101 -0
- package/dist/estate/core/params.gen.js.map +1 -0
- package/dist/estate/core/pathSerializer.gen.d.ts +34 -0
- package/dist/estate/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/estate/core/pathSerializer.gen.js +107 -0
- package/dist/estate/core/pathSerializer.gen.js.map +1 -0
- package/dist/estate/core/queryKeySerializer.gen.d.ts +19 -0
- package/dist/estate/core/queryKeySerializer.gen.d.ts.map +1 -0
- package/dist/estate/core/queryKeySerializer.gen.js +93 -0
- package/dist/estate/core/queryKeySerializer.gen.js.map +1 -0
- package/dist/estate/core/serverSentEvents.gen.d.ts +72 -0
- package/dist/estate/core/serverSentEvents.gen.d.ts.map +1 -0
- package/dist/estate/core/serverSentEvents.gen.js +134 -0
- package/dist/estate/core/serverSentEvents.gen.js.map +1 -0
- package/dist/estate/core/types.gen.d.ts +79 -0
- package/dist/estate/core/types.gen.d.ts.map +1 -0
- package/dist/estate/core/types.gen.js +3 -0
- package/dist/estate/core/types.gen.js.map +1 -0
- package/dist/estate/core/utils.gen.d.ts +20 -0
- package/dist/estate/core/utils.gen.d.ts.map +1 -0
- package/dist/estate/core/utils.gen.js +88 -0
- package/dist/estate/core/utils.gen.js.map +1 -0
- package/dist/estate/index.d.ts +3 -0
- package/dist/estate/index.d.ts.map +1 -0
- package/dist/estate/index.js +3 -0
- package/dist/estate/index.js.map +1 -0
- package/dist/estate/sdk.gen.d.ts +25 -0
- package/dist/estate/sdk.gen.d.ts.map +1 -0
- package/dist/estate/sdk.gen.js +19 -0
- package/dist/estate/sdk.gen.js.map +1 -0
- package/dist/estate/types.gen.d.ts +2140 -0
- package/dist/estate/types.gen.d.ts.map +1 -0
- package/dist/estate/types.gen.js +3 -0
- package/dist/estate/types.gen.js.map +1 -0
- package/dist/reference/client/client.gen.d.ts +3 -0
- package/dist/reference/client/client.gen.d.ts.map +1 -0
- package/dist/reference/client/client.gen.js +236 -0
- package/dist/reference/client/client.gen.js.map +1 -0
- package/dist/reference/client/index.d.ts +9 -0
- package/dist/reference/client/index.d.ts.map +1 -0
- package/dist/reference/client/index.js +7 -0
- package/dist/reference/client/index.js.map +1 -0
- package/dist/reference/client/types.gen.d.ts +118 -0
- package/dist/reference/client/types.gen.d.ts.map +1 -0
- package/dist/reference/client/types.gen.js +3 -0
- package/dist/reference/client/types.gen.js.map +1 -0
- package/dist/reference/client/utils.gen.d.ts +34 -0
- package/dist/reference/client/utils.gen.d.ts.map +1 -0
- package/dist/reference/client/utils.gen.js +229 -0
- package/dist/reference/client/utils.gen.js.map +1 -0
- package/dist/reference/client.gen.d.ts +13 -0
- package/dist/reference/client.gen.d.ts.map +1 -0
- package/dist/reference/client.gen.js +4 -0
- package/dist/reference/client.gen.js.map +1 -0
- package/dist/reference/core/auth.gen.d.ts +19 -0
- package/dist/reference/core/auth.gen.d.ts.map +1 -0
- package/dist/reference/core/auth.gen.js +15 -0
- package/dist/reference/core/auth.gen.js.map +1 -0
- package/dist/reference/core/bodySerializer.gen.d.ts +26 -0
- package/dist/reference/core/bodySerializer.gen.d.ts.map +1 -0
- package/dist/reference/core/bodySerializer.gen.js +58 -0
- package/dist/reference/core/bodySerializer.gen.js.map +1 -0
- package/dist/reference/core/params.gen.d.ts +44 -0
- package/dist/reference/core/params.gen.d.ts.map +1 -0
- package/dist/reference/core/params.gen.js +101 -0
- package/dist/reference/core/params.gen.js.map +1 -0
- package/dist/reference/core/pathSerializer.gen.d.ts +34 -0
- package/dist/reference/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/reference/core/pathSerializer.gen.js +107 -0
- package/dist/reference/core/pathSerializer.gen.js.map +1 -0
- package/dist/reference/core/queryKeySerializer.gen.d.ts +19 -0
- package/dist/reference/core/queryKeySerializer.gen.d.ts.map +1 -0
- package/dist/reference/core/queryKeySerializer.gen.js +93 -0
- package/dist/reference/core/queryKeySerializer.gen.js.map +1 -0
- package/dist/reference/core/serverSentEvents.gen.d.ts +72 -0
- package/dist/reference/core/serverSentEvents.gen.d.ts.map +1 -0
- package/dist/reference/core/serverSentEvents.gen.js +134 -0
- package/dist/reference/core/serverSentEvents.gen.js.map +1 -0
- package/dist/reference/core/types.gen.d.ts +79 -0
- package/dist/reference/core/types.gen.d.ts.map +1 -0
- package/dist/reference/core/types.gen.js +3 -0
- package/dist/reference/core/types.gen.js.map +1 -0
- package/dist/reference/core/utils.gen.d.ts +20 -0
- package/dist/reference/core/utils.gen.d.ts.map +1 -0
- package/dist/reference/core/utils.gen.js +88 -0
- package/dist/reference/core/utils.gen.js.map +1 -0
- package/dist/reference/index.d.ts +3 -0
- package/dist/reference/index.d.ts.map +1 -0
- package/dist/reference/index.js +3 -0
- package/dist/reference/index.js.map +1 -0
- package/dist/reference/sdk.gen.d.ts +508 -0
- package/dist/reference/sdk.gen.d.ts.map +1 -0
- package/dist/reference/sdk.gen.js +1147 -0
- package/dist/reference/sdk.gen.js.map +1 -0
- package/dist/reference/types.gen.d.ts +4602 -0
- package/dist/reference/types.gen.d.ts.map +1 -0
- package/dist/reference/types.gen.js +3 -0
- package/dist/reference/types.gen.js.map +1 -0
- package/package.json +50 -0
|
@@ -0,0 +1,4602 @@
|
|
|
1
|
+
export type ClientOptions = {
|
|
2
|
+
baseUrl: 'https://api.example.com/v1' | (string & {});
|
|
3
|
+
};
|
|
4
|
+
export type Error = {
|
|
5
|
+
error: {
|
|
6
|
+
/**
|
|
7
|
+
* Machine-readable error code
|
|
8
|
+
*/
|
|
9
|
+
code: string;
|
|
10
|
+
/**
|
|
11
|
+
* Human-readable error description
|
|
12
|
+
*/
|
|
13
|
+
message: string;
|
|
14
|
+
/**
|
|
15
|
+
* Additional structured detail about the error
|
|
16
|
+
*/
|
|
17
|
+
details?: {
|
|
18
|
+
[key: string]: unknown;
|
|
19
|
+
};
|
|
20
|
+
};
|
|
21
|
+
};
|
|
22
|
+
export type PaginatedEstateList = {
|
|
23
|
+
/**
|
|
24
|
+
* Page of estate records
|
|
25
|
+
*/
|
|
26
|
+
items: Array<Estate>;
|
|
27
|
+
/**
|
|
28
|
+
* Opaque cursor to fetch the next page; absent when hasMore is false
|
|
29
|
+
*/
|
|
30
|
+
cursor?: string;
|
|
31
|
+
/**
|
|
32
|
+
* Whether further pages are available
|
|
33
|
+
*/
|
|
34
|
+
hasMore: boolean;
|
|
35
|
+
};
|
|
36
|
+
export type ImportResult = {
|
|
37
|
+
/**
|
|
38
|
+
* Identifier assigned to the newly imported estate
|
|
39
|
+
*/
|
|
40
|
+
estateId: string;
|
|
41
|
+
/**
|
|
42
|
+
* Highest conformance level achieved:
|
|
43
|
+
* 1 = Schema Valid, 2 = Referentially Intact, 3 = Jurisdiction Complete
|
|
44
|
+
*
|
|
45
|
+
*/
|
|
46
|
+
conformanceLevel: 1 | 2 | 3;
|
|
47
|
+
/**
|
|
48
|
+
* Non-fatal warnings produced during import
|
|
49
|
+
*/
|
|
50
|
+
warnings?: Array<string>;
|
|
51
|
+
/**
|
|
52
|
+
* Count of each entity type created during import
|
|
53
|
+
*/
|
|
54
|
+
entitiesCreated?: {
|
|
55
|
+
persons?: number;
|
|
56
|
+
relationships?: number;
|
|
57
|
+
kinships?: number;
|
|
58
|
+
properties?: number;
|
|
59
|
+
assets?: number;
|
|
60
|
+
liabilities?: number;
|
|
61
|
+
bequests?: number;
|
|
62
|
+
trusts?: number;
|
|
63
|
+
executors?: number;
|
|
64
|
+
guardians?: number;
|
|
65
|
+
wishes?: number;
|
|
66
|
+
documents?: number;
|
|
67
|
+
attestations?: number;
|
|
68
|
+
proxyAuthorisations?: number;
|
|
69
|
+
dealerInterests?: number;
|
|
70
|
+
nonprobateTransfers?: number;
|
|
71
|
+
};
|
|
72
|
+
};
|
|
73
|
+
export type ExportJsonRequest = {
|
|
74
|
+
/**
|
|
75
|
+
* List of extension identifiers to include in the export
|
|
76
|
+
*/
|
|
77
|
+
includeExtensions?: Array<string>;
|
|
78
|
+
/**
|
|
79
|
+
* Minimum conformance level required for export
|
|
80
|
+
*/
|
|
81
|
+
conformanceLevel?: 1 | 2 | 3;
|
|
82
|
+
};
|
|
83
|
+
export type ExportPdfRequest = {
|
|
84
|
+
/**
|
|
85
|
+
* PDF template to use for rendering
|
|
86
|
+
*/
|
|
87
|
+
template: 'full' | 'summary' | 'professional';
|
|
88
|
+
/**
|
|
89
|
+
* List of extension identifiers to include in the PDF
|
|
90
|
+
*/
|
|
91
|
+
includeExtensions?: Array<string>;
|
|
92
|
+
/**
|
|
93
|
+
* Name of the person receiving the PDF (used in the document header)
|
|
94
|
+
*/
|
|
95
|
+
recipientName?: string;
|
|
96
|
+
};
|
|
97
|
+
export type CompanionLink = {
|
|
98
|
+
/**
|
|
99
|
+
* UUID of the estate to link as a companion (e.g. a spouse's estate)
|
|
100
|
+
*/
|
|
101
|
+
companionEstateId: string;
|
|
102
|
+
};
|
|
103
|
+
export type EstateSummary = {
|
|
104
|
+
/**
|
|
105
|
+
* Unique identifier for the estate
|
|
106
|
+
*/
|
|
107
|
+
estateId: string;
|
|
108
|
+
/**
|
|
109
|
+
* Current lifecycle status of the estate
|
|
110
|
+
*/
|
|
111
|
+
status: 'draft' | 'active' | 'locked' | 'archived';
|
|
112
|
+
jurisdiction: Jurisdiction;
|
|
113
|
+
/**
|
|
114
|
+
* Count of each entity type present in the estate
|
|
115
|
+
*/
|
|
116
|
+
entityCounts: {
|
|
117
|
+
persons?: number;
|
|
118
|
+
relationships?: number;
|
|
119
|
+
kinships?: number;
|
|
120
|
+
properties?: number;
|
|
121
|
+
assets?: number;
|
|
122
|
+
liabilities?: number;
|
|
123
|
+
bequests?: number;
|
|
124
|
+
trusts?: number;
|
|
125
|
+
executors?: number;
|
|
126
|
+
guardians?: number;
|
|
127
|
+
wishes?: number;
|
|
128
|
+
documents?: number;
|
|
129
|
+
attestations?: number;
|
|
130
|
+
proxyAuthorisations?: number;
|
|
131
|
+
dealerInterests?: number;
|
|
132
|
+
nonprobateTransfers?: number;
|
|
133
|
+
};
|
|
134
|
+
totalEstimatedValue?: Money;
|
|
135
|
+
totalLiabilities?: Money;
|
|
136
|
+
netEstimatedValue?: Money;
|
|
137
|
+
/**
|
|
138
|
+
* Current conformance level:
|
|
139
|
+
* 0 = Not validated, 1 = Schema Valid,
|
|
140
|
+
* 2 = Referentially Intact, 3 = Jurisdiction Complete
|
|
141
|
+
*
|
|
142
|
+
*/
|
|
143
|
+
conformanceLevel: 0 | 1 | 2 | 3;
|
|
144
|
+
/**
|
|
145
|
+
* Key completeness indicators for the estate
|
|
146
|
+
*/
|
|
147
|
+
completeness?: {
|
|
148
|
+
hasWill?: boolean;
|
|
149
|
+
hasExecutor?: boolean;
|
|
150
|
+
hasGuardian?: boolean;
|
|
151
|
+
hasAttestation?: boolean;
|
|
152
|
+
allBequestsHaveBeneficiary?: boolean;
|
|
153
|
+
};
|
|
154
|
+
/**
|
|
155
|
+
* Indicators used to assess estate complexity
|
|
156
|
+
*/
|
|
157
|
+
complexityIndicators?: {
|
|
158
|
+
/**
|
|
159
|
+
* Number of distinct jurisdictions involved
|
|
160
|
+
*/
|
|
161
|
+
jurisdictionCount?: number;
|
|
162
|
+
hasTrusts?: boolean;
|
|
163
|
+
hasForcedHeirship?: boolean;
|
|
164
|
+
hasNonprobateTransfers?: boolean;
|
|
165
|
+
hasCrossJurisdictionAssets?: boolean;
|
|
166
|
+
};
|
|
167
|
+
/**
|
|
168
|
+
* Date the estate was last modified (ISO 8601)
|
|
169
|
+
*/
|
|
170
|
+
lastModifiedAt: string;
|
|
171
|
+
};
|
|
172
|
+
/**
|
|
173
|
+
* Attestation
|
|
174
|
+
*
|
|
175
|
+
* Will execution formalities. Standalone — reused by estate, codicils, trusts, extensions. Supports written (E&W Wills Act s.9), oral (Islamic/customary), seal-based (Japanese inkan), kinyan-based (Jewish).
|
|
176
|
+
*/
|
|
177
|
+
export type Attestation = {
|
|
178
|
+
date?: string;
|
|
179
|
+
witnessPersonIds?: Array<string>;
|
|
180
|
+
method?: 'in_person' | 'video' | 'remote' | 'none' | 'kinyan_sudar' | 'kinyan_agav' | 'seal_based' | 'inkan_registered';
|
|
181
|
+
attestationType?: 'written_signed' | 'oral_witnessed' | 'oral_community' | 'seal_based';
|
|
182
|
+
solicitorSupervised?: boolean;
|
|
183
|
+
testatorSignedInPresenceOfWitnesses?: boolean;
|
|
184
|
+
witnessesSignedInPresenceOfTestator?: boolean;
|
|
185
|
+
witnessConflictCheck?: boolean;
|
|
186
|
+
witnessConflictCheckScope?: 'english_law' | 'halachic_broad' | 'shariah_standard' | 'civil_law_standard' | 'customary_oral' | 'community_testimony';
|
|
187
|
+
notes?: string;
|
|
188
|
+
[key: string]: unknown | string | Array<string> | 'in_person' | 'video' | 'remote' | 'none' | 'kinyan_sudar' | 'kinyan_agav' | 'seal_based' | 'inkan_registered' | 'written_signed' | 'oral_witnessed' | 'oral_community' | 'seal_based' | boolean | 'english_law' | 'halachic_broad' | 'shariah_standard' | 'civil_law_standard' | 'customary_oral' | 'community_testimony' | string | undefined;
|
|
189
|
+
};
|
|
190
|
+
/**
|
|
191
|
+
* Jurisdiction
|
|
192
|
+
*
|
|
193
|
+
* A legal jurisdiction identified by ISO 3166 codes.
|
|
194
|
+
*/
|
|
195
|
+
export type Jurisdiction = {
|
|
196
|
+
/**
|
|
197
|
+
* ISO 3166-1 alpha-2
|
|
198
|
+
*/
|
|
199
|
+
country: string;
|
|
200
|
+
/**
|
|
201
|
+
* ISO 3166-2 subdivision code (e.g. GB-SCT, US-CA)
|
|
202
|
+
*/
|
|
203
|
+
subdivision?: string;
|
|
204
|
+
legalSystem?: 'common_law' | 'civil_law' | 'mixed' | 'religious' | 'customary' | 'religious_islamic' | 'religious_jewish' | 'religious_hindu' | 'religious_canon' | 'plural';
|
|
205
|
+
/**
|
|
206
|
+
* Human-readable jurisdiction name (e.g. 'Scotland', 'California')
|
|
207
|
+
*/
|
|
208
|
+
name?: string;
|
|
209
|
+
};
|
|
210
|
+
/**
|
|
211
|
+
* Money
|
|
212
|
+
*
|
|
213
|
+
* Monetary value in integer minor currency units with ISO 4217 code. Never floating point.
|
|
214
|
+
*/
|
|
215
|
+
export type Money = {
|
|
216
|
+
/**
|
|
217
|
+
* Value in smallest currency unit (e.g. 32500 = £325.00)
|
|
218
|
+
*/
|
|
219
|
+
amount: number;
|
|
220
|
+
/**
|
|
221
|
+
* ISO 4217 three-letter code
|
|
222
|
+
*/
|
|
223
|
+
currency: string;
|
|
224
|
+
};
|
|
225
|
+
export type TestamentaryCapacity = {
|
|
226
|
+
assessed?: boolean;
|
|
227
|
+
assessmentDate?: string;
|
|
228
|
+
assessorName?: string;
|
|
229
|
+
assessorRole?: string;
|
|
230
|
+
capacityConfirmed?: boolean;
|
|
231
|
+
goldenRuleComplied?: boolean;
|
|
232
|
+
notes?: string;
|
|
233
|
+
};
|
|
234
|
+
export type Codicil = {
|
|
235
|
+
id: string;
|
|
236
|
+
date: string;
|
|
237
|
+
description?: string;
|
|
238
|
+
attestation?: Attestation;
|
|
239
|
+
documentId?: string;
|
|
240
|
+
};
|
|
241
|
+
export type ForcedHeirship = {
|
|
242
|
+
applies?: boolean;
|
|
243
|
+
reservedPortion?: number;
|
|
244
|
+
disposableQuota?: number;
|
|
245
|
+
jurisdiction?: Jurisdiction;
|
|
246
|
+
claimNature?: 'property_share' | 'cash_claim' | 'usufruct' | 'court_discretion';
|
|
247
|
+
calculationBasis?: 'fixed' | 'per_child_sliding' | 'court_discretion' | 'conditional';
|
|
248
|
+
applicableTo?: 'children_only' | 'children_and_spouse' | 'all_descendants' | 'all_heirs';
|
|
249
|
+
deferralRule?: string;
|
|
250
|
+
effectiveDate?: string;
|
|
251
|
+
reformVersion?: string;
|
|
252
|
+
notes?: string;
|
|
253
|
+
};
|
|
254
|
+
export type AdjudicatingBody = {
|
|
255
|
+
type: 'secular_court' | 'religious_court' | 'beth_din' | 'shariah_court' | 'tribal_court' | 'family_court' | 'family_council' | 'community_elders' | 'partition_meeting' | 'karta_decision' | 'maori_land_court' | 'high_court';
|
|
256
|
+
name?: string;
|
|
257
|
+
jurisdiction?: Jurisdiction;
|
|
258
|
+
caseReference?: string;
|
|
259
|
+
authoritative?: boolean;
|
|
260
|
+
};
|
|
261
|
+
export type ParallelDistribution = {
|
|
262
|
+
system: string;
|
|
263
|
+
jurisdiction?: Jurisdiction;
|
|
264
|
+
description?: string;
|
|
265
|
+
notes?: string;
|
|
266
|
+
};
|
|
267
|
+
export type ProbateGrant = {
|
|
268
|
+
grantType?: string;
|
|
269
|
+
grantDate?: string;
|
|
270
|
+
grantReference?: string;
|
|
271
|
+
issuingCourt?: string;
|
|
272
|
+
jurisdiction?: Jurisdiction;
|
|
273
|
+
notes?: string;
|
|
274
|
+
};
|
|
275
|
+
export type DeathRecord = {
|
|
276
|
+
dateOfDeath?: string;
|
|
277
|
+
placeOfDeath?: string;
|
|
278
|
+
deathCertificateRef?: string;
|
|
279
|
+
domicileAtDeath?: Jurisdiction;
|
|
280
|
+
notes?: string;
|
|
281
|
+
};
|
|
282
|
+
export type SuccessionConflict = {
|
|
283
|
+
description: string;
|
|
284
|
+
systems?: Array<string>;
|
|
285
|
+
resolutionStatus?: 'unresolved' | 'resolved' | 'pending_court' | 'pending_arbitration';
|
|
286
|
+
notes?: string;
|
|
287
|
+
};
|
|
288
|
+
/**
|
|
289
|
+
* Estate
|
|
290
|
+
*
|
|
291
|
+
* The root estate record — will, intestacy, or trust-based succession plan. Contains testator details, jurisdiction, will formalities, forced heirship, probate grants, death record, multi-jurisdiction administration, and tax treaty positions.
|
|
292
|
+
*/
|
|
293
|
+
export type Estate = {
|
|
294
|
+
id: string;
|
|
295
|
+
testatorPersonId: string;
|
|
296
|
+
status: 'draft' | 'active' | 'locked' | 'archived';
|
|
297
|
+
jurisdiction: Jurisdiction;
|
|
298
|
+
willType?: 'secular' | 'religious' | 'dual' | 'composite' | 'oral_witnessed' | 'oral_customary' | 'holographic' | 'notarised' | 'privileged_will';
|
|
299
|
+
extensionWillType?: string;
|
|
300
|
+
companionEstateId?: string;
|
|
301
|
+
primaryInstrument?: 'will' | 'revocable_trust' | 'both' | 'intestacy';
|
|
302
|
+
defaultPropertyRegime?: 'community_property' | 'separate_property' | 'equitable_distribution' | 'deferred_community' | 'universal_community' | 'participation_in_acquisitions' | 'islamic_dower';
|
|
303
|
+
totalEstimatedValue?: Money;
|
|
304
|
+
attestation?: Attestation;
|
|
305
|
+
testamentaryCapacity?: TestamentaryCapacity;
|
|
306
|
+
codicils?: Array<Codicil>;
|
|
307
|
+
revokesDocumentIds?: Array<string>;
|
|
308
|
+
revocationClause?: boolean;
|
|
309
|
+
forcedHeirship?: ForcedHeirship;
|
|
310
|
+
adjudicatingBodies?: Array<AdjudicatingBody>;
|
|
311
|
+
parallelDistributions?: Array<ParallelDistribution>;
|
|
312
|
+
probateGrant?: ProbateGrant;
|
|
313
|
+
deathRecord?: DeathRecord;
|
|
314
|
+
successionConflicts?: Array<SuccessionConflict>;
|
|
315
|
+
choiceOfLaw?: {
|
|
316
|
+
chosenLaw?: Jurisdiction;
|
|
317
|
+
basis?: string;
|
|
318
|
+
documentRef?: string;
|
|
319
|
+
};
|
|
320
|
+
electiveShareRight?: {
|
|
321
|
+
available?: boolean;
|
|
322
|
+
electedAmount?: Money;
|
|
323
|
+
statute?: string;
|
|
324
|
+
notes?: string;
|
|
325
|
+
};
|
|
326
|
+
priorMatrimonialClaim?: {
|
|
327
|
+
exists?: boolean;
|
|
328
|
+
description?: string;
|
|
329
|
+
claimantPersonId?: string;
|
|
330
|
+
notes?: string;
|
|
331
|
+
};
|
|
332
|
+
noContestClause?: {
|
|
333
|
+
present?: boolean;
|
|
334
|
+
enforceability?: string;
|
|
335
|
+
notes?: string;
|
|
336
|
+
};
|
|
337
|
+
pretermittedHeirClaims?: Array<{
|
|
338
|
+
claimantPersonId?: string;
|
|
339
|
+
status?: string;
|
|
340
|
+
notes?: string;
|
|
341
|
+
}>;
|
|
342
|
+
testamentaryPromises?: Array<{
|
|
343
|
+
claimantPersonId?: string;
|
|
344
|
+
promiseDescription?: string;
|
|
345
|
+
status?: string;
|
|
346
|
+
notes?: string;
|
|
347
|
+
}>;
|
|
348
|
+
judicialVariationPower?: {
|
|
349
|
+
available?: boolean;
|
|
350
|
+
statute?: string;
|
|
351
|
+
notes?: string;
|
|
352
|
+
};
|
|
353
|
+
commorientesRule?: {
|
|
354
|
+
applicable?: boolean;
|
|
355
|
+
rule?: string;
|
|
356
|
+
jurisdiction?: Jurisdiction;
|
|
357
|
+
notes?: string;
|
|
358
|
+
};
|
|
359
|
+
ancillaryProbate?: Array<{
|
|
360
|
+
jurisdiction: Jurisdiction;
|
|
361
|
+
fiduciaryPersonId?: string;
|
|
362
|
+
status?: 'not_started' | 'applied' | 'granted' | 'completed' | 'waived';
|
|
363
|
+
grantReference?: string;
|
|
364
|
+
localCounsel?: string;
|
|
365
|
+
notes?: string;
|
|
366
|
+
}>;
|
|
367
|
+
registrations?: Array<{
|
|
368
|
+
registry: string;
|
|
369
|
+
registrationNumber?: string;
|
|
370
|
+
jurisdictionScope?: string;
|
|
371
|
+
registrationDate?: string;
|
|
372
|
+
}>;
|
|
373
|
+
reportingCurrency?: string;
|
|
374
|
+
conversionRates?: Array<{
|
|
375
|
+
fromCurrency: string;
|
|
376
|
+
toCurrency: string;
|
|
377
|
+
rate: number;
|
|
378
|
+
rateDate: string;
|
|
379
|
+
source?: string;
|
|
380
|
+
}>;
|
|
381
|
+
taxTreatyPositions?: Array<{
|
|
382
|
+
treaty: string;
|
|
383
|
+
primaryTaxingJurisdiction?: Jurisdiction;
|
|
384
|
+
claimedCredits?: string;
|
|
385
|
+
relevantArticle?: string;
|
|
386
|
+
notes?: string;
|
|
387
|
+
}>;
|
|
388
|
+
suggestedPractitionerNeeds?: Array<string>;
|
|
389
|
+
createdAt: string;
|
|
390
|
+
lastModifiedAt: string;
|
|
391
|
+
notes?: string;
|
|
392
|
+
[key: string]: unknown | string | 'draft' | 'active' | 'locked' | 'archived' | Jurisdiction | 'secular' | 'religious' | 'dual' | 'composite' | 'oral_witnessed' | 'oral_customary' | 'holographic' | 'notarised' | 'privileged_will' | string | 'will' | 'revocable_trust' | 'both' | 'intestacy' | 'community_property' | 'separate_property' | 'equitable_distribution' | 'deferred_community' | 'universal_community' | 'participation_in_acquisitions' | 'islamic_dower' | Money | Attestation | TestamentaryCapacity | Array<Codicil> | Array<string> | boolean | ForcedHeirship | Array<AdjudicatingBody> | Array<ParallelDistribution> | ProbateGrant | DeathRecord | Array<SuccessionConflict> | {
|
|
393
|
+
chosenLaw?: Jurisdiction;
|
|
394
|
+
basis?: string;
|
|
395
|
+
documentRef?: string;
|
|
396
|
+
} | {
|
|
397
|
+
available?: boolean;
|
|
398
|
+
electedAmount?: Money;
|
|
399
|
+
statute?: string;
|
|
400
|
+
notes?: string;
|
|
401
|
+
} | {
|
|
402
|
+
exists?: boolean;
|
|
403
|
+
description?: string;
|
|
404
|
+
claimantPersonId?: string;
|
|
405
|
+
notes?: string;
|
|
406
|
+
} | {
|
|
407
|
+
present?: boolean;
|
|
408
|
+
enforceability?: string;
|
|
409
|
+
notes?: string;
|
|
410
|
+
} | Array<{
|
|
411
|
+
claimantPersonId?: string;
|
|
412
|
+
status?: string;
|
|
413
|
+
notes?: string;
|
|
414
|
+
}> | Array<{
|
|
415
|
+
claimantPersonId?: string;
|
|
416
|
+
promiseDescription?: string;
|
|
417
|
+
status?: string;
|
|
418
|
+
notes?: string;
|
|
419
|
+
}> | {
|
|
420
|
+
available?: boolean;
|
|
421
|
+
statute?: string;
|
|
422
|
+
notes?: string;
|
|
423
|
+
} | {
|
|
424
|
+
applicable?: boolean;
|
|
425
|
+
rule?: string;
|
|
426
|
+
jurisdiction?: Jurisdiction;
|
|
427
|
+
notes?: string;
|
|
428
|
+
} | Array<{
|
|
429
|
+
jurisdiction: Jurisdiction;
|
|
430
|
+
fiduciaryPersonId?: string;
|
|
431
|
+
status?: 'not_started' | 'applied' | 'granted' | 'completed' | 'waived';
|
|
432
|
+
grantReference?: string;
|
|
433
|
+
localCounsel?: string;
|
|
434
|
+
notes?: string;
|
|
435
|
+
}> | Array<{
|
|
436
|
+
registry: string;
|
|
437
|
+
registrationNumber?: string;
|
|
438
|
+
jurisdictionScope?: string;
|
|
439
|
+
registrationDate?: string;
|
|
440
|
+
}> | string | Array<{
|
|
441
|
+
fromCurrency: string;
|
|
442
|
+
toCurrency: string;
|
|
443
|
+
rate: number;
|
|
444
|
+
rateDate: string;
|
|
445
|
+
source?: string;
|
|
446
|
+
}> | Array<{
|
|
447
|
+
treaty: string;
|
|
448
|
+
primaryTaxingJurisdiction?: Jurisdiction;
|
|
449
|
+
claimedCredits?: string;
|
|
450
|
+
relevantArticle?: string;
|
|
451
|
+
notes?: string;
|
|
452
|
+
}> | Array<string> | string | undefined;
|
|
453
|
+
};
|
|
454
|
+
/**
|
|
455
|
+
* PostalAddress
|
|
456
|
+
*
|
|
457
|
+
* A physical address. Culturally neutral — supports any global addressing convention.
|
|
458
|
+
*/
|
|
459
|
+
export type Address = {
|
|
460
|
+
/**
|
|
461
|
+
* Street number and name
|
|
462
|
+
*/
|
|
463
|
+
streetAddress?: string;
|
|
464
|
+
/**
|
|
465
|
+
* Flat, suite, building, floor
|
|
466
|
+
*/
|
|
467
|
+
addressLine2?: string;
|
|
468
|
+
/**
|
|
469
|
+
* City, town, village, or ward
|
|
470
|
+
*/
|
|
471
|
+
addressLocality?: string;
|
|
472
|
+
/**
|
|
473
|
+
* State, prefecture, province, county
|
|
474
|
+
*/
|
|
475
|
+
addressRegion?: string;
|
|
476
|
+
postalCode?: string;
|
|
477
|
+
/**
|
|
478
|
+
* ISO 3166-1 alpha-2
|
|
479
|
+
*/
|
|
480
|
+
addressCountry?: string;
|
|
481
|
+
latitude?: number;
|
|
482
|
+
longitude?: number;
|
|
483
|
+
landmark?: string;
|
|
484
|
+
directionNotes?: string;
|
|
485
|
+
addressOrder?: 'western' | 'japanese' | 'indian' | 'arabic' | 'custom';
|
|
486
|
+
};
|
|
487
|
+
/**
|
|
488
|
+
* Identifier
|
|
489
|
+
*
|
|
490
|
+
* A typed external identifier. Use 'system' to namespace (e.g. 'urn:hmrc:nino').
|
|
491
|
+
*/
|
|
492
|
+
export type Identifier = {
|
|
493
|
+
/**
|
|
494
|
+
* Namespace URI or name
|
|
495
|
+
*/
|
|
496
|
+
system?: string;
|
|
497
|
+
/**
|
|
498
|
+
* The identifier value
|
|
499
|
+
*/
|
|
500
|
+
value: string;
|
|
501
|
+
/**
|
|
502
|
+
* Type label (e.g. 'passport', 'national_insurance', 'charity_number')
|
|
503
|
+
*/
|
|
504
|
+
type?: string;
|
|
505
|
+
};
|
|
506
|
+
/**
|
|
507
|
+
* Person
|
|
508
|
+
*
|
|
509
|
+
* A person involved in the estate. Schema.org name alignment. Any Unicode script. Supports CJK phonetic readings, chieftaincy titles, clan/lineage identifiers, dual legal personalities, and tax residency across multiple jurisdictions.
|
|
510
|
+
*/
|
|
511
|
+
export type Person = {
|
|
512
|
+
id: string;
|
|
513
|
+
/**
|
|
514
|
+
* First/given name (Schema.org: givenName)
|
|
515
|
+
*/
|
|
516
|
+
givenName: string;
|
|
517
|
+
/**
|
|
518
|
+
* Last/family/surname (Schema.org: familyName)
|
|
519
|
+
*/
|
|
520
|
+
familyName?: string;
|
|
521
|
+
/**
|
|
522
|
+
* Middle name(s) (Schema.org: additionalName)
|
|
523
|
+
*/
|
|
524
|
+
additionalName?: string;
|
|
525
|
+
/**
|
|
526
|
+
* Name the person prefers to be called
|
|
527
|
+
*/
|
|
528
|
+
preferredName?: string;
|
|
529
|
+
phoneticReading?: {
|
|
530
|
+
givenName?: string;
|
|
531
|
+
familyName?: string;
|
|
532
|
+
fullName?: string;
|
|
533
|
+
};
|
|
534
|
+
titles?: Array<{
|
|
535
|
+
title: string;
|
|
536
|
+
type?: 'chieftaincy' | 'traditional' | 'religious' | 'professional' | 'honorific' | 'clan' | 'academic' | 'military' | 'other';
|
|
537
|
+
}>;
|
|
538
|
+
clanOrLineage?: string;
|
|
539
|
+
/**
|
|
540
|
+
* ISO 8601 date of birth
|
|
541
|
+
*/
|
|
542
|
+
dateOfBirth?: string;
|
|
543
|
+
/**
|
|
544
|
+
* ISO 8601 date of death (if deceased)
|
|
545
|
+
*/
|
|
546
|
+
dateOfDeath?: string;
|
|
547
|
+
gender?: 'male' | 'female' | 'non_binary' | 'other' | 'prefer_not_to_say' | 'unknown';
|
|
548
|
+
domicile?: Jurisdiction;
|
|
549
|
+
roles: Array<'testator' | 'beneficiary' | 'executor' | 'guardian' | 'trustee' | 'witness' | 'attorney' | 'proxy' | 'protector' | 'enforcer'>;
|
|
550
|
+
contact?: {
|
|
551
|
+
email?: string;
|
|
552
|
+
/**
|
|
553
|
+
* Phone number (E.164 recommended)
|
|
554
|
+
*/
|
|
555
|
+
phone?: string;
|
|
556
|
+
address?: Address;
|
|
557
|
+
};
|
|
558
|
+
/**
|
|
559
|
+
* External identifiers (passport, national ID, etc.)
|
|
560
|
+
*/
|
|
561
|
+
identifiers?: Array<Identifier>;
|
|
562
|
+
ritualName?: {
|
|
563
|
+
/**
|
|
564
|
+
* The full ritual/religious name
|
|
565
|
+
*/
|
|
566
|
+
name: string;
|
|
567
|
+
/**
|
|
568
|
+
* Patronymic element (ben/bat, ibn/bint, etc.)
|
|
569
|
+
*/
|
|
570
|
+
patronymic?: string;
|
|
571
|
+
/**
|
|
572
|
+
* Naming tradition: hebrew, arabic_nasab, hindu, buddhist, etc.
|
|
573
|
+
*/
|
|
574
|
+
nameSystem?: string;
|
|
575
|
+
};
|
|
576
|
+
legalPersonalities?: Array<{
|
|
577
|
+
system: 'statutory' | 'customary' | 'religious' | 'traditional';
|
|
578
|
+
role: string;
|
|
579
|
+
jurisdiction?: Jurisdiction;
|
|
580
|
+
notes?: string;
|
|
581
|
+
}>;
|
|
582
|
+
taxResidency?: Array<{
|
|
583
|
+
jurisdiction: Jurisdiction;
|
|
584
|
+
taxpayerIdentifier?: string;
|
|
585
|
+
treatyPosition?: string;
|
|
586
|
+
fatcaStatus?: 'us_person' | 'non_us_person' | 'exempt' | 'unknown';
|
|
587
|
+
}>;
|
|
588
|
+
/**
|
|
589
|
+
* BCP 47 language tag for preferred language
|
|
590
|
+
*/
|
|
591
|
+
language?: string;
|
|
592
|
+
notes?: string;
|
|
593
|
+
[key: string]: unknown | string | string | string | {
|
|
594
|
+
givenName?: string;
|
|
595
|
+
familyName?: string;
|
|
596
|
+
fullName?: string;
|
|
597
|
+
} | Array<{
|
|
598
|
+
title: string;
|
|
599
|
+
type?: 'chieftaincy' | 'traditional' | 'religious' | 'professional' | 'honorific' | 'clan' | 'academic' | 'military' | 'other';
|
|
600
|
+
}> | string | 'male' | 'female' | 'non_binary' | 'other' | 'prefer_not_to_say' | 'unknown' | Jurisdiction | Array<'testator' | 'beneficiary' | 'executor' | 'guardian' | 'trustee' | 'witness' | 'attorney' | 'proxy' | 'protector' | 'enforcer'> | {
|
|
601
|
+
email?: string;
|
|
602
|
+
/**
|
|
603
|
+
* Phone number (E.164 recommended)
|
|
604
|
+
*/
|
|
605
|
+
phone?: string;
|
|
606
|
+
address?: Address;
|
|
607
|
+
} | Array<Identifier> | {
|
|
608
|
+
/**
|
|
609
|
+
* The full ritual/religious name
|
|
610
|
+
*/
|
|
611
|
+
name: string;
|
|
612
|
+
/**
|
|
613
|
+
* Patronymic element (ben/bat, ibn/bint, etc.)
|
|
614
|
+
*/
|
|
615
|
+
patronymic?: string;
|
|
616
|
+
/**
|
|
617
|
+
* Naming tradition: hebrew, arabic_nasab, hindu, buddhist, etc.
|
|
618
|
+
*/
|
|
619
|
+
nameSystem?: string;
|
|
620
|
+
} | Array<{
|
|
621
|
+
system: 'statutory' | 'customary' | 'religious' | 'traditional';
|
|
622
|
+
role: string;
|
|
623
|
+
jurisdiction?: Jurisdiction;
|
|
624
|
+
notes?: string;
|
|
625
|
+
}> | Array<{
|
|
626
|
+
jurisdiction: Jurisdiction;
|
|
627
|
+
taxpayerIdentifier?: string;
|
|
628
|
+
treatyPosition?: string;
|
|
629
|
+
fatcaStatus?: 'us_person' | 'non_us_person' | 'exempt' | 'unknown';
|
|
630
|
+
}> | undefined;
|
|
631
|
+
};
|
|
632
|
+
export type Partner = {
|
|
633
|
+
/**
|
|
634
|
+
* Reference to a Person.id
|
|
635
|
+
*/
|
|
636
|
+
personId: string;
|
|
637
|
+
/**
|
|
638
|
+
* Optional non-gendered label (e.g. 'First Wife', 'Partner A')
|
|
639
|
+
*/
|
|
640
|
+
displayLabel?: string;
|
|
641
|
+
/**
|
|
642
|
+
* Position in partner list (1-based)
|
|
643
|
+
*/
|
|
644
|
+
ordinal: number;
|
|
645
|
+
};
|
|
646
|
+
export type RelationshipEvent = {
|
|
647
|
+
type: 'CEREMONY' | 'REGISTRATION' | 'ENGAGEMENT' | 'MARRIAGE_CONTRACT' | 'PROPERTY_REGIME_CHANGE' | 'SEPARATION_INFORMAL' | 'SEPARATION_LEGAL' | 'DIVORCE_FILED' | 'DIVORCE_FINALISED' | 'FINANCIAL_ORDER' | 'ANNULMENT' | 'DISSOLUTION' | 'DEATH_OF_PARTNER' | 'RECONCILIATION' | 'VOID_DECLARATION' | 'MAHR_PAYMENT' | 'LOBOLA_PAYMENT';
|
|
648
|
+
/**
|
|
649
|
+
* ISO 8601 date
|
|
650
|
+
*/
|
|
651
|
+
date: string;
|
|
652
|
+
jurisdiction?: Jurisdiction;
|
|
653
|
+
notes?: string;
|
|
654
|
+
};
|
|
655
|
+
export type JurisdictionalRecognition = {
|
|
656
|
+
jurisdiction: Jurisdiction;
|
|
657
|
+
recognised: boolean;
|
|
658
|
+
/**
|
|
659
|
+
* What this jurisdiction recognises it as (if different)
|
|
660
|
+
*/
|
|
661
|
+
recognisedAs?: string;
|
|
662
|
+
notes?: string;
|
|
663
|
+
};
|
|
664
|
+
export type FinancialInstrument = unknown & {
|
|
665
|
+
type: 'MAHR' | 'KETUBAH' | 'LOBOLA' | 'PRENUPTIAL_AGREEMENT' | 'POSTNUPTIAL_AGREEMENT' | 'MARRIAGE_SETTLEMENT';
|
|
666
|
+
value?: Money;
|
|
667
|
+
status?: 'AGREED' | 'PAID' | 'PARTIALLY_PAID' | 'DEFERRED' | 'DISPUTED' | 'WAIVED';
|
|
668
|
+
description?: string;
|
|
669
|
+
/**
|
|
670
|
+
* Reference to a Document.id
|
|
671
|
+
*/
|
|
672
|
+
documentRef?: string;
|
|
673
|
+
date?: string;
|
|
674
|
+
/**
|
|
675
|
+
* How this affects inheritance distribution
|
|
676
|
+
*/
|
|
677
|
+
inheritanceImpact?: string;
|
|
678
|
+
maharDetails?: {
|
|
679
|
+
maharType?: 'prompt' | 'deferred' | 'combination';
|
|
680
|
+
recipientPersonId?: string;
|
|
681
|
+
linkedLiabilityId?: string;
|
|
682
|
+
};
|
|
683
|
+
ketubahDetails?: {
|
|
684
|
+
principalAmount?: Money;
|
|
685
|
+
tosefetAmount?: Money;
|
|
686
|
+
nedunya?: Money;
|
|
687
|
+
brideStatus?: 'virgin' | 'widow' | 'divorcee';
|
|
688
|
+
witnessPersonIds?: Array<string>;
|
|
689
|
+
officiatingRabbi?: string;
|
|
690
|
+
};
|
|
691
|
+
lobolaDetails?: {
|
|
692
|
+
negotiatedWith?: string;
|
|
693
|
+
includesLivestock?: boolean;
|
|
694
|
+
livestockCount?: number;
|
|
695
|
+
};
|
|
696
|
+
};
|
|
697
|
+
/**
|
|
698
|
+
* Relationship
|
|
699
|
+
*
|
|
700
|
+
* Spousal/partnership relationship. N-partner support (no structural two-partner limit). Event-based timeline (status derived from events). No gendered role names. Financial instruments with MAHR/KETUBAH subtype validation. Cross-jurisdiction recognition for dual civil/religious status.
|
|
701
|
+
*/
|
|
702
|
+
export type Relationship = {
|
|
703
|
+
id: string;
|
|
704
|
+
type: 'MARRIAGE_CIVIL' | 'MARRIAGE_RELIGIOUS' | 'MARRIAGE_CUSTOMARY' | 'MARRIAGE_COMMON_LAW' | 'CIVIL_PARTNERSHIP' | 'CIVIL_UNION' | 'DOMESTIC_PARTNERSHIP' | 'DE_FACTO' | 'COHABITATION' | 'ENGAGEMENT';
|
|
705
|
+
religiousSubtype?: string;
|
|
706
|
+
/**
|
|
707
|
+
* How the parties themselves describe this relationship
|
|
708
|
+
*/
|
|
709
|
+
selfDeclaredType?: string;
|
|
710
|
+
/**
|
|
711
|
+
* The people in this relationship. Minimum 2, no structural upper limit.
|
|
712
|
+
*/
|
|
713
|
+
partners: Array<Partner>;
|
|
714
|
+
/**
|
|
715
|
+
* Chronological events determining relationship status
|
|
716
|
+
*/
|
|
717
|
+
events?: Array<RelationshipEvent>;
|
|
718
|
+
currentStatus?: 'ACTIVE' | 'SEPARATED_INFORMAL' | 'SEPARATED_LEGAL' | 'DIVORCED' | 'ANNULLED' | 'DISSOLVED' | 'WIDOWED' | 'VOID' | 'PUTATIVE';
|
|
719
|
+
/**
|
|
720
|
+
* Primary jurisdiction where this relationship was formed
|
|
721
|
+
*/
|
|
722
|
+
jurisdiction?: Jurisdiction;
|
|
723
|
+
/**
|
|
724
|
+
* How other jurisdictions recognise (or don't) this relationship
|
|
725
|
+
*/
|
|
726
|
+
jurisdictionalRecognition?: Array<JurisdictionalRecognition>;
|
|
727
|
+
/**
|
|
728
|
+
* Mahr, ketubah, lobola, prenuptial agreements, etc.
|
|
729
|
+
*/
|
|
730
|
+
financialInstruments?: Array<FinancialInstrument>;
|
|
731
|
+
/**
|
|
732
|
+
* The marital property regime
|
|
733
|
+
*/
|
|
734
|
+
propertyRegime?: 'COMMUNITY_OF_PROPERTY' | 'SEPARATION_OF_PROPERTY' | 'COMMUNITY_OF_ACQUESTS' | 'DEFERRED_COMMUNITY' | 'SEPARATE_AS_MODIFIED' | 'ISLAMIC_DOWER' | 'US_COMMUNITY_PROPERTY' | 'US_COMMUNITY_WITH_SURVIVORSHIP' | 'US_QUASI_COMMUNITY' | 'HINDU_SEPARATE';
|
|
735
|
+
notes?: string;
|
|
736
|
+
[key: string]: unknown | string | 'MARRIAGE_CIVIL' | 'MARRIAGE_RELIGIOUS' | 'MARRIAGE_CUSTOMARY' | 'MARRIAGE_COMMON_LAW' | 'CIVIL_PARTNERSHIP' | 'CIVIL_UNION' | 'DOMESTIC_PARTNERSHIP' | 'DE_FACTO' | 'COHABITATION' | 'ENGAGEMENT' | string | Array<Partner> | Array<RelationshipEvent> | 'ACTIVE' | 'SEPARATED_INFORMAL' | 'SEPARATED_LEGAL' | 'DIVORCED' | 'ANNULLED' | 'DISSOLVED' | 'WIDOWED' | 'VOID' | 'PUTATIVE' | Jurisdiction | Array<JurisdictionalRecognition> | Array<FinancialInstrument> | 'COMMUNITY_OF_PROPERTY' | 'SEPARATION_OF_PROPERTY' | 'COMMUNITY_OF_ACQUESTS' | 'DEFERRED_COMMUNITY' | 'SEPARATE_AS_MODIFIED' | 'ISLAMIC_DOWER' | 'US_COMMUNITY_PROPERTY' | 'US_COMMUNITY_WITH_SURVIVORSHIP' | 'US_QUASI_COMMUNITY' | 'HINDU_SEPARATE' | undefined;
|
|
737
|
+
};
|
|
738
|
+
/**
|
|
739
|
+
* Kinship
|
|
740
|
+
*
|
|
741
|
+
* A familial bond between two people. Essential for intestacy calculation — inheritance rules in every jurisdiction depend on parent-child, sibling, and other familial relationships. Direction: fromPersonId is the parent/elder, toPersonId is the child/younger (for parent-child types). Indian extensions may add PARENT_CHILD_COPARCENARY, KARTA_MEMBER. See extensions/india-hindu.json.
|
|
742
|
+
*/
|
|
743
|
+
export type Kinship = {
|
|
744
|
+
id: string;
|
|
745
|
+
type: 'PARENT_CHILD_BIOLOGICAL' | 'PARENT_CHILD_ADOPTED' | 'PARENT_CHILD_STEP' | 'PARENT_CHILD_FOSTER' | 'PARENT_CHILD_ACKNOWLEDGED' | 'SIBLING' | 'HALF_SIBLING_PATERNAL' | 'HALF_SIBLING_MATERNAL' | 'STEP_SIBLING' | 'GRANDPARENT_GRANDCHILD' | 'UNCLE_NEPHEW' | 'AUNT_NEPHEW';
|
|
746
|
+
/**
|
|
747
|
+
* Parent/elder person in the kinship (Person.id)
|
|
748
|
+
*/
|
|
749
|
+
fromPersonId: string;
|
|
750
|
+
/**
|
|
751
|
+
* Child/younger person in the kinship (Person.id)
|
|
752
|
+
*/
|
|
753
|
+
toPersonId: string;
|
|
754
|
+
/**
|
|
755
|
+
* Legal recognition status of this familial bond
|
|
756
|
+
*/
|
|
757
|
+
legalStatus?: 'recognised' | 'contested' | 'pending' | 'unrecognised';
|
|
758
|
+
legitimacy?: 'legitimate' | 'illegitimate' | 'legitimated' | 'not_applicable';
|
|
759
|
+
/**
|
|
760
|
+
* Date of adoption order (for PARENT_CHILD_ADOPTED)
|
|
761
|
+
*/
|
|
762
|
+
adoptionDate?: string;
|
|
763
|
+
/**
|
|
764
|
+
* Court order or adoption certificate reference
|
|
765
|
+
*/
|
|
766
|
+
courtOrderRef?: string;
|
|
767
|
+
notes?: string;
|
|
768
|
+
[key: string]: unknown | string | 'PARENT_CHILD_BIOLOGICAL' | 'PARENT_CHILD_ADOPTED' | 'PARENT_CHILD_STEP' | 'PARENT_CHILD_FOSTER' | 'PARENT_CHILD_ACKNOWLEDGED' | 'SIBLING' | 'HALF_SIBLING_PATERNAL' | 'HALF_SIBLING_MATERNAL' | 'STEP_SIBLING' | 'GRANDPARENT_GRANDCHILD' | 'UNCLE_NEPHEW' | 'AUNT_NEPHEW' | 'recognised' | 'contested' | 'pending' | 'unrecognised' | 'legitimate' | 'illegitimate' | 'legitimated' | 'not_applicable' | string | string | undefined;
|
|
769
|
+
};
|
|
770
|
+
/**
|
|
771
|
+
* Property
|
|
772
|
+
*
|
|
773
|
+
* Real estate. Supports individual ownership, communal/family property (Nigeria), HUF coparcenary (India), government-vested land (Land Use Act), US community property, and informal/unregistered holdings.
|
|
774
|
+
*/
|
|
775
|
+
export type Property = {
|
|
776
|
+
id: string;
|
|
777
|
+
/**
|
|
778
|
+
* Display name (e.g. 'Family Home', '42 Acacia Avenue')
|
|
779
|
+
*/
|
|
780
|
+
name: string;
|
|
781
|
+
propertyType?: 'detached_house' | 'semi_detached_house' | 'terraced_house' | 'flat' | 'maisonette' | 'bungalow' | 'cottage' | 'farmhouse' | 'barn_conversion' | 'land' | 'commercial' | 'mixed_use' | 'houseboat' | 'mobile_home' | 'other';
|
|
782
|
+
address?: Address;
|
|
783
|
+
estimatedValue?: Money;
|
|
784
|
+
professionalValuation?: Money;
|
|
785
|
+
valuationDate?: string;
|
|
786
|
+
valuationConfidence?: 'estimated' | 'professional' | 'probate' | 'unknown';
|
|
787
|
+
isPrimaryResidence?: boolean;
|
|
788
|
+
ownershipType?: 'sole' | 'joint_tenants' | 'tenants_in_common' | 'trust' | 'tenancy_by_entirety';
|
|
789
|
+
ownershipPercentage?: number;
|
|
790
|
+
ownershipModel?: 'individual' | 'joint' | 'communal_family' | 'huf_coparcenary' | 'tribal' | 'government_vested' | 'trust_held';
|
|
791
|
+
acquisitionType?: 'self_acquired' | 'ancestral_joint' | 'ancestral_severed' | 'inherited' | 'gifted' | 'stridhan' | 'communal' | 'waqf_endowed';
|
|
792
|
+
tenureType?: 'freehold' | 'leasehold' | 'certificate_of_occupancy' | 'customary_right_of_occupancy' | 'communal' | 'government_allocated' | 'traditional_authority_granted' | 'informal_unregistered';
|
|
793
|
+
registrationStatus?: 'formally_registered' | 'informally_held' | 'community_acknowledged' | 'disputed' | 'undocumented';
|
|
794
|
+
ownershipEvidence?: 'title_deed' | 'certificate_of_occupancy' | 'family_recognition' | 'community_testimony' | 'receipts_only' | 'none';
|
|
795
|
+
applicableSuccessionLaw?: {
|
|
796
|
+
jurisdiction: Jurisdiction;
|
|
797
|
+
lawName?: string;
|
|
798
|
+
section?: string;
|
|
799
|
+
};
|
|
800
|
+
custodianPersonId?: string;
|
|
801
|
+
successionRule?: 'testamentary' | 'intestacy' | 'customary_eldest_son' | 'customary_family_council' | 'customary_matrilineal' | 'survivorship' | 'not_individually_bequeathable';
|
|
802
|
+
governmentConsentRequired?: boolean;
|
|
803
|
+
mobilityType?: 'immoveable' | 'moveable' | 'mixed';
|
|
804
|
+
mortgageOutstanding?: Money;
|
|
805
|
+
characterClassification?: 'community' | 'separate' | 'quasi_community' | 'mixed' | 'not_applicable';
|
|
806
|
+
homesteadStatus?: {
|
|
807
|
+
isHomestead?: boolean;
|
|
808
|
+
exemptionAmount?: Money;
|
|
809
|
+
exemptionUnlimited?: boolean;
|
|
810
|
+
deviseRestriction?: boolean;
|
|
811
|
+
notes?: string;
|
|
812
|
+
};
|
|
813
|
+
passesOutsideEstate?: boolean;
|
|
814
|
+
statutoryLifeEstate?: {
|
|
815
|
+
beneficiaryPersonId?: string;
|
|
816
|
+
basis?: string;
|
|
817
|
+
conditions?: string;
|
|
818
|
+
};
|
|
819
|
+
notes?: string;
|
|
820
|
+
[key: string]: unknown | string | string | 'detached_house' | 'semi_detached_house' | 'terraced_house' | 'flat' | 'maisonette' | 'bungalow' | 'cottage' | 'farmhouse' | 'barn_conversion' | 'land' | 'commercial' | 'mixed_use' | 'houseboat' | 'mobile_home' | 'other' | Address | Money | string | 'estimated' | 'professional' | 'probate' | 'unknown' | boolean | 'sole' | 'joint_tenants' | 'tenants_in_common' | 'trust' | 'tenancy_by_entirety' | number | 'individual' | 'joint' | 'communal_family' | 'huf_coparcenary' | 'tribal' | 'government_vested' | 'trust_held' | 'self_acquired' | 'ancestral_joint' | 'ancestral_severed' | 'inherited' | 'gifted' | 'stridhan' | 'communal' | 'waqf_endowed' | 'freehold' | 'leasehold' | 'certificate_of_occupancy' | 'customary_right_of_occupancy' | 'communal' | 'government_allocated' | 'traditional_authority_granted' | 'informal_unregistered' | 'formally_registered' | 'informally_held' | 'community_acknowledged' | 'disputed' | 'undocumented' | 'title_deed' | 'certificate_of_occupancy' | 'family_recognition' | 'community_testimony' | 'receipts_only' | 'none' | {
|
|
821
|
+
jurisdiction: Jurisdiction;
|
|
822
|
+
lawName?: string;
|
|
823
|
+
section?: string;
|
|
824
|
+
} | 'testamentary' | 'intestacy' | 'customary_eldest_son' | 'customary_family_council' | 'customary_matrilineal' | 'survivorship' | 'not_individually_bequeathable' | 'immoveable' | 'moveable' | 'mixed' | 'community' | 'separate' | 'quasi_community' | 'mixed' | 'not_applicable' | {
|
|
825
|
+
isHomestead?: boolean;
|
|
826
|
+
exemptionAmount?: Money;
|
|
827
|
+
exemptionUnlimited?: boolean;
|
|
828
|
+
deviseRestriction?: boolean;
|
|
829
|
+
notes?: string;
|
|
830
|
+
} | {
|
|
831
|
+
beneficiaryPersonId?: string;
|
|
832
|
+
basis?: string;
|
|
833
|
+
conditions?: string;
|
|
834
|
+
} | string | undefined;
|
|
835
|
+
};
|
|
836
|
+
export type Photo = {
|
|
837
|
+
url: string;
|
|
838
|
+
caption?: string;
|
|
839
|
+
};
|
|
840
|
+
/**
|
|
841
|
+
* Asset
|
|
842
|
+
*
|
|
843
|
+
* A non-property asset: financial accounts, personal property, vehicles, digital assets, business interests, Islamic finance instruments, etc.
|
|
844
|
+
*/
|
|
845
|
+
export type Asset = {
|
|
846
|
+
id: string;
|
|
847
|
+
/**
|
|
848
|
+
* Display name for this asset
|
|
849
|
+
*/
|
|
850
|
+
name: string;
|
|
851
|
+
category: 'bank_account' | 'savings_account' | 'investment' | 'pension' | 'shares' | 'premium_bonds' | 'cryptocurrency' | 'insurance' | 'vehicle' | 'jewellery' | 'art' | 'antiques' | 'collectibles' | 'furniture' | 'electronics' | 'musical_instruments' | 'books' | 'clothing' | 'kitchenware' | 'sports_equipment' | 'firearms' | 'wine_and_spirits' | 'tools' | 'garden_and_outdoor' | 'business_interest' | 'intellectual_property' | 'domain_name' | 'social_media_account' | 'digital_subscription' | 'sukuk' | 'takaful' | 'islamic_deposit' | 'other';
|
|
852
|
+
subcategory?: string;
|
|
853
|
+
estimatedValue?: Money;
|
|
854
|
+
professionalValuation?: Money;
|
|
855
|
+
valuationDate?: string;
|
|
856
|
+
valuationConfidence?: 'estimated' | 'professional' | 'probate' | 'unknown';
|
|
857
|
+
condition?: 'excellent' | 'good' | 'fair' | 'poor' | 'unknown' | 'not_applicable';
|
|
858
|
+
quantity?: number;
|
|
859
|
+
/**
|
|
860
|
+
* Where this asset is stored or held
|
|
861
|
+
*/
|
|
862
|
+
location?: string;
|
|
863
|
+
/**
|
|
864
|
+
* Reference to a Property.id if located at a property
|
|
865
|
+
*/
|
|
866
|
+
propertyId?: string;
|
|
867
|
+
/**
|
|
868
|
+
* Serial numbers, account numbers, policy refs, etc.
|
|
869
|
+
*/
|
|
870
|
+
identifiers?: Array<Identifier>;
|
|
871
|
+
photos?: Array<Photo>;
|
|
872
|
+
possessionStatus?: 'possessed_at_death' | 'receivable' | 'contingent';
|
|
873
|
+
mobilityType?: 'immoveable' | 'moveable' | 'mixed';
|
|
874
|
+
acquisitionType?: 'self_acquired' | 'ancestral_joint' | 'ancestral_severed' | 'inherited' | 'gifted' | 'stridhan' | 'communal' | 'waqf_endowed';
|
|
875
|
+
registrationStatus?: 'formally_registered' | 'informally_held' | 'community_acknowledged' | 'disputed' | 'undocumented';
|
|
876
|
+
ownershipEvidence?: 'title_deed' | 'certificate_of_occupancy' | 'family_recognition' | 'community_testimony' | 'receipts_only' | 'none';
|
|
877
|
+
applicableSuccessionLaw?: {
|
|
878
|
+
jurisdiction: Jurisdiction;
|
|
879
|
+
lawName?: string;
|
|
880
|
+
section?: string;
|
|
881
|
+
};
|
|
882
|
+
beneficiaryDesignation?: {
|
|
883
|
+
primaryBeneficiaryPersonIds?: Array<string>;
|
|
884
|
+
contingentBeneficiaryPersonIds?: Array<string>;
|
|
885
|
+
designationType?: 'retirement_account' | 'life_insurance' | 'superannuation' | 'pod_account' | 'other';
|
|
886
|
+
linkedNonprobateTransferId?: string;
|
|
887
|
+
};
|
|
888
|
+
digitalAccessConsent?: {
|
|
889
|
+
consentGiven?: boolean;
|
|
890
|
+
scope?: 'full_access' | 'limited_access' | 'no_access';
|
|
891
|
+
designatedRecipientPersonId?: string;
|
|
892
|
+
onlineToolDirective?: boolean;
|
|
893
|
+
};
|
|
894
|
+
passesOutsideEstate?: boolean;
|
|
895
|
+
notes?: string;
|
|
896
|
+
[key: string]: unknown | string | string | 'bank_account' | 'savings_account' | 'investment' | 'pension' | 'shares' | 'premium_bonds' | 'cryptocurrency' | 'insurance' | 'vehicle' | 'jewellery' | 'art' | 'antiques' | 'collectibles' | 'furniture' | 'electronics' | 'musical_instruments' | 'books' | 'clothing' | 'kitchenware' | 'sports_equipment' | 'firearms' | 'wine_and_spirits' | 'tools' | 'garden_and_outdoor' | 'business_interest' | 'intellectual_property' | 'domain_name' | 'social_media_account' | 'digital_subscription' | 'sukuk' | 'takaful' | 'islamic_deposit' | 'other' | string | Money | string | 'estimated' | 'professional' | 'probate' | 'unknown' | 'excellent' | 'good' | 'fair' | 'poor' | 'unknown' | 'not_applicable' | number | Array<Identifier> | Array<Photo> | 'possessed_at_death' | 'receivable' | 'contingent' | 'immoveable' | 'moveable' | 'mixed' | 'self_acquired' | 'ancestral_joint' | 'ancestral_severed' | 'inherited' | 'gifted' | 'stridhan' | 'communal' | 'waqf_endowed' | 'formally_registered' | 'informally_held' | 'community_acknowledged' | 'disputed' | 'undocumented' | 'title_deed' | 'certificate_of_occupancy' | 'family_recognition' | 'community_testimony' | 'receipts_only' | 'none' | {
|
|
897
|
+
jurisdiction: Jurisdiction;
|
|
898
|
+
lawName?: string;
|
|
899
|
+
section?: string;
|
|
900
|
+
} | {
|
|
901
|
+
primaryBeneficiaryPersonIds?: Array<string>;
|
|
902
|
+
contingentBeneficiaryPersonIds?: Array<string>;
|
|
903
|
+
designationType?: 'retirement_account' | 'life_insurance' | 'superannuation' | 'pod_account' | 'other';
|
|
904
|
+
linkedNonprobateTransferId?: string;
|
|
905
|
+
} | {
|
|
906
|
+
consentGiven?: boolean;
|
|
907
|
+
scope?: 'full_access' | 'limited_access' | 'no_access';
|
|
908
|
+
designatedRecipientPersonId?: string;
|
|
909
|
+
onlineToolDirective?: boolean;
|
|
910
|
+
} | boolean | undefined;
|
|
911
|
+
};
|
|
912
|
+
/**
|
|
913
|
+
* Liability
|
|
914
|
+
*
|
|
915
|
+
* A debt or financial obligation. Includes mortgages, loans, credit cards, and cultural obligations (mahr, ketubah debt, lobola) that are priority debts in certain jurisdictions.
|
|
916
|
+
*/
|
|
917
|
+
export type Liability = {
|
|
918
|
+
id: string;
|
|
919
|
+
type: 'mortgage' | 'personal_loan' | 'credit_card' | 'overdraft' | 'student_loan' | 'car_finance' | 'hire_purchase' | 'mahr' | 'ketubah_debt' | 'lobola' | 'tax_liability' | 'funeral_costs' | 'care_fees' | 'mezonot' | 'other';
|
|
920
|
+
/**
|
|
921
|
+
* Name of the creditor or institution
|
|
922
|
+
*/
|
|
923
|
+
creditor?: string;
|
|
924
|
+
/**
|
|
925
|
+
* Outstanding balance
|
|
926
|
+
*/
|
|
927
|
+
amount: Money;
|
|
928
|
+
/**
|
|
929
|
+
* Reference to a Property.id or Asset.id this liability is secured against
|
|
930
|
+
*/
|
|
931
|
+
securedAgainst?: string;
|
|
932
|
+
monthlyPayment?: Money;
|
|
933
|
+
/**
|
|
934
|
+
* Annual interest rate as percentage (e.g. 4.5 = 4.5%)
|
|
935
|
+
*/
|
|
936
|
+
interestRate?: number;
|
|
937
|
+
startDate?: string;
|
|
938
|
+
endDate?: string;
|
|
939
|
+
/**
|
|
940
|
+
* Account or reference number
|
|
941
|
+
*/
|
|
942
|
+
accountReference?: string;
|
|
943
|
+
notes?: string;
|
|
944
|
+
[key: string]: unknown | string | 'mortgage' | 'personal_loan' | 'credit_card' | 'overdraft' | 'student_loan' | 'car_finance' | 'hire_purchase' | 'mahr' | 'ketubah_debt' | 'lobola' | 'tax_liability' | 'funeral_costs' | 'care_fees' | 'mezonot' | 'other' | string | Money | number | string | undefined;
|
|
945
|
+
};
|
|
946
|
+
export type BeneficiaryOrganisation = {
|
|
947
|
+
name: string;
|
|
948
|
+
type: 'charity' | 'company' | 'unincorporated_association' | 'trust' | 'other';
|
|
949
|
+
registrationNumber?: string;
|
|
950
|
+
jurisdiction?: Jurisdiction;
|
|
951
|
+
};
|
|
952
|
+
export type LifeInterest = {
|
|
953
|
+
tenantForLifeId: string;
|
|
954
|
+
remaindermanId?: string;
|
|
955
|
+
remaindermanClassDefinition?: string;
|
|
956
|
+
interestType: 'use_and_income' | 'income_only' | 'use_only' | 'protective' | 'right_of_residence';
|
|
957
|
+
};
|
|
958
|
+
export type Substitution = {
|
|
959
|
+
beneficiaryId?: string;
|
|
960
|
+
classDefinition?: string;
|
|
961
|
+
beneficiaryOrganisation?: BeneficiaryOrganisation;
|
|
962
|
+
condition?: string;
|
|
963
|
+
perStirpes?: boolean;
|
|
964
|
+
};
|
|
965
|
+
export type PostDeathAction = {
|
|
966
|
+
type: 'disclaimer' | 'deed_of_variation' | 'appropriation' | 'assent';
|
|
967
|
+
date?: string;
|
|
968
|
+
description?: string;
|
|
969
|
+
documentId?: string;
|
|
970
|
+
};
|
|
971
|
+
export type InheritanceResponse = {
|
|
972
|
+
response: 'accepted' | 'renounced' | 'qualified_acceptance' | 'pending';
|
|
973
|
+
responseDate?: string;
|
|
974
|
+
responsePersonId?: string;
|
|
975
|
+
courtFiled?: boolean;
|
|
976
|
+
deadlineDate?: string;
|
|
977
|
+
};
|
|
978
|
+
/**
|
|
979
|
+
* Bequest
|
|
980
|
+
*
|
|
981
|
+
* A disposition of property or money in a will. Supports 7 core types (specific, pecuniary, demonstrative, general, residuary, life_interest, class) and extension types via extensionType (e.g. wasiyya, halachic_matanah).
|
|
982
|
+
*/
|
|
983
|
+
export type Bequest = unknown & {
|
|
984
|
+
id: string;
|
|
985
|
+
type: 'specific' | 'pecuniary' | 'demonstrative' | 'general' | 'residuary' | 'life_interest' | 'class';
|
|
986
|
+
extensionType?: string;
|
|
987
|
+
beneficiaryId?: string;
|
|
988
|
+
beneficiaryOrganisation?: BeneficiaryOrganisation;
|
|
989
|
+
classDefinition?: string;
|
|
990
|
+
lifeInterest?: LifeInterest;
|
|
991
|
+
amount?: Money;
|
|
992
|
+
sharePercentage?: number;
|
|
993
|
+
description?: string;
|
|
994
|
+
sourceAssetId?: string;
|
|
995
|
+
conditions?: Array<string>;
|
|
996
|
+
substitutions?: Array<Substitution>;
|
|
997
|
+
hotchpot?: boolean;
|
|
998
|
+
distributionMethod?: 'per_capita' | 'per_stirpes' | 'modified_per_stirpes' | 'per_capita_at_each_generation' | 'halachic_yerusha';
|
|
999
|
+
predeceaseRule?: 'lapse' | 'per_stirpes' | 'substitution' | 'accrual' | 'statutory_default';
|
|
1000
|
+
constrainedBy?: 'testamentary_freedom' | 'customary_rule' | 'forced_heirship' | 'religious_rule' | 'coparcenary_survivorship';
|
|
1001
|
+
customaryOverride?: boolean;
|
|
1002
|
+
postDeathActions?: Array<PostDeathAction>;
|
|
1003
|
+
inheritanceResponse?: InheritanceResponse;
|
|
1004
|
+
notes?: string;
|
|
1005
|
+
[key: string]: unknown | string | 'specific' | 'pecuniary' | 'demonstrative' | 'general' | 'residuary' | 'life_interest' | 'class' | string | BeneficiaryOrganisation | LifeInterest | Money | number | Array<string> | Array<Substitution> | boolean | 'per_capita' | 'per_stirpes' | 'modified_per_stirpes' | 'per_capita_at_each_generation' | 'halachic_yerusha' | 'lapse' | 'per_stirpes' | 'substitution' | 'accrual' | 'statutory_default' | 'testamentary_freedom' | 'customary_rule' | 'forced_heirship' | 'religious_rule' | 'coparcenary_survivorship' | Array<PostDeathAction> | InheritanceResponse | undefined;
|
|
1006
|
+
};
|
|
1007
|
+
export type TrustAppointee = {
|
|
1008
|
+
personId: string;
|
|
1009
|
+
role: 'trustee' | 'protector' | 'enforcer';
|
|
1010
|
+
};
|
|
1011
|
+
export type TrustBeneficiary = {
|
|
1012
|
+
personId?: string;
|
|
1013
|
+
classDefinition?: string;
|
|
1014
|
+
organisationName?: string;
|
|
1015
|
+
interestType: 'income' | 'capital' | 'both' | 'discretionary';
|
|
1016
|
+
};
|
|
1017
|
+
/**
|
|
1018
|
+
* Trust
|
|
1019
|
+
*
|
|
1020
|
+
* A trust instrument — testamentary or inter vivos. Covers discretionary, bare, life interest, charitable, nil rate band, waqf (Islamic endowment), and offshore structures with governance features (reserved powers, flee clauses, protector powers).
|
|
1021
|
+
*/
|
|
1022
|
+
export type Trust = {
|
|
1023
|
+
id: string;
|
|
1024
|
+
name: string;
|
|
1025
|
+
type: 'discretionary' | 'life_interest' | 'bare' | 'accumulation_and_maintenance' | 'disabled_persons' | 'charitable' | 'nil_rate_band' | 'waqf' | 'other';
|
|
1026
|
+
trustees: Array<TrustAppointee>;
|
|
1027
|
+
beneficiaries: Array<TrustBeneficiary>;
|
|
1028
|
+
settlor?: string;
|
|
1029
|
+
isTestamentary?: boolean;
|
|
1030
|
+
createdDate?: string;
|
|
1031
|
+
creationType?: 'testamentary' | 'inter_vivos_revocable' | 'inter_vivos_irrevocable';
|
|
1032
|
+
revocability?: 'revocable' | 'irrevocable' | 'perpetual';
|
|
1033
|
+
perpetual?: boolean;
|
|
1034
|
+
vestingAge?: number;
|
|
1035
|
+
vestingDate?: string;
|
|
1036
|
+
vestingConditions?: Array<string>;
|
|
1037
|
+
contingentInterests?: Array<string>;
|
|
1038
|
+
trustPeriod?: string;
|
|
1039
|
+
governingLaw?: Jurisdiction;
|
|
1040
|
+
reservedPowers?: Array<{
|
|
1041
|
+
powerType: 'investment' | 'distribution' | 'amendment' | 'revocation' | 'addition_of_beneficiaries' | 'removal_of_trustees' | 'change_of_governing_law';
|
|
1042
|
+
heldByPersonId?: string;
|
|
1043
|
+
conditions?: string;
|
|
1044
|
+
}>;
|
|
1045
|
+
fleeClause?: {
|
|
1046
|
+
present?: boolean;
|
|
1047
|
+
triggerEvents?: Array<string>;
|
|
1048
|
+
destinationJurisdiction?: Jurisdiction;
|
|
1049
|
+
automaticOrDiscretionary?: 'automatic' | 'discretionary';
|
|
1050
|
+
};
|
|
1051
|
+
protectorPowers?: Array<{
|
|
1052
|
+
powerType: 'consent_to_distribution' | 'remove_trustee' | 'appoint_trustee' | 'change_governing_law' | 'veto_investment' | 'add_beneficiary' | 'exclude_beneficiary' | 'enforce_purpose';
|
|
1053
|
+
protectorPersonId: string;
|
|
1054
|
+
exerciseConditions?: string;
|
|
1055
|
+
}>;
|
|
1056
|
+
jurisdictionalRecognition?: Array<{
|
|
1057
|
+
jurisdiction: Jurisdiction;
|
|
1058
|
+
recognised: boolean;
|
|
1059
|
+
recognisedAs?: string;
|
|
1060
|
+
hagueTrustConventionApplies?: boolean;
|
|
1061
|
+
notes?: string;
|
|
1062
|
+
}>;
|
|
1063
|
+
assetProtectionFeatures?: {
|
|
1064
|
+
selfSettled?: boolean;
|
|
1065
|
+
spendthriftClause?: boolean;
|
|
1066
|
+
fraudulentTransferLookback?: string;
|
|
1067
|
+
domesticationDate?: string;
|
|
1068
|
+
};
|
|
1069
|
+
notes?: string;
|
|
1070
|
+
[key: string]: unknown | string | string | 'discretionary' | 'life_interest' | 'bare' | 'accumulation_and_maintenance' | 'disabled_persons' | 'charitable' | 'nil_rate_band' | 'waqf' | 'other' | Array<TrustAppointee> | Array<TrustBeneficiary> | boolean | string | 'testamentary' | 'inter_vivos_revocable' | 'inter_vivos_irrevocable' | 'revocable' | 'irrevocable' | 'perpetual' | number | Array<string> | Array<string> | Jurisdiction | Array<{
|
|
1071
|
+
powerType: 'investment' | 'distribution' | 'amendment' | 'revocation' | 'addition_of_beneficiaries' | 'removal_of_trustees' | 'change_of_governing_law';
|
|
1072
|
+
heldByPersonId?: string;
|
|
1073
|
+
conditions?: string;
|
|
1074
|
+
}> | {
|
|
1075
|
+
present?: boolean;
|
|
1076
|
+
triggerEvents?: Array<string>;
|
|
1077
|
+
destinationJurisdiction?: Jurisdiction;
|
|
1078
|
+
automaticOrDiscretionary?: 'automatic' | 'discretionary';
|
|
1079
|
+
} | Array<{
|
|
1080
|
+
powerType: 'consent_to_distribution' | 'remove_trustee' | 'appoint_trustee' | 'change_governing_law' | 'veto_investment' | 'add_beneficiary' | 'exclude_beneficiary' | 'enforce_purpose';
|
|
1081
|
+
protectorPersonId: string;
|
|
1082
|
+
exerciseConditions?: string;
|
|
1083
|
+
}> | Array<{
|
|
1084
|
+
jurisdiction: Jurisdiction;
|
|
1085
|
+
recognised: boolean;
|
|
1086
|
+
recognisedAs?: string;
|
|
1087
|
+
hagueTrustConventionApplies?: boolean;
|
|
1088
|
+
notes?: string;
|
|
1089
|
+
}> | {
|
|
1090
|
+
selfSettled?: boolean;
|
|
1091
|
+
spendthriftClause?: boolean;
|
|
1092
|
+
fraudulentTransferLookback?: string;
|
|
1093
|
+
domesticationDate?: string;
|
|
1094
|
+
} | undefined;
|
|
1095
|
+
};
|
|
1096
|
+
/**
|
|
1097
|
+
* Executor
|
|
1098
|
+
*
|
|
1099
|
+
* A person appointed to administer an estate. Includes professional executors, administrators (intestacy), and administrators with will annexed.
|
|
1100
|
+
*/
|
|
1101
|
+
export type Executor = {
|
|
1102
|
+
id: string;
|
|
1103
|
+
/**
|
|
1104
|
+
* Reference to a Person.id
|
|
1105
|
+
*/
|
|
1106
|
+
personId: string;
|
|
1107
|
+
role: 'primary' | 'secondary' | 'substitute' | 'administrator' | 'administrator_with_will_annexed';
|
|
1108
|
+
isProfessional?: boolean;
|
|
1109
|
+
/**
|
|
1110
|
+
* Firm name if the executor is a professional (solicitor, accountant, trust corporation)
|
|
1111
|
+
*/
|
|
1112
|
+
firmName?: string;
|
|
1113
|
+
grantType?: 'grant_of_probate' | 'letters_of_administration' | 'letters_of_administration_with_will_annexed' | 'resealing' | 'european_certificate_of_succession';
|
|
1114
|
+
grantDate?: string;
|
|
1115
|
+
grantReference?: string;
|
|
1116
|
+
issuingCourt?: string;
|
|
1117
|
+
notes?: string;
|
|
1118
|
+
[key: string]: unknown | string | 'primary' | 'secondary' | 'substitute' | 'administrator' | 'administrator_with_will_annexed' | boolean | string | 'grant_of_probate' | 'letters_of_administration' | 'letters_of_administration_with_will_annexed' | 'resealing' | 'european_certificate_of_succession' | string | undefined;
|
|
1119
|
+
};
|
|
1120
|
+
/**
|
|
1121
|
+
* Guardian
|
|
1122
|
+
*
|
|
1123
|
+
* A guardian appointment for a minor child. Supports testamentary, court-appointed, shariah court, community-appointed, and religious court appointments. Guardianship structures include individual, collective, rotating, and family council determined.
|
|
1124
|
+
*/
|
|
1125
|
+
export type Guardian = {
|
|
1126
|
+
id: string;
|
|
1127
|
+
/**
|
|
1128
|
+
* Reference to the guardian Person.id
|
|
1129
|
+
*/
|
|
1130
|
+
guardianPersonId: string;
|
|
1131
|
+
/**
|
|
1132
|
+
* Reference to the child Person.id
|
|
1133
|
+
*/
|
|
1134
|
+
childPersonId: string;
|
|
1135
|
+
role: 'primary' | 'secondary' | 'substitute';
|
|
1136
|
+
appointmentType: 'testamentary' | 'parental_responsibility' | 'court_appointed' | 'shariah_court_appointed' | 'community_appointed' | 'religious_court_appointed';
|
|
1137
|
+
guardianshipStructure?: 'individual' | 'collective' | 'rotating' | 'family_council_determined';
|
|
1138
|
+
familyCouncilDecisionRef?: string;
|
|
1139
|
+
conditions?: string;
|
|
1140
|
+
notes?: string;
|
|
1141
|
+
[key: string]: unknown | string | 'primary' | 'secondary' | 'substitute' | 'testamentary' | 'parental_responsibility' | 'court_appointed' | 'shariah_court_appointed' | 'community_appointed' | 'religious_court_appointed' | 'individual' | 'collective' | 'rotating' | 'family_council_determined' | string | undefined;
|
|
1142
|
+
};
|
|
1143
|
+
/**
|
|
1144
|
+
* Wish
|
|
1145
|
+
*
|
|
1146
|
+
* A non-binding (or culturally/religiously binding) wish — funeral, letter of wishes, care instructions, pet care, digital estate, distribution preferences.
|
|
1147
|
+
*/
|
|
1148
|
+
export type Wish = {
|
|
1149
|
+
id: string;
|
|
1150
|
+
type: 'funeral' | 'letter' | 'care' | 'distribution' | 'digital' | 'pets' | 'general';
|
|
1151
|
+
title: string;
|
|
1152
|
+
content?: string;
|
|
1153
|
+
bindingNature?: 'non_binding' | 'culturally_obligatory' | 'religiously_obligatory' | 'legally_binding';
|
|
1154
|
+
/**
|
|
1155
|
+
* Person this wish is addressed to
|
|
1156
|
+
*/
|
|
1157
|
+
addresseePersonId?: string;
|
|
1158
|
+
/**
|
|
1159
|
+
* Asset this wish relates to
|
|
1160
|
+
*/
|
|
1161
|
+
relatedAssetId?: string;
|
|
1162
|
+
notes?: string;
|
|
1163
|
+
[key: string]: unknown | string | 'funeral' | 'letter' | 'care' | 'distribution' | 'digital' | 'pets' | 'general' | string | 'non_binding' | 'culturally_obligatory' | 'religiously_obligatory' | 'legally_binding' | undefined;
|
|
1164
|
+
};
|
|
1165
|
+
/**
|
|
1166
|
+
* Document
|
|
1167
|
+
*
|
|
1168
|
+
* A document associated with an estate — wills, codicils, trust deeds, and religious documents (shtar_chov, ketubah_document, nikah_nama, etc.). Type is a free string (minLength 1) to accommodate jurisdiction-specific and religious document types.
|
|
1169
|
+
*/
|
|
1170
|
+
export type Document = {
|
|
1171
|
+
id: string;
|
|
1172
|
+
type: string;
|
|
1173
|
+
title: string;
|
|
1174
|
+
fileFormat?: string;
|
|
1175
|
+
/**
|
|
1176
|
+
* Storage reference (e.g. S3 URI, file path, or external system reference)
|
|
1177
|
+
*/
|
|
1178
|
+
storageRef?: string;
|
|
1179
|
+
fileSizeBytes?: number;
|
|
1180
|
+
mimeType?: string;
|
|
1181
|
+
createdDate?: string;
|
|
1182
|
+
notes?: string;
|
|
1183
|
+
[key: string]: unknown | string | string | string | number | string | undefined;
|
|
1184
|
+
};
|
|
1185
|
+
/**
|
|
1186
|
+
* Nonprobate Transfer
|
|
1187
|
+
*
|
|
1188
|
+
* Assets that pass outside the probate estate — revocable trusts, TOD deeds, POD accounts, JTWROS, beneficiary designations, superannuation/CPF/EPF nominations.
|
|
1189
|
+
*/
|
|
1190
|
+
export type NonprobateTransfer = {
|
|
1191
|
+
id: string;
|
|
1192
|
+
type: 'revocable_trust' | 'tod_deed' | 'pod_account' | 'jtwros' | 'tenancy_by_entirety' | 'beneficiary_designation' | 'life_insurance_nomination' | 'superannuation_nomination' | 'cpf_nomination' | 'epf_nomination' | 'mandatory_savings_nomination';
|
|
1193
|
+
designationType?: string;
|
|
1194
|
+
description?: string;
|
|
1195
|
+
trustId?: string;
|
|
1196
|
+
propertyId?: string;
|
|
1197
|
+
assetIds?: Array<string>;
|
|
1198
|
+
beneficiaryPersonIds?: Array<string>;
|
|
1199
|
+
contingentBeneficiaryPersonIds?: Array<string>;
|
|
1200
|
+
survivingOwnerPersonIds?: Array<string>;
|
|
1201
|
+
passesOutsideEstate: boolean;
|
|
1202
|
+
bindingNomination?: boolean;
|
|
1203
|
+
nominationExpiryDate?: string;
|
|
1204
|
+
recordingReference?: string;
|
|
1205
|
+
jurisdiction?: Jurisdiction;
|
|
1206
|
+
notes?: string;
|
|
1207
|
+
[key: string]: unknown | string | 'revocable_trust' | 'tod_deed' | 'pod_account' | 'jtwros' | 'tenancy_by_entirety' | 'beneficiary_designation' | 'life_insurance_nomination' | 'superannuation_nomination' | 'cpf_nomination' | 'epf_nomination' | 'mandatory_savings_nomination' | string | Array<string> | Array<string> | Array<string> | Array<string> | boolean | string | Jurisdiction | undefined;
|
|
1208
|
+
};
|
|
1209
|
+
export type ConsentRecord = {
|
|
1210
|
+
consentGiven: boolean;
|
|
1211
|
+
consentDate?: string;
|
|
1212
|
+
consentMethod?: 'in_person_verbal' | 'in_person_written' | 'video_recorded' | 'witnessed_verbal' | 'phone_recorded' | 'assumed_cultural_norm';
|
|
1213
|
+
witnesses?: Array<{
|
|
1214
|
+
personId: string;
|
|
1215
|
+
role?: string;
|
|
1216
|
+
witnessedDate?: string;
|
|
1217
|
+
}>;
|
|
1218
|
+
documentRef?: string;
|
|
1219
|
+
notes?: string;
|
|
1220
|
+
};
|
|
1221
|
+
/**
|
|
1222
|
+
* Proxy Authorisation
|
|
1223
|
+
*
|
|
1224
|
+
* Authorises a proxy to act on behalf of a testator — information gathering, communication, negotiation, or full decision-making. Includes consent record with cultural consent methods.
|
|
1225
|
+
*/
|
|
1226
|
+
export type ProxyAuthorisation = {
|
|
1227
|
+
id: string;
|
|
1228
|
+
proxyPersonId: string;
|
|
1229
|
+
testatorPersonId: string;
|
|
1230
|
+
scope: 'full' | 'information_gathering' | 'communication' | 'negotiation' | 'decision_making';
|
|
1231
|
+
consentRecord: ConsentRecord;
|
|
1232
|
+
dealerNegotiationPermitted?: boolean;
|
|
1233
|
+
startDate?: string;
|
|
1234
|
+
expiryDate?: string;
|
|
1235
|
+
revocationDate?: string;
|
|
1236
|
+
auditTrailEnabled?: boolean;
|
|
1237
|
+
notes?: string;
|
|
1238
|
+
[key: string]: unknown | string | 'full' | 'information_gathering' | 'communication' | 'negotiation' | 'decision_making' | ConsentRecord | boolean | string | string | undefined;
|
|
1239
|
+
};
|
|
1240
|
+
export type InterestedParty = {
|
|
1241
|
+
personId?: string;
|
|
1242
|
+
name: string;
|
|
1243
|
+
type: 'art_dealer' | 'antique_dealer' | 'property_investor' | 'auction_house' | 'gallery' | 'private_collector' | 'museum' | 'institution' | 'charity' | 'developer' | 'fund_manager' | 'family_office' | 'estate_agent' | 'solicitor_firm' | 'other';
|
|
1244
|
+
contactDetails?: string;
|
|
1245
|
+
};
|
|
1246
|
+
export type AssetInterestItem = {
|
|
1247
|
+
assetId?: string;
|
|
1248
|
+
propertyId?: string;
|
|
1249
|
+
interestLevel?: 'exploratory' | 'moderate' | 'strong' | 'committed';
|
|
1250
|
+
};
|
|
1251
|
+
export type CollectionInterest = unknown & {
|
|
1252
|
+
name?: string;
|
|
1253
|
+
assetIds?: Array<string>;
|
|
1254
|
+
propertyIds?: Array<string>;
|
|
1255
|
+
notes?: string;
|
|
1256
|
+
};
|
|
1257
|
+
export type OfferDetails = {
|
|
1258
|
+
amount?: Money;
|
|
1259
|
+
conditions?: Array<string>;
|
|
1260
|
+
validUntil?: string;
|
|
1261
|
+
offerDate?: string;
|
|
1262
|
+
documentRef?: string;
|
|
1263
|
+
};
|
|
1264
|
+
/**
|
|
1265
|
+
* Dealer Interest
|
|
1266
|
+
*
|
|
1267
|
+
* Level D data — records third-party interest in estate assets (art dealers, property investors, collectors). Privacy-controlled. Managed via proxy authorisation.
|
|
1268
|
+
*/
|
|
1269
|
+
export type DealerInterest = {
|
|
1270
|
+
id: string;
|
|
1271
|
+
interestedParty: InterestedParty;
|
|
1272
|
+
assets?: Array<AssetInterestItem>;
|
|
1273
|
+
collection?: CollectionInterest;
|
|
1274
|
+
offerStatus: 'standing_interest' | 'verbal_offer' | 'written_offer' | 'formal_valuation' | 'conditional_offer' | 'accepted' | 'declined' | 'expired' | 'withdrawn';
|
|
1275
|
+
offerDetails?: OfferDetails;
|
|
1276
|
+
testatorDisposition?: 'willing_to_sell' | 'prefer_not_to_sell' | 'hold_for_executor' | 'deferred_to_family' | 'promised_to_institution' | 'undecided';
|
|
1277
|
+
linkedBequestId?: string;
|
|
1278
|
+
privacyLevel: 'testator_only' | 'proxy_visible' | 'executor_visible' | 'all_parties';
|
|
1279
|
+
communicationInitiatedBy?: 'buyer' | 'testator' | 'proxy' | 'executor';
|
|
1280
|
+
managedByProxyId?: string;
|
|
1281
|
+
notes?: string;
|
|
1282
|
+
[key: string]: unknown | string | InterestedParty | Array<AssetInterestItem> | CollectionInterest | 'standing_interest' | 'verbal_offer' | 'written_offer' | 'formal_valuation' | 'conditional_offer' | 'accepted' | 'declined' | 'expired' | 'withdrawn' | OfferDetails | 'willing_to_sell' | 'prefer_not_to_sell' | 'hold_for_executor' | 'deferred_to_family' | 'promised_to_institution' | 'undecided' | 'testator_only' | 'proxy_visible' | 'executor_visible' | 'all_parties' | 'buyer' | 'testator' | 'proxy' | 'executor' | string | undefined;
|
|
1283
|
+
};
|
|
1284
|
+
/**
|
|
1285
|
+
* INHERIT v1 Root Schema
|
|
1286
|
+
*
|
|
1287
|
+
* Root entry point for an INHERIT v1 estate data interchange document. Contains a single estate and arrays of all entity types.
|
|
1288
|
+
*/
|
|
1289
|
+
export type Schema = {
|
|
1290
|
+
inherit: 'https://openinherit.org/v1/schema.json';
|
|
1291
|
+
version: 1;
|
|
1292
|
+
exportedAt?: string;
|
|
1293
|
+
exportedBy?: {
|
|
1294
|
+
name?: string;
|
|
1295
|
+
email?: string;
|
|
1296
|
+
organisationName?: string;
|
|
1297
|
+
};
|
|
1298
|
+
generator?: {
|
|
1299
|
+
name: string;
|
|
1300
|
+
version?: string;
|
|
1301
|
+
url?: string;
|
|
1302
|
+
};
|
|
1303
|
+
estate: Estate;
|
|
1304
|
+
people: Array<Person>;
|
|
1305
|
+
kinships: Array<Kinship>;
|
|
1306
|
+
relationships: Array<Relationship>;
|
|
1307
|
+
properties: Array<Property>;
|
|
1308
|
+
assets: Array<Asset>;
|
|
1309
|
+
liabilities: Array<Liability>;
|
|
1310
|
+
bequests: Array<Bequest>;
|
|
1311
|
+
trusts: Array<Trust>;
|
|
1312
|
+
executors: Array<Executor>;
|
|
1313
|
+
guardians: Array<Guardian>;
|
|
1314
|
+
wishes: Array<Wish>;
|
|
1315
|
+
documents: Array<Document>;
|
|
1316
|
+
nonprobateTransfers: Array<NonprobateTransfer>;
|
|
1317
|
+
proxyAuthorisations: Array<ProxyAuthorisation>;
|
|
1318
|
+
dealerInterests: Array<DealerInterest>;
|
|
1319
|
+
extensions?: Array<string>;
|
|
1320
|
+
[key: string]: unknown | 'https://openinherit.org/v1/schema.json' | 1 | string | {
|
|
1321
|
+
name?: string;
|
|
1322
|
+
email?: string;
|
|
1323
|
+
organisationName?: string;
|
|
1324
|
+
} | {
|
|
1325
|
+
name: string;
|
|
1326
|
+
version?: string;
|
|
1327
|
+
url?: string;
|
|
1328
|
+
} | Estate | Array<Person> | Array<Kinship> | Array<Relationship> | Array<Property> | Array<Asset> | Array<Liability> | Array<Bequest> | Array<Trust> | Array<Executor> | Array<Guardian> | Array<Wish> | Array<Document> | Array<NonprobateTransfer> | Array<ProxyAuthorisation> | Array<DealerInterest> | Array<string> | undefined;
|
|
1329
|
+
};
|
|
1330
|
+
export type ValidationResult = {
|
|
1331
|
+
valid: boolean;
|
|
1332
|
+
/**
|
|
1333
|
+
* 0 = Invalid, 1 = Schema Valid, 2 = Referentially Intact,
|
|
1334
|
+
* 3 = Jurisdiction Complete
|
|
1335
|
+
*
|
|
1336
|
+
*/
|
|
1337
|
+
conformanceLevel: 0 | 1 | 2 | 3;
|
|
1338
|
+
errors: Array<{
|
|
1339
|
+
path: string;
|
|
1340
|
+
message: string;
|
|
1341
|
+
level: 'error' | 'warning' | 'info';
|
|
1342
|
+
}>;
|
|
1343
|
+
};
|
|
1344
|
+
/**
|
|
1345
|
+
* Unique identifier for the estate (UUID v4)
|
|
1346
|
+
*/
|
|
1347
|
+
export type EstateId = string;
|
|
1348
|
+
/**
|
|
1349
|
+
* Opaque cursor for pagination — use the value returned in the previous response
|
|
1350
|
+
*/
|
|
1351
|
+
export type Cursor = string;
|
|
1352
|
+
/**
|
|
1353
|
+
* Maximum number of items to return (1–100)
|
|
1354
|
+
*/
|
|
1355
|
+
export type Limit = number;
|
|
1356
|
+
export type ListEstatesData = {
|
|
1357
|
+
body?: never;
|
|
1358
|
+
path?: never;
|
|
1359
|
+
query?: {
|
|
1360
|
+
/**
|
|
1361
|
+
* Opaque cursor for pagination — use the value returned in the previous response
|
|
1362
|
+
*/
|
|
1363
|
+
cursor?: string;
|
|
1364
|
+
/**
|
|
1365
|
+
* Maximum number of items to return (1–100)
|
|
1366
|
+
*/
|
|
1367
|
+
limit?: number;
|
|
1368
|
+
/**
|
|
1369
|
+
* Filter by estate status
|
|
1370
|
+
*/
|
|
1371
|
+
status?: 'draft' | 'active' | 'locked' | 'archived';
|
|
1372
|
+
/**
|
|
1373
|
+
* Filter by jurisdiction code (ISO 3166-2)
|
|
1374
|
+
*/
|
|
1375
|
+
jurisdiction?: string;
|
|
1376
|
+
};
|
|
1377
|
+
url: '/estates';
|
|
1378
|
+
};
|
|
1379
|
+
export type ListEstatesResponses = {
|
|
1380
|
+
/**
|
|
1381
|
+
* Paginated list of estates
|
|
1382
|
+
*/
|
|
1383
|
+
200: PaginatedEstateList;
|
|
1384
|
+
};
|
|
1385
|
+
export type ListEstatesResponse = ListEstatesResponses[keyof ListEstatesResponses];
|
|
1386
|
+
export type CreateEstateData = {
|
|
1387
|
+
body: Estate;
|
|
1388
|
+
path?: never;
|
|
1389
|
+
query?: never;
|
|
1390
|
+
url: '/estates';
|
|
1391
|
+
};
|
|
1392
|
+
export type CreateEstateErrors = {
|
|
1393
|
+
/**
|
|
1394
|
+
* The request body failed schema validation
|
|
1395
|
+
*/
|
|
1396
|
+
400: Error;
|
|
1397
|
+
};
|
|
1398
|
+
export type CreateEstateError = CreateEstateErrors[keyof CreateEstateErrors];
|
|
1399
|
+
export type CreateEstateResponses = {
|
|
1400
|
+
/**
|
|
1401
|
+
* Estate created successfully
|
|
1402
|
+
*/
|
|
1403
|
+
201: Estate;
|
|
1404
|
+
};
|
|
1405
|
+
export type CreateEstateResponse = CreateEstateResponses[keyof CreateEstateResponses];
|
|
1406
|
+
export type DeleteEstateData = {
|
|
1407
|
+
body?: never;
|
|
1408
|
+
path: {
|
|
1409
|
+
/**
|
|
1410
|
+
* Unique identifier for the estate (UUID v4)
|
|
1411
|
+
*/
|
|
1412
|
+
estateId: string;
|
|
1413
|
+
};
|
|
1414
|
+
query?: never;
|
|
1415
|
+
url: '/estates/{estateId}';
|
|
1416
|
+
};
|
|
1417
|
+
export type DeleteEstateErrors = {
|
|
1418
|
+
/**
|
|
1419
|
+
* The requested resource was not found
|
|
1420
|
+
*/
|
|
1421
|
+
404: Error;
|
|
1422
|
+
};
|
|
1423
|
+
export type DeleteEstateError = DeleteEstateErrors[keyof DeleteEstateErrors];
|
|
1424
|
+
export type DeleteEstateResponses = {
|
|
1425
|
+
/**
|
|
1426
|
+
* Estate deleted successfully
|
|
1427
|
+
*/
|
|
1428
|
+
204: void;
|
|
1429
|
+
};
|
|
1430
|
+
export type DeleteEstateResponse = DeleteEstateResponses[keyof DeleteEstateResponses];
|
|
1431
|
+
export type GetEstateData = {
|
|
1432
|
+
body?: never;
|
|
1433
|
+
path: {
|
|
1434
|
+
/**
|
|
1435
|
+
* Unique identifier for the estate (UUID v4)
|
|
1436
|
+
*/
|
|
1437
|
+
estateId: string;
|
|
1438
|
+
};
|
|
1439
|
+
query?: never;
|
|
1440
|
+
url: '/estates/{estateId}';
|
|
1441
|
+
};
|
|
1442
|
+
export type GetEstateErrors = {
|
|
1443
|
+
/**
|
|
1444
|
+
* The requested resource was not found
|
|
1445
|
+
*/
|
|
1446
|
+
404: Error;
|
|
1447
|
+
};
|
|
1448
|
+
export type GetEstateError = GetEstateErrors[keyof GetEstateErrors];
|
|
1449
|
+
export type GetEstateResponses = {
|
|
1450
|
+
/**
|
|
1451
|
+
* Estate retrieved successfully
|
|
1452
|
+
*/
|
|
1453
|
+
200: Estate;
|
|
1454
|
+
};
|
|
1455
|
+
export type GetEstateResponse = GetEstateResponses[keyof GetEstateResponses];
|
|
1456
|
+
export type UpdateEstateData = {
|
|
1457
|
+
body: Estate;
|
|
1458
|
+
headers?: {
|
|
1459
|
+
/**
|
|
1460
|
+
* ETag value from a previous response for optimistic concurrency control
|
|
1461
|
+
*/
|
|
1462
|
+
'If-Match'?: string;
|
|
1463
|
+
};
|
|
1464
|
+
path: {
|
|
1465
|
+
/**
|
|
1466
|
+
* Unique identifier for the estate (UUID v4)
|
|
1467
|
+
*/
|
|
1468
|
+
estateId: string;
|
|
1469
|
+
};
|
|
1470
|
+
query?: never;
|
|
1471
|
+
url: '/estates/{estateId}';
|
|
1472
|
+
};
|
|
1473
|
+
export type UpdateEstateErrors = {
|
|
1474
|
+
/**
|
|
1475
|
+
* The request body failed schema validation
|
|
1476
|
+
*/
|
|
1477
|
+
400: Error;
|
|
1478
|
+
/**
|
|
1479
|
+
* The requested resource was not found
|
|
1480
|
+
*/
|
|
1481
|
+
404: Error;
|
|
1482
|
+
/**
|
|
1483
|
+
* Precondition failed — ETag mismatch
|
|
1484
|
+
*/
|
|
1485
|
+
412: Error;
|
|
1486
|
+
};
|
|
1487
|
+
export type UpdateEstateError = UpdateEstateErrors[keyof UpdateEstateErrors];
|
|
1488
|
+
export type UpdateEstateResponses = {
|
|
1489
|
+
/**
|
|
1490
|
+
* Estate updated successfully
|
|
1491
|
+
*/
|
|
1492
|
+
200: Estate;
|
|
1493
|
+
};
|
|
1494
|
+
export type UpdateEstateResponse = UpdateEstateResponses[keyof UpdateEstateResponses];
|
|
1495
|
+
export type ListPeopleData = {
|
|
1496
|
+
body?: never;
|
|
1497
|
+
path: {
|
|
1498
|
+
/**
|
|
1499
|
+
* Unique identifier for the estate (UUID v4)
|
|
1500
|
+
*/
|
|
1501
|
+
estateId: string;
|
|
1502
|
+
};
|
|
1503
|
+
query?: never;
|
|
1504
|
+
url: '/estates/{estateId}/people';
|
|
1505
|
+
};
|
|
1506
|
+
export type ListPeopleResponses = {
|
|
1507
|
+
/**
|
|
1508
|
+
* List of people
|
|
1509
|
+
*/
|
|
1510
|
+
200: {
|
|
1511
|
+
items: Array<Person>;
|
|
1512
|
+
};
|
|
1513
|
+
};
|
|
1514
|
+
export type ListPeopleResponse = ListPeopleResponses[keyof ListPeopleResponses];
|
|
1515
|
+
export type CreatePersonData = {
|
|
1516
|
+
body: Person;
|
|
1517
|
+
path: {
|
|
1518
|
+
/**
|
|
1519
|
+
* Unique identifier for the estate (UUID v4)
|
|
1520
|
+
*/
|
|
1521
|
+
estateId: string;
|
|
1522
|
+
};
|
|
1523
|
+
query?: never;
|
|
1524
|
+
url: '/estates/{estateId}/people';
|
|
1525
|
+
};
|
|
1526
|
+
export type CreatePersonErrors = {
|
|
1527
|
+
/**
|
|
1528
|
+
* The request body failed schema validation
|
|
1529
|
+
*/
|
|
1530
|
+
400: Error;
|
|
1531
|
+
};
|
|
1532
|
+
export type CreatePersonError = CreatePersonErrors[keyof CreatePersonErrors];
|
|
1533
|
+
export type CreatePersonResponses = {
|
|
1534
|
+
/**
|
|
1535
|
+
* Person created successfully
|
|
1536
|
+
*/
|
|
1537
|
+
201: Person;
|
|
1538
|
+
};
|
|
1539
|
+
export type CreatePersonResponse = CreatePersonResponses[keyof CreatePersonResponses];
|
|
1540
|
+
export type DeletePersonData = {
|
|
1541
|
+
body?: never;
|
|
1542
|
+
path: {
|
|
1543
|
+
/**
|
|
1544
|
+
* Unique identifier for the estate (UUID v4)
|
|
1545
|
+
*/
|
|
1546
|
+
estateId: string;
|
|
1547
|
+
/**
|
|
1548
|
+
* Unique identifier for the person (UUID v4)
|
|
1549
|
+
*/
|
|
1550
|
+
personId: string;
|
|
1551
|
+
};
|
|
1552
|
+
query?: never;
|
|
1553
|
+
url: '/estates/{estateId}/people/{personId}';
|
|
1554
|
+
};
|
|
1555
|
+
export type DeletePersonErrors = {
|
|
1556
|
+
/**
|
|
1557
|
+
* The requested resource was not found
|
|
1558
|
+
*/
|
|
1559
|
+
404: Error;
|
|
1560
|
+
/**
|
|
1561
|
+
* The request conflicts with the current state of the resource
|
|
1562
|
+
*/
|
|
1563
|
+
409: Error;
|
|
1564
|
+
};
|
|
1565
|
+
export type DeletePersonError = DeletePersonErrors[keyof DeletePersonErrors];
|
|
1566
|
+
export type DeletePersonResponses = {
|
|
1567
|
+
/**
|
|
1568
|
+
* Person deleted successfully
|
|
1569
|
+
*/
|
|
1570
|
+
204: void;
|
|
1571
|
+
};
|
|
1572
|
+
export type DeletePersonResponse = DeletePersonResponses[keyof DeletePersonResponses];
|
|
1573
|
+
export type GetPersonData = {
|
|
1574
|
+
body?: never;
|
|
1575
|
+
path: {
|
|
1576
|
+
/**
|
|
1577
|
+
* Unique identifier for the estate (UUID v4)
|
|
1578
|
+
*/
|
|
1579
|
+
estateId: string;
|
|
1580
|
+
/**
|
|
1581
|
+
* Unique identifier for the person (UUID v4)
|
|
1582
|
+
*/
|
|
1583
|
+
personId: string;
|
|
1584
|
+
};
|
|
1585
|
+
query?: never;
|
|
1586
|
+
url: '/estates/{estateId}/people/{personId}';
|
|
1587
|
+
};
|
|
1588
|
+
export type GetPersonErrors = {
|
|
1589
|
+
/**
|
|
1590
|
+
* The requested resource was not found
|
|
1591
|
+
*/
|
|
1592
|
+
404: Error;
|
|
1593
|
+
};
|
|
1594
|
+
export type GetPersonError = GetPersonErrors[keyof GetPersonErrors];
|
|
1595
|
+
export type GetPersonResponses = {
|
|
1596
|
+
/**
|
|
1597
|
+
* Person retrieved successfully
|
|
1598
|
+
*/
|
|
1599
|
+
200: Person;
|
|
1600
|
+
};
|
|
1601
|
+
export type GetPersonResponse = GetPersonResponses[keyof GetPersonResponses];
|
|
1602
|
+
export type UpdatePersonData = {
|
|
1603
|
+
body: Person;
|
|
1604
|
+
headers?: {
|
|
1605
|
+
/**
|
|
1606
|
+
* ETag value for optimistic concurrency control
|
|
1607
|
+
*/
|
|
1608
|
+
'If-Match'?: string;
|
|
1609
|
+
};
|
|
1610
|
+
path: {
|
|
1611
|
+
/**
|
|
1612
|
+
* Unique identifier for the estate (UUID v4)
|
|
1613
|
+
*/
|
|
1614
|
+
estateId: string;
|
|
1615
|
+
/**
|
|
1616
|
+
* Unique identifier for the person (UUID v4)
|
|
1617
|
+
*/
|
|
1618
|
+
personId: string;
|
|
1619
|
+
};
|
|
1620
|
+
query?: never;
|
|
1621
|
+
url: '/estates/{estateId}/people/{personId}';
|
|
1622
|
+
};
|
|
1623
|
+
export type UpdatePersonErrors = {
|
|
1624
|
+
/**
|
|
1625
|
+
* The request body failed schema validation
|
|
1626
|
+
*/
|
|
1627
|
+
400: Error;
|
|
1628
|
+
/**
|
|
1629
|
+
* The requested resource was not found
|
|
1630
|
+
*/
|
|
1631
|
+
404: Error;
|
|
1632
|
+
};
|
|
1633
|
+
export type UpdatePersonError = UpdatePersonErrors[keyof UpdatePersonErrors];
|
|
1634
|
+
export type UpdatePersonResponses = {
|
|
1635
|
+
/**
|
|
1636
|
+
* Person updated successfully
|
|
1637
|
+
*/
|
|
1638
|
+
200: Person;
|
|
1639
|
+
};
|
|
1640
|
+
export type UpdatePersonResponse = UpdatePersonResponses[keyof UpdatePersonResponses];
|
|
1641
|
+
export type ReplacePersonData = {
|
|
1642
|
+
body: Person;
|
|
1643
|
+
headers?: {
|
|
1644
|
+
/**
|
|
1645
|
+
* ETag value for optimistic concurrency control
|
|
1646
|
+
*/
|
|
1647
|
+
'If-Match'?: string;
|
|
1648
|
+
};
|
|
1649
|
+
path: {
|
|
1650
|
+
/**
|
|
1651
|
+
* Unique identifier for the estate (UUID v4)
|
|
1652
|
+
*/
|
|
1653
|
+
estateId: string;
|
|
1654
|
+
/**
|
|
1655
|
+
* Unique identifier for the person (UUID v4)
|
|
1656
|
+
*/
|
|
1657
|
+
personId: string;
|
|
1658
|
+
};
|
|
1659
|
+
query?: never;
|
|
1660
|
+
url: '/estates/{estateId}/people/{personId}';
|
|
1661
|
+
};
|
|
1662
|
+
export type ReplacePersonErrors = {
|
|
1663
|
+
/**
|
|
1664
|
+
* The request body failed schema validation
|
|
1665
|
+
*/
|
|
1666
|
+
400: Error;
|
|
1667
|
+
/**
|
|
1668
|
+
* The requested resource was not found
|
|
1669
|
+
*/
|
|
1670
|
+
404: Error;
|
|
1671
|
+
};
|
|
1672
|
+
export type ReplacePersonError = ReplacePersonErrors[keyof ReplacePersonErrors];
|
|
1673
|
+
export type ReplacePersonResponses = {
|
|
1674
|
+
/**
|
|
1675
|
+
* Person replaced successfully
|
|
1676
|
+
*/
|
|
1677
|
+
200: Person;
|
|
1678
|
+
};
|
|
1679
|
+
export type ReplacePersonResponse = ReplacePersonResponses[keyof ReplacePersonResponses];
|
|
1680
|
+
export type ListRelationshipsData = {
|
|
1681
|
+
body?: never;
|
|
1682
|
+
path: {
|
|
1683
|
+
/**
|
|
1684
|
+
* Unique identifier for the estate (UUID v4)
|
|
1685
|
+
*/
|
|
1686
|
+
estateId: string;
|
|
1687
|
+
};
|
|
1688
|
+
query?: never;
|
|
1689
|
+
url: '/estates/{estateId}/relationships';
|
|
1690
|
+
};
|
|
1691
|
+
export type ListRelationshipsResponses = {
|
|
1692
|
+
/**
|
|
1693
|
+
* List of relationships
|
|
1694
|
+
*/
|
|
1695
|
+
200: {
|
|
1696
|
+
items: Array<Relationship>;
|
|
1697
|
+
};
|
|
1698
|
+
};
|
|
1699
|
+
export type ListRelationshipsResponse = ListRelationshipsResponses[keyof ListRelationshipsResponses];
|
|
1700
|
+
export type CreateRelationshipData = {
|
|
1701
|
+
body: Relationship;
|
|
1702
|
+
path: {
|
|
1703
|
+
/**
|
|
1704
|
+
* Unique identifier for the estate (UUID v4)
|
|
1705
|
+
*/
|
|
1706
|
+
estateId: string;
|
|
1707
|
+
};
|
|
1708
|
+
query?: never;
|
|
1709
|
+
url: '/estates/{estateId}/relationships';
|
|
1710
|
+
};
|
|
1711
|
+
export type CreateRelationshipErrors = {
|
|
1712
|
+
/**
|
|
1713
|
+
* The request body failed schema validation
|
|
1714
|
+
*/
|
|
1715
|
+
400: Error;
|
|
1716
|
+
};
|
|
1717
|
+
export type CreateRelationshipError = CreateRelationshipErrors[keyof CreateRelationshipErrors];
|
|
1718
|
+
export type CreateRelationshipResponses = {
|
|
1719
|
+
/**
|
|
1720
|
+
* Relationship created successfully
|
|
1721
|
+
*/
|
|
1722
|
+
201: Relationship;
|
|
1723
|
+
};
|
|
1724
|
+
export type CreateRelationshipResponse = CreateRelationshipResponses[keyof CreateRelationshipResponses];
|
|
1725
|
+
export type DeleteRelationshipData = {
|
|
1726
|
+
body?: never;
|
|
1727
|
+
path: {
|
|
1728
|
+
/**
|
|
1729
|
+
* Unique identifier for the estate (UUID v4)
|
|
1730
|
+
*/
|
|
1731
|
+
estateId: string;
|
|
1732
|
+
/**
|
|
1733
|
+
* Unique identifier for the relationship (UUID v4)
|
|
1734
|
+
*/
|
|
1735
|
+
relationshipId: string;
|
|
1736
|
+
};
|
|
1737
|
+
query?: never;
|
|
1738
|
+
url: '/estates/{estateId}/relationships/{relationshipId}';
|
|
1739
|
+
};
|
|
1740
|
+
export type DeleteRelationshipErrors = {
|
|
1741
|
+
/**
|
|
1742
|
+
* The requested resource was not found
|
|
1743
|
+
*/
|
|
1744
|
+
404: Error;
|
|
1745
|
+
};
|
|
1746
|
+
export type DeleteRelationshipError = DeleteRelationshipErrors[keyof DeleteRelationshipErrors];
|
|
1747
|
+
export type DeleteRelationshipResponses = {
|
|
1748
|
+
/**
|
|
1749
|
+
* Relationship deleted successfully
|
|
1750
|
+
*/
|
|
1751
|
+
204: void;
|
|
1752
|
+
};
|
|
1753
|
+
export type DeleteRelationshipResponse = DeleteRelationshipResponses[keyof DeleteRelationshipResponses];
|
|
1754
|
+
export type GetRelationshipData = {
|
|
1755
|
+
body?: never;
|
|
1756
|
+
path: {
|
|
1757
|
+
/**
|
|
1758
|
+
* Unique identifier for the estate (UUID v4)
|
|
1759
|
+
*/
|
|
1760
|
+
estateId: string;
|
|
1761
|
+
/**
|
|
1762
|
+
* Unique identifier for the relationship (UUID v4)
|
|
1763
|
+
*/
|
|
1764
|
+
relationshipId: string;
|
|
1765
|
+
};
|
|
1766
|
+
query?: never;
|
|
1767
|
+
url: '/estates/{estateId}/relationships/{relationshipId}';
|
|
1768
|
+
};
|
|
1769
|
+
export type GetRelationshipErrors = {
|
|
1770
|
+
/**
|
|
1771
|
+
* The requested resource was not found
|
|
1772
|
+
*/
|
|
1773
|
+
404: Error;
|
|
1774
|
+
};
|
|
1775
|
+
export type GetRelationshipError = GetRelationshipErrors[keyof GetRelationshipErrors];
|
|
1776
|
+
export type GetRelationshipResponses = {
|
|
1777
|
+
/**
|
|
1778
|
+
* Relationship retrieved successfully
|
|
1779
|
+
*/
|
|
1780
|
+
200: Relationship;
|
|
1781
|
+
};
|
|
1782
|
+
export type GetRelationshipResponse = GetRelationshipResponses[keyof GetRelationshipResponses];
|
|
1783
|
+
export type UpdateRelationshipData = {
|
|
1784
|
+
body: Relationship;
|
|
1785
|
+
headers?: {
|
|
1786
|
+
/**
|
|
1787
|
+
* ETag value for optimistic concurrency control
|
|
1788
|
+
*/
|
|
1789
|
+
'If-Match'?: string;
|
|
1790
|
+
};
|
|
1791
|
+
path: {
|
|
1792
|
+
/**
|
|
1793
|
+
* Unique identifier for the estate (UUID v4)
|
|
1794
|
+
*/
|
|
1795
|
+
estateId: string;
|
|
1796
|
+
/**
|
|
1797
|
+
* Unique identifier for the relationship (UUID v4)
|
|
1798
|
+
*/
|
|
1799
|
+
relationshipId: string;
|
|
1800
|
+
};
|
|
1801
|
+
query?: never;
|
|
1802
|
+
url: '/estates/{estateId}/relationships/{relationshipId}';
|
|
1803
|
+
};
|
|
1804
|
+
export type UpdateRelationshipErrors = {
|
|
1805
|
+
/**
|
|
1806
|
+
* The request body failed schema validation
|
|
1807
|
+
*/
|
|
1808
|
+
400: Error;
|
|
1809
|
+
/**
|
|
1810
|
+
* The requested resource was not found
|
|
1811
|
+
*/
|
|
1812
|
+
404: Error;
|
|
1813
|
+
};
|
|
1814
|
+
export type UpdateRelationshipError = UpdateRelationshipErrors[keyof UpdateRelationshipErrors];
|
|
1815
|
+
export type UpdateRelationshipResponses = {
|
|
1816
|
+
/**
|
|
1817
|
+
* Relationship updated successfully
|
|
1818
|
+
*/
|
|
1819
|
+
200: Relationship;
|
|
1820
|
+
};
|
|
1821
|
+
export type UpdateRelationshipResponse = UpdateRelationshipResponses[keyof UpdateRelationshipResponses];
|
|
1822
|
+
export type ReplaceRelationshipData = {
|
|
1823
|
+
body: Relationship;
|
|
1824
|
+
headers?: {
|
|
1825
|
+
/**
|
|
1826
|
+
* ETag value for optimistic concurrency control
|
|
1827
|
+
*/
|
|
1828
|
+
'If-Match'?: string;
|
|
1829
|
+
};
|
|
1830
|
+
path: {
|
|
1831
|
+
/**
|
|
1832
|
+
* Unique identifier for the estate (UUID v4)
|
|
1833
|
+
*/
|
|
1834
|
+
estateId: string;
|
|
1835
|
+
/**
|
|
1836
|
+
* Unique identifier for the relationship (UUID v4)
|
|
1837
|
+
*/
|
|
1838
|
+
relationshipId: string;
|
|
1839
|
+
};
|
|
1840
|
+
query?: never;
|
|
1841
|
+
url: '/estates/{estateId}/relationships/{relationshipId}';
|
|
1842
|
+
};
|
|
1843
|
+
export type ReplaceRelationshipErrors = {
|
|
1844
|
+
/**
|
|
1845
|
+
* The request body failed schema validation
|
|
1846
|
+
*/
|
|
1847
|
+
400: Error;
|
|
1848
|
+
/**
|
|
1849
|
+
* The requested resource was not found
|
|
1850
|
+
*/
|
|
1851
|
+
404: Error;
|
|
1852
|
+
};
|
|
1853
|
+
export type ReplaceRelationshipError = ReplaceRelationshipErrors[keyof ReplaceRelationshipErrors];
|
|
1854
|
+
export type ReplaceRelationshipResponses = {
|
|
1855
|
+
/**
|
|
1856
|
+
* Relationship replaced successfully
|
|
1857
|
+
*/
|
|
1858
|
+
200: Relationship;
|
|
1859
|
+
};
|
|
1860
|
+
export type ReplaceRelationshipResponse = ReplaceRelationshipResponses[keyof ReplaceRelationshipResponses];
|
|
1861
|
+
export type ListKinshipsData = {
|
|
1862
|
+
body?: never;
|
|
1863
|
+
path: {
|
|
1864
|
+
/**
|
|
1865
|
+
* Unique identifier for the estate (UUID v4)
|
|
1866
|
+
*/
|
|
1867
|
+
estateId: string;
|
|
1868
|
+
};
|
|
1869
|
+
query?: never;
|
|
1870
|
+
url: '/estates/{estateId}/kinships';
|
|
1871
|
+
};
|
|
1872
|
+
export type ListKinshipsResponses = {
|
|
1873
|
+
/**
|
|
1874
|
+
* List of kinships
|
|
1875
|
+
*/
|
|
1876
|
+
200: {
|
|
1877
|
+
items: Array<Kinship>;
|
|
1878
|
+
};
|
|
1879
|
+
};
|
|
1880
|
+
export type ListKinshipsResponse = ListKinshipsResponses[keyof ListKinshipsResponses];
|
|
1881
|
+
export type CreateKinshipData = {
|
|
1882
|
+
body: Kinship;
|
|
1883
|
+
path: {
|
|
1884
|
+
/**
|
|
1885
|
+
* Unique identifier for the estate (UUID v4)
|
|
1886
|
+
*/
|
|
1887
|
+
estateId: string;
|
|
1888
|
+
};
|
|
1889
|
+
query?: never;
|
|
1890
|
+
url: '/estates/{estateId}/kinships';
|
|
1891
|
+
};
|
|
1892
|
+
export type CreateKinshipErrors = {
|
|
1893
|
+
/**
|
|
1894
|
+
* The request body failed schema validation
|
|
1895
|
+
*/
|
|
1896
|
+
400: Error;
|
|
1897
|
+
};
|
|
1898
|
+
export type CreateKinshipError = CreateKinshipErrors[keyof CreateKinshipErrors];
|
|
1899
|
+
export type CreateKinshipResponses = {
|
|
1900
|
+
/**
|
|
1901
|
+
* Kinship created successfully
|
|
1902
|
+
*/
|
|
1903
|
+
201: Kinship;
|
|
1904
|
+
};
|
|
1905
|
+
export type CreateKinshipResponse = CreateKinshipResponses[keyof CreateKinshipResponses];
|
|
1906
|
+
export type DeleteKinshipData = {
|
|
1907
|
+
body?: never;
|
|
1908
|
+
path: {
|
|
1909
|
+
/**
|
|
1910
|
+
* Unique identifier for the estate (UUID v4)
|
|
1911
|
+
*/
|
|
1912
|
+
estateId: string;
|
|
1913
|
+
/**
|
|
1914
|
+
* Unique identifier for the kinship (UUID v4)
|
|
1915
|
+
*/
|
|
1916
|
+
kinshipId: string;
|
|
1917
|
+
};
|
|
1918
|
+
query?: never;
|
|
1919
|
+
url: '/estates/{estateId}/kinships/{kinshipId}';
|
|
1920
|
+
};
|
|
1921
|
+
export type DeleteKinshipErrors = {
|
|
1922
|
+
/**
|
|
1923
|
+
* The requested resource was not found
|
|
1924
|
+
*/
|
|
1925
|
+
404: Error;
|
|
1926
|
+
};
|
|
1927
|
+
export type DeleteKinshipError = DeleteKinshipErrors[keyof DeleteKinshipErrors];
|
|
1928
|
+
export type DeleteKinshipResponses = {
|
|
1929
|
+
/**
|
|
1930
|
+
* Kinship deleted successfully
|
|
1931
|
+
*/
|
|
1932
|
+
204: void;
|
|
1933
|
+
};
|
|
1934
|
+
export type DeleteKinshipResponse = DeleteKinshipResponses[keyof DeleteKinshipResponses];
|
|
1935
|
+
export type GetKinshipData = {
|
|
1936
|
+
body?: never;
|
|
1937
|
+
path: {
|
|
1938
|
+
/**
|
|
1939
|
+
* Unique identifier for the estate (UUID v4)
|
|
1940
|
+
*/
|
|
1941
|
+
estateId: string;
|
|
1942
|
+
/**
|
|
1943
|
+
* Unique identifier for the kinship (UUID v4)
|
|
1944
|
+
*/
|
|
1945
|
+
kinshipId: string;
|
|
1946
|
+
};
|
|
1947
|
+
query?: never;
|
|
1948
|
+
url: '/estates/{estateId}/kinships/{kinshipId}';
|
|
1949
|
+
};
|
|
1950
|
+
export type GetKinshipErrors = {
|
|
1951
|
+
/**
|
|
1952
|
+
* The requested resource was not found
|
|
1953
|
+
*/
|
|
1954
|
+
404: Error;
|
|
1955
|
+
};
|
|
1956
|
+
export type GetKinshipError = GetKinshipErrors[keyof GetKinshipErrors];
|
|
1957
|
+
export type GetKinshipResponses = {
|
|
1958
|
+
/**
|
|
1959
|
+
* Kinship retrieved successfully
|
|
1960
|
+
*/
|
|
1961
|
+
200: Kinship;
|
|
1962
|
+
};
|
|
1963
|
+
export type GetKinshipResponse = GetKinshipResponses[keyof GetKinshipResponses];
|
|
1964
|
+
export type UpdateKinshipData = {
|
|
1965
|
+
body: Kinship;
|
|
1966
|
+
headers?: {
|
|
1967
|
+
/**
|
|
1968
|
+
* ETag value for optimistic concurrency control
|
|
1969
|
+
*/
|
|
1970
|
+
'If-Match'?: string;
|
|
1971
|
+
};
|
|
1972
|
+
path: {
|
|
1973
|
+
/**
|
|
1974
|
+
* Unique identifier for the estate (UUID v4)
|
|
1975
|
+
*/
|
|
1976
|
+
estateId: string;
|
|
1977
|
+
/**
|
|
1978
|
+
* Unique identifier for the kinship (UUID v4)
|
|
1979
|
+
*/
|
|
1980
|
+
kinshipId: string;
|
|
1981
|
+
};
|
|
1982
|
+
query?: never;
|
|
1983
|
+
url: '/estates/{estateId}/kinships/{kinshipId}';
|
|
1984
|
+
};
|
|
1985
|
+
export type UpdateKinshipErrors = {
|
|
1986
|
+
/**
|
|
1987
|
+
* The request body failed schema validation
|
|
1988
|
+
*/
|
|
1989
|
+
400: Error;
|
|
1990
|
+
/**
|
|
1991
|
+
* The requested resource was not found
|
|
1992
|
+
*/
|
|
1993
|
+
404: Error;
|
|
1994
|
+
};
|
|
1995
|
+
export type UpdateKinshipError = UpdateKinshipErrors[keyof UpdateKinshipErrors];
|
|
1996
|
+
export type UpdateKinshipResponses = {
|
|
1997
|
+
/**
|
|
1998
|
+
* Kinship updated successfully
|
|
1999
|
+
*/
|
|
2000
|
+
200: Kinship;
|
|
2001
|
+
};
|
|
2002
|
+
export type UpdateKinshipResponse = UpdateKinshipResponses[keyof UpdateKinshipResponses];
|
|
2003
|
+
export type ReplaceKinshipData = {
|
|
2004
|
+
body: Kinship;
|
|
2005
|
+
headers?: {
|
|
2006
|
+
/**
|
|
2007
|
+
* ETag value for optimistic concurrency control
|
|
2008
|
+
*/
|
|
2009
|
+
'If-Match'?: string;
|
|
2010
|
+
};
|
|
2011
|
+
path: {
|
|
2012
|
+
/**
|
|
2013
|
+
* Unique identifier for the estate (UUID v4)
|
|
2014
|
+
*/
|
|
2015
|
+
estateId: string;
|
|
2016
|
+
/**
|
|
2017
|
+
* Unique identifier for the kinship (UUID v4)
|
|
2018
|
+
*/
|
|
2019
|
+
kinshipId: string;
|
|
2020
|
+
};
|
|
2021
|
+
query?: never;
|
|
2022
|
+
url: '/estates/{estateId}/kinships/{kinshipId}';
|
|
2023
|
+
};
|
|
2024
|
+
export type ReplaceKinshipErrors = {
|
|
2025
|
+
/**
|
|
2026
|
+
* The request body failed schema validation
|
|
2027
|
+
*/
|
|
2028
|
+
400: Error;
|
|
2029
|
+
/**
|
|
2030
|
+
* The requested resource was not found
|
|
2031
|
+
*/
|
|
2032
|
+
404: Error;
|
|
2033
|
+
};
|
|
2034
|
+
export type ReplaceKinshipError = ReplaceKinshipErrors[keyof ReplaceKinshipErrors];
|
|
2035
|
+
export type ReplaceKinshipResponses = {
|
|
2036
|
+
/**
|
|
2037
|
+
* Kinship replaced successfully
|
|
2038
|
+
*/
|
|
2039
|
+
200: Kinship;
|
|
2040
|
+
};
|
|
2041
|
+
export type ReplaceKinshipResponse = ReplaceKinshipResponses[keyof ReplaceKinshipResponses];
|
|
2042
|
+
export type ListPropertiesData = {
|
|
2043
|
+
body?: never;
|
|
2044
|
+
path: {
|
|
2045
|
+
/**
|
|
2046
|
+
* Unique identifier for the estate (UUID v4)
|
|
2047
|
+
*/
|
|
2048
|
+
estateId: string;
|
|
2049
|
+
};
|
|
2050
|
+
query?: never;
|
|
2051
|
+
url: '/estates/{estateId}/properties';
|
|
2052
|
+
};
|
|
2053
|
+
export type ListPropertiesResponses = {
|
|
2054
|
+
/**
|
|
2055
|
+
* List of properties
|
|
2056
|
+
*/
|
|
2057
|
+
200: {
|
|
2058
|
+
items: Array<Property>;
|
|
2059
|
+
};
|
|
2060
|
+
};
|
|
2061
|
+
export type ListPropertiesResponse = ListPropertiesResponses[keyof ListPropertiesResponses];
|
|
2062
|
+
export type CreatePropertyData = {
|
|
2063
|
+
body: Property;
|
|
2064
|
+
path: {
|
|
2065
|
+
/**
|
|
2066
|
+
* Unique identifier for the estate (UUID v4)
|
|
2067
|
+
*/
|
|
2068
|
+
estateId: string;
|
|
2069
|
+
};
|
|
2070
|
+
query?: never;
|
|
2071
|
+
url: '/estates/{estateId}/properties';
|
|
2072
|
+
};
|
|
2073
|
+
export type CreatePropertyErrors = {
|
|
2074
|
+
/**
|
|
2075
|
+
* The request body failed schema validation
|
|
2076
|
+
*/
|
|
2077
|
+
400: Error;
|
|
2078
|
+
};
|
|
2079
|
+
export type CreatePropertyError = CreatePropertyErrors[keyof CreatePropertyErrors];
|
|
2080
|
+
export type CreatePropertyResponses = {
|
|
2081
|
+
/**
|
|
2082
|
+
* Property created successfully
|
|
2083
|
+
*/
|
|
2084
|
+
201: Property;
|
|
2085
|
+
};
|
|
2086
|
+
export type CreatePropertyResponse = CreatePropertyResponses[keyof CreatePropertyResponses];
|
|
2087
|
+
export type DeletePropertyData = {
|
|
2088
|
+
body?: never;
|
|
2089
|
+
path: {
|
|
2090
|
+
/**
|
|
2091
|
+
* Unique identifier for the estate (UUID v4)
|
|
2092
|
+
*/
|
|
2093
|
+
estateId: string;
|
|
2094
|
+
/**
|
|
2095
|
+
* Unique identifier for the property (UUID v4)
|
|
2096
|
+
*/
|
|
2097
|
+
propertyId: string;
|
|
2098
|
+
};
|
|
2099
|
+
query?: never;
|
|
2100
|
+
url: '/estates/{estateId}/properties/{propertyId}';
|
|
2101
|
+
};
|
|
2102
|
+
export type DeletePropertyErrors = {
|
|
2103
|
+
/**
|
|
2104
|
+
* The requested resource was not found
|
|
2105
|
+
*/
|
|
2106
|
+
404: Error;
|
|
2107
|
+
/**
|
|
2108
|
+
* The request conflicts with the current state of the resource
|
|
2109
|
+
*/
|
|
2110
|
+
409: Error;
|
|
2111
|
+
};
|
|
2112
|
+
export type DeletePropertyError = DeletePropertyErrors[keyof DeletePropertyErrors];
|
|
2113
|
+
export type DeletePropertyResponses = {
|
|
2114
|
+
/**
|
|
2115
|
+
* Property deleted successfully
|
|
2116
|
+
*/
|
|
2117
|
+
204: void;
|
|
2118
|
+
};
|
|
2119
|
+
export type DeletePropertyResponse = DeletePropertyResponses[keyof DeletePropertyResponses];
|
|
2120
|
+
export type GetPropertyData = {
|
|
2121
|
+
body?: never;
|
|
2122
|
+
path: {
|
|
2123
|
+
/**
|
|
2124
|
+
* Unique identifier for the estate (UUID v4)
|
|
2125
|
+
*/
|
|
2126
|
+
estateId: string;
|
|
2127
|
+
/**
|
|
2128
|
+
* Unique identifier for the property (UUID v4)
|
|
2129
|
+
*/
|
|
2130
|
+
propertyId: string;
|
|
2131
|
+
};
|
|
2132
|
+
query?: never;
|
|
2133
|
+
url: '/estates/{estateId}/properties/{propertyId}';
|
|
2134
|
+
};
|
|
2135
|
+
export type GetPropertyErrors = {
|
|
2136
|
+
/**
|
|
2137
|
+
* The requested resource was not found
|
|
2138
|
+
*/
|
|
2139
|
+
404: Error;
|
|
2140
|
+
};
|
|
2141
|
+
export type GetPropertyError = GetPropertyErrors[keyof GetPropertyErrors];
|
|
2142
|
+
export type GetPropertyResponses = {
|
|
2143
|
+
/**
|
|
2144
|
+
* Property retrieved successfully
|
|
2145
|
+
*/
|
|
2146
|
+
200: Property;
|
|
2147
|
+
};
|
|
2148
|
+
export type GetPropertyResponse = GetPropertyResponses[keyof GetPropertyResponses];
|
|
2149
|
+
export type UpdatePropertyData = {
|
|
2150
|
+
body: Property;
|
|
2151
|
+
headers?: {
|
|
2152
|
+
/**
|
|
2153
|
+
* ETag value for optimistic concurrency control
|
|
2154
|
+
*/
|
|
2155
|
+
'If-Match'?: string;
|
|
2156
|
+
};
|
|
2157
|
+
path: {
|
|
2158
|
+
/**
|
|
2159
|
+
* Unique identifier for the estate (UUID v4)
|
|
2160
|
+
*/
|
|
2161
|
+
estateId: string;
|
|
2162
|
+
/**
|
|
2163
|
+
* Unique identifier for the property (UUID v4)
|
|
2164
|
+
*/
|
|
2165
|
+
propertyId: string;
|
|
2166
|
+
};
|
|
2167
|
+
query?: never;
|
|
2168
|
+
url: '/estates/{estateId}/properties/{propertyId}';
|
|
2169
|
+
};
|
|
2170
|
+
export type UpdatePropertyErrors = {
|
|
2171
|
+
/**
|
|
2172
|
+
* The request body failed schema validation
|
|
2173
|
+
*/
|
|
2174
|
+
400: Error;
|
|
2175
|
+
/**
|
|
2176
|
+
* The requested resource was not found
|
|
2177
|
+
*/
|
|
2178
|
+
404: Error;
|
|
2179
|
+
};
|
|
2180
|
+
export type UpdatePropertyError = UpdatePropertyErrors[keyof UpdatePropertyErrors];
|
|
2181
|
+
export type UpdatePropertyResponses = {
|
|
2182
|
+
/**
|
|
2183
|
+
* Property updated successfully
|
|
2184
|
+
*/
|
|
2185
|
+
200: Property;
|
|
2186
|
+
};
|
|
2187
|
+
export type UpdatePropertyResponse = UpdatePropertyResponses[keyof UpdatePropertyResponses];
|
|
2188
|
+
export type ReplacePropertyData = {
|
|
2189
|
+
body: Property;
|
|
2190
|
+
headers?: {
|
|
2191
|
+
/**
|
|
2192
|
+
* ETag value for optimistic concurrency control
|
|
2193
|
+
*/
|
|
2194
|
+
'If-Match'?: string;
|
|
2195
|
+
};
|
|
2196
|
+
path: {
|
|
2197
|
+
/**
|
|
2198
|
+
* Unique identifier for the estate (UUID v4)
|
|
2199
|
+
*/
|
|
2200
|
+
estateId: string;
|
|
2201
|
+
/**
|
|
2202
|
+
* Unique identifier for the property (UUID v4)
|
|
2203
|
+
*/
|
|
2204
|
+
propertyId: string;
|
|
2205
|
+
};
|
|
2206
|
+
query?: never;
|
|
2207
|
+
url: '/estates/{estateId}/properties/{propertyId}';
|
|
2208
|
+
};
|
|
2209
|
+
export type ReplacePropertyErrors = {
|
|
2210
|
+
/**
|
|
2211
|
+
* The request body failed schema validation
|
|
2212
|
+
*/
|
|
2213
|
+
400: Error;
|
|
2214
|
+
/**
|
|
2215
|
+
* The requested resource was not found
|
|
2216
|
+
*/
|
|
2217
|
+
404: Error;
|
|
2218
|
+
};
|
|
2219
|
+
export type ReplacePropertyError = ReplacePropertyErrors[keyof ReplacePropertyErrors];
|
|
2220
|
+
export type ReplacePropertyResponses = {
|
|
2221
|
+
/**
|
|
2222
|
+
* Property replaced successfully
|
|
2223
|
+
*/
|
|
2224
|
+
200: Property;
|
|
2225
|
+
};
|
|
2226
|
+
export type ReplacePropertyResponse = ReplacePropertyResponses[keyof ReplacePropertyResponses];
|
|
2227
|
+
export type ListAssetsData = {
|
|
2228
|
+
body?: never;
|
|
2229
|
+
path: {
|
|
2230
|
+
/**
|
|
2231
|
+
* Unique identifier for the estate (UUID v4)
|
|
2232
|
+
*/
|
|
2233
|
+
estateId: string;
|
|
2234
|
+
};
|
|
2235
|
+
query?: never;
|
|
2236
|
+
url: '/estates/{estateId}/assets';
|
|
2237
|
+
};
|
|
2238
|
+
export type ListAssetsResponses = {
|
|
2239
|
+
/**
|
|
2240
|
+
* List of assets
|
|
2241
|
+
*/
|
|
2242
|
+
200: {
|
|
2243
|
+
items: Array<Asset>;
|
|
2244
|
+
};
|
|
2245
|
+
};
|
|
2246
|
+
export type ListAssetsResponse = ListAssetsResponses[keyof ListAssetsResponses];
|
|
2247
|
+
export type CreateAssetData = {
|
|
2248
|
+
body: Asset;
|
|
2249
|
+
path: {
|
|
2250
|
+
/**
|
|
2251
|
+
* Unique identifier for the estate (UUID v4)
|
|
2252
|
+
*/
|
|
2253
|
+
estateId: string;
|
|
2254
|
+
};
|
|
2255
|
+
query?: never;
|
|
2256
|
+
url: '/estates/{estateId}/assets';
|
|
2257
|
+
};
|
|
2258
|
+
export type CreateAssetErrors = {
|
|
2259
|
+
/**
|
|
2260
|
+
* The request body failed schema validation
|
|
2261
|
+
*/
|
|
2262
|
+
400: Error;
|
|
2263
|
+
};
|
|
2264
|
+
export type CreateAssetError = CreateAssetErrors[keyof CreateAssetErrors];
|
|
2265
|
+
export type CreateAssetResponses = {
|
|
2266
|
+
/**
|
|
2267
|
+
* Asset created successfully
|
|
2268
|
+
*/
|
|
2269
|
+
201: Asset;
|
|
2270
|
+
};
|
|
2271
|
+
export type CreateAssetResponse = CreateAssetResponses[keyof CreateAssetResponses];
|
|
2272
|
+
export type DeleteAssetData = {
|
|
2273
|
+
body?: never;
|
|
2274
|
+
path: {
|
|
2275
|
+
/**
|
|
2276
|
+
* Unique identifier for the estate (UUID v4)
|
|
2277
|
+
*/
|
|
2278
|
+
estateId: string;
|
|
2279
|
+
/**
|
|
2280
|
+
* Unique identifier for the asset (UUID v4)
|
|
2281
|
+
*/
|
|
2282
|
+
assetId: string;
|
|
2283
|
+
};
|
|
2284
|
+
query?: never;
|
|
2285
|
+
url: '/estates/{estateId}/assets/{assetId}';
|
|
2286
|
+
};
|
|
2287
|
+
export type DeleteAssetErrors = {
|
|
2288
|
+
/**
|
|
2289
|
+
* The requested resource was not found
|
|
2290
|
+
*/
|
|
2291
|
+
404: Error;
|
|
2292
|
+
/**
|
|
2293
|
+
* The request conflicts with the current state of the resource
|
|
2294
|
+
*/
|
|
2295
|
+
409: Error;
|
|
2296
|
+
};
|
|
2297
|
+
export type DeleteAssetError = DeleteAssetErrors[keyof DeleteAssetErrors];
|
|
2298
|
+
export type DeleteAssetResponses = {
|
|
2299
|
+
/**
|
|
2300
|
+
* Asset deleted successfully
|
|
2301
|
+
*/
|
|
2302
|
+
204: void;
|
|
2303
|
+
};
|
|
2304
|
+
export type DeleteAssetResponse = DeleteAssetResponses[keyof DeleteAssetResponses];
|
|
2305
|
+
export type GetAssetData = {
|
|
2306
|
+
body?: never;
|
|
2307
|
+
path: {
|
|
2308
|
+
/**
|
|
2309
|
+
* Unique identifier for the estate (UUID v4)
|
|
2310
|
+
*/
|
|
2311
|
+
estateId: string;
|
|
2312
|
+
/**
|
|
2313
|
+
* Unique identifier for the asset (UUID v4)
|
|
2314
|
+
*/
|
|
2315
|
+
assetId: string;
|
|
2316
|
+
};
|
|
2317
|
+
query?: never;
|
|
2318
|
+
url: '/estates/{estateId}/assets/{assetId}';
|
|
2319
|
+
};
|
|
2320
|
+
export type GetAssetErrors = {
|
|
2321
|
+
/**
|
|
2322
|
+
* The requested resource was not found
|
|
2323
|
+
*/
|
|
2324
|
+
404: Error;
|
|
2325
|
+
};
|
|
2326
|
+
export type GetAssetError = GetAssetErrors[keyof GetAssetErrors];
|
|
2327
|
+
export type GetAssetResponses = {
|
|
2328
|
+
/**
|
|
2329
|
+
* Asset retrieved successfully
|
|
2330
|
+
*/
|
|
2331
|
+
200: Asset;
|
|
2332
|
+
};
|
|
2333
|
+
export type GetAssetResponse = GetAssetResponses[keyof GetAssetResponses];
|
|
2334
|
+
export type UpdateAssetData = {
|
|
2335
|
+
body: Asset;
|
|
2336
|
+
headers?: {
|
|
2337
|
+
/**
|
|
2338
|
+
* ETag value for optimistic concurrency control
|
|
2339
|
+
*/
|
|
2340
|
+
'If-Match'?: string;
|
|
2341
|
+
};
|
|
2342
|
+
path: {
|
|
2343
|
+
/**
|
|
2344
|
+
* Unique identifier for the estate (UUID v4)
|
|
2345
|
+
*/
|
|
2346
|
+
estateId: string;
|
|
2347
|
+
/**
|
|
2348
|
+
* Unique identifier for the asset (UUID v4)
|
|
2349
|
+
*/
|
|
2350
|
+
assetId: string;
|
|
2351
|
+
};
|
|
2352
|
+
query?: never;
|
|
2353
|
+
url: '/estates/{estateId}/assets/{assetId}';
|
|
2354
|
+
};
|
|
2355
|
+
export type UpdateAssetErrors = {
|
|
2356
|
+
/**
|
|
2357
|
+
* The request body failed schema validation
|
|
2358
|
+
*/
|
|
2359
|
+
400: Error;
|
|
2360
|
+
/**
|
|
2361
|
+
* The requested resource was not found
|
|
2362
|
+
*/
|
|
2363
|
+
404: Error;
|
|
2364
|
+
};
|
|
2365
|
+
export type UpdateAssetError = UpdateAssetErrors[keyof UpdateAssetErrors];
|
|
2366
|
+
export type UpdateAssetResponses = {
|
|
2367
|
+
/**
|
|
2368
|
+
* Asset updated successfully
|
|
2369
|
+
*/
|
|
2370
|
+
200: Asset;
|
|
2371
|
+
};
|
|
2372
|
+
export type UpdateAssetResponse = UpdateAssetResponses[keyof UpdateAssetResponses];
|
|
2373
|
+
export type ReplaceAssetData = {
|
|
2374
|
+
body: Asset;
|
|
2375
|
+
headers?: {
|
|
2376
|
+
/**
|
|
2377
|
+
* ETag value for optimistic concurrency control
|
|
2378
|
+
*/
|
|
2379
|
+
'If-Match'?: string;
|
|
2380
|
+
};
|
|
2381
|
+
path: {
|
|
2382
|
+
/**
|
|
2383
|
+
* Unique identifier for the estate (UUID v4)
|
|
2384
|
+
*/
|
|
2385
|
+
estateId: string;
|
|
2386
|
+
/**
|
|
2387
|
+
* Unique identifier for the asset (UUID v4)
|
|
2388
|
+
*/
|
|
2389
|
+
assetId: string;
|
|
2390
|
+
};
|
|
2391
|
+
query?: never;
|
|
2392
|
+
url: '/estates/{estateId}/assets/{assetId}';
|
|
2393
|
+
};
|
|
2394
|
+
export type ReplaceAssetErrors = {
|
|
2395
|
+
/**
|
|
2396
|
+
* The request body failed schema validation
|
|
2397
|
+
*/
|
|
2398
|
+
400: Error;
|
|
2399
|
+
/**
|
|
2400
|
+
* The requested resource was not found
|
|
2401
|
+
*/
|
|
2402
|
+
404: Error;
|
|
2403
|
+
};
|
|
2404
|
+
export type ReplaceAssetError = ReplaceAssetErrors[keyof ReplaceAssetErrors];
|
|
2405
|
+
export type ReplaceAssetResponses = {
|
|
2406
|
+
/**
|
|
2407
|
+
* Asset replaced successfully
|
|
2408
|
+
*/
|
|
2409
|
+
200: Asset;
|
|
2410
|
+
};
|
|
2411
|
+
export type ReplaceAssetResponse = ReplaceAssetResponses[keyof ReplaceAssetResponses];
|
|
2412
|
+
export type ListLiabilitiesData = {
|
|
2413
|
+
body?: never;
|
|
2414
|
+
path: {
|
|
2415
|
+
/**
|
|
2416
|
+
* Unique identifier for the estate (UUID v4)
|
|
2417
|
+
*/
|
|
2418
|
+
estateId: string;
|
|
2419
|
+
};
|
|
2420
|
+
query?: never;
|
|
2421
|
+
url: '/estates/{estateId}/liabilities';
|
|
2422
|
+
};
|
|
2423
|
+
export type ListLiabilitiesResponses = {
|
|
2424
|
+
/**
|
|
2425
|
+
* List of liabilities
|
|
2426
|
+
*/
|
|
2427
|
+
200: {
|
|
2428
|
+
items: Array<Liability>;
|
|
2429
|
+
};
|
|
2430
|
+
};
|
|
2431
|
+
export type ListLiabilitiesResponse = ListLiabilitiesResponses[keyof ListLiabilitiesResponses];
|
|
2432
|
+
export type CreateLiabilityData = {
|
|
2433
|
+
body: Liability;
|
|
2434
|
+
path: {
|
|
2435
|
+
/**
|
|
2436
|
+
* Unique identifier for the estate (UUID v4)
|
|
2437
|
+
*/
|
|
2438
|
+
estateId: string;
|
|
2439
|
+
};
|
|
2440
|
+
query?: never;
|
|
2441
|
+
url: '/estates/{estateId}/liabilities';
|
|
2442
|
+
};
|
|
2443
|
+
export type CreateLiabilityErrors = {
|
|
2444
|
+
/**
|
|
2445
|
+
* The request body failed schema validation
|
|
2446
|
+
*/
|
|
2447
|
+
400: Error;
|
|
2448
|
+
};
|
|
2449
|
+
export type CreateLiabilityError = CreateLiabilityErrors[keyof CreateLiabilityErrors];
|
|
2450
|
+
export type CreateLiabilityResponses = {
|
|
2451
|
+
/**
|
|
2452
|
+
* Liability created successfully
|
|
2453
|
+
*/
|
|
2454
|
+
201: Liability;
|
|
2455
|
+
};
|
|
2456
|
+
export type CreateLiabilityResponse = CreateLiabilityResponses[keyof CreateLiabilityResponses];
|
|
2457
|
+
export type DeleteLiabilityData = {
|
|
2458
|
+
body?: never;
|
|
2459
|
+
path: {
|
|
2460
|
+
/**
|
|
2461
|
+
* Unique identifier for the estate (UUID v4)
|
|
2462
|
+
*/
|
|
2463
|
+
estateId: string;
|
|
2464
|
+
/**
|
|
2465
|
+
* Unique identifier for the liability (UUID v4)
|
|
2466
|
+
*/
|
|
2467
|
+
liabilityId: string;
|
|
2468
|
+
};
|
|
2469
|
+
query?: never;
|
|
2470
|
+
url: '/estates/{estateId}/liabilities/{liabilityId}';
|
|
2471
|
+
};
|
|
2472
|
+
export type DeleteLiabilityErrors = {
|
|
2473
|
+
/**
|
|
2474
|
+
* The requested resource was not found
|
|
2475
|
+
*/
|
|
2476
|
+
404: Error;
|
|
2477
|
+
};
|
|
2478
|
+
export type DeleteLiabilityError = DeleteLiabilityErrors[keyof DeleteLiabilityErrors];
|
|
2479
|
+
export type DeleteLiabilityResponses = {
|
|
2480
|
+
/**
|
|
2481
|
+
* Liability deleted successfully
|
|
2482
|
+
*/
|
|
2483
|
+
204: void;
|
|
2484
|
+
};
|
|
2485
|
+
export type DeleteLiabilityResponse = DeleteLiabilityResponses[keyof DeleteLiabilityResponses];
|
|
2486
|
+
export type GetLiabilityData = {
|
|
2487
|
+
body?: never;
|
|
2488
|
+
path: {
|
|
2489
|
+
/**
|
|
2490
|
+
* Unique identifier for the estate (UUID v4)
|
|
2491
|
+
*/
|
|
2492
|
+
estateId: string;
|
|
2493
|
+
/**
|
|
2494
|
+
* Unique identifier for the liability (UUID v4)
|
|
2495
|
+
*/
|
|
2496
|
+
liabilityId: string;
|
|
2497
|
+
};
|
|
2498
|
+
query?: never;
|
|
2499
|
+
url: '/estates/{estateId}/liabilities/{liabilityId}';
|
|
2500
|
+
};
|
|
2501
|
+
export type GetLiabilityErrors = {
|
|
2502
|
+
/**
|
|
2503
|
+
* The requested resource was not found
|
|
2504
|
+
*/
|
|
2505
|
+
404: Error;
|
|
2506
|
+
};
|
|
2507
|
+
export type GetLiabilityError = GetLiabilityErrors[keyof GetLiabilityErrors];
|
|
2508
|
+
export type GetLiabilityResponses = {
|
|
2509
|
+
/**
|
|
2510
|
+
* Liability retrieved successfully
|
|
2511
|
+
*/
|
|
2512
|
+
200: Liability;
|
|
2513
|
+
};
|
|
2514
|
+
export type GetLiabilityResponse = GetLiabilityResponses[keyof GetLiabilityResponses];
|
|
2515
|
+
export type UpdateLiabilityData = {
|
|
2516
|
+
body: Liability;
|
|
2517
|
+
headers?: {
|
|
2518
|
+
/**
|
|
2519
|
+
* ETag value for optimistic concurrency control
|
|
2520
|
+
*/
|
|
2521
|
+
'If-Match'?: string;
|
|
2522
|
+
};
|
|
2523
|
+
path: {
|
|
2524
|
+
/**
|
|
2525
|
+
* Unique identifier for the estate (UUID v4)
|
|
2526
|
+
*/
|
|
2527
|
+
estateId: string;
|
|
2528
|
+
/**
|
|
2529
|
+
* Unique identifier for the liability (UUID v4)
|
|
2530
|
+
*/
|
|
2531
|
+
liabilityId: string;
|
|
2532
|
+
};
|
|
2533
|
+
query?: never;
|
|
2534
|
+
url: '/estates/{estateId}/liabilities/{liabilityId}';
|
|
2535
|
+
};
|
|
2536
|
+
export type UpdateLiabilityErrors = {
|
|
2537
|
+
/**
|
|
2538
|
+
* The request body failed schema validation
|
|
2539
|
+
*/
|
|
2540
|
+
400: Error;
|
|
2541
|
+
/**
|
|
2542
|
+
* The requested resource was not found
|
|
2543
|
+
*/
|
|
2544
|
+
404: Error;
|
|
2545
|
+
};
|
|
2546
|
+
export type UpdateLiabilityError = UpdateLiabilityErrors[keyof UpdateLiabilityErrors];
|
|
2547
|
+
export type UpdateLiabilityResponses = {
|
|
2548
|
+
/**
|
|
2549
|
+
* Liability updated successfully
|
|
2550
|
+
*/
|
|
2551
|
+
200: Liability;
|
|
2552
|
+
};
|
|
2553
|
+
export type UpdateLiabilityResponse = UpdateLiabilityResponses[keyof UpdateLiabilityResponses];
|
|
2554
|
+
export type ReplaceLiabilityData = {
|
|
2555
|
+
body: Liability;
|
|
2556
|
+
headers?: {
|
|
2557
|
+
/**
|
|
2558
|
+
* ETag value for optimistic concurrency control
|
|
2559
|
+
*/
|
|
2560
|
+
'If-Match'?: string;
|
|
2561
|
+
};
|
|
2562
|
+
path: {
|
|
2563
|
+
/**
|
|
2564
|
+
* Unique identifier for the estate (UUID v4)
|
|
2565
|
+
*/
|
|
2566
|
+
estateId: string;
|
|
2567
|
+
/**
|
|
2568
|
+
* Unique identifier for the liability (UUID v4)
|
|
2569
|
+
*/
|
|
2570
|
+
liabilityId: string;
|
|
2571
|
+
};
|
|
2572
|
+
query?: never;
|
|
2573
|
+
url: '/estates/{estateId}/liabilities/{liabilityId}';
|
|
2574
|
+
};
|
|
2575
|
+
export type ReplaceLiabilityErrors = {
|
|
2576
|
+
/**
|
|
2577
|
+
* The request body failed schema validation
|
|
2578
|
+
*/
|
|
2579
|
+
400: Error;
|
|
2580
|
+
/**
|
|
2581
|
+
* The requested resource was not found
|
|
2582
|
+
*/
|
|
2583
|
+
404: Error;
|
|
2584
|
+
};
|
|
2585
|
+
export type ReplaceLiabilityError = ReplaceLiabilityErrors[keyof ReplaceLiabilityErrors];
|
|
2586
|
+
export type ReplaceLiabilityResponses = {
|
|
2587
|
+
/**
|
|
2588
|
+
* Liability replaced successfully
|
|
2589
|
+
*/
|
|
2590
|
+
200: Liability;
|
|
2591
|
+
};
|
|
2592
|
+
export type ReplaceLiabilityResponse = ReplaceLiabilityResponses[keyof ReplaceLiabilityResponses];
|
|
2593
|
+
export type ListBequestsData = {
|
|
2594
|
+
body?: never;
|
|
2595
|
+
path: {
|
|
2596
|
+
/**
|
|
2597
|
+
* Unique identifier for the estate (UUID v4)
|
|
2598
|
+
*/
|
|
2599
|
+
estateId: string;
|
|
2600
|
+
};
|
|
2601
|
+
query?: never;
|
|
2602
|
+
url: '/estates/{estateId}/bequests';
|
|
2603
|
+
};
|
|
2604
|
+
export type ListBequestsResponses = {
|
|
2605
|
+
/**
|
|
2606
|
+
* List of bequests
|
|
2607
|
+
*/
|
|
2608
|
+
200: {
|
|
2609
|
+
items: Array<Bequest>;
|
|
2610
|
+
};
|
|
2611
|
+
};
|
|
2612
|
+
export type ListBequestsResponse = ListBequestsResponses[keyof ListBequestsResponses];
|
|
2613
|
+
export type CreateBequestData = {
|
|
2614
|
+
body: Bequest;
|
|
2615
|
+
path: {
|
|
2616
|
+
/**
|
|
2617
|
+
* Unique identifier for the estate (UUID v4)
|
|
2618
|
+
*/
|
|
2619
|
+
estateId: string;
|
|
2620
|
+
};
|
|
2621
|
+
query?: never;
|
|
2622
|
+
url: '/estates/{estateId}/bequests';
|
|
2623
|
+
};
|
|
2624
|
+
export type CreateBequestErrors = {
|
|
2625
|
+
/**
|
|
2626
|
+
* The request body failed schema validation
|
|
2627
|
+
*/
|
|
2628
|
+
400: Error;
|
|
2629
|
+
};
|
|
2630
|
+
export type CreateBequestError = CreateBequestErrors[keyof CreateBequestErrors];
|
|
2631
|
+
export type CreateBequestResponses = {
|
|
2632
|
+
/**
|
|
2633
|
+
* Bequest created successfully
|
|
2634
|
+
*/
|
|
2635
|
+
201: Bequest;
|
|
2636
|
+
};
|
|
2637
|
+
export type CreateBequestResponse = CreateBequestResponses[keyof CreateBequestResponses];
|
|
2638
|
+
export type DeleteBequestData = {
|
|
2639
|
+
body?: never;
|
|
2640
|
+
path: {
|
|
2641
|
+
/**
|
|
2642
|
+
* Unique identifier for the estate (UUID v4)
|
|
2643
|
+
*/
|
|
2644
|
+
estateId: string;
|
|
2645
|
+
/**
|
|
2646
|
+
* Unique identifier for the bequest (UUID v4)
|
|
2647
|
+
*/
|
|
2648
|
+
bequestId: string;
|
|
2649
|
+
};
|
|
2650
|
+
query?: never;
|
|
2651
|
+
url: '/estates/{estateId}/bequests/{bequestId}';
|
|
2652
|
+
};
|
|
2653
|
+
export type DeleteBequestErrors = {
|
|
2654
|
+
/**
|
|
2655
|
+
* The requested resource was not found
|
|
2656
|
+
*/
|
|
2657
|
+
404: Error;
|
|
2658
|
+
};
|
|
2659
|
+
export type DeleteBequestError = DeleteBequestErrors[keyof DeleteBequestErrors];
|
|
2660
|
+
export type DeleteBequestResponses = {
|
|
2661
|
+
/**
|
|
2662
|
+
* Bequest deleted successfully
|
|
2663
|
+
*/
|
|
2664
|
+
204: void;
|
|
2665
|
+
};
|
|
2666
|
+
export type DeleteBequestResponse = DeleteBequestResponses[keyof DeleteBequestResponses];
|
|
2667
|
+
export type GetBequestData = {
|
|
2668
|
+
body?: never;
|
|
2669
|
+
path: {
|
|
2670
|
+
/**
|
|
2671
|
+
* Unique identifier for the estate (UUID v4)
|
|
2672
|
+
*/
|
|
2673
|
+
estateId: string;
|
|
2674
|
+
/**
|
|
2675
|
+
* Unique identifier for the bequest (UUID v4)
|
|
2676
|
+
*/
|
|
2677
|
+
bequestId: string;
|
|
2678
|
+
};
|
|
2679
|
+
query?: never;
|
|
2680
|
+
url: '/estates/{estateId}/bequests/{bequestId}';
|
|
2681
|
+
};
|
|
2682
|
+
export type GetBequestErrors = {
|
|
2683
|
+
/**
|
|
2684
|
+
* The requested resource was not found
|
|
2685
|
+
*/
|
|
2686
|
+
404: Error;
|
|
2687
|
+
};
|
|
2688
|
+
export type GetBequestError = GetBequestErrors[keyof GetBequestErrors];
|
|
2689
|
+
export type GetBequestResponses = {
|
|
2690
|
+
/**
|
|
2691
|
+
* Bequest retrieved successfully
|
|
2692
|
+
*/
|
|
2693
|
+
200: Bequest;
|
|
2694
|
+
};
|
|
2695
|
+
export type GetBequestResponse = GetBequestResponses[keyof GetBequestResponses];
|
|
2696
|
+
export type UpdateBequestData = {
|
|
2697
|
+
body: Bequest;
|
|
2698
|
+
headers?: {
|
|
2699
|
+
/**
|
|
2700
|
+
* ETag value for optimistic concurrency control
|
|
2701
|
+
*/
|
|
2702
|
+
'If-Match'?: string;
|
|
2703
|
+
};
|
|
2704
|
+
path: {
|
|
2705
|
+
/**
|
|
2706
|
+
* Unique identifier for the estate (UUID v4)
|
|
2707
|
+
*/
|
|
2708
|
+
estateId: string;
|
|
2709
|
+
/**
|
|
2710
|
+
* Unique identifier for the bequest (UUID v4)
|
|
2711
|
+
*/
|
|
2712
|
+
bequestId: string;
|
|
2713
|
+
};
|
|
2714
|
+
query?: never;
|
|
2715
|
+
url: '/estates/{estateId}/bequests/{bequestId}';
|
|
2716
|
+
};
|
|
2717
|
+
export type UpdateBequestErrors = {
|
|
2718
|
+
/**
|
|
2719
|
+
* The request body failed schema validation
|
|
2720
|
+
*/
|
|
2721
|
+
400: Error;
|
|
2722
|
+
/**
|
|
2723
|
+
* The requested resource was not found
|
|
2724
|
+
*/
|
|
2725
|
+
404: Error;
|
|
2726
|
+
};
|
|
2727
|
+
export type UpdateBequestError = UpdateBequestErrors[keyof UpdateBequestErrors];
|
|
2728
|
+
export type UpdateBequestResponses = {
|
|
2729
|
+
/**
|
|
2730
|
+
* Bequest updated successfully
|
|
2731
|
+
*/
|
|
2732
|
+
200: Bequest;
|
|
2733
|
+
};
|
|
2734
|
+
export type UpdateBequestResponse = UpdateBequestResponses[keyof UpdateBequestResponses];
|
|
2735
|
+
export type ReplaceBequestData = {
|
|
2736
|
+
body: Bequest;
|
|
2737
|
+
headers?: {
|
|
2738
|
+
/**
|
|
2739
|
+
* ETag value for optimistic concurrency control
|
|
2740
|
+
*/
|
|
2741
|
+
'If-Match'?: string;
|
|
2742
|
+
};
|
|
2743
|
+
path: {
|
|
2744
|
+
/**
|
|
2745
|
+
* Unique identifier for the estate (UUID v4)
|
|
2746
|
+
*/
|
|
2747
|
+
estateId: string;
|
|
2748
|
+
/**
|
|
2749
|
+
* Unique identifier for the bequest (UUID v4)
|
|
2750
|
+
*/
|
|
2751
|
+
bequestId: string;
|
|
2752
|
+
};
|
|
2753
|
+
query?: never;
|
|
2754
|
+
url: '/estates/{estateId}/bequests/{bequestId}';
|
|
2755
|
+
};
|
|
2756
|
+
export type ReplaceBequestErrors = {
|
|
2757
|
+
/**
|
|
2758
|
+
* The request body failed schema validation
|
|
2759
|
+
*/
|
|
2760
|
+
400: Error;
|
|
2761
|
+
/**
|
|
2762
|
+
* The requested resource was not found
|
|
2763
|
+
*/
|
|
2764
|
+
404: Error;
|
|
2765
|
+
};
|
|
2766
|
+
export type ReplaceBequestError = ReplaceBequestErrors[keyof ReplaceBequestErrors];
|
|
2767
|
+
export type ReplaceBequestResponses = {
|
|
2768
|
+
/**
|
|
2769
|
+
* Bequest replaced successfully
|
|
2770
|
+
*/
|
|
2771
|
+
200: Bequest;
|
|
2772
|
+
};
|
|
2773
|
+
export type ReplaceBequestResponse = ReplaceBequestResponses[keyof ReplaceBequestResponses];
|
|
2774
|
+
export type ListTrustsData = {
|
|
2775
|
+
body?: never;
|
|
2776
|
+
path: {
|
|
2777
|
+
/**
|
|
2778
|
+
* Unique identifier for the estate (UUID v4)
|
|
2779
|
+
*/
|
|
2780
|
+
estateId: string;
|
|
2781
|
+
};
|
|
2782
|
+
query?: never;
|
|
2783
|
+
url: '/estates/{estateId}/trusts';
|
|
2784
|
+
};
|
|
2785
|
+
export type ListTrustsResponses = {
|
|
2786
|
+
/**
|
|
2787
|
+
* List of trusts
|
|
2788
|
+
*/
|
|
2789
|
+
200: {
|
|
2790
|
+
items: Array<Trust>;
|
|
2791
|
+
};
|
|
2792
|
+
};
|
|
2793
|
+
export type ListTrustsResponse = ListTrustsResponses[keyof ListTrustsResponses];
|
|
2794
|
+
export type CreateTrustData = {
|
|
2795
|
+
body: Trust;
|
|
2796
|
+
path: {
|
|
2797
|
+
/**
|
|
2798
|
+
* Unique identifier for the estate (UUID v4)
|
|
2799
|
+
*/
|
|
2800
|
+
estateId: string;
|
|
2801
|
+
};
|
|
2802
|
+
query?: never;
|
|
2803
|
+
url: '/estates/{estateId}/trusts';
|
|
2804
|
+
};
|
|
2805
|
+
export type CreateTrustErrors = {
|
|
2806
|
+
/**
|
|
2807
|
+
* The request body failed schema validation
|
|
2808
|
+
*/
|
|
2809
|
+
400: Error;
|
|
2810
|
+
};
|
|
2811
|
+
export type CreateTrustError = CreateTrustErrors[keyof CreateTrustErrors];
|
|
2812
|
+
export type CreateTrustResponses = {
|
|
2813
|
+
/**
|
|
2814
|
+
* Trust created successfully
|
|
2815
|
+
*/
|
|
2816
|
+
201: Trust;
|
|
2817
|
+
};
|
|
2818
|
+
export type CreateTrustResponse = CreateTrustResponses[keyof CreateTrustResponses];
|
|
2819
|
+
export type DeleteTrustData = {
|
|
2820
|
+
body?: never;
|
|
2821
|
+
path: {
|
|
2822
|
+
/**
|
|
2823
|
+
* Unique identifier for the estate (UUID v4)
|
|
2824
|
+
*/
|
|
2825
|
+
estateId: string;
|
|
2826
|
+
/**
|
|
2827
|
+
* Unique identifier for the trust (UUID v4)
|
|
2828
|
+
*/
|
|
2829
|
+
trustId: string;
|
|
2830
|
+
};
|
|
2831
|
+
query?: never;
|
|
2832
|
+
url: '/estates/{estateId}/trusts/{trustId}';
|
|
2833
|
+
};
|
|
2834
|
+
export type DeleteTrustErrors = {
|
|
2835
|
+
/**
|
|
2836
|
+
* The requested resource was not found
|
|
2837
|
+
*/
|
|
2838
|
+
404: Error;
|
|
2839
|
+
};
|
|
2840
|
+
export type DeleteTrustError = DeleteTrustErrors[keyof DeleteTrustErrors];
|
|
2841
|
+
export type DeleteTrustResponses = {
|
|
2842
|
+
/**
|
|
2843
|
+
* Trust deleted successfully
|
|
2844
|
+
*/
|
|
2845
|
+
204: void;
|
|
2846
|
+
};
|
|
2847
|
+
export type DeleteTrustResponse = DeleteTrustResponses[keyof DeleteTrustResponses];
|
|
2848
|
+
export type GetTrustData = {
|
|
2849
|
+
body?: never;
|
|
2850
|
+
path: {
|
|
2851
|
+
/**
|
|
2852
|
+
* Unique identifier for the estate (UUID v4)
|
|
2853
|
+
*/
|
|
2854
|
+
estateId: string;
|
|
2855
|
+
/**
|
|
2856
|
+
* Unique identifier for the trust (UUID v4)
|
|
2857
|
+
*/
|
|
2858
|
+
trustId: string;
|
|
2859
|
+
};
|
|
2860
|
+
query?: never;
|
|
2861
|
+
url: '/estates/{estateId}/trusts/{trustId}';
|
|
2862
|
+
};
|
|
2863
|
+
export type GetTrustErrors = {
|
|
2864
|
+
/**
|
|
2865
|
+
* The requested resource was not found
|
|
2866
|
+
*/
|
|
2867
|
+
404: Error;
|
|
2868
|
+
};
|
|
2869
|
+
export type GetTrustError = GetTrustErrors[keyof GetTrustErrors];
|
|
2870
|
+
export type GetTrustResponses = {
|
|
2871
|
+
/**
|
|
2872
|
+
* Trust retrieved successfully
|
|
2873
|
+
*/
|
|
2874
|
+
200: Trust;
|
|
2875
|
+
};
|
|
2876
|
+
export type GetTrustResponse = GetTrustResponses[keyof GetTrustResponses];
|
|
2877
|
+
export type UpdateTrustData = {
|
|
2878
|
+
body: Trust;
|
|
2879
|
+
headers?: {
|
|
2880
|
+
/**
|
|
2881
|
+
* ETag value for optimistic concurrency control
|
|
2882
|
+
*/
|
|
2883
|
+
'If-Match'?: string;
|
|
2884
|
+
};
|
|
2885
|
+
path: {
|
|
2886
|
+
/**
|
|
2887
|
+
* Unique identifier for the estate (UUID v4)
|
|
2888
|
+
*/
|
|
2889
|
+
estateId: string;
|
|
2890
|
+
/**
|
|
2891
|
+
* Unique identifier for the trust (UUID v4)
|
|
2892
|
+
*/
|
|
2893
|
+
trustId: string;
|
|
2894
|
+
};
|
|
2895
|
+
query?: never;
|
|
2896
|
+
url: '/estates/{estateId}/trusts/{trustId}';
|
|
2897
|
+
};
|
|
2898
|
+
export type UpdateTrustErrors = {
|
|
2899
|
+
/**
|
|
2900
|
+
* The request body failed schema validation
|
|
2901
|
+
*/
|
|
2902
|
+
400: Error;
|
|
2903
|
+
/**
|
|
2904
|
+
* The requested resource was not found
|
|
2905
|
+
*/
|
|
2906
|
+
404: Error;
|
|
2907
|
+
};
|
|
2908
|
+
export type UpdateTrustError = UpdateTrustErrors[keyof UpdateTrustErrors];
|
|
2909
|
+
export type UpdateTrustResponses = {
|
|
2910
|
+
/**
|
|
2911
|
+
* Trust updated successfully
|
|
2912
|
+
*/
|
|
2913
|
+
200: Trust;
|
|
2914
|
+
};
|
|
2915
|
+
export type UpdateTrustResponse = UpdateTrustResponses[keyof UpdateTrustResponses];
|
|
2916
|
+
export type ReplaceTrustData = {
|
|
2917
|
+
body: Trust;
|
|
2918
|
+
headers?: {
|
|
2919
|
+
/**
|
|
2920
|
+
* ETag value for optimistic concurrency control
|
|
2921
|
+
*/
|
|
2922
|
+
'If-Match'?: string;
|
|
2923
|
+
};
|
|
2924
|
+
path: {
|
|
2925
|
+
/**
|
|
2926
|
+
* Unique identifier for the estate (UUID v4)
|
|
2927
|
+
*/
|
|
2928
|
+
estateId: string;
|
|
2929
|
+
/**
|
|
2930
|
+
* Unique identifier for the trust (UUID v4)
|
|
2931
|
+
*/
|
|
2932
|
+
trustId: string;
|
|
2933
|
+
};
|
|
2934
|
+
query?: never;
|
|
2935
|
+
url: '/estates/{estateId}/trusts/{trustId}';
|
|
2936
|
+
};
|
|
2937
|
+
export type ReplaceTrustErrors = {
|
|
2938
|
+
/**
|
|
2939
|
+
* The request body failed schema validation
|
|
2940
|
+
*/
|
|
2941
|
+
400: Error;
|
|
2942
|
+
/**
|
|
2943
|
+
* The requested resource was not found
|
|
2944
|
+
*/
|
|
2945
|
+
404: Error;
|
|
2946
|
+
};
|
|
2947
|
+
export type ReplaceTrustError = ReplaceTrustErrors[keyof ReplaceTrustErrors];
|
|
2948
|
+
export type ReplaceTrustResponses = {
|
|
2949
|
+
/**
|
|
2950
|
+
* Trust replaced successfully
|
|
2951
|
+
*/
|
|
2952
|
+
200: Trust;
|
|
2953
|
+
};
|
|
2954
|
+
export type ReplaceTrustResponse = ReplaceTrustResponses[keyof ReplaceTrustResponses];
|
|
2955
|
+
export type ListExecutorsData = {
|
|
2956
|
+
body?: never;
|
|
2957
|
+
path: {
|
|
2958
|
+
/**
|
|
2959
|
+
* Unique identifier for the estate (UUID v4)
|
|
2960
|
+
*/
|
|
2961
|
+
estateId: string;
|
|
2962
|
+
};
|
|
2963
|
+
query?: never;
|
|
2964
|
+
url: '/estates/{estateId}/executors';
|
|
2965
|
+
};
|
|
2966
|
+
export type ListExecutorsResponses = {
|
|
2967
|
+
/**
|
|
2968
|
+
* List of executors
|
|
2969
|
+
*/
|
|
2970
|
+
200: {
|
|
2971
|
+
items: Array<Executor>;
|
|
2972
|
+
};
|
|
2973
|
+
};
|
|
2974
|
+
export type ListExecutorsResponse = ListExecutorsResponses[keyof ListExecutorsResponses];
|
|
2975
|
+
export type CreateExecutorData = {
|
|
2976
|
+
body: Executor;
|
|
2977
|
+
path: {
|
|
2978
|
+
/**
|
|
2979
|
+
* Unique identifier for the estate (UUID v4)
|
|
2980
|
+
*/
|
|
2981
|
+
estateId: string;
|
|
2982
|
+
};
|
|
2983
|
+
query?: never;
|
|
2984
|
+
url: '/estates/{estateId}/executors';
|
|
2985
|
+
};
|
|
2986
|
+
export type CreateExecutorErrors = {
|
|
2987
|
+
/**
|
|
2988
|
+
* The request body failed schema validation
|
|
2989
|
+
*/
|
|
2990
|
+
400: Error;
|
|
2991
|
+
};
|
|
2992
|
+
export type CreateExecutorError = CreateExecutorErrors[keyof CreateExecutorErrors];
|
|
2993
|
+
export type CreateExecutorResponses = {
|
|
2994
|
+
/**
|
|
2995
|
+
* Executor created successfully
|
|
2996
|
+
*/
|
|
2997
|
+
201: Executor;
|
|
2998
|
+
};
|
|
2999
|
+
export type CreateExecutorResponse = CreateExecutorResponses[keyof CreateExecutorResponses];
|
|
3000
|
+
export type DeleteExecutorData = {
|
|
3001
|
+
body?: never;
|
|
3002
|
+
path: {
|
|
3003
|
+
/**
|
|
3004
|
+
* Unique identifier for the estate (UUID v4)
|
|
3005
|
+
*/
|
|
3006
|
+
estateId: string;
|
|
3007
|
+
/**
|
|
3008
|
+
* Unique identifier for the executor (UUID v4)
|
|
3009
|
+
*/
|
|
3010
|
+
executorId: string;
|
|
3011
|
+
};
|
|
3012
|
+
query?: never;
|
|
3013
|
+
url: '/estates/{estateId}/executors/{executorId}';
|
|
3014
|
+
};
|
|
3015
|
+
export type DeleteExecutorErrors = {
|
|
3016
|
+
/**
|
|
3017
|
+
* The requested resource was not found
|
|
3018
|
+
*/
|
|
3019
|
+
404: Error;
|
|
3020
|
+
};
|
|
3021
|
+
export type DeleteExecutorError = DeleteExecutorErrors[keyof DeleteExecutorErrors];
|
|
3022
|
+
export type DeleteExecutorResponses = {
|
|
3023
|
+
/**
|
|
3024
|
+
* Executor deleted successfully
|
|
3025
|
+
*/
|
|
3026
|
+
204: void;
|
|
3027
|
+
};
|
|
3028
|
+
export type DeleteExecutorResponse = DeleteExecutorResponses[keyof DeleteExecutorResponses];
|
|
3029
|
+
export type GetExecutorData = {
|
|
3030
|
+
body?: never;
|
|
3031
|
+
path: {
|
|
3032
|
+
/**
|
|
3033
|
+
* Unique identifier for the estate (UUID v4)
|
|
3034
|
+
*/
|
|
3035
|
+
estateId: string;
|
|
3036
|
+
/**
|
|
3037
|
+
* Unique identifier for the executor (UUID v4)
|
|
3038
|
+
*/
|
|
3039
|
+
executorId: string;
|
|
3040
|
+
};
|
|
3041
|
+
query?: never;
|
|
3042
|
+
url: '/estates/{estateId}/executors/{executorId}';
|
|
3043
|
+
};
|
|
3044
|
+
export type GetExecutorErrors = {
|
|
3045
|
+
/**
|
|
3046
|
+
* The requested resource was not found
|
|
3047
|
+
*/
|
|
3048
|
+
404: Error;
|
|
3049
|
+
};
|
|
3050
|
+
export type GetExecutorError = GetExecutorErrors[keyof GetExecutorErrors];
|
|
3051
|
+
export type GetExecutorResponses = {
|
|
3052
|
+
/**
|
|
3053
|
+
* Executor retrieved successfully
|
|
3054
|
+
*/
|
|
3055
|
+
200: Executor;
|
|
3056
|
+
};
|
|
3057
|
+
export type GetExecutorResponse = GetExecutorResponses[keyof GetExecutorResponses];
|
|
3058
|
+
export type UpdateExecutorData = {
|
|
3059
|
+
body: Executor;
|
|
3060
|
+
headers?: {
|
|
3061
|
+
/**
|
|
3062
|
+
* ETag value for optimistic concurrency control
|
|
3063
|
+
*/
|
|
3064
|
+
'If-Match'?: string;
|
|
3065
|
+
};
|
|
3066
|
+
path: {
|
|
3067
|
+
/**
|
|
3068
|
+
* Unique identifier for the estate (UUID v4)
|
|
3069
|
+
*/
|
|
3070
|
+
estateId: string;
|
|
3071
|
+
/**
|
|
3072
|
+
* Unique identifier for the executor (UUID v4)
|
|
3073
|
+
*/
|
|
3074
|
+
executorId: string;
|
|
3075
|
+
};
|
|
3076
|
+
query?: never;
|
|
3077
|
+
url: '/estates/{estateId}/executors/{executorId}';
|
|
3078
|
+
};
|
|
3079
|
+
export type UpdateExecutorErrors = {
|
|
3080
|
+
/**
|
|
3081
|
+
* The request body failed schema validation
|
|
3082
|
+
*/
|
|
3083
|
+
400: Error;
|
|
3084
|
+
/**
|
|
3085
|
+
* The requested resource was not found
|
|
3086
|
+
*/
|
|
3087
|
+
404: Error;
|
|
3088
|
+
};
|
|
3089
|
+
export type UpdateExecutorError = UpdateExecutorErrors[keyof UpdateExecutorErrors];
|
|
3090
|
+
export type UpdateExecutorResponses = {
|
|
3091
|
+
/**
|
|
3092
|
+
* Executor updated successfully
|
|
3093
|
+
*/
|
|
3094
|
+
200: Executor;
|
|
3095
|
+
};
|
|
3096
|
+
export type UpdateExecutorResponse = UpdateExecutorResponses[keyof UpdateExecutorResponses];
|
|
3097
|
+
export type ReplaceExecutorData = {
|
|
3098
|
+
body: Executor;
|
|
3099
|
+
headers?: {
|
|
3100
|
+
/**
|
|
3101
|
+
* ETag value for optimistic concurrency control
|
|
3102
|
+
*/
|
|
3103
|
+
'If-Match'?: string;
|
|
3104
|
+
};
|
|
3105
|
+
path: {
|
|
3106
|
+
/**
|
|
3107
|
+
* Unique identifier for the estate (UUID v4)
|
|
3108
|
+
*/
|
|
3109
|
+
estateId: string;
|
|
3110
|
+
/**
|
|
3111
|
+
* Unique identifier for the executor (UUID v4)
|
|
3112
|
+
*/
|
|
3113
|
+
executorId: string;
|
|
3114
|
+
};
|
|
3115
|
+
query?: never;
|
|
3116
|
+
url: '/estates/{estateId}/executors/{executorId}';
|
|
3117
|
+
};
|
|
3118
|
+
export type ReplaceExecutorErrors = {
|
|
3119
|
+
/**
|
|
3120
|
+
* The request body failed schema validation
|
|
3121
|
+
*/
|
|
3122
|
+
400: Error;
|
|
3123
|
+
/**
|
|
3124
|
+
* The requested resource was not found
|
|
3125
|
+
*/
|
|
3126
|
+
404: Error;
|
|
3127
|
+
};
|
|
3128
|
+
export type ReplaceExecutorError = ReplaceExecutorErrors[keyof ReplaceExecutorErrors];
|
|
3129
|
+
export type ReplaceExecutorResponses = {
|
|
3130
|
+
/**
|
|
3131
|
+
* Executor replaced successfully
|
|
3132
|
+
*/
|
|
3133
|
+
200: Executor;
|
|
3134
|
+
};
|
|
3135
|
+
export type ReplaceExecutorResponse = ReplaceExecutorResponses[keyof ReplaceExecutorResponses];
|
|
3136
|
+
export type ListGuardiansData = {
|
|
3137
|
+
body?: never;
|
|
3138
|
+
path: {
|
|
3139
|
+
/**
|
|
3140
|
+
* Unique identifier for the estate (UUID v4)
|
|
3141
|
+
*/
|
|
3142
|
+
estateId: string;
|
|
3143
|
+
};
|
|
3144
|
+
query?: never;
|
|
3145
|
+
url: '/estates/{estateId}/guardians';
|
|
3146
|
+
};
|
|
3147
|
+
export type ListGuardiansResponses = {
|
|
3148
|
+
/**
|
|
3149
|
+
* List of guardians
|
|
3150
|
+
*/
|
|
3151
|
+
200: {
|
|
3152
|
+
items: Array<Guardian>;
|
|
3153
|
+
};
|
|
3154
|
+
};
|
|
3155
|
+
export type ListGuardiansResponse = ListGuardiansResponses[keyof ListGuardiansResponses];
|
|
3156
|
+
export type CreateGuardianData = {
|
|
3157
|
+
body: Guardian;
|
|
3158
|
+
path: {
|
|
3159
|
+
/**
|
|
3160
|
+
* Unique identifier for the estate (UUID v4)
|
|
3161
|
+
*/
|
|
3162
|
+
estateId: string;
|
|
3163
|
+
};
|
|
3164
|
+
query?: never;
|
|
3165
|
+
url: '/estates/{estateId}/guardians';
|
|
3166
|
+
};
|
|
3167
|
+
export type CreateGuardianErrors = {
|
|
3168
|
+
/**
|
|
3169
|
+
* The request body failed schema validation
|
|
3170
|
+
*/
|
|
3171
|
+
400: Error;
|
|
3172
|
+
};
|
|
3173
|
+
export type CreateGuardianError = CreateGuardianErrors[keyof CreateGuardianErrors];
|
|
3174
|
+
export type CreateGuardianResponses = {
|
|
3175
|
+
/**
|
|
3176
|
+
* Guardian created successfully
|
|
3177
|
+
*/
|
|
3178
|
+
201: Guardian;
|
|
3179
|
+
};
|
|
3180
|
+
export type CreateGuardianResponse = CreateGuardianResponses[keyof CreateGuardianResponses];
|
|
3181
|
+
export type DeleteGuardianData = {
|
|
3182
|
+
body?: never;
|
|
3183
|
+
path: {
|
|
3184
|
+
/**
|
|
3185
|
+
* Unique identifier for the estate (UUID v4)
|
|
3186
|
+
*/
|
|
3187
|
+
estateId: string;
|
|
3188
|
+
/**
|
|
3189
|
+
* Unique identifier for the guardian (UUID v4)
|
|
3190
|
+
*/
|
|
3191
|
+
guardianId: string;
|
|
3192
|
+
};
|
|
3193
|
+
query?: never;
|
|
3194
|
+
url: '/estates/{estateId}/guardians/{guardianId}';
|
|
3195
|
+
};
|
|
3196
|
+
export type DeleteGuardianErrors = {
|
|
3197
|
+
/**
|
|
3198
|
+
* The requested resource was not found
|
|
3199
|
+
*/
|
|
3200
|
+
404: Error;
|
|
3201
|
+
};
|
|
3202
|
+
export type DeleteGuardianError = DeleteGuardianErrors[keyof DeleteGuardianErrors];
|
|
3203
|
+
export type DeleteGuardianResponses = {
|
|
3204
|
+
/**
|
|
3205
|
+
* Guardian deleted successfully
|
|
3206
|
+
*/
|
|
3207
|
+
204: void;
|
|
3208
|
+
};
|
|
3209
|
+
export type DeleteGuardianResponse = DeleteGuardianResponses[keyof DeleteGuardianResponses];
|
|
3210
|
+
export type GetGuardianData = {
|
|
3211
|
+
body?: never;
|
|
3212
|
+
path: {
|
|
3213
|
+
/**
|
|
3214
|
+
* Unique identifier for the estate (UUID v4)
|
|
3215
|
+
*/
|
|
3216
|
+
estateId: string;
|
|
3217
|
+
/**
|
|
3218
|
+
* Unique identifier for the guardian (UUID v4)
|
|
3219
|
+
*/
|
|
3220
|
+
guardianId: string;
|
|
3221
|
+
};
|
|
3222
|
+
query?: never;
|
|
3223
|
+
url: '/estates/{estateId}/guardians/{guardianId}';
|
|
3224
|
+
};
|
|
3225
|
+
export type GetGuardianErrors = {
|
|
3226
|
+
/**
|
|
3227
|
+
* The requested resource was not found
|
|
3228
|
+
*/
|
|
3229
|
+
404: Error;
|
|
3230
|
+
};
|
|
3231
|
+
export type GetGuardianError = GetGuardianErrors[keyof GetGuardianErrors];
|
|
3232
|
+
export type GetGuardianResponses = {
|
|
3233
|
+
/**
|
|
3234
|
+
* Guardian retrieved successfully
|
|
3235
|
+
*/
|
|
3236
|
+
200: Guardian;
|
|
3237
|
+
};
|
|
3238
|
+
export type GetGuardianResponse = GetGuardianResponses[keyof GetGuardianResponses];
|
|
3239
|
+
export type UpdateGuardianData = {
|
|
3240
|
+
body: Guardian;
|
|
3241
|
+
headers?: {
|
|
3242
|
+
/**
|
|
3243
|
+
* ETag value for optimistic concurrency control
|
|
3244
|
+
*/
|
|
3245
|
+
'If-Match'?: string;
|
|
3246
|
+
};
|
|
3247
|
+
path: {
|
|
3248
|
+
/**
|
|
3249
|
+
* Unique identifier for the estate (UUID v4)
|
|
3250
|
+
*/
|
|
3251
|
+
estateId: string;
|
|
3252
|
+
/**
|
|
3253
|
+
* Unique identifier for the guardian (UUID v4)
|
|
3254
|
+
*/
|
|
3255
|
+
guardianId: string;
|
|
3256
|
+
};
|
|
3257
|
+
query?: never;
|
|
3258
|
+
url: '/estates/{estateId}/guardians/{guardianId}';
|
|
3259
|
+
};
|
|
3260
|
+
export type UpdateGuardianErrors = {
|
|
3261
|
+
/**
|
|
3262
|
+
* The request body failed schema validation
|
|
3263
|
+
*/
|
|
3264
|
+
400: Error;
|
|
3265
|
+
/**
|
|
3266
|
+
* The requested resource was not found
|
|
3267
|
+
*/
|
|
3268
|
+
404: Error;
|
|
3269
|
+
};
|
|
3270
|
+
export type UpdateGuardianError = UpdateGuardianErrors[keyof UpdateGuardianErrors];
|
|
3271
|
+
export type UpdateGuardianResponses = {
|
|
3272
|
+
/**
|
|
3273
|
+
* Guardian updated successfully
|
|
3274
|
+
*/
|
|
3275
|
+
200: Guardian;
|
|
3276
|
+
};
|
|
3277
|
+
export type UpdateGuardianResponse = UpdateGuardianResponses[keyof UpdateGuardianResponses];
|
|
3278
|
+
export type ReplaceGuardianData = {
|
|
3279
|
+
body: Guardian;
|
|
3280
|
+
headers?: {
|
|
3281
|
+
/**
|
|
3282
|
+
* ETag value for optimistic concurrency control
|
|
3283
|
+
*/
|
|
3284
|
+
'If-Match'?: string;
|
|
3285
|
+
};
|
|
3286
|
+
path: {
|
|
3287
|
+
/**
|
|
3288
|
+
* Unique identifier for the estate (UUID v4)
|
|
3289
|
+
*/
|
|
3290
|
+
estateId: string;
|
|
3291
|
+
/**
|
|
3292
|
+
* Unique identifier for the guardian (UUID v4)
|
|
3293
|
+
*/
|
|
3294
|
+
guardianId: string;
|
|
3295
|
+
};
|
|
3296
|
+
query?: never;
|
|
3297
|
+
url: '/estates/{estateId}/guardians/{guardianId}';
|
|
3298
|
+
};
|
|
3299
|
+
export type ReplaceGuardianErrors = {
|
|
3300
|
+
/**
|
|
3301
|
+
* The request body failed schema validation
|
|
3302
|
+
*/
|
|
3303
|
+
400: Error;
|
|
3304
|
+
/**
|
|
3305
|
+
* The requested resource was not found
|
|
3306
|
+
*/
|
|
3307
|
+
404: Error;
|
|
3308
|
+
};
|
|
3309
|
+
export type ReplaceGuardianError = ReplaceGuardianErrors[keyof ReplaceGuardianErrors];
|
|
3310
|
+
export type ReplaceGuardianResponses = {
|
|
3311
|
+
/**
|
|
3312
|
+
* Guardian replaced successfully
|
|
3313
|
+
*/
|
|
3314
|
+
200: Guardian;
|
|
3315
|
+
};
|
|
3316
|
+
export type ReplaceGuardianResponse = ReplaceGuardianResponses[keyof ReplaceGuardianResponses];
|
|
3317
|
+
export type ListWishesData = {
|
|
3318
|
+
body?: never;
|
|
3319
|
+
path: {
|
|
3320
|
+
/**
|
|
3321
|
+
* Unique identifier for the estate (UUID v4)
|
|
3322
|
+
*/
|
|
3323
|
+
estateId: string;
|
|
3324
|
+
};
|
|
3325
|
+
query?: never;
|
|
3326
|
+
url: '/estates/{estateId}/wishes';
|
|
3327
|
+
};
|
|
3328
|
+
export type ListWishesResponses = {
|
|
3329
|
+
/**
|
|
3330
|
+
* List of wishes
|
|
3331
|
+
*/
|
|
3332
|
+
200: {
|
|
3333
|
+
items: Array<Wish>;
|
|
3334
|
+
};
|
|
3335
|
+
};
|
|
3336
|
+
export type ListWishesResponse = ListWishesResponses[keyof ListWishesResponses];
|
|
3337
|
+
export type CreateWishData = {
|
|
3338
|
+
body: Wish;
|
|
3339
|
+
path: {
|
|
3340
|
+
/**
|
|
3341
|
+
* Unique identifier for the estate (UUID v4)
|
|
3342
|
+
*/
|
|
3343
|
+
estateId: string;
|
|
3344
|
+
};
|
|
3345
|
+
query?: never;
|
|
3346
|
+
url: '/estates/{estateId}/wishes';
|
|
3347
|
+
};
|
|
3348
|
+
export type CreateWishErrors = {
|
|
3349
|
+
/**
|
|
3350
|
+
* The request body failed schema validation
|
|
3351
|
+
*/
|
|
3352
|
+
400: Error;
|
|
3353
|
+
};
|
|
3354
|
+
export type CreateWishError = CreateWishErrors[keyof CreateWishErrors];
|
|
3355
|
+
export type CreateWishResponses = {
|
|
3356
|
+
/**
|
|
3357
|
+
* Wish created successfully
|
|
3358
|
+
*/
|
|
3359
|
+
201: Wish;
|
|
3360
|
+
};
|
|
3361
|
+
export type CreateWishResponse = CreateWishResponses[keyof CreateWishResponses];
|
|
3362
|
+
export type DeleteWishData = {
|
|
3363
|
+
body?: never;
|
|
3364
|
+
path: {
|
|
3365
|
+
/**
|
|
3366
|
+
* Unique identifier for the estate (UUID v4)
|
|
3367
|
+
*/
|
|
3368
|
+
estateId: string;
|
|
3369
|
+
/**
|
|
3370
|
+
* Unique identifier for the wish (UUID v4)
|
|
3371
|
+
*/
|
|
3372
|
+
wishId: string;
|
|
3373
|
+
};
|
|
3374
|
+
query?: never;
|
|
3375
|
+
url: '/estates/{estateId}/wishes/{wishId}';
|
|
3376
|
+
};
|
|
3377
|
+
export type DeleteWishErrors = {
|
|
3378
|
+
/**
|
|
3379
|
+
* The requested resource was not found
|
|
3380
|
+
*/
|
|
3381
|
+
404: Error;
|
|
3382
|
+
};
|
|
3383
|
+
export type DeleteWishError = DeleteWishErrors[keyof DeleteWishErrors];
|
|
3384
|
+
export type DeleteWishResponses = {
|
|
3385
|
+
/**
|
|
3386
|
+
* Wish deleted successfully
|
|
3387
|
+
*/
|
|
3388
|
+
204: void;
|
|
3389
|
+
};
|
|
3390
|
+
export type DeleteWishResponse = DeleteWishResponses[keyof DeleteWishResponses];
|
|
3391
|
+
export type GetWishData = {
|
|
3392
|
+
body?: never;
|
|
3393
|
+
path: {
|
|
3394
|
+
/**
|
|
3395
|
+
* Unique identifier for the estate (UUID v4)
|
|
3396
|
+
*/
|
|
3397
|
+
estateId: string;
|
|
3398
|
+
/**
|
|
3399
|
+
* Unique identifier for the wish (UUID v4)
|
|
3400
|
+
*/
|
|
3401
|
+
wishId: string;
|
|
3402
|
+
};
|
|
3403
|
+
query?: never;
|
|
3404
|
+
url: '/estates/{estateId}/wishes/{wishId}';
|
|
3405
|
+
};
|
|
3406
|
+
export type GetWishErrors = {
|
|
3407
|
+
/**
|
|
3408
|
+
* The requested resource was not found
|
|
3409
|
+
*/
|
|
3410
|
+
404: Error;
|
|
3411
|
+
};
|
|
3412
|
+
export type GetWishError = GetWishErrors[keyof GetWishErrors];
|
|
3413
|
+
export type GetWishResponses = {
|
|
3414
|
+
/**
|
|
3415
|
+
* Wish retrieved successfully
|
|
3416
|
+
*/
|
|
3417
|
+
200: Wish;
|
|
3418
|
+
};
|
|
3419
|
+
export type GetWishResponse = GetWishResponses[keyof GetWishResponses];
|
|
3420
|
+
export type UpdateWishData = {
|
|
3421
|
+
body: Wish;
|
|
3422
|
+
headers?: {
|
|
3423
|
+
/**
|
|
3424
|
+
* ETag value for optimistic concurrency control
|
|
3425
|
+
*/
|
|
3426
|
+
'If-Match'?: string;
|
|
3427
|
+
};
|
|
3428
|
+
path: {
|
|
3429
|
+
/**
|
|
3430
|
+
* Unique identifier for the estate (UUID v4)
|
|
3431
|
+
*/
|
|
3432
|
+
estateId: string;
|
|
3433
|
+
/**
|
|
3434
|
+
* Unique identifier for the wish (UUID v4)
|
|
3435
|
+
*/
|
|
3436
|
+
wishId: string;
|
|
3437
|
+
};
|
|
3438
|
+
query?: never;
|
|
3439
|
+
url: '/estates/{estateId}/wishes/{wishId}';
|
|
3440
|
+
};
|
|
3441
|
+
export type UpdateWishErrors = {
|
|
3442
|
+
/**
|
|
3443
|
+
* The request body failed schema validation
|
|
3444
|
+
*/
|
|
3445
|
+
400: Error;
|
|
3446
|
+
/**
|
|
3447
|
+
* The requested resource was not found
|
|
3448
|
+
*/
|
|
3449
|
+
404: Error;
|
|
3450
|
+
};
|
|
3451
|
+
export type UpdateWishError = UpdateWishErrors[keyof UpdateWishErrors];
|
|
3452
|
+
export type UpdateWishResponses = {
|
|
3453
|
+
/**
|
|
3454
|
+
* Wish updated successfully
|
|
3455
|
+
*/
|
|
3456
|
+
200: Wish;
|
|
3457
|
+
};
|
|
3458
|
+
export type UpdateWishResponse = UpdateWishResponses[keyof UpdateWishResponses];
|
|
3459
|
+
export type ReplaceWishData = {
|
|
3460
|
+
body: Wish;
|
|
3461
|
+
headers?: {
|
|
3462
|
+
/**
|
|
3463
|
+
* ETag value for optimistic concurrency control
|
|
3464
|
+
*/
|
|
3465
|
+
'If-Match'?: string;
|
|
3466
|
+
};
|
|
3467
|
+
path: {
|
|
3468
|
+
/**
|
|
3469
|
+
* Unique identifier for the estate (UUID v4)
|
|
3470
|
+
*/
|
|
3471
|
+
estateId: string;
|
|
3472
|
+
/**
|
|
3473
|
+
* Unique identifier for the wish (UUID v4)
|
|
3474
|
+
*/
|
|
3475
|
+
wishId: string;
|
|
3476
|
+
};
|
|
3477
|
+
query?: never;
|
|
3478
|
+
url: '/estates/{estateId}/wishes/{wishId}';
|
|
3479
|
+
};
|
|
3480
|
+
export type ReplaceWishErrors = {
|
|
3481
|
+
/**
|
|
3482
|
+
* The request body failed schema validation
|
|
3483
|
+
*/
|
|
3484
|
+
400: Error;
|
|
3485
|
+
/**
|
|
3486
|
+
* The requested resource was not found
|
|
3487
|
+
*/
|
|
3488
|
+
404: Error;
|
|
3489
|
+
};
|
|
3490
|
+
export type ReplaceWishError = ReplaceWishErrors[keyof ReplaceWishErrors];
|
|
3491
|
+
export type ReplaceWishResponses = {
|
|
3492
|
+
/**
|
|
3493
|
+
* Wish replaced successfully
|
|
3494
|
+
*/
|
|
3495
|
+
200: Wish;
|
|
3496
|
+
};
|
|
3497
|
+
export type ReplaceWishResponse = ReplaceWishResponses[keyof ReplaceWishResponses];
|
|
3498
|
+
export type ListDocumentsData = {
|
|
3499
|
+
body?: never;
|
|
3500
|
+
path: {
|
|
3501
|
+
/**
|
|
3502
|
+
* Unique identifier for the estate (UUID v4)
|
|
3503
|
+
*/
|
|
3504
|
+
estateId: string;
|
|
3505
|
+
};
|
|
3506
|
+
query?: never;
|
|
3507
|
+
url: '/estates/{estateId}/documents';
|
|
3508
|
+
};
|
|
3509
|
+
export type ListDocumentsResponses = {
|
|
3510
|
+
/**
|
|
3511
|
+
* List of documents
|
|
3512
|
+
*/
|
|
3513
|
+
200: {
|
|
3514
|
+
items: Array<Document>;
|
|
3515
|
+
};
|
|
3516
|
+
};
|
|
3517
|
+
export type ListDocumentsResponse = ListDocumentsResponses[keyof ListDocumentsResponses];
|
|
3518
|
+
export type CreateDocumentData = {
|
|
3519
|
+
body: Document;
|
|
3520
|
+
path: {
|
|
3521
|
+
/**
|
|
3522
|
+
* Unique identifier for the estate (UUID v4)
|
|
3523
|
+
*/
|
|
3524
|
+
estateId: string;
|
|
3525
|
+
};
|
|
3526
|
+
query?: never;
|
|
3527
|
+
url: '/estates/{estateId}/documents';
|
|
3528
|
+
};
|
|
3529
|
+
export type CreateDocumentErrors = {
|
|
3530
|
+
/**
|
|
3531
|
+
* The request body failed schema validation
|
|
3532
|
+
*/
|
|
3533
|
+
400: Error;
|
|
3534
|
+
};
|
|
3535
|
+
export type CreateDocumentError = CreateDocumentErrors[keyof CreateDocumentErrors];
|
|
3536
|
+
export type CreateDocumentResponses = {
|
|
3537
|
+
/**
|
|
3538
|
+
* Document created successfully
|
|
3539
|
+
*/
|
|
3540
|
+
201: Document;
|
|
3541
|
+
};
|
|
3542
|
+
export type CreateDocumentResponse = CreateDocumentResponses[keyof CreateDocumentResponses];
|
|
3543
|
+
export type DeleteDocumentData = {
|
|
3544
|
+
body?: never;
|
|
3545
|
+
path: {
|
|
3546
|
+
/**
|
|
3547
|
+
* Unique identifier for the estate (UUID v4)
|
|
3548
|
+
*/
|
|
3549
|
+
estateId: string;
|
|
3550
|
+
/**
|
|
3551
|
+
* Unique identifier for the document (UUID v4)
|
|
3552
|
+
*/
|
|
3553
|
+
documentId: string;
|
|
3554
|
+
};
|
|
3555
|
+
query?: never;
|
|
3556
|
+
url: '/estates/{estateId}/documents/{documentId}';
|
|
3557
|
+
};
|
|
3558
|
+
export type DeleteDocumentErrors = {
|
|
3559
|
+
/**
|
|
3560
|
+
* The requested resource was not found
|
|
3561
|
+
*/
|
|
3562
|
+
404: Error;
|
|
3563
|
+
};
|
|
3564
|
+
export type DeleteDocumentError = DeleteDocumentErrors[keyof DeleteDocumentErrors];
|
|
3565
|
+
export type DeleteDocumentResponses = {
|
|
3566
|
+
/**
|
|
3567
|
+
* Document deleted successfully
|
|
3568
|
+
*/
|
|
3569
|
+
204: void;
|
|
3570
|
+
};
|
|
3571
|
+
export type DeleteDocumentResponse = DeleteDocumentResponses[keyof DeleteDocumentResponses];
|
|
3572
|
+
export type GetDocumentData = {
|
|
3573
|
+
body?: never;
|
|
3574
|
+
path: {
|
|
3575
|
+
/**
|
|
3576
|
+
* Unique identifier for the estate (UUID v4)
|
|
3577
|
+
*/
|
|
3578
|
+
estateId: string;
|
|
3579
|
+
/**
|
|
3580
|
+
* Unique identifier for the document (UUID v4)
|
|
3581
|
+
*/
|
|
3582
|
+
documentId: string;
|
|
3583
|
+
};
|
|
3584
|
+
query?: never;
|
|
3585
|
+
url: '/estates/{estateId}/documents/{documentId}';
|
|
3586
|
+
};
|
|
3587
|
+
export type GetDocumentErrors = {
|
|
3588
|
+
/**
|
|
3589
|
+
* The requested resource was not found
|
|
3590
|
+
*/
|
|
3591
|
+
404: Error;
|
|
3592
|
+
};
|
|
3593
|
+
export type GetDocumentError = GetDocumentErrors[keyof GetDocumentErrors];
|
|
3594
|
+
export type GetDocumentResponses = {
|
|
3595
|
+
/**
|
|
3596
|
+
* Document retrieved successfully
|
|
3597
|
+
*/
|
|
3598
|
+
200: Document;
|
|
3599
|
+
};
|
|
3600
|
+
export type GetDocumentResponse = GetDocumentResponses[keyof GetDocumentResponses];
|
|
3601
|
+
export type UpdateDocumentData = {
|
|
3602
|
+
body: Document;
|
|
3603
|
+
headers?: {
|
|
3604
|
+
/**
|
|
3605
|
+
* ETag value for optimistic concurrency control
|
|
3606
|
+
*/
|
|
3607
|
+
'If-Match'?: string;
|
|
3608
|
+
};
|
|
3609
|
+
path: {
|
|
3610
|
+
/**
|
|
3611
|
+
* Unique identifier for the estate (UUID v4)
|
|
3612
|
+
*/
|
|
3613
|
+
estateId: string;
|
|
3614
|
+
/**
|
|
3615
|
+
* Unique identifier for the document (UUID v4)
|
|
3616
|
+
*/
|
|
3617
|
+
documentId: string;
|
|
3618
|
+
};
|
|
3619
|
+
query?: never;
|
|
3620
|
+
url: '/estates/{estateId}/documents/{documentId}';
|
|
3621
|
+
};
|
|
3622
|
+
export type UpdateDocumentErrors = {
|
|
3623
|
+
/**
|
|
3624
|
+
* The request body failed schema validation
|
|
3625
|
+
*/
|
|
3626
|
+
400: Error;
|
|
3627
|
+
/**
|
|
3628
|
+
* The requested resource was not found
|
|
3629
|
+
*/
|
|
3630
|
+
404: Error;
|
|
3631
|
+
};
|
|
3632
|
+
export type UpdateDocumentError = UpdateDocumentErrors[keyof UpdateDocumentErrors];
|
|
3633
|
+
export type UpdateDocumentResponses = {
|
|
3634
|
+
/**
|
|
3635
|
+
* Document updated successfully
|
|
3636
|
+
*/
|
|
3637
|
+
200: Document;
|
|
3638
|
+
};
|
|
3639
|
+
export type UpdateDocumentResponse = UpdateDocumentResponses[keyof UpdateDocumentResponses];
|
|
3640
|
+
export type ReplaceDocumentData = {
|
|
3641
|
+
body: Document;
|
|
3642
|
+
headers?: {
|
|
3643
|
+
/**
|
|
3644
|
+
* ETag value for optimistic concurrency control
|
|
3645
|
+
*/
|
|
3646
|
+
'If-Match'?: string;
|
|
3647
|
+
};
|
|
3648
|
+
path: {
|
|
3649
|
+
/**
|
|
3650
|
+
* Unique identifier for the estate (UUID v4)
|
|
3651
|
+
*/
|
|
3652
|
+
estateId: string;
|
|
3653
|
+
/**
|
|
3654
|
+
* Unique identifier for the document (UUID v4)
|
|
3655
|
+
*/
|
|
3656
|
+
documentId: string;
|
|
3657
|
+
};
|
|
3658
|
+
query?: never;
|
|
3659
|
+
url: '/estates/{estateId}/documents/{documentId}';
|
|
3660
|
+
};
|
|
3661
|
+
export type ReplaceDocumentErrors = {
|
|
3662
|
+
/**
|
|
3663
|
+
* The request body failed schema validation
|
|
3664
|
+
*/
|
|
3665
|
+
400: Error;
|
|
3666
|
+
/**
|
|
3667
|
+
* The requested resource was not found
|
|
3668
|
+
*/
|
|
3669
|
+
404: Error;
|
|
3670
|
+
};
|
|
3671
|
+
export type ReplaceDocumentError = ReplaceDocumentErrors[keyof ReplaceDocumentErrors];
|
|
3672
|
+
export type ReplaceDocumentResponses = {
|
|
3673
|
+
/**
|
|
3674
|
+
* Document replaced successfully
|
|
3675
|
+
*/
|
|
3676
|
+
200: Document;
|
|
3677
|
+
};
|
|
3678
|
+
export type ReplaceDocumentResponse = ReplaceDocumentResponses[keyof ReplaceDocumentResponses];
|
|
3679
|
+
export type ListAttestationsData = {
|
|
3680
|
+
body?: never;
|
|
3681
|
+
path: {
|
|
3682
|
+
/**
|
|
3683
|
+
* Unique identifier for the estate (UUID v4)
|
|
3684
|
+
*/
|
|
3685
|
+
estateId: string;
|
|
3686
|
+
};
|
|
3687
|
+
query?: never;
|
|
3688
|
+
url: '/estates/{estateId}/attestations';
|
|
3689
|
+
};
|
|
3690
|
+
export type ListAttestationsResponses = {
|
|
3691
|
+
/**
|
|
3692
|
+
* List of attestations
|
|
3693
|
+
*/
|
|
3694
|
+
200: {
|
|
3695
|
+
items: Array<Attestation>;
|
|
3696
|
+
};
|
|
3697
|
+
};
|
|
3698
|
+
export type ListAttestationsResponse = ListAttestationsResponses[keyof ListAttestationsResponses];
|
|
3699
|
+
export type CreateAttestationData = {
|
|
3700
|
+
body: Attestation;
|
|
3701
|
+
path: {
|
|
3702
|
+
/**
|
|
3703
|
+
* Unique identifier for the estate (UUID v4)
|
|
3704
|
+
*/
|
|
3705
|
+
estateId: string;
|
|
3706
|
+
};
|
|
3707
|
+
query?: never;
|
|
3708
|
+
url: '/estates/{estateId}/attestations';
|
|
3709
|
+
};
|
|
3710
|
+
export type CreateAttestationErrors = {
|
|
3711
|
+
/**
|
|
3712
|
+
* The request body failed schema validation
|
|
3713
|
+
*/
|
|
3714
|
+
400: Error;
|
|
3715
|
+
};
|
|
3716
|
+
export type CreateAttestationError = CreateAttestationErrors[keyof CreateAttestationErrors];
|
|
3717
|
+
export type CreateAttestationResponses = {
|
|
3718
|
+
/**
|
|
3719
|
+
* Attestation created successfully
|
|
3720
|
+
*/
|
|
3721
|
+
201: Attestation;
|
|
3722
|
+
};
|
|
3723
|
+
export type CreateAttestationResponse = CreateAttestationResponses[keyof CreateAttestationResponses];
|
|
3724
|
+
export type DeleteAttestationData = {
|
|
3725
|
+
body?: never;
|
|
3726
|
+
path: {
|
|
3727
|
+
/**
|
|
3728
|
+
* Unique identifier for the estate (UUID v4)
|
|
3729
|
+
*/
|
|
3730
|
+
estateId: string;
|
|
3731
|
+
/**
|
|
3732
|
+
* Unique identifier for the attestation (UUID v4)
|
|
3733
|
+
*/
|
|
3734
|
+
attestationId: string;
|
|
3735
|
+
};
|
|
3736
|
+
query?: never;
|
|
3737
|
+
url: '/estates/{estateId}/attestations/{attestationId}';
|
|
3738
|
+
};
|
|
3739
|
+
export type DeleteAttestationErrors = {
|
|
3740
|
+
/**
|
|
3741
|
+
* The requested resource was not found
|
|
3742
|
+
*/
|
|
3743
|
+
404: Error;
|
|
3744
|
+
};
|
|
3745
|
+
export type DeleteAttestationError = DeleteAttestationErrors[keyof DeleteAttestationErrors];
|
|
3746
|
+
export type DeleteAttestationResponses = {
|
|
3747
|
+
/**
|
|
3748
|
+
* Attestation deleted successfully
|
|
3749
|
+
*/
|
|
3750
|
+
204: void;
|
|
3751
|
+
};
|
|
3752
|
+
export type DeleteAttestationResponse = DeleteAttestationResponses[keyof DeleteAttestationResponses];
|
|
3753
|
+
export type GetAttestationData = {
|
|
3754
|
+
body?: never;
|
|
3755
|
+
path: {
|
|
3756
|
+
/**
|
|
3757
|
+
* Unique identifier for the estate (UUID v4)
|
|
3758
|
+
*/
|
|
3759
|
+
estateId: string;
|
|
3760
|
+
/**
|
|
3761
|
+
* Unique identifier for the attestation (UUID v4)
|
|
3762
|
+
*/
|
|
3763
|
+
attestationId: string;
|
|
3764
|
+
};
|
|
3765
|
+
query?: never;
|
|
3766
|
+
url: '/estates/{estateId}/attestations/{attestationId}';
|
|
3767
|
+
};
|
|
3768
|
+
export type GetAttestationErrors = {
|
|
3769
|
+
/**
|
|
3770
|
+
* The requested resource was not found
|
|
3771
|
+
*/
|
|
3772
|
+
404: Error;
|
|
3773
|
+
};
|
|
3774
|
+
export type GetAttestationError = GetAttestationErrors[keyof GetAttestationErrors];
|
|
3775
|
+
export type GetAttestationResponses = {
|
|
3776
|
+
/**
|
|
3777
|
+
* Attestation retrieved successfully
|
|
3778
|
+
*/
|
|
3779
|
+
200: Attestation;
|
|
3780
|
+
};
|
|
3781
|
+
export type GetAttestationResponse = GetAttestationResponses[keyof GetAttestationResponses];
|
|
3782
|
+
export type UpdateAttestationData = {
|
|
3783
|
+
body: Attestation;
|
|
3784
|
+
headers?: {
|
|
3785
|
+
/**
|
|
3786
|
+
* ETag value for optimistic concurrency control
|
|
3787
|
+
*/
|
|
3788
|
+
'If-Match'?: string;
|
|
3789
|
+
};
|
|
3790
|
+
path: {
|
|
3791
|
+
/**
|
|
3792
|
+
* Unique identifier for the estate (UUID v4)
|
|
3793
|
+
*/
|
|
3794
|
+
estateId: string;
|
|
3795
|
+
/**
|
|
3796
|
+
* Unique identifier for the attestation (UUID v4)
|
|
3797
|
+
*/
|
|
3798
|
+
attestationId: string;
|
|
3799
|
+
};
|
|
3800
|
+
query?: never;
|
|
3801
|
+
url: '/estates/{estateId}/attestations/{attestationId}';
|
|
3802
|
+
};
|
|
3803
|
+
export type UpdateAttestationErrors = {
|
|
3804
|
+
/**
|
|
3805
|
+
* The request body failed schema validation
|
|
3806
|
+
*/
|
|
3807
|
+
400: Error;
|
|
3808
|
+
/**
|
|
3809
|
+
* The requested resource was not found
|
|
3810
|
+
*/
|
|
3811
|
+
404: Error;
|
|
3812
|
+
};
|
|
3813
|
+
export type UpdateAttestationError = UpdateAttestationErrors[keyof UpdateAttestationErrors];
|
|
3814
|
+
export type UpdateAttestationResponses = {
|
|
3815
|
+
/**
|
|
3816
|
+
* Attestation updated successfully
|
|
3817
|
+
*/
|
|
3818
|
+
200: Attestation;
|
|
3819
|
+
};
|
|
3820
|
+
export type UpdateAttestationResponse = UpdateAttestationResponses[keyof UpdateAttestationResponses];
|
|
3821
|
+
export type ReplaceAttestationData = {
|
|
3822
|
+
body: Attestation;
|
|
3823
|
+
headers?: {
|
|
3824
|
+
/**
|
|
3825
|
+
* ETag value for optimistic concurrency control
|
|
3826
|
+
*/
|
|
3827
|
+
'If-Match'?: string;
|
|
3828
|
+
};
|
|
3829
|
+
path: {
|
|
3830
|
+
/**
|
|
3831
|
+
* Unique identifier for the estate (UUID v4)
|
|
3832
|
+
*/
|
|
3833
|
+
estateId: string;
|
|
3834
|
+
/**
|
|
3835
|
+
* Unique identifier for the attestation (UUID v4)
|
|
3836
|
+
*/
|
|
3837
|
+
attestationId: string;
|
|
3838
|
+
};
|
|
3839
|
+
query?: never;
|
|
3840
|
+
url: '/estates/{estateId}/attestations/{attestationId}';
|
|
3841
|
+
};
|
|
3842
|
+
export type ReplaceAttestationErrors = {
|
|
3843
|
+
/**
|
|
3844
|
+
* The request body failed schema validation
|
|
3845
|
+
*/
|
|
3846
|
+
400: Error;
|
|
3847
|
+
/**
|
|
3848
|
+
* The requested resource was not found
|
|
3849
|
+
*/
|
|
3850
|
+
404: Error;
|
|
3851
|
+
};
|
|
3852
|
+
export type ReplaceAttestationError = ReplaceAttestationErrors[keyof ReplaceAttestationErrors];
|
|
3853
|
+
export type ReplaceAttestationResponses = {
|
|
3854
|
+
/**
|
|
3855
|
+
* Attestation replaced successfully
|
|
3856
|
+
*/
|
|
3857
|
+
200: Attestation;
|
|
3858
|
+
};
|
|
3859
|
+
export type ReplaceAttestationResponse = ReplaceAttestationResponses[keyof ReplaceAttestationResponses];
|
|
3860
|
+
export type ListNonprobateTransfersData = {
|
|
3861
|
+
body?: never;
|
|
3862
|
+
path: {
|
|
3863
|
+
/**
|
|
3864
|
+
* Unique identifier for the estate (UUID v4)
|
|
3865
|
+
*/
|
|
3866
|
+
estateId: string;
|
|
3867
|
+
};
|
|
3868
|
+
query?: never;
|
|
3869
|
+
url: '/estates/{estateId}/nonprobate-transfers';
|
|
3870
|
+
};
|
|
3871
|
+
export type ListNonprobateTransfersResponses = {
|
|
3872
|
+
/**
|
|
3873
|
+
* List of nonprobate transfers
|
|
3874
|
+
*/
|
|
3875
|
+
200: {
|
|
3876
|
+
items: Array<NonprobateTransfer>;
|
|
3877
|
+
};
|
|
3878
|
+
};
|
|
3879
|
+
export type ListNonprobateTransfersResponse = ListNonprobateTransfersResponses[keyof ListNonprobateTransfersResponses];
|
|
3880
|
+
export type CreateNonprobateTransferData = {
|
|
3881
|
+
body: NonprobateTransfer;
|
|
3882
|
+
path: {
|
|
3883
|
+
/**
|
|
3884
|
+
* Unique identifier for the estate (UUID v4)
|
|
3885
|
+
*/
|
|
3886
|
+
estateId: string;
|
|
3887
|
+
};
|
|
3888
|
+
query?: never;
|
|
3889
|
+
url: '/estates/{estateId}/nonprobate-transfers';
|
|
3890
|
+
};
|
|
3891
|
+
export type CreateNonprobateTransferErrors = {
|
|
3892
|
+
/**
|
|
3893
|
+
* The request body failed schema validation
|
|
3894
|
+
*/
|
|
3895
|
+
400: Error;
|
|
3896
|
+
};
|
|
3897
|
+
export type CreateNonprobateTransferError = CreateNonprobateTransferErrors[keyof CreateNonprobateTransferErrors];
|
|
3898
|
+
export type CreateNonprobateTransferResponses = {
|
|
3899
|
+
/**
|
|
3900
|
+
* NonprobateTransfer created successfully
|
|
3901
|
+
*/
|
|
3902
|
+
201: NonprobateTransfer;
|
|
3903
|
+
};
|
|
3904
|
+
export type CreateNonprobateTransferResponse = CreateNonprobateTransferResponses[keyof CreateNonprobateTransferResponses];
|
|
3905
|
+
export type DeleteNonprobateTransferData = {
|
|
3906
|
+
body?: never;
|
|
3907
|
+
path: {
|
|
3908
|
+
/**
|
|
3909
|
+
* Unique identifier for the estate (UUID v4)
|
|
3910
|
+
*/
|
|
3911
|
+
estateId: string;
|
|
3912
|
+
/**
|
|
3913
|
+
* Unique identifier for the nonprobate transfer (UUID v4)
|
|
3914
|
+
*/
|
|
3915
|
+
transferId: string;
|
|
3916
|
+
};
|
|
3917
|
+
query?: never;
|
|
3918
|
+
url: '/estates/{estateId}/nonprobate-transfers/{transferId}';
|
|
3919
|
+
};
|
|
3920
|
+
export type DeleteNonprobateTransferErrors = {
|
|
3921
|
+
/**
|
|
3922
|
+
* The requested resource was not found
|
|
3923
|
+
*/
|
|
3924
|
+
404: Error;
|
|
3925
|
+
};
|
|
3926
|
+
export type DeleteNonprobateTransferError = DeleteNonprobateTransferErrors[keyof DeleteNonprobateTransferErrors];
|
|
3927
|
+
export type DeleteNonprobateTransferResponses = {
|
|
3928
|
+
/**
|
|
3929
|
+
* NonprobateTransfer deleted successfully
|
|
3930
|
+
*/
|
|
3931
|
+
204: void;
|
|
3932
|
+
};
|
|
3933
|
+
export type DeleteNonprobateTransferResponse = DeleteNonprobateTransferResponses[keyof DeleteNonprobateTransferResponses];
|
|
3934
|
+
export type GetNonprobateTransferData = {
|
|
3935
|
+
body?: never;
|
|
3936
|
+
path: {
|
|
3937
|
+
/**
|
|
3938
|
+
* Unique identifier for the estate (UUID v4)
|
|
3939
|
+
*/
|
|
3940
|
+
estateId: string;
|
|
3941
|
+
/**
|
|
3942
|
+
* Unique identifier for the nonprobate transfer (UUID v4)
|
|
3943
|
+
*/
|
|
3944
|
+
transferId: string;
|
|
3945
|
+
};
|
|
3946
|
+
query?: never;
|
|
3947
|
+
url: '/estates/{estateId}/nonprobate-transfers/{transferId}';
|
|
3948
|
+
};
|
|
3949
|
+
export type GetNonprobateTransferErrors = {
|
|
3950
|
+
/**
|
|
3951
|
+
* The requested resource was not found
|
|
3952
|
+
*/
|
|
3953
|
+
404: Error;
|
|
3954
|
+
};
|
|
3955
|
+
export type GetNonprobateTransferError = GetNonprobateTransferErrors[keyof GetNonprobateTransferErrors];
|
|
3956
|
+
export type GetNonprobateTransferResponses = {
|
|
3957
|
+
/**
|
|
3958
|
+
* NonprobateTransfer retrieved successfully
|
|
3959
|
+
*/
|
|
3960
|
+
200: NonprobateTransfer;
|
|
3961
|
+
};
|
|
3962
|
+
export type GetNonprobateTransferResponse = GetNonprobateTransferResponses[keyof GetNonprobateTransferResponses];
|
|
3963
|
+
export type UpdateNonprobateTransferData = {
|
|
3964
|
+
body: NonprobateTransfer;
|
|
3965
|
+
headers?: {
|
|
3966
|
+
/**
|
|
3967
|
+
* ETag value for optimistic concurrency control
|
|
3968
|
+
*/
|
|
3969
|
+
'If-Match'?: string;
|
|
3970
|
+
};
|
|
3971
|
+
path: {
|
|
3972
|
+
/**
|
|
3973
|
+
* Unique identifier for the estate (UUID v4)
|
|
3974
|
+
*/
|
|
3975
|
+
estateId: string;
|
|
3976
|
+
/**
|
|
3977
|
+
* Unique identifier for the nonprobate transfer (UUID v4)
|
|
3978
|
+
*/
|
|
3979
|
+
transferId: string;
|
|
3980
|
+
};
|
|
3981
|
+
query?: never;
|
|
3982
|
+
url: '/estates/{estateId}/nonprobate-transfers/{transferId}';
|
|
3983
|
+
};
|
|
3984
|
+
export type UpdateNonprobateTransferErrors = {
|
|
3985
|
+
/**
|
|
3986
|
+
* The request body failed schema validation
|
|
3987
|
+
*/
|
|
3988
|
+
400: Error;
|
|
3989
|
+
/**
|
|
3990
|
+
* The requested resource was not found
|
|
3991
|
+
*/
|
|
3992
|
+
404: Error;
|
|
3993
|
+
};
|
|
3994
|
+
export type UpdateNonprobateTransferError = UpdateNonprobateTransferErrors[keyof UpdateNonprobateTransferErrors];
|
|
3995
|
+
export type UpdateNonprobateTransferResponses = {
|
|
3996
|
+
/**
|
|
3997
|
+
* NonprobateTransfer updated successfully
|
|
3998
|
+
*/
|
|
3999
|
+
200: NonprobateTransfer;
|
|
4000
|
+
};
|
|
4001
|
+
export type UpdateNonprobateTransferResponse = UpdateNonprobateTransferResponses[keyof UpdateNonprobateTransferResponses];
|
|
4002
|
+
export type ReplaceNonprobateTransferData = {
|
|
4003
|
+
body: NonprobateTransfer;
|
|
4004
|
+
headers?: {
|
|
4005
|
+
/**
|
|
4006
|
+
* ETag value for optimistic concurrency control
|
|
4007
|
+
*/
|
|
4008
|
+
'If-Match'?: string;
|
|
4009
|
+
};
|
|
4010
|
+
path: {
|
|
4011
|
+
/**
|
|
4012
|
+
* Unique identifier for the estate (UUID v4)
|
|
4013
|
+
*/
|
|
4014
|
+
estateId: string;
|
|
4015
|
+
/**
|
|
4016
|
+
* Unique identifier for the nonprobate transfer (UUID v4)
|
|
4017
|
+
*/
|
|
4018
|
+
transferId: string;
|
|
4019
|
+
};
|
|
4020
|
+
query?: never;
|
|
4021
|
+
url: '/estates/{estateId}/nonprobate-transfers/{transferId}';
|
|
4022
|
+
};
|
|
4023
|
+
export type ReplaceNonprobateTransferErrors = {
|
|
4024
|
+
/**
|
|
4025
|
+
* The request body failed schema validation
|
|
4026
|
+
*/
|
|
4027
|
+
400: Error;
|
|
4028
|
+
/**
|
|
4029
|
+
* The requested resource was not found
|
|
4030
|
+
*/
|
|
4031
|
+
404: Error;
|
|
4032
|
+
};
|
|
4033
|
+
export type ReplaceNonprobateTransferError = ReplaceNonprobateTransferErrors[keyof ReplaceNonprobateTransferErrors];
|
|
4034
|
+
export type ReplaceNonprobateTransferResponses = {
|
|
4035
|
+
/**
|
|
4036
|
+
* NonprobateTransfer replaced successfully
|
|
4037
|
+
*/
|
|
4038
|
+
200: NonprobateTransfer;
|
|
4039
|
+
};
|
|
4040
|
+
export type ReplaceNonprobateTransferResponse = ReplaceNonprobateTransferResponses[keyof ReplaceNonprobateTransferResponses];
|
|
4041
|
+
export type ListProxyAuthorisationsData = {
|
|
4042
|
+
body?: never;
|
|
4043
|
+
path: {
|
|
4044
|
+
/**
|
|
4045
|
+
* Unique identifier for the estate (UUID v4)
|
|
4046
|
+
*/
|
|
4047
|
+
estateId: string;
|
|
4048
|
+
};
|
|
4049
|
+
query?: never;
|
|
4050
|
+
url: '/estates/{estateId}/proxy-authorisations';
|
|
4051
|
+
};
|
|
4052
|
+
export type ListProxyAuthorisationsResponses = {
|
|
4053
|
+
/**
|
|
4054
|
+
* List of proxy authorisations
|
|
4055
|
+
*/
|
|
4056
|
+
200: {
|
|
4057
|
+
items: Array<ProxyAuthorisation>;
|
|
4058
|
+
};
|
|
4059
|
+
};
|
|
4060
|
+
export type ListProxyAuthorisationsResponse = ListProxyAuthorisationsResponses[keyof ListProxyAuthorisationsResponses];
|
|
4061
|
+
export type CreateProxyAuthorisationData = {
|
|
4062
|
+
body: ProxyAuthorisation;
|
|
4063
|
+
path: {
|
|
4064
|
+
/**
|
|
4065
|
+
* Unique identifier for the estate (UUID v4)
|
|
4066
|
+
*/
|
|
4067
|
+
estateId: string;
|
|
4068
|
+
};
|
|
4069
|
+
query?: never;
|
|
4070
|
+
url: '/estates/{estateId}/proxy-authorisations';
|
|
4071
|
+
};
|
|
4072
|
+
export type CreateProxyAuthorisationErrors = {
|
|
4073
|
+
/**
|
|
4074
|
+
* The request body failed schema validation
|
|
4075
|
+
*/
|
|
4076
|
+
400: Error;
|
|
4077
|
+
};
|
|
4078
|
+
export type CreateProxyAuthorisationError = CreateProxyAuthorisationErrors[keyof CreateProxyAuthorisationErrors];
|
|
4079
|
+
export type CreateProxyAuthorisationResponses = {
|
|
4080
|
+
/**
|
|
4081
|
+
* ProxyAuthorisation created successfully
|
|
4082
|
+
*/
|
|
4083
|
+
201: ProxyAuthorisation;
|
|
4084
|
+
};
|
|
4085
|
+
export type CreateProxyAuthorisationResponse = CreateProxyAuthorisationResponses[keyof CreateProxyAuthorisationResponses];
|
|
4086
|
+
export type DeleteProxyAuthorisationData = {
|
|
4087
|
+
body?: never;
|
|
4088
|
+
path: {
|
|
4089
|
+
/**
|
|
4090
|
+
* Unique identifier for the estate (UUID v4)
|
|
4091
|
+
*/
|
|
4092
|
+
estateId: string;
|
|
4093
|
+
/**
|
|
4094
|
+
* Unique identifier for the proxy authorisation (UUID v4)
|
|
4095
|
+
*/
|
|
4096
|
+
authorisationId: string;
|
|
4097
|
+
};
|
|
4098
|
+
query?: never;
|
|
4099
|
+
url: '/estates/{estateId}/proxy-authorisations/{authorisationId}';
|
|
4100
|
+
};
|
|
4101
|
+
export type DeleteProxyAuthorisationErrors = {
|
|
4102
|
+
/**
|
|
4103
|
+
* The requested resource was not found
|
|
4104
|
+
*/
|
|
4105
|
+
404: Error;
|
|
4106
|
+
};
|
|
4107
|
+
export type DeleteProxyAuthorisationError = DeleteProxyAuthorisationErrors[keyof DeleteProxyAuthorisationErrors];
|
|
4108
|
+
export type DeleteProxyAuthorisationResponses = {
|
|
4109
|
+
/**
|
|
4110
|
+
* ProxyAuthorisation deleted successfully
|
|
4111
|
+
*/
|
|
4112
|
+
204: void;
|
|
4113
|
+
};
|
|
4114
|
+
export type DeleteProxyAuthorisationResponse = DeleteProxyAuthorisationResponses[keyof DeleteProxyAuthorisationResponses];
|
|
4115
|
+
export type GetProxyAuthorisationData = {
|
|
4116
|
+
body?: never;
|
|
4117
|
+
path: {
|
|
4118
|
+
/**
|
|
4119
|
+
* Unique identifier for the estate (UUID v4)
|
|
4120
|
+
*/
|
|
4121
|
+
estateId: string;
|
|
4122
|
+
/**
|
|
4123
|
+
* Unique identifier for the proxy authorisation (UUID v4)
|
|
4124
|
+
*/
|
|
4125
|
+
authorisationId: string;
|
|
4126
|
+
};
|
|
4127
|
+
query?: never;
|
|
4128
|
+
url: '/estates/{estateId}/proxy-authorisations/{authorisationId}';
|
|
4129
|
+
};
|
|
4130
|
+
export type GetProxyAuthorisationErrors = {
|
|
4131
|
+
/**
|
|
4132
|
+
* The requested resource was not found
|
|
4133
|
+
*/
|
|
4134
|
+
404: Error;
|
|
4135
|
+
};
|
|
4136
|
+
export type GetProxyAuthorisationError = GetProxyAuthorisationErrors[keyof GetProxyAuthorisationErrors];
|
|
4137
|
+
export type GetProxyAuthorisationResponses = {
|
|
4138
|
+
/**
|
|
4139
|
+
* ProxyAuthorisation retrieved successfully
|
|
4140
|
+
*/
|
|
4141
|
+
200: ProxyAuthorisation;
|
|
4142
|
+
};
|
|
4143
|
+
export type GetProxyAuthorisationResponse = GetProxyAuthorisationResponses[keyof GetProxyAuthorisationResponses];
|
|
4144
|
+
export type UpdateProxyAuthorisationData = {
|
|
4145
|
+
body: ProxyAuthorisation;
|
|
4146
|
+
headers?: {
|
|
4147
|
+
/**
|
|
4148
|
+
* ETag value for optimistic concurrency control
|
|
4149
|
+
*/
|
|
4150
|
+
'If-Match'?: string;
|
|
4151
|
+
};
|
|
4152
|
+
path: {
|
|
4153
|
+
/**
|
|
4154
|
+
* Unique identifier for the estate (UUID v4)
|
|
4155
|
+
*/
|
|
4156
|
+
estateId: string;
|
|
4157
|
+
/**
|
|
4158
|
+
* Unique identifier for the proxy authorisation (UUID v4)
|
|
4159
|
+
*/
|
|
4160
|
+
authorisationId: string;
|
|
4161
|
+
};
|
|
4162
|
+
query?: never;
|
|
4163
|
+
url: '/estates/{estateId}/proxy-authorisations/{authorisationId}';
|
|
4164
|
+
};
|
|
4165
|
+
export type UpdateProxyAuthorisationErrors = {
|
|
4166
|
+
/**
|
|
4167
|
+
* The request body failed schema validation
|
|
4168
|
+
*/
|
|
4169
|
+
400: Error;
|
|
4170
|
+
/**
|
|
4171
|
+
* The requested resource was not found
|
|
4172
|
+
*/
|
|
4173
|
+
404: Error;
|
|
4174
|
+
};
|
|
4175
|
+
export type UpdateProxyAuthorisationError = UpdateProxyAuthorisationErrors[keyof UpdateProxyAuthorisationErrors];
|
|
4176
|
+
export type UpdateProxyAuthorisationResponses = {
|
|
4177
|
+
/**
|
|
4178
|
+
* ProxyAuthorisation updated successfully
|
|
4179
|
+
*/
|
|
4180
|
+
200: ProxyAuthorisation;
|
|
4181
|
+
};
|
|
4182
|
+
export type UpdateProxyAuthorisationResponse = UpdateProxyAuthorisationResponses[keyof UpdateProxyAuthorisationResponses];
|
|
4183
|
+
export type ReplaceProxyAuthorisationData = {
|
|
4184
|
+
body: ProxyAuthorisation;
|
|
4185
|
+
headers?: {
|
|
4186
|
+
/**
|
|
4187
|
+
* ETag value for optimistic concurrency control
|
|
4188
|
+
*/
|
|
4189
|
+
'If-Match'?: string;
|
|
4190
|
+
};
|
|
4191
|
+
path: {
|
|
4192
|
+
/**
|
|
4193
|
+
* Unique identifier for the estate (UUID v4)
|
|
4194
|
+
*/
|
|
4195
|
+
estateId: string;
|
|
4196
|
+
/**
|
|
4197
|
+
* Unique identifier for the proxy authorisation (UUID v4)
|
|
4198
|
+
*/
|
|
4199
|
+
authorisationId: string;
|
|
4200
|
+
};
|
|
4201
|
+
query?: never;
|
|
4202
|
+
url: '/estates/{estateId}/proxy-authorisations/{authorisationId}';
|
|
4203
|
+
};
|
|
4204
|
+
export type ReplaceProxyAuthorisationErrors = {
|
|
4205
|
+
/**
|
|
4206
|
+
* The request body failed schema validation
|
|
4207
|
+
*/
|
|
4208
|
+
400: Error;
|
|
4209
|
+
/**
|
|
4210
|
+
* The requested resource was not found
|
|
4211
|
+
*/
|
|
4212
|
+
404: Error;
|
|
4213
|
+
};
|
|
4214
|
+
export type ReplaceProxyAuthorisationError = ReplaceProxyAuthorisationErrors[keyof ReplaceProxyAuthorisationErrors];
|
|
4215
|
+
export type ReplaceProxyAuthorisationResponses = {
|
|
4216
|
+
/**
|
|
4217
|
+
* ProxyAuthorisation replaced successfully
|
|
4218
|
+
*/
|
|
4219
|
+
200: ProxyAuthorisation;
|
|
4220
|
+
};
|
|
4221
|
+
export type ReplaceProxyAuthorisationResponse = ReplaceProxyAuthorisationResponses[keyof ReplaceProxyAuthorisationResponses];
|
|
4222
|
+
export type ListDealerInterestsData = {
|
|
4223
|
+
body?: never;
|
|
4224
|
+
path: {
|
|
4225
|
+
/**
|
|
4226
|
+
* Unique identifier for the estate (UUID v4)
|
|
4227
|
+
*/
|
|
4228
|
+
estateId: string;
|
|
4229
|
+
};
|
|
4230
|
+
query?: never;
|
|
4231
|
+
url: '/estates/{estateId}/dealer-interests';
|
|
4232
|
+
};
|
|
4233
|
+
export type ListDealerInterestsResponses = {
|
|
4234
|
+
/**
|
|
4235
|
+
* List of dealer interests
|
|
4236
|
+
*/
|
|
4237
|
+
200: {
|
|
4238
|
+
items: Array<DealerInterest>;
|
|
4239
|
+
};
|
|
4240
|
+
};
|
|
4241
|
+
export type ListDealerInterestsResponse = ListDealerInterestsResponses[keyof ListDealerInterestsResponses];
|
|
4242
|
+
export type CreateDealerInterestData = {
|
|
4243
|
+
body: DealerInterest;
|
|
4244
|
+
path: {
|
|
4245
|
+
/**
|
|
4246
|
+
* Unique identifier for the estate (UUID v4)
|
|
4247
|
+
*/
|
|
4248
|
+
estateId: string;
|
|
4249
|
+
};
|
|
4250
|
+
query?: never;
|
|
4251
|
+
url: '/estates/{estateId}/dealer-interests';
|
|
4252
|
+
};
|
|
4253
|
+
export type CreateDealerInterestErrors = {
|
|
4254
|
+
/**
|
|
4255
|
+
* The request body failed schema validation
|
|
4256
|
+
*/
|
|
4257
|
+
400: Error;
|
|
4258
|
+
};
|
|
4259
|
+
export type CreateDealerInterestError = CreateDealerInterestErrors[keyof CreateDealerInterestErrors];
|
|
4260
|
+
export type CreateDealerInterestResponses = {
|
|
4261
|
+
/**
|
|
4262
|
+
* DealerInterest created successfully
|
|
4263
|
+
*/
|
|
4264
|
+
201: DealerInterest;
|
|
4265
|
+
};
|
|
4266
|
+
export type CreateDealerInterestResponse = CreateDealerInterestResponses[keyof CreateDealerInterestResponses];
|
|
4267
|
+
export type DeleteDealerInterestData = {
|
|
4268
|
+
body?: never;
|
|
4269
|
+
path: {
|
|
4270
|
+
/**
|
|
4271
|
+
* Unique identifier for the estate (UUID v4)
|
|
4272
|
+
*/
|
|
4273
|
+
estateId: string;
|
|
4274
|
+
/**
|
|
4275
|
+
* Unique identifier for the dealer interest (UUID v4)
|
|
4276
|
+
*/
|
|
4277
|
+
interestId: string;
|
|
4278
|
+
};
|
|
4279
|
+
query?: never;
|
|
4280
|
+
url: '/estates/{estateId}/dealer-interests/{interestId}';
|
|
4281
|
+
};
|
|
4282
|
+
export type DeleteDealerInterestErrors = {
|
|
4283
|
+
/**
|
|
4284
|
+
* The requested resource was not found
|
|
4285
|
+
*/
|
|
4286
|
+
404: Error;
|
|
4287
|
+
};
|
|
4288
|
+
export type DeleteDealerInterestError = DeleteDealerInterestErrors[keyof DeleteDealerInterestErrors];
|
|
4289
|
+
export type DeleteDealerInterestResponses = {
|
|
4290
|
+
/**
|
|
4291
|
+
* DealerInterest deleted successfully
|
|
4292
|
+
*/
|
|
4293
|
+
204: void;
|
|
4294
|
+
};
|
|
4295
|
+
export type DeleteDealerInterestResponse = DeleteDealerInterestResponses[keyof DeleteDealerInterestResponses];
|
|
4296
|
+
export type GetDealerInterestData = {
|
|
4297
|
+
body?: never;
|
|
4298
|
+
path: {
|
|
4299
|
+
/**
|
|
4300
|
+
* Unique identifier for the estate (UUID v4)
|
|
4301
|
+
*/
|
|
4302
|
+
estateId: string;
|
|
4303
|
+
/**
|
|
4304
|
+
* Unique identifier for the dealer interest (UUID v4)
|
|
4305
|
+
*/
|
|
4306
|
+
interestId: string;
|
|
4307
|
+
};
|
|
4308
|
+
query?: never;
|
|
4309
|
+
url: '/estates/{estateId}/dealer-interests/{interestId}';
|
|
4310
|
+
};
|
|
4311
|
+
export type GetDealerInterestErrors = {
|
|
4312
|
+
/**
|
|
4313
|
+
* The requested resource was not found
|
|
4314
|
+
*/
|
|
4315
|
+
404: Error;
|
|
4316
|
+
};
|
|
4317
|
+
export type GetDealerInterestError = GetDealerInterestErrors[keyof GetDealerInterestErrors];
|
|
4318
|
+
export type GetDealerInterestResponses = {
|
|
4319
|
+
/**
|
|
4320
|
+
* DealerInterest retrieved successfully
|
|
4321
|
+
*/
|
|
4322
|
+
200: DealerInterest;
|
|
4323
|
+
};
|
|
4324
|
+
export type GetDealerInterestResponse = GetDealerInterestResponses[keyof GetDealerInterestResponses];
|
|
4325
|
+
export type UpdateDealerInterestData = {
|
|
4326
|
+
body: DealerInterest;
|
|
4327
|
+
headers?: {
|
|
4328
|
+
/**
|
|
4329
|
+
* ETag value for optimistic concurrency control
|
|
4330
|
+
*/
|
|
4331
|
+
'If-Match'?: string;
|
|
4332
|
+
};
|
|
4333
|
+
path: {
|
|
4334
|
+
/**
|
|
4335
|
+
* Unique identifier for the estate (UUID v4)
|
|
4336
|
+
*/
|
|
4337
|
+
estateId: string;
|
|
4338
|
+
/**
|
|
4339
|
+
* Unique identifier for the dealer interest (UUID v4)
|
|
4340
|
+
*/
|
|
4341
|
+
interestId: string;
|
|
4342
|
+
};
|
|
4343
|
+
query?: never;
|
|
4344
|
+
url: '/estates/{estateId}/dealer-interests/{interestId}';
|
|
4345
|
+
};
|
|
4346
|
+
export type UpdateDealerInterestErrors = {
|
|
4347
|
+
/**
|
|
4348
|
+
* The request body failed schema validation
|
|
4349
|
+
*/
|
|
4350
|
+
400: Error;
|
|
4351
|
+
/**
|
|
4352
|
+
* The requested resource was not found
|
|
4353
|
+
*/
|
|
4354
|
+
404: Error;
|
|
4355
|
+
};
|
|
4356
|
+
export type UpdateDealerInterestError = UpdateDealerInterestErrors[keyof UpdateDealerInterestErrors];
|
|
4357
|
+
export type UpdateDealerInterestResponses = {
|
|
4358
|
+
/**
|
|
4359
|
+
* DealerInterest updated successfully
|
|
4360
|
+
*/
|
|
4361
|
+
200: DealerInterest;
|
|
4362
|
+
};
|
|
4363
|
+
export type UpdateDealerInterestResponse = UpdateDealerInterestResponses[keyof UpdateDealerInterestResponses];
|
|
4364
|
+
export type ReplaceDealerInterestData = {
|
|
4365
|
+
body: DealerInterest;
|
|
4366
|
+
headers?: {
|
|
4367
|
+
/**
|
|
4368
|
+
* ETag value for optimistic concurrency control
|
|
4369
|
+
*/
|
|
4370
|
+
'If-Match'?: string;
|
|
4371
|
+
};
|
|
4372
|
+
path: {
|
|
4373
|
+
/**
|
|
4374
|
+
* Unique identifier for the estate (UUID v4)
|
|
4375
|
+
*/
|
|
4376
|
+
estateId: string;
|
|
4377
|
+
/**
|
|
4378
|
+
* Unique identifier for the dealer interest (UUID v4)
|
|
4379
|
+
*/
|
|
4380
|
+
interestId: string;
|
|
4381
|
+
};
|
|
4382
|
+
query?: never;
|
|
4383
|
+
url: '/estates/{estateId}/dealer-interests/{interestId}';
|
|
4384
|
+
};
|
|
4385
|
+
export type ReplaceDealerInterestErrors = {
|
|
4386
|
+
/**
|
|
4387
|
+
* The request body failed schema validation
|
|
4388
|
+
*/
|
|
4389
|
+
400: Error;
|
|
4390
|
+
/**
|
|
4391
|
+
* The requested resource was not found
|
|
4392
|
+
*/
|
|
4393
|
+
404: Error;
|
|
4394
|
+
};
|
|
4395
|
+
export type ReplaceDealerInterestError = ReplaceDealerInterestErrors[keyof ReplaceDealerInterestErrors];
|
|
4396
|
+
export type ReplaceDealerInterestResponses = {
|
|
4397
|
+
/**
|
|
4398
|
+
* DealerInterest replaced successfully
|
|
4399
|
+
*/
|
|
4400
|
+
200: DealerInterest;
|
|
4401
|
+
};
|
|
4402
|
+
export type ReplaceDealerInterestResponse = ReplaceDealerInterestResponses[keyof ReplaceDealerInterestResponses];
|
|
4403
|
+
export type ExportEstateJsonData = {
|
|
4404
|
+
body?: ExportJsonRequest;
|
|
4405
|
+
path: {
|
|
4406
|
+
/**
|
|
4407
|
+
* Unique identifier for the estate (UUID v4)
|
|
4408
|
+
*/
|
|
4409
|
+
estateId: string;
|
|
4410
|
+
};
|
|
4411
|
+
query?: never;
|
|
4412
|
+
url: '/estates/{estateId}/export/json';
|
|
4413
|
+
};
|
|
4414
|
+
export type ExportEstateJsonErrors = {
|
|
4415
|
+
/**
|
|
4416
|
+
* The requested resource was not found
|
|
4417
|
+
*/
|
|
4418
|
+
404: Error;
|
|
4419
|
+
};
|
|
4420
|
+
export type ExportEstateJsonError = ExportEstateJsonErrors[keyof ExportEstateJsonErrors];
|
|
4421
|
+
export type ExportEstateJsonResponses = {
|
|
4422
|
+
/**
|
|
4423
|
+
* INHERIT document exported successfully
|
|
4424
|
+
*/
|
|
4425
|
+
200: Schema;
|
|
4426
|
+
};
|
|
4427
|
+
export type ExportEstateJsonResponse = ExportEstateJsonResponses[keyof ExportEstateJsonResponses];
|
|
4428
|
+
export type ExportEstatePdfData = {
|
|
4429
|
+
body: ExportPdfRequest;
|
|
4430
|
+
path: {
|
|
4431
|
+
/**
|
|
4432
|
+
* Unique identifier for the estate (UUID v4)
|
|
4433
|
+
*/
|
|
4434
|
+
estateId: string;
|
|
4435
|
+
};
|
|
4436
|
+
query?: never;
|
|
4437
|
+
url: '/estates/{estateId}/export/pdf';
|
|
4438
|
+
};
|
|
4439
|
+
export type ExportEstatePdfErrors = {
|
|
4440
|
+
/**
|
|
4441
|
+
* The requested resource was not found
|
|
4442
|
+
*/
|
|
4443
|
+
404: Error;
|
|
4444
|
+
};
|
|
4445
|
+
export type ExportEstatePdfError = ExportEstatePdfErrors[keyof ExportEstatePdfErrors];
|
|
4446
|
+
export type ExportEstatePdfResponses = {
|
|
4447
|
+
/**
|
|
4448
|
+
* PDF report generated successfully
|
|
4449
|
+
*/
|
|
4450
|
+
200: Blob | File;
|
|
4451
|
+
};
|
|
4452
|
+
export type ExportEstatePdfResponse = ExportEstatePdfResponses[keyof ExportEstatePdfResponses];
|
|
4453
|
+
export type ImportEstateData = {
|
|
4454
|
+
body: Schema;
|
|
4455
|
+
path?: never;
|
|
4456
|
+
query?: never;
|
|
4457
|
+
url: '/estates/import';
|
|
4458
|
+
};
|
|
4459
|
+
export type ImportEstateErrors = {
|
|
4460
|
+
/**
|
|
4461
|
+
* The request body failed schema validation
|
|
4462
|
+
*/
|
|
4463
|
+
400: Error;
|
|
4464
|
+
};
|
|
4465
|
+
export type ImportEstateError = ImportEstateErrors[keyof ImportEstateErrors];
|
|
4466
|
+
export type ImportEstateResponses = {
|
|
4467
|
+
/**
|
|
4468
|
+
* Estate imported successfully
|
|
4469
|
+
*/
|
|
4470
|
+
201: ImportResult;
|
|
4471
|
+
};
|
|
4472
|
+
export type ImportEstateResponse = ImportEstateResponses[keyof ImportEstateResponses];
|
|
4473
|
+
export type ValidateEstateData = {
|
|
4474
|
+
body?: never;
|
|
4475
|
+
path: {
|
|
4476
|
+
/**
|
|
4477
|
+
* Unique identifier for the estate (UUID v4)
|
|
4478
|
+
*/
|
|
4479
|
+
estateId: string;
|
|
4480
|
+
};
|
|
4481
|
+
query?: never;
|
|
4482
|
+
url: '/estates/{estateId}/validate';
|
|
4483
|
+
};
|
|
4484
|
+
export type ValidateEstateErrors = {
|
|
4485
|
+
/**
|
|
4486
|
+
* The requested resource was not found
|
|
4487
|
+
*/
|
|
4488
|
+
404: Error;
|
|
4489
|
+
};
|
|
4490
|
+
export type ValidateEstateError = ValidateEstateErrors[keyof ValidateEstateErrors];
|
|
4491
|
+
export type ValidateEstateResponses = {
|
|
4492
|
+
/**
|
|
4493
|
+
* Validation result returned successfully
|
|
4494
|
+
*/
|
|
4495
|
+
200: ValidationResult;
|
|
4496
|
+
};
|
|
4497
|
+
export type ValidateEstateResponse = ValidateEstateResponses[keyof ValidateEstateResponses];
|
|
4498
|
+
export type UnlinkCompanionData = {
|
|
4499
|
+
body?: never;
|
|
4500
|
+
path: {
|
|
4501
|
+
/**
|
|
4502
|
+
* Unique identifier for the estate (UUID v4)
|
|
4503
|
+
*/
|
|
4504
|
+
estateId: string;
|
|
4505
|
+
};
|
|
4506
|
+
query?: never;
|
|
4507
|
+
url: '/estates/{estateId}/companion';
|
|
4508
|
+
};
|
|
4509
|
+
export type UnlinkCompanionErrors = {
|
|
4510
|
+
/**
|
|
4511
|
+
* The requested resource was not found
|
|
4512
|
+
*/
|
|
4513
|
+
404: Error;
|
|
4514
|
+
};
|
|
4515
|
+
export type UnlinkCompanionError = UnlinkCompanionErrors[keyof UnlinkCompanionErrors];
|
|
4516
|
+
export type UnlinkCompanionResponses = {
|
|
4517
|
+
/**
|
|
4518
|
+
* Companion unlinked successfully
|
|
4519
|
+
*/
|
|
4520
|
+
204: void;
|
|
4521
|
+
};
|
|
4522
|
+
export type UnlinkCompanionResponse = UnlinkCompanionResponses[keyof UnlinkCompanionResponses];
|
|
4523
|
+
export type GetCompanionData = {
|
|
4524
|
+
body?: never;
|
|
4525
|
+
path: {
|
|
4526
|
+
/**
|
|
4527
|
+
* Unique identifier for the estate (UUID v4)
|
|
4528
|
+
*/
|
|
4529
|
+
estateId: string;
|
|
4530
|
+
};
|
|
4531
|
+
query?: never;
|
|
4532
|
+
url: '/estates/{estateId}/companion';
|
|
4533
|
+
};
|
|
4534
|
+
export type GetCompanionErrors = {
|
|
4535
|
+
/**
|
|
4536
|
+
* The requested resource was not found
|
|
4537
|
+
*/
|
|
4538
|
+
404: Error;
|
|
4539
|
+
};
|
|
4540
|
+
export type GetCompanionError = GetCompanionErrors[keyof GetCompanionErrors];
|
|
4541
|
+
export type GetCompanionResponses = {
|
|
4542
|
+
/**
|
|
4543
|
+
* Companion estate summary returned successfully
|
|
4544
|
+
*/
|
|
4545
|
+
200: EstateSummary;
|
|
4546
|
+
};
|
|
4547
|
+
export type GetCompanionResponse = GetCompanionResponses[keyof GetCompanionResponses];
|
|
4548
|
+
export type LinkCompanionData = {
|
|
4549
|
+
body: CompanionLink;
|
|
4550
|
+
path: {
|
|
4551
|
+
/**
|
|
4552
|
+
* Unique identifier for the estate (UUID v4)
|
|
4553
|
+
*/
|
|
4554
|
+
estateId: string;
|
|
4555
|
+
};
|
|
4556
|
+
query?: never;
|
|
4557
|
+
url: '/estates/{estateId}/companion';
|
|
4558
|
+
};
|
|
4559
|
+
export type LinkCompanionErrors = {
|
|
4560
|
+
/**
|
|
4561
|
+
* The requested resource was not found
|
|
4562
|
+
*/
|
|
4563
|
+
404: Error;
|
|
4564
|
+
/**
|
|
4565
|
+
* The request conflicts with the current state of the resource
|
|
4566
|
+
*/
|
|
4567
|
+
409: Error;
|
|
4568
|
+
};
|
|
4569
|
+
export type LinkCompanionError = LinkCompanionErrors[keyof LinkCompanionErrors];
|
|
4570
|
+
export type LinkCompanionResponses = {
|
|
4571
|
+
/**
|
|
4572
|
+
* Companion linked successfully
|
|
4573
|
+
*/
|
|
4574
|
+
200: Estate;
|
|
4575
|
+
};
|
|
4576
|
+
export type LinkCompanionResponse = LinkCompanionResponses[keyof LinkCompanionResponses];
|
|
4577
|
+
export type GetEstateSummaryData = {
|
|
4578
|
+
body?: never;
|
|
4579
|
+
path: {
|
|
4580
|
+
/**
|
|
4581
|
+
* Unique identifier for the estate (UUID v4)
|
|
4582
|
+
*/
|
|
4583
|
+
estateId: string;
|
|
4584
|
+
};
|
|
4585
|
+
query?: never;
|
|
4586
|
+
url: '/estates/{estateId}/summary';
|
|
4587
|
+
};
|
|
4588
|
+
export type GetEstateSummaryErrors = {
|
|
4589
|
+
/**
|
|
4590
|
+
* The requested resource was not found
|
|
4591
|
+
*/
|
|
4592
|
+
404: Error;
|
|
4593
|
+
};
|
|
4594
|
+
export type GetEstateSummaryError = GetEstateSummaryErrors[keyof GetEstateSummaryErrors];
|
|
4595
|
+
export type GetEstateSummaryResponses = {
|
|
4596
|
+
/**
|
|
4597
|
+
* Estate summary returned successfully
|
|
4598
|
+
*/
|
|
4599
|
+
200: EstateSummary;
|
|
4600
|
+
};
|
|
4601
|
+
export type GetEstateSummaryResponse = GetEstateSummaryResponses[keyof GetEstateSummaryResponses];
|
|
4602
|
+
//# sourceMappingURL=types.gen.d.ts.map
|