@researchdatabox/raido-openapi-generated-node 0.0.2 → 5.0.0-RC1
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 +1679 -0
- package/dist/api.js +701 -16
- package/dist/base.d.ts +55 -0
- package/dist/base.js +69 -0
- package/dist/common.d.ts +65 -0
- package/dist/common.js +144 -0
- package/dist/configuration.d.ts +83 -0
- package/dist/configuration.js +92 -0
- package/dist/{model/accessType.js → index.d.ts} +3 -9
- package/dist/index.js +32 -0
- package/package.json +12 -7
- package/dist/api/adminExperimentalApi.js +0 -1092
- package/dist/api/apis.js +0 -41
- package/dist/api/basicRaidExperimentalApi.js +0 -561
- package/dist/api/publicExperimentalApi.js +0 -264
- package/dist/api/raidoStableV1Api.js +0 -369
- package/dist/api/unapprovedExperimentalApi.js +0 -147
- package/dist/model/access.js +0 -44
- package/dist/model/accessBlock.js +0 -35
- package/dist/model/accessStatement.js +0 -35
- package/dist/model/accessTypeWithSchemaUri.js +0 -35
- package/dist/model/alternateIdentifier.js +0 -35
- package/dist/model/alternateIdentifierBlock.js +0 -35
- package/dist/model/alternateUrl.js +0 -29
- package/dist/model/alternateUrlBlock.js +0 -29
- package/dist/model/apiKey.js +0 -74
- package/dist/model/appUser.js +0 -83
- package/dist/model/appUserExtraV1.js +0 -44
- package/dist/model/authzRequestExtraV1.js +0 -104
- package/dist/model/authzRequestStatus.js +0 -20
- package/dist/model/closedRaid.js +0 -35
- package/dist/model/contributor.js +0 -59
- package/dist/model/contributorBlock.js +0 -47
- package/dist/model/contributorIdentifierSchemeType.js +0 -18
- package/dist/model/contributorPosition.js +0 -47
- package/dist/model/contributorPositionRaidMetadataSchemaType.js +0 -22
- package/dist/model/contributorPositionSchemeType.js +0 -18
- package/dist/model/contributorPositionWithSchemaUri.js +0 -47
- package/dist/model/contributorRole.js +0 -35
- package/dist/model/contributorRoleCreditNisoOrgType.js +0 -31
- package/dist/model/contributorRoleSchemeType.js +0 -18
- package/dist/model/contributorRoleWithSchemaUri.js +0 -35
- package/dist/model/datesBlock.js +0 -35
- package/dist/model/description.js +0 -41
- package/dist/model/descriptionBlock.js +0 -35
- package/dist/model/descriptionType.js +0 -19
- package/dist/model/descriptionTypeWithSchemaUri.js +0 -35
- package/dist/model/failureResponse.js +0 -53
- package/dist/model/generateApiTokenRequest.js +0 -29
- package/dist/model/generateApiTokenResponse.js +0 -35
- package/dist/model/id.js +0 -89
- package/dist/model/idBlock.js +0 -95
- package/dist/model/language.js +0 -35
- package/dist/model/legacyMetadataSchemaV1.js +0 -68
- package/dist/model/migrateLegacyRaidRequest.js +0 -35
- package/dist/model/migrateLegacyRaidRequestMintRequest.js +0 -41
- package/dist/model/mintRaidoSchemaV1Request.js +0 -38
- package/dist/model/mintRaidoSchemaV1RequestMintRequest.js +0 -32
- package/dist/model/mintResponse.js +0 -41
- package/dist/model/modelDate.js +0 -38
- package/dist/model/models.js +0 -506
- package/dist/model/organisation.js +0 -41
- package/dist/model/organisationBlock.js +0 -41
- package/dist/model/organisationIdentifierSchemeType.js +0 -18
- package/dist/model/organisationRole.js +0 -47
- package/dist/model/organisationRoleSchemeType.js +0 -18
- package/dist/model/organisationRoleType.js +0 -22
- package/dist/model/organisationRoleWithSchemaUri.js +0 -47
- package/dist/model/owner.js +0 -47
- package/dist/model/publicClosedMetadataSchemaV1.js +0 -41
- package/dist/model/publicRaidMetadataSchemaV1.js +0 -116
- package/dist/model/publicReadRaidMetadataResponseV1.js +0 -116
- package/dist/model/publicReadRaidResponseV3.js +0 -56
- package/dist/model/publicServicePoint.js +0 -38
- package/dist/model/raidCreateRequest.js +0 -107
- package/dist/model/raidDto.js +0 -107
- package/dist/model/raidListItemV2.js +0 -53
- package/dist/model/raidListItemV3.js +0 -53
- package/dist/model/raidListRequestV2.js +0 -35
- package/dist/model/raidUpdateRequest.js +0 -107
- package/dist/model/raidoMetadataSchemaV1.js +0 -116
- package/dist/model/raidoMetadataSchemaV2.js +0 -116
- package/dist/model/raidoMetaschema.js +0 -22
- package/dist/model/raidoMetaschemaV2.js +0 -23
- package/dist/model/readRaidResponseV2.js +0 -71
- package/dist/model/readRaidV2Request.js +0 -29
- package/dist/model/registrationAgency.js +0 -38
- package/dist/model/relatedObject.js +0 -47
- package/dist/model/relatedObjectBlock.js +0 -53
- package/dist/model/relatedObjectCategory.js +0 -35
- package/dist/model/relatedObjectType.js +0 -35
- package/dist/model/relatedRaid.js +0 -35
- package/dist/model/relatedRaidBlock.js +0 -41
- package/dist/model/relatedRaidType.js +0 -35
- package/dist/model/servicePoint.js +0 -74
- package/dist/model/spatialCoverage.js +0 -47
- package/dist/model/spatialCoverageBlock.js +0 -41
- package/dist/model/subject.js +0 -41
- package/dist/model/subjectBlock.js +0 -41
- package/dist/model/subjectKeyword.js +0 -35
- package/dist/model/title.js +0 -53
- package/dist/model/titleBlock.js +0 -47
- package/dist/model/titleType.js +0 -19
- package/dist/model/titleTypeWithSchemaUri.js +0 -35
- package/dist/model/traditionalKnowledgeLabel.js +0 -35
- package/dist/model/traditionalKnowledgeLabelBlock.js +0 -29
- package/dist/model/updateAuthzRequest.js +0 -35
- package/dist/model/updateAuthzRequestStatus.js +0 -47
- package/dist/model/updateAuthzResponse.js +0 -35
- package/dist/model/updateRaidoSchemaV1Request.js +0 -29
- package/dist/model/updateRaidoSchemaV2Request.js +0 -29
- package/dist/model/validationFailure.js +0 -41
- package/dist/model/validationFailureResponse.js +0 -59
- package/dist/model/versionResult.js +0 -47
package/dist/api.d.ts
ADDED
|
@@ -0,0 +1,1679 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* RAID v2 API
|
|
3
|
+
* This file is where all the endpoint paths are defined, it\'s the \"top level\' of the OpenAPI definition that links all the different files together. The `3.0` in the filename refers to this file being based on OpenAPI 3.0 as opposed to OpenAPI 3.1, which the tooling doesn\'t support yet. The `2.0.0` in the version field refers to the fact that there\'s already a `1.0.0` used for the legacy RAiD application. Note that swagger ui doesn\'t currently work with our spec, see https://github.com/swagger-api/swagger-ui/issues/7724 But the spec works fine with openapi-generator tooling.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.0.0
|
|
6
|
+
* Contact: contact@raid.org
|
|
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 { Configuration } from './configuration';
|
|
13
|
+
import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
14
|
+
import { RequestArgs, BaseAPI } from './base';
|
|
15
|
+
/**
|
|
16
|
+
*
|
|
17
|
+
* @export
|
|
18
|
+
* @interface Access
|
|
19
|
+
*/
|
|
20
|
+
export interface Access {
|
|
21
|
+
/**
|
|
22
|
+
*
|
|
23
|
+
* @type {AccessType}
|
|
24
|
+
* @memberof Access
|
|
25
|
+
*/
|
|
26
|
+
'type': AccessType;
|
|
27
|
+
/**
|
|
28
|
+
*
|
|
29
|
+
* @type {AccessStatement}
|
|
30
|
+
* @memberof Access
|
|
31
|
+
*/
|
|
32
|
+
'statement'?: AccessStatement;
|
|
33
|
+
/**
|
|
34
|
+
* Date the embargo on access to the RAiD ends. Year
|
|
35
|
+
* @type {string}
|
|
36
|
+
* @memberof Access
|
|
37
|
+
*/
|
|
38
|
+
'embargoExpiry'?: string;
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
*
|
|
42
|
+
* @export
|
|
43
|
+
* @interface AccessStatement
|
|
44
|
+
*/
|
|
45
|
+
export interface AccessStatement {
|
|
46
|
+
/**
|
|
47
|
+
*
|
|
48
|
+
* @type {string}
|
|
49
|
+
* @memberof AccessStatement
|
|
50
|
+
*/
|
|
51
|
+
'text'?: string;
|
|
52
|
+
/**
|
|
53
|
+
*
|
|
54
|
+
* @type {Language}
|
|
55
|
+
* @memberof AccessStatement
|
|
56
|
+
*/
|
|
57
|
+
'language'?: Language;
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
*
|
|
61
|
+
* @export
|
|
62
|
+
* @interface AccessType
|
|
63
|
+
*/
|
|
64
|
+
export interface AccessType {
|
|
65
|
+
/**
|
|
66
|
+
*
|
|
67
|
+
* @type {string}
|
|
68
|
+
* @memberof AccessType
|
|
69
|
+
*/
|
|
70
|
+
'id': string;
|
|
71
|
+
/**
|
|
72
|
+
*
|
|
73
|
+
* @type {string}
|
|
74
|
+
* @memberof AccessType
|
|
75
|
+
*/
|
|
76
|
+
'schemaUri': string;
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
*
|
|
80
|
+
* @export
|
|
81
|
+
* @interface AlternateIdentifier
|
|
82
|
+
*/
|
|
83
|
+
export interface AlternateIdentifier {
|
|
84
|
+
/**
|
|
85
|
+
*
|
|
86
|
+
* @type {string}
|
|
87
|
+
* @memberof AlternateIdentifier
|
|
88
|
+
*/
|
|
89
|
+
'id'?: string;
|
|
90
|
+
/**
|
|
91
|
+
*
|
|
92
|
+
* @type {string}
|
|
93
|
+
* @memberof AlternateIdentifier
|
|
94
|
+
*/
|
|
95
|
+
'type'?: string;
|
|
96
|
+
}
|
|
97
|
+
/**
|
|
98
|
+
*
|
|
99
|
+
* @export
|
|
100
|
+
* @interface AlternateUrl
|
|
101
|
+
*/
|
|
102
|
+
export interface AlternateUrl {
|
|
103
|
+
/**
|
|
104
|
+
*
|
|
105
|
+
* @type {string}
|
|
106
|
+
* @memberof AlternateUrl
|
|
107
|
+
*/
|
|
108
|
+
'url': string;
|
|
109
|
+
}
|
|
110
|
+
/**
|
|
111
|
+
*
|
|
112
|
+
* @export
|
|
113
|
+
* @interface ClosedRaid
|
|
114
|
+
*/
|
|
115
|
+
export interface ClosedRaid {
|
|
116
|
+
/**
|
|
117
|
+
*
|
|
118
|
+
* @type {Id}
|
|
119
|
+
* @memberof ClosedRaid
|
|
120
|
+
*/
|
|
121
|
+
'identifier'?: Id;
|
|
122
|
+
/**
|
|
123
|
+
*
|
|
124
|
+
* @type {Access}
|
|
125
|
+
* @memberof ClosedRaid
|
|
126
|
+
*/
|
|
127
|
+
'access'?: Access;
|
|
128
|
+
}
|
|
129
|
+
/**
|
|
130
|
+
*
|
|
131
|
+
* @export
|
|
132
|
+
* @interface Contributor
|
|
133
|
+
*/
|
|
134
|
+
export interface Contributor {
|
|
135
|
+
/**
|
|
136
|
+
*
|
|
137
|
+
* @type {string}
|
|
138
|
+
* @memberof Contributor
|
|
139
|
+
*/
|
|
140
|
+
'id': string;
|
|
141
|
+
/**
|
|
142
|
+
*
|
|
143
|
+
* @type {string}
|
|
144
|
+
* @memberof Contributor
|
|
145
|
+
*/
|
|
146
|
+
'schemaUri': string;
|
|
147
|
+
/**
|
|
148
|
+
*
|
|
149
|
+
* @type {Array<ContributorPosition>}
|
|
150
|
+
* @memberof Contributor
|
|
151
|
+
*/
|
|
152
|
+
'position': Array<ContributorPosition>;
|
|
153
|
+
/**
|
|
154
|
+
*
|
|
155
|
+
* @type {Array<ContributorRole>}
|
|
156
|
+
* @memberof Contributor
|
|
157
|
+
*/
|
|
158
|
+
'role': Array<ContributorRole>;
|
|
159
|
+
/**
|
|
160
|
+
*
|
|
161
|
+
* @type {boolean}
|
|
162
|
+
* @memberof Contributor
|
|
163
|
+
*/
|
|
164
|
+
'leader'?: boolean;
|
|
165
|
+
/**
|
|
166
|
+
*
|
|
167
|
+
* @type {boolean}
|
|
168
|
+
* @memberof Contributor
|
|
169
|
+
*/
|
|
170
|
+
'contact'?: boolean;
|
|
171
|
+
}
|
|
172
|
+
/**
|
|
173
|
+
*
|
|
174
|
+
* @export
|
|
175
|
+
* @interface ContributorPosition
|
|
176
|
+
*/
|
|
177
|
+
export interface ContributorPosition {
|
|
178
|
+
/**
|
|
179
|
+
*
|
|
180
|
+
* @type {string}
|
|
181
|
+
* @memberof ContributorPosition
|
|
182
|
+
*/
|
|
183
|
+
'schemaUri': string;
|
|
184
|
+
/**
|
|
185
|
+
*
|
|
186
|
+
* @type {string}
|
|
187
|
+
* @memberof ContributorPosition
|
|
188
|
+
*/
|
|
189
|
+
'id': string;
|
|
190
|
+
/**
|
|
191
|
+
*
|
|
192
|
+
* @type {string}
|
|
193
|
+
* @memberof ContributorPosition
|
|
194
|
+
*/
|
|
195
|
+
'startDate': string;
|
|
196
|
+
/**
|
|
197
|
+
*
|
|
198
|
+
* @type {string}
|
|
199
|
+
* @memberof ContributorPosition
|
|
200
|
+
*/
|
|
201
|
+
'endDate'?: string;
|
|
202
|
+
}
|
|
203
|
+
/**
|
|
204
|
+
*
|
|
205
|
+
* @export
|
|
206
|
+
* @interface ContributorRole
|
|
207
|
+
*/
|
|
208
|
+
export interface ContributorRole {
|
|
209
|
+
/**
|
|
210
|
+
*
|
|
211
|
+
* @type {string}
|
|
212
|
+
* @memberof ContributorRole
|
|
213
|
+
*/
|
|
214
|
+
'schemaUri': string;
|
|
215
|
+
/**
|
|
216
|
+
*
|
|
217
|
+
* @type {string}
|
|
218
|
+
* @memberof ContributorRole
|
|
219
|
+
*/
|
|
220
|
+
'id': string;
|
|
221
|
+
}
|
|
222
|
+
/**
|
|
223
|
+
*
|
|
224
|
+
* @export
|
|
225
|
+
* @interface Description
|
|
226
|
+
*/
|
|
227
|
+
export interface Description {
|
|
228
|
+
/**
|
|
229
|
+
*
|
|
230
|
+
* @type {string}
|
|
231
|
+
* @memberof Description
|
|
232
|
+
*/
|
|
233
|
+
'text': string;
|
|
234
|
+
/**
|
|
235
|
+
*
|
|
236
|
+
* @type {DescriptionType}
|
|
237
|
+
* @memberof Description
|
|
238
|
+
*/
|
|
239
|
+
'type': DescriptionType;
|
|
240
|
+
/**
|
|
241
|
+
*
|
|
242
|
+
* @type {Language}
|
|
243
|
+
* @memberof Description
|
|
244
|
+
*/
|
|
245
|
+
'language'?: Language;
|
|
246
|
+
}
|
|
247
|
+
/**
|
|
248
|
+
*
|
|
249
|
+
* @export
|
|
250
|
+
* @interface DescriptionType
|
|
251
|
+
*/
|
|
252
|
+
export interface DescriptionType {
|
|
253
|
+
/**
|
|
254
|
+
*
|
|
255
|
+
* @type {string}
|
|
256
|
+
* @memberof DescriptionType
|
|
257
|
+
*/
|
|
258
|
+
'id': string;
|
|
259
|
+
/**
|
|
260
|
+
*
|
|
261
|
+
* @type {string}
|
|
262
|
+
* @memberof DescriptionType
|
|
263
|
+
*/
|
|
264
|
+
'schemaUri': string;
|
|
265
|
+
}
|
|
266
|
+
/**
|
|
267
|
+
*
|
|
268
|
+
* @export
|
|
269
|
+
* @interface FailureResponse
|
|
270
|
+
*/
|
|
271
|
+
export interface FailureResponse {
|
|
272
|
+
/**
|
|
273
|
+
*
|
|
274
|
+
* @type {string}
|
|
275
|
+
* @memberof FailureResponse
|
|
276
|
+
*/
|
|
277
|
+
'type': string;
|
|
278
|
+
/**
|
|
279
|
+
*
|
|
280
|
+
* @type {string}
|
|
281
|
+
* @memberof FailureResponse
|
|
282
|
+
*/
|
|
283
|
+
'title': string;
|
|
284
|
+
/**
|
|
285
|
+
*
|
|
286
|
+
* @type {number}
|
|
287
|
+
* @memberof FailureResponse
|
|
288
|
+
*/
|
|
289
|
+
'status': number;
|
|
290
|
+
/**
|
|
291
|
+
*
|
|
292
|
+
* @type {string}
|
|
293
|
+
* @memberof FailureResponse
|
|
294
|
+
*/
|
|
295
|
+
'detail': string;
|
|
296
|
+
/**
|
|
297
|
+
*
|
|
298
|
+
* @type {string}
|
|
299
|
+
* @memberof FailureResponse
|
|
300
|
+
*/
|
|
301
|
+
'instance': string;
|
|
302
|
+
}
|
|
303
|
+
/**
|
|
304
|
+
*
|
|
305
|
+
* @export
|
|
306
|
+
* @interface Id
|
|
307
|
+
*/
|
|
308
|
+
export interface Id {
|
|
309
|
+
/**
|
|
310
|
+
* The identifier of the raid, e.g. https://raid.org.au/102.100.100/zzz
|
|
311
|
+
* @type {string}
|
|
312
|
+
* @memberof Id
|
|
313
|
+
*/
|
|
314
|
+
'id': string;
|
|
315
|
+
/**
|
|
316
|
+
* The URI of the Identifier scheme. For example, https://raid.org
|
|
317
|
+
* @type {string}
|
|
318
|
+
* @memberof Id
|
|
319
|
+
*/
|
|
320
|
+
'schemaUri': string;
|
|
321
|
+
/**
|
|
322
|
+
*
|
|
323
|
+
* @type {RegistrationAgency}
|
|
324
|
+
* @memberof Id
|
|
325
|
+
*/
|
|
326
|
+
'registrationAgency': RegistrationAgency;
|
|
327
|
+
/**
|
|
328
|
+
*
|
|
329
|
+
* @type {Owner}
|
|
330
|
+
* @memberof Id
|
|
331
|
+
*/
|
|
332
|
+
'owner': Owner;
|
|
333
|
+
/**
|
|
334
|
+
* The URL for the raid via the minting raid agency system, e.g https://raid.org.au/10378.1/1695863
|
|
335
|
+
* @type {string}
|
|
336
|
+
* @memberof Id
|
|
337
|
+
*/
|
|
338
|
+
'raidAgencyUrl'?: string;
|
|
339
|
+
/**
|
|
340
|
+
* The license under which the RAiD Metadata Record associated with this Identifier has been issued.
|
|
341
|
+
* @type {string}
|
|
342
|
+
* @memberof Id
|
|
343
|
+
*/
|
|
344
|
+
'license': string;
|
|
345
|
+
/**
|
|
346
|
+
* The version of the resource. Read-only. Increments automatically on update.
|
|
347
|
+
* @type {number}
|
|
348
|
+
* @memberof Id
|
|
349
|
+
*/
|
|
350
|
+
'version': number;
|
|
351
|
+
}
|
|
352
|
+
/**
|
|
353
|
+
*
|
|
354
|
+
* @export
|
|
355
|
+
* @interface Language
|
|
356
|
+
*/
|
|
357
|
+
export interface Language {
|
|
358
|
+
/**
|
|
359
|
+
*
|
|
360
|
+
* @type {string}
|
|
361
|
+
* @memberof Language
|
|
362
|
+
*/
|
|
363
|
+
'id'?: string;
|
|
364
|
+
/**
|
|
365
|
+
*
|
|
366
|
+
* @type {string}
|
|
367
|
+
* @memberof Language
|
|
368
|
+
*/
|
|
369
|
+
'schemaUri': string;
|
|
370
|
+
}
|
|
371
|
+
/**
|
|
372
|
+
* Metadata schema block containing the start and end date of the RAiD.
|
|
373
|
+
* @export
|
|
374
|
+
* @interface ModelDate
|
|
375
|
+
*/
|
|
376
|
+
export interface ModelDate {
|
|
377
|
+
/**
|
|
378
|
+
*
|
|
379
|
+
* @type {string}
|
|
380
|
+
* @memberof ModelDate
|
|
381
|
+
*/
|
|
382
|
+
'startDate': string;
|
|
383
|
+
/**
|
|
384
|
+
*
|
|
385
|
+
* @type {string}
|
|
386
|
+
* @memberof ModelDate
|
|
387
|
+
*/
|
|
388
|
+
'endDate'?: string;
|
|
389
|
+
}
|
|
390
|
+
/**
|
|
391
|
+
*
|
|
392
|
+
* @export
|
|
393
|
+
* @interface Organisation
|
|
394
|
+
*/
|
|
395
|
+
export interface Organisation {
|
|
396
|
+
/**
|
|
397
|
+
*
|
|
398
|
+
* @type {string}
|
|
399
|
+
* @memberof Organisation
|
|
400
|
+
*/
|
|
401
|
+
'id': string;
|
|
402
|
+
/**
|
|
403
|
+
*
|
|
404
|
+
* @type {string}
|
|
405
|
+
* @memberof Organisation
|
|
406
|
+
*/
|
|
407
|
+
'schemaUri': string;
|
|
408
|
+
/**
|
|
409
|
+
*
|
|
410
|
+
* @type {Array<OrganisationRole>}
|
|
411
|
+
* @memberof Organisation
|
|
412
|
+
*/
|
|
413
|
+
'role': Array<OrganisationRole>;
|
|
414
|
+
}
|
|
415
|
+
/**
|
|
416
|
+
*
|
|
417
|
+
* @export
|
|
418
|
+
* @interface OrganisationRole
|
|
419
|
+
*/
|
|
420
|
+
export interface OrganisationRole {
|
|
421
|
+
/**
|
|
422
|
+
*
|
|
423
|
+
* @type {string}
|
|
424
|
+
* @memberof OrganisationRole
|
|
425
|
+
*/
|
|
426
|
+
'schemaUri': string;
|
|
427
|
+
/**
|
|
428
|
+
*
|
|
429
|
+
* @type {string}
|
|
430
|
+
* @memberof OrganisationRole
|
|
431
|
+
*/
|
|
432
|
+
'id': string;
|
|
433
|
+
/**
|
|
434
|
+
*
|
|
435
|
+
* @type {string}
|
|
436
|
+
* @memberof OrganisationRole
|
|
437
|
+
*/
|
|
438
|
+
'startDate': string;
|
|
439
|
+
/**
|
|
440
|
+
*
|
|
441
|
+
* @type {string}
|
|
442
|
+
* @memberof OrganisationRole
|
|
443
|
+
*/
|
|
444
|
+
'endDate'?: string;
|
|
445
|
+
}
|
|
446
|
+
/**
|
|
447
|
+
* The legal entity responsible for the RAiD; the ‘Owner’ of a RAiD. Analogous to a DataCite ‘Member’, has a legal agreement with the Registration Agency.
|
|
448
|
+
* @export
|
|
449
|
+
* @interface Owner
|
|
450
|
+
*/
|
|
451
|
+
export interface Owner {
|
|
452
|
+
/**
|
|
453
|
+
*
|
|
454
|
+
* @type {string}
|
|
455
|
+
* @memberof Owner
|
|
456
|
+
*/
|
|
457
|
+
'id': string;
|
|
458
|
+
/**
|
|
459
|
+
*
|
|
460
|
+
* @type {string}
|
|
461
|
+
* @memberof Owner
|
|
462
|
+
*/
|
|
463
|
+
'schemaUri': string;
|
|
464
|
+
/**
|
|
465
|
+
* The Service Point (SP) that requested the RAiD. Analogous to a DataCite ‘Repository’. SPs belong to an owner, RAiD owners can have multiple SPs, and SPs do not need to be legal entities.
|
|
466
|
+
* @type {number}
|
|
467
|
+
* @memberof Owner
|
|
468
|
+
*/
|
|
469
|
+
'servicePoint'?: number;
|
|
470
|
+
}
|
|
471
|
+
/**
|
|
472
|
+
*
|
|
473
|
+
* @export
|
|
474
|
+
* @interface RaidChange
|
|
475
|
+
*/
|
|
476
|
+
export interface RaidChange {
|
|
477
|
+
/**
|
|
478
|
+
*
|
|
479
|
+
* @type {string}
|
|
480
|
+
* @memberof RaidChange
|
|
481
|
+
*/
|
|
482
|
+
'handle'?: string;
|
|
483
|
+
/**
|
|
484
|
+
*
|
|
485
|
+
* @type {number}
|
|
486
|
+
* @memberof RaidChange
|
|
487
|
+
*/
|
|
488
|
+
'version'?: number;
|
|
489
|
+
/**
|
|
490
|
+
* A base64 encoded json patch (RFC 6902) representation of a change to the raid.
|
|
491
|
+
* @type {string}
|
|
492
|
+
* @memberof RaidChange
|
|
493
|
+
*/
|
|
494
|
+
'diff'?: string;
|
|
495
|
+
/**
|
|
496
|
+
* A timestamp of the change
|
|
497
|
+
* @type {string}
|
|
498
|
+
* @memberof RaidChange
|
|
499
|
+
*/
|
|
500
|
+
'timestamp'?: string;
|
|
501
|
+
}
|
|
502
|
+
/**
|
|
503
|
+
*
|
|
504
|
+
* @export
|
|
505
|
+
* @interface RaidCreateRequest
|
|
506
|
+
*/
|
|
507
|
+
export interface RaidCreateRequest {
|
|
508
|
+
/**
|
|
509
|
+
*
|
|
510
|
+
* @type {Id}
|
|
511
|
+
* @memberof RaidCreateRequest
|
|
512
|
+
*/
|
|
513
|
+
'identifier'?: Id;
|
|
514
|
+
/**
|
|
515
|
+
*
|
|
516
|
+
* @type {Array<Title>}
|
|
517
|
+
* @memberof RaidCreateRequest
|
|
518
|
+
*/
|
|
519
|
+
'title'?: Array<Title>;
|
|
520
|
+
/**
|
|
521
|
+
*
|
|
522
|
+
* @type {ModelDate}
|
|
523
|
+
* @memberof RaidCreateRequest
|
|
524
|
+
*/
|
|
525
|
+
'date'?: ModelDate;
|
|
526
|
+
/**
|
|
527
|
+
*
|
|
528
|
+
* @type {Array<Description>}
|
|
529
|
+
* @memberof RaidCreateRequest
|
|
530
|
+
*/
|
|
531
|
+
'description'?: Array<Description>;
|
|
532
|
+
/**
|
|
533
|
+
*
|
|
534
|
+
* @type {Access}
|
|
535
|
+
* @memberof RaidCreateRequest
|
|
536
|
+
*/
|
|
537
|
+
'access': Access;
|
|
538
|
+
/**
|
|
539
|
+
*
|
|
540
|
+
* @type {Array<AlternateUrl>}
|
|
541
|
+
* @memberof RaidCreateRequest
|
|
542
|
+
*/
|
|
543
|
+
'alternateUrl'?: Array<AlternateUrl>;
|
|
544
|
+
/**
|
|
545
|
+
*
|
|
546
|
+
* @type {Array<Contributor>}
|
|
547
|
+
* @memberof RaidCreateRequest
|
|
548
|
+
*/
|
|
549
|
+
'contributor'?: Array<Contributor>;
|
|
550
|
+
/**
|
|
551
|
+
*
|
|
552
|
+
* @type {Array<Organisation>}
|
|
553
|
+
* @memberof RaidCreateRequest
|
|
554
|
+
*/
|
|
555
|
+
'organisation'?: Array<Organisation>;
|
|
556
|
+
/**
|
|
557
|
+
*
|
|
558
|
+
* @type {Array<Subject>}
|
|
559
|
+
* @memberof RaidCreateRequest
|
|
560
|
+
*/
|
|
561
|
+
'subject'?: Array<Subject>;
|
|
562
|
+
/**
|
|
563
|
+
*
|
|
564
|
+
* @type {Array<RelatedRaid>}
|
|
565
|
+
* @memberof RaidCreateRequest
|
|
566
|
+
*/
|
|
567
|
+
'relatedRaid'?: Array<RelatedRaid>;
|
|
568
|
+
/**
|
|
569
|
+
*
|
|
570
|
+
* @type {Array<RelatedObject>}
|
|
571
|
+
* @memberof RaidCreateRequest
|
|
572
|
+
*/
|
|
573
|
+
'relatedObject'?: Array<RelatedObject>;
|
|
574
|
+
/**
|
|
575
|
+
*
|
|
576
|
+
* @type {Array<AlternateIdentifier>}
|
|
577
|
+
* @memberof RaidCreateRequest
|
|
578
|
+
*/
|
|
579
|
+
'alternateIdentifier'?: Array<AlternateIdentifier>;
|
|
580
|
+
/**
|
|
581
|
+
*
|
|
582
|
+
* @type {Array<SpatialCoverage>}
|
|
583
|
+
* @memberof RaidCreateRequest
|
|
584
|
+
*/
|
|
585
|
+
'spatialCoverage'?: Array<SpatialCoverage>;
|
|
586
|
+
/**
|
|
587
|
+
*
|
|
588
|
+
* @type {Array<TraditionalKnowledgeLabel>}
|
|
589
|
+
* @memberof RaidCreateRequest
|
|
590
|
+
*/
|
|
591
|
+
'traditionalKnowledgeLabel'?: Array<TraditionalKnowledgeLabel>;
|
|
592
|
+
}
|
|
593
|
+
/**
|
|
594
|
+
*
|
|
595
|
+
* @export
|
|
596
|
+
* @interface RaidDto
|
|
597
|
+
*/
|
|
598
|
+
export interface RaidDto {
|
|
599
|
+
/**
|
|
600
|
+
*
|
|
601
|
+
* @type {Id}
|
|
602
|
+
* @memberof RaidDto
|
|
603
|
+
*/
|
|
604
|
+
'identifier': Id;
|
|
605
|
+
/**
|
|
606
|
+
*
|
|
607
|
+
* @type {Array<Title>}
|
|
608
|
+
* @memberof RaidDto
|
|
609
|
+
*/
|
|
610
|
+
'title'?: Array<Title>;
|
|
611
|
+
/**
|
|
612
|
+
*
|
|
613
|
+
* @type {ModelDate}
|
|
614
|
+
* @memberof RaidDto
|
|
615
|
+
*/
|
|
616
|
+
'date'?: ModelDate;
|
|
617
|
+
/**
|
|
618
|
+
*
|
|
619
|
+
* @type {Array<Description>}
|
|
620
|
+
* @memberof RaidDto
|
|
621
|
+
*/
|
|
622
|
+
'description'?: Array<Description>;
|
|
623
|
+
/**
|
|
624
|
+
*
|
|
625
|
+
* @type {Access}
|
|
626
|
+
* @memberof RaidDto
|
|
627
|
+
*/
|
|
628
|
+
'access': Access;
|
|
629
|
+
/**
|
|
630
|
+
*
|
|
631
|
+
* @type {Array<AlternateUrl>}
|
|
632
|
+
* @memberof RaidDto
|
|
633
|
+
*/
|
|
634
|
+
'alternateUrl'?: Array<AlternateUrl>;
|
|
635
|
+
/**
|
|
636
|
+
*
|
|
637
|
+
* @type {Array<Contributor>}
|
|
638
|
+
* @memberof RaidDto
|
|
639
|
+
*/
|
|
640
|
+
'contributor'?: Array<Contributor>;
|
|
641
|
+
/**
|
|
642
|
+
*
|
|
643
|
+
* @type {Array<Organisation>}
|
|
644
|
+
* @memberof RaidDto
|
|
645
|
+
*/
|
|
646
|
+
'organisation'?: Array<Organisation>;
|
|
647
|
+
/**
|
|
648
|
+
*
|
|
649
|
+
* @type {Array<Subject>}
|
|
650
|
+
* @memberof RaidDto
|
|
651
|
+
*/
|
|
652
|
+
'subject'?: Array<Subject>;
|
|
653
|
+
/**
|
|
654
|
+
*
|
|
655
|
+
* @type {Array<RelatedRaid>}
|
|
656
|
+
* @memberof RaidDto
|
|
657
|
+
*/
|
|
658
|
+
'relatedRaid'?: Array<RelatedRaid>;
|
|
659
|
+
/**
|
|
660
|
+
*
|
|
661
|
+
* @type {Array<RelatedObject>}
|
|
662
|
+
* @memberof RaidDto
|
|
663
|
+
*/
|
|
664
|
+
'relatedObject'?: Array<RelatedObject>;
|
|
665
|
+
/**
|
|
666
|
+
*
|
|
667
|
+
* @type {Array<AlternateIdentifier>}
|
|
668
|
+
* @memberof RaidDto
|
|
669
|
+
*/
|
|
670
|
+
'alternateIdentifier'?: Array<AlternateIdentifier>;
|
|
671
|
+
/**
|
|
672
|
+
*
|
|
673
|
+
* @type {Array<SpatialCoverage>}
|
|
674
|
+
* @memberof RaidDto
|
|
675
|
+
*/
|
|
676
|
+
'spatialCoverage'?: Array<SpatialCoverage>;
|
|
677
|
+
/**
|
|
678
|
+
*
|
|
679
|
+
* @type {Array<TraditionalKnowledgeLabel>}
|
|
680
|
+
* @memberof RaidDto
|
|
681
|
+
*/
|
|
682
|
+
'traditionalKnowledgeLabel'?: Array<TraditionalKnowledgeLabel>;
|
|
683
|
+
}
|
|
684
|
+
/**
|
|
685
|
+
*
|
|
686
|
+
* @export
|
|
687
|
+
* @interface RaidUpdateRequest
|
|
688
|
+
*/
|
|
689
|
+
export interface RaidUpdateRequest {
|
|
690
|
+
/**
|
|
691
|
+
*
|
|
692
|
+
* @type {Id}
|
|
693
|
+
* @memberof RaidUpdateRequest
|
|
694
|
+
*/
|
|
695
|
+
'identifier': Id;
|
|
696
|
+
/**
|
|
697
|
+
*
|
|
698
|
+
* @type {Array<Title>}
|
|
699
|
+
* @memberof RaidUpdateRequest
|
|
700
|
+
*/
|
|
701
|
+
'title'?: Array<Title>;
|
|
702
|
+
/**
|
|
703
|
+
*
|
|
704
|
+
* @type {ModelDate}
|
|
705
|
+
* @memberof RaidUpdateRequest
|
|
706
|
+
*/
|
|
707
|
+
'date'?: ModelDate;
|
|
708
|
+
/**
|
|
709
|
+
*
|
|
710
|
+
* @type {Array<Description>}
|
|
711
|
+
* @memberof RaidUpdateRequest
|
|
712
|
+
*/
|
|
713
|
+
'description'?: Array<Description>;
|
|
714
|
+
/**
|
|
715
|
+
*
|
|
716
|
+
* @type {Access}
|
|
717
|
+
* @memberof RaidUpdateRequest
|
|
718
|
+
*/
|
|
719
|
+
'access': Access;
|
|
720
|
+
/**
|
|
721
|
+
*
|
|
722
|
+
* @type {Array<AlternateUrl>}
|
|
723
|
+
* @memberof RaidUpdateRequest
|
|
724
|
+
*/
|
|
725
|
+
'alternateUrl'?: Array<AlternateUrl>;
|
|
726
|
+
/**
|
|
727
|
+
*
|
|
728
|
+
* @type {Array<Contributor>}
|
|
729
|
+
* @memberof RaidUpdateRequest
|
|
730
|
+
*/
|
|
731
|
+
'contributor'?: Array<Contributor>;
|
|
732
|
+
/**
|
|
733
|
+
*
|
|
734
|
+
* @type {Array<Organisation>}
|
|
735
|
+
* @memberof RaidUpdateRequest
|
|
736
|
+
*/
|
|
737
|
+
'organisation'?: Array<Organisation>;
|
|
738
|
+
/**
|
|
739
|
+
*
|
|
740
|
+
* @type {Array<Subject>}
|
|
741
|
+
* @memberof RaidUpdateRequest
|
|
742
|
+
*/
|
|
743
|
+
'subject'?: Array<Subject>;
|
|
744
|
+
/**
|
|
745
|
+
*
|
|
746
|
+
* @type {Array<RelatedRaid>}
|
|
747
|
+
* @memberof RaidUpdateRequest
|
|
748
|
+
*/
|
|
749
|
+
'relatedRaid'?: Array<RelatedRaid>;
|
|
750
|
+
/**
|
|
751
|
+
*
|
|
752
|
+
* @type {Array<RelatedObject>}
|
|
753
|
+
* @memberof RaidUpdateRequest
|
|
754
|
+
*/
|
|
755
|
+
'relatedObject'?: Array<RelatedObject>;
|
|
756
|
+
/**
|
|
757
|
+
*
|
|
758
|
+
* @type {Array<AlternateIdentifier>}
|
|
759
|
+
* @memberof RaidUpdateRequest
|
|
760
|
+
*/
|
|
761
|
+
'alternateIdentifier'?: Array<AlternateIdentifier>;
|
|
762
|
+
/**
|
|
763
|
+
*
|
|
764
|
+
* @type {Array<SpatialCoverage>}
|
|
765
|
+
* @memberof RaidUpdateRequest
|
|
766
|
+
*/
|
|
767
|
+
'spatialCoverage'?: Array<SpatialCoverage>;
|
|
768
|
+
/**
|
|
769
|
+
*
|
|
770
|
+
* @type {Array<TraditionalKnowledgeLabel>}
|
|
771
|
+
* @memberof RaidUpdateRequest
|
|
772
|
+
*/
|
|
773
|
+
'traditionalKnowledgeLabel'?: Array<TraditionalKnowledgeLabel>;
|
|
774
|
+
}
|
|
775
|
+
/**
|
|
776
|
+
* ROR that identifies the organisation that operates the raid registration agency software that minted this raid.
|
|
777
|
+
* @export
|
|
778
|
+
* @interface RegistrationAgency
|
|
779
|
+
*/
|
|
780
|
+
export interface RegistrationAgency {
|
|
781
|
+
/**
|
|
782
|
+
*
|
|
783
|
+
* @type {string}
|
|
784
|
+
* @memberof RegistrationAgency
|
|
785
|
+
*/
|
|
786
|
+
'id': string;
|
|
787
|
+
/**
|
|
788
|
+
*
|
|
789
|
+
* @type {string}
|
|
790
|
+
* @memberof RegistrationAgency
|
|
791
|
+
*/
|
|
792
|
+
'schemaUri': string;
|
|
793
|
+
}
|
|
794
|
+
/**
|
|
795
|
+
*
|
|
796
|
+
* @export
|
|
797
|
+
* @interface RelatedObject
|
|
798
|
+
*/
|
|
799
|
+
export interface RelatedObject {
|
|
800
|
+
/**
|
|
801
|
+
*
|
|
802
|
+
* @type {string}
|
|
803
|
+
* @memberof RelatedObject
|
|
804
|
+
*/
|
|
805
|
+
'id'?: string;
|
|
806
|
+
/**
|
|
807
|
+
*
|
|
808
|
+
* @type {string}
|
|
809
|
+
* @memberof RelatedObject
|
|
810
|
+
*/
|
|
811
|
+
'schemaUri'?: string;
|
|
812
|
+
/**
|
|
813
|
+
*
|
|
814
|
+
* @type {RelatedObjectType}
|
|
815
|
+
* @memberof RelatedObject
|
|
816
|
+
*/
|
|
817
|
+
'type'?: RelatedObjectType;
|
|
818
|
+
/**
|
|
819
|
+
*
|
|
820
|
+
* @type {Array<RelatedObjectCategory>}
|
|
821
|
+
* @memberof RelatedObject
|
|
822
|
+
*/
|
|
823
|
+
'category'?: Array<RelatedObjectCategory>;
|
|
824
|
+
}
|
|
825
|
+
/**
|
|
826
|
+
*
|
|
827
|
+
* @export
|
|
828
|
+
* @interface RelatedObjectCategory
|
|
829
|
+
*/
|
|
830
|
+
export interface RelatedObjectCategory {
|
|
831
|
+
/**
|
|
832
|
+
*
|
|
833
|
+
* @type {string}
|
|
834
|
+
* @memberof RelatedObjectCategory
|
|
835
|
+
*/
|
|
836
|
+
'id'?: string;
|
|
837
|
+
/**
|
|
838
|
+
*
|
|
839
|
+
* @type {string}
|
|
840
|
+
* @memberof RelatedObjectCategory
|
|
841
|
+
*/
|
|
842
|
+
'schemaUri'?: string;
|
|
843
|
+
}
|
|
844
|
+
/**
|
|
845
|
+
*
|
|
846
|
+
* @export
|
|
847
|
+
* @interface RelatedObjectType
|
|
848
|
+
*/
|
|
849
|
+
export interface RelatedObjectType {
|
|
850
|
+
/**
|
|
851
|
+
*
|
|
852
|
+
* @type {string}
|
|
853
|
+
* @memberof RelatedObjectType
|
|
854
|
+
*/
|
|
855
|
+
'id'?: string;
|
|
856
|
+
/**
|
|
857
|
+
*
|
|
858
|
+
* @type {string}
|
|
859
|
+
* @memberof RelatedObjectType
|
|
860
|
+
*/
|
|
861
|
+
'schemaUri'?: string;
|
|
862
|
+
}
|
|
863
|
+
/**
|
|
864
|
+
*
|
|
865
|
+
* @export
|
|
866
|
+
* @interface RelatedRaid
|
|
867
|
+
*/
|
|
868
|
+
export interface RelatedRaid {
|
|
869
|
+
/**
|
|
870
|
+
*
|
|
871
|
+
* @type {string}
|
|
872
|
+
* @memberof RelatedRaid
|
|
873
|
+
*/
|
|
874
|
+
'id'?: string;
|
|
875
|
+
/**
|
|
876
|
+
*
|
|
877
|
+
* @type {RelatedRaidType}
|
|
878
|
+
* @memberof RelatedRaid
|
|
879
|
+
*/
|
|
880
|
+
'type'?: RelatedRaidType;
|
|
881
|
+
}
|
|
882
|
+
/**
|
|
883
|
+
*
|
|
884
|
+
* @export
|
|
885
|
+
* @interface RelatedRaidType
|
|
886
|
+
*/
|
|
887
|
+
export interface RelatedRaidType {
|
|
888
|
+
/**
|
|
889
|
+
*
|
|
890
|
+
* @type {string}
|
|
891
|
+
* @memberof RelatedRaidType
|
|
892
|
+
*/
|
|
893
|
+
'id': string;
|
|
894
|
+
/**
|
|
895
|
+
*
|
|
896
|
+
* @type {string}
|
|
897
|
+
* @memberof RelatedRaidType
|
|
898
|
+
*/
|
|
899
|
+
'schemaUri': string;
|
|
900
|
+
}
|
|
901
|
+
/**
|
|
902
|
+
* data that any member of service-point and operators can see
|
|
903
|
+
* @export
|
|
904
|
+
* @interface ServicePoint
|
|
905
|
+
*/
|
|
906
|
+
export interface ServicePoint {
|
|
907
|
+
/**
|
|
908
|
+
*
|
|
909
|
+
* @type {number}
|
|
910
|
+
* @memberof ServicePoint
|
|
911
|
+
*/
|
|
912
|
+
'id': number;
|
|
913
|
+
/**
|
|
914
|
+
*
|
|
915
|
+
* @type {string}
|
|
916
|
+
* @memberof ServicePoint
|
|
917
|
+
*/
|
|
918
|
+
'name': string;
|
|
919
|
+
/**
|
|
920
|
+
*
|
|
921
|
+
* @type {string}
|
|
922
|
+
* @memberof ServicePoint
|
|
923
|
+
*/
|
|
924
|
+
'identifierOwner': string;
|
|
925
|
+
/**
|
|
926
|
+
* The Datacite repository id. This needs to be created in Fabrica.
|
|
927
|
+
* @type {string}
|
|
928
|
+
* @memberof ServicePoint
|
|
929
|
+
*/
|
|
930
|
+
'repositoryId'?: string;
|
|
931
|
+
/**
|
|
932
|
+
* The prefix used in the handle when minting RAiDs. Assigned when the repository is created.
|
|
933
|
+
* @type {string}
|
|
934
|
+
* @memberof ServicePoint
|
|
935
|
+
*/
|
|
936
|
+
'prefix'?: string;
|
|
937
|
+
/**
|
|
938
|
+
*
|
|
939
|
+
* @type {string}
|
|
940
|
+
* @memberof ServicePoint
|
|
941
|
+
*/
|
|
942
|
+
'searchContent'?: string;
|
|
943
|
+
/**
|
|
944
|
+
*
|
|
945
|
+
* @type {string}
|
|
946
|
+
* @memberof ServicePoint
|
|
947
|
+
*/
|
|
948
|
+
'techEmail': string;
|
|
949
|
+
/**
|
|
950
|
+
*
|
|
951
|
+
* @type {string}
|
|
952
|
+
* @memberof ServicePoint
|
|
953
|
+
*/
|
|
954
|
+
'adminEmail': string;
|
|
955
|
+
/**
|
|
956
|
+
*
|
|
957
|
+
* @type {boolean}
|
|
958
|
+
* @memberof ServicePoint
|
|
959
|
+
*/
|
|
960
|
+
'enabled': boolean;
|
|
961
|
+
/**
|
|
962
|
+
*
|
|
963
|
+
* @type {boolean}
|
|
964
|
+
* @memberof ServicePoint
|
|
965
|
+
*/
|
|
966
|
+
'appWritesEnabled'?: boolean;
|
|
967
|
+
}
|
|
968
|
+
/**
|
|
969
|
+
*
|
|
970
|
+
* @export
|
|
971
|
+
* @interface ServicePointCreateRequest
|
|
972
|
+
*/
|
|
973
|
+
export interface ServicePointCreateRequest {
|
|
974
|
+
/**
|
|
975
|
+
* The name of the service point
|
|
976
|
+
* @type {string}
|
|
977
|
+
* @memberof ServicePointCreateRequest
|
|
978
|
+
*/
|
|
979
|
+
'name': string;
|
|
980
|
+
/**
|
|
981
|
+
* The email address of the person responsible for administering the service point.
|
|
982
|
+
* @type {string}
|
|
983
|
+
* @memberof ServicePointCreateRequest
|
|
984
|
+
*/
|
|
985
|
+
'adminEmail'?: string;
|
|
986
|
+
/**
|
|
987
|
+
* The email address of a technical contact when using the API
|
|
988
|
+
* @type {string}
|
|
989
|
+
* @memberof ServicePointCreateRequest
|
|
990
|
+
*/
|
|
991
|
+
'techEmail'?: string;
|
|
992
|
+
/**
|
|
993
|
+
* The PID of the institution that will own the RAiDs (currently only RORs are supported).
|
|
994
|
+
* @type {string}
|
|
995
|
+
* @memberof ServicePointCreateRequest
|
|
996
|
+
*/
|
|
997
|
+
'identifierOwner': string;
|
|
998
|
+
/**
|
|
999
|
+
* The Datacite repository id. This needs to be created in Fabrica.
|
|
1000
|
+
* @type {string}
|
|
1001
|
+
* @memberof ServicePointCreateRequest
|
|
1002
|
+
*/
|
|
1003
|
+
'repositoryId'?: string;
|
|
1004
|
+
/**
|
|
1005
|
+
* The prefix used in the handle when minting RAiDs. Assigned when the repository is created.
|
|
1006
|
+
* @type {string}
|
|
1007
|
+
* @memberof ServicePointCreateRequest
|
|
1008
|
+
*/
|
|
1009
|
+
'prefix'?: string;
|
|
1010
|
+
/**
|
|
1011
|
+
* The password of the repository in Datacite.
|
|
1012
|
+
* @type {string}
|
|
1013
|
+
* @memberof ServicePointCreateRequest
|
|
1014
|
+
*/
|
|
1015
|
+
'password'?: string;
|
|
1016
|
+
/**
|
|
1017
|
+
* Whether users are able to edit RAiDs in the in the app. This can cause conflicts when also creating/updating RAiDs through the API.
|
|
1018
|
+
* @type {boolean}
|
|
1019
|
+
* @memberof ServicePointCreateRequest
|
|
1020
|
+
*/
|
|
1021
|
+
'appWritesEnabled'?: boolean;
|
|
1022
|
+
/**
|
|
1023
|
+
* Whether the service point is able to create or update RAiDs
|
|
1024
|
+
* @type {boolean}
|
|
1025
|
+
* @memberof ServicePointCreateRequest
|
|
1026
|
+
*/
|
|
1027
|
+
'enabled'?: boolean;
|
|
1028
|
+
}
|
|
1029
|
+
/**
|
|
1030
|
+
*
|
|
1031
|
+
* @export
|
|
1032
|
+
* @interface ServicePointUpdateRequest
|
|
1033
|
+
*/
|
|
1034
|
+
export interface ServicePointUpdateRequest {
|
|
1035
|
+
/**
|
|
1036
|
+
* The name of the service point
|
|
1037
|
+
* @type {number}
|
|
1038
|
+
* @memberof ServicePointUpdateRequest
|
|
1039
|
+
*/
|
|
1040
|
+
'id': number;
|
|
1041
|
+
/**
|
|
1042
|
+
* The name of the service point
|
|
1043
|
+
* @type {string}
|
|
1044
|
+
* @memberof ServicePointUpdateRequest
|
|
1045
|
+
*/
|
|
1046
|
+
'name': string;
|
|
1047
|
+
/**
|
|
1048
|
+
* The email address of the person responsible for administering the service point.
|
|
1049
|
+
* @type {string}
|
|
1050
|
+
* @memberof ServicePointUpdateRequest
|
|
1051
|
+
*/
|
|
1052
|
+
'adminEmail'?: string;
|
|
1053
|
+
/**
|
|
1054
|
+
* The email address of a technical contact when using the API
|
|
1055
|
+
* @type {string}
|
|
1056
|
+
* @memberof ServicePointUpdateRequest
|
|
1057
|
+
*/
|
|
1058
|
+
'techEmail'?: string;
|
|
1059
|
+
/**
|
|
1060
|
+
* The PID of the institution that will own the RAiDs (currently only RORs are supported).
|
|
1061
|
+
* @type {string}
|
|
1062
|
+
* @memberof ServicePointUpdateRequest
|
|
1063
|
+
*/
|
|
1064
|
+
'identifierOwner': string;
|
|
1065
|
+
/**
|
|
1066
|
+
* The Datacite repository id. This needs to be created in Fabrica.
|
|
1067
|
+
* @type {string}
|
|
1068
|
+
* @memberof ServicePointUpdateRequest
|
|
1069
|
+
*/
|
|
1070
|
+
'repositoryId'?: string;
|
|
1071
|
+
/**
|
|
1072
|
+
* The prefix used in the handle when minting RAiDs. Assigned when the repository is created.
|
|
1073
|
+
* @type {string}
|
|
1074
|
+
* @memberof ServicePointUpdateRequest
|
|
1075
|
+
*/
|
|
1076
|
+
'prefix'?: string;
|
|
1077
|
+
/**
|
|
1078
|
+
* The password of the repository in Datacite.
|
|
1079
|
+
* @type {string}
|
|
1080
|
+
* @memberof ServicePointUpdateRequest
|
|
1081
|
+
*/
|
|
1082
|
+
'password'?: string;
|
|
1083
|
+
/**
|
|
1084
|
+
* Whether users are able to edit RAiDs in the in the app. This can cause conflicts when also creating/updating RAiDs through the API.
|
|
1085
|
+
* @type {boolean}
|
|
1086
|
+
* @memberof ServicePointUpdateRequest
|
|
1087
|
+
*/
|
|
1088
|
+
'appWritesEnabled'?: boolean;
|
|
1089
|
+
/**
|
|
1090
|
+
* Whether the service point is able to create or update RAiDs
|
|
1091
|
+
* @type {boolean}
|
|
1092
|
+
* @memberof ServicePointUpdateRequest
|
|
1093
|
+
*/
|
|
1094
|
+
'enabled'?: boolean;
|
|
1095
|
+
}
|
|
1096
|
+
/**
|
|
1097
|
+
*
|
|
1098
|
+
* @export
|
|
1099
|
+
* @interface SpatialCoverage
|
|
1100
|
+
*/
|
|
1101
|
+
export interface SpatialCoverage {
|
|
1102
|
+
/**
|
|
1103
|
+
*
|
|
1104
|
+
* @type {string}
|
|
1105
|
+
* @memberof SpatialCoverage
|
|
1106
|
+
*/
|
|
1107
|
+
'id'?: string;
|
|
1108
|
+
/**
|
|
1109
|
+
*
|
|
1110
|
+
* @type {string}
|
|
1111
|
+
* @memberof SpatialCoverage
|
|
1112
|
+
*/
|
|
1113
|
+
'schemaUri'?: string;
|
|
1114
|
+
/**
|
|
1115
|
+
*
|
|
1116
|
+
* @type {Array<SpatialCoveragePlace>}
|
|
1117
|
+
* @memberof SpatialCoverage
|
|
1118
|
+
*/
|
|
1119
|
+
'place'?: Array<SpatialCoveragePlace>;
|
|
1120
|
+
}
|
|
1121
|
+
/**
|
|
1122
|
+
*
|
|
1123
|
+
* @export
|
|
1124
|
+
* @interface SpatialCoveragePlace
|
|
1125
|
+
*/
|
|
1126
|
+
export interface SpatialCoveragePlace {
|
|
1127
|
+
/**
|
|
1128
|
+
*
|
|
1129
|
+
* @type {string}
|
|
1130
|
+
* @memberof SpatialCoveragePlace
|
|
1131
|
+
*/
|
|
1132
|
+
'text'?: string;
|
|
1133
|
+
/**
|
|
1134
|
+
*
|
|
1135
|
+
* @type {Language}
|
|
1136
|
+
* @memberof SpatialCoveragePlace
|
|
1137
|
+
*/
|
|
1138
|
+
'language'?: Language;
|
|
1139
|
+
}
|
|
1140
|
+
/**
|
|
1141
|
+
*
|
|
1142
|
+
* @export
|
|
1143
|
+
* @interface Subject
|
|
1144
|
+
*/
|
|
1145
|
+
export interface Subject {
|
|
1146
|
+
/**
|
|
1147
|
+
*
|
|
1148
|
+
* @type {string}
|
|
1149
|
+
* @memberof Subject
|
|
1150
|
+
*/
|
|
1151
|
+
'id': string;
|
|
1152
|
+
/**
|
|
1153
|
+
*
|
|
1154
|
+
* @type {string}
|
|
1155
|
+
* @memberof Subject
|
|
1156
|
+
*/
|
|
1157
|
+
'schemaUri': string;
|
|
1158
|
+
/**
|
|
1159
|
+
*
|
|
1160
|
+
* @type {Array<SubjectKeyword>}
|
|
1161
|
+
* @memberof Subject
|
|
1162
|
+
*/
|
|
1163
|
+
'keyword'?: Array<SubjectKeyword>;
|
|
1164
|
+
}
|
|
1165
|
+
/**
|
|
1166
|
+
*
|
|
1167
|
+
* @export
|
|
1168
|
+
* @interface SubjectKeyword
|
|
1169
|
+
*/
|
|
1170
|
+
export interface SubjectKeyword {
|
|
1171
|
+
/**
|
|
1172
|
+
*
|
|
1173
|
+
* @type {string}
|
|
1174
|
+
* @memberof SubjectKeyword
|
|
1175
|
+
*/
|
|
1176
|
+
'text': string;
|
|
1177
|
+
/**
|
|
1178
|
+
*
|
|
1179
|
+
* @type {Language}
|
|
1180
|
+
* @memberof SubjectKeyword
|
|
1181
|
+
*/
|
|
1182
|
+
'language'?: Language;
|
|
1183
|
+
}
|
|
1184
|
+
/**
|
|
1185
|
+
*
|
|
1186
|
+
* @export
|
|
1187
|
+
* @interface Title
|
|
1188
|
+
*/
|
|
1189
|
+
export interface Title {
|
|
1190
|
+
/**
|
|
1191
|
+
*
|
|
1192
|
+
* @type {string}
|
|
1193
|
+
* @memberof Title
|
|
1194
|
+
*/
|
|
1195
|
+
'text': string;
|
|
1196
|
+
/**
|
|
1197
|
+
*
|
|
1198
|
+
* @type {TitleType}
|
|
1199
|
+
* @memberof Title
|
|
1200
|
+
*/
|
|
1201
|
+
'type': TitleType;
|
|
1202
|
+
/**
|
|
1203
|
+
*
|
|
1204
|
+
* @type {string}
|
|
1205
|
+
* @memberof Title
|
|
1206
|
+
*/
|
|
1207
|
+
'startDate': string;
|
|
1208
|
+
/**
|
|
1209
|
+
*
|
|
1210
|
+
* @type {string}
|
|
1211
|
+
* @memberof Title
|
|
1212
|
+
*/
|
|
1213
|
+
'endDate'?: string;
|
|
1214
|
+
/**
|
|
1215
|
+
*
|
|
1216
|
+
* @type {Language}
|
|
1217
|
+
* @memberof Title
|
|
1218
|
+
*/
|
|
1219
|
+
'language'?: Language;
|
|
1220
|
+
}
|
|
1221
|
+
/**
|
|
1222
|
+
*
|
|
1223
|
+
* @export
|
|
1224
|
+
* @interface TitleType
|
|
1225
|
+
*/
|
|
1226
|
+
export interface TitleType {
|
|
1227
|
+
/**
|
|
1228
|
+
*
|
|
1229
|
+
* @type {string}
|
|
1230
|
+
* @memberof TitleType
|
|
1231
|
+
*/
|
|
1232
|
+
'id'?: string;
|
|
1233
|
+
/**
|
|
1234
|
+
*
|
|
1235
|
+
* @type {string}
|
|
1236
|
+
* @memberof TitleType
|
|
1237
|
+
*/
|
|
1238
|
+
'schemaUri'?: string;
|
|
1239
|
+
}
|
|
1240
|
+
/**
|
|
1241
|
+
*
|
|
1242
|
+
* @export
|
|
1243
|
+
* @interface TraditionalKnowledgeLabel
|
|
1244
|
+
*/
|
|
1245
|
+
export interface TraditionalKnowledgeLabel {
|
|
1246
|
+
/**
|
|
1247
|
+
*
|
|
1248
|
+
* @type {string}
|
|
1249
|
+
* @memberof TraditionalKnowledgeLabel
|
|
1250
|
+
*/
|
|
1251
|
+
'id'?: string;
|
|
1252
|
+
/**
|
|
1253
|
+
*
|
|
1254
|
+
* @type {string}
|
|
1255
|
+
* @memberof TraditionalKnowledgeLabel
|
|
1256
|
+
*/
|
|
1257
|
+
'schemaUri'?: string;
|
|
1258
|
+
}
|
|
1259
|
+
/**
|
|
1260
|
+
*
|
|
1261
|
+
* @export
|
|
1262
|
+
* @interface ValidationFailure
|
|
1263
|
+
*/
|
|
1264
|
+
export interface ValidationFailure {
|
|
1265
|
+
/**
|
|
1266
|
+
*
|
|
1267
|
+
* @type {string}
|
|
1268
|
+
* @memberof ValidationFailure
|
|
1269
|
+
*/
|
|
1270
|
+
'fieldId': string;
|
|
1271
|
+
/**
|
|
1272
|
+
*
|
|
1273
|
+
* @type {string}
|
|
1274
|
+
* @memberof ValidationFailure
|
|
1275
|
+
*/
|
|
1276
|
+
'errorType': string;
|
|
1277
|
+
/**
|
|
1278
|
+
*
|
|
1279
|
+
* @type {string}
|
|
1280
|
+
* @memberof ValidationFailure
|
|
1281
|
+
*/
|
|
1282
|
+
'message': string;
|
|
1283
|
+
}
|
|
1284
|
+
/**
|
|
1285
|
+
*
|
|
1286
|
+
* @export
|
|
1287
|
+
* @interface ValidationFailureResponse
|
|
1288
|
+
*/
|
|
1289
|
+
export interface ValidationFailureResponse {
|
|
1290
|
+
/**
|
|
1291
|
+
*
|
|
1292
|
+
* @type {Array<ValidationFailure>}
|
|
1293
|
+
* @memberof ValidationFailureResponse
|
|
1294
|
+
*/
|
|
1295
|
+
'failures': Array<ValidationFailure>;
|
|
1296
|
+
/**
|
|
1297
|
+
*
|
|
1298
|
+
* @type {string}
|
|
1299
|
+
* @memberof ValidationFailureResponse
|
|
1300
|
+
*/
|
|
1301
|
+
'type': string;
|
|
1302
|
+
/**
|
|
1303
|
+
*
|
|
1304
|
+
* @type {string}
|
|
1305
|
+
* @memberof ValidationFailureResponse
|
|
1306
|
+
*/
|
|
1307
|
+
'title': string;
|
|
1308
|
+
/**
|
|
1309
|
+
*
|
|
1310
|
+
* @type {number}
|
|
1311
|
+
* @memberof ValidationFailureResponse
|
|
1312
|
+
*/
|
|
1313
|
+
'status': number;
|
|
1314
|
+
/**
|
|
1315
|
+
*
|
|
1316
|
+
* @type {string}
|
|
1317
|
+
* @memberof ValidationFailureResponse
|
|
1318
|
+
*/
|
|
1319
|
+
'detail': string;
|
|
1320
|
+
/**
|
|
1321
|
+
*
|
|
1322
|
+
* @type {string}
|
|
1323
|
+
* @memberof ValidationFailureResponse
|
|
1324
|
+
*/
|
|
1325
|
+
'instance': string;
|
|
1326
|
+
}
|
|
1327
|
+
/**
|
|
1328
|
+
* RaidApi - axios parameter creator
|
|
1329
|
+
* @export
|
|
1330
|
+
*/
|
|
1331
|
+
export declare const RaidApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1332
|
+
/**
|
|
1333
|
+
*
|
|
1334
|
+
* @summary list raids
|
|
1335
|
+
* @param {number} [servicePointId]
|
|
1336
|
+
* @param {Array<string>} [includeFields] The top level fields to include in each RAiD in the response body. Excludes all other fields.
|
|
1337
|
+
* @param {*} [options] Override http request option.
|
|
1338
|
+
* @throws {RequiredError}
|
|
1339
|
+
*/
|
|
1340
|
+
findAllRaids: (servicePointId?: number, includeFields?: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1341
|
+
/**
|
|
1342
|
+
*
|
|
1343
|
+
* @summary read a raid, caller must be authorized
|
|
1344
|
+
* @param {string} prefix Prefix of the raid handle
|
|
1345
|
+
* @param {string} suffix Suffix of the raid handle
|
|
1346
|
+
* @param {number} [version] The version of the raid
|
|
1347
|
+
* @param {*} [options] Override http request option.
|
|
1348
|
+
* @throws {RequiredError}
|
|
1349
|
+
*/
|
|
1350
|
+
findRaidByName: (prefix: string, suffix: string, version?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1351
|
+
/**
|
|
1352
|
+
*
|
|
1353
|
+
* @summary mint a raid
|
|
1354
|
+
* @param {RaidCreateRequest} raidCreateRequest
|
|
1355
|
+
* @param {*} [options] Override http request option.
|
|
1356
|
+
* @throws {RequiredError}
|
|
1357
|
+
*/
|
|
1358
|
+
mintRaid: (raidCreateRequest: RaidCreateRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1359
|
+
/**
|
|
1360
|
+
*
|
|
1361
|
+
* @summary A list of the changes to the raid
|
|
1362
|
+
* @param {string} prefix Prefix of the raid handle
|
|
1363
|
+
* @param {string} suffix Suffix of the raid handle
|
|
1364
|
+
* @param {*} [options] Override http request option.
|
|
1365
|
+
* @throws {RequiredError}
|
|
1366
|
+
*/
|
|
1367
|
+
raidHistory: (prefix: string, suffix: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1368
|
+
/**
|
|
1369
|
+
*
|
|
1370
|
+
* @param {string} prefix Prefix of the raid handle
|
|
1371
|
+
* @param {string} suffix Suffix of the raid handle
|
|
1372
|
+
* @param {RaidUpdateRequest} raidUpdateRequest
|
|
1373
|
+
* @param {*} [options] Override http request option.
|
|
1374
|
+
* @throws {RequiredError}
|
|
1375
|
+
*/
|
|
1376
|
+
updateRaid: (prefix: string, suffix: string, raidUpdateRequest: RaidUpdateRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1377
|
+
};
|
|
1378
|
+
/**
|
|
1379
|
+
* RaidApi - functional programming interface
|
|
1380
|
+
* @export
|
|
1381
|
+
*/
|
|
1382
|
+
export declare const RaidApiFp: (configuration?: Configuration) => {
|
|
1383
|
+
/**
|
|
1384
|
+
*
|
|
1385
|
+
* @summary list raids
|
|
1386
|
+
* @param {number} [servicePointId]
|
|
1387
|
+
* @param {Array<string>} [includeFields] The top level fields to include in each RAiD in the response body. Excludes all other fields.
|
|
1388
|
+
* @param {*} [options] Override http request option.
|
|
1389
|
+
* @throws {RequiredError}
|
|
1390
|
+
*/
|
|
1391
|
+
findAllRaids(servicePointId?: number, includeFields?: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RaidDto>>>;
|
|
1392
|
+
/**
|
|
1393
|
+
*
|
|
1394
|
+
* @summary read a raid, caller must be authorized
|
|
1395
|
+
* @param {string} prefix Prefix of the raid handle
|
|
1396
|
+
* @param {string} suffix Suffix of the raid handle
|
|
1397
|
+
* @param {number} [version] The version of the raid
|
|
1398
|
+
* @param {*} [options] Override http request option.
|
|
1399
|
+
* @throws {RequiredError}
|
|
1400
|
+
*/
|
|
1401
|
+
findRaidByName(prefix: string, suffix: string, version?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RaidDto>>;
|
|
1402
|
+
/**
|
|
1403
|
+
*
|
|
1404
|
+
* @summary mint a raid
|
|
1405
|
+
* @param {RaidCreateRequest} raidCreateRequest
|
|
1406
|
+
* @param {*} [options] Override http request option.
|
|
1407
|
+
* @throws {RequiredError}
|
|
1408
|
+
*/
|
|
1409
|
+
mintRaid(raidCreateRequest: RaidCreateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RaidDto>>;
|
|
1410
|
+
/**
|
|
1411
|
+
*
|
|
1412
|
+
* @summary A list of the changes to the raid
|
|
1413
|
+
* @param {string} prefix Prefix of the raid handle
|
|
1414
|
+
* @param {string} suffix Suffix of the raid handle
|
|
1415
|
+
* @param {*} [options] Override http request option.
|
|
1416
|
+
* @throws {RequiredError}
|
|
1417
|
+
*/
|
|
1418
|
+
raidHistory(prefix: string, suffix: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RaidChange>>>;
|
|
1419
|
+
/**
|
|
1420
|
+
*
|
|
1421
|
+
* @param {string} prefix Prefix of the raid handle
|
|
1422
|
+
* @param {string} suffix Suffix of the raid handle
|
|
1423
|
+
* @param {RaidUpdateRequest} raidUpdateRequest
|
|
1424
|
+
* @param {*} [options] Override http request option.
|
|
1425
|
+
* @throws {RequiredError}
|
|
1426
|
+
*/
|
|
1427
|
+
updateRaid(prefix: string, suffix: string, raidUpdateRequest: RaidUpdateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RaidDto>>;
|
|
1428
|
+
};
|
|
1429
|
+
/**
|
|
1430
|
+
* RaidApi - factory interface
|
|
1431
|
+
* @export
|
|
1432
|
+
*/
|
|
1433
|
+
export declare const RaidApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1434
|
+
/**
|
|
1435
|
+
*
|
|
1436
|
+
* @summary list raids
|
|
1437
|
+
* @param {number} [servicePointId]
|
|
1438
|
+
* @param {Array<string>} [includeFields] The top level fields to include in each RAiD in the response body. Excludes all other fields.
|
|
1439
|
+
* @param {*} [options] Override http request option.
|
|
1440
|
+
* @throws {RequiredError}
|
|
1441
|
+
*/
|
|
1442
|
+
findAllRaids(servicePointId?: number, includeFields?: Array<string>, options?: any): AxiosPromise<Array<RaidDto>>;
|
|
1443
|
+
/**
|
|
1444
|
+
*
|
|
1445
|
+
* @summary read a raid, caller must be authorized
|
|
1446
|
+
* @param {string} prefix Prefix of the raid handle
|
|
1447
|
+
* @param {string} suffix Suffix of the raid handle
|
|
1448
|
+
* @param {number} [version] The version of the raid
|
|
1449
|
+
* @param {*} [options] Override http request option.
|
|
1450
|
+
* @throws {RequiredError}
|
|
1451
|
+
*/
|
|
1452
|
+
findRaidByName(prefix: string, suffix: string, version?: number, options?: any): AxiosPromise<RaidDto>;
|
|
1453
|
+
/**
|
|
1454
|
+
*
|
|
1455
|
+
* @summary mint a raid
|
|
1456
|
+
* @param {RaidCreateRequest} raidCreateRequest
|
|
1457
|
+
* @param {*} [options] Override http request option.
|
|
1458
|
+
* @throws {RequiredError}
|
|
1459
|
+
*/
|
|
1460
|
+
mintRaid(raidCreateRequest: RaidCreateRequest, options?: any): AxiosPromise<RaidDto>;
|
|
1461
|
+
/**
|
|
1462
|
+
*
|
|
1463
|
+
* @summary A list of the changes to the raid
|
|
1464
|
+
* @param {string} prefix Prefix of the raid handle
|
|
1465
|
+
* @param {string} suffix Suffix of the raid handle
|
|
1466
|
+
* @param {*} [options] Override http request option.
|
|
1467
|
+
* @throws {RequiredError}
|
|
1468
|
+
*/
|
|
1469
|
+
raidHistory(prefix: string, suffix: string, options?: any): AxiosPromise<Array<RaidChange>>;
|
|
1470
|
+
/**
|
|
1471
|
+
*
|
|
1472
|
+
* @param {string} prefix Prefix of the raid handle
|
|
1473
|
+
* @param {string} suffix Suffix of the raid handle
|
|
1474
|
+
* @param {RaidUpdateRequest} raidUpdateRequest
|
|
1475
|
+
* @param {*} [options] Override http request option.
|
|
1476
|
+
* @throws {RequiredError}
|
|
1477
|
+
*/
|
|
1478
|
+
updateRaid(prefix: string, suffix: string, raidUpdateRequest: RaidUpdateRequest, options?: any): AxiosPromise<RaidDto>;
|
|
1479
|
+
};
|
|
1480
|
+
/**
|
|
1481
|
+
* RaidApi - object-oriented interface
|
|
1482
|
+
* @export
|
|
1483
|
+
* @class RaidApi
|
|
1484
|
+
* @extends {BaseAPI}
|
|
1485
|
+
*/
|
|
1486
|
+
export declare class RaidApi extends BaseAPI {
|
|
1487
|
+
/**
|
|
1488
|
+
*
|
|
1489
|
+
* @summary list raids
|
|
1490
|
+
* @param {number} [servicePointId]
|
|
1491
|
+
* @param {Array<string>} [includeFields] The top level fields to include in each RAiD in the response body. Excludes all other fields.
|
|
1492
|
+
* @param {*} [options] Override http request option.
|
|
1493
|
+
* @throws {RequiredError}
|
|
1494
|
+
* @memberof RaidApi
|
|
1495
|
+
*/
|
|
1496
|
+
findAllRaids(servicePointId?: number, includeFields?: Array<string>, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<RaidDto[], any, {}>>;
|
|
1497
|
+
/**
|
|
1498
|
+
*
|
|
1499
|
+
* @summary read a raid, caller must be authorized
|
|
1500
|
+
* @param {string} prefix Prefix of the raid handle
|
|
1501
|
+
* @param {string} suffix Suffix of the raid handle
|
|
1502
|
+
* @param {number} [version] The version of the raid
|
|
1503
|
+
* @param {*} [options] Override http request option.
|
|
1504
|
+
* @throws {RequiredError}
|
|
1505
|
+
* @memberof RaidApi
|
|
1506
|
+
*/
|
|
1507
|
+
findRaidByName(prefix: string, suffix: string, version?: number, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<RaidDto, any, {}>>;
|
|
1508
|
+
/**
|
|
1509
|
+
*
|
|
1510
|
+
* @summary mint a raid
|
|
1511
|
+
* @param {RaidCreateRequest} raidCreateRequest
|
|
1512
|
+
* @param {*} [options] Override http request option.
|
|
1513
|
+
* @throws {RequiredError}
|
|
1514
|
+
* @memberof RaidApi
|
|
1515
|
+
*/
|
|
1516
|
+
mintRaid(raidCreateRequest: RaidCreateRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<RaidDto, any, {}>>;
|
|
1517
|
+
/**
|
|
1518
|
+
*
|
|
1519
|
+
* @summary A list of the changes to the raid
|
|
1520
|
+
* @param {string} prefix Prefix of the raid handle
|
|
1521
|
+
* @param {string} suffix Suffix of the raid handle
|
|
1522
|
+
* @param {*} [options] Override http request option.
|
|
1523
|
+
* @throws {RequiredError}
|
|
1524
|
+
* @memberof RaidApi
|
|
1525
|
+
*/
|
|
1526
|
+
raidHistory(prefix: string, suffix: string, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<RaidChange[], any, {}>>;
|
|
1527
|
+
/**
|
|
1528
|
+
*
|
|
1529
|
+
* @param {string} prefix Prefix of the raid handle
|
|
1530
|
+
* @param {string} suffix Suffix of the raid handle
|
|
1531
|
+
* @param {RaidUpdateRequest} raidUpdateRequest
|
|
1532
|
+
* @param {*} [options] Override http request option.
|
|
1533
|
+
* @throws {RequiredError}
|
|
1534
|
+
* @memberof RaidApi
|
|
1535
|
+
*/
|
|
1536
|
+
updateRaid(prefix: string, suffix: string, raidUpdateRequest: RaidUpdateRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<RaidDto, any, {}>>;
|
|
1537
|
+
}
|
|
1538
|
+
/**
|
|
1539
|
+
* ServicePointApi - axios parameter creator
|
|
1540
|
+
* @export
|
|
1541
|
+
*/
|
|
1542
|
+
export declare const ServicePointApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1543
|
+
/**
|
|
1544
|
+
*
|
|
1545
|
+
* @param {ServicePointCreateRequest} servicePointCreateRequest
|
|
1546
|
+
* @param {*} [options] Override http request option.
|
|
1547
|
+
* @throws {RequiredError}
|
|
1548
|
+
*/
|
|
1549
|
+
createServicePoint: (servicePointCreateRequest: ServicePointCreateRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1550
|
+
/**
|
|
1551
|
+
*
|
|
1552
|
+
* @param {*} [options] Override http request option.
|
|
1553
|
+
* @throws {RequiredError}
|
|
1554
|
+
*/
|
|
1555
|
+
findAllServicePoints: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1556
|
+
/**
|
|
1557
|
+
*
|
|
1558
|
+
* @param {number} id The id of the service point
|
|
1559
|
+
* @param {*} [options] Override http request option.
|
|
1560
|
+
* @throws {RequiredError}
|
|
1561
|
+
*/
|
|
1562
|
+
findServicePointById: (id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1563
|
+
/**
|
|
1564
|
+
*
|
|
1565
|
+
* @param {number} id The id of the service point
|
|
1566
|
+
* @param {ServicePointUpdateRequest} servicePointUpdateRequest
|
|
1567
|
+
* @param {*} [options] Override http request option.
|
|
1568
|
+
* @throws {RequiredError}
|
|
1569
|
+
*/
|
|
1570
|
+
updateServicePoint: (id: number, servicePointUpdateRequest: ServicePointUpdateRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1571
|
+
};
|
|
1572
|
+
/**
|
|
1573
|
+
* ServicePointApi - functional programming interface
|
|
1574
|
+
* @export
|
|
1575
|
+
*/
|
|
1576
|
+
export declare const ServicePointApiFp: (configuration?: Configuration) => {
|
|
1577
|
+
/**
|
|
1578
|
+
*
|
|
1579
|
+
* @param {ServicePointCreateRequest} servicePointCreateRequest
|
|
1580
|
+
* @param {*} [options] Override http request option.
|
|
1581
|
+
* @throws {RequiredError}
|
|
1582
|
+
*/
|
|
1583
|
+
createServicePoint(servicePointCreateRequest: ServicePointCreateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServicePoint>>;
|
|
1584
|
+
/**
|
|
1585
|
+
*
|
|
1586
|
+
* @param {*} [options] Override http request option.
|
|
1587
|
+
* @throws {RequiredError}
|
|
1588
|
+
*/
|
|
1589
|
+
findAllServicePoints(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ServicePoint>>>;
|
|
1590
|
+
/**
|
|
1591
|
+
*
|
|
1592
|
+
* @param {number} id The id of the service point
|
|
1593
|
+
* @param {*} [options] Override http request option.
|
|
1594
|
+
* @throws {RequiredError}
|
|
1595
|
+
*/
|
|
1596
|
+
findServicePointById(id: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServicePoint>>;
|
|
1597
|
+
/**
|
|
1598
|
+
*
|
|
1599
|
+
* @param {number} id The id of the service point
|
|
1600
|
+
* @param {ServicePointUpdateRequest} servicePointUpdateRequest
|
|
1601
|
+
* @param {*} [options] Override http request option.
|
|
1602
|
+
* @throws {RequiredError}
|
|
1603
|
+
*/
|
|
1604
|
+
updateServicePoint(id: number, servicePointUpdateRequest: ServicePointUpdateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServicePoint>>;
|
|
1605
|
+
};
|
|
1606
|
+
/**
|
|
1607
|
+
* ServicePointApi - factory interface
|
|
1608
|
+
* @export
|
|
1609
|
+
*/
|
|
1610
|
+
export declare const ServicePointApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1611
|
+
/**
|
|
1612
|
+
*
|
|
1613
|
+
* @param {ServicePointCreateRequest} servicePointCreateRequest
|
|
1614
|
+
* @param {*} [options] Override http request option.
|
|
1615
|
+
* @throws {RequiredError}
|
|
1616
|
+
*/
|
|
1617
|
+
createServicePoint(servicePointCreateRequest: ServicePointCreateRequest, options?: any): AxiosPromise<ServicePoint>;
|
|
1618
|
+
/**
|
|
1619
|
+
*
|
|
1620
|
+
* @param {*} [options] Override http request option.
|
|
1621
|
+
* @throws {RequiredError}
|
|
1622
|
+
*/
|
|
1623
|
+
findAllServicePoints(options?: any): AxiosPromise<Array<ServicePoint>>;
|
|
1624
|
+
/**
|
|
1625
|
+
*
|
|
1626
|
+
* @param {number} id The id of the service point
|
|
1627
|
+
* @param {*} [options] Override http request option.
|
|
1628
|
+
* @throws {RequiredError}
|
|
1629
|
+
*/
|
|
1630
|
+
findServicePointById(id: number, options?: any): AxiosPromise<ServicePoint>;
|
|
1631
|
+
/**
|
|
1632
|
+
*
|
|
1633
|
+
* @param {number} id The id of the service point
|
|
1634
|
+
* @param {ServicePointUpdateRequest} servicePointUpdateRequest
|
|
1635
|
+
* @param {*} [options] Override http request option.
|
|
1636
|
+
* @throws {RequiredError}
|
|
1637
|
+
*/
|
|
1638
|
+
updateServicePoint(id: number, servicePointUpdateRequest: ServicePointUpdateRequest, options?: any): AxiosPromise<ServicePoint>;
|
|
1639
|
+
};
|
|
1640
|
+
/**
|
|
1641
|
+
* ServicePointApi - object-oriented interface
|
|
1642
|
+
* @export
|
|
1643
|
+
* @class ServicePointApi
|
|
1644
|
+
* @extends {BaseAPI}
|
|
1645
|
+
*/
|
|
1646
|
+
export declare class ServicePointApi extends BaseAPI {
|
|
1647
|
+
/**
|
|
1648
|
+
*
|
|
1649
|
+
* @param {ServicePointCreateRequest} servicePointCreateRequest
|
|
1650
|
+
* @param {*} [options] Override http request option.
|
|
1651
|
+
* @throws {RequiredError}
|
|
1652
|
+
* @memberof ServicePointApi
|
|
1653
|
+
*/
|
|
1654
|
+
createServicePoint(servicePointCreateRequest: ServicePointCreateRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<ServicePoint, any, {}>>;
|
|
1655
|
+
/**
|
|
1656
|
+
*
|
|
1657
|
+
* @param {*} [options] Override http request option.
|
|
1658
|
+
* @throws {RequiredError}
|
|
1659
|
+
* @memberof ServicePointApi
|
|
1660
|
+
*/
|
|
1661
|
+
findAllServicePoints(options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<ServicePoint[], any, {}>>;
|
|
1662
|
+
/**
|
|
1663
|
+
*
|
|
1664
|
+
* @param {number} id The id of the service point
|
|
1665
|
+
* @param {*} [options] Override http request option.
|
|
1666
|
+
* @throws {RequiredError}
|
|
1667
|
+
* @memberof ServicePointApi
|
|
1668
|
+
*/
|
|
1669
|
+
findServicePointById(id: number, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<ServicePoint, any, {}>>;
|
|
1670
|
+
/**
|
|
1671
|
+
*
|
|
1672
|
+
* @param {number} id The id of the service point
|
|
1673
|
+
* @param {ServicePointUpdateRequest} servicePointUpdateRequest
|
|
1674
|
+
* @param {*} [options] Override http request option.
|
|
1675
|
+
* @throws {RequiredError}
|
|
1676
|
+
* @memberof ServicePointApi
|
|
1677
|
+
*/
|
|
1678
|
+
updateServicePoint(id: number, servicePointUpdateRequest: ServicePointUpdateRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<ServicePoint, any, {}>>;
|
|
1679
|
+
}
|