@firmenakte/api-client 2.11.8 → 2.22.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/README.md +27 -0
- package/client.d.ts +1256 -1084
- package/client.d.ts.map +1 -1
- package/client.js +247 -224
- package/index.d.ts +82 -79
- package/index.d.ts.map +1 -1
- package/keyfigure-labels.d.ts +10 -6
- package/keyfigure-labels.d.ts.map +1 -1
- package/keyfigure-labels.js +10 -6
- package/package.json +13 -2
- package/v2/generated/client/client.gen.d.ts +3 -0
- package/v2/generated/client/client.gen.d.ts.map +1 -0
- package/v2/generated/client/client.gen.js +220 -0
- package/v2/generated/client/index.d.ts +11 -0
- package/v2/generated/client/index.d.ts.map +1 -0
- package/v2/generated/client/index.js +17 -0
- package/v2/generated/client/types.gen.d.ts +121 -0
- package/v2/generated/client/types.gen.d.ts.map +1 -0
- package/v2/generated/client/types.gen.js +3 -0
- package/v2/generated/client/utils.gen.d.ts +38 -0
- package/v2/generated/client/utils.gen.d.ts.map +1 -0
- package/v2/generated/client/utils.gen.js +241 -0
- package/v2/generated/client.gen.d.ts +13 -0
- package/v2/generated/client.gen.d.ts.map +1 -0
- package/v2/generated/client.gen.js +6 -0
- package/v2/generated/core/auth.gen.d.ts +26 -0
- package/v2/generated/core/auth.gen.d.ts.map +1 -0
- package/v2/generated/core/auth.gen.js +18 -0
- package/v2/generated/core/bodySerializer.gen.d.ts +26 -0
- package/v2/generated/core/bodySerializer.gen.d.ts.map +1 -0
- package/v2/generated/core/bodySerializer.gen.js +60 -0
- package/v2/generated/core/params.gen.d.ts +44 -0
- package/v2/generated/core/params.gen.d.ts.map +1 -0
- package/v2/generated/core/params.gen.js +112 -0
- package/v2/generated/core/pathSerializer.gen.d.ts +34 -0
- package/v2/generated/core/pathSerializer.gen.d.ts.map +1 -0
- package/v2/generated/core/pathSerializer.gen.js +115 -0
- package/v2/generated/core/queryKeySerializer.gen.d.ts +19 -0
- package/v2/generated/core/queryKeySerializer.gen.d.ts.map +1 -0
- package/v2/generated/core/queryKeySerializer.gen.js +98 -0
- package/v2/generated/core/serverSentEvents.gen.d.ts +72 -0
- package/v2/generated/core/serverSentEvents.gen.d.ts.map +1 -0
- package/v2/generated/core/serverSentEvents.gen.js +135 -0
- package/v2/generated/core/types.gen.d.ts +84 -0
- package/v2/generated/core/types.gen.d.ts.map +1 -0
- package/v2/generated/core/types.gen.js +3 -0
- package/v2/generated/core/utils.gen.d.ts +20 -0
- package/v2/generated/core/utils.gen.d.ts.map +1 -0
- package/v2/generated/core/utils.gen.js +93 -0
- package/v2/generated/index.d.ts +3 -0
- package/v2/generated/index.d.ts.map +1 -0
- package/v2/generated/index.js +6 -0
- package/v2/generated/sdk.gen.d.ts +674 -0
- package/v2/generated/sdk.gen.d.ts.map +1 -0
- package/v2/generated/sdk.gen.js +1433 -0
- package/v2/generated/types.gen.d.ts +9439 -0
- package/v2/generated/types.gen.d.ts.map +1 -0
- package/v2/generated/types.gen.js +3 -0
- package/v2/index.d.ts +46 -0
- package/v2/index.d.ts.map +1 -0
- package/v2/index.js +80 -0
|
@@ -0,0 +1,1433 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file is auto-generated by @hey-api/openapi-ts
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.FirmenakteApi = void 0;
|
|
5
|
+
class HeyApiClient {
|
|
6
|
+
constructor(args) {
|
|
7
|
+
this.client = args.client;
|
|
8
|
+
}
|
|
9
|
+
}
|
|
10
|
+
class HeyApiRegistry {
|
|
11
|
+
constructor() {
|
|
12
|
+
this.defaultKey = 'default';
|
|
13
|
+
this.instances = new Map();
|
|
14
|
+
}
|
|
15
|
+
get(key) {
|
|
16
|
+
const instance = this.instances.get(key ?? this.defaultKey);
|
|
17
|
+
if (!instance) {
|
|
18
|
+
throw new Error(`No SDK client found. Create one with "new FirmenakteApi()" to fix this error.`);
|
|
19
|
+
}
|
|
20
|
+
return instance;
|
|
21
|
+
}
|
|
22
|
+
set(value, key) {
|
|
23
|
+
this.instances.set(key ?? this.defaultKey, value);
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
class FirmenakteApi extends HeyApiClient {
|
|
27
|
+
constructor(args) {
|
|
28
|
+
super(args);
|
|
29
|
+
FirmenakteApi.__registry.set(this, args.key);
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Capture a fixed search selection
|
|
33
|
+
*
|
|
34
|
+
* Freeze a complete ordered search selection on the server for a later confirmed save or export. Returns a handle and count, never all IDs. Maximum 100000 IDs, expires after 24 hours. Supply exactly one new companies, people or entries search without cursor. For a list defined by criteria, prefer creating the list with a query rule; capture is for an explicitly fixed snapshot. Ordinary pagination and aggregation do not need a capture. Costs one credit for keys; free for sessions. Responses are private, no-store.
|
|
35
|
+
*/
|
|
36
|
+
captureSelection(options) {
|
|
37
|
+
return (options.client ?? this.client).post({
|
|
38
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
39
|
+
url: '/api/v2/me/selections',
|
|
40
|
+
...options,
|
|
41
|
+
headers: {
|
|
42
|
+
'Content-Type': 'application/json',
|
|
43
|
+
...options.headers
|
|
44
|
+
}
|
|
45
|
+
});
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* Read a stored operation result
|
|
49
|
+
*
|
|
50
|
+
* Read an unchanged stored result or a specific JSON Pointer section without repeating the source query. Arrays are paginated; large objects expose field paths. Follow nextOffset or choose a field path. References are reader-scoped and expire after 24 hours. This is the stored snapshot, not live data. Free for keys and sessions. Responses are private, no-store.
|
|
51
|
+
*/
|
|
52
|
+
readResult(options) {
|
|
53
|
+
return (options.client ?? this.client).get({
|
|
54
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
55
|
+
url: '/api/v2/me/results/{id}',
|
|
56
|
+
...options
|
|
57
|
+
});
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* Clear my search history
|
|
61
|
+
*
|
|
62
|
+
* Delete the current user's personal search history in this workspace. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Requires a dashboard user session; workspace keys cannot access personal history.
|
|
63
|
+
*
|
|
64
|
+
* @deprecated
|
|
65
|
+
*/
|
|
66
|
+
clearSearchHistory(options) {
|
|
67
|
+
return (options?.client ?? this.client).delete({
|
|
68
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
69
|
+
url: '/api/v2/me/search-history',
|
|
70
|
+
...options
|
|
71
|
+
});
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* List my search history
|
|
75
|
+
*
|
|
76
|
+
* Return a cursor page of the user's entity and filter searches in this workspace, newest first. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Requires a dashboard user session; workspace keys cannot access personal history.
|
|
77
|
+
*
|
|
78
|
+
* @deprecated
|
|
79
|
+
*/
|
|
80
|
+
listSearchHistory(options) {
|
|
81
|
+
return (options?.client ?? this.client).get({
|
|
82
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
83
|
+
url: '/api/v2/me/search-history',
|
|
84
|
+
...options
|
|
85
|
+
});
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* Delete a search history item
|
|
89
|
+
*
|
|
90
|
+
* Delete one item from the current user's personal search history in this workspace. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Requires a dashboard user session; workspace keys cannot access personal history.
|
|
91
|
+
*
|
|
92
|
+
* @deprecated
|
|
93
|
+
*/
|
|
94
|
+
deleteSearchHistoryItem(options) {
|
|
95
|
+
return (options.client ?? this.client).delete({
|
|
96
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
97
|
+
url: '/api/v2/me/search-history/{id}',
|
|
98
|
+
...options
|
|
99
|
+
});
|
|
100
|
+
}
|
|
101
|
+
/**
|
|
102
|
+
* List workspace fields
|
|
103
|
+
*
|
|
104
|
+
* Return a cursor page of workspace field definitions and their stable keys. Optional listId restricts the result to that list's columns. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
105
|
+
*/
|
|
106
|
+
listFields(options) {
|
|
107
|
+
return (options?.client ?? this.client).get({
|
|
108
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
109
|
+
url: '/api/v2/me/fields',
|
|
110
|
+
...options
|
|
111
|
+
});
|
|
112
|
+
}
|
|
113
|
+
/**
|
|
114
|
+
* Create a workspace field
|
|
115
|
+
*
|
|
116
|
+
* Create a typed workspace field with a key derived from its label. Key collisions receive a suffix. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
117
|
+
*/
|
|
118
|
+
createField(options) {
|
|
119
|
+
return (options.client ?? this.client).post({
|
|
120
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
121
|
+
url: '/api/v2/me/fields',
|
|
122
|
+
...options,
|
|
123
|
+
headers: {
|
|
124
|
+
'Content-Type': 'application/json',
|
|
125
|
+
...options.headers
|
|
126
|
+
}
|
|
127
|
+
});
|
|
128
|
+
}
|
|
129
|
+
/**
|
|
130
|
+
* Delete a workspace field
|
|
131
|
+
*
|
|
132
|
+
* Delete a workspace field with its values and the list columns that show it. List rules cannot filter by workspace fields, so no list definition depends on one. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
133
|
+
*/
|
|
134
|
+
deleteField(options) {
|
|
135
|
+
return (options.client ?? this.client).delete({
|
|
136
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
137
|
+
url: '/api/v2/me/fields/{id}',
|
|
138
|
+
...options
|
|
139
|
+
});
|
|
140
|
+
}
|
|
141
|
+
/**
|
|
142
|
+
* Update a workspace field
|
|
143
|
+
*
|
|
144
|
+
* Update a workspace field's label, type or options without changing its key. Option renames update stored values together. Invalid conversions require clearInvalid. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
145
|
+
*/
|
|
146
|
+
updateField(options) {
|
|
147
|
+
return (options.client ?? this.client).patch({
|
|
148
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
149
|
+
url: '/api/v2/me/fields/{id}',
|
|
150
|
+
...options,
|
|
151
|
+
headers: {
|
|
152
|
+
'Content-Type': 'application/json',
|
|
153
|
+
...options.headers
|
|
154
|
+
}
|
|
155
|
+
});
|
|
156
|
+
}
|
|
157
|
+
/**
|
|
158
|
+
* Prepare a CSV import report
|
|
159
|
+
*
|
|
160
|
+
* Create a 24-hour review draft and match report from browser-parsed CSV rows for a workspace list. Entries, own records, options and values are not written until confirmation. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
161
|
+
*/
|
|
162
|
+
createImport(options) {
|
|
163
|
+
return (options.client ?? this.client).post({
|
|
164
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
165
|
+
url: '/api/v2/me/lists/{id}/imports',
|
|
166
|
+
...options,
|
|
167
|
+
headers: {
|
|
168
|
+
'Content-Type': 'application/json',
|
|
169
|
+
...options.headers
|
|
170
|
+
}
|
|
171
|
+
});
|
|
172
|
+
}
|
|
173
|
+
/**
|
|
174
|
+
* Get an import report
|
|
175
|
+
*
|
|
176
|
+
* Return an import draft's summary, field conversion warnings and cursor-paged rows. Rows can be filtered by match status; expired drafts return 410 import_expired. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
177
|
+
*/
|
|
178
|
+
getImport(options) {
|
|
179
|
+
return (options.client ?? this.client).get({
|
|
180
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
181
|
+
url: '/api/v2/me/lists/{id}/imports/{importId}',
|
|
182
|
+
...options
|
|
183
|
+
});
|
|
184
|
+
}
|
|
185
|
+
/**
|
|
186
|
+
* Choose import matches
|
|
187
|
+
*
|
|
188
|
+
* Update review draft rows with a register akteId or keepOwn choice. This does not add list entries or own records. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
189
|
+
*/
|
|
190
|
+
updateImport(options) {
|
|
191
|
+
return (options.client ?? this.client).patch({
|
|
192
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
193
|
+
url: '/api/v2/me/lists/{id}/imports/{importId}',
|
|
194
|
+
...options,
|
|
195
|
+
headers: {
|
|
196
|
+
'Content-Type': 'application/json',
|
|
197
|
+
...options.headers
|
|
198
|
+
}
|
|
199
|
+
});
|
|
200
|
+
}
|
|
201
|
+
/**
|
|
202
|
+
* Confirm a CSV import
|
|
203
|
+
*
|
|
204
|
+
* Add matched register records and reused or new own records to the list, together with field values and new options. Unresolved ambiguous rows retain candidate IDs. Confirmation is retry-safe without an Idempotency-Key; over 500 rows returns a durable job. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
205
|
+
*/
|
|
206
|
+
confirmImport(options) {
|
|
207
|
+
return (options.client ?? this.client).post({
|
|
208
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
209
|
+
url: '/api/v2/me/lists/{id}/imports/{importId}/confirm',
|
|
210
|
+
...options
|
|
211
|
+
});
|
|
212
|
+
}
|
|
213
|
+
/**
|
|
214
|
+
* Get a list write job
|
|
215
|
+
*
|
|
216
|
+
* Return the status and durable progress of a bulk list write job in this workspace. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
217
|
+
*/
|
|
218
|
+
getJob(options) {
|
|
219
|
+
return (options.client ?? this.client).get({
|
|
220
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
221
|
+
url: '/api/v2/me/jobs/{id}',
|
|
222
|
+
...options
|
|
223
|
+
});
|
|
224
|
+
}
|
|
225
|
+
/**
|
|
226
|
+
* Preview a rule for a new list
|
|
227
|
+
*
|
|
228
|
+
* Validate a rule before creating a list. Returns the same price, next run, match count and bounded sample as previewRule, without requiring or creating a list. Does not save, execute or charge. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
229
|
+
*/
|
|
230
|
+
previewNewListRule(options) {
|
|
231
|
+
return (options.client ?? this.client).post({
|
|
232
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
233
|
+
url: '/api/v2/me/lists/rules/preview',
|
|
234
|
+
...options,
|
|
235
|
+
headers: {
|
|
236
|
+
'Content-Type': 'application/json',
|
|
237
|
+
...options.headers
|
|
238
|
+
}
|
|
239
|
+
});
|
|
240
|
+
}
|
|
241
|
+
/**
|
|
242
|
+
* Preview a rule
|
|
243
|
+
*
|
|
244
|
+
* Validate a typed rule for an existing list identified by id, before saving it to that list. Creating a new list with rules uses createList and does not require this existing-list preview. Query rules return credits per execution, nextRunAt, matches (how many companies a run would newly add now, counted up to 10000) and at most five of them as a sample; neither is a reserved selection. Notification rules return zero credits, no matches and no sample. Does not save or execute. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
245
|
+
*/
|
|
246
|
+
previewRule(options) {
|
|
247
|
+
return (options.client ?? this.client).post({
|
|
248
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
249
|
+
url: '/api/v2/me/lists/{id}/rules/preview',
|
|
250
|
+
...options,
|
|
251
|
+
headers: {
|
|
252
|
+
'Content-Type': 'application/json',
|
|
253
|
+
...options.headers
|
|
254
|
+
}
|
|
255
|
+
});
|
|
256
|
+
}
|
|
257
|
+
/**
|
|
258
|
+
* List rules
|
|
259
|
+
*
|
|
260
|
+
* Read cursor-paged rules with typed rule configuration, revision, credits per execution and latest query run. Filter operationId to applyListQuery or notifyListEntries; keep this filter unchanged when paging. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
261
|
+
*/
|
|
262
|
+
listRules(options) {
|
|
263
|
+
return (options.client ?? this.client).get({
|
|
264
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
265
|
+
url: '/api/v2/me/lists/{id}/rules',
|
|
266
|
+
...options
|
|
267
|
+
});
|
|
268
|
+
}
|
|
269
|
+
/**
|
|
270
|
+
* Create a rule
|
|
271
|
+
*
|
|
272
|
+
* Save one typed rule: applyListQuery for company queries, or notifyListEntries for one inApp/email channel. runNow optionally starts an enabled query at the quoted list-update price; recurrence is controlled separately by its trigger. Notification channels are unique per list. Creation is free; scheduled and manual executions charge the server list-update price. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
273
|
+
*/
|
|
274
|
+
createRule(options) {
|
|
275
|
+
return (options.client ?? this.client).post({
|
|
276
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
277
|
+
url: '/api/v2/me/lists/{id}/rules',
|
|
278
|
+
...options,
|
|
279
|
+
headers: {
|
|
280
|
+
'Content-Type': 'application/json',
|
|
281
|
+
...options.headers
|
|
282
|
+
}
|
|
283
|
+
});
|
|
284
|
+
}
|
|
285
|
+
/**
|
|
286
|
+
* Delete a rule
|
|
287
|
+
*
|
|
288
|
+
* Delete one rule while keeping entries, values and historical runs. Copy its revision string from list_rules unchanged. Pause instead with update_rule. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
289
|
+
*/
|
|
290
|
+
deleteRule(options) {
|
|
291
|
+
return (options.client ?? this.client).delete({
|
|
292
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
293
|
+
url: '/api/v2/me/lists/{id}/rules/{ruleId}',
|
|
294
|
+
...options
|
|
295
|
+
});
|
|
296
|
+
}
|
|
297
|
+
/**
|
|
298
|
+
* Update a rule
|
|
299
|
+
*
|
|
300
|
+
* Replace a rule configuration using its unchanged revision from list_rules. Function and notification channel stay fixed. enabled:false pauses it; entries and values remain. Re-enabling notifications starts at the current event horizon. Changes fence older executions. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
301
|
+
*/
|
|
302
|
+
updateRule(options) {
|
|
303
|
+
return (options.client ?? this.client).patch({
|
|
304
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
305
|
+
url: '/api/v2/me/lists/{id}/rules/{ruleId}',
|
|
306
|
+
...options,
|
|
307
|
+
headers: {
|
|
308
|
+
'Content-Type': 'application/json',
|
|
309
|
+
...options.headers
|
|
310
|
+
}
|
|
311
|
+
});
|
|
312
|
+
}
|
|
313
|
+
/**
|
|
314
|
+
* Evaluate a rule
|
|
315
|
+
*
|
|
316
|
+
* Run an enabled applyListQuery rule using its unchanged revision from list_rules. dryRun previews; execution charges the list-update price, adds matches and preserves entries/exclusions. Notification rules run only from events. Read status with list_runs and additions with list_entries(runId). Reuse Idempotency-Key after a lost response. Additions respect list-wide exclusions and never remove members. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
317
|
+
*/
|
|
318
|
+
runRule(options) {
|
|
319
|
+
return (options.client ?? this.client).post({
|
|
320
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
321
|
+
url: '/api/v2/me/lists/{id}/rules/{ruleId}/run',
|
|
322
|
+
...options,
|
|
323
|
+
headers: {
|
|
324
|
+
'Content-Type': 'application/json',
|
|
325
|
+
...options.headers
|
|
326
|
+
}
|
|
327
|
+
});
|
|
328
|
+
}
|
|
329
|
+
/**
|
|
330
|
+
* List workspace lists
|
|
331
|
+
*
|
|
332
|
+
* Return a cursor page of workspace lists with membership counts. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
333
|
+
*/
|
|
334
|
+
listLists(options) {
|
|
335
|
+
return (options?.client ?? this.client).get({
|
|
336
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
337
|
+
url: '/api/v2/me/lists',
|
|
338
|
+
...options
|
|
339
|
+
});
|
|
340
|
+
}
|
|
341
|
+
/**
|
|
342
|
+
* Create a list
|
|
343
|
+
*
|
|
344
|
+
* Create a list atomically with optional items (up to 500) and rules (up to 100). Each rule contains its typed rule configuration and runNow flag. Use applyListQuery for reusable queries instead of enumerating matches. At most one enabled query may runNow; trigger manual is one-time, trigger schedule adds independent recurrence. Notification rules use notifyListEntries with one channel each. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
345
|
+
*/
|
|
346
|
+
createList(options) {
|
|
347
|
+
return (options.client ?? this.client).post({
|
|
348
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
349
|
+
url: '/api/v2/me/lists',
|
|
350
|
+
...options,
|
|
351
|
+
headers: {
|
|
352
|
+
'Content-Type': 'application/json',
|
|
353
|
+
...options.headers
|
|
354
|
+
}
|
|
355
|
+
});
|
|
356
|
+
}
|
|
357
|
+
/**
|
|
358
|
+
* Delete a list
|
|
359
|
+
*
|
|
360
|
+
* Delete a workspace list, its rules and entries while keeping workspace own records. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
361
|
+
*/
|
|
362
|
+
deleteList(options) {
|
|
363
|
+
return (options.client ?? this.client).delete({
|
|
364
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
365
|
+
url: '/api/v2/me/lists/{id}',
|
|
366
|
+
...options
|
|
367
|
+
});
|
|
368
|
+
}
|
|
369
|
+
/**
|
|
370
|
+
* Get a list
|
|
371
|
+
*
|
|
372
|
+
* Read list metadata, statistics, latest run and rev_ revision for update_list. Independent rules and their revision strings: list_rules. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
373
|
+
*/
|
|
374
|
+
getList(options) {
|
|
375
|
+
return (options.client ?? this.client).get({
|
|
376
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
377
|
+
url: '/api/v2/me/lists/{id}',
|
|
378
|
+
...options
|
|
379
|
+
});
|
|
380
|
+
}
|
|
381
|
+
/**
|
|
382
|
+
* Update a list
|
|
383
|
+
*
|
|
384
|
+
* Rename a list or change its color. Add independent rules with create_rule; edit or pause with update_rule. Optional If-Match checks the revision and returns 412 revision_conflict without saving if it changed. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
385
|
+
*/
|
|
386
|
+
updateList(options) {
|
|
387
|
+
return (options.client ?? this.client).patch({
|
|
388
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
389
|
+
url: '/api/v2/me/lists/{id}',
|
|
390
|
+
...options,
|
|
391
|
+
headers: {
|
|
392
|
+
'Content-Type': 'application/json',
|
|
393
|
+
...options.headers
|
|
394
|
+
}
|
|
395
|
+
});
|
|
396
|
+
}
|
|
397
|
+
/**
|
|
398
|
+
* List entries
|
|
399
|
+
*
|
|
400
|
+
* Return a filtered cursor page of visible list entries with their column values. Sort by a column or addedAt; empty values sort last. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
401
|
+
*/
|
|
402
|
+
listEntries(options) {
|
|
403
|
+
return (options.client ?? this.client).get({
|
|
404
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
405
|
+
url: '/api/v2/me/lists/{id}/entries',
|
|
406
|
+
...options
|
|
407
|
+
});
|
|
408
|
+
}
|
|
409
|
+
/**
|
|
410
|
+
* Add list entries
|
|
411
|
+
*
|
|
412
|
+
* Add register records, workspace own records or inline own records to a list. Re-adding a subject lifts its exclusion; existing subjects report alreadyPresent. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
413
|
+
*/
|
|
414
|
+
addEntries(options) {
|
|
415
|
+
return (options.client ?? this.client).post({
|
|
416
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
417
|
+
url: '/api/v2/me/lists/{id}/entries',
|
|
418
|
+
...options,
|
|
419
|
+
headers: {
|
|
420
|
+
'Content-Type': 'application/json',
|
|
421
|
+
...options.headers
|
|
422
|
+
}
|
|
423
|
+
});
|
|
424
|
+
}
|
|
425
|
+
/**
|
|
426
|
+
* Update a list entry
|
|
427
|
+
*
|
|
428
|
+
* Set a list entry's excluded state or its typed field values. Values belong to the subject and appear on every list; exclusion prevents dynamic re-addition until lifted. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
429
|
+
*/
|
|
430
|
+
updateEntry(options) {
|
|
431
|
+
return (options.client ?? this.client).patch({
|
|
432
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
433
|
+
url: '/api/v2/me/lists/{id}/entries/{entryId}',
|
|
434
|
+
...options,
|
|
435
|
+
headers: {
|
|
436
|
+
'Content-Type': 'application/json',
|
|
437
|
+
...options.headers
|
|
438
|
+
}
|
|
439
|
+
});
|
|
440
|
+
}
|
|
441
|
+
/**
|
|
442
|
+
* Remove list entries
|
|
443
|
+
*
|
|
444
|
+
* Exclude selected list entries by entry IDs, register IDs or a bulk selection. Excluded members do not return until explicitly re-added. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
445
|
+
*/
|
|
446
|
+
removeEntries(options) {
|
|
447
|
+
return (options.client ?? this.client).post({
|
|
448
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
449
|
+
url: '/api/v2/me/lists/{id}/entries/remove',
|
|
450
|
+
...options,
|
|
451
|
+
headers: {
|
|
452
|
+
'Content-Type': 'application/json',
|
|
453
|
+
...options.headers
|
|
454
|
+
}
|
|
455
|
+
});
|
|
456
|
+
}
|
|
457
|
+
/**
|
|
458
|
+
* List a list's columns
|
|
459
|
+
*
|
|
460
|
+
* Return the list's ordered register and workspace-field columns. Name stays first. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
461
|
+
*/
|
|
462
|
+
listColumns(options) {
|
|
463
|
+
return (options.client ?? this.client).get({
|
|
464
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
465
|
+
url: '/api/v2/me/lists/{id}/columns',
|
|
466
|
+
...options
|
|
467
|
+
});
|
|
468
|
+
}
|
|
469
|
+
/**
|
|
470
|
+
* Replace a list's columns
|
|
471
|
+
*
|
|
472
|
+
* Replace a list's column order, labels and visibility. Public paths must be columnable and own fields must belong to this workspace; name remains first and visible. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
473
|
+
*/
|
|
474
|
+
replaceColumns(options) {
|
|
475
|
+
return (options.client ?? this.client).put({
|
|
476
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
477
|
+
url: '/api/v2/me/lists/{id}/columns',
|
|
478
|
+
...options,
|
|
479
|
+
headers: {
|
|
480
|
+
'Content-Type': 'application/json',
|
|
481
|
+
...options.headers
|
|
482
|
+
}
|
|
483
|
+
});
|
|
484
|
+
}
|
|
485
|
+
/**
|
|
486
|
+
* Search list entries
|
|
487
|
+
*
|
|
488
|
+
* Filter a list's entries with the shared filter compiler, including workspace-field and list predicates. Results use keyset paging with empty values last; limit 0 counts for free. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
489
|
+
*/
|
|
490
|
+
searchEntries(options) {
|
|
491
|
+
return (options.client ?? this.client).post({
|
|
492
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
493
|
+
url: '/api/v2/me/lists/{id}/entries/search',
|
|
494
|
+
...options,
|
|
495
|
+
headers: {
|
|
496
|
+
'Content-Type': 'application/json',
|
|
497
|
+
...options.headers
|
|
498
|
+
}
|
|
499
|
+
});
|
|
500
|
+
}
|
|
501
|
+
/**
|
|
502
|
+
* List list runs
|
|
503
|
+
*
|
|
504
|
+
* Return a newest-first cursor page of a list's update runs with counts, evaluation date, credits and status. Optional trigger and status filters narrow the result. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
505
|
+
*/
|
|
506
|
+
listRuns(options) {
|
|
507
|
+
return (options.client ?? this.client).get({
|
|
508
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
509
|
+
url: '/api/v2/me/lists/{id}/runs',
|
|
510
|
+
...options
|
|
511
|
+
});
|
|
512
|
+
}
|
|
513
|
+
/**
|
|
514
|
+
* List list events
|
|
515
|
+
*
|
|
516
|
+
* Return a list's membership, identity-correction and skipped-update events in ascending sequence order. The after sequence never expires; type and runId can narrow the events. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
517
|
+
*/
|
|
518
|
+
listListEvents(options) {
|
|
519
|
+
return (options.client ?? this.client).get({
|
|
520
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
521
|
+
url: '/api/v2/me/lists/{id}/events',
|
|
522
|
+
...options
|
|
523
|
+
});
|
|
524
|
+
}
|
|
525
|
+
/**
|
|
526
|
+
* Map my search results
|
|
527
|
+
*
|
|
528
|
+
* Use listId or query; together they filter only existing list members. q narrows the result further. bbox is [minLng,minLat,maxLng,maxLat], zoom 0–20. Dense cells are SQL clusters; singleton cells become points from zoom 10. noLocation counts every match without visible coordinates, regardless of bbox. entries and withoutLocation are bounded cursor pages. Session searches are free; keys pay one credit. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
529
|
+
*/
|
|
530
|
+
searchMineGeo(options) {
|
|
531
|
+
return (options.client ?? this.client).post({
|
|
532
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
533
|
+
url: '/api/v2/me/search/geo',
|
|
534
|
+
...options,
|
|
535
|
+
headers: {
|
|
536
|
+
'Content-Type': 'application/json',
|
|
537
|
+
...options.headers
|
|
538
|
+
}
|
|
539
|
+
});
|
|
540
|
+
}
|
|
541
|
+
/**
|
|
542
|
+
* Search my data
|
|
543
|
+
*
|
|
544
|
+
* Search a workspace list or a company query using public, workspace-field and list predicates. Optional ownRecords includes workspace own records; columns selects public column values. Results use keyset paging with empty values last; limit 0 counts for free. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
545
|
+
*/
|
|
546
|
+
searchMine(options) {
|
|
547
|
+
return (options.client ?? this.client).post({
|
|
548
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
549
|
+
url: '/api/v2/me/search',
|
|
550
|
+
...options,
|
|
551
|
+
headers: {
|
|
552
|
+
'Content-Type': 'application/json',
|
|
553
|
+
...options.headers
|
|
554
|
+
}
|
|
555
|
+
});
|
|
556
|
+
}
|
|
557
|
+
/**
|
|
558
|
+
* Get my entity data
|
|
559
|
+
*
|
|
560
|
+
* Resolve a register ID, alias or workspace own-record ID and return its workspace field values, with the first 25 memberships, notes and activity items. Continuation cursors use the corresponding collection paths. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
561
|
+
*/
|
|
562
|
+
getMyEntity(options) {
|
|
563
|
+
return (options.client ?? this.client).get({
|
|
564
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
565
|
+
url: '/api/v2/me/entities/{id}',
|
|
566
|
+
...options
|
|
567
|
+
});
|
|
568
|
+
}
|
|
569
|
+
/**
|
|
570
|
+
* Update my entity values
|
|
571
|
+
*
|
|
572
|
+
* Set an entity's workspace-wide typed field values, even without list membership. Null clears a value. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
573
|
+
*/
|
|
574
|
+
updateMyEntity(options) {
|
|
575
|
+
return (options.client ?? this.client).patch({
|
|
576
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
577
|
+
url: '/api/v2/me/entities/{id}',
|
|
578
|
+
...options,
|
|
579
|
+
headers: {
|
|
580
|
+
'Content-Type': 'application/json',
|
|
581
|
+
...options.headers
|
|
582
|
+
}
|
|
583
|
+
});
|
|
584
|
+
}
|
|
585
|
+
/**
|
|
586
|
+
* List an entity's lists
|
|
587
|
+
*
|
|
588
|
+
* Return a cursor page of an entity's workspace list memberships, including excluded lists. Memberships include exclusion state and the membership origin. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
589
|
+
*/
|
|
590
|
+
listEntityLists(options) {
|
|
591
|
+
return (options.client ?? this.client).get({
|
|
592
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
593
|
+
url: '/api/v2/me/entities/{id}/lists',
|
|
594
|
+
...options
|
|
595
|
+
});
|
|
596
|
+
}
|
|
597
|
+
/**
|
|
598
|
+
* List an entity's activity
|
|
599
|
+
*
|
|
600
|
+
* Return a newest-first cursor page of an entity's workspace activity with readable summaries. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
601
|
+
*/
|
|
602
|
+
listEntityActivity(options) {
|
|
603
|
+
return (options.client ?? this.client).get({
|
|
604
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
605
|
+
url: '/api/v2/me/entities/{id}/activity',
|
|
606
|
+
...options
|
|
607
|
+
});
|
|
608
|
+
}
|
|
609
|
+
/**
|
|
610
|
+
* List my notes
|
|
611
|
+
*
|
|
612
|
+
* Return a cursor page of workspace notes on the requested subject. Suppressed subjects are hidden. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
613
|
+
*/
|
|
614
|
+
listNotes(options) {
|
|
615
|
+
return (options?.client ?? this.client).get({
|
|
616
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
617
|
+
url: '/api/v2/me/notes',
|
|
618
|
+
...options
|
|
619
|
+
});
|
|
620
|
+
}
|
|
621
|
+
/**
|
|
622
|
+
* Create a note
|
|
623
|
+
*
|
|
624
|
+
* Create a workspace note on a subject resolved from a canonical ID, alias or workspace own record. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
625
|
+
*/
|
|
626
|
+
createNote(options) {
|
|
627
|
+
return (options.client ?? this.client).post({
|
|
628
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
629
|
+
url: '/api/v2/me/notes',
|
|
630
|
+
...options,
|
|
631
|
+
headers: {
|
|
632
|
+
'Content-Type': 'application/json',
|
|
633
|
+
...options.headers
|
|
634
|
+
}
|
|
635
|
+
});
|
|
636
|
+
}
|
|
637
|
+
/**
|
|
638
|
+
* Delete a note
|
|
639
|
+
*
|
|
640
|
+
* Delete a workspace-owned note. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
641
|
+
*/
|
|
642
|
+
deleteNote(options) {
|
|
643
|
+
return (options.client ?? this.client).delete({
|
|
644
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
645
|
+
url: '/api/v2/me/notes/{id}',
|
|
646
|
+
...options
|
|
647
|
+
});
|
|
648
|
+
}
|
|
649
|
+
/**
|
|
650
|
+
* Update a note
|
|
651
|
+
*
|
|
652
|
+
* Update the text of a workspace-owned note. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
653
|
+
*/
|
|
654
|
+
updateNote(options) {
|
|
655
|
+
return (options.client ?? this.client).patch({
|
|
656
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
657
|
+
url: '/api/v2/me/notes/{id}',
|
|
658
|
+
...options,
|
|
659
|
+
headers: {
|
|
660
|
+
'Content-Type': 'application/json',
|
|
661
|
+
...options.headers
|
|
662
|
+
}
|
|
663
|
+
});
|
|
664
|
+
}
|
|
665
|
+
/**
|
|
666
|
+
* List my own records
|
|
667
|
+
*
|
|
668
|
+
* Return a cursor page of workspace own records ordered by name. Ambiguous records retain their candidate IDs. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
669
|
+
*/
|
|
670
|
+
listOwnRecords(options) {
|
|
671
|
+
return (options?.client ?? this.client).get({
|
|
672
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
673
|
+
url: '/api/v2/me/own-records',
|
|
674
|
+
...options
|
|
675
|
+
});
|
|
676
|
+
}
|
|
677
|
+
/**
|
|
678
|
+
* Create an own record
|
|
679
|
+
*
|
|
680
|
+
* Create a workspace own record with its supplied details, or reuse one with the same normalized name. Ambiguous register candidates are retained. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
681
|
+
*/
|
|
682
|
+
createOwnRecord(options) {
|
|
683
|
+
return (options.client ?? this.client).post({
|
|
684
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
685
|
+
url: '/api/v2/me/own-records',
|
|
686
|
+
...options,
|
|
687
|
+
headers: {
|
|
688
|
+
'Content-Type': 'application/json',
|
|
689
|
+
...options.headers
|
|
690
|
+
}
|
|
691
|
+
});
|
|
692
|
+
}
|
|
693
|
+
/**
|
|
694
|
+
* Delete an own record
|
|
695
|
+
*
|
|
696
|
+
* Delete a workspace own record and remove it from every list. Register records are not deleted. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
697
|
+
*/
|
|
698
|
+
deleteOwnRecord(options) {
|
|
699
|
+
return (options.client ?? this.client).delete({
|
|
700
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
701
|
+
url: '/api/v2/me/own-records/{id}',
|
|
702
|
+
...options
|
|
703
|
+
});
|
|
704
|
+
}
|
|
705
|
+
/**
|
|
706
|
+
* Get an own record
|
|
707
|
+
*
|
|
708
|
+
* Return an own record in the caller's workspace. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
709
|
+
*/
|
|
710
|
+
getOwnRecord(options) {
|
|
711
|
+
return (options.client ?? this.client).get({
|
|
712
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
713
|
+
url: '/api/v2/me/own-records/{id}',
|
|
714
|
+
...options
|
|
715
|
+
});
|
|
716
|
+
}
|
|
717
|
+
/**
|
|
718
|
+
* Update an own record
|
|
719
|
+
*
|
|
720
|
+
* Update a workspace own record's name, note, workspace field values and Firmenakte field values (sourceValues). Omitted values keep theirs; changes are visible on every list. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
721
|
+
*/
|
|
722
|
+
updateOwnRecord(options) {
|
|
723
|
+
return (options.client ?? this.client).patch({
|
|
724
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
725
|
+
url: '/api/v2/me/own-records/{id}',
|
|
726
|
+
...options,
|
|
727
|
+
headers: {
|
|
728
|
+
'Content-Type': 'application/json',
|
|
729
|
+
...options.headers
|
|
730
|
+
}
|
|
731
|
+
});
|
|
732
|
+
}
|
|
733
|
+
/**
|
|
734
|
+
* List exports
|
|
735
|
+
*
|
|
736
|
+
* Read this workspace's export jobs, newest first. Foreign IDs are not found. Cursor-paged collections; free; private, no-store.
|
|
737
|
+
*/
|
|
738
|
+
listExports(options) {
|
|
739
|
+
return (options?.client ?? this.client).get({
|
|
740
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
741
|
+
url: '/api/v2/me/exports',
|
|
742
|
+
...options
|
|
743
|
+
});
|
|
744
|
+
}
|
|
745
|
+
/**
|
|
746
|
+
* Start an export
|
|
747
|
+
*
|
|
748
|
+
* Freeze a list or query selection now and write its values in the background. All entries, including workspace own records, are exported in bounded pages without a row cap. Defaults to the list's columns or name, city, industry and registration date. people exports one row per person of a query with subject person and no listId. Sessions and metered keys pay the export_rows price per begun 1,000 frozen rows, at least the export_minimum price (current values: prices.exportRows and prices.exportMinimum in GET /api/v2/me/credits); failed jobs are refunded. Poll Location for rowsDone of rows; completed files expire after 24 hours. Optional Idempotency-Key replays the same job free.
|
|
749
|
+
*/
|
|
750
|
+
createExport(options) {
|
|
751
|
+
return (options.client ?? this.client).post({
|
|
752
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
753
|
+
url: '/api/v2/me/exports',
|
|
754
|
+
...options,
|
|
755
|
+
headers: {
|
|
756
|
+
'Content-Type': 'application/json',
|
|
757
|
+
...options.headers
|
|
758
|
+
}
|
|
759
|
+
});
|
|
760
|
+
}
|
|
761
|
+
/**
|
|
762
|
+
* Get an export
|
|
763
|
+
*
|
|
764
|
+
* Read this workspace's export jobs, newest first. Foreign IDs are not found. Cursor-paged collections; free; private, no-store.
|
|
765
|
+
*/
|
|
766
|
+
getExport(options) {
|
|
767
|
+
return (options.client ?? this.client).get({
|
|
768
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
769
|
+
url: '/api/v2/me/exports/{id}',
|
|
770
|
+
...options
|
|
771
|
+
});
|
|
772
|
+
}
|
|
773
|
+
/**
|
|
774
|
+
* Download an export file
|
|
775
|
+
*
|
|
776
|
+
* Stream the immutable CSV or XLSX belonging to this workspace, within 24 hours of completion. Foreign IDs are not found. Free; private, no-store. Errors remain problem JSON.
|
|
777
|
+
*/
|
|
778
|
+
getExportFile(options) {
|
|
779
|
+
return (options.client ?? this.client).get({
|
|
780
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
781
|
+
url: '/api/v2/me/exports/{id}/file',
|
|
782
|
+
...options
|
|
783
|
+
});
|
|
784
|
+
}
|
|
785
|
+
/**
|
|
786
|
+
* Set notification channels atomically
|
|
787
|
+
*
|
|
788
|
+
* Save both channel settings atomically using reviewed rule IDs and revisions, or explicit nulls for absent channels. A concurrent change returns 409. Re-enabling starts at the current event horizon. Free. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
789
|
+
*/
|
|
790
|
+
setNotificationRules(options) {
|
|
791
|
+
return (options.client ?? this.client).put({
|
|
792
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
793
|
+
url: '/api/v2/me/lists/{id}/notification-rules',
|
|
794
|
+
...options,
|
|
795
|
+
headers: {
|
|
796
|
+
'Content-Type': 'application/json',
|
|
797
|
+
...options.headers
|
|
798
|
+
}
|
|
799
|
+
});
|
|
800
|
+
}
|
|
801
|
+
/**
|
|
802
|
+
* List my notifications
|
|
803
|
+
*
|
|
804
|
+
* Personal notifications and read status, scoped to the dashboard session and workspace. Summarised per list run; skipped-credit warnings need no action. Cursor-paged with unread and all counters; suppressed subjects stay hidden. Free. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
805
|
+
*
|
|
806
|
+
* @deprecated
|
|
807
|
+
*/
|
|
808
|
+
listNotifications(options) {
|
|
809
|
+
return (options?.client ?? this.client).get({
|
|
810
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
811
|
+
url: '/api/v2/me/notifications',
|
|
812
|
+
...options
|
|
813
|
+
});
|
|
814
|
+
}
|
|
815
|
+
/**
|
|
816
|
+
* Mark my notifications read
|
|
817
|
+
*
|
|
818
|
+
* Personal notifications and read status, scoped to the dashboard session and workspace. Summarised per list run; skipped-credit warnings need no action. Cursor-paged with unread and all counters; suppressed subjects stay hidden. Free. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
819
|
+
*
|
|
820
|
+
* @deprecated
|
|
821
|
+
*/
|
|
822
|
+
markNotificationsRead(options) {
|
|
823
|
+
return (options.client ?? this.client).post({
|
|
824
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
825
|
+
url: '/api/v2/me/notifications/read',
|
|
826
|
+
...options,
|
|
827
|
+
headers: {
|
|
828
|
+
'Content-Type': 'application/json',
|
|
829
|
+
...options.headers
|
|
830
|
+
}
|
|
831
|
+
});
|
|
832
|
+
}
|
|
833
|
+
/**
|
|
834
|
+
* Get my daily digest settings
|
|
835
|
+
*
|
|
836
|
+
* Dashboard-session digest settings: enabled, at (HH:mm), timezone and to (the user's own address). Defaults: enabled, 07:00 Europe/Vienna. next contains the distinct-subject count and cursor-paged list totals. Disabling discards pending entries. A sent email costs one workspace credit. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
837
|
+
*
|
|
838
|
+
* @deprecated
|
|
839
|
+
*/
|
|
840
|
+
getDigestSettings(options) {
|
|
841
|
+
return (options?.client ?? this.client).get({
|
|
842
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
843
|
+
url: '/api/v2/me/digest',
|
|
844
|
+
...options
|
|
845
|
+
});
|
|
846
|
+
}
|
|
847
|
+
/**
|
|
848
|
+
* Update my daily digest settings
|
|
849
|
+
*
|
|
850
|
+
* Dashboard-session digest settings: enabled, at (HH:mm), timezone and to (the user's own address). Defaults: enabled, 07:00 Europe/Vienna. next contains the distinct-subject count and cursor-paged list totals. Disabling discards pending entries. A sent email costs one workspace credit. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.
|
|
851
|
+
*
|
|
852
|
+
* @deprecated
|
|
853
|
+
*/
|
|
854
|
+
updateDigestSettings(options) {
|
|
855
|
+
return (options.client ?? this.client).put({
|
|
856
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
857
|
+
url: '/api/v2/me/digest',
|
|
858
|
+
...options,
|
|
859
|
+
headers: {
|
|
860
|
+
'Content-Type': 'application/json',
|
|
861
|
+
...options.headers
|
|
862
|
+
}
|
|
863
|
+
});
|
|
864
|
+
}
|
|
865
|
+
/**
|
|
866
|
+
* Get my account
|
|
867
|
+
*
|
|
868
|
+
* Read or manage the credential's workspace. Responses are private, no-store and cost no credits. Accepts an API key or a dashboard session.
|
|
869
|
+
*/
|
|
870
|
+
getMe(options) {
|
|
871
|
+
return (options?.client ?? this.client).get({
|
|
872
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
873
|
+
url: '/api/v2/me',
|
|
874
|
+
...options
|
|
875
|
+
});
|
|
876
|
+
}
|
|
877
|
+
/**
|
|
878
|
+
* Get my credits
|
|
879
|
+
*
|
|
880
|
+
* Read or manage the credential's workspace. Responses are private, no-store and cost no credits. Accepts an API key or a dashboard session.
|
|
881
|
+
*/
|
|
882
|
+
getCredits(options) {
|
|
883
|
+
return (options?.client ?? this.client).get({
|
|
884
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
885
|
+
url: '/api/v2/me/credits',
|
|
886
|
+
...options
|
|
887
|
+
});
|
|
888
|
+
}
|
|
889
|
+
/**
|
|
890
|
+
* List my API keys
|
|
891
|
+
*
|
|
892
|
+
* Read or manage the credential's workspace. Responses are private, no-store and cost no credits. A dashboard session is required; an API key receives session_required.
|
|
893
|
+
*
|
|
894
|
+
* @deprecated
|
|
895
|
+
*/
|
|
896
|
+
listApiKeys(options) {
|
|
897
|
+
return (options?.client ?? this.client).get({
|
|
898
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
899
|
+
url: '/api/v2/me/api-keys',
|
|
900
|
+
...options
|
|
901
|
+
});
|
|
902
|
+
}
|
|
903
|
+
/**
|
|
904
|
+
* Create an API key
|
|
905
|
+
*
|
|
906
|
+
* Read or manage the credential's workspace. Responses are private, no-store and cost no credits. A dashboard session is required; an API key receives session_required.
|
|
907
|
+
*
|
|
908
|
+
* @deprecated
|
|
909
|
+
*/
|
|
910
|
+
createApiKey(options) {
|
|
911
|
+
return (options.client ?? this.client).post({
|
|
912
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
913
|
+
url: '/api/v2/me/api-keys',
|
|
914
|
+
...options,
|
|
915
|
+
headers: {
|
|
916
|
+
'Content-Type': 'application/json',
|
|
917
|
+
...options.headers
|
|
918
|
+
}
|
|
919
|
+
});
|
|
920
|
+
}
|
|
921
|
+
/**
|
|
922
|
+
* Delete an API key
|
|
923
|
+
*
|
|
924
|
+
* Read or manage the credential's workspace. Responses are private, no-store and cost no credits. A dashboard session is required; an API key receives session_required.
|
|
925
|
+
*
|
|
926
|
+
* @deprecated
|
|
927
|
+
*/
|
|
928
|
+
deleteApiKey(options) {
|
|
929
|
+
return (options.client ?? this.client).delete({
|
|
930
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
931
|
+
url: '/api/v2/me/api-keys/{id}',
|
|
932
|
+
...options
|
|
933
|
+
});
|
|
934
|
+
}
|
|
935
|
+
/**
|
|
936
|
+
* Check an EU or XI VAT number
|
|
937
|
+
*
|
|
938
|
+
* Prüft eine UID / Umsatzsteuer-Identifikationsnummer (VAT number) aus der EU oder Nordirland über VIES. Use check_uid for validity, not company search or resolve_companies. Returns verification with status valid or invalid, source and original verifiedAt; definitive results are reused for five minutes. Company matching is independent: no match does not mean invalid. Technical failures return an error, never invalid or a historical result as current. Uses the regular basic credit rate, including cached results; no confirmation required. Costs one credit for keys; sessions follow regular session pricing. Responses are private, no-store. Optional Idempotency-Key replays the original result for 24 hours; use a new key for a new check.
|
|
939
|
+
*/
|
|
940
|
+
checkUid(options) {
|
|
941
|
+
return (options.client ?? this.client).post({
|
|
942
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
943
|
+
url: '/api/v2/uid-checks',
|
|
944
|
+
...options,
|
|
945
|
+
headers: {
|
|
946
|
+
'Content-Type': 'application/json',
|
|
947
|
+
...options.headers
|
|
948
|
+
}
|
|
949
|
+
});
|
|
950
|
+
}
|
|
951
|
+
/**
|
|
952
|
+
* List people
|
|
953
|
+
*
|
|
954
|
+
* Read public person data. Birth dates, birth years and ages are never exposed. Collections use keyset cursors expiring after 24 hours. Includes embed the first 25 and continue on their own path. Key or session required; ETag and private, no-cache. Costs one credit for keys, except the free names index.
|
|
955
|
+
*/
|
|
956
|
+
listPeople(options) {
|
|
957
|
+
return (options?.client ?? this.client).get({
|
|
958
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
959
|
+
url: '/api/v2/people',
|
|
960
|
+
...options
|
|
961
|
+
});
|
|
962
|
+
}
|
|
963
|
+
/**
|
|
964
|
+
* Search people
|
|
965
|
+
*
|
|
966
|
+
* Read public person data. Birth dates, birth years and ages are never exposed. Collections use keyset cursors expiring after 24 hours. Includes embed the first 25 and continue on their own path. Key or session required; ETag and private, no-cache. Costs one credit for keys, except the free names index.
|
|
967
|
+
*/
|
|
968
|
+
searchPeople(options) {
|
|
969
|
+
return (options.client ?? this.client).post({
|
|
970
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
971
|
+
url: '/api/v2/people/search',
|
|
972
|
+
...options,
|
|
973
|
+
headers: {
|
|
974
|
+
'Content-Type': 'application/json',
|
|
975
|
+
...options.headers
|
|
976
|
+
}
|
|
977
|
+
});
|
|
978
|
+
}
|
|
979
|
+
/**
|
|
980
|
+
* List person names
|
|
981
|
+
*
|
|
982
|
+
* Read public person data. Birth dates, birth years and ages are never exposed. Collections use keyset cursors expiring after 24 hours. Includes embed the first 25 and continue on their own path. Key or session required; ETag and private, no-cache. Costs one credit for keys, except the free names index.
|
|
983
|
+
*/
|
|
984
|
+
listPersonNames(options) {
|
|
985
|
+
return (options?.client ?? this.client).get({
|
|
986
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
987
|
+
url: '/api/v2/people/names',
|
|
988
|
+
...options
|
|
989
|
+
});
|
|
990
|
+
}
|
|
991
|
+
/**
|
|
992
|
+
* Get a person
|
|
993
|
+
*
|
|
994
|
+
* Read public person data. Birth dates, birth years and ages are never exposed. Collections use keyset cursors expiring after 24 hours. Includes embed the first 25 and continue on their own path. Key or session required; ETag and private, no-cache. Costs one credit for keys, except the free names index.
|
|
995
|
+
*/
|
|
996
|
+
getPerson(options) {
|
|
997
|
+
return (options.client ?? this.client).get({
|
|
998
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
999
|
+
url: '/api/v2/people/{id}',
|
|
1000
|
+
...options
|
|
1001
|
+
});
|
|
1002
|
+
}
|
|
1003
|
+
/**
|
|
1004
|
+
* List person functions
|
|
1005
|
+
*
|
|
1006
|
+
* Read public person data. Birth dates, birth years and ages are never exposed. Collections use keyset cursors expiring after 24 hours. Includes embed the first 25 and continue on their own path. Key or session required; ETag and private, no-cache. Costs one credit for keys, except the free names index.
|
|
1007
|
+
*/
|
|
1008
|
+
listPersonFunctions(options) {
|
|
1009
|
+
return (options.client ?? this.client).get({
|
|
1010
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1011
|
+
url: '/api/v2/people/{id}/functions',
|
|
1012
|
+
...options
|
|
1013
|
+
});
|
|
1014
|
+
}
|
|
1015
|
+
/**
|
|
1016
|
+
* List person licenses
|
|
1017
|
+
*
|
|
1018
|
+
* Read public person data. Birth dates, birth years and ages are never exposed. Collections use keyset cursors expiring after 24 hours. Includes embed the first 25 and continue on their own path. Key or session required; ETag and private, no-cache. Costs one credit for keys, except the free names index.
|
|
1019
|
+
*/
|
|
1020
|
+
listPersonLicenses(options) {
|
|
1021
|
+
return (options.client ?? this.client).get({
|
|
1022
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1023
|
+
url: '/api/v2/people/{id}/licenses',
|
|
1024
|
+
...options
|
|
1025
|
+
});
|
|
1026
|
+
}
|
|
1027
|
+
/**
|
|
1028
|
+
* List person notices
|
|
1029
|
+
*
|
|
1030
|
+
* Read public person data. Birth dates, birth years and ages are never exposed. Collections use keyset cursors expiring after 24 hours. Includes embed the first 25 and continue on their own path. Key or session required; ETag and private, no-cache. Costs one credit for keys, except the free names index.
|
|
1031
|
+
*/
|
|
1032
|
+
listPersonNotices(options) {
|
|
1033
|
+
return (options.client ?? this.client).get({
|
|
1034
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1035
|
+
url: '/api/v2/people/{id}/notices',
|
|
1036
|
+
...options
|
|
1037
|
+
});
|
|
1038
|
+
}
|
|
1039
|
+
/**
|
|
1040
|
+
* List professional registrations
|
|
1041
|
+
*
|
|
1042
|
+
* Read public person data. Birth dates, birth years and ages are never exposed. Collections use keyset cursors expiring after 24 hours. Includes embed the first 25 and continue on their own path. Key or session required; ETag and private, no-cache. Costs one credit for keys, except the free names index.
|
|
1043
|
+
*/
|
|
1044
|
+
listPersonRegistrations(options) {
|
|
1045
|
+
return (options.client ?? this.client).get({
|
|
1046
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1047
|
+
url: '/api/v2/people/{id}/registrations',
|
|
1048
|
+
...options
|
|
1049
|
+
});
|
|
1050
|
+
}
|
|
1051
|
+
/**
|
|
1052
|
+
* Get a company
|
|
1053
|
+
*
|
|
1054
|
+
* Read a company by Firmenakte-ID or register alias. Aliases and merged identities resolve without redirects. Costs 1 credit; a conditional 304 is free. Dashboard sessions retain their existing price.
|
|
1055
|
+
*/
|
|
1056
|
+
getCompany(options) {
|
|
1057
|
+
return (options.client ?? this.client).get({
|
|
1058
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1059
|
+
url: '/api/v2/companies/{id}',
|
|
1060
|
+
...options
|
|
1061
|
+
});
|
|
1062
|
+
}
|
|
1063
|
+
/**
|
|
1064
|
+
* Get an entity
|
|
1065
|
+
*
|
|
1066
|
+
* Read a company or person by Firmenakte-ID or register alias. A person answer carries no birth date, birth year or age. Costs 1 credit; a conditional 304 is free.
|
|
1067
|
+
*/
|
|
1068
|
+
getEntity(options) {
|
|
1069
|
+
return (options.client ?? this.client).get({
|
|
1070
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1071
|
+
url: '/api/v2/entities/{id}',
|
|
1072
|
+
...options
|
|
1073
|
+
});
|
|
1074
|
+
}
|
|
1075
|
+
/**
|
|
1076
|
+
* Search companies
|
|
1077
|
+
*
|
|
1078
|
+
* Search companies using a nested filter tree. Keyset cursors bind filter and sort and expire after 24 hours. Costs 1 credit, including cache hits. Use limit 0 for a count; limits above 100 are clamped.
|
|
1079
|
+
*/
|
|
1080
|
+
searchCompanies(options) {
|
|
1081
|
+
return (options.client ?? this.client).post({
|
|
1082
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1083
|
+
url: '/api/v2/companies/search',
|
|
1084
|
+
...options,
|
|
1085
|
+
headers: {
|
|
1086
|
+
'Content-Type': 'application/json',
|
|
1087
|
+
...options.headers
|
|
1088
|
+
}
|
|
1089
|
+
});
|
|
1090
|
+
}
|
|
1091
|
+
/**
|
|
1092
|
+
* List companies
|
|
1093
|
+
*
|
|
1094
|
+
* The same operation as POST companies/search with q, place, status, legalForm, industry, trade and court as query parameters. No where or figures query parameters. Sort -revenue means descending figures.revenue. Keyset cursors bind filter and sort. Costs one credit for keys, including cache hits; conditional 304 is free.
|
|
1095
|
+
*/
|
|
1096
|
+
listCompanies(options) {
|
|
1097
|
+
return (options?.client ?? this.client).get({
|
|
1098
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1099
|
+
url: '/api/v2/companies',
|
|
1100
|
+
...options
|
|
1101
|
+
});
|
|
1102
|
+
}
|
|
1103
|
+
/**
|
|
1104
|
+
* Aggregate companies
|
|
1105
|
+
*
|
|
1106
|
+
* Count the complete filtered company set. Omit groupBy and metrics, or use empty arrays, for total with groups: []. An empty request counts all visible companies. Optional grouping uses legalForm, industry, city, zip, state or court; each group includes total, ungrouped and buckets. Optional metrics sum, average, min or max a catalog key figure across the complete filter, with known/missing counts; latest figure dates may differ. excludeOwnFilter removes each dimension's filters for facet counts. Short fields compile into the same filter tree. Account filters return 422 and point to POST /me/search/aggregate. Costs one credit for keys.
|
|
1107
|
+
*/
|
|
1108
|
+
aggregateCompanies(options) {
|
|
1109
|
+
return (options.client ?? this.client).post({
|
|
1110
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1111
|
+
url: '/api/v2/companies/aggregate',
|
|
1112
|
+
...options,
|
|
1113
|
+
headers: {
|
|
1114
|
+
'Content-Type': 'application/json',
|
|
1115
|
+
...options.headers
|
|
1116
|
+
}
|
|
1117
|
+
});
|
|
1118
|
+
}
|
|
1119
|
+
/**
|
|
1120
|
+
* Find the leading company per place
|
|
1121
|
+
*
|
|
1122
|
+
* Find the leader per state or city by a figures field, with a map location and the metric year. City groups are capped to the sixteen largest by company count. Short fields compile into the same filter tree. Account filters return 422 and point to POST /me/search/aggregate. Costs one credit for keys.
|
|
1123
|
+
*/
|
|
1124
|
+
topCompanies(options) {
|
|
1125
|
+
return (options.client ?? this.client).post({
|
|
1126
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1127
|
+
url: '/api/v2/companies/top',
|
|
1128
|
+
...options,
|
|
1129
|
+
headers: {
|
|
1130
|
+
'Content-Type': 'application/json',
|
|
1131
|
+
...options.headers
|
|
1132
|
+
}
|
|
1133
|
+
});
|
|
1134
|
+
}
|
|
1135
|
+
/**
|
|
1136
|
+
* Get a catalog
|
|
1137
|
+
*
|
|
1138
|
+
* Read legal-forms, oenace, trades, courts, functions, key-figures, registers, change-types or places. Every entry carries its parentCode, level, childCount and ancestor path; parent= reads one node's children and level= one level. refCount counts the visible companies under a value (current assignments for functions) as of the last refresh; static catalogues carry none. Without q, entries are ordered by refCount, then code. Register entries document field-detail coverage and unknown historical starts; change types carry German labels. Entries contain codes and German labels, never storage fields. Free for keys and sessions; supports ETag and free conditional 304. Cursor paging defaults to 25 and clamps to 100.
|
|
1139
|
+
*/
|
|
1140
|
+
getCatalog(options) {
|
|
1141
|
+
return (options.client ?? this.client).get({
|
|
1142
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1143
|
+
url: '/api/v2/catalogs/{name}',
|
|
1144
|
+
...options
|
|
1145
|
+
});
|
|
1146
|
+
}
|
|
1147
|
+
/**
|
|
1148
|
+
* Search places
|
|
1149
|
+
*
|
|
1150
|
+
* Search state, municipality, city and zip vocabulary by code, label or slug. States, municipalities and Austrian zip codes carry their place in the places catalogue (parentCode, level, childCount, path); every entry carries its company count as refCount. Free for keys and sessions; supports ETag and free conditional 304. Cursor paging defaults to 25 and clamps to 100.
|
|
1151
|
+
*/
|
|
1152
|
+
searchPlaces(options) {
|
|
1153
|
+
return (options?.client ?? this.client).get({
|
|
1154
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1155
|
+
url: '/api/v2/places',
|
|
1156
|
+
...options
|
|
1157
|
+
});
|
|
1158
|
+
}
|
|
1159
|
+
/**
|
|
1160
|
+
* List the field catalog
|
|
1161
|
+
*
|
|
1162
|
+
* Returns a page of field definitions with German labels, groups, capabilities, operators and options. Use filterable=true and scope=public to discover fields for search_companies, aggregate_companies and search_people; display-only columns have filterable=false. Browse group=figures for financial metrics or q=seat. for company location fields. Select subject person for person filters. q searches field metadata, not company names or location values; use search_places for places and get_catalog for industry or other catalog values. Account fields describe templates, not workspace definitions. Free for keys and sessions; supports ETag and conditional 304.
|
|
1163
|
+
*/
|
|
1164
|
+
listFieldCatalog(options) {
|
|
1165
|
+
return (options?.client ?? this.client).get({
|
|
1166
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1167
|
+
url: '/api/v2/catalogs/fields',
|
|
1168
|
+
...options
|
|
1169
|
+
});
|
|
1170
|
+
}
|
|
1171
|
+
/**
|
|
1172
|
+
* List company accounts
|
|
1173
|
+
*
|
|
1174
|
+
* Read company accounts. Cursor paging defaults to 25 and clamps to 100. nextCursor continues include=accounts on this path. Cursors bind the company and filters, expire after 24 hours, and reject changed filters. Costs one credit for keys; conditional 304 is free.
|
|
1175
|
+
*/
|
|
1176
|
+
listCompanyAccounts(options) {
|
|
1177
|
+
return (options.client ?? this.client).get({
|
|
1178
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1179
|
+
url: '/api/v2/companies/{id}/accounts',
|
|
1180
|
+
...options
|
|
1181
|
+
});
|
|
1182
|
+
}
|
|
1183
|
+
/**
|
|
1184
|
+
* List company people
|
|
1185
|
+
*
|
|
1186
|
+
* Functions that have not ended come first, on the Vienna calendar day. current=true returns functions that have started and not ended (inclusive dates; absent bounds are open). Firmenbuch and EVI relationships reconcile distinct roles and subscribed capital, supported sharePercent and source-owned evidence. Unknown percentages are omitted. Cursor paging defaults to 25, clamps to 100 and continues include=people. Costs one credit for keys; conditional 304 is free.
|
|
1187
|
+
*/
|
|
1188
|
+
listCompanyPeople(options) {
|
|
1189
|
+
return (options.client ?? this.client).get({
|
|
1190
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1191
|
+
url: '/api/v2/companies/{id}/people',
|
|
1192
|
+
...options
|
|
1193
|
+
});
|
|
1194
|
+
}
|
|
1195
|
+
/**
|
|
1196
|
+
* List company licenses
|
|
1197
|
+
*
|
|
1198
|
+
* Read company licenses. Cursor paging defaults to 25 and clamps to 100. nextCursor continues include=licenses on this path. Cursors bind the company and filters, expire after 24 hours, and reject changed filters. Costs one credit for keys; conditional 304 is free.
|
|
1199
|
+
*/
|
|
1200
|
+
listCompanyLicenses(options) {
|
|
1201
|
+
return (options.client ?? this.client).get({
|
|
1202
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1203
|
+
url: '/api/v2/companies/{id}/licenses',
|
|
1204
|
+
...options
|
|
1205
|
+
});
|
|
1206
|
+
}
|
|
1207
|
+
/**
|
|
1208
|
+
* List company notices
|
|
1209
|
+
*
|
|
1210
|
+
* Read company notices. Cursor paging defaults to 25 and clamps to 100. nextCursor continues include=notices on this path. Cursors bind the company and filters, expire after 24 hours, and reject changed filters. Costs one credit for keys; conditional 304 is free.
|
|
1211
|
+
*/
|
|
1212
|
+
listCompanyNotices(options) {
|
|
1213
|
+
return (options.client ?? this.client).get({
|
|
1214
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1215
|
+
url: '/api/v2/companies/{id}/notices',
|
|
1216
|
+
...options
|
|
1217
|
+
});
|
|
1218
|
+
}
|
|
1219
|
+
/**
|
|
1220
|
+
* List company documents
|
|
1221
|
+
*
|
|
1222
|
+
* Read company documents. Cursor paging defaults to 25 and clamps to 100. nextCursor continues include=documents on this path. Cursors bind the company and filters, expire after 24 hours, and reject changed filters. Costs one credit for keys; conditional 304 is free.
|
|
1223
|
+
*/
|
|
1224
|
+
listCompanyDocuments(options) {
|
|
1225
|
+
return (options.client ?? this.client).get({
|
|
1226
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1227
|
+
url: '/api/v2/companies/{id}/documents',
|
|
1228
|
+
...options
|
|
1229
|
+
});
|
|
1230
|
+
}
|
|
1231
|
+
/**
|
|
1232
|
+
* List company filings
|
|
1233
|
+
*
|
|
1234
|
+
* Read company filings. Cursor paging defaults to 25 and clamps to 100. nextCursor continues include=filings on this path. Cursors bind the company and filters, expire after 24 hours, and reject changed filters. Costs one credit for keys; conditional 304 is free.
|
|
1235
|
+
*/
|
|
1236
|
+
listCompanyFilings(options) {
|
|
1237
|
+
return (options.client ?? this.client).get({
|
|
1238
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1239
|
+
url: '/api/v2/companies/{id}/filings',
|
|
1240
|
+
...options
|
|
1241
|
+
});
|
|
1242
|
+
}
|
|
1243
|
+
/**
|
|
1244
|
+
* List company addresses
|
|
1245
|
+
*
|
|
1246
|
+
* Read company addresses. Cursor paging defaults to 25 and clamps to 100. nextCursor continues include=addresses on this path. Cursors bind the company and filters, expire after 24 hours, and reject changed filters. Costs one credit for keys; conditional 304 is free.
|
|
1247
|
+
*/
|
|
1248
|
+
listCompanyAddresses(options) {
|
|
1249
|
+
return (options.client ?? this.client).get({
|
|
1250
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1251
|
+
url: '/api/v2/companies/{id}/addresses',
|
|
1252
|
+
...options
|
|
1253
|
+
});
|
|
1254
|
+
}
|
|
1255
|
+
/**
|
|
1256
|
+
* List company industries
|
|
1257
|
+
*
|
|
1258
|
+
* Read company industries. Cursor paging defaults to 25 and clamps to 100. nextCursor continues include=industries on this path. Cursors bind the company and filters, expire after 24 hours, and reject changed filters. Costs one credit for keys; conditional 304 is free.
|
|
1259
|
+
*/
|
|
1260
|
+
listCompanyIndustries(options) {
|
|
1261
|
+
return (options.client ?? this.client).get({
|
|
1262
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1263
|
+
url: '/api/v2/companies/{id}/industries',
|
|
1264
|
+
...options
|
|
1265
|
+
});
|
|
1266
|
+
}
|
|
1267
|
+
/**
|
|
1268
|
+
* List company funding
|
|
1269
|
+
*
|
|
1270
|
+
* Read company funding. Cursor paging defaults to 25 and clamps to 100. nextCursor continues include=funding on this path. Cursors bind the company and filters, expire after 24 hours, and reject changed filters. Costs one credit for keys; conditional 304 is free.
|
|
1271
|
+
*/
|
|
1272
|
+
listCompanyFunding(options) {
|
|
1273
|
+
return (options.client ?? this.client).get({
|
|
1274
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1275
|
+
url: '/api/v2/companies/{id}/funding',
|
|
1276
|
+
...options
|
|
1277
|
+
});
|
|
1278
|
+
}
|
|
1279
|
+
/**
|
|
1280
|
+
* List company names
|
|
1281
|
+
*
|
|
1282
|
+
* Authenticated, free index of canonical company IDs, Firmenbuchnummern and names. Keyset paging defaults to 25 and clamps to 5000; supports ETag and free conditional 304.
|
|
1283
|
+
*/
|
|
1284
|
+
listCompanyNames(options) {
|
|
1285
|
+
return (options?.client ?? this.client).get({
|
|
1286
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1287
|
+
url: '/api/v2/companies/names',
|
|
1288
|
+
...options
|
|
1289
|
+
});
|
|
1290
|
+
}
|
|
1291
|
+
/**
|
|
1292
|
+
* Get a batch of companies
|
|
1293
|
+
*
|
|
1294
|
+
* Read up to 100 company IDs or aliases in request order. Each ok or merged item costs one credit; ambiguous and notFound items are free. Sessions retain their dashboard price.
|
|
1295
|
+
*/
|
|
1296
|
+
batchGetCompanies(options) {
|
|
1297
|
+
return (options.client ?? this.client).post({
|
|
1298
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1299
|
+
url: '/api/v2/companies/batch-get',
|
|
1300
|
+
...options,
|
|
1301
|
+
headers: {
|
|
1302
|
+
'Content-Type': 'application/json',
|
|
1303
|
+
...options.headers
|
|
1304
|
+
}
|
|
1305
|
+
});
|
|
1306
|
+
}
|
|
1307
|
+
/**
|
|
1308
|
+
* Resolve company names
|
|
1309
|
+
*
|
|
1310
|
+
* Resolve up to 100 company/person inputs with name, address, country, UID, registry, fnr or akteId. Identifiers and unique exact names match automatically; search candidates are always ambiguous, never auto-linked. Foreign companies and people without an akteId are unmatched. minConfidence is retained for compatibility but does not auto-link fuzzy candidates. CSV import and form suggestions use this same operation. Costs one credit for keys.
|
|
1311
|
+
*/
|
|
1312
|
+
resolveCompanies(options) {
|
|
1313
|
+
return (options.client ?? this.client).post({
|
|
1314
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1315
|
+
url: '/api/v2/companies/resolve',
|
|
1316
|
+
...options,
|
|
1317
|
+
headers: {
|
|
1318
|
+
'Content-Type': 'application/json',
|
|
1319
|
+
...options.headers
|
|
1320
|
+
}
|
|
1321
|
+
});
|
|
1322
|
+
}
|
|
1323
|
+
/**
|
|
1324
|
+
* Get a company's network
|
|
1325
|
+
*
|
|
1326
|
+
* The shared Firmenbuch and EVI network, with canonical company/person node IDs and assignment, ownership and address edges. Depth 1 matches the existing graph, depths 2 and 3 read further layers, preserving node limits. Includes supported shares and provenance. Costs three credits for keys; conditional 304 is free.
|
|
1327
|
+
*/
|
|
1328
|
+
getCompanyNetwork(options) {
|
|
1329
|
+
return (options.client ?? this.client).get({
|
|
1330
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1331
|
+
url: '/api/v2/companies/{id}/network',
|
|
1332
|
+
...options
|
|
1333
|
+
});
|
|
1334
|
+
}
|
|
1335
|
+
/**
|
|
1336
|
+
* List similar companies
|
|
1337
|
+
*
|
|
1338
|
+
* The bounded similarity neighbourhood from the existing network, industry and location matcher. Cursor-paged, costs three credits for keys; conditional 304 is free.
|
|
1339
|
+
*/
|
|
1340
|
+
listSimilarCompanies(options) {
|
|
1341
|
+
return (options.client ?? this.client).get({
|
|
1342
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1343
|
+
url: '/api/v2/companies/{id}/similar',
|
|
1344
|
+
...options
|
|
1345
|
+
});
|
|
1346
|
+
}
|
|
1347
|
+
/**
|
|
1348
|
+
* Download a Firmenbuch document
|
|
1349
|
+
*
|
|
1350
|
+
* Download register file content without workspace data. Firmenbuch documents are PDF or XML; GISA extracts are signed German PDFs. Costs the expensive-class price (3 credits); failed reads and matching conditional 304s are free. ETag and private, no-cache; errors remain problem JSON.
|
|
1351
|
+
*/
|
|
1352
|
+
getDocumentContent(options) {
|
|
1353
|
+
return (options.client ?? this.client).get({
|
|
1354
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1355
|
+
url: '/api/v2/documents/{key}/content',
|
|
1356
|
+
...options
|
|
1357
|
+
});
|
|
1358
|
+
}
|
|
1359
|
+
/**
|
|
1360
|
+
* Download a GISA extract
|
|
1361
|
+
*
|
|
1362
|
+
* Download register file content without workspace data. Firmenbuch documents are PDF or XML; GISA extracts are signed German PDFs. Costs the expensive-class price (3 credits); failed reads and matching conditional 304s are free. ETag and private, no-cache; errors remain problem JSON.
|
|
1363
|
+
*/
|
|
1364
|
+
getLicenseExtract(options) {
|
|
1365
|
+
return (options.client ?? this.client).get({
|
|
1366
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1367
|
+
url: '/api/v2/licenses/{gisaNumber}/extract',
|
|
1368
|
+
...options
|
|
1369
|
+
});
|
|
1370
|
+
}
|
|
1371
|
+
/**
|
|
1372
|
+
* Search companies and people
|
|
1373
|
+
*
|
|
1374
|
+
* Rank companies and people together by where q sits in the name, then name length, companies before people, name and ID. Accepts types=company,person. Key or session required; one credit for keys, ETag and private, no-cache. No account data or search history is read or written. Cursors bind query and types and expire after 24 hours.
|
|
1375
|
+
*/
|
|
1376
|
+
search(options) {
|
|
1377
|
+
return (options?.client ?? this.client).get({
|
|
1378
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1379
|
+
url: '/api/v2/search',
|
|
1380
|
+
...options
|
|
1381
|
+
});
|
|
1382
|
+
}
|
|
1383
|
+
/**
|
|
1384
|
+
* List all register changes
|
|
1385
|
+
*
|
|
1386
|
+
* Commit-ordered durable feed. after is the last processed non-negative sequence and never expires. A transactional counter serializes allocation until commit; the safe horizon is its committed value visible to this read. Only entries at or below the horizon are served. Delivery is at least once: deduplicate on stable id. nextCursor advances through the horizon even if no entries match. Omit after to read retained history. Filters: register, type and subject ID or alias; person subjects also match referenced people. Detail is full, partial or none, with typed data per register. Key or session required, one credit for keys, ETag and private, no-cache.
|
|
1387
|
+
*/
|
|
1388
|
+
listChanges(options) {
|
|
1389
|
+
return (options?.client ?? this.client).get({
|
|
1390
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1391
|
+
url: '/api/v2/changes',
|
|
1392
|
+
...options
|
|
1393
|
+
});
|
|
1394
|
+
}
|
|
1395
|
+
/**
|
|
1396
|
+
* Get a register change
|
|
1397
|
+
*
|
|
1398
|
+
* Commit-ordered durable feed. after is the last processed non-negative sequence and never expires. A transactional counter serializes allocation until commit; the safe horizon is its committed value visible to this read. Only entries at or below the horizon are served. Delivery is at least once: deduplicate on stable id. nextCursor advances through the horizon even if no entries match. Omit after to read retained history. Filters: register, type and subject ID or alias; person subjects also match referenced people. Detail is full, partial or none, with typed data per register. Key or session required, one credit for keys, ETag and private, no-cache.
|
|
1399
|
+
*/
|
|
1400
|
+
getChange(options) {
|
|
1401
|
+
return (options.client ?? this.client).get({
|
|
1402
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1403
|
+
url: '/api/v2/changes/{id}',
|
|
1404
|
+
...options
|
|
1405
|
+
});
|
|
1406
|
+
}
|
|
1407
|
+
/**
|
|
1408
|
+
* List a company's register changes
|
|
1409
|
+
*
|
|
1410
|
+
* Commit-ordered durable feed. after is the last processed non-negative sequence and never expires. A transactional counter serializes allocation until commit; the safe horizon is its committed value visible to this read. Only entries at or below the horizon are served. Delivery is at least once: deduplicate on stable id. nextCursor advances through the horizon even if no entries match. Omit after to read retained history. Filters: register, type and subject ID or alias; person subjects also match referenced people. Detail is full, partial or none, with typed data per register. Key or session required, one credit for keys, ETag and private, no-cache.
|
|
1411
|
+
*/
|
|
1412
|
+
listCompanyChanges(options) {
|
|
1413
|
+
return (options.client ?? this.client).get({
|
|
1414
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1415
|
+
url: '/api/v2/companies/{id}/changes',
|
|
1416
|
+
...options
|
|
1417
|
+
});
|
|
1418
|
+
}
|
|
1419
|
+
/**
|
|
1420
|
+
* List a person's register changes
|
|
1421
|
+
*
|
|
1422
|
+
* Commit-ordered durable feed. after is the last processed non-negative sequence and never expires. A transactional counter serializes allocation until commit; the safe horizon is its committed value visible to this read. Only entries at or below the horizon are served. Delivery is at least once: deduplicate on stable id. nextCursor advances through the horizon even if no entries match. Omit after to read retained history. Filters: register, type and subject ID or alias; person subjects also match referenced people. Detail is full, partial or none, with typed data per register. Key or session required, one credit for keys, ETag and private, no-cache.
|
|
1423
|
+
*/
|
|
1424
|
+
listPersonChanges(options) {
|
|
1425
|
+
return (options.client ?? this.client).get({
|
|
1426
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
1427
|
+
url: '/api/v2/people/{id}/changes',
|
|
1428
|
+
...options
|
|
1429
|
+
});
|
|
1430
|
+
}
|
|
1431
|
+
}
|
|
1432
|
+
exports.FirmenakteApi = FirmenakteApi;
|
|
1433
|
+
FirmenakteApi.__registry = new HeyApiRegistry();
|