@researchdatabox/rva-registry-openapi-generated-node 0.0.0-bootstrap.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/dist/api.d.ts +2367 -0
- package/dist/api.js +4067 -0
- package/dist/base.d.ts +42 -0
- package/dist/base.js +52 -0
- package/dist/common.d.ts +34 -0
- package/dist/common.js +122 -0
- package/dist/configuration.d.ts +98 -0
- package/dist/configuration.js +100 -0
- package/dist/index.d.ts +13 -0
- package/dist/index.js +31 -0
- package/package.json +32 -0
package/dist/api.d.ts
ADDED
|
@@ -0,0 +1,2367 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Vocabulary Registry API
|
|
3
|
+
* Public access to the Vocabulary Registry API
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.2.0
|
|
6
|
+
* Contact: services@ardc.edu.au
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from './configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
+
import globalAxios from 'axios';
|
|
15
|
+
import type { RequestArgs } from './base';
|
|
16
|
+
import { BaseAPI } from './base';
|
|
17
|
+
export interface AccessPoint {
|
|
18
|
+
'ap-api-sparql'?: ApApiSparql;
|
|
19
|
+
'ap-file'?: ApFile;
|
|
20
|
+
'ap-sesame-download'?: ApSesameDownload;
|
|
21
|
+
'ap-sissvoc'?: ApSissvoc;
|
|
22
|
+
'ap-web-page'?: ApWebPage;
|
|
23
|
+
'id'?: number;
|
|
24
|
+
'source': AccessPointSourceEnum;
|
|
25
|
+
'discriminator': AccessPointDiscriminatorEnum;
|
|
26
|
+
}
|
|
27
|
+
export declare const AccessPointSourceEnum: {
|
|
28
|
+
readonly System: "system";
|
|
29
|
+
readonly User: "user";
|
|
30
|
+
};
|
|
31
|
+
export type AccessPointSourceEnum = typeof AccessPointSourceEnum[keyof typeof AccessPointSourceEnum];
|
|
32
|
+
export declare const AccessPointDiscriminatorEnum: {
|
|
33
|
+
readonly ApiSparql: "apiSparql";
|
|
34
|
+
readonly File: "file";
|
|
35
|
+
readonly SesameDownload: "sesameDownload";
|
|
36
|
+
readonly Sissvoc: "sissvoc";
|
|
37
|
+
readonly WebPage: "webPage";
|
|
38
|
+
};
|
|
39
|
+
export type AccessPointDiscriminatorEnum = typeof AccessPointDiscriminatorEnum[keyof typeof AccessPointDiscriminatorEnum];
|
|
40
|
+
export interface AccessPointList {
|
|
41
|
+
'access-point'?: Array<AccessPoint>;
|
|
42
|
+
}
|
|
43
|
+
export interface ApApiSparql {
|
|
44
|
+
'url': string;
|
|
45
|
+
}
|
|
46
|
+
export interface ApFile {
|
|
47
|
+
'format'?: string;
|
|
48
|
+
'upload-id': number;
|
|
49
|
+
'url'?: string;
|
|
50
|
+
}
|
|
51
|
+
export interface ApSesameDownload {
|
|
52
|
+
'url-prefix'?: string;
|
|
53
|
+
}
|
|
54
|
+
export interface ApSissvoc {
|
|
55
|
+
'url-prefix'?: string;
|
|
56
|
+
}
|
|
57
|
+
export interface ApWebPage {
|
|
58
|
+
'url': string;
|
|
59
|
+
}
|
|
60
|
+
export interface LanguageDetails {
|
|
61
|
+
'tag'?: string;
|
|
62
|
+
'description'?: string;
|
|
63
|
+
}
|
|
64
|
+
export interface LanguageList {
|
|
65
|
+
'language-details'?: Array<LanguageDetails>;
|
|
66
|
+
}
|
|
67
|
+
export interface ModelError {
|
|
68
|
+
'message'?: string;
|
|
69
|
+
'constraintViolation'?: Array<ValidationError>;
|
|
70
|
+
}
|
|
71
|
+
export interface OwnedVocabulary {
|
|
72
|
+
'id'?: number;
|
|
73
|
+
'status': OwnedVocabularyStatusEnum;
|
|
74
|
+
'has-draft'?: boolean;
|
|
75
|
+
'owner': string;
|
|
76
|
+
'slug'?: string;
|
|
77
|
+
'title': string;
|
|
78
|
+
}
|
|
79
|
+
export declare const OwnedVocabularyStatusEnum: {
|
|
80
|
+
readonly Published: "published";
|
|
81
|
+
readonly Draft: "draft";
|
|
82
|
+
readonly Deprecated: "deprecated";
|
|
83
|
+
};
|
|
84
|
+
export type OwnedVocabularyStatusEnum = typeof OwnedVocabularyStatusEnum[keyof typeof OwnedVocabularyStatusEnum];
|
|
85
|
+
export interface OwnedVocabularyList {
|
|
86
|
+
'owned-vocabulary'?: Array<OwnedVocabulary>;
|
|
87
|
+
}
|
|
88
|
+
export interface PoolpartyProject {
|
|
89
|
+
'server-id'?: number;
|
|
90
|
+
'project-id'?: string;
|
|
91
|
+
}
|
|
92
|
+
export interface RelatedEntity {
|
|
93
|
+
'related-entity-identifier'?: Array<RelatedEntityIdentifier>;
|
|
94
|
+
'url'?: Array<string>;
|
|
95
|
+
'id'?: number;
|
|
96
|
+
'type': RelatedEntityTypeEnum;
|
|
97
|
+
'owner': string;
|
|
98
|
+
'title': string;
|
|
99
|
+
'email'?: string;
|
|
100
|
+
'phone'?: string;
|
|
101
|
+
}
|
|
102
|
+
export declare const RelatedEntityTypeEnum: {
|
|
103
|
+
readonly Party: "party";
|
|
104
|
+
readonly Service: "service";
|
|
105
|
+
readonly Vocabulary: "vocabulary";
|
|
106
|
+
};
|
|
107
|
+
export type RelatedEntityTypeEnum = typeof RelatedEntityTypeEnum[keyof typeof RelatedEntityTypeEnum];
|
|
108
|
+
export interface RelatedEntityIdentifier {
|
|
109
|
+
'id'?: number;
|
|
110
|
+
'identifier-type': RelatedEntityIdentifierIdentifierTypeEnum;
|
|
111
|
+
'identifier-value': string;
|
|
112
|
+
}
|
|
113
|
+
export declare const RelatedEntityIdentifierIdentifierTypeEnum: {
|
|
114
|
+
readonly AuAnlPeau: "auAnlPeau";
|
|
115
|
+
readonly Doi: "doi";
|
|
116
|
+
readonly Handle: "handle";
|
|
117
|
+
readonly Infouri: "infouri";
|
|
118
|
+
readonly Isil: "isil";
|
|
119
|
+
readonly Isni: "isni";
|
|
120
|
+
readonly Local: "local";
|
|
121
|
+
readonly Orcid: "orcid";
|
|
122
|
+
readonly Purl: "purl";
|
|
123
|
+
readonly ResearcherId: "researcherID";
|
|
124
|
+
readonly Ror: "ror";
|
|
125
|
+
readonly Uri: "uri";
|
|
126
|
+
readonly Viaf: "viaf";
|
|
127
|
+
};
|
|
128
|
+
export type RelatedEntityIdentifierIdentifierTypeEnum = typeof RelatedEntityIdentifierIdentifierTypeEnum[keyof typeof RelatedEntityIdentifierIdentifierTypeEnum];
|
|
129
|
+
export interface RelatedEntityList {
|
|
130
|
+
'related-entity'?: Array<RelatedEntity>;
|
|
131
|
+
}
|
|
132
|
+
export interface RelatedEntityRef {
|
|
133
|
+
'relation': Array<RelatedEntityRefRelationEnum>;
|
|
134
|
+
'related-entity'?: RelatedEntity;
|
|
135
|
+
'id': number;
|
|
136
|
+
}
|
|
137
|
+
export declare const RelatedEntityRefRelationEnum: {
|
|
138
|
+
readonly PublishedBy: "publishedBy";
|
|
139
|
+
readonly HasAuthor: "hasAuthor";
|
|
140
|
+
readonly HasContributor: "hasContributor";
|
|
141
|
+
readonly PointOfContact: "pointOfContact";
|
|
142
|
+
readonly ImplementedBy: "implementedBy";
|
|
143
|
+
readonly ConsumerOf: "consumerOf";
|
|
144
|
+
readonly IsFundedBy: "isFundedBy";
|
|
145
|
+
readonly HasAssociationWith: "hasAssociationWith";
|
|
146
|
+
readonly IsPresentedBy: "isPresentedBy";
|
|
147
|
+
readonly IsUsedBy: "isUsedBy";
|
|
148
|
+
readonly IsDerivedFrom: "isDerivedFrom";
|
|
149
|
+
readonly Enriches: "enriches";
|
|
150
|
+
readonly IsPartOf: "isPartOf";
|
|
151
|
+
};
|
|
152
|
+
export type RelatedEntityRefRelationEnum = typeof RelatedEntityRefRelationEnum[keyof typeof RelatedEntityRefRelationEnum];
|
|
153
|
+
export interface RelatedVocabulary {
|
|
154
|
+
'id'?: number;
|
|
155
|
+
'status': RelatedVocabularyStatusEnum;
|
|
156
|
+
'owner': string;
|
|
157
|
+
'slug'?: string;
|
|
158
|
+
'title': string;
|
|
159
|
+
'acronym'?: string;
|
|
160
|
+
'description'?: string;
|
|
161
|
+
}
|
|
162
|
+
export declare const RelatedVocabularyStatusEnum: {
|
|
163
|
+
readonly Published: "published";
|
|
164
|
+
readonly Draft: "draft";
|
|
165
|
+
readonly Deprecated: "deprecated";
|
|
166
|
+
};
|
|
167
|
+
export type RelatedVocabularyStatusEnum = typeof RelatedVocabularyStatusEnum[keyof typeof RelatedVocabularyStatusEnum];
|
|
168
|
+
export interface RelatedVocabularyRef {
|
|
169
|
+
'relation': Array<RelatedVocabularyRefRelationEnum>;
|
|
170
|
+
'related-vocabulary': RelatedVocabulary;
|
|
171
|
+
'id': number;
|
|
172
|
+
}
|
|
173
|
+
export declare const RelatedVocabularyRefRelationEnum: {
|
|
174
|
+
readonly HasAssociationWith: "hasAssociationWith";
|
|
175
|
+
readonly IsDerivedFrom: "isDerivedFrom";
|
|
176
|
+
readonly Enriches: "enriches";
|
|
177
|
+
readonly IsPartOf: "isPartOf";
|
|
178
|
+
};
|
|
179
|
+
export type RelatedVocabularyRefRelationEnum = typeof RelatedVocabularyRefRelationEnum[keyof typeof RelatedVocabularyRefRelationEnum];
|
|
180
|
+
export interface Result {
|
|
181
|
+
'stringValue'?: string;
|
|
182
|
+
'booleanValue'?: boolean;
|
|
183
|
+
'integerValue'?: number;
|
|
184
|
+
}
|
|
185
|
+
export interface ResultPair {
|
|
186
|
+
'result-key'?: string;
|
|
187
|
+
'result-value'?: string;
|
|
188
|
+
}
|
|
189
|
+
export interface ReverseRelatedVocabulary {
|
|
190
|
+
'related-entity-relation'?: Array<ReverseRelatedVocabularyRelatedEntityRelationEnum>;
|
|
191
|
+
'related-vocabulary-relation'?: Array<ReverseRelatedVocabularyRelatedVocabularyRelationEnum>;
|
|
192
|
+
'related-vocabulary': RelatedVocabulary;
|
|
193
|
+
}
|
|
194
|
+
export declare const ReverseRelatedVocabularyRelatedEntityRelationEnum: {
|
|
195
|
+
readonly PublishedBy: "publishedBy";
|
|
196
|
+
readonly HasAuthor: "hasAuthor";
|
|
197
|
+
readonly HasContributor: "hasContributor";
|
|
198
|
+
readonly PointOfContact: "pointOfContact";
|
|
199
|
+
readonly ImplementedBy: "implementedBy";
|
|
200
|
+
readonly ConsumerOf: "consumerOf";
|
|
201
|
+
readonly IsFundedBy: "isFundedBy";
|
|
202
|
+
readonly HasAssociationWith: "hasAssociationWith";
|
|
203
|
+
readonly IsPresentedBy: "isPresentedBy";
|
|
204
|
+
readonly IsUsedBy: "isUsedBy";
|
|
205
|
+
readonly IsDerivedFrom: "isDerivedFrom";
|
|
206
|
+
readonly Enriches: "enriches";
|
|
207
|
+
readonly IsPartOf: "isPartOf";
|
|
208
|
+
};
|
|
209
|
+
export type ReverseRelatedVocabularyRelatedEntityRelationEnum = typeof ReverseRelatedVocabularyRelatedEntityRelationEnum[keyof typeof ReverseRelatedVocabularyRelatedEntityRelationEnum];
|
|
210
|
+
export declare const ReverseRelatedVocabularyRelatedVocabularyRelationEnum: {
|
|
211
|
+
readonly HasAssociationWith: "hasAssociationWith";
|
|
212
|
+
readonly IsDerivedFrom: "isDerivedFrom";
|
|
213
|
+
readonly Enriches: "enriches";
|
|
214
|
+
readonly IsPartOf: "isPartOf";
|
|
215
|
+
};
|
|
216
|
+
export type ReverseRelatedVocabularyRelatedVocabularyRelationEnum = typeof ReverseRelatedVocabularyRelatedVocabularyRelationEnum[keyof typeof ReverseRelatedVocabularyRelatedVocabularyRelationEnum];
|
|
217
|
+
export interface ReverseRelatedVocabularyList {
|
|
218
|
+
'reverse-related-vocabulary'?: Array<ReverseRelatedVocabulary>;
|
|
219
|
+
}
|
|
220
|
+
export interface Role {
|
|
221
|
+
'id'?: string;
|
|
222
|
+
'typeId'?: RoleTypeIdEnum;
|
|
223
|
+
'fullName'?: string;
|
|
224
|
+
}
|
|
225
|
+
export declare const RoleTypeIdEnum: {
|
|
226
|
+
readonly RoleUser: "ROLE_USER";
|
|
227
|
+
readonly RoleOrganisational: "ROLE_ORGANISATIONAL";
|
|
228
|
+
readonly RoleFunctional: "ROLE_FUNCTIONAL";
|
|
229
|
+
readonly RoleDoiAppid: "ROLE_DOI_APPID";
|
|
230
|
+
};
|
|
231
|
+
export type RoleTypeIdEnum = typeof RoleTypeIdEnum[keyof typeof RoleTypeIdEnum];
|
|
232
|
+
export interface Subject {
|
|
233
|
+
'source': string;
|
|
234
|
+
'label': string;
|
|
235
|
+
'notation'?: string;
|
|
236
|
+
'iri'?: string;
|
|
237
|
+
}
|
|
238
|
+
export interface Subscription {
|
|
239
|
+
'notification-mode': SubscriptionNotificationModeEnum;
|
|
240
|
+
'element-type': SubscriptionElementTypeEnum;
|
|
241
|
+
'element-id'?: string;
|
|
242
|
+
'title'?: string;
|
|
243
|
+
'deleted'?: boolean;
|
|
244
|
+
}
|
|
245
|
+
export declare const SubscriptionNotificationModeEnum: {
|
|
246
|
+
readonly Email: "email";
|
|
247
|
+
};
|
|
248
|
+
export type SubscriptionNotificationModeEnum = typeof SubscriptionNotificationModeEnum[keyof typeof SubscriptionNotificationModeEnum];
|
|
249
|
+
export declare const SubscriptionElementTypeEnum: {
|
|
250
|
+
readonly System: "system";
|
|
251
|
+
readonly Owner: "owner";
|
|
252
|
+
readonly Vocabulary: "vocabulary";
|
|
253
|
+
};
|
|
254
|
+
export type SubscriptionElementTypeEnum = typeof SubscriptionElementTypeEnum[keyof typeof SubscriptionElementTypeEnum];
|
|
255
|
+
export interface SubscriptionList {
|
|
256
|
+
'subscription'?: Array<Subscription>;
|
|
257
|
+
}
|
|
258
|
+
export interface Subtask {
|
|
259
|
+
'subtaskProviderType'?: SubtaskSubtaskProviderTypeEnum;
|
|
260
|
+
'operation'?: SubtaskOperationEnum;
|
|
261
|
+
'priority'?: number;
|
|
262
|
+
'provider'?: string;
|
|
263
|
+
'subtaskProperties'?: {
|
|
264
|
+
[key: string]: string;
|
|
265
|
+
};
|
|
266
|
+
'status'?: SubtaskStatusEnum;
|
|
267
|
+
'results'?: {
|
|
268
|
+
[key: string]: string;
|
|
269
|
+
};
|
|
270
|
+
}
|
|
271
|
+
export declare const SubtaskSubtaskProviderTypeEnum: {
|
|
272
|
+
readonly Backup: "backup";
|
|
273
|
+
readonly Harvest: "harvest";
|
|
274
|
+
readonly Importer: "importer";
|
|
275
|
+
readonly Publish: "publish";
|
|
276
|
+
readonly Transform: "transform";
|
|
277
|
+
};
|
|
278
|
+
export type SubtaskSubtaskProviderTypeEnum = typeof SubtaskSubtaskProviderTypeEnum[keyof typeof SubtaskSubtaskProviderTypeEnum];
|
|
279
|
+
export declare const SubtaskOperationEnum: {
|
|
280
|
+
readonly Insert: "insert";
|
|
281
|
+
readonly Delete: "delete";
|
|
282
|
+
readonly Perform: "perform";
|
|
283
|
+
};
|
|
284
|
+
export type SubtaskOperationEnum = typeof SubtaskOperationEnum[keyof typeof SubtaskOperationEnum];
|
|
285
|
+
export declare const SubtaskStatusEnum: {
|
|
286
|
+
readonly New: "new";
|
|
287
|
+
readonly Partial: "partial";
|
|
288
|
+
readonly Success: "success";
|
|
289
|
+
readonly Error: "error";
|
|
290
|
+
};
|
|
291
|
+
export type SubtaskStatusEnum = typeof SubtaskStatusEnum[keyof typeof SubtaskStatusEnum];
|
|
292
|
+
export interface SubtaskOutcome {
|
|
293
|
+
'subtask-result'?: Array<ResultPair>;
|
|
294
|
+
'status'?: SubtaskOutcomeStatusEnum;
|
|
295
|
+
'subtask-provider-type'?: SubtaskOutcomeSubtaskProviderTypeEnum;
|
|
296
|
+
'provider'?: string;
|
|
297
|
+
'operation'?: SubtaskOutcomeOperationEnum;
|
|
298
|
+
}
|
|
299
|
+
export declare const SubtaskOutcomeStatusEnum: {
|
|
300
|
+
readonly New: "new";
|
|
301
|
+
readonly Partial: "partial";
|
|
302
|
+
readonly Success: "success";
|
|
303
|
+
readonly Error: "error";
|
|
304
|
+
};
|
|
305
|
+
export type SubtaskOutcomeStatusEnum = typeof SubtaskOutcomeStatusEnum[keyof typeof SubtaskOutcomeStatusEnum];
|
|
306
|
+
export declare const SubtaskOutcomeSubtaskProviderTypeEnum: {
|
|
307
|
+
readonly Backup: "backup";
|
|
308
|
+
readonly Harvest: "harvest";
|
|
309
|
+
readonly Importer: "importer";
|
|
310
|
+
readonly Publish: "publish";
|
|
311
|
+
readonly Transform: "transform";
|
|
312
|
+
};
|
|
313
|
+
export type SubtaskOutcomeSubtaskProviderTypeEnum = typeof SubtaskOutcomeSubtaskProviderTypeEnum[keyof typeof SubtaskOutcomeSubtaskProviderTypeEnum];
|
|
314
|
+
export declare const SubtaskOutcomeOperationEnum: {
|
|
315
|
+
readonly Insert: "insert";
|
|
316
|
+
readonly Delete: "delete";
|
|
317
|
+
readonly Perform: "perform";
|
|
318
|
+
};
|
|
319
|
+
export type SubtaskOutcomeOperationEnum = typeof SubtaskOutcomeOperationEnum[keyof typeof SubtaskOutcomeOperationEnum];
|
|
320
|
+
export interface Task {
|
|
321
|
+
'status'?: TaskStatusEnum;
|
|
322
|
+
'vocabularyId'?: number;
|
|
323
|
+
'versionId'?: number;
|
|
324
|
+
'subtasks'?: Array<Subtask>;
|
|
325
|
+
'results'?: {
|
|
326
|
+
[key: string]: string;
|
|
327
|
+
};
|
|
328
|
+
}
|
|
329
|
+
export declare const TaskStatusEnum: {
|
|
330
|
+
readonly New: "new";
|
|
331
|
+
readonly Partial: "partial";
|
|
332
|
+
readonly Success: "success";
|
|
333
|
+
readonly Error: "error";
|
|
334
|
+
};
|
|
335
|
+
export type TaskStatusEnum = typeof TaskStatusEnum[keyof typeof TaskStatusEnum];
|
|
336
|
+
export interface TaskOutcome {
|
|
337
|
+
'subtask-outcome'?: Array<SubtaskOutcome>;
|
|
338
|
+
'task-result'?: Array<ResultPair>;
|
|
339
|
+
'version-id'?: number;
|
|
340
|
+
'status'?: TaskOutcomeStatusEnum;
|
|
341
|
+
}
|
|
342
|
+
export declare const TaskOutcomeStatusEnum: {
|
|
343
|
+
readonly New: "new";
|
|
344
|
+
readonly Partial: "partial";
|
|
345
|
+
readonly Success: "success";
|
|
346
|
+
readonly Error: "error";
|
|
347
|
+
};
|
|
348
|
+
export type TaskOutcomeStatusEnum = typeof TaskOutcomeStatusEnum[keyof typeof TaskOutcomeStatusEnum];
|
|
349
|
+
export interface UserInfo {
|
|
350
|
+
'id'?: string;
|
|
351
|
+
'authenticationServiceId'?: UserInfoAuthenticationServiceIdEnum;
|
|
352
|
+
'fullName'?: string;
|
|
353
|
+
'isSuperUser'?: boolean;
|
|
354
|
+
'parentRole'?: Array<Role>;
|
|
355
|
+
}
|
|
356
|
+
export declare const UserInfoAuthenticationServiceIdEnum: {
|
|
357
|
+
readonly AuthenticationBuiltIn: "AUTHENTICATION_BUILT_IN";
|
|
358
|
+
readonly AuthenticationLdap: "AUTHENTICATION_LDAP";
|
|
359
|
+
readonly AuthenticationShibboleth: "AUTHENTICATION_SHIBBOLETH";
|
|
360
|
+
readonly AuthenticationSocialFacebook: "AUTHENTICATION_SOCIAL_FACEBOOK";
|
|
361
|
+
readonly AuthenticationSocialGoogle: "AUTHENTICATION_SOCIAL_GOOGLE";
|
|
362
|
+
readonly AuthenticationSocialTwitter: "AUTHENTICATION_SOCIAL_TWITTER";
|
|
363
|
+
};
|
|
364
|
+
export type UserInfoAuthenticationServiceIdEnum = typeof UserInfoAuthenticationServiceIdEnum[keyof typeof UserInfoAuthenticationServiceIdEnum];
|
|
365
|
+
export interface ValidationError {
|
|
366
|
+
'message'?: string;
|
|
367
|
+
'path'?: string;
|
|
368
|
+
}
|
|
369
|
+
export interface Version {
|
|
370
|
+
'browse-flag'?: Array<VersionBrowseFlagEnum>;
|
|
371
|
+
'access-point'?: Array<AccessPoint>;
|
|
372
|
+
'id'?: number;
|
|
373
|
+
'status': VersionStatusEnum;
|
|
374
|
+
'title': string;
|
|
375
|
+
'slug'?: string;
|
|
376
|
+
'note'?: string;
|
|
377
|
+
'release-date'?: string;
|
|
378
|
+
'do-poolparty-harvest'?: boolean;
|
|
379
|
+
'do-import'?: boolean;
|
|
380
|
+
'do-publish'?: boolean;
|
|
381
|
+
'force-workflow'?: boolean;
|
|
382
|
+
}
|
|
383
|
+
export declare const VersionBrowseFlagEnum: {
|
|
384
|
+
readonly MaySortByNotation: "maySortByNotation";
|
|
385
|
+
readonly DefaultSortByNotation: "defaultSortByNotation";
|
|
386
|
+
readonly NotationAlpha: "notationAlpha";
|
|
387
|
+
readonly NotationFloat: "notationFloat";
|
|
388
|
+
readonly NotationDotted: "notationDotted";
|
|
389
|
+
readonly DefaultDisplayNotation: "defaultDisplayNotation";
|
|
390
|
+
readonly IncludeConceptSchemes: "includeConceptSchemes";
|
|
391
|
+
readonly IncludeCollections: "includeCollections";
|
|
392
|
+
readonly MayResolveResources: "mayResolveResources";
|
|
393
|
+
};
|
|
394
|
+
export type VersionBrowseFlagEnum = typeof VersionBrowseFlagEnum[keyof typeof VersionBrowseFlagEnum];
|
|
395
|
+
export declare const VersionStatusEnum: {
|
|
396
|
+
readonly Current: "current";
|
|
397
|
+
readonly Superseded: "superseded";
|
|
398
|
+
};
|
|
399
|
+
export type VersionStatusEnum = typeof VersionStatusEnum[keyof typeof VersionStatusEnum];
|
|
400
|
+
export interface VersionArtefact {
|
|
401
|
+
'id'?: number;
|
|
402
|
+
'status': VersionArtefactStatusEnum;
|
|
403
|
+
'type': VersionArtefactTypeEnum;
|
|
404
|
+
}
|
|
405
|
+
export declare const VersionArtefactStatusEnum: {
|
|
406
|
+
readonly Current: "current";
|
|
407
|
+
readonly Pending: "pending";
|
|
408
|
+
};
|
|
409
|
+
export type VersionArtefactStatusEnum = typeof VersionArtefactStatusEnum[keyof typeof VersionArtefactStatusEnum];
|
|
410
|
+
export declare const VersionArtefactTypeEnum: {
|
|
411
|
+
readonly ConceptList: "conceptList";
|
|
412
|
+
readonly ConceptTree: "conceptTree";
|
|
413
|
+
readonly HarvestPoolparty: "harvestPoolparty";
|
|
414
|
+
readonly ResourceDocs: "resourceDocs";
|
|
415
|
+
};
|
|
416
|
+
export type VersionArtefactTypeEnum = typeof VersionArtefactTypeEnum[keyof typeof VersionArtefactTypeEnum];
|
|
417
|
+
export interface VersionArtefactList {
|
|
418
|
+
'version-artefact'?: Array<VersionArtefact>;
|
|
419
|
+
}
|
|
420
|
+
export interface VersionList {
|
|
421
|
+
'version'?: Array<Version>;
|
|
422
|
+
}
|
|
423
|
+
export interface Vocabulary {
|
|
424
|
+
'poolparty-project'?: PoolpartyProject;
|
|
425
|
+
'subject'?: Array<Subject>;
|
|
426
|
+
'version'?: Array<Version>;
|
|
427
|
+
'other-language'?: Array<string>;
|
|
428
|
+
'top-concept'?: Array<string>;
|
|
429
|
+
'related-entity-ref': Array<RelatedEntityRef>;
|
|
430
|
+
'related-vocabulary-ref'?: Array<RelatedVocabularyRef>;
|
|
431
|
+
'language-list'?: LanguageList;
|
|
432
|
+
'workflow-outcome'?: WorkflowOutcome;
|
|
433
|
+
'id'?: number;
|
|
434
|
+
'status': VocabularyStatusEnum;
|
|
435
|
+
'owner': string;
|
|
436
|
+
'slug'?: string;
|
|
437
|
+
'title': string;
|
|
438
|
+
'acronym'?: string;
|
|
439
|
+
'description'?: string;
|
|
440
|
+
'note'?: string;
|
|
441
|
+
'revision-cycle'?: string;
|
|
442
|
+
'creation-date'?: string;
|
|
443
|
+
'primary-language'?: string;
|
|
444
|
+
'licence'?: string;
|
|
445
|
+
}
|
|
446
|
+
export declare const VocabularyStatusEnum: {
|
|
447
|
+
readonly Published: "published";
|
|
448
|
+
readonly Draft: "draft";
|
|
449
|
+
readonly Deprecated: "deprecated";
|
|
450
|
+
};
|
|
451
|
+
export type VocabularyStatusEnum = typeof VocabularyStatusEnum[keyof typeof VocabularyStatusEnum];
|
|
452
|
+
export interface VocabularyList {
|
|
453
|
+
'vocabulary'?: Array<Vocabulary>;
|
|
454
|
+
}
|
|
455
|
+
export interface WorkflowOutcome {
|
|
456
|
+
'task-outcome'?: Array<TaskOutcome>;
|
|
457
|
+
'vocabulary-id'?: number;
|
|
458
|
+
}
|
|
459
|
+
/**
|
|
460
|
+
* AdminApi - axios parameter creator
|
|
461
|
+
*/
|
|
462
|
+
export declare const AdminApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
463
|
+
/**
|
|
464
|
+
* This method is only available to administrator users.
|
|
465
|
+
* @summary Backup all PoolParty projects.
|
|
466
|
+
* @param {*} [options] Override http request option.
|
|
467
|
+
* @throws {RequiredError}
|
|
468
|
+
*/
|
|
469
|
+
backupAllPoolPartyProjects: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
470
|
+
/**
|
|
471
|
+
* This method is only available to administrator users.
|
|
472
|
+
* @summary Backup one PoolParty project.
|
|
473
|
+
* @param {string} projectId
|
|
474
|
+
* @param {*} [options] Override http request option.
|
|
475
|
+
* @throws {RequiredError}
|
|
476
|
+
*/
|
|
477
|
+
backupPoolPartyProject: (projectId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
478
|
+
/**
|
|
479
|
+
* This method is only available to administrator users.
|
|
480
|
+
* @summary Force a soft commit of pending changes to the Solr collections.
|
|
481
|
+
* @param {*} [options] Override http request option.
|
|
482
|
+
* @throws {RequiredError}
|
|
483
|
+
*/
|
|
484
|
+
commitSolr: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
485
|
+
/**
|
|
486
|
+
* This method is only available to administrator users.
|
|
487
|
+
* @summary Generate email notifications.
|
|
488
|
+
* @param {string} [startDate] Start date/time of registry events to consider. Values are specified in UTC: required format YYYY-MM-DDTHH:MM:SS, e.g., 2017-10-26T13:00:00. If not specified, defaults to a week before the current date/time, and endDate is taken as the current date/time (irrespective of any value given for endDate).
|
|
489
|
+
* @param {string} [endDate] End date/time of registry events to consider. Values are specified in UTC: required format YYYY-MM-DDTHH:MM:SS, e.g., 2017-11-26T00:00:00. If not specified, defaults to the current date/time.
|
|
490
|
+
* @param {*} [options] Override http request option.
|
|
491
|
+
* @throws {RequiredError}
|
|
492
|
+
*/
|
|
493
|
+
generateNotificationEmails: (startDate?: string, endDate?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
494
|
+
/**
|
|
495
|
+
* This method is only available to administrator users.
|
|
496
|
+
* @summary Get a task.
|
|
497
|
+
* @param {number} taskId The ID of the task to get.
|
|
498
|
+
* @param {*} [options] Override http request option.
|
|
499
|
+
* @throws {RequiredError}
|
|
500
|
+
*/
|
|
501
|
+
getTask: (taskId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
502
|
+
/**
|
|
503
|
+
* This method is only available to administrator users.
|
|
504
|
+
* @summary Get all the current (published and deprecated) and draft vocabularies.
|
|
505
|
+
* @param {*} [options] Override http request option.
|
|
506
|
+
* @throws {RequiredError}
|
|
507
|
+
*/
|
|
508
|
+
getVocabulariesIncludingDraft: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
509
|
+
/**
|
|
510
|
+
* This method is only available to administrator users.
|
|
511
|
+
* @summary Force Solr indexing of all vocabularies.
|
|
512
|
+
* @param {*} [options] Override http request option.
|
|
513
|
+
* @throws {RequiredError}
|
|
514
|
+
*/
|
|
515
|
+
indexAll: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
516
|
+
/**
|
|
517
|
+
* This method is only available to administrator users.
|
|
518
|
+
* @summary Force Solr indexing of one vocabulary.
|
|
519
|
+
* @param {number} vocabularyId
|
|
520
|
+
* @param {*} [options] Override http request option.
|
|
521
|
+
* @throws {RequiredError}
|
|
522
|
+
*/
|
|
523
|
+
indexOne: (vocabularyId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
524
|
+
/**
|
|
525
|
+
* This method is only available to administrator users. The task must exist in the database. There must be a current instance of the vocabulary and version.
|
|
526
|
+
* @summary Run a task.
|
|
527
|
+
* @param {number} taskId The ID of the task to run.
|
|
528
|
+
* @param {*} [options] Override http request option.
|
|
529
|
+
* @throws {RequiredError}
|
|
530
|
+
*/
|
|
531
|
+
runTask: (taskId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
532
|
+
/**
|
|
533
|
+
* This method is only available to administrator users. The tasks must exist in the database. There must be a current instance of the vocabularies and versions.
|
|
534
|
+
* @summary Run a set of tasks for one vocabulary.
|
|
535
|
+
* @param {Array<number>} taskId The IDs of the tasks to run.
|
|
536
|
+
* @param {*} [options] Override http request option.
|
|
537
|
+
* @throws {RequiredError}
|
|
538
|
+
*/
|
|
539
|
+
runTaskSet: (taskId: Array<number>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
540
|
+
};
|
|
541
|
+
/**
|
|
542
|
+
* AdminApi - functional programming interface
|
|
543
|
+
*/
|
|
544
|
+
export declare const AdminApiFp: (configuration?: Configuration) => {
|
|
545
|
+
/**
|
|
546
|
+
* This method is only available to administrator users.
|
|
547
|
+
* @summary Backup all PoolParty projects.
|
|
548
|
+
* @param {*} [options] Override http request option.
|
|
549
|
+
* @throws {RequiredError}
|
|
550
|
+
*/
|
|
551
|
+
backupAllPoolPartyProjects(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
552
|
+
[key: string]: object;
|
|
553
|
+
}>>;
|
|
554
|
+
/**
|
|
555
|
+
* This method is only available to administrator users.
|
|
556
|
+
* @summary Backup one PoolParty project.
|
|
557
|
+
* @param {string} projectId
|
|
558
|
+
* @param {*} [options] Override http request option.
|
|
559
|
+
* @throws {RequiredError}
|
|
560
|
+
*/
|
|
561
|
+
backupPoolPartyProject(projectId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
562
|
+
[key: string]: object;
|
|
563
|
+
}>>;
|
|
564
|
+
/**
|
|
565
|
+
* This method is only available to administrator users.
|
|
566
|
+
* @summary Force a soft commit of pending changes to the Solr collections.
|
|
567
|
+
* @param {*} [options] Override http request option.
|
|
568
|
+
* @throws {RequiredError}
|
|
569
|
+
*/
|
|
570
|
+
commitSolr(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Result>>;
|
|
571
|
+
/**
|
|
572
|
+
* This method is only available to administrator users.
|
|
573
|
+
* @summary Generate email notifications.
|
|
574
|
+
* @param {string} [startDate] Start date/time of registry events to consider. Values are specified in UTC: required format YYYY-MM-DDTHH:MM:SS, e.g., 2017-10-26T13:00:00. If not specified, defaults to a week before the current date/time, and endDate is taken as the current date/time (irrespective of any value given for endDate).
|
|
575
|
+
* @param {string} [endDate] End date/time of registry events to consider. Values are specified in UTC: required format YYYY-MM-DDTHH:MM:SS, e.g., 2017-11-26T00:00:00. If not specified, defaults to the current date/time.
|
|
576
|
+
* @param {*} [options] Override http request option.
|
|
577
|
+
* @throws {RequiredError}
|
|
578
|
+
*/
|
|
579
|
+
generateNotificationEmails(startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
580
|
+
/**
|
|
581
|
+
* This method is only available to administrator users.
|
|
582
|
+
* @summary Get a task.
|
|
583
|
+
* @param {number} taskId The ID of the task to get.
|
|
584
|
+
* @param {*} [options] Override http request option.
|
|
585
|
+
* @throws {RequiredError}
|
|
586
|
+
*/
|
|
587
|
+
getTask(taskId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Task>>;
|
|
588
|
+
/**
|
|
589
|
+
* This method is only available to administrator users.
|
|
590
|
+
* @summary Get all the current (published and deprecated) and draft vocabularies.
|
|
591
|
+
* @param {*} [options] Override http request option.
|
|
592
|
+
* @throws {RequiredError}
|
|
593
|
+
*/
|
|
594
|
+
getVocabulariesIncludingDraft(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VocabularyList>>;
|
|
595
|
+
/**
|
|
596
|
+
* This method is only available to administrator users.
|
|
597
|
+
* @summary Force Solr indexing of all vocabularies.
|
|
598
|
+
* @param {*} [options] Override http request option.
|
|
599
|
+
* @throws {RequiredError}
|
|
600
|
+
*/
|
|
601
|
+
indexAll(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Result>>;
|
|
602
|
+
/**
|
|
603
|
+
* This method is only available to administrator users.
|
|
604
|
+
* @summary Force Solr indexing of one vocabulary.
|
|
605
|
+
* @param {number} vocabularyId
|
|
606
|
+
* @param {*} [options] Override http request option.
|
|
607
|
+
* @throws {RequiredError}
|
|
608
|
+
*/
|
|
609
|
+
indexOne(vocabularyId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Result>>;
|
|
610
|
+
/**
|
|
611
|
+
* This method is only available to administrator users. The task must exist in the database. There must be a current instance of the vocabulary and version.
|
|
612
|
+
* @summary Run a task.
|
|
613
|
+
* @param {number} taskId The ID of the task to run.
|
|
614
|
+
* @param {*} [options] Override http request option.
|
|
615
|
+
* @throws {RequiredError}
|
|
616
|
+
*/
|
|
617
|
+
runTask(taskId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Task>>;
|
|
618
|
+
/**
|
|
619
|
+
* This method is only available to administrator users. The tasks must exist in the database. There must be a current instance of the vocabularies and versions.
|
|
620
|
+
* @summary Run a set of tasks for one vocabulary.
|
|
621
|
+
* @param {Array<number>} taskId The IDs of the tasks to run.
|
|
622
|
+
* @param {*} [options] Override http request option.
|
|
623
|
+
* @throws {RequiredError}
|
|
624
|
+
*/
|
|
625
|
+
runTaskSet(taskId: Array<number>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowOutcome>>;
|
|
626
|
+
};
|
|
627
|
+
/**
|
|
628
|
+
* AdminApi - factory interface
|
|
629
|
+
*/
|
|
630
|
+
export declare const AdminApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
631
|
+
/**
|
|
632
|
+
* This method is only available to administrator users.
|
|
633
|
+
* @summary Backup all PoolParty projects.
|
|
634
|
+
* @param {*} [options] Override http request option.
|
|
635
|
+
* @throws {RequiredError}
|
|
636
|
+
*/
|
|
637
|
+
backupAllPoolPartyProjects(options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
638
|
+
[key: string]: object;
|
|
639
|
+
}>;
|
|
640
|
+
/**
|
|
641
|
+
* This method is only available to administrator users.
|
|
642
|
+
* @summary Backup one PoolParty project.
|
|
643
|
+
* @param {string} projectId
|
|
644
|
+
* @param {*} [options] Override http request option.
|
|
645
|
+
* @throws {RequiredError}
|
|
646
|
+
*/
|
|
647
|
+
backupPoolPartyProject(projectId: string, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
648
|
+
[key: string]: object;
|
|
649
|
+
}>;
|
|
650
|
+
/**
|
|
651
|
+
* This method is only available to administrator users.
|
|
652
|
+
* @summary Force a soft commit of pending changes to the Solr collections.
|
|
653
|
+
* @param {*} [options] Override http request option.
|
|
654
|
+
* @throws {RequiredError}
|
|
655
|
+
*/
|
|
656
|
+
commitSolr(options?: RawAxiosRequestConfig): AxiosPromise<Result>;
|
|
657
|
+
/**
|
|
658
|
+
* This method is only available to administrator users.
|
|
659
|
+
* @summary Generate email notifications.
|
|
660
|
+
* @param {string} [startDate] Start date/time of registry events to consider. Values are specified in UTC: required format YYYY-MM-DDTHH:MM:SS, e.g., 2017-10-26T13:00:00. If not specified, defaults to a week before the current date/time, and endDate is taken as the current date/time (irrespective of any value given for endDate).
|
|
661
|
+
* @param {string} [endDate] End date/time of registry events to consider. Values are specified in UTC: required format YYYY-MM-DDTHH:MM:SS, e.g., 2017-11-26T00:00:00. If not specified, defaults to the current date/time.
|
|
662
|
+
* @param {*} [options] Override http request option.
|
|
663
|
+
* @throws {RequiredError}
|
|
664
|
+
*/
|
|
665
|
+
generateNotificationEmails(startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
666
|
+
/**
|
|
667
|
+
* This method is only available to administrator users.
|
|
668
|
+
* @summary Get a task.
|
|
669
|
+
* @param {number} taskId The ID of the task to get.
|
|
670
|
+
* @param {*} [options] Override http request option.
|
|
671
|
+
* @throws {RequiredError}
|
|
672
|
+
*/
|
|
673
|
+
getTask(taskId: number, options?: RawAxiosRequestConfig): AxiosPromise<Task>;
|
|
674
|
+
/**
|
|
675
|
+
* This method is only available to administrator users.
|
|
676
|
+
* @summary Get all the current (published and deprecated) and draft vocabularies.
|
|
677
|
+
* @param {*} [options] Override http request option.
|
|
678
|
+
* @throws {RequiredError}
|
|
679
|
+
*/
|
|
680
|
+
getVocabulariesIncludingDraft(options?: RawAxiosRequestConfig): AxiosPromise<VocabularyList>;
|
|
681
|
+
/**
|
|
682
|
+
* This method is only available to administrator users.
|
|
683
|
+
* @summary Force Solr indexing of all vocabularies.
|
|
684
|
+
* @param {*} [options] Override http request option.
|
|
685
|
+
* @throws {RequiredError}
|
|
686
|
+
*/
|
|
687
|
+
indexAll(options?: RawAxiosRequestConfig): AxiosPromise<Result>;
|
|
688
|
+
/**
|
|
689
|
+
* This method is only available to administrator users.
|
|
690
|
+
* @summary Force Solr indexing of one vocabulary.
|
|
691
|
+
* @param {number} vocabularyId
|
|
692
|
+
* @param {*} [options] Override http request option.
|
|
693
|
+
* @throws {RequiredError}
|
|
694
|
+
*/
|
|
695
|
+
indexOne(vocabularyId: number, options?: RawAxiosRequestConfig): AxiosPromise<Result>;
|
|
696
|
+
/**
|
|
697
|
+
* This method is only available to administrator users. The task must exist in the database. There must be a current instance of the vocabulary and version.
|
|
698
|
+
* @summary Run a task.
|
|
699
|
+
* @param {number} taskId The ID of the task to run.
|
|
700
|
+
* @param {*} [options] Override http request option.
|
|
701
|
+
* @throws {RequiredError}
|
|
702
|
+
*/
|
|
703
|
+
runTask(taskId: number, options?: RawAxiosRequestConfig): AxiosPromise<Task>;
|
|
704
|
+
/**
|
|
705
|
+
* This method is only available to administrator users. The tasks must exist in the database. There must be a current instance of the vocabularies and versions.
|
|
706
|
+
* @summary Run a set of tasks for one vocabulary.
|
|
707
|
+
* @param {Array<number>} taskId The IDs of the tasks to run.
|
|
708
|
+
* @param {*} [options] Override http request option.
|
|
709
|
+
* @throws {RequiredError}
|
|
710
|
+
*/
|
|
711
|
+
runTaskSet(taskId: Array<number>, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowOutcome>;
|
|
712
|
+
};
|
|
713
|
+
/**
|
|
714
|
+
* AdminApi - object-oriented interface
|
|
715
|
+
*/
|
|
716
|
+
export declare class AdminApi extends BaseAPI {
|
|
717
|
+
/**
|
|
718
|
+
* This method is only available to administrator users.
|
|
719
|
+
* @summary Backup all PoolParty projects.
|
|
720
|
+
* @param {*} [options] Override http request option.
|
|
721
|
+
* @throws {RequiredError}
|
|
722
|
+
*/
|
|
723
|
+
backupAllPoolPartyProjects(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<{
|
|
724
|
+
[key: string]: object;
|
|
725
|
+
}, any, {}>>;
|
|
726
|
+
/**
|
|
727
|
+
* This method is only available to administrator users.
|
|
728
|
+
* @summary Backup one PoolParty project.
|
|
729
|
+
* @param {string} projectId
|
|
730
|
+
* @param {*} [options] Override http request option.
|
|
731
|
+
* @throws {RequiredError}
|
|
732
|
+
*/
|
|
733
|
+
backupPoolPartyProject(projectId: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<{
|
|
734
|
+
[key: string]: object;
|
|
735
|
+
}, any, {}>>;
|
|
736
|
+
/**
|
|
737
|
+
* This method is only available to administrator users.
|
|
738
|
+
* @summary Force a soft commit of pending changes to the Solr collections.
|
|
739
|
+
* @param {*} [options] Override http request option.
|
|
740
|
+
* @throws {RequiredError}
|
|
741
|
+
*/
|
|
742
|
+
commitSolr(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Result, any, {}>>;
|
|
743
|
+
/**
|
|
744
|
+
* This method is only available to administrator users.
|
|
745
|
+
* @summary Generate email notifications.
|
|
746
|
+
* @param {string} [startDate] Start date/time of registry events to consider. Values are specified in UTC: required format YYYY-MM-DDTHH:MM:SS, e.g., 2017-10-26T13:00:00. If not specified, defaults to a week before the current date/time, and endDate is taken as the current date/time (irrespective of any value given for endDate).
|
|
747
|
+
* @param {string} [endDate] End date/time of registry events to consider. Values are specified in UTC: required format YYYY-MM-DDTHH:MM:SS, e.g., 2017-11-26T00:00:00. If not specified, defaults to the current date/time.
|
|
748
|
+
* @param {*} [options] Override http request option.
|
|
749
|
+
* @throws {RequiredError}
|
|
750
|
+
*/
|
|
751
|
+
generateNotificationEmails(startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<string, any, {}>>;
|
|
752
|
+
/**
|
|
753
|
+
* This method is only available to administrator users.
|
|
754
|
+
* @summary Get a task.
|
|
755
|
+
* @param {number} taskId The ID of the task to get.
|
|
756
|
+
* @param {*} [options] Override http request option.
|
|
757
|
+
* @throws {RequiredError}
|
|
758
|
+
*/
|
|
759
|
+
getTask(taskId: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Task, any, {}>>;
|
|
760
|
+
/**
|
|
761
|
+
* This method is only available to administrator users.
|
|
762
|
+
* @summary Get all the current (published and deprecated) and draft vocabularies.
|
|
763
|
+
* @param {*} [options] Override http request option.
|
|
764
|
+
* @throws {RequiredError}
|
|
765
|
+
*/
|
|
766
|
+
getVocabulariesIncludingDraft(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<VocabularyList, any, {}>>;
|
|
767
|
+
/**
|
|
768
|
+
* This method is only available to administrator users.
|
|
769
|
+
* @summary Force Solr indexing of all vocabularies.
|
|
770
|
+
* @param {*} [options] Override http request option.
|
|
771
|
+
* @throws {RequiredError}
|
|
772
|
+
*/
|
|
773
|
+
indexAll(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Result, any, {}>>;
|
|
774
|
+
/**
|
|
775
|
+
* This method is only available to administrator users.
|
|
776
|
+
* @summary Force Solr indexing of one vocabulary.
|
|
777
|
+
* @param {number} vocabularyId
|
|
778
|
+
* @param {*} [options] Override http request option.
|
|
779
|
+
* @throws {RequiredError}
|
|
780
|
+
*/
|
|
781
|
+
indexOne(vocabularyId: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Result, any, {}>>;
|
|
782
|
+
/**
|
|
783
|
+
* This method is only available to administrator users. The task must exist in the database. There must be a current instance of the vocabulary and version.
|
|
784
|
+
* @summary Run a task.
|
|
785
|
+
* @param {number} taskId The ID of the task to run.
|
|
786
|
+
* @param {*} [options] Override http request option.
|
|
787
|
+
* @throws {RequiredError}
|
|
788
|
+
*/
|
|
789
|
+
runTask(taskId: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Task, any, {}>>;
|
|
790
|
+
/**
|
|
791
|
+
* This method is only available to administrator users. The tasks must exist in the database. There must be a current instance of the vocabularies and versions.
|
|
792
|
+
* @summary Run a set of tasks for one vocabulary.
|
|
793
|
+
* @param {Array<number>} taskId The IDs of the tasks to run.
|
|
794
|
+
* @param {*} [options] Override http request option.
|
|
795
|
+
* @throws {RequiredError}
|
|
796
|
+
*/
|
|
797
|
+
runTaskSet(taskId: Array<number>, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<WorkflowOutcome, any, {}>>;
|
|
798
|
+
}
|
|
799
|
+
/**
|
|
800
|
+
* ResourcesApi - axios parameter creator
|
|
801
|
+
*/
|
|
802
|
+
export declare const ResourcesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
803
|
+
/**
|
|
804
|
+
*
|
|
805
|
+
* @summary Create a new related entity.
|
|
806
|
+
* @param {RelatedEntity} body The related entity to be added.
|
|
807
|
+
* @param {*} [options] Override http request option.
|
|
808
|
+
* @throws {RequiredError}
|
|
809
|
+
*/
|
|
810
|
+
createRelatedEntity: (body: RelatedEntity, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
811
|
+
/**
|
|
812
|
+
* The response contains the ID of the resulting upload in the integerValue field, and the sanitized filename in the stringValue field.
|
|
813
|
+
* @summary Upload a file.
|
|
814
|
+
* @param {string} owner The owner of the upload
|
|
815
|
+
* @param {string} format The type of the upload
|
|
816
|
+
* @param {File} file The file to upload
|
|
817
|
+
* @param {*} [options] Override http request option.
|
|
818
|
+
* @throws {RequiredError}
|
|
819
|
+
*/
|
|
820
|
+
createUpload: (owner: string, format: string, file: File, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
821
|
+
/**
|
|
822
|
+
*
|
|
823
|
+
* @summary Create a new vocabulary.
|
|
824
|
+
* @param {Vocabulary} body The vocabulary to be added.
|
|
825
|
+
* @param {*} [options] Override http request option.
|
|
826
|
+
* @throws {RequiredError}
|
|
827
|
+
*/
|
|
828
|
+
createVocabulary: (body: Vocabulary, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
829
|
+
/**
|
|
830
|
+
*
|
|
831
|
+
* @summary Delete a related entity.
|
|
832
|
+
* @param {number} relatedEntityId The ID of the related entity to be deleted.
|
|
833
|
+
* @param {*} [options] Override http request option.
|
|
834
|
+
* @throws {RequiredError}
|
|
835
|
+
*/
|
|
836
|
+
deleteRelatedEntity: (relatedEntityId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
837
|
+
/**
|
|
838
|
+
*
|
|
839
|
+
* @summary Delete a vocabulary.
|
|
840
|
+
* @param {number} vocabularyId The ID of the vocabulary to be deleted.
|
|
841
|
+
* @param {boolean} [deleteCurrent] Whether or not to delete the current version.
|
|
842
|
+
* @param {boolean} [deleteDraft] Whether or not to delete the draft version.
|
|
843
|
+
* @param {*} [options] Override http request option.
|
|
844
|
+
* @throws {RequiredError}
|
|
845
|
+
*/
|
|
846
|
+
deleteVocabulary: (vocabularyId: number, deleteCurrent?: boolean, deleteDraft?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
847
|
+
/**
|
|
848
|
+
* In this version of the download method, a download format is specified as a query parameter. The response will include a Content-Disposition header that specifies a full filename based on the underlying data; its extension may be different from the value of the format query parameter.
|
|
849
|
+
* @summary Get a download.
|
|
850
|
+
* @param {number} downloadId The Id of the download.
|
|
851
|
+
* @param {string} [format] The format of the download. This must be a filename extension without the period, e.g., \"rdf\".
|
|
852
|
+
* @param {*} [options] Override http request option.
|
|
853
|
+
* @throws {RequiredError}
|
|
854
|
+
*/
|
|
855
|
+
download: (downloadId: number, format?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
856
|
+
/**
|
|
857
|
+
* In this version of the download method, the last component of the URL specifies a filename and an extension. The response will include a Content-Disposition header that specifies a filename and extension based on the underlying data; they may be different from the values specified.
|
|
858
|
+
* @summary Get a download.
|
|
859
|
+
* @param {number} downloadId The Id of the download.
|
|
860
|
+
* @param {string} filename The filename of the download.
|
|
861
|
+
* @param {string} extension The format of the download. This must be a filename extension without the period, e.g., \"rdf\".
|
|
862
|
+
* @param {*} [options] Override http request option.
|
|
863
|
+
* @throws {RequiredError}
|
|
864
|
+
*/
|
|
865
|
+
downloadWithFilename: (downloadId: number, filename: string, extension: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
866
|
+
/**
|
|
867
|
+
*
|
|
868
|
+
* @summary Get the current access points of a version, by its version id.
|
|
869
|
+
* @param {number} versionId The ID of the version from which to get the current access points.
|
|
870
|
+
* @param {*} [options] Override http request option.
|
|
871
|
+
* @throws {RequiredError}
|
|
872
|
+
*/
|
|
873
|
+
getAccessPointsForVersionById: (versionId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
874
|
+
/**
|
|
875
|
+
* The result list contains one element for each vocabulary owned by the caller. The status attribute will be \"draft\" if there is only a draft instance of the vocabulary; in this case, hasDraft will be true. Otherwise, status will be either \"published\" or \"deprecated\", and hasDraft will be true if there is also a draft instance.
|
|
876
|
+
* @summary Get a list of vocabularies owned by the caller.
|
|
877
|
+
* @param {*} [options] Override http request option.
|
|
878
|
+
* @throws {RequiredError}
|
|
879
|
+
*/
|
|
880
|
+
getOwnedVocabularies: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
881
|
+
/**
|
|
882
|
+
*
|
|
883
|
+
* @summary Get all current related entities, optionally, filtered by related entity type. Results do not include related entity identifiers.
|
|
884
|
+
* @param {GetRelatedEntitiesRelatedEntityTypeEnum} [relatedEntityType] The type of the related entities to get.
|
|
885
|
+
* @param {*} [options] Override http request option.
|
|
886
|
+
* @throws {RequiredError}
|
|
887
|
+
*/
|
|
888
|
+
getRelatedEntities: (relatedEntityType?: GetRelatedEntitiesRelatedEntityTypeEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
889
|
+
/**
|
|
890
|
+
*
|
|
891
|
+
* @summary Get the current related entities of a vocabulary, by its vocabulary id.
|
|
892
|
+
* @param {number} vocabularyId The ID of the vocabulary from which to get the current related entities.
|
|
893
|
+
* @param {*} [options] Override http request option.
|
|
894
|
+
* @throws {RequiredError}
|
|
895
|
+
*/
|
|
896
|
+
getRelatedEntitiesForVocabularyById: (vocabularyId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
897
|
+
/**
|
|
898
|
+
*
|
|
899
|
+
* @summary Get a current related entity by its id.
|
|
900
|
+
* @param {number} relatedEntityId The ID of the related entity to get.
|
|
901
|
+
* @param {*} [options] Override http request option.
|
|
902
|
+
* @throws {RequiredError}
|
|
903
|
+
*/
|
|
904
|
+
getRelatedEntityById: (relatedEntityId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
905
|
+
/**
|
|
906
|
+
*
|
|
907
|
+
* @summary Get the current concept tree of a version, by its version id.
|
|
908
|
+
* @param {number} versionId The ID of the version from which to get the concept tree.
|
|
909
|
+
* @param {*} [options] Override http request option.
|
|
910
|
+
* @throws {RequiredError}
|
|
911
|
+
*/
|
|
912
|
+
getVersionArtefactConceptTree: (versionId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
913
|
+
/**
|
|
914
|
+
*
|
|
915
|
+
* @summary Get the current version artefacts of a version, by its version id. Results can be filtered by version artefact type.
|
|
916
|
+
* @param {number} versionId The ID of the version from which to get the version artefacts.
|
|
917
|
+
* @param {GetVersionArtefactsTypeEnum} [type] Version artefact type used to filter results.
|
|
918
|
+
* @param {*} [options] Override http request option.
|
|
919
|
+
* @throws {RequiredError}
|
|
920
|
+
*/
|
|
921
|
+
getVersionArtefacts: (versionId: number, type?: GetVersionArtefactsTypeEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
922
|
+
/**
|
|
923
|
+
*
|
|
924
|
+
* @summary Get a current version by its id.
|
|
925
|
+
* @param {number} versionId The ID of the version to get.
|
|
926
|
+
* @param {*} [options] Override http request option.
|
|
927
|
+
* @throws {RequiredError}
|
|
928
|
+
*/
|
|
929
|
+
getVersionById: (versionId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
930
|
+
/**
|
|
931
|
+
*
|
|
932
|
+
* @summary Get the current versions of a vocabulary, by its vocabulary id. The results are returned in reverse order of release date.
|
|
933
|
+
* @param {number} vocabularyId The ID of the vocabulary from which to get the current versions.
|
|
934
|
+
* @param {*} [options] Override http request option.
|
|
935
|
+
* @throws {RequiredError}
|
|
936
|
+
*/
|
|
937
|
+
getVersionsForVocabularyById: (vocabularyId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
938
|
+
/**
|
|
939
|
+
*
|
|
940
|
+
* @summary Get all the current vocabularies. This includes both published and deprecated vocabularies.
|
|
941
|
+
* @param {*} [options] Override http request option.
|
|
942
|
+
* @throws {RequiredError}
|
|
943
|
+
*/
|
|
944
|
+
getVocabularies: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
945
|
+
/**
|
|
946
|
+
*
|
|
947
|
+
* @summary Get all current vocabularies related to a related entity, by the related entity\'s id.
|
|
948
|
+
* @param {number} relatedEntityId The ID of the related entity for which to get the vocabularies related to it.
|
|
949
|
+
* @param {*} [options] Override http request option.
|
|
950
|
+
* @throws {RequiredError}
|
|
951
|
+
*/
|
|
952
|
+
getVocabulariesRelatedToRelatedEntityById: (relatedEntityId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
953
|
+
/**
|
|
954
|
+
*
|
|
955
|
+
* @summary Get all current vocabularies related to a vocabulary, by its vocabulary id.
|
|
956
|
+
* @param {number} vocabularyId The ID of the vocabulary for which to get the vocabularies related to it.
|
|
957
|
+
* @param {*} [options] Override http request option.
|
|
958
|
+
* @throws {RequiredError}
|
|
959
|
+
*/
|
|
960
|
+
getVocabulariesRelatedToVocabularyById: (vocabularyId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
961
|
+
/**
|
|
962
|
+
*
|
|
963
|
+
* @summary Get a current vocabulary by its id.
|
|
964
|
+
* @param {number} vocabularyId The ID of the vocabulary to get.
|
|
965
|
+
* @param {boolean} [includeVersions] Whether or not to include version elements. If enabled, versions are returned in reverse order of release date.
|
|
966
|
+
* @param {boolean} [includeAccessPoints] Whether or not to include access points. Setting this to true forces includeVersions also to be true.
|
|
967
|
+
* @param {boolean} [includeRelatedEntitiesAndVocabularies] Whether or not to include full details of related entities, and top-level details of related vocabularies. If false (the default), only references will be included.
|
|
968
|
+
* @param {boolean} [includeLanguageList] Whether or not to include descriptions of the language tags.
|
|
969
|
+
* @param {*} [options] Override http request option.
|
|
970
|
+
* @throws {RequiredError}
|
|
971
|
+
*/
|
|
972
|
+
getVocabularyById: (vocabularyId: number, includeVersions?: boolean, includeAccessPoints?: boolean, includeRelatedEntitiesAndVocabularies?: boolean, includeLanguageList?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
973
|
+
/**
|
|
974
|
+
* Access points that have source=SYSTEM are stripped out.
|
|
975
|
+
* @summary Get a vocabulary by its id, for editing.
|
|
976
|
+
* @param {number} vocabularyId The ID of the vocabulary to get for editing.
|
|
977
|
+
* @param {*} [options] Override http request option.
|
|
978
|
+
* @throws {RequiredError}
|
|
979
|
+
*/
|
|
980
|
+
getVocabularyByIdEdit: (vocabularyId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
981
|
+
/**
|
|
982
|
+
*
|
|
983
|
+
* @summary Get a current vocabulary by its slug.
|
|
984
|
+
* @param {string} slug The slug of the vocabulary to get.
|
|
985
|
+
* @param {boolean} [includeVersions] Whether or not to include version elements. If enabled, versions are returned in reverse order of release date.
|
|
986
|
+
* @param {boolean} [includeAccessPoints] Whether or not to include access points. Setting this to true forces includeVersions also to be true.
|
|
987
|
+
* @param {boolean} [includeRelatedEntitiesAndVocabularies] Whether or not to include full details of related entities, and top-level details of related vocabularies. If false (the default), only references will be included.
|
|
988
|
+
* @param {boolean} [includeLanguageList] Whether or not to include descriptions of the language tags.
|
|
989
|
+
* @param {*} [options] Override http request option.
|
|
990
|
+
* @throws {RequiredError}
|
|
991
|
+
*/
|
|
992
|
+
getVocabularyBySlug: (slug: string, includeVersions?: boolean, includeAccessPoints?: boolean, includeRelatedEntitiesAndVocabularies?: boolean, includeLanguageList?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
993
|
+
/**
|
|
994
|
+
* Returns true, if the version has a draft instance. Returns false, if there is no draft instance with that version id. The result is returned in the booleanValue property.
|
|
995
|
+
* @summary Determine if a version has a draft instance.
|
|
996
|
+
* @param {number} versionId The ID of the version to check.
|
|
997
|
+
* @param {*} [options] Override http request option.
|
|
998
|
+
* @throws {RequiredError}
|
|
999
|
+
*/
|
|
1000
|
+
hasDraftVersionById: (versionId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1001
|
+
/**
|
|
1002
|
+
* Returns true, if the vocabulary has a draft instance, and the user is authorized to access it. Returns false in every other case, i.e., if there is no draft instance with that vocabulary id, or even if there is such a draft instance, but the user is not authorized to access it. The result is returned in the booleanValue property.
|
|
1003
|
+
* @summary Determine if a vocabulary has a draft instance.
|
|
1004
|
+
* @param {number} vocabularyId The ID of the vocabulary to check.
|
|
1005
|
+
* @param {*} [options] Override http request option.
|
|
1006
|
+
* @throws {RequiredError}
|
|
1007
|
+
*/
|
|
1008
|
+
hasDraftVocabularyById: (vocabularyId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1009
|
+
/**
|
|
1010
|
+
*
|
|
1011
|
+
* @summary Query if the user has authorization to modify a current vocabulary. A Boolean result will be returned.
|
|
1012
|
+
* @param {number} vocabularyId The ID of the vocabulary to check ownership.
|
|
1013
|
+
* @param {*} [options] Override http request option.
|
|
1014
|
+
* @throws {RequiredError}
|
|
1015
|
+
*/
|
|
1016
|
+
ownsVocabularyById: (vocabularyId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1017
|
+
/**
|
|
1018
|
+
*
|
|
1019
|
+
* @summary Update a related entity.
|
|
1020
|
+
* @param {number} relatedEntityId The ID of the related entity to be updated.
|
|
1021
|
+
* @param {RelatedEntity} body The new value of the related entity.
|
|
1022
|
+
* @param {*} [options] Override http request option.
|
|
1023
|
+
* @throws {RequiredError}
|
|
1024
|
+
*/
|
|
1025
|
+
updateRelatedEntity: (relatedEntityId: number, body: RelatedEntity, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1026
|
+
/**
|
|
1027
|
+
*
|
|
1028
|
+
* @summary Update a vocabulary.
|
|
1029
|
+
* @param {number} vocabularyId The ID of the vocabulary to be updated.
|
|
1030
|
+
* @param {Vocabulary} body The vocabulary to be updated.
|
|
1031
|
+
* @param {*} [options] Override http request option.
|
|
1032
|
+
* @throws {RequiredError}
|
|
1033
|
+
*/
|
|
1034
|
+
updateVocabulary: (vocabularyId: number, body: Vocabulary, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1035
|
+
};
|
|
1036
|
+
/**
|
|
1037
|
+
* ResourcesApi - functional programming interface
|
|
1038
|
+
*/
|
|
1039
|
+
export declare const ResourcesApiFp: (configuration?: Configuration) => {
|
|
1040
|
+
/**
|
|
1041
|
+
*
|
|
1042
|
+
* @summary Create a new related entity.
|
|
1043
|
+
* @param {RelatedEntity} body The related entity to be added.
|
|
1044
|
+
* @param {*} [options] Override http request option.
|
|
1045
|
+
* @throws {RequiredError}
|
|
1046
|
+
*/
|
|
1047
|
+
createRelatedEntity(body: RelatedEntity, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RelatedEntity>>;
|
|
1048
|
+
/**
|
|
1049
|
+
* The response contains the ID of the resulting upload in the integerValue field, and the sanitized filename in the stringValue field.
|
|
1050
|
+
* @summary Upload a file.
|
|
1051
|
+
* @param {string} owner The owner of the upload
|
|
1052
|
+
* @param {string} format The type of the upload
|
|
1053
|
+
* @param {File} file The file to upload
|
|
1054
|
+
* @param {*} [options] Override http request option.
|
|
1055
|
+
* @throws {RequiredError}
|
|
1056
|
+
*/
|
|
1057
|
+
createUpload(owner: string, format: string, file: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Result>>;
|
|
1058
|
+
/**
|
|
1059
|
+
*
|
|
1060
|
+
* @summary Create a new vocabulary.
|
|
1061
|
+
* @param {Vocabulary} body The vocabulary to be added.
|
|
1062
|
+
* @param {*} [options] Override http request option.
|
|
1063
|
+
* @throws {RequiredError}
|
|
1064
|
+
*/
|
|
1065
|
+
createVocabulary(body: Vocabulary, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Vocabulary>>;
|
|
1066
|
+
/**
|
|
1067
|
+
*
|
|
1068
|
+
* @summary Delete a related entity.
|
|
1069
|
+
* @param {number} relatedEntityId The ID of the related entity to be deleted.
|
|
1070
|
+
* @param {*} [options] Override http request option.
|
|
1071
|
+
* @throws {RequiredError}
|
|
1072
|
+
*/
|
|
1073
|
+
deleteRelatedEntity(relatedEntityId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1074
|
+
/**
|
|
1075
|
+
*
|
|
1076
|
+
* @summary Delete a vocabulary.
|
|
1077
|
+
* @param {number} vocabularyId The ID of the vocabulary to be deleted.
|
|
1078
|
+
* @param {boolean} [deleteCurrent] Whether or not to delete the current version.
|
|
1079
|
+
* @param {boolean} [deleteDraft] Whether or not to delete the draft version.
|
|
1080
|
+
* @param {*} [options] Override http request option.
|
|
1081
|
+
* @throws {RequiredError}
|
|
1082
|
+
*/
|
|
1083
|
+
deleteVocabulary(vocabularyId: number, deleteCurrent?: boolean, deleteDraft?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1084
|
+
/**
|
|
1085
|
+
* In this version of the download method, a download format is specified as a query parameter. The response will include a Content-Disposition header that specifies a full filename based on the underlying data; its extension may be different from the value of the format query parameter.
|
|
1086
|
+
* @summary Get a download.
|
|
1087
|
+
* @param {number} downloadId The Id of the download.
|
|
1088
|
+
* @param {string} [format] The format of the download. This must be a filename extension without the period, e.g., \"rdf\".
|
|
1089
|
+
* @param {*} [options] Override http request option.
|
|
1090
|
+
* @throws {RequiredError}
|
|
1091
|
+
*/
|
|
1092
|
+
download(downloadId: number, format?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
1093
|
+
/**
|
|
1094
|
+
* In this version of the download method, the last component of the URL specifies a filename and an extension. The response will include a Content-Disposition header that specifies a filename and extension based on the underlying data; they may be different from the values specified.
|
|
1095
|
+
* @summary Get a download.
|
|
1096
|
+
* @param {number} downloadId The Id of the download.
|
|
1097
|
+
* @param {string} filename The filename of the download.
|
|
1098
|
+
* @param {string} extension The format of the download. This must be a filename extension without the period, e.g., \"rdf\".
|
|
1099
|
+
* @param {*} [options] Override http request option.
|
|
1100
|
+
* @throws {RequiredError}
|
|
1101
|
+
*/
|
|
1102
|
+
downloadWithFilename(downloadId: number, filename: string, extension: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
1103
|
+
/**
|
|
1104
|
+
*
|
|
1105
|
+
* @summary Get the current access points of a version, by its version id.
|
|
1106
|
+
* @param {number} versionId The ID of the version from which to get the current access points.
|
|
1107
|
+
* @param {*} [options] Override http request option.
|
|
1108
|
+
* @throws {RequiredError}
|
|
1109
|
+
*/
|
|
1110
|
+
getAccessPointsForVersionById(versionId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessPointList>>;
|
|
1111
|
+
/**
|
|
1112
|
+
* The result list contains one element for each vocabulary owned by the caller. The status attribute will be \"draft\" if there is only a draft instance of the vocabulary; in this case, hasDraft will be true. Otherwise, status will be either \"published\" or \"deprecated\", and hasDraft will be true if there is also a draft instance.
|
|
1113
|
+
* @summary Get a list of vocabularies owned by the caller.
|
|
1114
|
+
* @param {*} [options] Override http request option.
|
|
1115
|
+
* @throws {RequiredError}
|
|
1116
|
+
*/
|
|
1117
|
+
getOwnedVocabularies(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OwnedVocabularyList>>;
|
|
1118
|
+
/**
|
|
1119
|
+
*
|
|
1120
|
+
* @summary Get all current related entities, optionally, filtered by related entity type. Results do not include related entity identifiers.
|
|
1121
|
+
* @param {GetRelatedEntitiesRelatedEntityTypeEnum} [relatedEntityType] The type of the related entities to get.
|
|
1122
|
+
* @param {*} [options] Override http request option.
|
|
1123
|
+
* @throws {RequiredError}
|
|
1124
|
+
*/
|
|
1125
|
+
getRelatedEntities(relatedEntityType?: GetRelatedEntitiesRelatedEntityTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RelatedEntityList>>;
|
|
1126
|
+
/**
|
|
1127
|
+
*
|
|
1128
|
+
* @summary Get the current related entities of a vocabulary, by its vocabulary id.
|
|
1129
|
+
* @param {number} vocabularyId The ID of the vocabulary from which to get the current related entities.
|
|
1130
|
+
* @param {*} [options] Override http request option.
|
|
1131
|
+
* @throws {RequiredError}
|
|
1132
|
+
*/
|
|
1133
|
+
getRelatedEntitiesForVocabularyById(vocabularyId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RelatedEntityList>>;
|
|
1134
|
+
/**
|
|
1135
|
+
*
|
|
1136
|
+
* @summary Get a current related entity by its id.
|
|
1137
|
+
* @param {number} relatedEntityId The ID of the related entity to get.
|
|
1138
|
+
* @param {*} [options] Override http request option.
|
|
1139
|
+
* @throws {RequiredError}
|
|
1140
|
+
*/
|
|
1141
|
+
getRelatedEntityById(relatedEntityId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RelatedEntity>>;
|
|
1142
|
+
/**
|
|
1143
|
+
*
|
|
1144
|
+
* @summary Get the current concept tree of a version, by its version id.
|
|
1145
|
+
* @param {number} versionId The ID of the version from which to get the concept tree.
|
|
1146
|
+
* @param {*} [options] Override http request option.
|
|
1147
|
+
* @throws {RequiredError}
|
|
1148
|
+
*/
|
|
1149
|
+
getVersionArtefactConceptTree(versionId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
1150
|
+
/**
|
|
1151
|
+
*
|
|
1152
|
+
* @summary Get the current version artefacts of a version, by its version id. Results can be filtered by version artefact type.
|
|
1153
|
+
* @param {number} versionId The ID of the version from which to get the version artefacts.
|
|
1154
|
+
* @param {GetVersionArtefactsTypeEnum} [type] Version artefact type used to filter results.
|
|
1155
|
+
* @param {*} [options] Override http request option.
|
|
1156
|
+
* @throws {RequiredError}
|
|
1157
|
+
*/
|
|
1158
|
+
getVersionArtefacts(versionId: number, type?: GetVersionArtefactsTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VersionArtefactList>>;
|
|
1159
|
+
/**
|
|
1160
|
+
*
|
|
1161
|
+
* @summary Get a current version by its id.
|
|
1162
|
+
* @param {number} versionId The ID of the version to get.
|
|
1163
|
+
* @param {*} [options] Override http request option.
|
|
1164
|
+
* @throws {RequiredError}
|
|
1165
|
+
*/
|
|
1166
|
+
getVersionById(versionId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Version>>;
|
|
1167
|
+
/**
|
|
1168
|
+
*
|
|
1169
|
+
* @summary Get the current versions of a vocabulary, by its vocabulary id. The results are returned in reverse order of release date.
|
|
1170
|
+
* @param {number} vocabularyId The ID of the vocabulary from which to get the current versions.
|
|
1171
|
+
* @param {*} [options] Override http request option.
|
|
1172
|
+
* @throws {RequiredError}
|
|
1173
|
+
*/
|
|
1174
|
+
getVersionsForVocabularyById(vocabularyId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VersionList>>;
|
|
1175
|
+
/**
|
|
1176
|
+
*
|
|
1177
|
+
* @summary Get all the current vocabularies. This includes both published and deprecated vocabularies.
|
|
1178
|
+
* @param {*} [options] Override http request option.
|
|
1179
|
+
* @throws {RequiredError}
|
|
1180
|
+
*/
|
|
1181
|
+
getVocabularies(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VocabularyList>>;
|
|
1182
|
+
/**
|
|
1183
|
+
*
|
|
1184
|
+
* @summary Get all current vocabularies related to a related entity, by the related entity\'s id.
|
|
1185
|
+
* @param {number} relatedEntityId The ID of the related entity for which to get the vocabularies related to it.
|
|
1186
|
+
* @param {*} [options] Override http request option.
|
|
1187
|
+
* @throws {RequiredError}
|
|
1188
|
+
*/
|
|
1189
|
+
getVocabulariesRelatedToRelatedEntityById(relatedEntityId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReverseRelatedVocabularyList>>;
|
|
1190
|
+
/**
|
|
1191
|
+
*
|
|
1192
|
+
* @summary Get all current vocabularies related to a vocabulary, by its vocabulary id.
|
|
1193
|
+
* @param {number} vocabularyId The ID of the vocabulary for which to get the vocabularies related to it.
|
|
1194
|
+
* @param {*} [options] Override http request option.
|
|
1195
|
+
* @throws {RequiredError}
|
|
1196
|
+
*/
|
|
1197
|
+
getVocabulariesRelatedToVocabularyById(vocabularyId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReverseRelatedVocabularyList>>;
|
|
1198
|
+
/**
|
|
1199
|
+
*
|
|
1200
|
+
* @summary Get a current vocabulary by its id.
|
|
1201
|
+
* @param {number} vocabularyId The ID of the vocabulary to get.
|
|
1202
|
+
* @param {boolean} [includeVersions] Whether or not to include version elements. If enabled, versions are returned in reverse order of release date.
|
|
1203
|
+
* @param {boolean} [includeAccessPoints] Whether or not to include access points. Setting this to true forces includeVersions also to be true.
|
|
1204
|
+
* @param {boolean} [includeRelatedEntitiesAndVocabularies] Whether or not to include full details of related entities, and top-level details of related vocabularies. If false (the default), only references will be included.
|
|
1205
|
+
* @param {boolean} [includeLanguageList] Whether or not to include descriptions of the language tags.
|
|
1206
|
+
* @param {*} [options] Override http request option.
|
|
1207
|
+
* @throws {RequiredError}
|
|
1208
|
+
*/
|
|
1209
|
+
getVocabularyById(vocabularyId: number, includeVersions?: boolean, includeAccessPoints?: boolean, includeRelatedEntitiesAndVocabularies?: boolean, includeLanguageList?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Vocabulary>>;
|
|
1210
|
+
/**
|
|
1211
|
+
* Access points that have source=SYSTEM are stripped out.
|
|
1212
|
+
* @summary Get a vocabulary by its id, for editing.
|
|
1213
|
+
* @param {number} vocabularyId The ID of the vocabulary to get for editing.
|
|
1214
|
+
* @param {*} [options] Override http request option.
|
|
1215
|
+
* @throws {RequiredError}
|
|
1216
|
+
*/
|
|
1217
|
+
getVocabularyByIdEdit(vocabularyId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Vocabulary>>;
|
|
1218
|
+
/**
|
|
1219
|
+
*
|
|
1220
|
+
* @summary Get a current vocabulary by its slug.
|
|
1221
|
+
* @param {string} slug The slug of the vocabulary to get.
|
|
1222
|
+
* @param {boolean} [includeVersions] Whether or not to include version elements. If enabled, versions are returned in reverse order of release date.
|
|
1223
|
+
* @param {boolean} [includeAccessPoints] Whether or not to include access points. Setting this to true forces includeVersions also to be true.
|
|
1224
|
+
* @param {boolean} [includeRelatedEntitiesAndVocabularies] Whether or not to include full details of related entities, and top-level details of related vocabularies. If false (the default), only references will be included.
|
|
1225
|
+
* @param {boolean} [includeLanguageList] Whether or not to include descriptions of the language tags.
|
|
1226
|
+
* @param {*} [options] Override http request option.
|
|
1227
|
+
* @throws {RequiredError}
|
|
1228
|
+
*/
|
|
1229
|
+
getVocabularyBySlug(slug: string, includeVersions?: boolean, includeAccessPoints?: boolean, includeRelatedEntitiesAndVocabularies?: boolean, includeLanguageList?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Vocabulary>>;
|
|
1230
|
+
/**
|
|
1231
|
+
* Returns true, if the version has a draft instance. Returns false, if there is no draft instance with that version id. The result is returned in the booleanValue property.
|
|
1232
|
+
* @summary Determine if a version has a draft instance.
|
|
1233
|
+
* @param {number} versionId The ID of the version to check.
|
|
1234
|
+
* @param {*} [options] Override http request option.
|
|
1235
|
+
* @throws {RequiredError}
|
|
1236
|
+
*/
|
|
1237
|
+
hasDraftVersionById(versionId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Result>>;
|
|
1238
|
+
/**
|
|
1239
|
+
* Returns true, if the vocabulary has a draft instance, and the user is authorized to access it. Returns false in every other case, i.e., if there is no draft instance with that vocabulary id, or even if there is such a draft instance, but the user is not authorized to access it. The result is returned in the booleanValue property.
|
|
1240
|
+
* @summary Determine if a vocabulary has a draft instance.
|
|
1241
|
+
* @param {number} vocabularyId The ID of the vocabulary to check.
|
|
1242
|
+
* @param {*} [options] Override http request option.
|
|
1243
|
+
* @throws {RequiredError}
|
|
1244
|
+
*/
|
|
1245
|
+
hasDraftVocabularyById(vocabularyId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Result>>;
|
|
1246
|
+
/**
|
|
1247
|
+
*
|
|
1248
|
+
* @summary Query if the user has authorization to modify a current vocabulary. A Boolean result will be returned.
|
|
1249
|
+
* @param {number} vocabularyId The ID of the vocabulary to check ownership.
|
|
1250
|
+
* @param {*} [options] Override http request option.
|
|
1251
|
+
* @throws {RequiredError}
|
|
1252
|
+
*/
|
|
1253
|
+
ownsVocabularyById(vocabularyId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Result>>;
|
|
1254
|
+
/**
|
|
1255
|
+
*
|
|
1256
|
+
* @summary Update a related entity.
|
|
1257
|
+
* @param {number} relatedEntityId The ID of the related entity to be updated.
|
|
1258
|
+
* @param {RelatedEntity} body The new value of the related entity.
|
|
1259
|
+
* @param {*} [options] Override http request option.
|
|
1260
|
+
* @throws {RequiredError}
|
|
1261
|
+
*/
|
|
1262
|
+
updateRelatedEntity(relatedEntityId: number, body: RelatedEntity, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RelatedEntity>>;
|
|
1263
|
+
/**
|
|
1264
|
+
*
|
|
1265
|
+
* @summary Update a vocabulary.
|
|
1266
|
+
* @param {number} vocabularyId The ID of the vocabulary to be updated.
|
|
1267
|
+
* @param {Vocabulary} body The vocabulary to be updated.
|
|
1268
|
+
* @param {*} [options] Override http request option.
|
|
1269
|
+
* @throws {RequiredError}
|
|
1270
|
+
*/
|
|
1271
|
+
updateVocabulary(vocabularyId: number, body: Vocabulary, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Vocabulary>>;
|
|
1272
|
+
};
|
|
1273
|
+
/**
|
|
1274
|
+
* ResourcesApi - factory interface
|
|
1275
|
+
*/
|
|
1276
|
+
export declare const ResourcesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1277
|
+
/**
|
|
1278
|
+
*
|
|
1279
|
+
* @summary Create a new related entity.
|
|
1280
|
+
* @param {RelatedEntity} body The related entity to be added.
|
|
1281
|
+
* @param {*} [options] Override http request option.
|
|
1282
|
+
* @throws {RequiredError}
|
|
1283
|
+
*/
|
|
1284
|
+
createRelatedEntity(body: RelatedEntity, options?: RawAxiosRequestConfig): AxiosPromise<RelatedEntity>;
|
|
1285
|
+
/**
|
|
1286
|
+
* The response contains the ID of the resulting upload in the integerValue field, and the sanitized filename in the stringValue field.
|
|
1287
|
+
* @summary Upload a file.
|
|
1288
|
+
* @param {string} owner The owner of the upload
|
|
1289
|
+
* @param {string} format The type of the upload
|
|
1290
|
+
* @param {File} file The file to upload
|
|
1291
|
+
* @param {*} [options] Override http request option.
|
|
1292
|
+
* @throws {RequiredError}
|
|
1293
|
+
*/
|
|
1294
|
+
createUpload(owner: string, format: string, file: File, options?: RawAxiosRequestConfig): AxiosPromise<Result>;
|
|
1295
|
+
/**
|
|
1296
|
+
*
|
|
1297
|
+
* @summary Create a new vocabulary.
|
|
1298
|
+
* @param {Vocabulary} body The vocabulary to be added.
|
|
1299
|
+
* @param {*} [options] Override http request option.
|
|
1300
|
+
* @throws {RequiredError}
|
|
1301
|
+
*/
|
|
1302
|
+
createVocabulary(body: Vocabulary, options?: RawAxiosRequestConfig): AxiosPromise<Vocabulary>;
|
|
1303
|
+
/**
|
|
1304
|
+
*
|
|
1305
|
+
* @summary Delete a related entity.
|
|
1306
|
+
* @param {number} relatedEntityId The ID of the related entity to be deleted.
|
|
1307
|
+
* @param {*} [options] Override http request option.
|
|
1308
|
+
* @throws {RequiredError}
|
|
1309
|
+
*/
|
|
1310
|
+
deleteRelatedEntity(relatedEntityId: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1311
|
+
/**
|
|
1312
|
+
*
|
|
1313
|
+
* @summary Delete a vocabulary.
|
|
1314
|
+
* @param {number} vocabularyId The ID of the vocabulary to be deleted.
|
|
1315
|
+
* @param {boolean} [deleteCurrent] Whether or not to delete the current version.
|
|
1316
|
+
* @param {boolean} [deleteDraft] Whether or not to delete the draft version.
|
|
1317
|
+
* @param {*} [options] Override http request option.
|
|
1318
|
+
* @throws {RequiredError}
|
|
1319
|
+
*/
|
|
1320
|
+
deleteVocabulary(vocabularyId: number, deleteCurrent?: boolean, deleteDraft?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1321
|
+
/**
|
|
1322
|
+
* In this version of the download method, a download format is specified as a query parameter. The response will include a Content-Disposition header that specifies a full filename based on the underlying data; its extension may be different from the value of the format query parameter.
|
|
1323
|
+
* @summary Get a download.
|
|
1324
|
+
* @param {number} downloadId The Id of the download.
|
|
1325
|
+
* @param {string} [format] The format of the download. This must be a filename extension without the period, e.g., \"rdf\".
|
|
1326
|
+
* @param {*} [options] Override http request option.
|
|
1327
|
+
* @throws {RequiredError}
|
|
1328
|
+
*/
|
|
1329
|
+
download(downloadId: number, format?: string, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
1330
|
+
/**
|
|
1331
|
+
* In this version of the download method, the last component of the URL specifies a filename and an extension. The response will include a Content-Disposition header that specifies a filename and extension based on the underlying data; they may be different from the values specified.
|
|
1332
|
+
* @summary Get a download.
|
|
1333
|
+
* @param {number} downloadId The Id of the download.
|
|
1334
|
+
* @param {string} filename The filename of the download.
|
|
1335
|
+
* @param {string} extension The format of the download. This must be a filename extension without the period, e.g., \"rdf\".
|
|
1336
|
+
* @param {*} [options] Override http request option.
|
|
1337
|
+
* @throws {RequiredError}
|
|
1338
|
+
*/
|
|
1339
|
+
downloadWithFilename(downloadId: number, filename: string, extension: string, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
1340
|
+
/**
|
|
1341
|
+
*
|
|
1342
|
+
* @summary Get the current access points of a version, by its version id.
|
|
1343
|
+
* @param {number} versionId The ID of the version from which to get the current access points.
|
|
1344
|
+
* @param {*} [options] Override http request option.
|
|
1345
|
+
* @throws {RequiredError}
|
|
1346
|
+
*/
|
|
1347
|
+
getAccessPointsForVersionById(versionId: number, options?: RawAxiosRequestConfig): AxiosPromise<AccessPointList>;
|
|
1348
|
+
/**
|
|
1349
|
+
* The result list contains one element for each vocabulary owned by the caller. The status attribute will be \"draft\" if there is only a draft instance of the vocabulary; in this case, hasDraft will be true. Otherwise, status will be either \"published\" or \"deprecated\", and hasDraft will be true if there is also a draft instance.
|
|
1350
|
+
* @summary Get a list of vocabularies owned by the caller.
|
|
1351
|
+
* @param {*} [options] Override http request option.
|
|
1352
|
+
* @throws {RequiredError}
|
|
1353
|
+
*/
|
|
1354
|
+
getOwnedVocabularies(options?: RawAxiosRequestConfig): AxiosPromise<OwnedVocabularyList>;
|
|
1355
|
+
/**
|
|
1356
|
+
*
|
|
1357
|
+
* @summary Get all current related entities, optionally, filtered by related entity type. Results do not include related entity identifiers.
|
|
1358
|
+
* @param {GetRelatedEntitiesRelatedEntityTypeEnum} [relatedEntityType] The type of the related entities to get.
|
|
1359
|
+
* @param {*} [options] Override http request option.
|
|
1360
|
+
* @throws {RequiredError}
|
|
1361
|
+
*/
|
|
1362
|
+
getRelatedEntities(relatedEntityType?: GetRelatedEntitiesRelatedEntityTypeEnum, options?: RawAxiosRequestConfig): AxiosPromise<RelatedEntityList>;
|
|
1363
|
+
/**
|
|
1364
|
+
*
|
|
1365
|
+
* @summary Get the current related entities of a vocabulary, by its vocabulary id.
|
|
1366
|
+
* @param {number} vocabularyId The ID of the vocabulary from which to get the current related entities.
|
|
1367
|
+
* @param {*} [options] Override http request option.
|
|
1368
|
+
* @throws {RequiredError}
|
|
1369
|
+
*/
|
|
1370
|
+
getRelatedEntitiesForVocabularyById(vocabularyId: number, options?: RawAxiosRequestConfig): AxiosPromise<RelatedEntityList>;
|
|
1371
|
+
/**
|
|
1372
|
+
*
|
|
1373
|
+
* @summary Get a current related entity by its id.
|
|
1374
|
+
* @param {number} relatedEntityId The ID of the related entity to get.
|
|
1375
|
+
* @param {*} [options] Override http request option.
|
|
1376
|
+
* @throws {RequiredError}
|
|
1377
|
+
*/
|
|
1378
|
+
getRelatedEntityById(relatedEntityId: number, options?: RawAxiosRequestConfig): AxiosPromise<RelatedEntity>;
|
|
1379
|
+
/**
|
|
1380
|
+
*
|
|
1381
|
+
* @summary Get the current concept tree of a version, by its version id.
|
|
1382
|
+
* @param {number} versionId The ID of the version from which to get the concept tree.
|
|
1383
|
+
* @param {*} [options] Override http request option.
|
|
1384
|
+
* @throws {RequiredError}
|
|
1385
|
+
*/
|
|
1386
|
+
getVersionArtefactConceptTree(versionId: number, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
1387
|
+
/**
|
|
1388
|
+
*
|
|
1389
|
+
* @summary Get the current version artefacts of a version, by its version id. Results can be filtered by version artefact type.
|
|
1390
|
+
* @param {number} versionId The ID of the version from which to get the version artefacts.
|
|
1391
|
+
* @param {GetVersionArtefactsTypeEnum} [type] Version artefact type used to filter results.
|
|
1392
|
+
* @param {*} [options] Override http request option.
|
|
1393
|
+
* @throws {RequiredError}
|
|
1394
|
+
*/
|
|
1395
|
+
getVersionArtefacts(versionId: number, type?: GetVersionArtefactsTypeEnum, options?: RawAxiosRequestConfig): AxiosPromise<VersionArtefactList>;
|
|
1396
|
+
/**
|
|
1397
|
+
*
|
|
1398
|
+
* @summary Get a current version by its id.
|
|
1399
|
+
* @param {number} versionId The ID of the version to get.
|
|
1400
|
+
* @param {*} [options] Override http request option.
|
|
1401
|
+
* @throws {RequiredError}
|
|
1402
|
+
*/
|
|
1403
|
+
getVersionById(versionId: number, options?: RawAxiosRequestConfig): AxiosPromise<Version>;
|
|
1404
|
+
/**
|
|
1405
|
+
*
|
|
1406
|
+
* @summary Get the current versions of a vocabulary, by its vocabulary id. The results are returned in reverse order of release date.
|
|
1407
|
+
* @param {number} vocabularyId The ID of the vocabulary from which to get the current versions.
|
|
1408
|
+
* @param {*} [options] Override http request option.
|
|
1409
|
+
* @throws {RequiredError}
|
|
1410
|
+
*/
|
|
1411
|
+
getVersionsForVocabularyById(vocabularyId: number, options?: RawAxiosRequestConfig): AxiosPromise<VersionList>;
|
|
1412
|
+
/**
|
|
1413
|
+
*
|
|
1414
|
+
* @summary Get all the current vocabularies. This includes both published and deprecated vocabularies.
|
|
1415
|
+
* @param {*} [options] Override http request option.
|
|
1416
|
+
* @throws {RequiredError}
|
|
1417
|
+
*/
|
|
1418
|
+
getVocabularies(options?: RawAxiosRequestConfig): AxiosPromise<VocabularyList>;
|
|
1419
|
+
/**
|
|
1420
|
+
*
|
|
1421
|
+
* @summary Get all current vocabularies related to a related entity, by the related entity\'s id.
|
|
1422
|
+
* @param {number} relatedEntityId The ID of the related entity for which to get the vocabularies related to it.
|
|
1423
|
+
* @param {*} [options] Override http request option.
|
|
1424
|
+
* @throws {RequiredError}
|
|
1425
|
+
*/
|
|
1426
|
+
getVocabulariesRelatedToRelatedEntityById(relatedEntityId: number, options?: RawAxiosRequestConfig): AxiosPromise<ReverseRelatedVocabularyList>;
|
|
1427
|
+
/**
|
|
1428
|
+
*
|
|
1429
|
+
* @summary Get all current vocabularies related to a vocabulary, by its vocabulary id.
|
|
1430
|
+
* @param {number} vocabularyId The ID of the vocabulary for which to get the vocabularies related to it.
|
|
1431
|
+
* @param {*} [options] Override http request option.
|
|
1432
|
+
* @throws {RequiredError}
|
|
1433
|
+
*/
|
|
1434
|
+
getVocabulariesRelatedToVocabularyById(vocabularyId: number, options?: RawAxiosRequestConfig): AxiosPromise<ReverseRelatedVocabularyList>;
|
|
1435
|
+
/**
|
|
1436
|
+
*
|
|
1437
|
+
* @summary Get a current vocabulary by its id.
|
|
1438
|
+
* @param {number} vocabularyId The ID of the vocabulary to get.
|
|
1439
|
+
* @param {boolean} [includeVersions] Whether or not to include version elements. If enabled, versions are returned in reverse order of release date.
|
|
1440
|
+
* @param {boolean} [includeAccessPoints] Whether or not to include access points. Setting this to true forces includeVersions also to be true.
|
|
1441
|
+
* @param {boolean} [includeRelatedEntitiesAndVocabularies] Whether or not to include full details of related entities, and top-level details of related vocabularies. If false (the default), only references will be included.
|
|
1442
|
+
* @param {boolean} [includeLanguageList] Whether or not to include descriptions of the language tags.
|
|
1443
|
+
* @param {*} [options] Override http request option.
|
|
1444
|
+
* @throws {RequiredError}
|
|
1445
|
+
*/
|
|
1446
|
+
getVocabularyById(vocabularyId: number, includeVersions?: boolean, includeAccessPoints?: boolean, includeRelatedEntitiesAndVocabularies?: boolean, includeLanguageList?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<Vocabulary>;
|
|
1447
|
+
/**
|
|
1448
|
+
* Access points that have source=SYSTEM are stripped out.
|
|
1449
|
+
* @summary Get a vocabulary by its id, for editing.
|
|
1450
|
+
* @param {number} vocabularyId The ID of the vocabulary to get for editing.
|
|
1451
|
+
* @param {*} [options] Override http request option.
|
|
1452
|
+
* @throws {RequiredError}
|
|
1453
|
+
*/
|
|
1454
|
+
getVocabularyByIdEdit(vocabularyId: number, options?: RawAxiosRequestConfig): AxiosPromise<Vocabulary>;
|
|
1455
|
+
/**
|
|
1456
|
+
*
|
|
1457
|
+
* @summary Get a current vocabulary by its slug.
|
|
1458
|
+
* @param {string} slug The slug of the vocabulary to get.
|
|
1459
|
+
* @param {boolean} [includeVersions] Whether or not to include version elements. If enabled, versions are returned in reverse order of release date.
|
|
1460
|
+
* @param {boolean} [includeAccessPoints] Whether or not to include access points. Setting this to true forces includeVersions also to be true.
|
|
1461
|
+
* @param {boolean} [includeRelatedEntitiesAndVocabularies] Whether or not to include full details of related entities, and top-level details of related vocabularies. If false (the default), only references will be included.
|
|
1462
|
+
* @param {boolean} [includeLanguageList] Whether or not to include descriptions of the language tags.
|
|
1463
|
+
* @param {*} [options] Override http request option.
|
|
1464
|
+
* @throws {RequiredError}
|
|
1465
|
+
*/
|
|
1466
|
+
getVocabularyBySlug(slug: string, includeVersions?: boolean, includeAccessPoints?: boolean, includeRelatedEntitiesAndVocabularies?: boolean, includeLanguageList?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<Vocabulary>;
|
|
1467
|
+
/**
|
|
1468
|
+
* Returns true, if the version has a draft instance. Returns false, if there is no draft instance with that version id. The result is returned in the booleanValue property.
|
|
1469
|
+
* @summary Determine if a version has a draft instance.
|
|
1470
|
+
* @param {number} versionId The ID of the version to check.
|
|
1471
|
+
* @param {*} [options] Override http request option.
|
|
1472
|
+
* @throws {RequiredError}
|
|
1473
|
+
*/
|
|
1474
|
+
hasDraftVersionById(versionId: number, options?: RawAxiosRequestConfig): AxiosPromise<Result>;
|
|
1475
|
+
/**
|
|
1476
|
+
* Returns true, if the vocabulary has a draft instance, and the user is authorized to access it. Returns false in every other case, i.e., if there is no draft instance with that vocabulary id, or even if there is such a draft instance, but the user is not authorized to access it. The result is returned in the booleanValue property.
|
|
1477
|
+
* @summary Determine if a vocabulary has a draft instance.
|
|
1478
|
+
* @param {number} vocabularyId The ID of the vocabulary to check.
|
|
1479
|
+
* @param {*} [options] Override http request option.
|
|
1480
|
+
* @throws {RequiredError}
|
|
1481
|
+
*/
|
|
1482
|
+
hasDraftVocabularyById(vocabularyId: number, options?: RawAxiosRequestConfig): AxiosPromise<Result>;
|
|
1483
|
+
/**
|
|
1484
|
+
*
|
|
1485
|
+
* @summary Query if the user has authorization to modify a current vocabulary. A Boolean result will be returned.
|
|
1486
|
+
* @param {number} vocabularyId The ID of the vocabulary to check ownership.
|
|
1487
|
+
* @param {*} [options] Override http request option.
|
|
1488
|
+
* @throws {RequiredError}
|
|
1489
|
+
*/
|
|
1490
|
+
ownsVocabularyById(vocabularyId: number, options?: RawAxiosRequestConfig): AxiosPromise<Result>;
|
|
1491
|
+
/**
|
|
1492
|
+
*
|
|
1493
|
+
* @summary Update a related entity.
|
|
1494
|
+
* @param {number} relatedEntityId The ID of the related entity to be updated.
|
|
1495
|
+
* @param {RelatedEntity} body The new value of the related entity.
|
|
1496
|
+
* @param {*} [options] Override http request option.
|
|
1497
|
+
* @throws {RequiredError}
|
|
1498
|
+
*/
|
|
1499
|
+
updateRelatedEntity(relatedEntityId: number, body: RelatedEntity, options?: RawAxiosRequestConfig): AxiosPromise<RelatedEntity>;
|
|
1500
|
+
/**
|
|
1501
|
+
*
|
|
1502
|
+
* @summary Update a vocabulary.
|
|
1503
|
+
* @param {number} vocabularyId The ID of the vocabulary to be updated.
|
|
1504
|
+
* @param {Vocabulary} body The vocabulary to be updated.
|
|
1505
|
+
* @param {*} [options] Override http request option.
|
|
1506
|
+
* @throws {RequiredError}
|
|
1507
|
+
*/
|
|
1508
|
+
updateVocabulary(vocabularyId: number, body: Vocabulary, options?: RawAxiosRequestConfig): AxiosPromise<Vocabulary>;
|
|
1509
|
+
};
|
|
1510
|
+
/**
|
|
1511
|
+
* ResourcesApi - object-oriented interface
|
|
1512
|
+
*/
|
|
1513
|
+
export declare class ResourcesApi extends BaseAPI {
|
|
1514
|
+
/**
|
|
1515
|
+
*
|
|
1516
|
+
* @summary Create a new related entity.
|
|
1517
|
+
* @param {RelatedEntity} body The related entity to be added.
|
|
1518
|
+
* @param {*} [options] Override http request option.
|
|
1519
|
+
* @throws {RequiredError}
|
|
1520
|
+
*/
|
|
1521
|
+
createRelatedEntity(body: RelatedEntity, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<RelatedEntity, any, {}>>;
|
|
1522
|
+
/**
|
|
1523
|
+
* The response contains the ID of the resulting upload in the integerValue field, and the sanitized filename in the stringValue field.
|
|
1524
|
+
* @summary Upload a file.
|
|
1525
|
+
* @param {string} owner The owner of the upload
|
|
1526
|
+
* @param {string} format The type of the upload
|
|
1527
|
+
* @param {File} file The file to upload
|
|
1528
|
+
* @param {*} [options] Override http request option.
|
|
1529
|
+
* @throws {RequiredError}
|
|
1530
|
+
*/
|
|
1531
|
+
createUpload(owner: string, format: string, file: File, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Result, any, {}>>;
|
|
1532
|
+
/**
|
|
1533
|
+
*
|
|
1534
|
+
* @summary Create a new vocabulary.
|
|
1535
|
+
* @param {Vocabulary} body The vocabulary to be added.
|
|
1536
|
+
* @param {*} [options] Override http request option.
|
|
1537
|
+
* @throws {RequiredError}
|
|
1538
|
+
*/
|
|
1539
|
+
createVocabulary(body: Vocabulary, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Vocabulary, any, {}>>;
|
|
1540
|
+
/**
|
|
1541
|
+
*
|
|
1542
|
+
* @summary Delete a related entity.
|
|
1543
|
+
* @param {number} relatedEntityId The ID of the related entity to be deleted.
|
|
1544
|
+
* @param {*} [options] Override http request option.
|
|
1545
|
+
* @throws {RequiredError}
|
|
1546
|
+
*/
|
|
1547
|
+
deleteRelatedEntity(relatedEntityId: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}>>;
|
|
1548
|
+
/**
|
|
1549
|
+
*
|
|
1550
|
+
* @summary Delete a vocabulary.
|
|
1551
|
+
* @param {number} vocabularyId The ID of the vocabulary to be deleted.
|
|
1552
|
+
* @param {boolean} [deleteCurrent] Whether or not to delete the current version.
|
|
1553
|
+
* @param {boolean} [deleteDraft] Whether or not to delete the draft version.
|
|
1554
|
+
* @param {*} [options] Override http request option.
|
|
1555
|
+
* @throws {RequiredError}
|
|
1556
|
+
*/
|
|
1557
|
+
deleteVocabulary(vocabularyId: number, deleteCurrent?: boolean, deleteDraft?: boolean, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}>>;
|
|
1558
|
+
/**
|
|
1559
|
+
* In this version of the download method, a download format is specified as a query parameter. The response will include a Content-Disposition header that specifies a full filename based on the underlying data; its extension may be different from the value of the format query parameter.
|
|
1560
|
+
* @summary Get a download.
|
|
1561
|
+
* @param {number} downloadId The Id of the download.
|
|
1562
|
+
* @param {string} [format] The format of the download. This must be a filename extension without the period, e.g., \"rdf\".
|
|
1563
|
+
* @param {*} [options] Override http request option.
|
|
1564
|
+
* @throws {RequiredError}
|
|
1565
|
+
*/
|
|
1566
|
+
download(downloadId: number, format?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<File, any, {}>>;
|
|
1567
|
+
/**
|
|
1568
|
+
* In this version of the download method, the last component of the URL specifies a filename and an extension. The response will include a Content-Disposition header that specifies a filename and extension based on the underlying data; they may be different from the values specified.
|
|
1569
|
+
* @summary Get a download.
|
|
1570
|
+
* @param {number} downloadId The Id of the download.
|
|
1571
|
+
* @param {string} filename The filename of the download.
|
|
1572
|
+
* @param {string} extension The format of the download. This must be a filename extension without the period, e.g., \"rdf\".
|
|
1573
|
+
* @param {*} [options] Override http request option.
|
|
1574
|
+
* @throws {RequiredError}
|
|
1575
|
+
*/
|
|
1576
|
+
downloadWithFilename(downloadId: number, filename: string, extension: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<File, any, {}>>;
|
|
1577
|
+
/**
|
|
1578
|
+
*
|
|
1579
|
+
* @summary Get the current access points of a version, by its version id.
|
|
1580
|
+
* @param {number} versionId The ID of the version from which to get the current access points.
|
|
1581
|
+
* @param {*} [options] Override http request option.
|
|
1582
|
+
* @throws {RequiredError}
|
|
1583
|
+
*/
|
|
1584
|
+
getAccessPointsForVersionById(versionId: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<AccessPointList, any, {}>>;
|
|
1585
|
+
/**
|
|
1586
|
+
* The result list contains one element for each vocabulary owned by the caller. The status attribute will be \"draft\" if there is only a draft instance of the vocabulary; in this case, hasDraft will be true. Otherwise, status will be either \"published\" or \"deprecated\", and hasDraft will be true if there is also a draft instance.
|
|
1587
|
+
* @summary Get a list of vocabularies owned by the caller.
|
|
1588
|
+
* @param {*} [options] Override http request option.
|
|
1589
|
+
* @throws {RequiredError}
|
|
1590
|
+
*/
|
|
1591
|
+
getOwnedVocabularies(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<OwnedVocabularyList, any, {}>>;
|
|
1592
|
+
/**
|
|
1593
|
+
*
|
|
1594
|
+
* @summary Get all current related entities, optionally, filtered by related entity type. Results do not include related entity identifiers.
|
|
1595
|
+
* @param {GetRelatedEntitiesRelatedEntityTypeEnum} [relatedEntityType] The type of the related entities to get.
|
|
1596
|
+
* @param {*} [options] Override http request option.
|
|
1597
|
+
* @throws {RequiredError}
|
|
1598
|
+
*/
|
|
1599
|
+
getRelatedEntities(relatedEntityType?: GetRelatedEntitiesRelatedEntityTypeEnum, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<RelatedEntityList, any, {}>>;
|
|
1600
|
+
/**
|
|
1601
|
+
*
|
|
1602
|
+
* @summary Get the current related entities of a vocabulary, by its vocabulary id.
|
|
1603
|
+
* @param {number} vocabularyId The ID of the vocabulary from which to get the current related entities.
|
|
1604
|
+
* @param {*} [options] Override http request option.
|
|
1605
|
+
* @throws {RequiredError}
|
|
1606
|
+
*/
|
|
1607
|
+
getRelatedEntitiesForVocabularyById(vocabularyId: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<RelatedEntityList, any, {}>>;
|
|
1608
|
+
/**
|
|
1609
|
+
*
|
|
1610
|
+
* @summary Get a current related entity by its id.
|
|
1611
|
+
* @param {number} relatedEntityId The ID of the related entity to get.
|
|
1612
|
+
* @param {*} [options] Override http request option.
|
|
1613
|
+
* @throws {RequiredError}
|
|
1614
|
+
*/
|
|
1615
|
+
getRelatedEntityById(relatedEntityId: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<RelatedEntity, any, {}>>;
|
|
1616
|
+
/**
|
|
1617
|
+
*
|
|
1618
|
+
* @summary Get the current concept tree of a version, by its version id.
|
|
1619
|
+
* @param {number} versionId The ID of the version from which to get the concept tree.
|
|
1620
|
+
* @param {*} [options] Override http request option.
|
|
1621
|
+
* @throws {RequiredError}
|
|
1622
|
+
*/
|
|
1623
|
+
getVersionArtefactConceptTree(versionId: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<string, any, {}>>;
|
|
1624
|
+
/**
|
|
1625
|
+
*
|
|
1626
|
+
* @summary Get the current version artefacts of a version, by its version id. Results can be filtered by version artefact type.
|
|
1627
|
+
* @param {number} versionId The ID of the version from which to get the version artefacts.
|
|
1628
|
+
* @param {GetVersionArtefactsTypeEnum} [type] Version artefact type used to filter results.
|
|
1629
|
+
* @param {*} [options] Override http request option.
|
|
1630
|
+
* @throws {RequiredError}
|
|
1631
|
+
*/
|
|
1632
|
+
getVersionArtefacts(versionId: number, type?: GetVersionArtefactsTypeEnum, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<VersionArtefactList, any, {}>>;
|
|
1633
|
+
/**
|
|
1634
|
+
*
|
|
1635
|
+
* @summary Get a current version by its id.
|
|
1636
|
+
* @param {number} versionId The ID of the version to get.
|
|
1637
|
+
* @param {*} [options] Override http request option.
|
|
1638
|
+
* @throws {RequiredError}
|
|
1639
|
+
*/
|
|
1640
|
+
getVersionById(versionId: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Version, any, {}>>;
|
|
1641
|
+
/**
|
|
1642
|
+
*
|
|
1643
|
+
* @summary Get the current versions of a vocabulary, by its vocabulary id. The results are returned in reverse order of release date.
|
|
1644
|
+
* @param {number} vocabularyId The ID of the vocabulary from which to get the current versions.
|
|
1645
|
+
* @param {*} [options] Override http request option.
|
|
1646
|
+
* @throws {RequiredError}
|
|
1647
|
+
*/
|
|
1648
|
+
getVersionsForVocabularyById(vocabularyId: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<VersionList, any, {}>>;
|
|
1649
|
+
/**
|
|
1650
|
+
*
|
|
1651
|
+
* @summary Get all the current vocabularies. This includes both published and deprecated vocabularies.
|
|
1652
|
+
* @param {*} [options] Override http request option.
|
|
1653
|
+
* @throws {RequiredError}
|
|
1654
|
+
*/
|
|
1655
|
+
getVocabularies(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<VocabularyList, any, {}>>;
|
|
1656
|
+
/**
|
|
1657
|
+
*
|
|
1658
|
+
* @summary Get all current vocabularies related to a related entity, by the related entity\'s id.
|
|
1659
|
+
* @param {number} relatedEntityId The ID of the related entity for which to get the vocabularies related to it.
|
|
1660
|
+
* @param {*} [options] Override http request option.
|
|
1661
|
+
* @throws {RequiredError}
|
|
1662
|
+
*/
|
|
1663
|
+
getVocabulariesRelatedToRelatedEntityById(relatedEntityId: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ReverseRelatedVocabularyList, any, {}>>;
|
|
1664
|
+
/**
|
|
1665
|
+
*
|
|
1666
|
+
* @summary Get all current vocabularies related to a vocabulary, by its vocabulary id.
|
|
1667
|
+
* @param {number} vocabularyId The ID of the vocabulary for which to get the vocabularies related to it.
|
|
1668
|
+
* @param {*} [options] Override http request option.
|
|
1669
|
+
* @throws {RequiredError}
|
|
1670
|
+
*/
|
|
1671
|
+
getVocabulariesRelatedToVocabularyById(vocabularyId: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ReverseRelatedVocabularyList, any, {}>>;
|
|
1672
|
+
/**
|
|
1673
|
+
*
|
|
1674
|
+
* @summary Get a current vocabulary by its id.
|
|
1675
|
+
* @param {number} vocabularyId The ID of the vocabulary to get.
|
|
1676
|
+
* @param {boolean} [includeVersions] Whether or not to include version elements. If enabled, versions are returned in reverse order of release date.
|
|
1677
|
+
* @param {boolean} [includeAccessPoints] Whether or not to include access points. Setting this to true forces includeVersions also to be true.
|
|
1678
|
+
* @param {boolean} [includeRelatedEntitiesAndVocabularies] Whether or not to include full details of related entities, and top-level details of related vocabularies. If false (the default), only references will be included.
|
|
1679
|
+
* @param {boolean} [includeLanguageList] Whether or not to include descriptions of the language tags.
|
|
1680
|
+
* @param {*} [options] Override http request option.
|
|
1681
|
+
* @throws {RequiredError}
|
|
1682
|
+
*/
|
|
1683
|
+
getVocabularyById(vocabularyId: number, includeVersions?: boolean, includeAccessPoints?: boolean, includeRelatedEntitiesAndVocabularies?: boolean, includeLanguageList?: boolean, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Vocabulary, any, {}>>;
|
|
1684
|
+
/**
|
|
1685
|
+
* Access points that have source=SYSTEM are stripped out.
|
|
1686
|
+
* @summary Get a vocabulary by its id, for editing.
|
|
1687
|
+
* @param {number} vocabularyId The ID of the vocabulary to get for editing.
|
|
1688
|
+
* @param {*} [options] Override http request option.
|
|
1689
|
+
* @throws {RequiredError}
|
|
1690
|
+
*/
|
|
1691
|
+
getVocabularyByIdEdit(vocabularyId: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Vocabulary, any, {}>>;
|
|
1692
|
+
/**
|
|
1693
|
+
*
|
|
1694
|
+
* @summary Get a current vocabulary by its slug.
|
|
1695
|
+
* @param {string} slug The slug of the vocabulary to get.
|
|
1696
|
+
* @param {boolean} [includeVersions] Whether or not to include version elements. If enabled, versions are returned in reverse order of release date.
|
|
1697
|
+
* @param {boolean} [includeAccessPoints] Whether or not to include access points. Setting this to true forces includeVersions also to be true.
|
|
1698
|
+
* @param {boolean} [includeRelatedEntitiesAndVocabularies] Whether or not to include full details of related entities, and top-level details of related vocabularies. If false (the default), only references will be included.
|
|
1699
|
+
* @param {boolean} [includeLanguageList] Whether or not to include descriptions of the language tags.
|
|
1700
|
+
* @param {*} [options] Override http request option.
|
|
1701
|
+
* @throws {RequiredError}
|
|
1702
|
+
*/
|
|
1703
|
+
getVocabularyBySlug(slug: string, includeVersions?: boolean, includeAccessPoints?: boolean, includeRelatedEntitiesAndVocabularies?: boolean, includeLanguageList?: boolean, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Vocabulary, any, {}>>;
|
|
1704
|
+
/**
|
|
1705
|
+
* Returns true, if the version has a draft instance. Returns false, if there is no draft instance with that version id. The result is returned in the booleanValue property.
|
|
1706
|
+
* @summary Determine if a version has a draft instance.
|
|
1707
|
+
* @param {number} versionId The ID of the version to check.
|
|
1708
|
+
* @param {*} [options] Override http request option.
|
|
1709
|
+
* @throws {RequiredError}
|
|
1710
|
+
*/
|
|
1711
|
+
hasDraftVersionById(versionId: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Result, any, {}>>;
|
|
1712
|
+
/**
|
|
1713
|
+
* Returns true, if the vocabulary has a draft instance, and the user is authorized to access it. Returns false in every other case, i.e., if there is no draft instance with that vocabulary id, or even if there is such a draft instance, but the user is not authorized to access it. The result is returned in the booleanValue property.
|
|
1714
|
+
* @summary Determine if a vocabulary has a draft instance.
|
|
1715
|
+
* @param {number} vocabularyId The ID of the vocabulary to check.
|
|
1716
|
+
* @param {*} [options] Override http request option.
|
|
1717
|
+
* @throws {RequiredError}
|
|
1718
|
+
*/
|
|
1719
|
+
hasDraftVocabularyById(vocabularyId: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Result, any, {}>>;
|
|
1720
|
+
/**
|
|
1721
|
+
*
|
|
1722
|
+
* @summary Query if the user has authorization to modify a current vocabulary. A Boolean result will be returned.
|
|
1723
|
+
* @param {number} vocabularyId The ID of the vocabulary to check ownership.
|
|
1724
|
+
* @param {*} [options] Override http request option.
|
|
1725
|
+
* @throws {RequiredError}
|
|
1726
|
+
*/
|
|
1727
|
+
ownsVocabularyById(vocabularyId: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Result, any, {}>>;
|
|
1728
|
+
/**
|
|
1729
|
+
*
|
|
1730
|
+
* @summary Update a related entity.
|
|
1731
|
+
* @param {number} relatedEntityId The ID of the related entity to be updated.
|
|
1732
|
+
* @param {RelatedEntity} body The new value of the related entity.
|
|
1733
|
+
* @param {*} [options] Override http request option.
|
|
1734
|
+
* @throws {RequiredError}
|
|
1735
|
+
*/
|
|
1736
|
+
updateRelatedEntity(relatedEntityId: number, body: RelatedEntity, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<RelatedEntity, any, {}>>;
|
|
1737
|
+
/**
|
|
1738
|
+
*
|
|
1739
|
+
* @summary Update a vocabulary.
|
|
1740
|
+
* @param {number} vocabularyId The ID of the vocabulary to be updated.
|
|
1741
|
+
* @param {Vocabulary} body The vocabulary to be updated.
|
|
1742
|
+
* @param {*} [options] Override http request option.
|
|
1743
|
+
* @throws {RequiredError}
|
|
1744
|
+
*/
|
|
1745
|
+
updateVocabulary(vocabularyId: number, body: Vocabulary, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Vocabulary, any, {}>>;
|
|
1746
|
+
}
|
|
1747
|
+
export declare const GetRelatedEntitiesRelatedEntityTypeEnum: {
|
|
1748
|
+
readonly Party: "party";
|
|
1749
|
+
readonly Service: "service";
|
|
1750
|
+
readonly Vocabulary: "vocabulary";
|
|
1751
|
+
};
|
|
1752
|
+
export type GetRelatedEntitiesRelatedEntityTypeEnum = typeof GetRelatedEntitiesRelatedEntityTypeEnum[keyof typeof GetRelatedEntitiesRelatedEntityTypeEnum];
|
|
1753
|
+
export declare const GetVersionArtefactsTypeEnum: {
|
|
1754
|
+
readonly ConceptList: "conceptList";
|
|
1755
|
+
readonly ConceptTree: "conceptTree";
|
|
1756
|
+
readonly HarvestPoolparty: "harvestPoolparty";
|
|
1757
|
+
readonly ResourceDocs: "resourceDocs";
|
|
1758
|
+
};
|
|
1759
|
+
export type GetVersionArtefactsTypeEnum = typeof GetVersionArtefactsTypeEnum[keyof typeof GetVersionArtefactsTypeEnum];
|
|
1760
|
+
/**
|
|
1761
|
+
* ServicesApi - axios parameter creator
|
|
1762
|
+
*/
|
|
1763
|
+
export declare const ServicesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1764
|
+
/**
|
|
1765
|
+
*
|
|
1766
|
+
* @summary Create an email subscription for an owner.
|
|
1767
|
+
* @param {string} owner Owner to subscribe to. Specify * to subscribe to notifications for all owners.
|
|
1768
|
+
* @param {string} emailAddress Subscriber email address
|
|
1769
|
+
* @param {*} [options] Override http request option.
|
|
1770
|
+
* @throws {RequiredError}
|
|
1771
|
+
*/
|
|
1772
|
+
createEmailSubscriptionOwner: (owner: string, emailAddress: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1773
|
+
/**
|
|
1774
|
+
*
|
|
1775
|
+
* @summary Create an email subscription for the system.
|
|
1776
|
+
* @param {string} emailAddress
|
|
1777
|
+
* @param {*} [options] Override http request option.
|
|
1778
|
+
* @throws {RequiredError}
|
|
1779
|
+
*/
|
|
1780
|
+
createEmailSubscriptionSystem: (emailAddress: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1781
|
+
/**
|
|
1782
|
+
*
|
|
1783
|
+
* @summary Create an email subscription for a vocabulary.
|
|
1784
|
+
* @param {number} vocabularyId The ID of the vocabulary to be subscribed to.
|
|
1785
|
+
* @param {string} emailAddress Subscriber email address
|
|
1786
|
+
* @param {*} [options] Override http request option.
|
|
1787
|
+
* @throws {RequiredError}
|
|
1788
|
+
*/
|
|
1789
|
+
createEmailSubscriptionVocabulary: (vocabularyId: number, emailAddress: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1790
|
+
/**
|
|
1791
|
+
*
|
|
1792
|
+
* @summary Delete all email subscriptions for a subscriber.
|
|
1793
|
+
* @param {string} token Subscriber authentication token
|
|
1794
|
+
* @param {*} [options] Override http request option.
|
|
1795
|
+
* @throws {RequiredError}
|
|
1796
|
+
*/
|
|
1797
|
+
deleteEmailSubscriptionAll: (token: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1798
|
+
/**
|
|
1799
|
+
*
|
|
1800
|
+
* @summary Delete an email subscription for an owner.
|
|
1801
|
+
* @param {string} token Subscriber authentication token
|
|
1802
|
+
* @param {string} owner Owner to unsubscribe from. Specify * to remove a subscription to notifications for all owners (in which case, any other existing subscriptions to individual owners will remain).
|
|
1803
|
+
* @param {*} [options] Override http request option.
|
|
1804
|
+
* @throws {RequiredError}
|
|
1805
|
+
*/
|
|
1806
|
+
deleteEmailSubscriptionOwner: (token: string, owner: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1807
|
+
/**
|
|
1808
|
+
*
|
|
1809
|
+
* @summary Delete an email subscription for the system.
|
|
1810
|
+
* @param {string} token Subscriber authentication token
|
|
1811
|
+
* @param {*} [options] Override http request option.
|
|
1812
|
+
* @throws {RequiredError}
|
|
1813
|
+
*/
|
|
1814
|
+
deleteEmailSubscriptionSystem: (token: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1815
|
+
/**
|
|
1816
|
+
*
|
|
1817
|
+
* @summary Delete an email subscription for a vocabulary.
|
|
1818
|
+
* @param {string} token Subscriber authentication token
|
|
1819
|
+
* @param {number} vocabularyId The ID of the vocabulary to be unsubscribed from.
|
|
1820
|
+
* @param {*} [options] Override http request option.
|
|
1821
|
+
* @throws {RequiredError}
|
|
1822
|
+
*/
|
|
1823
|
+
deleteEmailSubscriptionVocabulary: (token: string, vocabularyId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1824
|
+
/**
|
|
1825
|
+
*
|
|
1826
|
+
* @summary Get the email subscriptions for a subscriber.
|
|
1827
|
+
* @param {string} token Subscriber authentication token
|
|
1828
|
+
* @param {*} [options] Override http request option.
|
|
1829
|
+
* @throws {RequiredError}
|
|
1830
|
+
*/
|
|
1831
|
+
getEmailSubscriptions: (token: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1832
|
+
/**
|
|
1833
|
+
*
|
|
1834
|
+
* @summary Get the metadata for a PoolParty project.
|
|
1835
|
+
* @param {number} serverId The PoolParty server Id.
|
|
1836
|
+
* @param {string} projectId The PoolParty project Id.
|
|
1837
|
+
* @param {*} [options] Override http request option.
|
|
1838
|
+
* @throws {RequiredError}
|
|
1839
|
+
*/
|
|
1840
|
+
getPoolPartyProjectMetadata: (serverId: number, projectId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1841
|
+
/**
|
|
1842
|
+
*
|
|
1843
|
+
* @summary Get the list of PoolParty projects.
|
|
1844
|
+
* @param {number} serverId The PoolParty server Id.
|
|
1845
|
+
* @param {*} [options] Override http request option.
|
|
1846
|
+
* @throws {RequiredError}
|
|
1847
|
+
*/
|
|
1848
|
+
getPoolPartyProjects: (serverId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1849
|
+
/**
|
|
1850
|
+
*
|
|
1851
|
+
* @summary Get the user\'s profile data.
|
|
1852
|
+
* @param {*} [options] Override http request option.
|
|
1853
|
+
* @throws {RequiredError}
|
|
1854
|
+
*/
|
|
1855
|
+
getUserData: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1856
|
+
/**
|
|
1857
|
+
* Because of standard web browser behaviour on receipt of redirects, it is not possible to use this method in the swagger-ui interface. On a successful redirect, you will either see no response, or the browser will follow the redirect.
|
|
1858
|
+
* @summary Perform a redirect.
|
|
1859
|
+
* @param {string} [mode] The mode of resolution. For now, only \"current\" is supported, and this is the default.
|
|
1860
|
+
* @param {string} [iri] The IRI to be resolved.
|
|
1861
|
+
* @param {string} [suffix] An optional suffix to be appended to the redirected URL.
|
|
1862
|
+
* @param {*} [options] Override http request option.
|
|
1863
|
+
* @throws {RequiredError}
|
|
1864
|
+
*/
|
|
1865
|
+
lookupIRI: (mode?: string, iri?: string, suffix?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1866
|
+
/**
|
|
1867
|
+
*
|
|
1868
|
+
* @summary Perform a search of vocabulary metadata.
|
|
1869
|
+
* @param {string} filtersJson Filters that define the search parameters. The filters are specified as a JSON object. Examples of keys/values supported: \\\'\\\"q\\\":\\\"query term\\\"\\\': query term; \\\'\\\"pp\\\":10\\\' number of results per page;\\\'\\\"p\\\":3\\\' page number of results; \\\'\\\"sort\\\":\\\"zToA\\\"\\\': sort order of results; \\\'\\\"widgetable\\\":true\\\': select only widgetable vocabularies. Facets are also specified with filters: e.g., \\\'\\\"publisher\\\":\\\"CSIRO\\\"\\\'. Supported facets: \\\"access\\\", \\\"format\\\", \\\"language\\\", \\\"licence\\\", \\\"publisher\\\", \\\"subject_labels\\\".
|
|
1870
|
+
* @param {*} [options] Override http request option.
|
|
1871
|
+
* @throws {RequiredError}
|
|
1872
|
+
*/
|
|
1873
|
+
search: (filtersJson: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1874
|
+
/**
|
|
1875
|
+
*
|
|
1876
|
+
* @summary Perform a search of vocabulary resources.
|
|
1877
|
+
* @param {string} filtersJson Filters that define the search parameters. The filters are specified as a JSON object. Examples of keys/values supported: \\\'\\\"q\\\":\\\"query term\\\"\\\': query term; \\\'\\\"pp\\\":10\\\' number of results per page;\\\'\\\"p\\\":3\\\' page number of results; \\\'\\\"sort\\\":\\\"zToA\\\"\\\': sort order of results; \\\'\\\"collapse_expand\\\":false\\\' disable collapse/expand results with the same IRI; \\\'\\\"language\\\":\\\"[\\\"NONE\\\",\\\"en\\\"]\\\"\\\': limit to specified languages (to include results for all languages, don\\\'t specify a value for this filter). Facets are also specified with filters: e.g., \\\'\\\"publisher\\\":\\\"CSIRO\\\"\\\'. Supported facets: \\\"publisher\\\", \\\"rdf_type\\\", \\\"status\\\", \\\"subject_labels\\\".
|
|
1878
|
+
* @param {*} [options] Override http request option.
|
|
1879
|
+
* @throws {RequiredError}
|
|
1880
|
+
*/
|
|
1881
|
+
searchResources: (filtersJson: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1882
|
+
};
|
|
1883
|
+
/**
|
|
1884
|
+
* ServicesApi - functional programming interface
|
|
1885
|
+
*/
|
|
1886
|
+
export declare const ServicesApiFp: (configuration?: Configuration) => {
|
|
1887
|
+
/**
|
|
1888
|
+
*
|
|
1889
|
+
* @summary Create an email subscription for an owner.
|
|
1890
|
+
* @param {string} owner Owner to subscribe to. Specify * to subscribe to notifications for all owners.
|
|
1891
|
+
* @param {string} emailAddress Subscriber email address
|
|
1892
|
+
* @param {*} [options] Override http request option.
|
|
1893
|
+
* @throws {RequiredError}
|
|
1894
|
+
*/
|
|
1895
|
+
createEmailSubscriptionOwner(owner: string, emailAddress: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1896
|
+
/**
|
|
1897
|
+
*
|
|
1898
|
+
* @summary Create an email subscription for the system.
|
|
1899
|
+
* @param {string} emailAddress
|
|
1900
|
+
* @param {*} [options] Override http request option.
|
|
1901
|
+
* @throws {RequiredError}
|
|
1902
|
+
*/
|
|
1903
|
+
createEmailSubscriptionSystem(emailAddress: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1904
|
+
/**
|
|
1905
|
+
*
|
|
1906
|
+
* @summary Create an email subscription for a vocabulary.
|
|
1907
|
+
* @param {number} vocabularyId The ID of the vocabulary to be subscribed to.
|
|
1908
|
+
* @param {string} emailAddress Subscriber email address
|
|
1909
|
+
* @param {*} [options] Override http request option.
|
|
1910
|
+
* @throws {RequiredError}
|
|
1911
|
+
*/
|
|
1912
|
+
createEmailSubscriptionVocabulary(vocabularyId: number, emailAddress: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1913
|
+
/**
|
|
1914
|
+
*
|
|
1915
|
+
* @summary Delete all email subscriptions for a subscriber.
|
|
1916
|
+
* @param {string} token Subscriber authentication token
|
|
1917
|
+
* @param {*} [options] Override http request option.
|
|
1918
|
+
* @throws {RequiredError}
|
|
1919
|
+
*/
|
|
1920
|
+
deleteEmailSubscriptionAll(token: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1921
|
+
/**
|
|
1922
|
+
*
|
|
1923
|
+
* @summary Delete an email subscription for an owner.
|
|
1924
|
+
* @param {string} token Subscriber authentication token
|
|
1925
|
+
* @param {string} owner Owner to unsubscribe from. Specify * to remove a subscription to notifications for all owners (in which case, any other existing subscriptions to individual owners will remain).
|
|
1926
|
+
* @param {*} [options] Override http request option.
|
|
1927
|
+
* @throws {RequiredError}
|
|
1928
|
+
*/
|
|
1929
|
+
deleteEmailSubscriptionOwner(token: string, owner: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1930
|
+
/**
|
|
1931
|
+
*
|
|
1932
|
+
* @summary Delete an email subscription for the system.
|
|
1933
|
+
* @param {string} token Subscriber authentication token
|
|
1934
|
+
* @param {*} [options] Override http request option.
|
|
1935
|
+
* @throws {RequiredError}
|
|
1936
|
+
*/
|
|
1937
|
+
deleteEmailSubscriptionSystem(token: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1938
|
+
/**
|
|
1939
|
+
*
|
|
1940
|
+
* @summary Delete an email subscription for a vocabulary.
|
|
1941
|
+
* @param {string} token Subscriber authentication token
|
|
1942
|
+
* @param {number} vocabularyId The ID of the vocabulary to be unsubscribed from.
|
|
1943
|
+
* @param {*} [options] Override http request option.
|
|
1944
|
+
* @throws {RequiredError}
|
|
1945
|
+
*/
|
|
1946
|
+
deleteEmailSubscriptionVocabulary(token: string, vocabularyId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1947
|
+
/**
|
|
1948
|
+
*
|
|
1949
|
+
* @summary Get the email subscriptions for a subscriber.
|
|
1950
|
+
* @param {string} token Subscriber authentication token
|
|
1951
|
+
* @param {*} [options] Override http request option.
|
|
1952
|
+
* @throws {RequiredError}
|
|
1953
|
+
*/
|
|
1954
|
+
getEmailSubscriptions(token: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SubscriptionList>>;
|
|
1955
|
+
/**
|
|
1956
|
+
*
|
|
1957
|
+
* @summary Get the metadata for a PoolParty project.
|
|
1958
|
+
* @param {number} serverId The PoolParty server Id.
|
|
1959
|
+
* @param {string} projectId The PoolParty project Id.
|
|
1960
|
+
* @param {*} [options] Override http request option.
|
|
1961
|
+
* @throws {RequiredError}
|
|
1962
|
+
*/
|
|
1963
|
+
getPoolPartyProjectMetadata(serverId: number, projectId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
1964
|
+
/**
|
|
1965
|
+
*
|
|
1966
|
+
* @summary Get the list of PoolParty projects.
|
|
1967
|
+
* @param {number} serverId The PoolParty server Id.
|
|
1968
|
+
* @param {*} [options] Override http request option.
|
|
1969
|
+
* @throws {RequiredError}
|
|
1970
|
+
*/
|
|
1971
|
+
getPoolPartyProjects(serverId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
1972
|
+
/**
|
|
1973
|
+
*
|
|
1974
|
+
* @summary Get the user\'s profile data.
|
|
1975
|
+
* @param {*} [options] Override http request option.
|
|
1976
|
+
* @throws {RequiredError}
|
|
1977
|
+
*/
|
|
1978
|
+
getUserData(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserInfo>>;
|
|
1979
|
+
/**
|
|
1980
|
+
* Because of standard web browser behaviour on receipt of redirects, it is not possible to use this method in the swagger-ui interface. On a successful redirect, you will either see no response, or the browser will follow the redirect.
|
|
1981
|
+
* @summary Perform a redirect.
|
|
1982
|
+
* @param {string} [mode] The mode of resolution. For now, only \"current\" is supported, and this is the default.
|
|
1983
|
+
* @param {string} [iri] The IRI to be resolved.
|
|
1984
|
+
* @param {string} [suffix] An optional suffix to be appended to the redirected URL.
|
|
1985
|
+
* @param {*} [options] Override http request option.
|
|
1986
|
+
* @throws {RequiredError}
|
|
1987
|
+
*/
|
|
1988
|
+
lookupIRI(mode?: string, iri?: string, suffix?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1989
|
+
/**
|
|
1990
|
+
*
|
|
1991
|
+
* @summary Perform a search of vocabulary metadata.
|
|
1992
|
+
* @param {string} filtersJson Filters that define the search parameters. The filters are specified as a JSON object. Examples of keys/values supported: \\\'\\\"q\\\":\\\"query term\\\"\\\': query term; \\\'\\\"pp\\\":10\\\' number of results per page;\\\'\\\"p\\\":3\\\' page number of results; \\\'\\\"sort\\\":\\\"zToA\\\"\\\': sort order of results; \\\'\\\"widgetable\\\":true\\\': select only widgetable vocabularies. Facets are also specified with filters: e.g., \\\'\\\"publisher\\\":\\\"CSIRO\\\"\\\'. Supported facets: \\\"access\\\", \\\"format\\\", \\\"language\\\", \\\"licence\\\", \\\"publisher\\\", \\\"subject_labels\\\".
|
|
1993
|
+
* @param {*} [options] Override http request option.
|
|
1994
|
+
* @throws {RequiredError}
|
|
1995
|
+
*/
|
|
1996
|
+
search(filtersJson: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
1997
|
+
/**
|
|
1998
|
+
*
|
|
1999
|
+
* @summary Perform a search of vocabulary resources.
|
|
2000
|
+
* @param {string} filtersJson Filters that define the search parameters. The filters are specified as a JSON object. Examples of keys/values supported: \\\'\\\"q\\\":\\\"query term\\\"\\\': query term; \\\'\\\"pp\\\":10\\\' number of results per page;\\\'\\\"p\\\":3\\\' page number of results; \\\'\\\"sort\\\":\\\"zToA\\\"\\\': sort order of results; \\\'\\\"collapse_expand\\\":false\\\' disable collapse/expand results with the same IRI; \\\'\\\"language\\\":\\\"[\\\"NONE\\\",\\\"en\\\"]\\\"\\\': limit to specified languages (to include results for all languages, don\\\'t specify a value for this filter). Facets are also specified with filters: e.g., \\\'\\\"publisher\\\":\\\"CSIRO\\\"\\\'. Supported facets: \\\"publisher\\\", \\\"rdf_type\\\", \\\"status\\\", \\\"subject_labels\\\".
|
|
2001
|
+
* @param {*} [options] Override http request option.
|
|
2002
|
+
* @throws {RequiredError}
|
|
2003
|
+
*/
|
|
2004
|
+
searchResources(filtersJson: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
2005
|
+
};
|
|
2006
|
+
/**
|
|
2007
|
+
* ServicesApi - factory interface
|
|
2008
|
+
*/
|
|
2009
|
+
export declare const ServicesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2010
|
+
/**
|
|
2011
|
+
*
|
|
2012
|
+
* @summary Create an email subscription for an owner.
|
|
2013
|
+
* @param {string} owner Owner to subscribe to. Specify * to subscribe to notifications for all owners.
|
|
2014
|
+
* @param {string} emailAddress Subscriber email address
|
|
2015
|
+
* @param {*} [options] Override http request option.
|
|
2016
|
+
* @throws {RequiredError}
|
|
2017
|
+
*/
|
|
2018
|
+
createEmailSubscriptionOwner(owner: string, emailAddress: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
2019
|
+
/**
|
|
2020
|
+
*
|
|
2021
|
+
* @summary Create an email subscription for the system.
|
|
2022
|
+
* @param {string} emailAddress
|
|
2023
|
+
* @param {*} [options] Override http request option.
|
|
2024
|
+
* @throws {RequiredError}
|
|
2025
|
+
*/
|
|
2026
|
+
createEmailSubscriptionSystem(emailAddress: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
2027
|
+
/**
|
|
2028
|
+
*
|
|
2029
|
+
* @summary Create an email subscription for a vocabulary.
|
|
2030
|
+
* @param {number} vocabularyId The ID of the vocabulary to be subscribed to.
|
|
2031
|
+
* @param {string} emailAddress Subscriber email address
|
|
2032
|
+
* @param {*} [options] Override http request option.
|
|
2033
|
+
* @throws {RequiredError}
|
|
2034
|
+
*/
|
|
2035
|
+
createEmailSubscriptionVocabulary(vocabularyId: number, emailAddress: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
2036
|
+
/**
|
|
2037
|
+
*
|
|
2038
|
+
* @summary Delete all email subscriptions for a subscriber.
|
|
2039
|
+
* @param {string} token Subscriber authentication token
|
|
2040
|
+
* @param {*} [options] Override http request option.
|
|
2041
|
+
* @throws {RequiredError}
|
|
2042
|
+
*/
|
|
2043
|
+
deleteEmailSubscriptionAll(token: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
2044
|
+
/**
|
|
2045
|
+
*
|
|
2046
|
+
* @summary Delete an email subscription for an owner.
|
|
2047
|
+
* @param {string} token Subscriber authentication token
|
|
2048
|
+
* @param {string} owner Owner to unsubscribe from. Specify * to remove a subscription to notifications for all owners (in which case, any other existing subscriptions to individual owners will remain).
|
|
2049
|
+
* @param {*} [options] Override http request option.
|
|
2050
|
+
* @throws {RequiredError}
|
|
2051
|
+
*/
|
|
2052
|
+
deleteEmailSubscriptionOwner(token: string, owner: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
2053
|
+
/**
|
|
2054
|
+
*
|
|
2055
|
+
* @summary Delete an email subscription for the system.
|
|
2056
|
+
* @param {string} token Subscriber authentication token
|
|
2057
|
+
* @param {*} [options] Override http request option.
|
|
2058
|
+
* @throws {RequiredError}
|
|
2059
|
+
*/
|
|
2060
|
+
deleteEmailSubscriptionSystem(token: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
2061
|
+
/**
|
|
2062
|
+
*
|
|
2063
|
+
* @summary Delete an email subscription for a vocabulary.
|
|
2064
|
+
* @param {string} token Subscriber authentication token
|
|
2065
|
+
* @param {number} vocabularyId The ID of the vocabulary to be unsubscribed from.
|
|
2066
|
+
* @param {*} [options] Override http request option.
|
|
2067
|
+
* @throws {RequiredError}
|
|
2068
|
+
*/
|
|
2069
|
+
deleteEmailSubscriptionVocabulary(token: string, vocabularyId: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
2070
|
+
/**
|
|
2071
|
+
*
|
|
2072
|
+
* @summary Get the email subscriptions for a subscriber.
|
|
2073
|
+
* @param {string} token Subscriber authentication token
|
|
2074
|
+
* @param {*} [options] Override http request option.
|
|
2075
|
+
* @throws {RequiredError}
|
|
2076
|
+
*/
|
|
2077
|
+
getEmailSubscriptions(token: string, options?: RawAxiosRequestConfig): AxiosPromise<SubscriptionList>;
|
|
2078
|
+
/**
|
|
2079
|
+
*
|
|
2080
|
+
* @summary Get the metadata for a PoolParty project.
|
|
2081
|
+
* @param {number} serverId The PoolParty server Id.
|
|
2082
|
+
* @param {string} projectId The PoolParty project Id.
|
|
2083
|
+
* @param {*} [options] Override http request option.
|
|
2084
|
+
* @throws {RequiredError}
|
|
2085
|
+
*/
|
|
2086
|
+
getPoolPartyProjectMetadata(serverId: number, projectId: string, options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
2087
|
+
/**
|
|
2088
|
+
*
|
|
2089
|
+
* @summary Get the list of PoolParty projects.
|
|
2090
|
+
* @param {number} serverId The PoolParty server Id.
|
|
2091
|
+
* @param {*} [options] Override http request option.
|
|
2092
|
+
* @throws {RequiredError}
|
|
2093
|
+
*/
|
|
2094
|
+
getPoolPartyProjects(serverId: number, options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
2095
|
+
/**
|
|
2096
|
+
*
|
|
2097
|
+
* @summary Get the user\'s profile data.
|
|
2098
|
+
* @param {*} [options] Override http request option.
|
|
2099
|
+
* @throws {RequiredError}
|
|
2100
|
+
*/
|
|
2101
|
+
getUserData(options?: RawAxiosRequestConfig): AxiosPromise<UserInfo>;
|
|
2102
|
+
/**
|
|
2103
|
+
* Because of standard web browser behaviour on receipt of redirects, it is not possible to use this method in the swagger-ui interface. On a successful redirect, you will either see no response, or the browser will follow the redirect.
|
|
2104
|
+
* @summary Perform a redirect.
|
|
2105
|
+
* @param {string} [mode] The mode of resolution. For now, only \"current\" is supported, and this is the default.
|
|
2106
|
+
* @param {string} [iri] The IRI to be resolved.
|
|
2107
|
+
* @param {string} [suffix] An optional suffix to be appended to the redirected URL.
|
|
2108
|
+
* @param {*} [options] Override http request option.
|
|
2109
|
+
* @throws {RequiredError}
|
|
2110
|
+
*/
|
|
2111
|
+
lookupIRI(mode?: string, iri?: string, suffix?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
2112
|
+
/**
|
|
2113
|
+
*
|
|
2114
|
+
* @summary Perform a search of vocabulary metadata.
|
|
2115
|
+
* @param {string} filtersJson Filters that define the search parameters. The filters are specified as a JSON object. Examples of keys/values supported: \\\'\\\"q\\\":\\\"query term\\\"\\\': query term; \\\'\\\"pp\\\":10\\\' number of results per page;\\\'\\\"p\\\":3\\\' page number of results; \\\'\\\"sort\\\":\\\"zToA\\\"\\\': sort order of results; \\\'\\\"widgetable\\\":true\\\': select only widgetable vocabularies. Facets are also specified with filters: e.g., \\\'\\\"publisher\\\":\\\"CSIRO\\\"\\\'. Supported facets: \\\"access\\\", \\\"format\\\", \\\"language\\\", \\\"licence\\\", \\\"publisher\\\", \\\"subject_labels\\\".
|
|
2116
|
+
* @param {*} [options] Override http request option.
|
|
2117
|
+
* @throws {RequiredError}
|
|
2118
|
+
*/
|
|
2119
|
+
search(filtersJson: string, options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
2120
|
+
/**
|
|
2121
|
+
*
|
|
2122
|
+
* @summary Perform a search of vocabulary resources.
|
|
2123
|
+
* @param {string} filtersJson Filters that define the search parameters. The filters are specified as a JSON object. Examples of keys/values supported: \\\'\\\"q\\\":\\\"query term\\\"\\\': query term; \\\'\\\"pp\\\":10\\\' number of results per page;\\\'\\\"p\\\":3\\\' page number of results; \\\'\\\"sort\\\":\\\"zToA\\\"\\\': sort order of results; \\\'\\\"collapse_expand\\\":false\\\' disable collapse/expand results with the same IRI; \\\'\\\"language\\\":\\\"[\\\"NONE\\\",\\\"en\\\"]\\\"\\\': limit to specified languages (to include results for all languages, don\\\'t specify a value for this filter). Facets are also specified with filters: e.g., \\\'\\\"publisher\\\":\\\"CSIRO\\\"\\\'. Supported facets: \\\"publisher\\\", \\\"rdf_type\\\", \\\"status\\\", \\\"subject_labels\\\".
|
|
2124
|
+
* @param {*} [options] Override http request option.
|
|
2125
|
+
* @throws {RequiredError}
|
|
2126
|
+
*/
|
|
2127
|
+
searchResources(filtersJson: string, options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
2128
|
+
};
|
|
2129
|
+
/**
|
|
2130
|
+
* ServicesApi - object-oriented interface
|
|
2131
|
+
*/
|
|
2132
|
+
export declare class ServicesApi extends BaseAPI {
|
|
2133
|
+
/**
|
|
2134
|
+
*
|
|
2135
|
+
* @summary Create an email subscription for an owner.
|
|
2136
|
+
* @param {string} owner Owner to subscribe to. Specify * to subscribe to notifications for all owners.
|
|
2137
|
+
* @param {string} emailAddress Subscriber email address
|
|
2138
|
+
* @param {*} [options] Override http request option.
|
|
2139
|
+
* @throws {RequiredError}
|
|
2140
|
+
*/
|
|
2141
|
+
createEmailSubscriptionOwner(owner: string, emailAddress: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}>>;
|
|
2142
|
+
/**
|
|
2143
|
+
*
|
|
2144
|
+
* @summary Create an email subscription for the system.
|
|
2145
|
+
* @param {string} emailAddress
|
|
2146
|
+
* @param {*} [options] Override http request option.
|
|
2147
|
+
* @throws {RequiredError}
|
|
2148
|
+
*/
|
|
2149
|
+
createEmailSubscriptionSystem(emailAddress: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}>>;
|
|
2150
|
+
/**
|
|
2151
|
+
*
|
|
2152
|
+
* @summary Create an email subscription for a vocabulary.
|
|
2153
|
+
* @param {number} vocabularyId The ID of the vocabulary to be subscribed to.
|
|
2154
|
+
* @param {string} emailAddress Subscriber email address
|
|
2155
|
+
* @param {*} [options] Override http request option.
|
|
2156
|
+
* @throws {RequiredError}
|
|
2157
|
+
*/
|
|
2158
|
+
createEmailSubscriptionVocabulary(vocabularyId: number, emailAddress: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}>>;
|
|
2159
|
+
/**
|
|
2160
|
+
*
|
|
2161
|
+
* @summary Delete all email subscriptions for a subscriber.
|
|
2162
|
+
* @param {string} token Subscriber authentication token
|
|
2163
|
+
* @param {*} [options] Override http request option.
|
|
2164
|
+
* @throws {RequiredError}
|
|
2165
|
+
*/
|
|
2166
|
+
deleteEmailSubscriptionAll(token: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}>>;
|
|
2167
|
+
/**
|
|
2168
|
+
*
|
|
2169
|
+
* @summary Delete an email subscription for an owner.
|
|
2170
|
+
* @param {string} token Subscriber authentication token
|
|
2171
|
+
* @param {string} owner Owner to unsubscribe from. Specify * to remove a subscription to notifications for all owners (in which case, any other existing subscriptions to individual owners will remain).
|
|
2172
|
+
* @param {*} [options] Override http request option.
|
|
2173
|
+
* @throws {RequiredError}
|
|
2174
|
+
*/
|
|
2175
|
+
deleteEmailSubscriptionOwner(token: string, owner: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}>>;
|
|
2176
|
+
/**
|
|
2177
|
+
*
|
|
2178
|
+
* @summary Delete an email subscription for the system.
|
|
2179
|
+
* @param {string} token Subscriber authentication token
|
|
2180
|
+
* @param {*} [options] Override http request option.
|
|
2181
|
+
* @throws {RequiredError}
|
|
2182
|
+
*/
|
|
2183
|
+
deleteEmailSubscriptionSystem(token: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}>>;
|
|
2184
|
+
/**
|
|
2185
|
+
*
|
|
2186
|
+
* @summary Delete an email subscription for a vocabulary.
|
|
2187
|
+
* @param {string} token Subscriber authentication token
|
|
2188
|
+
* @param {number} vocabularyId The ID of the vocabulary to be unsubscribed from.
|
|
2189
|
+
* @param {*} [options] Override http request option.
|
|
2190
|
+
* @throws {RequiredError}
|
|
2191
|
+
*/
|
|
2192
|
+
deleteEmailSubscriptionVocabulary(token: string, vocabularyId: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}>>;
|
|
2193
|
+
/**
|
|
2194
|
+
*
|
|
2195
|
+
* @summary Get the email subscriptions for a subscriber.
|
|
2196
|
+
* @param {string} token Subscriber authentication token
|
|
2197
|
+
* @param {*} [options] Override http request option.
|
|
2198
|
+
* @throws {RequiredError}
|
|
2199
|
+
*/
|
|
2200
|
+
getEmailSubscriptions(token: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SubscriptionList, any, {}>>;
|
|
2201
|
+
/**
|
|
2202
|
+
*
|
|
2203
|
+
* @summary Get the metadata for a PoolParty project.
|
|
2204
|
+
* @param {number} serverId The PoolParty server Id.
|
|
2205
|
+
* @param {string} projectId The PoolParty project Id.
|
|
2206
|
+
* @param {*} [options] Override http request option.
|
|
2207
|
+
* @throws {RequiredError}
|
|
2208
|
+
*/
|
|
2209
|
+
getPoolPartyProjectMetadata(serverId: number, projectId: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<object, any, {}>>;
|
|
2210
|
+
/**
|
|
2211
|
+
*
|
|
2212
|
+
* @summary Get the list of PoolParty projects.
|
|
2213
|
+
* @param {number} serverId The PoolParty server Id.
|
|
2214
|
+
* @param {*} [options] Override http request option.
|
|
2215
|
+
* @throws {RequiredError}
|
|
2216
|
+
*/
|
|
2217
|
+
getPoolPartyProjects(serverId: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<object, any, {}>>;
|
|
2218
|
+
/**
|
|
2219
|
+
*
|
|
2220
|
+
* @summary Get the user\'s profile data.
|
|
2221
|
+
* @param {*} [options] Override http request option.
|
|
2222
|
+
* @throws {RequiredError}
|
|
2223
|
+
*/
|
|
2224
|
+
getUserData(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UserInfo, any, {}>>;
|
|
2225
|
+
/**
|
|
2226
|
+
* Because of standard web browser behaviour on receipt of redirects, it is not possible to use this method in the swagger-ui interface. On a successful redirect, you will either see no response, or the browser will follow the redirect.
|
|
2227
|
+
* @summary Perform a redirect.
|
|
2228
|
+
* @param {string} [mode] The mode of resolution. For now, only \"current\" is supported, and this is the default.
|
|
2229
|
+
* @param {string} [iri] The IRI to be resolved.
|
|
2230
|
+
* @param {string} [suffix] An optional suffix to be appended to the redirected URL.
|
|
2231
|
+
* @param {*} [options] Override http request option.
|
|
2232
|
+
* @throws {RequiredError}
|
|
2233
|
+
*/
|
|
2234
|
+
lookupIRI(mode?: string, iri?: string, suffix?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}>>;
|
|
2235
|
+
/**
|
|
2236
|
+
*
|
|
2237
|
+
* @summary Perform a search of vocabulary metadata.
|
|
2238
|
+
* @param {string} filtersJson Filters that define the search parameters. The filters are specified as a JSON object. Examples of keys/values supported: \\\'\\\"q\\\":\\\"query term\\\"\\\': query term; \\\'\\\"pp\\\":10\\\' number of results per page;\\\'\\\"p\\\":3\\\' page number of results; \\\'\\\"sort\\\":\\\"zToA\\\"\\\': sort order of results; \\\'\\\"widgetable\\\":true\\\': select only widgetable vocabularies. Facets are also specified with filters: e.g., \\\'\\\"publisher\\\":\\\"CSIRO\\\"\\\'. Supported facets: \\\"access\\\", \\\"format\\\", \\\"language\\\", \\\"licence\\\", \\\"publisher\\\", \\\"subject_labels\\\".
|
|
2239
|
+
* @param {*} [options] Override http request option.
|
|
2240
|
+
* @throws {RequiredError}
|
|
2241
|
+
*/
|
|
2242
|
+
search(filtersJson: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<object, any, {}>>;
|
|
2243
|
+
/**
|
|
2244
|
+
*
|
|
2245
|
+
* @summary Perform a search of vocabulary resources.
|
|
2246
|
+
* @param {string} filtersJson Filters that define the search parameters. The filters are specified as a JSON object. Examples of keys/values supported: \\\'\\\"q\\\":\\\"query term\\\"\\\': query term; \\\'\\\"pp\\\":10\\\' number of results per page;\\\'\\\"p\\\":3\\\' page number of results; \\\'\\\"sort\\\":\\\"zToA\\\"\\\': sort order of results; \\\'\\\"collapse_expand\\\":false\\\' disable collapse/expand results with the same IRI; \\\'\\\"language\\\":\\\"[\\\"NONE\\\",\\\"en\\\"]\\\"\\\': limit to specified languages (to include results for all languages, don\\\'t specify a value for this filter). Facets are also specified with filters: e.g., \\\'\\\"publisher\\\":\\\"CSIRO\\\"\\\'. Supported facets: \\\"publisher\\\", \\\"rdf_type\\\", \\\"status\\\", \\\"subject_labels\\\".
|
|
2247
|
+
* @param {*} [options] Override http request option.
|
|
2248
|
+
* @throws {RequiredError}
|
|
2249
|
+
*/
|
|
2250
|
+
searchResources(filtersJson: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<object, any, {}>>;
|
|
2251
|
+
}
|
|
2252
|
+
/**
|
|
2253
|
+
* UtilitiesApi - axios parameter creator
|
|
2254
|
+
*/
|
|
2255
|
+
export declare const UtilitiesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2256
|
+
/**
|
|
2257
|
+
*
|
|
2258
|
+
* @summary Generate a slug.
|
|
2259
|
+
* @param {string} input String from which the slug is generated.
|
|
2260
|
+
* @param {*} [options] Override http request option.
|
|
2261
|
+
* @throws {RequiredError}
|
|
2262
|
+
*/
|
|
2263
|
+
generateSlug: (input: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2264
|
+
/**
|
|
2265
|
+
* If the tag is valid, the response will contain the canonical form of the tag, andits full description. If the tag is invalid, the response will contain the errors generated during parsing.
|
|
2266
|
+
* @summary Parse a BCP 47 language tag.
|
|
2267
|
+
* @param {string} tag Language tag to be parsed.
|
|
2268
|
+
* @param {*} [options] Override http request option.
|
|
2269
|
+
* @throws {RequiredError}
|
|
2270
|
+
*/
|
|
2271
|
+
parseLanguageTag: (tag: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2272
|
+
/**
|
|
2273
|
+
* The response contains a list element for every tag included in the input. For each invalid tag, the list element has no attributes.
|
|
2274
|
+
* @summary Parse several BCP 47 language tags.
|
|
2275
|
+
* @param {Array<string>} tags Language tags to be parsed.
|
|
2276
|
+
* @param {*} [options] Override http request option.
|
|
2277
|
+
* @throws {RequiredError}
|
|
2278
|
+
*/
|
|
2279
|
+
parseLanguageTags: (tags: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2280
|
+
};
|
|
2281
|
+
/**
|
|
2282
|
+
* UtilitiesApi - functional programming interface
|
|
2283
|
+
*/
|
|
2284
|
+
export declare const UtilitiesApiFp: (configuration?: Configuration) => {
|
|
2285
|
+
/**
|
|
2286
|
+
*
|
|
2287
|
+
* @summary Generate a slug.
|
|
2288
|
+
* @param {string} input String from which the slug is generated.
|
|
2289
|
+
* @param {*} [options] Override http request option.
|
|
2290
|
+
* @throws {RequiredError}
|
|
2291
|
+
*/
|
|
2292
|
+
generateSlug(input: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Result>>;
|
|
2293
|
+
/**
|
|
2294
|
+
* If the tag is valid, the response will contain the canonical form of the tag, andits full description. If the tag is invalid, the response will contain the errors generated during parsing.
|
|
2295
|
+
* @summary Parse a BCP 47 language tag.
|
|
2296
|
+
* @param {string} tag Language tag to be parsed.
|
|
2297
|
+
* @param {*} [options] Override http request option.
|
|
2298
|
+
* @throws {RequiredError}
|
|
2299
|
+
*/
|
|
2300
|
+
parseLanguageTag(tag: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LanguageDetails>>;
|
|
2301
|
+
/**
|
|
2302
|
+
* The response contains a list element for every tag included in the input. For each invalid tag, the list element has no attributes.
|
|
2303
|
+
* @summary Parse several BCP 47 language tags.
|
|
2304
|
+
* @param {Array<string>} tags Language tags to be parsed.
|
|
2305
|
+
* @param {*} [options] Override http request option.
|
|
2306
|
+
* @throws {RequiredError}
|
|
2307
|
+
*/
|
|
2308
|
+
parseLanguageTags(tags: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LanguageList>>;
|
|
2309
|
+
};
|
|
2310
|
+
/**
|
|
2311
|
+
* UtilitiesApi - factory interface
|
|
2312
|
+
*/
|
|
2313
|
+
export declare const UtilitiesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2314
|
+
/**
|
|
2315
|
+
*
|
|
2316
|
+
* @summary Generate a slug.
|
|
2317
|
+
* @param {string} input String from which the slug is generated.
|
|
2318
|
+
* @param {*} [options] Override http request option.
|
|
2319
|
+
* @throws {RequiredError}
|
|
2320
|
+
*/
|
|
2321
|
+
generateSlug(input: string, options?: RawAxiosRequestConfig): AxiosPromise<Result>;
|
|
2322
|
+
/**
|
|
2323
|
+
* If the tag is valid, the response will contain the canonical form of the tag, andits full description. If the tag is invalid, the response will contain the errors generated during parsing.
|
|
2324
|
+
* @summary Parse a BCP 47 language tag.
|
|
2325
|
+
* @param {string} tag Language tag to be parsed.
|
|
2326
|
+
* @param {*} [options] Override http request option.
|
|
2327
|
+
* @throws {RequiredError}
|
|
2328
|
+
*/
|
|
2329
|
+
parseLanguageTag(tag: string, options?: RawAxiosRequestConfig): AxiosPromise<LanguageDetails>;
|
|
2330
|
+
/**
|
|
2331
|
+
* The response contains a list element for every tag included in the input. For each invalid tag, the list element has no attributes.
|
|
2332
|
+
* @summary Parse several BCP 47 language tags.
|
|
2333
|
+
* @param {Array<string>} tags Language tags to be parsed.
|
|
2334
|
+
* @param {*} [options] Override http request option.
|
|
2335
|
+
* @throws {RequiredError}
|
|
2336
|
+
*/
|
|
2337
|
+
parseLanguageTags(tags: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<LanguageList>;
|
|
2338
|
+
};
|
|
2339
|
+
/**
|
|
2340
|
+
* UtilitiesApi - object-oriented interface
|
|
2341
|
+
*/
|
|
2342
|
+
export declare class UtilitiesApi extends BaseAPI {
|
|
2343
|
+
/**
|
|
2344
|
+
*
|
|
2345
|
+
* @summary Generate a slug.
|
|
2346
|
+
* @param {string} input String from which the slug is generated.
|
|
2347
|
+
* @param {*} [options] Override http request option.
|
|
2348
|
+
* @throws {RequiredError}
|
|
2349
|
+
*/
|
|
2350
|
+
generateSlug(input: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Result, any, {}>>;
|
|
2351
|
+
/**
|
|
2352
|
+
* If the tag is valid, the response will contain the canonical form of the tag, andits full description. If the tag is invalid, the response will contain the errors generated during parsing.
|
|
2353
|
+
* @summary Parse a BCP 47 language tag.
|
|
2354
|
+
* @param {string} tag Language tag to be parsed.
|
|
2355
|
+
* @param {*} [options] Override http request option.
|
|
2356
|
+
* @throws {RequiredError}
|
|
2357
|
+
*/
|
|
2358
|
+
parseLanguageTag(tag: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<LanguageDetails, any, {}>>;
|
|
2359
|
+
/**
|
|
2360
|
+
* The response contains a list element for every tag included in the input. For each invalid tag, the list element has no attributes.
|
|
2361
|
+
* @summary Parse several BCP 47 language tags.
|
|
2362
|
+
* @param {Array<string>} tags Language tags to be parsed.
|
|
2363
|
+
* @param {*} [options] Override http request option.
|
|
2364
|
+
* @throws {RequiredError}
|
|
2365
|
+
*/
|
|
2366
|
+
parseLanguageTags(tags: Array<string>, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<LanguageList, any, {}>>;
|
|
2367
|
+
}
|