@triveria/wallet 0.0.4 → 0.0.7
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/api.d.ts +1207 -0
- package/auth.d.ts +1 -0
- package/base.d.ts +66 -0
- package/client.d.ts +17 -0
- package/common.d.ts +65 -0
- package/configuration.d.ts +91 -0
- package/index.d.ts +15 -0
- package/package.json +1 -1
package/api.d.ts
ADDED
|
@@ -0,0 +1,1207 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Triveria Wallet API
|
|
3
|
+
* Triveria Wallet API allows to manage credentials inside a specific wallet and interactions between wallets as specified by the OIDC4VC specification.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
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 type { RequestArgs } from './base';
|
|
15
|
+
import { BaseAPI } from './base';
|
|
16
|
+
/**
|
|
17
|
+
* The authorized flow initiation result consisting of the issuer state and URL
|
|
18
|
+
* @export
|
|
19
|
+
* @interface AuthOffer
|
|
20
|
+
*/
|
|
21
|
+
export interface AuthOffer {
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof AuthOffer
|
|
26
|
+
*/
|
|
27
|
+
'state': string;
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof AuthOffer
|
|
32
|
+
*/
|
|
33
|
+
'issuer_url': string;
|
|
34
|
+
/**
|
|
35
|
+
*
|
|
36
|
+
* @type {string}
|
|
37
|
+
* @memberof AuthOffer
|
|
38
|
+
*/
|
|
39
|
+
'offer': string;
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
*
|
|
43
|
+
* @export
|
|
44
|
+
* @interface Credential
|
|
45
|
+
*/
|
|
46
|
+
export interface Credential {
|
|
47
|
+
/**
|
|
48
|
+
* The value of the @context property MUST be an ordered set where the first item is a URL with the value https://www.w3.org/ns/credentials/v2. Subsequent items in the array MUST express context information and be composed of any combination of URLs or objects. It is RECOMMENDED that each URL in the @context be one which, if dereferenced, results in a document containing machine-readable information about the @context. https://www.w3.org/TR/vc-data-model-2.0/#contexts
|
|
49
|
+
* @type {Array<string>}
|
|
50
|
+
* @memberof Credential
|
|
51
|
+
*/
|
|
52
|
+
'@context'?: Array<string>;
|
|
53
|
+
/**
|
|
54
|
+
*
|
|
55
|
+
* @type {string}
|
|
56
|
+
* @memberof Credential
|
|
57
|
+
*/
|
|
58
|
+
'id': string;
|
|
59
|
+
/**
|
|
60
|
+
* The value of the type property MUST be, or map to (through interpretation of the @context property), one or more URLs. If more than one URL is provided, the URLs MUST be interpreted as an unordered set. Syntactic conveniences SHOULD be used to ease developer usage. Such conveniences might include JSON-LD terms. It is RECOMMENDED that each URL in the type be one which, if dereferenced, results in a document containing machine-readable information about the type. https://www.w3.org/TR/vc-data-model-2.0/#types
|
|
61
|
+
* @type {Array<string>}
|
|
62
|
+
* @memberof Credential
|
|
63
|
+
*/
|
|
64
|
+
'type'?: Array<string>;
|
|
65
|
+
/**
|
|
66
|
+
*
|
|
67
|
+
* @type {CredentialSchema}
|
|
68
|
+
* @memberof Credential
|
|
69
|
+
*/
|
|
70
|
+
'credentialSchema'?: CredentialSchema;
|
|
71
|
+
/**
|
|
72
|
+
*
|
|
73
|
+
* @type {CredentialSubject}
|
|
74
|
+
* @memberof Credential
|
|
75
|
+
*/
|
|
76
|
+
'credentialSubject'?: CredentialSubject;
|
|
77
|
+
/**
|
|
78
|
+
*
|
|
79
|
+
* @type {CredentialStatus}
|
|
80
|
+
* @memberof Credential
|
|
81
|
+
*/
|
|
82
|
+
'credentialStatus'?: CredentialStatus;
|
|
83
|
+
/**
|
|
84
|
+
*
|
|
85
|
+
* @type {Array<EvidenceItem>}
|
|
86
|
+
* @memberof Credential
|
|
87
|
+
*/
|
|
88
|
+
'evidence'?: Array<EvidenceItem>;
|
|
89
|
+
/**
|
|
90
|
+
* Date Time Stamp string value representing the date and time the credential becomes valid https://www.w3.org/TR/vc-data-model-2.0/#defn-validFrom
|
|
91
|
+
* @type {string}
|
|
92
|
+
* @memberof Credential
|
|
93
|
+
*/
|
|
94
|
+
'validFrom'?: string;
|
|
95
|
+
/**
|
|
96
|
+
* Date Time Stamp string value representing the date and time the credential ceases to be valid https://www.w3.org/TR/vc-data-model-2.0/#defn-validUntil
|
|
97
|
+
* @type {string}
|
|
98
|
+
* @memberof Credential
|
|
99
|
+
*/
|
|
100
|
+
'validUntil'?: string;
|
|
101
|
+
/**
|
|
102
|
+
* EBSI specific field defining the date of issuance.
|
|
103
|
+
* @type {string}
|
|
104
|
+
* @memberof Credential
|
|
105
|
+
*/
|
|
106
|
+
'issued'?: string;
|
|
107
|
+
/**
|
|
108
|
+
* EBSI specific field defining the date of issuance.
|
|
109
|
+
* @type {string}
|
|
110
|
+
* @memberof Credential
|
|
111
|
+
*/
|
|
112
|
+
'issuanceDate'?: string;
|
|
113
|
+
/**
|
|
114
|
+
* EBSI specific field defining the date of expiration.
|
|
115
|
+
* @type {string}
|
|
116
|
+
* @memberof Credential
|
|
117
|
+
*/
|
|
118
|
+
'expirationDate'?: string;
|
|
119
|
+
/**
|
|
120
|
+
* Either a URL or an object containing an id property https://www.w3.org/TR/vc-data-model-2.0/#defn-holder
|
|
121
|
+
* @type {string}
|
|
122
|
+
* @memberof Credential
|
|
123
|
+
*/
|
|
124
|
+
'holder'?: string;
|
|
125
|
+
/**
|
|
126
|
+
* Either a URL or an object containing an id property https://www.w3.org/TR/vc-data-model-2.0/#defn-issuer
|
|
127
|
+
* @type {string}
|
|
128
|
+
* @memberof Credential
|
|
129
|
+
*/
|
|
130
|
+
'issuer'?: string;
|
|
131
|
+
/**
|
|
132
|
+
*
|
|
133
|
+
* @type {RefreshService}
|
|
134
|
+
* @memberof Credential
|
|
135
|
+
*/
|
|
136
|
+
'refreshService'?: RefreshService;
|
|
137
|
+
/**
|
|
138
|
+
*
|
|
139
|
+
* @type {TermsOfUse}
|
|
140
|
+
* @memberof Credential
|
|
141
|
+
*/
|
|
142
|
+
'termsOfUse'?: TermsOfUse;
|
|
143
|
+
/**
|
|
144
|
+
*
|
|
145
|
+
* @type {Proof}
|
|
146
|
+
* @memberof Credential
|
|
147
|
+
*/
|
|
148
|
+
'proof'?: Proof;
|
|
149
|
+
}
|
|
150
|
+
/**
|
|
151
|
+
*
|
|
152
|
+
* @export
|
|
153
|
+
* @interface CredentialIssuerDefinition
|
|
154
|
+
*/
|
|
155
|
+
export interface CredentialIssuerDefinition {
|
|
156
|
+
/**
|
|
157
|
+
* Credential format ex. `jwt_vc`.
|
|
158
|
+
* @type {string}
|
|
159
|
+
* @memberof CredentialIssuerDefinition
|
|
160
|
+
*/
|
|
161
|
+
'credentialFormat'?: CredentialIssuerDefinitionCredentialFormatEnum;
|
|
162
|
+
/**
|
|
163
|
+
* Type of credentials for which the specified credential issuer will be used.
|
|
164
|
+
* @type {Array<string>}
|
|
165
|
+
* @memberof CredentialIssuerDefinition
|
|
166
|
+
*/
|
|
167
|
+
'credentialType'?: Array<string>;
|
|
168
|
+
/**
|
|
169
|
+
* Type of issuer to be used with credentials of the type specified.
|
|
170
|
+
* @type {string}
|
|
171
|
+
* @memberof CredentialIssuerDefinition
|
|
172
|
+
*/
|
|
173
|
+
'credentialIssuer'?: CredentialIssuerDefinitionCredentialIssuerEnum;
|
|
174
|
+
}
|
|
175
|
+
export declare const CredentialIssuerDefinitionCredentialFormatEnum: {
|
|
176
|
+
readonly JwtVc: "jwt_vc";
|
|
177
|
+
};
|
|
178
|
+
export type CredentialIssuerDefinitionCredentialFormatEnum = typeof CredentialIssuerDefinitionCredentialFormatEnum[keyof typeof CredentialIssuerDefinitionCredentialFormatEnum];
|
|
179
|
+
export declare const CredentialIssuerDefinitionCredentialIssuerEnum: {
|
|
180
|
+
readonly CtWalletSame: "CtWalletSame";
|
|
181
|
+
readonly IssuanceQueue: "IssuanceQueue";
|
|
182
|
+
};
|
|
183
|
+
export type CredentialIssuerDefinitionCredentialIssuerEnum = typeof CredentialIssuerDefinitionCredentialIssuerEnum[keyof typeof CredentialIssuerDefinitionCredentialIssuerEnum];
|
|
184
|
+
/**
|
|
185
|
+
*
|
|
186
|
+
* @export
|
|
187
|
+
* @interface CredentialList
|
|
188
|
+
*/
|
|
189
|
+
export interface CredentialList {
|
|
190
|
+
/**
|
|
191
|
+
*
|
|
192
|
+
* @type {Array<CredentialMetadata>}
|
|
193
|
+
* @memberof CredentialList
|
|
194
|
+
*/
|
|
195
|
+
'list'?: Array<CredentialMetadata>;
|
|
196
|
+
}
|
|
197
|
+
/**
|
|
198
|
+
* Any Credential related accompanying key, value pairs that are not part of the Issued Credential
|
|
199
|
+
* @export
|
|
200
|
+
* @interface CredentialMetadata
|
|
201
|
+
*/
|
|
202
|
+
export interface CredentialMetadata {
|
|
203
|
+
[key: string]: string;
|
|
204
|
+
/**
|
|
205
|
+
*
|
|
206
|
+
* @type {string}
|
|
207
|
+
* @memberof CredentialMetadata
|
|
208
|
+
*/
|
|
209
|
+
'id': string;
|
|
210
|
+
/**
|
|
211
|
+
*
|
|
212
|
+
* @type {string}
|
|
213
|
+
* @memberof CredentialMetadata
|
|
214
|
+
*/
|
|
215
|
+
'name': string;
|
|
216
|
+
/**
|
|
217
|
+
*
|
|
218
|
+
* @type {string}
|
|
219
|
+
* @memberof CredentialMetadata
|
|
220
|
+
*/
|
|
221
|
+
'status': CredentialMetadataStatusEnum;
|
|
222
|
+
}
|
|
223
|
+
export declare const CredentialMetadataStatusEnum: {
|
|
224
|
+
readonly Draft: "draft";
|
|
225
|
+
readonly Valid: "valid";
|
|
226
|
+
readonly Invalid: "invalid";
|
|
227
|
+
};
|
|
228
|
+
export type CredentialMetadataStatusEnum = typeof CredentialMetadataStatusEnum[keyof typeof CredentialMetadataStatusEnum];
|
|
229
|
+
/**
|
|
230
|
+
* @type CredentialSchema
|
|
231
|
+
* One or more data schemas that provide verifiers with enough information to determine if the provided data conforms to the provided schema(s) https://www.w3.org/TR/vc-data-model-2.0/#defn-credentialSchema
|
|
232
|
+
* @export
|
|
233
|
+
*/
|
|
234
|
+
export type CredentialSchema = Array<CredentialSchemaItem> | CredentialSchemaItem;
|
|
235
|
+
/**
|
|
236
|
+
*
|
|
237
|
+
* @export
|
|
238
|
+
* @interface CredentialSchemaItem
|
|
239
|
+
*/
|
|
240
|
+
export interface CredentialSchemaItem {
|
|
241
|
+
[key: string]: any;
|
|
242
|
+
/**
|
|
243
|
+
* A URL identifying the schema file
|
|
244
|
+
* @type {string}
|
|
245
|
+
* @memberof CredentialSchemaItem
|
|
246
|
+
*/
|
|
247
|
+
'id': string;
|
|
248
|
+
/**
|
|
249
|
+
*
|
|
250
|
+
* @type {string}
|
|
251
|
+
* @memberof CredentialSchemaItem
|
|
252
|
+
*/
|
|
253
|
+
'name'?: string;
|
|
254
|
+
/**
|
|
255
|
+
* Defines the schema type, for example, JsonSchema
|
|
256
|
+
* @type {string}
|
|
257
|
+
* @memberof CredentialSchemaItem
|
|
258
|
+
*/
|
|
259
|
+
'type': string;
|
|
260
|
+
}
|
|
261
|
+
/**
|
|
262
|
+
* It is expected that the value will provide enough information to determine the current status of the credential and that machine readable information will be retrievable from the URL https://www.w3.org/TR/vc-data-model-2.0/#defn-credentialStatus
|
|
263
|
+
* @export
|
|
264
|
+
* @interface CredentialStatus
|
|
265
|
+
*/
|
|
266
|
+
export interface CredentialStatus {
|
|
267
|
+
/**
|
|
268
|
+
*
|
|
269
|
+
* @type {string}
|
|
270
|
+
* @memberof CredentialStatus
|
|
271
|
+
*/
|
|
272
|
+
'id': string;
|
|
273
|
+
/**
|
|
274
|
+
*
|
|
275
|
+
* @type {string}
|
|
276
|
+
* @memberof CredentialStatus
|
|
277
|
+
*/
|
|
278
|
+
'type': string;
|
|
279
|
+
/**
|
|
280
|
+
*
|
|
281
|
+
* @type {string}
|
|
282
|
+
* @memberof CredentialStatus
|
|
283
|
+
*/
|
|
284
|
+
'statusPurpose'?: string;
|
|
285
|
+
/**
|
|
286
|
+
*
|
|
287
|
+
* @type {string}
|
|
288
|
+
* @memberof CredentialStatus
|
|
289
|
+
*/
|
|
290
|
+
'statusListIndex'?: string;
|
|
291
|
+
/**
|
|
292
|
+
*
|
|
293
|
+
* @type {string}
|
|
294
|
+
* @memberof CredentialStatus
|
|
295
|
+
*/
|
|
296
|
+
'statusListCredential'?: string;
|
|
297
|
+
}
|
|
298
|
+
/**
|
|
299
|
+
* @type CredentialSubject
|
|
300
|
+
* Set of objects that MUST contain one or more claims that are each related to a subject of the verifiable credential https://www.w3.org/TR/vc-data-model-2.0/#defn-credentialSubject
|
|
301
|
+
* @export
|
|
302
|
+
*/
|
|
303
|
+
export type CredentialSubject = Array<CredentialSubjectItem> | CredentialSubjectItem;
|
|
304
|
+
/**
|
|
305
|
+
*
|
|
306
|
+
* @export
|
|
307
|
+
* @interface CredentialSubjectItem
|
|
308
|
+
*/
|
|
309
|
+
export interface CredentialSubjectItem {
|
|
310
|
+
[key: string]: any;
|
|
311
|
+
/**
|
|
312
|
+
*
|
|
313
|
+
* @type {string}
|
|
314
|
+
* @memberof CredentialSubjectItem
|
|
315
|
+
*/
|
|
316
|
+
'id'?: string;
|
|
317
|
+
}
|
|
318
|
+
/**
|
|
319
|
+
* A credential type that can be issued by the issuer - format: the verifiable credential format (for example \"jwt_vc\") - type: the verifiable credential type, usually provided as list of strings (for example: \"VerifiableCredential\", \"VerifiableAttestation\", \"VerifiableId\")
|
|
320
|
+
* @export
|
|
321
|
+
* @interface CredentialType
|
|
322
|
+
*/
|
|
323
|
+
export interface CredentialType {
|
|
324
|
+
/**
|
|
325
|
+
*
|
|
326
|
+
* @type {string}
|
|
327
|
+
* @memberof CredentialType
|
|
328
|
+
*/
|
|
329
|
+
'format': string;
|
|
330
|
+
/**
|
|
331
|
+
*
|
|
332
|
+
* @type {Array<string>}
|
|
333
|
+
* @memberof CredentialType
|
|
334
|
+
*/
|
|
335
|
+
'type': Array<string>;
|
|
336
|
+
}
|
|
337
|
+
/**
|
|
338
|
+
* The wrapper contains Verifiable Credential in both, the Credential and as Base64 signed format alongside with metadata.
|
|
339
|
+
* @export
|
|
340
|
+
* @interface CredentialWrapper
|
|
341
|
+
*/
|
|
342
|
+
export interface CredentialWrapper {
|
|
343
|
+
/**
|
|
344
|
+
*
|
|
345
|
+
* @type {CredentialMetadata}
|
|
346
|
+
* @memberof CredentialWrapper
|
|
347
|
+
*/
|
|
348
|
+
'metadata'?: CredentialMetadata;
|
|
349
|
+
/**
|
|
350
|
+
*
|
|
351
|
+
* @type {Credential}
|
|
352
|
+
* @memberof CredentialWrapper
|
|
353
|
+
*/
|
|
354
|
+
'vc'?: Credential;
|
|
355
|
+
/**
|
|
356
|
+
* The base64 encoded Verifiable Credential in its final signed form
|
|
357
|
+
* @type {string}
|
|
358
|
+
* @memberof CredentialWrapper
|
|
359
|
+
*/
|
|
360
|
+
'signedVc'?: string;
|
|
361
|
+
}
|
|
362
|
+
/**
|
|
363
|
+
* The deferred process status. Can be either in progress, or completed, or error. When the status is completed, the Id property will be set to the value of the resulting object ID.
|
|
364
|
+
* @export
|
|
365
|
+
* @interface Deferred
|
|
366
|
+
*/
|
|
367
|
+
export interface Deferred {
|
|
368
|
+
/**
|
|
369
|
+
*
|
|
370
|
+
* @type {string}
|
|
371
|
+
* @memberof Deferred
|
|
372
|
+
*/
|
|
373
|
+
'Status': DeferredStatusEnum;
|
|
374
|
+
/**
|
|
375
|
+
*
|
|
376
|
+
* @type {string}
|
|
377
|
+
* @memberof Deferred
|
|
378
|
+
*/
|
|
379
|
+
'Id'?: string;
|
|
380
|
+
}
|
|
381
|
+
export declare const DeferredStatusEnum: {
|
|
382
|
+
readonly InProgress: "in_progress";
|
|
383
|
+
readonly Completed: "completed";
|
|
384
|
+
readonly Error: "error";
|
|
385
|
+
};
|
|
386
|
+
export type DeferredStatusEnum = typeof DeferredStatusEnum[keyof typeof DeferredStatusEnum];
|
|
387
|
+
/**
|
|
388
|
+
* Decentralized ID of the wallet owner
|
|
389
|
+
* @export
|
|
390
|
+
* @interface Did
|
|
391
|
+
*/
|
|
392
|
+
export interface Did {
|
|
393
|
+
/**
|
|
394
|
+
*
|
|
395
|
+
* @type {string}
|
|
396
|
+
* @memberof Did
|
|
397
|
+
*/
|
|
398
|
+
'Did': string;
|
|
399
|
+
}
|
|
400
|
+
/**
|
|
401
|
+
* A scheme providing enough information for a verifier to determine whether the evidence gathered by the issuer meets its confidence requirements for relying on the credential
|
|
402
|
+
* @export
|
|
403
|
+
* @interface EvidenceItem
|
|
404
|
+
*/
|
|
405
|
+
export interface EvidenceItem {
|
|
406
|
+
[key: string]: any;
|
|
407
|
+
/**
|
|
408
|
+
* URL that points to where more information about this instance of evidence can be found
|
|
409
|
+
* @type {string}
|
|
410
|
+
* @memberof EvidenceItem
|
|
411
|
+
*/
|
|
412
|
+
'id'?: string;
|
|
413
|
+
/**
|
|
414
|
+
* The precise content of each evidence scheme is determined by the specific evidence type definition.
|
|
415
|
+
* @type {Array<string>}
|
|
416
|
+
* @memberof EvidenceItem
|
|
417
|
+
*/
|
|
418
|
+
'type': Array<string>;
|
|
419
|
+
}
|
|
420
|
+
/**
|
|
421
|
+
* Health status of the system
|
|
422
|
+
* @export
|
|
423
|
+
* @interface HealthStatus
|
|
424
|
+
*/
|
|
425
|
+
export interface HealthStatus {
|
|
426
|
+
/**
|
|
427
|
+
*
|
|
428
|
+
* @type {string}
|
|
429
|
+
* @memberof HealthStatus
|
|
430
|
+
*/
|
|
431
|
+
'status': HealthStatusStatusEnum;
|
|
432
|
+
/**
|
|
433
|
+
*
|
|
434
|
+
* @type {Array<SystemImpact>}
|
|
435
|
+
* @memberof HealthStatus
|
|
436
|
+
*/
|
|
437
|
+
'subsystems': Array<SystemImpact>;
|
|
438
|
+
}
|
|
439
|
+
export declare const HealthStatusStatusEnum: {
|
|
440
|
+
readonly Ok: "ok";
|
|
441
|
+
readonly Limited: "limited";
|
|
442
|
+
readonly Critical: "critical";
|
|
443
|
+
};
|
|
444
|
+
export type HealthStatusStatusEnum = typeof HealthStatusStatusEnum[keyof typeof HealthStatusStatusEnum];
|
|
445
|
+
/**
|
|
446
|
+
* Request for the creation of a holder initiated authorized flow offer.
|
|
447
|
+
* @export
|
|
448
|
+
* @interface HolderAuthOfferCreationReq
|
|
449
|
+
*/
|
|
450
|
+
export interface HolderAuthOfferCreationReq {
|
|
451
|
+
/**
|
|
452
|
+
*
|
|
453
|
+
* @type {string}
|
|
454
|
+
* @memberof HolderAuthOfferCreationReq
|
|
455
|
+
*/
|
|
456
|
+
'issuer_url': string;
|
|
457
|
+
/**
|
|
458
|
+
*
|
|
459
|
+
* @type {Array<string>}
|
|
460
|
+
* @memberof HolderAuthOfferCreationReq
|
|
461
|
+
*/
|
|
462
|
+
'types': Array<string>;
|
|
463
|
+
/**
|
|
464
|
+
*
|
|
465
|
+
* @type {string}
|
|
466
|
+
* @memberof HolderAuthOfferCreationReq
|
|
467
|
+
*/
|
|
468
|
+
'state': string;
|
|
469
|
+
/**
|
|
470
|
+
*
|
|
471
|
+
* @type {boolean}
|
|
472
|
+
* @memberof HolderAuthOfferCreationReq
|
|
473
|
+
*/
|
|
474
|
+
'deferred': boolean;
|
|
475
|
+
}
|
|
476
|
+
/**
|
|
477
|
+
* Request for authorization flow credential issuance process start. Consists of offered credential\'s types and credential offer endpoint (most commonly only schema)
|
|
478
|
+
* @export
|
|
479
|
+
* @interface InitAuthOffer
|
|
480
|
+
*/
|
|
481
|
+
export interface InitAuthOffer {
|
|
482
|
+
/**
|
|
483
|
+
*
|
|
484
|
+
* @type {Array<string>}
|
|
485
|
+
* @memberof InitAuthOffer
|
|
486
|
+
*/
|
|
487
|
+
'credential_types': Array<string>;
|
|
488
|
+
/**
|
|
489
|
+
*
|
|
490
|
+
* @type {string}
|
|
491
|
+
* @memberof InitAuthOffer
|
|
492
|
+
*/
|
|
493
|
+
'offer_endpoint'?: string;
|
|
494
|
+
}
|
|
495
|
+
/**
|
|
496
|
+
* Request for pre-authorized issuance process start. Consists of client id, credential offer endpoint (most commonly only schema) and id\'s of credentials to be issued to client.
|
|
497
|
+
* @export
|
|
498
|
+
* @interface InitPreAuthOffer
|
|
499
|
+
*/
|
|
500
|
+
export interface InitPreAuthOffer {
|
|
501
|
+
/**
|
|
502
|
+
*
|
|
503
|
+
* @type {string}
|
|
504
|
+
* @memberof InitPreAuthOffer
|
|
505
|
+
*/
|
|
506
|
+
'client_id': string;
|
|
507
|
+
/**
|
|
508
|
+
*
|
|
509
|
+
* @type {Array<string>}
|
|
510
|
+
* @memberof InitPreAuthOffer
|
|
511
|
+
*/
|
|
512
|
+
'credential_types': Array<string>;
|
|
513
|
+
/**
|
|
514
|
+
*
|
|
515
|
+
* @type {string}
|
|
516
|
+
* @memberof InitPreAuthOffer
|
|
517
|
+
*/
|
|
518
|
+
'offer_endpoint'?: string;
|
|
519
|
+
}
|
|
520
|
+
/**
|
|
521
|
+
* Request for addition of already created VC to issuance queue for a specified client.
|
|
522
|
+
* @export
|
|
523
|
+
* @interface IssuanceQueueCredAdd
|
|
524
|
+
*/
|
|
525
|
+
export interface IssuanceQueueCredAdd {
|
|
526
|
+
/**
|
|
527
|
+
*
|
|
528
|
+
* @type {string}
|
|
529
|
+
* @memberof IssuanceQueueCredAdd
|
|
530
|
+
*/
|
|
531
|
+
'client_id': string;
|
|
532
|
+
}
|
|
533
|
+
/**
|
|
534
|
+
* Common error message
|
|
535
|
+
* @export
|
|
536
|
+
* @interface ModelError
|
|
537
|
+
*/
|
|
538
|
+
export interface ModelError {
|
|
539
|
+
/**
|
|
540
|
+
*
|
|
541
|
+
* @type {string}
|
|
542
|
+
* @memberof ModelError
|
|
543
|
+
*/
|
|
544
|
+
'Message': string;
|
|
545
|
+
}
|
|
546
|
+
/**
|
|
547
|
+
* Result of the preauthorized issuance process start. Consists of the preauthorized code, pin, and the issuer url.
|
|
548
|
+
* @export
|
|
549
|
+
* @interface PreauthOffer
|
|
550
|
+
*/
|
|
551
|
+
export interface PreauthOffer {
|
|
552
|
+
/**
|
|
553
|
+
*
|
|
554
|
+
* @type {string}
|
|
555
|
+
* @memberof PreauthOffer
|
|
556
|
+
*/
|
|
557
|
+
'preauth_code': string;
|
|
558
|
+
/**
|
|
559
|
+
*
|
|
560
|
+
* @type {string}
|
|
561
|
+
* @memberof PreauthOffer
|
|
562
|
+
*/
|
|
563
|
+
'pin': string;
|
|
564
|
+
/**
|
|
565
|
+
*
|
|
566
|
+
* @type {string}
|
|
567
|
+
* @memberof PreauthOffer
|
|
568
|
+
*/
|
|
569
|
+
'issuer_url': string;
|
|
570
|
+
/**
|
|
571
|
+
*
|
|
572
|
+
* @type {string}
|
|
573
|
+
* @memberof PreauthOffer
|
|
574
|
+
*/
|
|
575
|
+
'offer': string;
|
|
576
|
+
}
|
|
577
|
+
/**
|
|
578
|
+
* One or more cryptographic proofs that can be used to detect tampering and verify the authorship of a verifiable credential or verifiable presentation https://www.w3.org/TR/vc-data-model-2.0/#securing-verifiable-credentials
|
|
579
|
+
* @export
|
|
580
|
+
* @interface Proof
|
|
581
|
+
*/
|
|
582
|
+
export interface Proof {
|
|
583
|
+
/**
|
|
584
|
+
*
|
|
585
|
+
* @type {string}
|
|
586
|
+
* @memberof Proof
|
|
587
|
+
*/
|
|
588
|
+
'type': string;
|
|
589
|
+
/**
|
|
590
|
+
*
|
|
591
|
+
* @type {string}
|
|
592
|
+
* @memberof Proof
|
|
593
|
+
*/
|
|
594
|
+
'created': string;
|
|
595
|
+
/**
|
|
596
|
+
*
|
|
597
|
+
* @type {string}
|
|
598
|
+
* @memberof Proof
|
|
599
|
+
*/
|
|
600
|
+
'verificationMethod': string;
|
|
601
|
+
/**
|
|
602
|
+
*
|
|
603
|
+
* @type {string}
|
|
604
|
+
* @memberof Proof
|
|
605
|
+
*/
|
|
606
|
+
'proofPurpose': string;
|
|
607
|
+
/**
|
|
608
|
+
*
|
|
609
|
+
* @type {string}
|
|
610
|
+
* @memberof Proof
|
|
611
|
+
*/
|
|
612
|
+
'proofValue'?: string;
|
|
613
|
+
}
|
|
614
|
+
/**
|
|
615
|
+
* @type RefreshService
|
|
616
|
+
* A refresh service is a mechanism that can be utilized by software agents to retrieve an updated copy of a Verifiable Credential https://www.w3.org/TR/vc-data-model-2.0/#defn-refreshService
|
|
617
|
+
* @export
|
|
618
|
+
*/
|
|
619
|
+
export type RefreshService = Array<RefreshServiceItem> | RefreshServiceItem;
|
|
620
|
+
/**
|
|
621
|
+
*
|
|
622
|
+
* @export
|
|
623
|
+
* @interface RefreshServiceItem
|
|
624
|
+
*/
|
|
625
|
+
export interface RefreshServiceItem {
|
|
626
|
+
/**
|
|
627
|
+
* The URL of the service
|
|
628
|
+
* @type {string}
|
|
629
|
+
* @memberof RefreshServiceItem
|
|
630
|
+
*/
|
|
631
|
+
'id': string;
|
|
632
|
+
/**
|
|
633
|
+
*
|
|
634
|
+
* @type {string}
|
|
635
|
+
* @memberof RefreshServiceItem
|
|
636
|
+
*/
|
|
637
|
+
'type': string;
|
|
638
|
+
}
|
|
639
|
+
/**
|
|
640
|
+
* The subsystem status impact on the overall system
|
|
641
|
+
* @export
|
|
642
|
+
* @interface SystemImpact
|
|
643
|
+
*/
|
|
644
|
+
export interface SystemImpact {
|
|
645
|
+
/**
|
|
646
|
+
*
|
|
647
|
+
* @type {string}
|
|
648
|
+
* @memberof SystemImpact
|
|
649
|
+
*/
|
|
650
|
+
'subsystem': string;
|
|
651
|
+
/**
|
|
652
|
+
*
|
|
653
|
+
* @type {string}
|
|
654
|
+
* @memberof SystemImpact
|
|
655
|
+
*/
|
|
656
|
+
'status': SystemImpactStatusEnum;
|
|
657
|
+
/**
|
|
658
|
+
*
|
|
659
|
+
* @type {string}
|
|
660
|
+
* @memberof SystemImpact
|
|
661
|
+
*/
|
|
662
|
+
'message': string;
|
|
663
|
+
}
|
|
664
|
+
export declare const SystemImpactStatusEnum: {
|
|
665
|
+
readonly Ok: "ok";
|
|
666
|
+
readonly Limited: "limited";
|
|
667
|
+
readonly Critical: "critical";
|
|
668
|
+
};
|
|
669
|
+
export type SystemImpactStatusEnum = typeof SystemImpactStatusEnum[keyof typeof SystemImpactStatusEnum];
|
|
670
|
+
/**
|
|
671
|
+
* Policy under which the creator issued the credential or presentation https://www.w3.org/TR/vc-data-model-2.0/#defn-termsOfUse
|
|
672
|
+
* @export
|
|
673
|
+
* @interface TermsOfUse
|
|
674
|
+
*/
|
|
675
|
+
export interface TermsOfUse {
|
|
676
|
+
[key: string]: any;
|
|
677
|
+
/**
|
|
678
|
+
*
|
|
679
|
+
* @type {string}
|
|
680
|
+
* @memberof TermsOfUse
|
|
681
|
+
*/
|
|
682
|
+
'id'?: string;
|
|
683
|
+
/**
|
|
684
|
+
*
|
|
685
|
+
* @type {string}
|
|
686
|
+
* @memberof TermsOfUse
|
|
687
|
+
*/
|
|
688
|
+
'type': string;
|
|
689
|
+
}
|
|
690
|
+
/**
|
|
691
|
+
* The offer to be accepted. The offer URL is mandatory and the pin is required only in case of the pre-authorized flow.
|
|
692
|
+
* @export
|
|
693
|
+
* @interface VcOffer
|
|
694
|
+
*/
|
|
695
|
+
export interface VcOffer {
|
|
696
|
+
/**
|
|
697
|
+
*
|
|
698
|
+
* @type {string}
|
|
699
|
+
* @memberof VcOffer
|
|
700
|
+
*/
|
|
701
|
+
'Url': string;
|
|
702
|
+
/**
|
|
703
|
+
*
|
|
704
|
+
* @type {string}
|
|
705
|
+
* @memberof VcOffer
|
|
706
|
+
*/
|
|
707
|
+
'Pin'?: string;
|
|
708
|
+
}
|
|
709
|
+
/**
|
|
710
|
+
* Wallet specific configuration,
|
|
711
|
+
* @export
|
|
712
|
+
* @interface WalletConfig
|
|
713
|
+
*/
|
|
714
|
+
export interface WalletConfig {
|
|
715
|
+
/**
|
|
716
|
+
* List of credential issuers to be used with credentials of a specific type during their issuance.
|
|
717
|
+
* @type {Array<CredentialIssuerDefinition>}
|
|
718
|
+
* @memberof WalletConfig
|
|
719
|
+
*/
|
|
720
|
+
'credentialIssuers'?: Array<CredentialIssuerDefinition>;
|
|
721
|
+
}
|
|
722
|
+
/**
|
|
723
|
+
* DefaultApi - axios parameter creator
|
|
724
|
+
* @export
|
|
725
|
+
*/
|
|
726
|
+
export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
727
|
+
/**
|
|
728
|
+
* Creates verifiable credential in a draft state. This endpoint is available only to the issuer wallet and should be used to initially create a credential.
|
|
729
|
+
* @param {Credential} [credential] Verifiable Credential in JSON format
|
|
730
|
+
* @param {*} [options] Override http request option.
|
|
731
|
+
* @throws {RequiredError}
|
|
732
|
+
*/
|
|
733
|
+
credentialCreate: (credential?: Credential, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
734
|
+
/**
|
|
735
|
+
* Retrieves a specific verifiable credential based on the provided identifier. Upon retrieval the status of the credential is checked on the fly and therefore guaranteed.
|
|
736
|
+
* @param {string} credentialId Verifiable Credential Identifier
|
|
737
|
+
* @param {*} [options] Override http request option.
|
|
738
|
+
* @throws {RequiredError}
|
|
739
|
+
*/
|
|
740
|
+
credentialGet: (credentialId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
741
|
+
/**
|
|
742
|
+
*
|
|
743
|
+
* @param {string} credentialId Verifiable Credential Identifier
|
|
744
|
+
* @param {*} [options] Override http request option.
|
|
745
|
+
* @throws {RequiredError}
|
|
746
|
+
*/
|
|
747
|
+
credentialIssue: (credentialId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
748
|
+
/**
|
|
749
|
+
* Retrieves a list of credentials.
|
|
750
|
+
* @param {*} [options] Override http request option.
|
|
751
|
+
* @throws {RequiredError}
|
|
752
|
+
*/
|
|
753
|
+
credentialList: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
754
|
+
/**
|
|
755
|
+
*
|
|
756
|
+
* @param {string} credentialId Verifiable Credential Identifier
|
|
757
|
+
* @param {Credential} [credential] Verifiable Credential in JSON format
|
|
758
|
+
* @param {*} [options] Override http request option.
|
|
759
|
+
* @throws {RequiredError}
|
|
760
|
+
*/
|
|
761
|
+
credentialUpdate: (credentialId: string, credential?: Credential, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
762
|
+
/**
|
|
763
|
+
*
|
|
764
|
+
* @param {string} deferredId Deferred token
|
|
765
|
+
* @param {*} [options] Override http request option.
|
|
766
|
+
* @throws {RequiredError}
|
|
767
|
+
*/
|
|
768
|
+
deferredStatus: (deferredId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
769
|
+
/**
|
|
770
|
+
*
|
|
771
|
+
* @param {*} [options] Override http request option.
|
|
772
|
+
* @throws {RequiredError}
|
|
773
|
+
*/
|
|
774
|
+
getCurrentDid: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
775
|
+
/**
|
|
776
|
+
*
|
|
777
|
+
* @param {*} [options] Override http request option.
|
|
778
|
+
* @throws {RequiredError}
|
|
779
|
+
*/
|
|
780
|
+
healthCheck: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
781
|
+
/**
|
|
782
|
+
* Creates an authorized credential offer (deferred or instant) for holder-initiated credential request using provided parameters. The offer is an URL that the creator should provide to the client via a redirect, link, or QR code.
|
|
783
|
+
* @param {HolderAuthOfferCreationReq} [holderAuthOfferCreationReq]
|
|
784
|
+
* @param {*} [options] Override http request option.
|
|
785
|
+
* @throws {RequiredError}
|
|
786
|
+
*/
|
|
787
|
+
holderCreateAuthOffer: (holderAuthOfferCreationReq?: HolderAuthOfferCreationReq, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
788
|
+
/**
|
|
789
|
+
* Returns verifiable credential format and types that are supported by the issuer. - format: the verifiable credential format (for example \"jwt_vc\") - type: a list of strings that define supported verifiable credential type(s)
|
|
790
|
+
* @param {string} url
|
|
791
|
+
* @param {*} [options] Override http request option.
|
|
792
|
+
* @throws {RequiredError}
|
|
793
|
+
*/
|
|
794
|
+
issuerCredentialTypesList: (url: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
795
|
+
/**
|
|
796
|
+
* Issue verifiable credential using OIDC4VCI offer acceptance
|
|
797
|
+
* @param {VcOffer} [vcOffer] Offer URL and optional PIN for the request
|
|
798
|
+
* @param {*} [options] Override http request option.
|
|
799
|
+
* @throws {RequiredError}
|
|
800
|
+
*/
|
|
801
|
+
oidcAcceptOffer: (vcOffer?: VcOffer, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
802
|
+
/**
|
|
803
|
+
* Add already created VC to issuance queue for a specified client using authorized in-time or deferred flow.
|
|
804
|
+
* @param {string} credentialId
|
|
805
|
+
* @param {IssuanceQueueCredAdd} [issuanceQueueCredAdd]
|
|
806
|
+
* @param {*} [options] Override http request option.
|
|
807
|
+
* @throws {RequiredError}
|
|
808
|
+
*/
|
|
809
|
+
oidcAddCredToIssuanceQueue: (credentialId: string, issuanceQueueCredAdd?: IssuanceQueueCredAdd, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
810
|
+
/**
|
|
811
|
+
* Initiates issuing of the credential using the authorized deferred flow, in which the holder will receive credential asynchronously.
|
|
812
|
+
* @param {InitAuthOffer} [initAuthOffer]
|
|
813
|
+
* @param {*} [options] Override http request option.
|
|
814
|
+
* @throws {RequiredError}
|
|
815
|
+
*/
|
|
816
|
+
oidcInitiateDeferred: (initAuthOffer?: InitAuthOffer, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
817
|
+
/**
|
|
818
|
+
* Initiates issuing of the verifiable credential using authorized flow.
|
|
819
|
+
* @param {InitAuthOffer} [initAuthOffer]
|
|
820
|
+
* @param {*} [options] Override http request option.
|
|
821
|
+
* @throws {RequiredError}
|
|
822
|
+
*/
|
|
823
|
+
oidcInitiateIntime: (initAuthOffer?: InitAuthOffer, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
824
|
+
/**
|
|
825
|
+
* Initiates issuing of the verifiable credential using pre-authorized flow.
|
|
826
|
+
* @param {InitPreAuthOffer} [initPreAuthOffer]
|
|
827
|
+
* @param {*} [options] Override http request option.
|
|
828
|
+
* @throws {RequiredError}
|
|
829
|
+
*/
|
|
830
|
+
oidcInitiatePreauth: (initPreAuthOffer?: InitPreAuthOffer, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
831
|
+
/**
|
|
832
|
+
* The first call will authenticate the client and create a new wallet that will be accessible only to the client. Any further calls are meant to update the wallet configuration. Be careful when changing the configuration as it may result in the wallet malfunction.
|
|
833
|
+
* @param {WalletConfig} [walletConfig]
|
|
834
|
+
* @param {*} [options] Override http request option.
|
|
835
|
+
* @throws {RequiredError}
|
|
836
|
+
*/
|
|
837
|
+
walletConfigure: (walletConfig?: WalletConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
838
|
+
};
|
|
839
|
+
/**
|
|
840
|
+
* DefaultApi - functional programming interface
|
|
841
|
+
* @export
|
|
842
|
+
*/
|
|
843
|
+
export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
844
|
+
/**
|
|
845
|
+
* Creates verifiable credential in a draft state. This endpoint is available only to the issuer wallet and should be used to initially create a credential.
|
|
846
|
+
* @param {Credential} [credential] Verifiable Credential in JSON format
|
|
847
|
+
* @param {*} [options] Override http request option.
|
|
848
|
+
* @throws {RequiredError}
|
|
849
|
+
*/
|
|
850
|
+
credentialCreate(credential?: Credential, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Credential>>;
|
|
851
|
+
/**
|
|
852
|
+
* Retrieves a specific verifiable credential based on the provided identifier. Upon retrieval the status of the credential is checked on the fly and therefore guaranteed.
|
|
853
|
+
* @param {string} credentialId Verifiable Credential Identifier
|
|
854
|
+
* @param {*} [options] Override http request option.
|
|
855
|
+
* @throws {RequiredError}
|
|
856
|
+
*/
|
|
857
|
+
credentialGet(credentialId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CredentialWrapper>>;
|
|
858
|
+
/**
|
|
859
|
+
*
|
|
860
|
+
* @param {string} credentialId Verifiable Credential Identifier
|
|
861
|
+
* @param {*} [options] Override http request option.
|
|
862
|
+
* @throws {RequiredError}
|
|
863
|
+
*/
|
|
864
|
+
credentialIssue(credentialId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
865
|
+
/**
|
|
866
|
+
* Retrieves a list of credentials.
|
|
867
|
+
* @param {*} [options] Override http request option.
|
|
868
|
+
* @throws {RequiredError}
|
|
869
|
+
*/
|
|
870
|
+
credentialList(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CredentialList>>;
|
|
871
|
+
/**
|
|
872
|
+
*
|
|
873
|
+
* @param {string} credentialId Verifiable Credential Identifier
|
|
874
|
+
* @param {Credential} [credential] Verifiable Credential in JSON format
|
|
875
|
+
* @param {*} [options] Override http request option.
|
|
876
|
+
* @throws {RequiredError}
|
|
877
|
+
*/
|
|
878
|
+
credentialUpdate(credentialId: string, credential?: Credential, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Credential>>;
|
|
879
|
+
/**
|
|
880
|
+
*
|
|
881
|
+
* @param {string} deferredId Deferred token
|
|
882
|
+
* @param {*} [options] Override http request option.
|
|
883
|
+
* @throws {RequiredError}
|
|
884
|
+
*/
|
|
885
|
+
deferredStatus(deferredId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Deferred>>;
|
|
886
|
+
/**
|
|
887
|
+
*
|
|
888
|
+
* @param {*} [options] Override http request option.
|
|
889
|
+
* @throws {RequiredError}
|
|
890
|
+
*/
|
|
891
|
+
getCurrentDid(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Did>>;
|
|
892
|
+
/**
|
|
893
|
+
*
|
|
894
|
+
* @param {*} [options] Override http request option.
|
|
895
|
+
* @throws {RequiredError}
|
|
896
|
+
*/
|
|
897
|
+
healthCheck(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HealthStatus>>;
|
|
898
|
+
/**
|
|
899
|
+
* Creates an authorized credential offer (deferred or instant) for holder-initiated credential request using provided parameters. The offer is an URL that the creator should provide to the client via a redirect, link, or QR code.
|
|
900
|
+
* @param {HolderAuthOfferCreationReq} [holderAuthOfferCreationReq]
|
|
901
|
+
* @param {*} [options] Override http request option.
|
|
902
|
+
* @throws {RequiredError}
|
|
903
|
+
*/
|
|
904
|
+
holderCreateAuthOffer(holderAuthOfferCreationReq?: HolderAuthOfferCreationReq, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
905
|
+
/**
|
|
906
|
+
* Returns verifiable credential format and types that are supported by the issuer. - format: the verifiable credential format (for example \"jwt_vc\") - type: a list of strings that define supported verifiable credential type(s)
|
|
907
|
+
* @param {string} url
|
|
908
|
+
* @param {*} [options] Override http request option.
|
|
909
|
+
* @throws {RequiredError}
|
|
910
|
+
*/
|
|
911
|
+
issuerCredentialTypesList(url: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CredentialType>>>;
|
|
912
|
+
/**
|
|
913
|
+
* Issue verifiable credential using OIDC4VCI offer acceptance
|
|
914
|
+
* @param {VcOffer} [vcOffer] Offer URL and optional PIN for the request
|
|
915
|
+
* @param {*} [options] Override http request option.
|
|
916
|
+
* @throws {RequiredError}
|
|
917
|
+
*/
|
|
918
|
+
oidcAcceptOffer(vcOffer?: VcOffer, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
919
|
+
/**
|
|
920
|
+
* Add already created VC to issuance queue for a specified client using authorized in-time or deferred flow.
|
|
921
|
+
* @param {string} credentialId
|
|
922
|
+
* @param {IssuanceQueueCredAdd} [issuanceQueueCredAdd]
|
|
923
|
+
* @param {*} [options] Override http request option.
|
|
924
|
+
* @throws {RequiredError}
|
|
925
|
+
*/
|
|
926
|
+
oidcAddCredToIssuanceQueue(credentialId: string, issuanceQueueCredAdd?: IssuanceQueueCredAdd, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
927
|
+
/**
|
|
928
|
+
* Initiates issuing of the credential using the authorized deferred flow, in which the holder will receive credential asynchronously.
|
|
929
|
+
* @param {InitAuthOffer} [initAuthOffer]
|
|
930
|
+
* @param {*} [options] Override http request option.
|
|
931
|
+
* @throws {RequiredError}
|
|
932
|
+
*/
|
|
933
|
+
oidcInitiateDeferred(initAuthOffer?: InitAuthOffer, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthOffer>>;
|
|
934
|
+
/**
|
|
935
|
+
* Initiates issuing of the verifiable credential using authorized flow.
|
|
936
|
+
* @param {InitAuthOffer} [initAuthOffer]
|
|
937
|
+
* @param {*} [options] Override http request option.
|
|
938
|
+
* @throws {RequiredError}
|
|
939
|
+
*/
|
|
940
|
+
oidcInitiateIntime(initAuthOffer?: InitAuthOffer, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthOffer>>;
|
|
941
|
+
/**
|
|
942
|
+
* Initiates issuing of the verifiable credential using pre-authorized flow.
|
|
943
|
+
* @param {InitPreAuthOffer} [initPreAuthOffer]
|
|
944
|
+
* @param {*} [options] Override http request option.
|
|
945
|
+
* @throws {RequiredError}
|
|
946
|
+
*/
|
|
947
|
+
oidcInitiatePreauth(initPreAuthOffer?: InitPreAuthOffer, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PreauthOffer>>;
|
|
948
|
+
/**
|
|
949
|
+
* The first call will authenticate the client and create a new wallet that will be accessible only to the client. Any further calls are meant to update the wallet configuration. Be careful when changing the configuration as it may result in the wallet malfunction.
|
|
950
|
+
* @param {WalletConfig} [walletConfig]
|
|
951
|
+
* @param {*} [options] Override http request option.
|
|
952
|
+
* @throws {RequiredError}
|
|
953
|
+
*/
|
|
954
|
+
walletConfigure(walletConfig?: WalletConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
955
|
+
};
|
|
956
|
+
/**
|
|
957
|
+
* DefaultApi - factory interface
|
|
958
|
+
* @export
|
|
959
|
+
*/
|
|
960
|
+
export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
961
|
+
/**
|
|
962
|
+
* Creates verifiable credential in a draft state. This endpoint is available only to the issuer wallet and should be used to initially create a credential.
|
|
963
|
+
* @param {Credential} [credential] Verifiable Credential in JSON format
|
|
964
|
+
* @param {*} [options] Override http request option.
|
|
965
|
+
* @throws {RequiredError}
|
|
966
|
+
*/
|
|
967
|
+
credentialCreate(credential?: Credential, options?: any): AxiosPromise<Credential>;
|
|
968
|
+
/**
|
|
969
|
+
* Retrieves a specific verifiable credential based on the provided identifier. Upon retrieval the status of the credential is checked on the fly and therefore guaranteed.
|
|
970
|
+
* @param {string} credentialId Verifiable Credential Identifier
|
|
971
|
+
* @param {*} [options] Override http request option.
|
|
972
|
+
* @throws {RequiredError}
|
|
973
|
+
*/
|
|
974
|
+
credentialGet(credentialId: string, options?: any): AxiosPromise<CredentialWrapper>;
|
|
975
|
+
/**
|
|
976
|
+
*
|
|
977
|
+
* @param {string} credentialId Verifiable Credential Identifier
|
|
978
|
+
* @param {*} [options] Override http request option.
|
|
979
|
+
* @throws {RequiredError}
|
|
980
|
+
*/
|
|
981
|
+
credentialIssue(credentialId: string, options?: any): AxiosPromise<void>;
|
|
982
|
+
/**
|
|
983
|
+
* Retrieves a list of credentials.
|
|
984
|
+
* @param {*} [options] Override http request option.
|
|
985
|
+
* @throws {RequiredError}
|
|
986
|
+
*/
|
|
987
|
+
credentialList(options?: any): AxiosPromise<CredentialList>;
|
|
988
|
+
/**
|
|
989
|
+
*
|
|
990
|
+
* @param {string} credentialId Verifiable Credential Identifier
|
|
991
|
+
* @param {Credential} [credential] Verifiable Credential in JSON format
|
|
992
|
+
* @param {*} [options] Override http request option.
|
|
993
|
+
* @throws {RequiredError}
|
|
994
|
+
*/
|
|
995
|
+
credentialUpdate(credentialId: string, credential?: Credential, options?: any): AxiosPromise<Credential>;
|
|
996
|
+
/**
|
|
997
|
+
*
|
|
998
|
+
* @param {string} deferredId Deferred token
|
|
999
|
+
* @param {*} [options] Override http request option.
|
|
1000
|
+
* @throws {RequiredError}
|
|
1001
|
+
*/
|
|
1002
|
+
deferredStatus(deferredId: string, options?: any): AxiosPromise<Deferred>;
|
|
1003
|
+
/**
|
|
1004
|
+
*
|
|
1005
|
+
* @param {*} [options] Override http request option.
|
|
1006
|
+
* @throws {RequiredError}
|
|
1007
|
+
*/
|
|
1008
|
+
getCurrentDid(options?: any): AxiosPromise<Did>;
|
|
1009
|
+
/**
|
|
1010
|
+
*
|
|
1011
|
+
* @param {*} [options] Override http request option.
|
|
1012
|
+
* @throws {RequiredError}
|
|
1013
|
+
*/
|
|
1014
|
+
healthCheck(options?: any): AxiosPromise<HealthStatus>;
|
|
1015
|
+
/**
|
|
1016
|
+
* Creates an authorized credential offer (deferred or instant) for holder-initiated credential request using provided parameters. The offer is an URL that the creator should provide to the client via a redirect, link, or QR code.
|
|
1017
|
+
* @param {HolderAuthOfferCreationReq} [holderAuthOfferCreationReq]
|
|
1018
|
+
* @param {*} [options] Override http request option.
|
|
1019
|
+
* @throws {RequiredError}
|
|
1020
|
+
*/
|
|
1021
|
+
holderCreateAuthOffer(holderAuthOfferCreationReq?: HolderAuthOfferCreationReq, options?: any): AxiosPromise<void>;
|
|
1022
|
+
/**
|
|
1023
|
+
* Returns verifiable credential format and types that are supported by the issuer. - format: the verifiable credential format (for example \"jwt_vc\") - type: a list of strings that define supported verifiable credential type(s)
|
|
1024
|
+
* @param {string} url
|
|
1025
|
+
* @param {*} [options] Override http request option.
|
|
1026
|
+
* @throws {RequiredError}
|
|
1027
|
+
*/
|
|
1028
|
+
issuerCredentialTypesList(url: string, options?: any): AxiosPromise<Array<CredentialType>>;
|
|
1029
|
+
/**
|
|
1030
|
+
* Issue verifiable credential using OIDC4VCI offer acceptance
|
|
1031
|
+
* @param {VcOffer} [vcOffer] Offer URL and optional PIN for the request
|
|
1032
|
+
* @param {*} [options] Override http request option.
|
|
1033
|
+
* @throws {RequiredError}
|
|
1034
|
+
*/
|
|
1035
|
+
oidcAcceptOffer(vcOffer?: VcOffer, options?: any): AxiosPromise<Array<string>>;
|
|
1036
|
+
/**
|
|
1037
|
+
* Add already created VC to issuance queue for a specified client using authorized in-time or deferred flow.
|
|
1038
|
+
* @param {string} credentialId
|
|
1039
|
+
* @param {IssuanceQueueCredAdd} [issuanceQueueCredAdd]
|
|
1040
|
+
* @param {*} [options] Override http request option.
|
|
1041
|
+
* @throws {RequiredError}
|
|
1042
|
+
*/
|
|
1043
|
+
oidcAddCredToIssuanceQueue(credentialId: string, issuanceQueueCredAdd?: IssuanceQueueCredAdd, options?: any): AxiosPromise<void>;
|
|
1044
|
+
/**
|
|
1045
|
+
* Initiates issuing of the credential using the authorized deferred flow, in which the holder will receive credential asynchronously.
|
|
1046
|
+
* @param {InitAuthOffer} [initAuthOffer]
|
|
1047
|
+
* @param {*} [options] Override http request option.
|
|
1048
|
+
* @throws {RequiredError}
|
|
1049
|
+
*/
|
|
1050
|
+
oidcInitiateDeferred(initAuthOffer?: InitAuthOffer, options?: any): AxiosPromise<AuthOffer>;
|
|
1051
|
+
/**
|
|
1052
|
+
* Initiates issuing of the verifiable credential using authorized flow.
|
|
1053
|
+
* @param {InitAuthOffer} [initAuthOffer]
|
|
1054
|
+
* @param {*} [options] Override http request option.
|
|
1055
|
+
* @throws {RequiredError}
|
|
1056
|
+
*/
|
|
1057
|
+
oidcInitiateIntime(initAuthOffer?: InitAuthOffer, options?: any): AxiosPromise<AuthOffer>;
|
|
1058
|
+
/**
|
|
1059
|
+
* Initiates issuing of the verifiable credential using pre-authorized flow.
|
|
1060
|
+
* @param {InitPreAuthOffer} [initPreAuthOffer]
|
|
1061
|
+
* @param {*} [options] Override http request option.
|
|
1062
|
+
* @throws {RequiredError}
|
|
1063
|
+
*/
|
|
1064
|
+
oidcInitiatePreauth(initPreAuthOffer?: InitPreAuthOffer, options?: any): AxiosPromise<PreauthOffer>;
|
|
1065
|
+
/**
|
|
1066
|
+
* The first call will authenticate the client and create a new wallet that will be accessible only to the client. Any further calls are meant to update the wallet configuration. Be careful when changing the configuration as it may result in the wallet malfunction.
|
|
1067
|
+
* @param {WalletConfig} [walletConfig]
|
|
1068
|
+
* @param {*} [options] Override http request option.
|
|
1069
|
+
* @throws {RequiredError}
|
|
1070
|
+
*/
|
|
1071
|
+
walletConfigure(walletConfig?: WalletConfig, options?: any): AxiosPromise<void>;
|
|
1072
|
+
};
|
|
1073
|
+
/**
|
|
1074
|
+
* DefaultApi - object-oriented interface
|
|
1075
|
+
* @export
|
|
1076
|
+
* @class DefaultApi
|
|
1077
|
+
* @extends {BaseAPI}
|
|
1078
|
+
*/
|
|
1079
|
+
export declare class DefaultApi extends BaseAPI {
|
|
1080
|
+
/**
|
|
1081
|
+
* Creates verifiable credential in a draft state. This endpoint is available only to the issuer wallet and should be used to initially create a credential.
|
|
1082
|
+
* @param {Credential} [credential] Verifiable Credential in JSON format
|
|
1083
|
+
* @param {*} [options] Override http request option.
|
|
1084
|
+
* @throws {RequiredError}
|
|
1085
|
+
* @memberof DefaultApi
|
|
1086
|
+
*/
|
|
1087
|
+
credentialCreate(credential?: Credential, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Credential, any>>;
|
|
1088
|
+
/**
|
|
1089
|
+
* Retrieves a specific verifiable credential based on the provided identifier. Upon retrieval the status of the credential is checked on the fly and therefore guaranteed.
|
|
1090
|
+
* @param {string} credentialId Verifiable Credential Identifier
|
|
1091
|
+
* @param {*} [options] Override http request option.
|
|
1092
|
+
* @throws {RequiredError}
|
|
1093
|
+
* @memberof DefaultApi
|
|
1094
|
+
*/
|
|
1095
|
+
credentialGet(credentialId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CredentialWrapper, any>>;
|
|
1096
|
+
/**
|
|
1097
|
+
*
|
|
1098
|
+
* @param {string} credentialId Verifiable Credential Identifier
|
|
1099
|
+
* @param {*} [options] Override http request option.
|
|
1100
|
+
* @throws {RequiredError}
|
|
1101
|
+
* @memberof DefaultApi
|
|
1102
|
+
*/
|
|
1103
|
+
credentialIssue(credentialId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
1104
|
+
/**
|
|
1105
|
+
* Retrieves a list of credentials.
|
|
1106
|
+
* @param {*} [options] Override http request option.
|
|
1107
|
+
* @throws {RequiredError}
|
|
1108
|
+
* @memberof DefaultApi
|
|
1109
|
+
*/
|
|
1110
|
+
credentialList(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CredentialList, any>>;
|
|
1111
|
+
/**
|
|
1112
|
+
*
|
|
1113
|
+
* @param {string} credentialId Verifiable Credential Identifier
|
|
1114
|
+
* @param {Credential} [credential] Verifiable Credential in JSON format
|
|
1115
|
+
* @param {*} [options] Override http request option.
|
|
1116
|
+
* @throws {RequiredError}
|
|
1117
|
+
* @memberof DefaultApi
|
|
1118
|
+
*/
|
|
1119
|
+
credentialUpdate(credentialId: string, credential?: Credential, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Credential, any>>;
|
|
1120
|
+
/**
|
|
1121
|
+
*
|
|
1122
|
+
* @param {string} deferredId Deferred token
|
|
1123
|
+
* @param {*} [options] Override http request option.
|
|
1124
|
+
* @throws {RequiredError}
|
|
1125
|
+
* @memberof DefaultApi
|
|
1126
|
+
*/
|
|
1127
|
+
deferredStatus(deferredId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Deferred, any>>;
|
|
1128
|
+
/**
|
|
1129
|
+
*
|
|
1130
|
+
* @param {*} [options] Override http request option.
|
|
1131
|
+
* @throws {RequiredError}
|
|
1132
|
+
* @memberof DefaultApi
|
|
1133
|
+
*/
|
|
1134
|
+
getCurrentDid(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Did, any>>;
|
|
1135
|
+
/**
|
|
1136
|
+
*
|
|
1137
|
+
* @param {*} [options] Override http request option.
|
|
1138
|
+
* @throws {RequiredError}
|
|
1139
|
+
* @memberof DefaultApi
|
|
1140
|
+
*/
|
|
1141
|
+
healthCheck(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HealthStatus, any>>;
|
|
1142
|
+
/**
|
|
1143
|
+
* Creates an authorized credential offer (deferred or instant) for holder-initiated credential request using provided parameters. The offer is an URL that the creator should provide to the client via a redirect, link, or QR code.
|
|
1144
|
+
* @param {HolderAuthOfferCreationReq} [holderAuthOfferCreationReq]
|
|
1145
|
+
* @param {*} [options] Override http request option.
|
|
1146
|
+
* @throws {RequiredError}
|
|
1147
|
+
* @memberof DefaultApi
|
|
1148
|
+
*/
|
|
1149
|
+
holderCreateAuthOffer(holderAuthOfferCreationReq?: HolderAuthOfferCreationReq, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
1150
|
+
/**
|
|
1151
|
+
* Returns verifiable credential format and types that are supported by the issuer. - format: the verifiable credential format (for example \"jwt_vc\") - type: a list of strings that define supported verifiable credential type(s)
|
|
1152
|
+
* @param {string} url
|
|
1153
|
+
* @param {*} [options] Override http request option.
|
|
1154
|
+
* @throws {RequiredError}
|
|
1155
|
+
* @memberof DefaultApi
|
|
1156
|
+
*/
|
|
1157
|
+
issuerCredentialTypesList(url: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CredentialType[], any>>;
|
|
1158
|
+
/**
|
|
1159
|
+
* Issue verifiable credential using OIDC4VCI offer acceptance
|
|
1160
|
+
* @param {VcOffer} [vcOffer] Offer URL and optional PIN for the request
|
|
1161
|
+
* @param {*} [options] Override http request option.
|
|
1162
|
+
* @throws {RequiredError}
|
|
1163
|
+
* @memberof DefaultApi
|
|
1164
|
+
*/
|
|
1165
|
+
oidcAcceptOffer(vcOffer?: VcOffer, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
|
|
1166
|
+
/**
|
|
1167
|
+
* Add already created VC to issuance queue for a specified client using authorized in-time or deferred flow.
|
|
1168
|
+
* @param {string} credentialId
|
|
1169
|
+
* @param {IssuanceQueueCredAdd} [issuanceQueueCredAdd]
|
|
1170
|
+
* @param {*} [options] Override http request option.
|
|
1171
|
+
* @throws {RequiredError}
|
|
1172
|
+
* @memberof DefaultApi
|
|
1173
|
+
*/
|
|
1174
|
+
oidcAddCredToIssuanceQueue(credentialId: string, issuanceQueueCredAdd?: IssuanceQueueCredAdd, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
1175
|
+
/**
|
|
1176
|
+
* Initiates issuing of the credential using the authorized deferred flow, in which the holder will receive credential asynchronously.
|
|
1177
|
+
* @param {InitAuthOffer} [initAuthOffer]
|
|
1178
|
+
* @param {*} [options] Override http request option.
|
|
1179
|
+
* @throws {RequiredError}
|
|
1180
|
+
* @memberof DefaultApi
|
|
1181
|
+
*/
|
|
1182
|
+
oidcInitiateDeferred(initAuthOffer?: InitAuthOffer, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthOffer, any>>;
|
|
1183
|
+
/**
|
|
1184
|
+
* Initiates issuing of the verifiable credential using authorized flow.
|
|
1185
|
+
* @param {InitAuthOffer} [initAuthOffer]
|
|
1186
|
+
* @param {*} [options] Override http request option.
|
|
1187
|
+
* @throws {RequiredError}
|
|
1188
|
+
* @memberof DefaultApi
|
|
1189
|
+
*/
|
|
1190
|
+
oidcInitiateIntime(initAuthOffer?: InitAuthOffer, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthOffer, any>>;
|
|
1191
|
+
/**
|
|
1192
|
+
* Initiates issuing of the verifiable credential using pre-authorized flow.
|
|
1193
|
+
* @param {InitPreAuthOffer} [initPreAuthOffer]
|
|
1194
|
+
* @param {*} [options] Override http request option.
|
|
1195
|
+
* @throws {RequiredError}
|
|
1196
|
+
* @memberof DefaultApi
|
|
1197
|
+
*/
|
|
1198
|
+
oidcInitiatePreauth(initPreAuthOffer?: InitPreAuthOffer, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PreauthOffer, any>>;
|
|
1199
|
+
/**
|
|
1200
|
+
* The first call will authenticate the client and create a new wallet that will be accessible only to the client. Any further calls are meant to update the wallet configuration. Be careful when changing the configuration as it may result in the wallet malfunction.
|
|
1201
|
+
* @param {WalletConfig} [walletConfig]
|
|
1202
|
+
* @param {*} [options] Override http request option.
|
|
1203
|
+
* @throws {RequiredError}
|
|
1204
|
+
* @memberof DefaultApi
|
|
1205
|
+
*/
|
|
1206
|
+
walletConfigure(walletConfig?: WalletConfig, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
1207
|
+
}
|