/
openapi.d.ts
866 lines (866 loc) · 27.8 KB
/
openapi.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
/* eslint-disable @typescript-eslint/no-empty-interface */
export namespace WalletComponents {
export namespace Schemas {
/**
* Error
*/
export interface ApiError {
code: number // int32
message: string
}
/**
* CompactJWS
*/
export type CompactJWS = string // ^[a-zA-Z0-9_-]+\.[a-zA-Z0-9_-]+\.[a-zA-Z0-9_-]+$
/**
* Contract
*/
export interface Contract {
/**
* example:
* Contract
*/
type: 'Contract'
/**
* example:
* Resource name
*/
name?: string
identity?: /**
* a DID using the ethr resolver
* example:
* did:ethr:i3m:0x031bee96cfae8bad99ea0dd3d08d1a3296084f894e9ddfe1ffe141133e81ac5863
*/
Did /* ^did:ethr:(\w+:)?0x[0-9a-fA-F]{40}([0-9a-fA-F]{26})?$ */
resource: {
dataSharingAgreement: DataSharingAgreement
keyPair?: JwkPair
}
}
export interface DataExchange {
/**
* A stringified JWK with alphabetically sorted claims
* example:
* {"alg":"ES256","crv":"P-256","kty":"EC","x":"t0ueMqN9j8lWYa2FXZjSw3cycpwSgxjl26qlV6zkFEo","y":"rMqWC9jGfXXLEh_1cku4-f0PfbFa1igbNWLPzos_gb0"}
*/
orig: string
/**
* A stringified JWK with alphabetically sorted claims
* example:
* {"alg":"ES256","crv":"P-256","kty":"EC","x":"sI5lkRCGpfeViQzAnu-gLnZnIGdbtfPiY7dGk4yVn-k","y":"4iFXDnEzPEb7Ce_18RSV22jW6VaVCpwH3FgTAKj3Cf4"}
*/
dest: string
/**
* example:
* A256GCM
*/
encAlg: 'A128GCM' | 'A256GCM'
/**
* example:
* ES256
*/
signingAlg: 'ES256' | 'ES384' | 'ES512'
/**
* example:
* SHA-256
*/
hashAlg: 'SHA-256' | 'SHA-384' | 'SHA-512'
ledgerContractAddress: /**
* Ethereum Address in EIP-55 format (with checksum)
* example:
* 0x71C7656EC7ab88b098defB751B7401B5f6d8976F
*/
EthereumAddress /* ^0x([0-9A-Fa-f]){40}$ */
ledgerSignerAddress: /**
* Ethereum Address in EIP-55 format (with checksum)
* example:
* 0x71C7656EC7ab88b098defB751B7401B5f6d8976F
*/
EthereumAddress /* ^0x([0-9A-Fa-f]){40}$ */
/**
* Maximum acceptable time in milliseconds between issued PoO and verified PoR
* example:
* 10000
*/
pooToPorDelay: number
/**
* Maximum acceptable time in milliseconds between issued PoO and issued PoP
* example:
* 20000
*/
pooToPopDelay: number
/**
* Maximum acceptable time between issued PoO and secret published on the ledger
* example:
* 180000
*/
pooToSecretDelay: number
/**
* A stringified JSON-LD schema describing the data format
*/
schema?: string
/**
* hash of the cipherblock in base64url with no padding
*/
cipherblockDgst: string // ^[a-zA-Z0-9_-]+$
/**
* hash of the plaintext block in base64url with no padding
*/
blockCommitment: string // ^[a-zA-Z0-9_-]+$
/**
* ash of the secret that can be used to decrypt the block in base64url with no padding
*/
secretCommitment: string // ^[a-zA-Z0-9_-]+$
}
export interface DataExchangeAgreement {
/**
* A stringified JWK with alphabetically sorted claims
* example:
* {"alg":"ES256","crv":"P-256","kty":"EC","x":"t0ueMqN9j8lWYa2FXZjSw3cycpwSgxjl26qlV6zkFEo","y":"rMqWC9jGfXXLEh_1cku4-f0PfbFa1igbNWLPzos_gb0"}
*/
orig: string
/**
* A stringified JWK with alphabetically sorted claims
* example:
* {"alg":"ES256","crv":"P-256","kty":"EC","x":"sI5lkRCGpfeViQzAnu-gLnZnIGdbtfPiY7dGk4yVn-k","y":"4iFXDnEzPEb7Ce_18RSV22jW6VaVCpwH3FgTAKj3Cf4"}
*/
dest: string
/**
* example:
* A256GCM
*/
encAlg: 'A128GCM' | 'A256GCM'
/**
* example:
* ES256
*/
signingAlg: 'ES256' | 'ES384' | 'ES512'
/**
* example:
* SHA-256
*/
hashAlg: 'SHA-256' | 'SHA-384' | 'SHA-512'
ledgerContractAddress: /**
* Ethereum Address in EIP-55 format (with checksum)
* example:
* 0x71C7656EC7ab88b098defB751B7401B5f6d8976F
*/
EthereumAddress /* ^0x([0-9A-Fa-f]){40}$ */
ledgerSignerAddress: /**
* Ethereum Address in EIP-55 format (with checksum)
* example:
* 0x71C7656EC7ab88b098defB751B7401B5f6d8976F
*/
EthereumAddress /* ^0x([0-9A-Fa-f]){40}$ */
/**
* Maximum acceptable time in milliseconds between issued PoO and verified PoR
* example:
* 10000
*/
pooToPorDelay: number
/**
* Maximum acceptable time in milliseconds between issued PoO and issued PoP
* example:
* 20000
*/
pooToPopDelay: number
/**
* Maximum acceptable time between issued PoO and secret published on the ledger
* example:
* 180000
*/
pooToSecretDelay: number
/**
* A stringified JSON-LD schema describing the data format
*/
schema?: string
}
/**
* DataExchangeResource
*/
export interface DataExchangeResource {
/**
* example:
* DataExchange
*/
type: 'DataExchange'
/**
* example:
* Resource name
*/
name?: string
resource: DataExchange
}
export interface DataSharingAgreement {
dataOfferingDescription: {
dataOfferingId: string
version: number
category?: string
active: boolean
title?: string
}
parties: {
providerDid: /**
* a DID using the ethr resolver
* example:
* did:ethr:i3m:0x031bee96cfae8bad99ea0dd3d08d1a3296084f894e9ddfe1ffe141133e81ac5863
*/
Did /* ^did:ethr:(\w+:)?0x[0-9a-fA-F]{40}([0-9a-fA-F]{26})?$ */
consumerDid: /**
* a DID using the ethr resolver
* example:
* did:ethr:i3m:0x031bee96cfae8bad99ea0dd3d08d1a3296084f894e9ddfe1ffe141133e81ac5863
*/
Did /* ^did:ethr:(\w+:)?0x[0-9a-fA-F]{40}([0-9a-fA-F]{26})?$ */
}
purpose: string
duration: {
creationDate: number
startDate: number
endDate: number
}
intendedUse: {
processData: boolean
shareDataWithThirdParty: boolean
editData: boolean
}
licenseGrant: {
transferable: boolean
exclusiveness: boolean
paidUp: boolean
revocable: boolean
processing: boolean
modifying: boolean
analyzing: boolean
storingData: boolean
storingCopy: boolean
reproducing: boolean
distributing: boolean
loaning: boolean
selling: boolean
renting: boolean
furtherLicensing: boolean
leasing: boolean
}
dataStream: boolean
personalData: boolean
pricingModel: {
paymentType?: string
pricingModelName?: string
basicPrice: number // float
currency: string
fee?: number // float
hasPaymentOnSubscription?: {
paymentOnSubscriptionName?: string
paymentType?: string
timeDuration?: string
description?: string
repeat?: string
hasSubscriptionPrice?: number
}
hasFreePrice: {
hasPriceFree?: boolean
}
}
dataExchangeAgreement: DataExchangeAgreement
signatures: {
providerSignature: /* CompactJWS */ CompactJWS /* ^[a-zA-Z0-9_-]+\.[a-zA-Z0-9_-]+\.[a-zA-Z0-9_-]+$ */
consumerSignature: /* CompactJWS */ CompactJWS /* ^[a-zA-Z0-9_-]+\.[a-zA-Z0-9_-]+\.[a-zA-Z0-9_-]+$ */
}
}
/**
* JwtPayload
*/
export interface DecodedJwt {
header?: {
[name: string]: any
typ: 'JWT'
alg: 'ES256K'
}
payload?: {
[name: string]: any
iss: /**
* a DID using the ethr resolver
* example:
* did:ethr:i3m:0x031bee96cfae8bad99ea0dd3d08d1a3296084f894e9ddfe1ffe141133e81ac5863
*/
Did /* ^did:ethr:(\w+:)?0x[0-9a-fA-F]{40}([0-9a-fA-F]{26})?$ */
}
signature: string // ^[A-Za-z0-9_-]+$
/**
* <base64url(header)>.<base64url(payload)>
*/
data: string // ^[A-Za-z0-9_-]+\.[A-Za-z0-9_-]+$
}
/**
* a DID using the ethr resolver
* example:
* did:ethr:i3m:0x031bee96cfae8bad99ea0dd3d08d1a3296084f894e9ddfe1ffe141133e81ac5863
*/
export type Did = string // ^did:ethr:(\w+:)?0x[0-9a-fA-F]{40}([0-9a-fA-F]{26})?$
/**
* Ethereum Address in EIP-55 format (with checksum)
* example:
* 0x71C7656EC7ab88b098defB751B7401B5f6d8976F
*/
export type EthereumAddress = string // ^0x([0-9A-Fa-f]){40}$
/**
* IdentityCreateInput
* Besides the here defined options, provider specific properties should be added here if necessary, e.g. "path" for BIP21 wallets, or the key algorithm (if the wallet supports multiple algorithm).
*
*/
export interface IdentityCreateInput {
[name: string]: any
alias?: string
}
/**
* IdentityCreateOutput
* It returns the account id and type
*
*/
export interface IdentityCreateOutput {
[name: string]: any
did: /**
* a DID using the ethr resolver
* example:
* did:ethr:i3m:0x031bee96cfae8bad99ea0dd3d08d1a3296084f894e9ddfe1ffe141133e81ac5863
*/
Did /* ^did:ethr:(\w+:)?0x[0-9a-fA-F]{40}([0-9a-fA-F]{26})?$ */
}
/**
* Identity Data
*/
export interface IdentityData {
/**
* example:
* did:ethr:i3m:0x03142f480f831e835822fc0cd35726844a7069d28df58fb82037f1598812e1ade8
*/
did: string
/**
* example:
* identity1
*/
alias?: string
/**
* example:
* did:ethr:i3m
*/
provider?: string
/**
* example:
* [
* "0x8646cAcF516de1292be1D30AB68E7Ea51e9B1BE7"
* ]
*/
addresses?: /**
* Ethereum Address in EIP-55 format (with checksum)
* example:
* 0x71C7656EC7ab88b098defB751B7401B5f6d8976F
*/
EthereumAddress /* ^0x([0-9A-Fa-f]){40}$ */[]
}
/**
* IdentityListInput
* A list of DIDs
*/
export type IdentityListInput = Array<{
did: /**
* a DID using the ethr resolver
* example:
* did:ethr:i3m:0x031bee96cfae8bad99ea0dd3d08d1a3296084f894e9ddfe1ffe141133e81ac5863
*/
Did /* ^did:ethr:(\w+:)?0x[0-9a-fA-F]{40}([0-9a-fA-F]{26})?$ */
}>
/**
* IdentitySelectOutput
*/
export interface IdentitySelectOutput {
did: /**
* a DID using the ethr resolver
* example:
* did:ethr:i3m:0x031bee96cfae8bad99ea0dd3d08d1a3296084f894e9ddfe1ffe141133e81ac5863
*/
Did /* ^did:ethr:(\w+:)?0x[0-9a-fA-F]{40}([0-9a-fA-F]{26})?$ */
}
export interface JwkPair {
/**
* A stringified JWK with alphabetically sorted claims that represents a private key (complementary to `publicJwk`)
*
* example:
* {"alg":"ES256","crv":"P-256","d":"rQp_3eZzvXwt1sK7WWsRhVYipqNGblzYDKKaYirlqs0","kty":"EC","x":"sMGSjfIlRJRseMpx3iHhCx4uh-6N4-AUKX18lmoeSD8","y":"Hu8EcpyH2XrCd-oKqm9keEhnMx2v2QaPs6P4Vs8OkpE"}
*/
privateJwk: string
/**
* A stringified JWK with alphabetically sorted claims that represents the public key (complementary to `privateJwk`).
*
* example:
* {"alg":"ES256","crv":"P-256","kty":"EC","x":"sMGSjfIlRJRseMpx3iHhCx4uh-6N4-AUKX18lmoeSD8","y":"Hu8EcpyH2XrCd-oKqm9keEhnMx2v2QaPs6P4Vs8OkpE"}
*/
publicJwk: string
}
/**
* JWK pair
*/
export interface KeyPair {
/**
* example:
* KeyPair
*/
type: 'KeyPair'
/**
* example:
* Resource name
*/
name?: string
identity?: /**
* a DID using the ethr resolver
* example:
* did:ethr:i3m:0x031bee96cfae8bad99ea0dd3d08d1a3296084f894e9ddfe1ffe141133e81ac5863
*/
Did /* ^did:ethr:(\w+:)?0x[0-9a-fA-F]{40}([0-9a-fA-F]{26})?$ */
resource: {
keyPair: JwkPair
}
}
/**
* NonRepudiationProof
*/
export interface NonRepudiationProof {
/**
* example:
* NonRepudiationProof
*/
type: 'NonRepudiationProof'
/**
* example:
* Resource name
*/
name?: string
/**
* a non-repudiation proof (either a PoO, a PoR or a PoP) as a compact JWS
*/
resource: any
}
/**
* ObjectResource
*/
export interface ObjectResource {
/**
* example:
* Object
*/
type: 'Object'
/**
* example:
* Resource name
*/
name?: string
parentResource?: string
identity?: /**
* a DID using the ethr resolver
* example:
* did:ethr:i3m:0x031bee96cfae8bad99ea0dd3d08d1a3296084f894e9ddfe1ffe141133e81ac5863
*/
Did /* ^did:ethr:(\w+:)?0x[0-9a-fA-F]{40}([0-9a-fA-F]{26})?$ */
resource: {
[name: string]: any
}
}
/**
* ProviderData
* A JSON object with information of the DLT provider currently in use.
*/
export interface ProviderData {
[name: string]: any
/**
* example:
* did:ethr:i3m
*/
provider?: string
/**
* example:
* i3m
*/
network?: string
rpcUrl?: string | string[]
}
/**
* Receipt
*/
export interface Receipt {
receipt: string
}
/**
* Resource
*/
export type Resource = /* Resource */ /* VerifiableCredential */ VerifiableCredential | /* ObjectResource */ ObjectResource | /* JWK pair */ KeyPair | /* Contract */ Contract | /* NonRepudiationProof */ NonRepudiationProof | /* DataExchangeResource */ DataExchangeResource
export interface ResourceId {
id: string
}
/**
* ResourceListOutput
* A list of resources
*/
export type ResourceListOutput = /* Resource */ Resource[]
export type ResourceType = 'VerifiableCredential' | 'Object' | 'KeyPair' | 'Contract' | 'DataExchange' | 'NonRepudiationProof'
/**
* SignInput
*/
export type SignInput = /* SignInput */ /* SignTransaction */ SignTransaction | /* SignRaw */ SignRaw | /* SignJWT */ SignJWT
/**
* SignJWT
*/
export interface SignJWT {
type: 'JWT'
data: {
/**
* header fields to be added to the JWS header. "alg" and "kid" will be ignored since they are automatically added by the wallet.
*/
header?: {
[name: string]: any
}
/**
* A JSON object to be signed by the wallet. It will become the payload of the generated JWS. 'iss' (issuer) and 'iat' (issued at) will be automatically added by the wallet and will override provided values.
*/
payload: {
[name: string]: any
}
}
}
/**
* SignOutput
*/
export interface SignOutput {
signature: string
}
/**
* SignRaw
*/
export interface SignRaw {
type: 'Raw'
data: {
/**
* Base64Url encoded data to sign
*/
payload: string // ^[A-Za-z0-9_-]+$
}
}
/**
* SignTransaction
*/
export interface SignTransaction {
type: 'Transaction'
data: /* Transaction */ Transaction
}
/**
* SignTypes
*/
export type SignTypes = 'Transaction' | 'Raw' | 'JWT'
/**
* SignedTransaction
* A list of resources
*/
export interface SignedTransaction {
transaction?: string // ^0x(?:[A-Fa-f0-9])+$
}
/**
* Transaction
*/
export interface Transaction {
[name: string]: any
from?: string
to?: string
nonce?: number
}
/**
* VerifiableCredential
*/
export interface VerifiableCredential {
/**
* example:
* VerifiableCredential
*/
type: 'VerifiableCredential'
/**
* example:
* Resource name
*/
name?: string
resource: {
[name: string]: any
/**
* example:
* [
* "https://www.w3.org/2018/credentials/v1"
* ]
*/
'@context': string[]
/**
* example:
* http://example.edu/credentials/1872
*/
id?: string
/**
* example:
* [
* "VerifiableCredential"
* ]
*/
type: string[]
issuer: {
[name: string]: any
id: /**
* a DID using the ethr resolver
* example:
* did:ethr:i3m:0x031bee96cfae8bad99ea0dd3d08d1a3296084f894e9ddfe1ffe141133e81ac5863
*/
Did /* ^did:ethr:(\w+:)?0x[0-9a-fA-F]{40}([0-9a-fA-F]{26})?$ */
}
/**
* example:
* 2021-06-10T19:07:28.000Z
*/
issuanceDate: string // date-time
credentialSubject: {
[name: string]: any
id: /**
* a DID using the ethr resolver
* example:
* did:ethr:i3m:0x031bee96cfae8bad99ea0dd3d08d1a3296084f894e9ddfe1ffe141133e81ac5863
*/
Did /* ^did:ethr:(\w+:)?0x[0-9a-fA-F]{40}([0-9a-fA-F]{26})?$ */
}
proof: {
[name: string]: any
type: 'JwtProof2020'
}
}
}
/**
* VerificationOutput
*/
export interface VerificationOutput {
/**
* whether verification has been successful or has failed
*/
verification: 'success' | 'failed'
/**
* error message if verification failed
*/
error?: string
/**
* the decoded JWT
*/
decodedJwt?: any
}
}
}
export namespace WalletPaths {
export namespace DidJwtVerify {
export interface RequestBody {
/**
* example:
* eyJhbGciOiJFUzI1NksiLCJ0eXAiOiJKV1QifQ.eyJmaWVsZDEiOiJzYWRzYWQ3NSIsImZpZWxkMiI6ImFmZnNhczlmODdzIiwiaXNzIjoiZGlkOmV0aHI6aTNtOjB4MDNmOTcwNjRhMzUzZmFmNWRkNTQwYWE2N2I2OTE2YmY1NmMwOWM1MGNjODAzN2E0NTNlNzg1ODdmMjdmYjg4ZTk0IiwiaWF0IjoxNjY1NDAwMzYzfQ.IpQ7WprvDMk6QWcJXuPBazat-2657dWIK-iGvOOB5oAhAmMqDBm8OEtKordqeqcEWwhWw_C7_ziMMZkPz1JIkw
*/
jwt: string // ^[A-Za-z0-9_-]+\.[A-Za-z0-9_-]+\.[A-Za-z0-9_-]+$
/**
* The expected values of the proof's payload claims. An expected value of '' can be used to just check that the claim is in the payload. An example could be:
*
* ```json
* {
* iss: 'orig',
* exchange: {
* id: '9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d',
* orig: '{"kty":"EC","x":"rPMP39e-o8cU6m4WL8_qd2wxo-nBTjWXZtPGBiiGCTY","y":"0uvxGEebFDxKOHYUlHREzq4mRULuZvQ6LB2I11yE1E0","crv":"P-256"}', // Public key in JSON.stringify(JWK) of the block origin (sender)
* dest: '{"kty":"EC","x":"qf_mNdy57ia1vAq5QLpTPxJUCRhS2003-gL0nLcbXoA","y":"H_8YwSCKJhDbZv17YEgDfAiKTaQ8x0jpLYCC2myxAeY","crv":"P-256"}', // Public key in JSON.stringify(JWK) of the block destination (receiver)
* hash_alg: 'SHA-256',
* cipherblock_dgst: 'IBUIstf98_afbiuh7UaifkasytNih7as-Jah61ls9UI', // hash of the cipherblock in base64url with no padding
* block_commitment: '', // hash of the plaintext block in base64url with no padding
* secret_commitment: '' // hash of the secret that can be used to decrypt the block in base64url with no padding
* }
* }
* ```
*
*/
expectedPayloadClaims?: {
[name: string]: any
}
}
export namespace Responses {
export type $200 = /* VerificationOutput */ WalletComponents.Schemas.VerificationOutput
export type Default = /* Error */ WalletComponents.Schemas.ApiError
}
}
export namespace IdentityCreate {
export type RequestBody = /**
* IdentityCreateInput
* Besides the here defined options, provider specific properties should be added here if necessary, e.g. "path" for BIP21 wallets, or the key algorithm (if the wallet supports multiple algorithm).
*
*/
WalletComponents.Schemas.IdentityCreateInput
export namespace Responses {
export type $201 = /**
* IdentityCreateOutput
* It returns the account id and type
*
*/
WalletComponents.Schemas.IdentityCreateOutput
export type Default = /* Error */ WalletComponents.Schemas.ApiError
}
}
export namespace IdentityDeployTransaction {
export namespace Parameters {
export type Did = /**
* a DID using the ethr resolver
* example:
* did:ethr:i3m:0x031bee96cfae8bad99ea0dd3d08d1a3296084f894e9ddfe1ffe141133e81ac5863
*/
WalletComponents.Schemas.Did /* ^did:ethr:(\w+:)?0x[0-9a-fA-F]{40}([0-9a-fA-F]{26})?$ */
}
export interface PathParameters {
did: Parameters.Did
}
export type RequestBody = /* Transaction */ WalletComponents.Schemas.Transaction
export namespace Responses {
export type $200 = /* Receipt */ WalletComponents.Schemas.Receipt
export type Default = /* Error */ WalletComponents.Schemas.ApiError
}
}
export namespace IdentityInfo {
export namespace Parameters {
export type Did = /**
* a DID using the ethr resolver
* example:
* did:ethr:i3m:0x031bee96cfae8bad99ea0dd3d08d1a3296084f894e9ddfe1ffe141133e81ac5863
*/
WalletComponents.Schemas.Did /* ^did:ethr:(\w+:)?0x[0-9a-fA-F]{40}([0-9a-fA-F]{26})?$ */
}
export interface PathParameters {
did: Parameters.Did
}
export namespace Responses {
export type $200 = /* Identity Data */ WalletComponents.Schemas.IdentityData
export type Default = /* Error */ WalletComponents.Schemas.ApiError
}
}
export namespace IdentityList {
export namespace Parameters {
/**
* An alias for the identity
*/
export type Alias = string
}
export interface QueryParameters {
alias?: /* An alias for the identity */ Parameters.Alias
}
export namespace Responses {
export type $200 = /**
* IdentityListInput
* A list of DIDs
*/
WalletComponents.Schemas.IdentityListInput
export type Default = /* Error */ WalletComponents.Schemas.ApiError
}
}
export namespace IdentitySelect {
export namespace Parameters {
/**
* Message to show to the user with the reason to pick an identity
*/
export type Reason = string
}
export interface QueryParameters {
reason?: /* Message to show to the user with the reason to pick an identity */ Parameters.Reason
}
export namespace Responses {
export type $200 = /* IdentitySelectOutput */ WalletComponents.Schemas.IdentitySelectOutput
export type Default = /* Error */ WalletComponents.Schemas.ApiError
}
}
export namespace IdentitySign {
export namespace Parameters {
export type Did = /**
* a DID using the ethr resolver
* example:
* did:ethr:i3m:0x031bee96cfae8bad99ea0dd3d08d1a3296084f894e9ddfe1ffe141133e81ac5863
*/
WalletComponents.Schemas.Did /* ^did:ethr:(\w+:)?0x[0-9a-fA-F]{40}([0-9a-fA-F]{26})?$ */
}
export interface PathParameters {
did: Parameters.Did
}
export type RequestBody = /* SignInput */ WalletComponents.Schemas.SignInput
export namespace Responses {
export type $200 = /* SignOutput */ WalletComponents.Schemas.SignOutput
export type Default = /* Error */ WalletComponents.Schemas.ApiError
}
}
export namespace ProviderinfoGet {
export namespace Responses {
export type $200 = /**
* ProviderData
* A JSON object with information of the DLT provider currently in use.
*/
WalletComponents.Schemas.ProviderData
export type Default = /* Error */ WalletComponents.Schemas.ApiError
}
}
export namespace ResourceCreate {
export type RequestBody = /* Resource */ WalletComponents.Schemas.Resource
export namespace Responses {
export type $201 = WalletComponents.Schemas.ResourceId
export type Default = /* Error */ WalletComponents.Schemas.ApiError
}
}
export namespace ResourceList {
export namespace Parameters {
export type Identity = /**
* a DID using the ethr resolver
* example:
* did:ethr:i3m:0x031bee96cfae8bad99ea0dd3d08d1a3296084f894e9ddfe1ffe141133e81ac5863
*/
WalletComponents.Schemas.Did /* ^did:ethr:(\w+:)?0x[0-9a-fA-F]{40}([0-9a-fA-F]{26})?$ */
export type ParentResource = string
export type Type = WalletComponents.Schemas.ResourceType
}
export interface QueryParameters {
type?: Parameters.Type
identity?: Parameters.Identity
parentResource?: Parameters.ParentResource
}
export namespace Responses {
export type $200 = /**
* ResourceListOutput
* A list of resources
*/
WalletComponents.Schemas.ResourceListOutput
export type Default = /* Error */ WalletComponents.Schemas.ApiError
}
}
export namespace SelectiveDisclosure {
export namespace Parameters {
export type Jwt = string // ^[A-Za-z0-9_-]+\.[A-Za-z0-9_-]+\.[A-Za-z0-9_-]+$
}
export interface PathParameters {
jwt: Parameters.Jwt /* ^[A-Za-z0-9_-]+\.[A-Za-z0-9_-]+\.[A-Za-z0-9_-]+$ */
}
export namespace Responses {
export interface $200 {
jwt?: string
}
export type Default = /* Error */ WalletComponents.Schemas.ApiError
}
}
export namespace TransactionDeploy {
export type RequestBody = /**
* SignedTransaction
* A list of resources
*/
WalletComponents.Schemas.SignedTransaction
export namespace Responses {
export interface $200 {
}
export type Default = /* Error */ WalletComponents.Schemas.ApiError
}
}
}