@idunion/tl-sdk 0.0.29 → 0.0.30

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 CHANGED
@@ -15,127 +15,60 @@ import type { RequestArgs } from './base';
15
15
  import { BaseAPI } from './base';
16
16
  /**
17
17
  * Defines accreditations which were given to specific holder
18
- * @export
19
- * @interface AccreditedFor
20
18
  */
21
19
  export interface AccreditedFor {
22
20
  /**
23
21
  * Jurisdiction limitation based on geographical region defined by https://publications.europa.eu/resource/authority/atu
24
- * @type {string}
25
- * @memberof AccreditedFor
26
22
  */
27
23
  'limitJurisdiction'?: string;
28
24
  /**
29
25
  * Link to a schema for which the accreditation is given
30
- * @type {string}
31
- * @memberof AccreditedFor
32
26
  */
33
27
  'schemaId'?: string;
34
28
  /**
35
29
  * Comma separated VC type for which the accreditation is given
36
- * @type {string}
37
- * @memberof AccreditedFor
38
30
  */
39
31
  'types'?: string;
40
32
  }
41
- /**
42
- *
43
- * @export
44
- * @interface DidDocument
45
- */
46
33
  export interface DidDocument {
47
34
  /**
48
35
  * The JSON-LD Context is either a string or a list containing any combination of strings and/or ordered maps. https://www.w3.org/TR/did-1.0/#dfn-context
49
- * @type {Array<string>}
50
- * @memberof DidDocument
51
36
  */
52
37
  '@context': Array<string>;
53
38
  /**
54
39
  * An entity that has the capability to make changes to a DID document. A DID might have more than one DID controller. The DID controller(s) can be denoted by the optional controller property at the top level of the DID document. Note that a DID controller might be the DID subject. https://www.w3.org/TR/did-1.0/#dfn-did-controllers
55
- * @type {Array<string>}
56
- * @memberof DidDocument
57
40
  */
58
41
  'controller'?: Array<string>;
59
- /**
60
- *
61
- * @type {string}
62
- * @memberof DidDocument
63
- */
64
42
  'id': string;
65
43
  /**
66
44
  * The verificationMethod property is OPTIONAL. If present, the value MUST be a set of verification methods, where each verification method is expressed using a map. The verification method map MUST include the id, type, controller, and specific verification material properties that are determined by the value of type and are defined in 5.2.1 Verification Material. A verification method MAY include additional properties. Verification methods SHOULD be registered in the DID Specification Registries [DID-SPEC-REGISTRIES]. https://www.w3.org/TR/did-1.0/#verification-methods
67
- * @type {Array<VerificationMethod>}
68
- * @memberof DidDocument
69
45
  */
70
46
  'verificationMethod'?: Array<VerificationMethod>;
71
47
  /**
72
48
  * The capabilityInvocation verification relationship is used to specify a verification method that might be used by the DID subject to invoke a cryptographic capability, such as the authorization to update the DID Document. https://www.w3.org/TR/did-1.0/#capability-invocation
73
- * @type {Array<string>}
74
- * @memberof DidDocument
75
49
  */
76
50
  'capabilityInvocation'?: Array<string>;
77
51
  /**
78
52
  * The authentication verification relationship is used to specify how the DID subject is expected to be authenticated, for purposes such as logging into a website or engaging in any sort of challenge-response protocol. https://www.w3.org/TR/did-1.0/#authentication
79
- * @type {Array<string>}
80
- * @memberof DidDocument
81
53
  */
82
54
  'authentication'?: Array<string>;
83
55
  /**
84
56
  * The assertionMethod verification relationship is used to specify how the DID subject is expected to express claims, such as for the purposes of issuing a Verifiable Credential [VC-DATA-MODEL]. https://www.w3.org/TR/did-1.0/#assertion
85
- * @type {Array<string>}
86
- * @memberof DidDocument
87
57
  */
88
58
  'assertionMethod'?: Array<string>;
89
- /**
90
- *
91
- * @type {Array<ServiceItem>}
92
- * @memberof DidDocument
93
- */
94
59
  'service'?: Array<ServiceItem>;
95
60
  }
96
- /**
97
- *
98
- * @export
99
- * @interface DidDocumentCreatePayload
100
- */
101
61
  export interface DidDocumentCreatePayload {
102
- /**
103
- *
104
- * @type {string}
105
- * @memberof DidDocumentCreatePayload
106
- */
107
62
  'didKey': string;
108
- /**
109
- *
110
- * @type {string}
111
- * @memberof DidDocumentCreatePayload
112
- */
113
63
  'orgName': string;
114
64
  }
115
- /**
116
- *
117
- * @export
118
- * @interface DidDocumentList
119
- */
120
65
  export interface DidDocumentList {
121
- /**
122
- *
123
- * @type {Array<string>}
124
- * @memberof DidDocumentList
125
- */
126
66
  'items'?: Array<string>;
127
67
  }
128
68
  /**
129
69
  * Health status of the system
130
- * @export
131
- * @interface HealthStatus
132
70
  */
133
71
  export interface HealthStatus {
134
- /**
135
- *
136
- * @type {string}
137
- * @memberof HealthStatus
138
- */
139
72
  'status': HealthStatusStatusEnum;
140
73
  }
141
74
  export declare const HealthStatusStatusEnum: {
@@ -144,160 +77,59 @@ export declare const HealthStatusStatusEnum: {
144
77
  readonly Critical: "critical";
145
78
  };
146
79
  export type HealthStatusStatusEnum = typeof HealthStatusStatusEnum[keyof typeof HealthStatusStatusEnum];
147
- /**
148
- *
149
- * @export
150
- * @interface IssuerDisplayItem
151
- */
152
80
  export interface IssuerDisplayItem {
153
- /**
154
- *
155
- * @type {string}
156
- * @memberof IssuerDisplayItem
157
- */
158
81
  'name'?: string;
159
- /**
160
- *
161
- * @type {string}
162
- * @memberof IssuerDisplayItem
163
- */
164
82
  'locale'?: string;
165
- /**
166
- *
167
- * @type {IssuerLogo}
168
- * @memberof IssuerDisplayItem
169
- */
170
83
  'logo'?: IssuerLogo;
171
84
  }
172
- /**
173
- *
174
- * @export
175
- * @interface IssuerLogo
176
- */
177
85
  export interface IssuerLogo {
178
- /**
179
- *
180
- * @type {string}
181
- * @memberof IssuerLogo
182
- */
183
86
  'uri'?: string;
184
- /**
185
- *
186
- * @type {string}
187
- * @memberof IssuerLogo
188
- */
189
87
  'alt_text'?: string;
190
88
  }
191
89
  /**
192
90
  * Common error message
193
- * @export
194
- * @interface ModelError
195
91
  */
196
92
  export interface ModelError {
197
- /**
198
- *
199
- * @type {string}
200
- * @memberof ModelError
201
- */
202
93
  'error': string;
203
- /**
204
- *
205
- * @type {string}
206
- * @memberof ModelError
207
- */
208
94
  'message': string;
209
95
  }
210
- /**
211
- *
212
- * @export
213
- * @interface OnboardingCredential
214
- */
215
96
  export interface OnboardingCredential {
216
- /**
217
- *
218
- * @type {string}
219
- * @memberof OnboardingCredential
220
- */
221
97
  'link': string;
222
- /**
223
- *
224
- * @type {string}
225
- * @memberof OnboardingCredential
226
- */
227
98
  'issuerDid': string;
228
- /**
229
- *
230
- * @type {Array<IssuerDisplayItem>}
231
- * @memberof OnboardingCredential
232
- */
233
99
  'issuerDisplay'?: Array<IssuerDisplayItem>;
234
100
  }
235
- /**
236
- *
237
- * @export
238
- * @interface OnboardingPayload
239
- */
240
101
  export interface OnboardingPayload {
241
102
  /**
242
103
  * The Verifier ID that should be used to verify the onboarding credential.
243
- * @type {string}
244
- * @memberof OnboardingPayload
245
104
  */
246
105
  'verifierId': string;
247
106
  }
248
- /**
249
- *
250
- * @export
251
- * @interface OnboardingResponse
252
- */
253
107
  export interface OnboardingResponse {
254
108
  /**
255
109
  * Url of verifier authorization server that contains the requested verifier scope.
256
- * @type {string}
257
- * @memberof OnboardingResponse
258
110
  */
259
111
  'verifierUrl': string;
260
112
  /**
261
113
  * A code that can be used to match the verified credential for later use.
262
- * @type {string}
263
- * @memberof OnboardingResponse
264
114
  */
265
115
  'verifierState': string;
266
116
  }
267
- /**
268
- *
269
- * @export
270
- * @interface OnboardingStatus
271
- */
272
117
  export interface OnboardingStatus {
273
118
  /**
274
119
  * When the status is completed the DID will be provided.
275
- * @type {string}
276
- * @memberof OnboardingStatus
277
120
  */
278
121
  'did'?: string;
279
122
  /**
280
123
  * The status message providing additional info on specific status.
281
- * @type {string}
282
- * @memberof OnboardingStatus
283
124
  */
284
125
  'message'?: string;
285
126
  /**
286
127
  * The onboarding process status
287
- * @type {string}
288
- * @memberof OnboardingStatus
289
128
  */
290
129
  'status': OnboardingStatusStatusEnum;
291
- /**
292
- *
293
- * @type {Tl}
294
- * @memberof OnboardingStatus
295
- */
296
130
  'tl'?: Tl;
297
131
  /**
298
132
  * After the onboarding is initiate this value will be provided
299
- * @type {string}
300
- * @memberof OnboardingStatus
301
133
  */
302
134
  'verifierUrl'?: string;
303
135
  }
@@ -309,175 +141,68 @@ export declare const OnboardingStatusStatusEnum: {
309
141
  export type OnboardingStatusStatusEnum = typeof OnboardingStatusStatusEnum[keyof typeof OnboardingStatusStatusEnum];
310
142
  /**
311
143
  * Services are used in DID documents to express ways of communicating with the DID subject or associated entities. A service can be any type of service the DID subject wants to advertise, including decentralized identity management services for further discovery, authentication, authorization, or interaction. https://www.w3.org/TR/did-1.0/#services
312
- * @export
313
- * @interface ServiceItem
314
144
  */
315
145
  export interface ServiceItem {
316
- /**
317
- *
318
- * @type {string}
319
- * @memberof ServiceItem
320
- */
321
146
  'id': string;
322
- /**
323
- *
324
- * @type {string}
325
- * @memberof ServiceItem
326
- */
327
147
  'type': string;
328
148
  /**
329
149
  * The value of the serviceEndpoint property MUST be a string, a map, or a set composed of one or more strings and/or maps. All string values MUST be valid URIs conforming to [RFC3986] and normalized according to the Normalization and Comparison rules in RFC3986 and to any normalization rules in its applicable URI scheme specification. https://www.w3.org/TR/did-1.0/#dfn-serviceendpoint
330
- * @type {string}
331
- * @memberof ServiceItem
332
150
  */
333
151
  'serviceEndpoint': string;
334
152
  }
335
153
  /**
336
154
  * Trust List meta info
337
- * @export
338
- * @interface Tl
339
155
  */
340
156
  export interface Tl {
341
- /**
342
- *
343
- * @type {string}
344
- * @memberof Tl
345
- */
346
157
  'id': string;
347
158
  /**
348
159
  * Trust List human-readable name
349
- * @type {string}
350
- * @memberof Tl
351
160
  */
352
161
  'name': string;
353
162
  /**
354
163
  * Trust List description
355
- * @type {string}
356
- * @memberof Tl
357
164
  */
358
165
  'description': string;
359
- /**
360
- *
361
- * @type {string}
362
- * @memberof Tl
363
- */
364
166
  'didBase': string;
365
- /**
366
- *
367
- * @type {string}
368
- * @memberof Tl
369
- */
370
167
  'governanceWalletId': string;
371
- /**
372
- *
373
- * @type {string}
374
- * @memberof Tl
375
- */
376
168
  'verifierId': string;
377
169
  }
378
- /**
379
- *
380
- * @export
381
- * @interface TlList
382
- */
383
170
  export interface TlList {
384
- /**
385
- *
386
- * @type {Array<Tl>}
387
- * @memberof TlList
388
- */
389
171
  'items'?: Array<Tl>;
390
172
  }
391
173
  /**
392
174
  * Trust List create payload
393
- * @export
394
- * @interface TlPayload
395
175
  */
396
176
  export interface TlPayload {
397
177
  /**
398
178
  * Trust List human-readable name
399
- * @type {string}
400
- * @memberof TlPayload
401
179
  */
402
180
  'name': string;
403
181
  /**
404
182
  * Trust List description
405
- * @type {string}
406
- * @memberof TlPayload
407
183
  */
408
184
  'description': string;
409
- /**
410
- *
411
- * @type {string}
412
- * @memberof TlPayload
413
- */
414
185
  'suggestedId'?: string;
415
186
  /**
416
187
  * The Wallet used by the Trust List for VC interactions
417
- * @type {string}
418
- * @memberof TlPayload
419
188
  */
420
189
  'governanceWalletId': string;
421
190
  /**
422
191
  * The Verifier used to verify onboarding credentials
423
- * @type {string}
424
- * @memberof TlPayload
425
192
  */
426
193
  'verifierId': string;
427
194
  }
428
- /**
429
- *
430
- * @export
431
- * @interface Tlr
432
- */
433
195
  export interface Tlr {
434
- /**
435
- *
436
- * @type {string}
437
- * @memberof Tlr
438
- */
439
196
  'orgName': string;
440
- /**
441
- *
442
- * @type {string}
443
- * @memberof Tlr
444
- */
445
197
  'id': string;
446
- /**
447
- *
448
- * @type {string}
449
- * @memberof Tlr
450
- */
451
198
  'did': string;
452
- /**
453
- *
454
- * @type {string}
455
- * @memberof Tlr
456
- */
457
199
  'tlId': string;
458
- /**
459
- *
460
- * @type {string}
461
- * @memberof Tlr
462
- */
463
200
  'tlName': string;
464
201
  /**
465
202
  * Denotes the Trust List record trust status. - Unverified record is created manually without presenting an onboarding VC - Verified record is created upon onboarding VC presentation - Trusted record is created upon onboarding VC presentation that was issued by an Issuer that is verified by IDunion SCE
466
- * @type {string}
467
- * @memberof Tlr
468
203
  */
469
204
  'status': TlrStatusEnum;
470
- /**
471
- *
472
- * @type {Array<AccreditedFor>}
473
- * @memberof Tlr
474
- */
475
205
  'accreditedFor'?: Array<AccreditedFor>;
476
- /**
477
- *
478
- * @type {Array<OnboardingCredential>}
479
- * @memberof Tlr
480
- */
481
206
  'onboardingCredentials'?: Array<OnboardingCredential>;
482
207
  }
483
208
  export declare const TlrStatusEnum: {
@@ -486,61 +211,26 @@ export declare const TlrStatusEnum: {
486
211
  readonly Trusted: "trusted";
487
212
  };
488
213
  export type TlrStatusEnum = typeof TlrStatusEnum[keyof typeof TlrStatusEnum];
489
- /**
490
- *
491
- * @export
492
- * @interface TlrList
493
- */
494
214
  export interface TlrList {
495
- /**
496
- *
497
- * @type {Array<Tlr>}
498
- * @memberof TlrList
499
- */
500
215
  'items'?: Array<Tlr>;
501
216
  }
502
- /**
503
- *
504
- * @export
505
- * @interface VerificationMethod
506
- */
507
217
  export interface VerificationMethod {
508
218
  [key: string]: any;
509
- /**
510
- *
511
- * @type {string}
512
- * @memberof VerificationMethod
513
- */
514
219
  'controller': string;
515
- /**
516
- *
517
- * @type {string}
518
- * @memberof VerificationMethod
519
- */
520
220
  'id': string;
521
221
  /**
522
222
  * The value of the type property MUST be a string that references exactly one verification method type. In order to maximize global interoperability, the verification method type SHOULD be registered in the DID Specification Registries [DID-SPEC-REGISTRIES].
523
- * @type {string}
524
- * @memberof VerificationMethod
525
223
  */
526
224
  'type': string;
527
225
  }
528
- /**
529
- *
530
- * @export
531
- * @interface VpResponse
532
- */
533
226
  export interface VpResponse {
534
227
  /**
535
228
  * Verifiable Presentation in JWT format
536
- * @type {string}
537
- * @memberof VpResponse
538
229
  */
539
230
  'vp': string;
540
231
  }
541
232
  /**
542
233
  * DefaultApi - axios parameter creator
543
- * @export
544
234
  */
545
235
  export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
546
236
  /**
@@ -667,7 +357,6 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
667
357
  };
668
358
  /**
669
359
  * DefaultApi - functional programming interface
670
- * @export
671
360
  */
672
361
  export declare const DefaultApiFp: (configuration?: Configuration) => {
673
362
  /**
@@ -794,7 +483,6 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
794
483
  };
795
484
  /**
796
485
  * DefaultApi - factory interface
797
- * @export
798
486
  */
799
487
  export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
800
488
  /**
@@ -921,9 +609,6 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
921
609
  };
922
610
  /**
923
611
  * DefaultApi - object-oriented interface
924
- * @export
925
- * @class DefaultApi
926
- * @extends {BaseAPI}
927
612
  */
928
613
  export declare class DefaultApi extends BaseAPI {
929
614
  /**
@@ -932,7 +617,6 @@ export declare class DefaultApi extends BaseAPI {
932
617
  * @param {DidDocumentCreatePayload} [didDocumentCreatePayload] DID Document Create Payload.
933
618
  * @param {*} [options] Override http request option.
934
619
  * @throws {RequiredError}
935
- * @memberof DefaultApi
936
620
  */
937
621
  didDocumentCreate(tlId: string, didDocumentCreatePayload?: DidDocumentCreatePayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
938
622
  /**
@@ -941,7 +625,6 @@ export declare class DefaultApi extends BaseAPI {
941
625
  * @param {string} tlrId Trust List Record Identifier
942
626
  * @param {*} [options] Override http request option.
943
627
  * @throws {RequiredError}
944
- * @memberof DefaultApi
945
628
  */
946
629
  didGet(tlId: string, tlrId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DidDocument, any>>;
947
630
  /**
@@ -949,7 +632,6 @@ export declare class DefaultApi extends BaseAPI {
949
632
  * @param {string} tlId
950
633
  * @param {*} [options] Override http request option.
951
634
  * @throws {RequiredError}
952
- * @memberof DefaultApi
953
635
  */
954
636
  didSuggest(tlId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
955
637
  /**
@@ -959,14 +641,12 @@ export declare class DefaultApi extends BaseAPI {
959
641
  * @param {VerificationMethod} [verificationMethod] Verification method.
960
642
  * @param {*} [options] Override http request option.
961
643
  * @throws {RequiredError}
962
- * @memberof DefaultApi
963
644
  */
964
645
  didVerificationMethodAdd(tlId: string, did: string, verificationMethod?: VerificationMethod, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
965
646
  /**
966
647
  *
967
648
  * @param {*} [options] Override http request option.
968
649
  * @throws {RequiredError}
969
- * @memberof DefaultApi
970
650
  */
971
651
  healthCheck(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HealthStatus, any>>;
972
652
  /**
@@ -975,7 +655,6 @@ export declare class DefaultApi extends BaseAPI {
975
655
  * @param {OnboardingPayload} [onboardingPayload] DID onboarding init payload.
976
656
  * @param {*} [options] Override http request option.
977
657
  * @throws {RequiredError}
978
- * @memberof DefaultApi
979
658
  */
980
659
  onboardingInit(tlId: string, onboardingPayload?: OnboardingPayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OnboardingResponse, any>>;
981
660
  /**
@@ -983,7 +662,6 @@ export declare class DefaultApi extends BaseAPI {
983
662
  * @param {string} verifierState Verifier state
984
663
  * @param {*} [options] Override http request option.
985
664
  * @throws {RequiredError}
986
- * @memberof DefaultApi
987
665
  */
988
666
  onboardingStatus(verifierState: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OnboardingStatus, any>>;
989
667
  /**
@@ -991,7 +669,6 @@ export declare class DefaultApi extends BaseAPI {
991
669
  * @param {TlPayload} [tlPayload] Trust List create payload.
992
670
  * @param {*} [options] Override http request option.
993
671
  * @throws {RequiredError}
994
- * @memberof DefaultApi
995
672
  */
996
673
  tlCreate(tlPayload?: TlPayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Tl, any>>;
997
674
  /**
@@ -999,7 +676,6 @@ export declare class DefaultApi extends BaseAPI {
999
676
  * @param {string} tlId
1000
677
  * @param {*} [options] Override http request option.
1001
678
  * @throws {RequiredError}
1002
- * @memberof DefaultApi
1003
679
  */
1004
680
  tlGet(tlId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Tl, any>>;
1005
681
  /**
@@ -1007,7 +683,6 @@ export declare class DefaultApi extends BaseAPI {
1007
683
  * @param {string} [ownerId]
1008
684
  * @param {*} [options] Override http request option.
1009
685
  * @throws {RequiredError}
1010
- * @memberof DefaultApi
1011
686
  */
1012
687
  tlList(ownerId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TlList, any>>;
1013
688
  /**
@@ -1016,7 +691,6 @@ export declare class DefaultApi extends BaseAPI {
1016
691
  * @param {TlPayload} [tlPayload] Trust List create payload.
1017
692
  * @param {*} [options] Override http request option.
1018
693
  * @throws {RequiredError}
1019
- * @memberof DefaultApi
1020
694
  */
1021
695
  tlPatch(tlId: string, tlPayload?: TlPayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Tl, any>>;
1022
696
  /**
@@ -1025,7 +699,6 @@ export declare class DefaultApi extends BaseAPI {
1025
699
  * @param {string} tlrId Trust List Record Identifier
1026
700
  * @param {*} [options] Override http request option.
1027
701
  * @throws {RequiredError}
1028
- * @memberof DefaultApi
1029
702
  */
1030
703
  tlrGet(tlId: string, tlrId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Tlr, any>>;
1031
704
  /**
@@ -1033,7 +706,6 @@ export declare class DefaultApi extends BaseAPI {
1033
706
  * @param {string} orgName
1034
707
  * @param {*} [options] Override http request option.
1035
708
  * @throws {RequiredError}
1036
- * @memberof DefaultApi
1037
709
  */
1038
710
  tlrSearch(orgName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TlrList, any>>;
1039
711
  /**
@@ -1042,7 +714,6 @@ export declare class DefaultApi extends BaseAPI {
1042
714
  * @param {string} tlrId Trust List Record Identifier
1043
715
  * @param {*} [options] Override http request option.
1044
716
  * @throws {RequiredError}
1045
- * @memberof DefaultApi
1046
717
  */
1047
718
  tlrTrustChainGet(tlId: string, tlrId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Tlr[], any>>;
1048
719
  /**
@@ -1050,7 +721,6 @@ export declare class DefaultApi extends BaseAPI {
1050
721
  * @param {string} tlId
1051
722
  * @param {*} [options] Override http request option.
1052
723
  * @throws {RequiredError}
1053
- * @memberof DefaultApi
1054
724
  */
1055
725
  tlrsGet(tlId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TlrList, any>>;
1056
726
  /**
@@ -1060,7 +730,6 @@ export declare class DefaultApi extends BaseAPI {
1060
730
  * @param {string} id
1061
731
  * @param {*} [options] Override http request option.
1062
732
  * @throws {RequiredError}
1063
- * @memberof DefaultApi
1064
733
  */
1065
734
  vpGet(tlId: string, did: string, id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VpResponse, any>>;
1066
735
  }
package/api.js CHANGED
@@ -49,7 +49,6 @@ exports.TlrStatusEnum = {
49
49
  };
50
50
  /**
51
51
  * DefaultApi - axios parameter creator
52
- * @export
53
52
  */
54
53
  const DefaultApiAxiosParamCreator = function (configuration) {
55
54
  return {
@@ -564,7 +563,6 @@ const DefaultApiAxiosParamCreator = function (configuration) {
564
563
  exports.DefaultApiAxiosParamCreator = DefaultApiAxiosParamCreator;
565
564
  /**
566
565
  * DefaultApi - functional programming interface
567
- * @export
568
566
  */
569
567
  const DefaultApiFp = function (configuration) {
570
568
  const localVarAxiosParamCreator = (0, exports.DefaultApiAxiosParamCreator)(configuration);
@@ -823,7 +821,6 @@ const DefaultApiFp = function (configuration) {
823
821
  exports.DefaultApiFp = DefaultApiFp;
824
822
  /**
825
823
  * DefaultApi - factory interface
826
- * @export
827
824
  */
828
825
  const DefaultApiFactory = function (configuration, basePath, axios) {
829
826
  const localVarFp = (0, exports.DefaultApiFp)(configuration);
@@ -986,9 +983,6 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
986
983
  exports.DefaultApiFactory = DefaultApiFactory;
987
984
  /**
988
985
  * DefaultApi - object-oriented interface
989
- * @export
990
- * @class DefaultApi
991
- * @extends {BaseAPI}
992
986
  */
993
987
  class DefaultApi extends base_1.BaseAPI {
994
988
  /**
@@ -997,7 +991,6 @@ class DefaultApi extends base_1.BaseAPI {
997
991
  * @param {DidDocumentCreatePayload} [didDocumentCreatePayload] DID Document Create Payload.
998
992
  * @param {*} [options] Override http request option.
999
993
  * @throws {RequiredError}
1000
- * @memberof DefaultApi
1001
994
  */
1002
995
  didDocumentCreate(tlId, didDocumentCreatePayload, options) {
1003
996
  return (0, exports.DefaultApiFp)(this.configuration).didDocumentCreate(tlId, didDocumentCreatePayload, options).then((request) => request(this.axios, this.basePath));
@@ -1008,7 +1001,6 @@ class DefaultApi extends base_1.BaseAPI {
1008
1001
  * @param {string} tlrId Trust List Record Identifier
1009
1002
  * @param {*} [options] Override http request option.
1010
1003
  * @throws {RequiredError}
1011
- * @memberof DefaultApi
1012
1004
  */
1013
1005
  didGet(tlId, tlrId, options) {
1014
1006
  return (0, exports.DefaultApiFp)(this.configuration).didGet(tlId, tlrId, options).then((request) => request(this.axios, this.basePath));
@@ -1018,7 +1010,6 @@ class DefaultApi extends base_1.BaseAPI {
1018
1010
  * @param {string} tlId
1019
1011
  * @param {*} [options] Override http request option.
1020
1012
  * @throws {RequiredError}
1021
- * @memberof DefaultApi
1022
1013
  */
1023
1014
  didSuggest(tlId, options) {
1024
1015
  return (0, exports.DefaultApiFp)(this.configuration).didSuggest(tlId, options).then((request) => request(this.axios, this.basePath));
@@ -1030,7 +1021,6 @@ class DefaultApi extends base_1.BaseAPI {
1030
1021
  * @param {VerificationMethod} [verificationMethod] Verification method.
1031
1022
  * @param {*} [options] Override http request option.
1032
1023
  * @throws {RequiredError}
1033
- * @memberof DefaultApi
1034
1024
  */
1035
1025
  didVerificationMethodAdd(tlId, did, verificationMethod, options) {
1036
1026
  return (0, exports.DefaultApiFp)(this.configuration).didVerificationMethodAdd(tlId, did, verificationMethod, options).then((request) => request(this.axios, this.basePath));
@@ -1039,7 +1029,6 @@ class DefaultApi extends base_1.BaseAPI {
1039
1029
  *
1040
1030
  * @param {*} [options] Override http request option.
1041
1031
  * @throws {RequiredError}
1042
- * @memberof DefaultApi
1043
1032
  */
1044
1033
  healthCheck(options) {
1045
1034
  return (0, exports.DefaultApiFp)(this.configuration).healthCheck(options).then((request) => request(this.axios, this.basePath));
@@ -1050,7 +1039,6 @@ class DefaultApi extends base_1.BaseAPI {
1050
1039
  * @param {OnboardingPayload} [onboardingPayload] DID onboarding init payload.
1051
1040
  * @param {*} [options] Override http request option.
1052
1041
  * @throws {RequiredError}
1053
- * @memberof DefaultApi
1054
1042
  */
1055
1043
  onboardingInit(tlId, onboardingPayload, options) {
1056
1044
  return (0, exports.DefaultApiFp)(this.configuration).onboardingInit(tlId, onboardingPayload, options).then((request) => request(this.axios, this.basePath));
@@ -1060,7 +1048,6 @@ class DefaultApi extends base_1.BaseAPI {
1060
1048
  * @param {string} verifierState Verifier state
1061
1049
  * @param {*} [options] Override http request option.
1062
1050
  * @throws {RequiredError}
1063
- * @memberof DefaultApi
1064
1051
  */
1065
1052
  onboardingStatus(verifierState, options) {
1066
1053
  return (0, exports.DefaultApiFp)(this.configuration).onboardingStatus(verifierState, options).then((request) => request(this.axios, this.basePath));
@@ -1070,7 +1057,6 @@ class DefaultApi extends base_1.BaseAPI {
1070
1057
  * @param {TlPayload} [tlPayload] Trust List create payload.
1071
1058
  * @param {*} [options] Override http request option.
1072
1059
  * @throws {RequiredError}
1073
- * @memberof DefaultApi
1074
1060
  */
1075
1061
  tlCreate(tlPayload, options) {
1076
1062
  return (0, exports.DefaultApiFp)(this.configuration).tlCreate(tlPayload, options).then((request) => request(this.axios, this.basePath));
@@ -1080,7 +1066,6 @@ class DefaultApi extends base_1.BaseAPI {
1080
1066
  * @param {string} tlId
1081
1067
  * @param {*} [options] Override http request option.
1082
1068
  * @throws {RequiredError}
1083
- * @memberof DefaultApi
1084
1069
  */
1085
1070
  tlGet(tlId, options) {
1086
1071
  return (0, exports.DefaultApiFp)(this.configuration).tlGet(tlId, options).then((request) => request(this.axios, this.basePath));
@@ -1090,7 +1075,6 @@ class DefaultApi extends base_1.BaseAPI {
1090
1075
  * @param {string} [ownerId]
1091
1076
  * @param {*} [options] Override http request option.
1092
1077
  * @throws {RequiredError}
1093
- * @memberof DefaultApi
1094
1078
  */
1095
1079
  tlList(ownerId, options) {
1096
1080
  return (0, exports.DefaultApiFp)(this.configuration).tlList(ownerId, options).then((request) => request(this.axios, this.basePath));
@@ -1101,7 +1085,6 @@ class DefaultApi extends base_1.BaseAPI {
1101
1085
  * @param {TlPayload} [tlPayload] Trust List create payload.
1102
1086
  * @param {*} [options] Override http request option.
1103
1087
  * @throws {RequiredError}
1104
- * @memberof DefaultApi
1105
1088
  */
1106
1089
  tlPatch(tlId, tlPayload, options) {
1107
1090
  return (0, exports.DefaultApiFp)(this.configuration).tlPatch(tlId, tlPayload, options).then((request) => request(this.axios, this.basePath));
@@ -1112,7 +1095,6 @@ class DefaultApi extends base_1.BaseAPI {
1112
1095
  * @param {string} tlrId Trust List Record Identifier
1113
1096
  * @param {*} [options] Override http request option.
1114
1097
  * @throws {RequiredError}
1115
- * @memberof DefaultApi
1116
1098
  */
1117
1099
  tlrGet(tlId, tlrId, options) {
1118
1100
  return (0, exports.DefaultApiFp)(this.configuration).tlrGet(tlId, tlrId, options).then((request) => request(this.axios, this.basePath));
@@ -1122,7 +1104,6 @@ class DefaultApi extends base_1.BaseAPI {
1122
1104
  * @param {string} orgName
1123
1105
  * @param {*} [options] Override http request option.
1124
1106
  * @throws {RequiredError}
1125
- * @memberof DefaultApi
1126
1107
  */
1127
1108
  tlrSearch(orgName, options) {
1128
1109
  return (0, exports.DefaultApiFp)(this.configuration).tlrSearch(orgName, options).then((request) => request(this.axios, this.basePath));
@@ -1133,7 +1114,6 @@ class DefaultApi extends base_1.BaseAPI {
1133
1114
  * @param {string} tlrId Trust List Record Identifier
1134
1115
  * @param {*} [options] Override http request option.
1135
1116
  * @throws {RequiredError}
1136
- * @memberof DefaultApi
1137
1117
  */
1138
1118
  tlrTrustChainGet(tlId, tlrId, options) {
1139
1119
  return (0, exports.DefaultApiFp)(this.configuration).tlrTrustChainGet(tlId, tlrId, options).then((request) => request(this.axios, this.basePath));
@@ -1143,7 +1123,6 @@ class DefaultApi extends base_1.BaseAPI {
1143
1123
  * @param {string} tlId
1144
1124
  * @param {*} [options] Override http request option.
1145
1125
  * @throws {RequiredError}
1146
- * @memberof DefaultApi
1147
1126
  */
1148
1127
  tlrsGet(tlId, options) {
1149
1128
  return (0, exports.DefaultApiFp)(this.configuration).tlrsGet(tlId, options).then((request) => request(this.axios, this.basePath));
@@ -1155,7 +1134,6 @@ class DefaultApi extends base_1.BaseAPI {
1155
1134
  * @param {string} id
1156
1135
  * @param {*} [options] Override http request option.
1157
1136
  * @throws {RequiredError}
1158
- * @memberof DefaultApi
1159
1137
  */
1160
1138
  vpGet(tlId, did, id, options) {
1161
1139
  return (0, exports.DefaultApiFp)(this.configuration).vpGet(tlId, did, id, options).then((request) => request(this.axios, this.basePath));
package/base.d.ts CHANGED
@@ -12,42 +12,22 @@
12
12
  import type { Configuration } from './configuration';
13
13
  import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
14
  export declare const BASE_PATH: string;
15
- /**
16
- *
17
- * @export
18
- */
19
15
  export declare const COLLECTION_FORMATS: {
20
16
  csv: string;
21
17
  ssv: string;
22
18
  tsv: string;
23
19
  pipes: string;
24
20
  };
25
- /**
26
- *
27
- * @export
28
- * @interface RequestArgs
29
- */
30
21
  export interface RequestArgs {
31
22
  url: string;
32
23
  options: RawAxiosRequestConfig;
33
24
  }
34
- /**
35
- *
36
- * @export
37
- * @class BaseAPI
38
- */
39
25
  export declare class BaseAPI {
40
26
  protected basePath: string;
41
27
  protected axios: AxiosInstance;
42
28
  protected configuration: Configuration | undefined;
43
29
  constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
44
30
  }
45
- /**
46
- *
47
- * @export
48
- * @class RequiredError
49
- * @extends {Error}
50
- */
51
31
  export declare class RequiredError extends Error {
52
32
  field: string;
53
33
  constructor(field: string, msg?: string);
@@ -58,9 +38,5 @@ interface ServerMap {
58
38
  description: string;
59
39
  }[];
60
40
  }
61
- /**
62
- *
63
- * @export
64
- */
65
41
  export declare const operationServerMap: ServerMap;
66
42
  export {};
package/base.js CHANGED
@@ -19,21 +19,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
19
19
  exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
20
20
  const axios_1 = __importDefault(require("axios"));
21
21
  exports.BASE_PATH = "/api/v1".replace(/\/+$/, "");
22
- /**
23
- *
24
- * @export
25
- */
26
22
  exports.COLLECTION_FORMATS = {
27
23
  csv: ",",
28
24
  ssv: " ",
29
25
  tsv: "\t",
30
26
  pipes: "|",
31
27
  };
32
- /**
33
- *
34
- * @export
35
- * @class BaseAPI
36
- */
37
28
  class BaseAPI {
38
29
  constructor(configuration, basePath = exports.BASE_PATH, axios = axios_1.default) {
39
30
  var _a;
@@ -47,12 +38,6 @@ class BaseAPI {
47
38
  }
48
39
  exports.BaseAPI = BaseAPI;
49
40
  ;
50
- /**
51
- *
52
- * @export
53
- * @class RequiredError
54
- * @extends {Error}
55
- */
56
41
  class RequiredError extends Error {
57
42
  constructor(field, msg) {
58
43
  super(msg);
@@ -61,8 +46,4 @@ class RequiredError extends Error {
61
46
  }
62
47
  }
63
48
  exports.RequiredError = RequiredError;
64
- /**
65
- *
66
- * @export
67
- */
68
49
  exports.operationServerMap = {};
package/common.d.ts CHANGED
@@ -12,54 +12,17 @@
12
12
  import type { Configuration } from "./configuration";
13
13
  import type { RequestArgs } from "./base";
14
14
  import type { AxiosInstance, AxiosResponse } from 'axios';
15
- /**
16
- *
17
- * @export
18
- */
19
15
  export declare const DUMMY_BASE_URL = "https://example.com";
20
16
  /**
21
17
  *
22
18
  * @throws {RequiredError}
23
- * @export
24
19
  */
25
20
  export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
26
- /**
27
- *
28
- * @export
29
- */
30
21
  export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
31
- /**
32
- *
33
- * @export
34
- */
35
22
  export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
36
- /**
37
- *
38
- * @export
39
- */
40
23
  export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
41
- /**
42
- *
43
- * @export
44
- */
45
24
  export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
46
- /**
47
- *
48
- * @export
49
- */
50
25
  export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
51
- /**
52
- *
53
- * @export
54
- */
55
26
  export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
56
- /**
57
- *
58
- * @export
59
- */
60
27
  export declare const toPathString: (url: URL) => string;
61
- /**
62
- *
63
- * @export
64
- */
65
28
  export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
package/common.js CHANGED
@@ -24,15 +24,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
24
24
  Object.defineProperty(exports, "__esModule", { value: true });
25
25
  exports.createRequestFunction = exports.toPathString = exports.serializeDataIfNeeded = exports.setSearchParams = exports.setOAuthToObject = exports.setBearerAuthToObject = exports.setBasicAuthToObject = exports.setApiKeyToObject = exports.assertParamExists = exports.DUMMY_BASE_URL = void 0;
26
26
  const base_1 = require("./base");
27
- /**
28
- *
29
- * @export
30
- */
31
27
  exports.DUMMY_BASE_URL = 'https://example.com';
32
28
  /**
33
29
  *
34
30
  * @throws {RequiredError}
35
- * @export
36
31
  */
37
32
  const assertParamExists = function (functionName, paramName, paramValue) {
38
33
  if (paramValue === null || paramValue === undefined) {
@@ -40,10 +35,6 @@ const assertParamExists = function (functionName, paramName, paramValue) {
40
35
  }
41
36
  };
42
37
  exports.assertParamExists = assertParamExists;
43
- /**
44
- *
45
- * @export
46
- */
47
38
  const setApiKeyToObject = function (object, keyParamName, configuration) {
48
39
  return __awaiter(this, void 0, void 0, function* () {
49
40
  if (configuration && configuration.apiKey) {
@@ -55,20 +46,12 @@ const setApiKeyToObject = function (object, keyParamName, configuration) {
55
46
  });
56
47
  };
57
48
  exports.setApiKeyToObject = setApiKeyToObject;
58
- /**
59
- *
60
- * @export
61
- */
62
49
  const setBasicAuthToObject = function (object, configuration) {
63
50
  if (configuration && (configuration.username || configuration.password)) {
64
51
  object["auth"] = { username: configuration.username, password: configuration.password };
65
52
  }
66
53
  };
67
54
  exports.setBasicAuthToObject = setBasicAuthToObject;
68
- /**
69
- *
70
- * @export
71
- */
72
55
  const setBearerAuthToObject = function (object, configuration) {
73
56
  return __awaiter(this, void 0, void 0, function* () {
74
57
  if (configuration && configuration.accessToken) {
@@ -80,10 +63,6 @@ const setBearerAuthToObject = function (object, configuration) {
80
63
  });
81
64
  };
82
65
  exports.setBearerAuthToObject = setBearerAuthToObject;
83
- /**
84
- *
85
- * @export
86
- */
87
66
  const setOAuthToObject = function (object, name, scopes, configuration) {
88
67
  return __awaiter(this, void 0, void 0, function* () {
89
68
  if (configuration && configuration.accessToken) {
@@ -115,20 +94,12 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
115
94
  }
116
95
  }
117
96
  }
118
- /**
119
- *
120
- * @export
121
- */
122
97
  const setSearchParams = function (url, ...objects) {
123
98
  const searchParams = new URLSearchParams(url.search);
124
99
  setFlattenedQueryParams(searchParams, objects);
125
100
  url.search = searchParams.toString();
126
101
  };
127
102
  exports.setSearchParams = setSearchParams;
128
- /**
129
- *
130
- * @export
131
- */
132
103
  const serializeDataIfNeeded = function (value, requestOptions, configuration) {
133
104
  const nonString = typeof value !== 'string';
134
105
  const needsSerialization = nonString && configuration && configuration.isJsonMime
@@ -139,18 +110,10 @@ const serializeDataIfNeeded = function (value, requestOptions, configuration) {
139
110
  : (value || "");
140
111
  };
141
112
  exports.serializeDataIfNeeded = serializeDataIfNeeded;
142
- /**
143
- *
144
- * @export
145
- */
146
113
  const toPathString = function (url) {
147
114
  return url.pathname + url.search + url.hash;
148
115
  };
149
116
  exports.toPathString = toPathString;
150
- /**
151
- *
152
- * @export
153
- */
154
117
  const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
155
118
  return (axios = globalAxios, basePath = BASE_PATH) => {
156
119
  var _a;
@@ -23,49 +23,32 @@ export declare class Configuration {
23
23
  /**
24
24
  * parameter for apiKey security
25
25
  * @param name security name
26
- * @memberof Configuration
27
26
  */
28
27
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
29
28
  /**
30
29
  * parameter for basic security
31
- *
32
- * @type {string}
33
- * @memberof Configuration
34
30
  */
35
31
  username?: string;
36
32
  /**
37
33
  * parameter for basic security
38
- *
39
- * @type {string}
40
- * @memberof Configuration
41
34
  */
42
35
  password?: string;
43
36
  /**
44
37
  * parameter for oauth2 security
45
38
  * @param name security name
46
39
  * @param scopes oauth2 scope
47
- * @memberof Configuration
48
40
  */
49
41
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
50
42
  /**
51
43
  * override base path
52
- *
53
- * @type {string}
54
- * @memberof Configuration
55
44
  */
56
45
  basePath?: string;
57
46
  /**
58
47
  * override server index
59
- *
60
- * @type {number}
61
- * @memberof Configuration
62
48
  */
63
49
  serverIndex?: number;
64
50
  /**
65
51
  * base options for axios calls
66
- *
67
- * @type {any}
68
- * @memberof Configuration
69
52
  */
70
53
  baseOptions?: any;
71
54
  /**
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@idunion/tl-sdk",
3
3
  "private": false,
4
- "version": "0.0.29",
4
+ "version": "0.0.30",
5
5
  "description": "",
6
6
  "main": "index.js",
7
7
  "scripts": {