humanos 1.0.2 → 1.0.3
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/README.md +310 -114
- package/dist/index.d.mts +3558 -1753
- package/dist/index.d.ts +3558 -1753
- package/dist/index.js +1621 -499
- package/dist/index.mjs +1578 -478
- package/generated/.openapi-generator/FILES +59 -33
- package/generated/api/actions-api.ts +273 -0
- package/generated/api/activity-api.ts +225 -0
- package/generated/api/{resource-api.ts → approval-api.ts} +65 -61
- package/generated/api/credentials-api.ts +365 -25
- package/generated/api/didapi.ts +138 -0
- package/generated/api/requests-api.ts +124 -134
- package/generated/api/user-api.ts +45 -36
- package/generated/api/webhooks-api.ts +84 -56
- package/generated/api.ts +5 -1
- package/generated/models/action-dto.ts +36 -0
- package/generated/models/action-entity.ts +57 -0
- package/generated/models/action-list-entity.ts +39 -0
- package/generated/models/action-query.ts +48 -0
- package/generated/models/action-ref-dto.ts +36 -0
- package/generated/models/action-version-detail-entity.ts +72 -0
- package/generated/models/action-version-list-entity.ts +39 -0
- package/generated/models/action-version-summary-entity.ts +48 -0
- package/generated/models/activities-entity.ts +39 -0
- package/generated/models/activity-entity.ts +90 -0
- package/generated/models/activity-query.ts +96 -0
- package/generated/models/consent.ts +36 -0
- package/generated/models/constraints-dto.ts +36 -0
- package/generated/models/{agent-detail-entity.ts → contact-entity.ts} +8 -8
- package/generated/models/create-presentation-dto.ts +30 -0
- package/generated/models/create-presentation400-response.ts +42 -0
- package/generated/models/create-presentation403-response.ts +42 -0
- package/generated/models/create-presentation404-response.ts +42 -0
- package/generated/models/create-subject-dto.ts +10 -4
- package/generated/models/create-subject-entity.ts +4 -4
- package/generated/models/{cancel-request404-response.ts → create400-response.ts} +5 -5
- package/generated/models/credential-dto-data-inner.ts +26 -0
- package/generated/models/credential-dto.ts +52 -6
- package/generated/models/credential-entity.ts +33 -7
- package/generated/models/{credential-subject.ts → credential-event-decision.ts} +13 -11
- package/generated/models/credential-event-user.ts +1 -1
- package/generated/models/credential-event.ts +15 -19
- package/generated/models/credential-placement-dto.ts +85 -0
- package/generated/models/credential-status.ts +5 -3
- package/generated/models/credentials-detail404-response.ts +42 -0
- package/generated/models/credentials-evidence404-response.ts +42 -0
- package/generated/models/credentials-issue-vp400-response.ts +42 -0
- package/generated/models/credentials-issue-vp403-response.ts +42 -0
- package/generated/models/credentials-issue-vp404-response.ts +42 -0
- package/generated/models/credentials-revoke400-response.ts +42 -0
- package/generated/models/credentials-revoke409-response.ts +42 -0
- package/generated/models/did-document-entity.ts +63 -0
- package/generated/models/evidence.ts +44 -0
- package/generated/models/generate-credential-entity.ts +2 -2
- package/generated/models/generate-request-dto.ts +18 -15
- package/generated/models/generate-request-entity.ts +6 -6
- package/generated/models/generate-subject-entity.ts +3 -3
- package/generated/models/get-evidence404-response.ts +42 -0
- package/generated/models/group-entity.ts +3 -3
- package/generated/models/groups-entity.ts +1 -1
- package/generated/models/identity-dto.ts +27 -27
- package/generated/models/identity-event-decision.ts +13 -1
- package/generated/models/{create-subject-user-entity.ts → identity-event-user.ts} +12 -12
- package/generated/models/identity-event.ts +14 -18
- package/generated/models/{identity-event-identity.ts → identity-payload.ts} +12 -12
- package/generated/models/index.ts +55 -32
- package/generated/models/{action-type.ts → json-value.ts} +6 -12
- package/generated/models/{mandate-data-dto-value.ts → organization-data-entity.ts} +9 -3
- package/generated/models/{issuer-detail-entity.ts → otp-error.ts} +8 -8
- package/generated/models/otp-failed-event-otp.ts +3 -3
- package/generated/models/otp-failed-event.ts +11 -15
- package/generated/models/partial-subject-entity.ts +42 -0
- package/generated/models/presentation-receipt-entity.ts +42 -0
- package/generated/models/presentation-response-entity.ts +39 -0
- package/generated/models/receipt-entity.ts +36 -0
- package/generated/models/request-credential-entity.ts +72 -0
- package/generated/models/request-detail-entity.ts +26 -20
- package/generated/models/request-detail-subject-entity.ts +87 -0
- package/generated/models/request-entity.ts +14 -8
- package/generated/models/request-query.ts +3 -21
- package/generated/models/request-subject-entity.ts +21 -6
- package/generated/models/requests-create400-response.ts +42 -0
- package/generated/models/requests-detail404-response.ts +42 -0
- package/generated/models/requests-entity.ts +1 -1
- package/generated/models/requests-resend-otp403-response.ts +42 -0
- package/generated/models/resend-otp403-response.ts +42 -0
- package/generated/models/resource-entity.ts +11 -3
- package/generated/models/{group-resource-entity.ts → resource-minimal-entity.ts} +13 -11
- package/generated/models/resource-query.ts +3 -1
- package/generated/models/resources-entity.ts +1 -1
- package/generated/models/revoke-credential-dto.ts +30 -0
- package/generated/models/revoke-credential-entity.ts +63 -0
- package/generated/models/revoke-credential400-response.ts +42 -0
- package/generated/models/revoke-credential409-response.ts +42 -0
- package/generated/models/revoke-receipt-entity.ts +42 -0
- package/generated/models/schema-entity.ts +57 -0
- package/generated/models/schema-list-entity.ts +39 -0
- package/generated/models/schema-query.ts +48 -0
- package/generated/models/schema-response-entity.ts +45 -0
- package/generated/models/schema-version-detail-entity.ts +72 -0
- package/generated/models/schema-version-list-entity.ts +39 -0
- package/generated/models/schema-version-response-entity.ts +54 -0
- package/generated/models/schema-version-summary-entity.ts +48 -0
- package/generated/models/subject-contact-entity.ts +7 -7
- package/generated/models/subject-issuer-entity.ts +69 -0
- package/generated/models/subject-query.ts +4 -4
- package/generated/models/test-event.ts +11 -15
- package/generated/models/user-create400-response.ts +42 -0
- package/generated/models/user-detail400-response.ts +42 -0
- package/generated/models/user-detail404-response.ts +42 -0
- package/generated/models/verification-method-entity.ts +48 -0
- package/generated/models/verify-allow-response-entity.ts +61 -0
- package/generated/models/verify-deny-response-entity.ts +79 -0
- package/generated/models/verify-evaluation-entity.ts +51 -0
- package/generated/models/verify-presentation-dto.ts +36 -0
- package/generated/models/verify-receipt-entity.ts +42 -0
- package/generated/models/w3-cverifiable-credential-credential-subject-mandate-action.ts +44 -0
- package/generated/models/w3-cverifiable-credential-credential-subject-mandate-constraint-constraint-schema.ts +44 -0
- package/generated/models/w3-cverifiable-credential-credential-subject-mandate-constraint.ts +41 -0
- package/generated/models/w3-cverifiable-credential-credential-subject-mandate-context.ts +32 -0
- package/generated/models/{mandate-data-type.ts → w3-cverifiable-credential-credential-subject-mandate-grantor.ts} +3 -16
- package/generated/models/w3-cverifiable-credential-credential-subject-mandate.ts +65 -0
- package/generated/models/w3-cverifiable-credential-credential-subject.ts +41 -0
- package/generated/models/w3-cverifiable-credential-evidences-inner.ts +42 -0
- package/generated/models/w3-cverifiable-credential-proofs-inner.ts +62 -0
- package/generated/models/w3-cverifiable-credential-valid-from.ts +24 -0
- package/generated/models/w3-cverifiable-credential-valid-until.ts +24 -0
- package/generated/models/w3-cverifiable-credential.ts +24 -25
- package/generated/models/webhook-call-event.ts +6 -12
- package/package.json +1 -1
- package/generated/models/credential-full-entity.ts +0 -82
- package/generated/models/get-credential-entity.ts +0 -48
- package/generated/models/identity-field-placement.ts +0 -73
- package/generated/models/identity-field-type.ts +0 -38
- package/generated/models/mandate-data-dto-type.ts +0 -73
- package/generated/models/mandate-data-dto.ts +0 -71
- package/generated/models/signature-placement-item-dto.ts +0 -72
- package/generated/models/signature-placement.ts +0 -56
- package/generated/models/subject-entity.ts +0 -48
- package/generated/models/w3-cproof.ts +0 -82
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Humanos API
|
|
5
|
+
* Humanos API
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
*
|
|
19
|
+
* @export
|
|
20
|
+
* @interface CreatePresentation400Response
|
|
21
|
+
*/
|
|
22
|
+
export interface CreatePresentation400Response {
|
|
23
|
+
/**
|
|
24
|
+
*
|
|
25
|
+
* @type {number}
|
|
26
|
+
* @memberof CreatePresentation400Response
|
|
27
|
+
*/
|
|
28
|
+
'statusCode'?: number;
|
|
29
|
+
/**
|
|
30
|
+
*
|
|
31
|
+
* @type {string}
|
|
32
|
+
* @memberof CreatePresentation400Response
|
|
33
|
+
*/
|
|
34
|
+
'message'?: string;
|
|
35
|
+
/**
|
|
36
|
+
*
|
|
37
|
+
* @type {string}
|
|
38
|
+
* @memberof CreatePresentation400Response
|
|
39
|
+
*/
|
|
40
|
+
'error'?: string;
|
|
41
|
+
}
|
|
42
|
+
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Humanos API
|
|
5
|
+
* Humanos API
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
*
|
|
19
|
+
* @export
|
|
20
|
+
* @interface CreatePresentation403Response
|
|
21
|
+
*/
|
|
22
|
+
export interface CreatePresentation403Response {
|
|
23
|
+
/**
|
|
24
|
+
*
|
|
25
|
+
* @type {number}
|
|
26
|
+
* @memberof CreatePresentation403Response
|
|
27
|
+
*/
|
|
28
|
+
'statusCode'?: number;
|
|
29
|
+
/**
|
|
30
|
+
*
|
|
31
|
+
* @type {string}
|
|
32
|
+
* @memberof CreatePresentation403Response
|
|
33
|
+
*/
|
|
34
|
+
'message'?: string;
|
|
35
|
+
/**
|
|
36
|
+
*
|
|
37
|
+
* @type {string}
|
|
38
|
+
* @memberof CreatePresentation403Response
|
|
39
|
+
*/
|
|
40
|
+
'error'?: string;
|
|
41
|
+
}
|
|
42
|
+
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Humanos API
|
|
5
|
+
* Humanos API
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
*
|
|
19
|
+
* @export
|
|
20
|
+
* @interface CreatePresentation404Response
|
|
21
|
+
*/
|
|
22
|
+
export interface CreatePresentation404Response {
|
|
23
|
+
/**
|
|
24
|
+
*
|
|
25
|
+
* @type {number}
|
|
26
|
+
* @memberof CreatePresentation404Response
|
|
27
|
+
*/
|
|
28
|
+
'statusCode'?: number;
|
|
29
|
+
/**
|
|
30
|
+
*
|
|
31
|
+
* @type {string}
|
|
32
|
+
* @memberof CreatePresentation404Response
|
|
33
|
+
*/
|
|
34
|
+
'message'?: string;
|
|
35
|
+
/**
|
|
36
|
+
*
|
|
37
|
+
* @type {string}
|
|
38
|
+
* @memberof CreatePresentation404Response
|
|
39
|
+
*/
|
|
40
|
+
'error'?: string;
|
|
41
|
+
}
|
|
42
|
+
|
|
@@ -24,11 +24,11 @@ import type { IdentityDto } from './identity-dto';
|
|
|
24
24
|
*/
|
|
25
25
|
export interface CreateSubjectDto {
|
|
26
26
|
/**
|
|
27
|
-
*
|
|
28
|
-
* @type {
|
|
27
|
+
* The verified contact (email or phone number) that identifies this subject. This becomes a Contact row with a DID — Humanos can OTP it, route webhooks to it, and use it to participate in credential signing flows. See `extraContacts` for non-verified per-issuer metadata strings.
|
|
28
|
+
* @type {string}
|
|
29
29
|
* @memberof CreateSubjectDto
|
|
30
30
|
*/
|
|
31
|
-
'
|
|
31
|
+
'contact': string;
|
|
32
32
|
/**
|
|
33
33
|
* Identifier to help you identify the user in your own system. We recommend using a unique value.
|
|
34
34
|
* @type {string}
|
|
@@ -36,7 +36,13 @@ export interface CreateSubjectDto {
|
|
|
36
36
|
*/
|
|
37
37
|
'internalId'?: string;
|
|
38
38
|
/**
|
|
39
|
-
*
|
|
39
|
+
* Array of contact emails or phone numbers. Any update will fully replace the existing extra contacts. This contacts only live within your organization, therefore are not verified by Humanos. You will not be able to use it to contact the user.
|
|
40
|
+
* @type {Array<string>}
|
|
41
|
+
* @memberof CreateSubjectDto
|
|
42
|
+
*/
|
|
43
|
+
'extraContacts'?: Array<string>;
|
|
44
|
+
/**
|
|
45
|
+
* Identity information to be assigned to the user Only mandatory fields are {fullName, birth, docId, countryAlpha3}. Any extra field can be provided for visualization Any update will fully replace the existing identity. This identity only lives within your organization, therefore is not verified by Humanos.
|
|
40
46
|
* @type {IdentityDto}
|
|
41
47
|
* @memberof CreateSubjectDto
|
|
42
48
|
*/
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
|
|
16
16
|
// May contain unused imports in some cases
|
|
17
17
|
// @ts-ignore
|
|
18
|
-
import type {
|
|
18
|
+
import type { PartialSubjectEntity } from './partial-subject-entity';
|
|
19
19
|
|
|
20
20
|
/**
|
|
21
21
|
*
|
|
@@ -36,11 +36,11 @@ export interface CreateSubjectEntity {
|
|
|
36
36
|
*/
|
|
37
37
|
'message': string;
|
|
38
38
|
/**
|
|
39
|
-
* User information. Will just contain the
|
|
40
|
-
* @type {
|
|
39
|
+
* User information. Will just contain the contact if the operation fails
|
|
40
|
+
* @type {PartialSubjectEntity}
|
|
41
41
|
* @memberof CreateSubjectEntity
|
|
42
42
|
*/
|
|
43
|
-
'user':
|
|
43
|
+
'user': PartialSubjectEntity;
|
|
44
44
|
}
|
|
45
45
|
|
|
46
46
|
export const CreateSubjectEntityStatusEnum = {
|
|
@@ -17,25 +17,25 @@
|
|
|
17
17
|
/**
|
|
18
18
|
*
|
|
19
19
|
* @export
|
|
20
|
-
* @interface
|
|
20
|
+
* @interface Create400Response
|
|
21
21
|
*/
|
|
22
|
-
export interface
|
|
22
|
+
export interface Create400Response {
|
|
23
23
|
/**
|
|
24
24
|
*
|
|
25
25
|
* @type {number}
|
|
26
|
-
* @memberof
|
|
26
|
+
* @memberof Create400Response
|
|
27
27
|
*/
|
|
28
28
|
'statusCode'?: number;
|
|
29
29
|
/**
|
|
30
30
|
*
|
|
31
31
|
* @type {string}
|
|
32
|
-
* @memberof
|
|
32
|
+
* @memberof Create400Response
|
|
33
33
|
*/
|
|
34
34
|
'message'?: string;
|
|
35
35
|
/**
|
|
36
36
|
*
|
|
37
37
|
* @type {string}
|
|
38
|
-
* @memberof
|
|
38
|
+
* @memberof Create400Response
|
|
39
39
|
*/
|
|
40
40
|
'error'?: string;
|
|
41
41
|
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Humanos API
|
|
5
|
+
* Humanos API
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
// May contain unused imports in some cases
|
|
17
|
+
// @ts-ignore
|
|
18
|
+
import type { CONSENT } from './consent';
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
* @type CredentialDtoDataInner
|
|
22
|
+
* @export
|
|
23
|
+
*/
|
|
24
|
+
export type CredentialDtoDataInner = CONSENT | string;
|
|
25
|
+
|
|
26
|
+
|
|
@@ -15,7 +15,13 @@
|
|
|
15
15
|
|
|
16
16
|
// May contain unused imports in some cases
|
|
17
17
|
// @ts-ignore
|
|
18
|
-
import type {
|
|
18
|
+
import type { ActionDto } from './action-dto';
|
|
19
|
+
// May contain unused imports in some cases
|
|
20
|
+
// @ts-ignore
|
|
21
|
+
import type { CredentialDtoDataInner } from './credential-dto-data-inner';
|
|
22
|
+
// May contain unused imports in some cases
|
|
23
|
+
// @ts-ignore
|
|
24
|
+
import type { CredentialPlacementDto } from './credential-placement-dto';
|
|
19
25
|
|
|
20
26
|
/**
|
|
21
27
|
*
|
|
@@ -28,19 +34,37 @@ export interface CredentialDto {
|
|
|
28
34
|
* @type {string}
|
|
29
35
|
* @memberof CredentialDto
|
|
30
36
|
*/
|
|
31
|
-
'scope'
|
|
37
|
+
'scope'?: string;
|
|
32
38
|
/**
|
|
33
|
-
* The
|
|
39
|
+
* The date from which the credential becomes valid. Must be now or later. Defaults to now if omitted.
|
|
34
40
|
* @type {string}
|
|
35
41
|
* @memberof CredentialDto
|
|
36
42
|
*/
|
|
37
|
-
'
|
|
43
|
+
'validFrom'?: string;
|
|
44
|
+
/**
|
|
45
|
+
* The expiration date for the credential
|
|
46
|
+
* @type {string}
|
|
47
|
+
* @memberof CredentialDto
|
|
48
|
+
*/
|
|
49
|
+
'validUntil'?: string;
|
|
50
|
+
/**
|
|
51
|
+
* The type of the credential, can help categorize credentials. General methods should use the type JSON - Type JSON is recommended for general use. - Type DOCUMENT should include the following unhidden fields: { label: \"display name\", type: \"pdf\" } - Type CONSENT should include the following unhidden fields: { label: \"display name\", type: \"url\" }, { label: \"text\", type: \"string\" } - Type POLICY is for action-bound credentials. Provide an \'action\' (actionUrn + userParams) and omit \'data\'.
|
|
52
|
+
* @type {string}
|
|
53
|
+
* @memberof CredentialDto
|
|
54
|
+
*/
|
|
55
|
+
'type': CredentialDtoTypeEnum;
|
|
38
56
|
/**
|
|
39
57
|
* Name of the credential
|
|
40
58
|
* @type {string}
|
|
41
59
|
* @memberof CredentialDto
|
|
42
60
|
*/
|
|
43
61
|
'name': string;
|
|
62
|
+
/**
|
|
63
|
+
* Optional description for the credential
|
|
64
|
+
* @type {string}
|
|
65
|
+
* @memberof CredentialDto
|
|
66
|
+
*/
|
|
67
|
+
'description'?: string;
|
|
44
68
|
/**
|
|
45
69
|
* Identifier to help you identify the credential in your own system. We recommend using a unique value.
|
|
46
70
|
* @type {string}
|
|
@@ -49,9 +73,31 @@ export interface CredentialDto {
|
|
|
49
73
|
'internalId'?: string;
|
|
50
74
|
/**
|
|
51
75
|
* Data associated with the credential
|
|
52
|
-
* @type {Array<
|
|
76
|
+
* @type {Array<CredentialDtoDataInner>}
|
|
77
|
+
* @memberof CredentialDto
|
|
78
|
+
*/
|
|
79
|
+
'data'?: Array<CredentialDtoDataInner>;
|
|
80
|
+
/**
|
|
81
|
+
* Predefined signature placements for document credentials
|
|
82
|
+
* @type {Array<CredentialPlacementDto>}
|
|
53
83
|
* @memberof CredentialDto
|
|
54
84
|
*/
|
|
55
|
-
'
|
|
85
|
+
'placements'?: Array<CredentialPlacementDto>;
|
|
86
|
+
/**
|
|
87
|
+
* Reference to the action (and its userParams) bound to this credential
|
|
88
|
+
* @type {ActionDto}
|
|
89
|
+
* @memberof CredentialDto
|
|
90
|
+
*/
|
|
91
|
+
'action'?: ActionDto;
|
|
56
92
|
}
|
|
57
93
|
|
|
94
|
+
export const CredentialDtoTypeEnum = {
|
|
95
|
+
Document: 'DOCUMENT',
|
|
96
|
+
Consent: 'CONSENT',
|
|
97
|
+
Json: 'JSON',
|
|
98
|
+
Policy: 'POLICY'
|
|
99
|
+
} as const;
|
|
100
|
+
|
|
101
|
+
export type CredentialDtoTypeEnum = typeof CredentialDtoTypeEnum[keyof typeof CredentialDtoTypeEnum];
|
|
102
|
+
|
|
103
|
+
|
|
@@ -21,17 +21,23 @@
|
|
|
21
21
|
*/
|
|
22
22
|
export interface CredentialEntity {
|
|
23
23
|
/**
|
|
24
|
-
*
|
|
24
|
+
*
|
|
25
25
|
* @type {string}
|
|
26
26
|
* @memberof CredentialEntity
|
|
27
27
|
*/
|
|
28
28
|
'id': string;
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
*
|
|
31
31
|
* @type {string}
|
|
32
32
|
* @memberof CredentialEntity
|
|
33
33
|
*/
|
|
34
34
|
'name'?: string;
|
|
35
|
+
/**
|
|
36
|
+
*
|
|
37
|
+
* @type {string}
|
|
38
|
+
* @memberof CredentialEntity
|
|
39
|
+
*/
|
|
40
|
+
'description'?: string;
|
|
35
41
|
/**
|
|
36
42
|
* Identifier to help you identify the credential in your own system. We recommend using a unique value.
|
|
37
43
|
* @type {string}
|
|
@@ -39,24 +45,44 @@ export interface CredentialEntity {
|
|
|
39
45
|
*/
|
|
40
46
|
'internalId'?: string;
|
|
41
47
|
/**
|
|
42
|
-
*
|
|
48
|
+
* The type of resource for this credential (e.g., DOCUMENT, CONSENT, FORM)
|
|
43
49
|
* @type {string}
|
|
44
50
|
* @memberof CredentialEntity
|
|
45
51
|
*/
|
|
46
52
|
'resourceType': string;
|
|
47
53
|
/**
|
|
48
|
-
*
|
|
54
|
+
* The status of the credential
|
|
49
55
|
* @type {string}
|
|
50
56
|
* @memberof CredentialEntity
|
|
51
57
|
*/
|
|
52
58
|
'status': CredentialEntityStatusEnum;
|
|
59
|
+
/**
|
|
60
|
+
*
|
|
61
|
+
* @type {Array<string>}
|
|
62
|
+
* @memberof CredentialEntity
|
|
63
|
+
*/
|
|
64
|
+
'tags'?: Array<string>;
|
|
65
|
+
/**
|
|
66
|
+
* The W3C Verifiable Credential following the VIA protocol specification. While the credential is in DRAFT status, this object is in building mode: evidences, proofs, and other fields may still be attached or modified as grantors review and decide. The `proofs` array will be empty at this stage. Once all grantors have accepted (or the request window expires), the status transitions out of DRAFT and cryptographic signature proofs are attached. At that point the credential is fully sealed and can be passed for verification as defined by the VIA protocol.
|
|
67
|
+
* @type {object}
|
|
68
|
+
* @memberof CredentialEntity
|
|
69
|
+
*/
|
|
70
|
+
'w3cCredential': object;
|
|
71
|
+
/**
|
|
72
|
+
* Whether each grantor accepted or rejected the credential and information about the grantor contact. The `id` field carries the decision URN.
|
|
73
|
+
* @type {Array<Array<any>>}
|
|
74
|
+
* @memberof CredentialEntity
|
|
75
|
+
*/
|
|
76
|
+
'decisions'?: Array<Array<any>>;
|
|
53
77
|
}
|
|
54
78
|
|
|
55
79
|
export const CredentialEntityStatusEnum = {
|
|
56
|
-
|
|
57
|
-
|
|
80
|
+
Draft: 'DRAFT',
|
|
81
|
+
Active: 'ACTIVE',
|
|
58
82
|
Rejected: 'REJECTED',
|
|
59
|
-
|
|
83
|
+
Canceled: 'CANCELED',
|
|
84
|
+
Revoked: 'REVOKED',
|
|
85
|
+
Expired: 'EXPIRED'
|
|
60
86
|
} as const;
|
|
61
87
|
|
|
62
88
|
export type CredentialEntityStatusEnum = typeof CredentialEntityStatusEnum[keyof typeof CredentialEntityStatusEnum];
|
|
@@ -15,25 +15,27 @@
|
|
|
15
15
|
|
|
16
16
|
// May contain unused imports in some cases
|
|
17
17
|
// @ts-ignore
|
|
18
|
-
import type {
|
|
18
|
+
import type { DeliveryActionType } from './delivery-action-type';
|
|
19
19
|
|
|
20
20
|
/**
|
|
21
21
|
*
|
|
22
22
|
* @export
|
|
23
|
-
* @interface
|
|
23
|
+
* @interface CredentialEventDecision
|
|
24
24
|
*/
|
|
25
|
-
export interface
|
|
25
|
+
export interface CredentialEventDecision {
|
|
26
26
|
/**
|
|
27
|
-
*
|
|
28
|
-
* @type {
|
|
29
|
-
* @memberof
|
|
27
|
+
*
|
|
28
|
+
* @type {DeliveryActionType}
|
|
29
|
+
* @memberof CredentialEventDecision
|
|
30
30
|
*/
|
|
31
|
-
'
|
|
31
|
+
'action': DeliveryActionType;
|
|
32
32
|
/**
|
|
33
|
-
*
|
|
34
|
-
* @type {
|
|
35
|
-
* @memberof
|
|
33
|
+
*
|
|
34
|
+
* @type {string}
|
|
35
|
+
* @memberof CredentialEventDecision
|
|
36
36
|
*/
|
|
37
|
-
'
|
|
37
|
+
'date': string;
|
|
38
38
|
}
|
|
39
39
|
|
|
40
|
+
|
|
41
|
+
|
|
@@ -15,16 +15,13 @@
|
|
|
15
15
|
|
|
16
16
|
// May contain unused imports in some cases
|
|
17
17
|
// @ts-ignore
|
|
18
|
-
import type {
|
|
19
|
-
// May contain unused imports in some cases
|
|
20
|
-
// @ts-ignore
|
|
21
|
-
import type { CredentialFullEntity } from './credential-full-entity';
|
|
18
|
+
import type { CredentialEntity } from './credential-entity';
|
|
22
19
|
// May contain unused imports in some cases
|
|
23
20
|
// @ts-ignore
|
|
24
|
-
import type {
|
|
21
|
+
import type { CredentialEventDecision } from './credential-event-decision';
|
|
25
22
|
// May contain unused imports in some cases
|
|
26
23
|
// @ts-ignore
|
|
27
|
-
import type {
|
|
24
|
+
import type { CredentialEventUser } from './credential-event-user';
|
|
28
25
|
|
|
29
26
|
/**
|
|
30
27
|
*
|
|
@@ -36,10 +33,10 @@ export interface CredentialEvent {
|
|
|
36
33
|
|
|
37
34
|
/**
|
|
38
35
|
*
|
|
39
|
-
* @type {
|
|
36
|
+
* @type {string}
|
|
40
37
|
* @memberof CredentialEvent
|
|
41
38
|
*/
|
|
42
|
-
'eventType':
|
|
39
|
+
'eventType': CredentialEventEventTypeEnum;
|
|
43
40
|
/**
|
|
44
41
|
*
|
|
45
42
|
* @type {string}
|
|
@@ -69,26 +66,25 @@ export interface CredentialEvent {
|
|
|
69
66
|
* @type {string}
|
|
70
67
|
* @memberof CredentialEvent
|
|
71
68
|
*/
|
|
72
|
-
'
|
|
69
|
+
'api_version': string;
|
|
73
70
|
/**
|
|
74
71
|
*
|
|
75
|
-
* @type {
|
|
72
|
+
* @type {CredentialEntity}
|
|
76
73
|
* @memberof CredentialEvent
|
|
77
74
|
*/
|
|
78
|
-
'
|
|
75
|
+
'credential': CredentialEntity;
|
|
79
76
|
/**
|
|
80
77
|
*
|
|
81
|
-
* @type {
|
|
78
|
+
* @type {CredentialEventDecision}
|
|
82
79
|
* @memberof CredentialEvent
|
|
83
80
|
*/
|
|
84
|
-
'
|
|
85
|
-
/**
|
|
86
|
-
*
|
|
87
|
-
* @type {CredentialFullEntity}
|
|
88
|
-
* @memberof CredentialEvent
|
|
89
|
-
*/
|
|
90
|
-
'credential': CredentialFullEntity;
|
|
81
|
+
'decision': CredentialEventDecision;
|
|
91
82
|
}
|
|
92
83
|
|
|
84
|
+
export const CredentialEventEventTypeEnum = {
|
|
85
|
+
Credential: 'credential'
|
|
86
|
+
} as const;
|
|
87
|
+
|
|
88
|
+
export type CredentialEventEventTypeEnum = typeof CredentialEventEventTypeEnum[keyof typeof CredentialEventEventTypeEnum];
|
|
93
89
|
|
|
94
90
|
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Humanos API
|
|
5
|
+
* Humanos API
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
*
|
|
19
|
+
* @export
|
|
20
|
+
* @interface CredentialPlacementDto
|
|
21
|
+
*/
|
|
22
|
+
export interface CredentialPlacementDto {
|
|
23
|
+
/**
|
|
24
|
+
* Contact email or phone matching contacts[]
|
|
25
|
+
* @type {string}
|
|
26
|
+
* @memberof CredentialPlacementDto
|
|
27
|
+
*/
|
|
28
|
+
'contact': string;
|
|
29
|
+
/**
|
|
30
|
+
* Placement type
|
|
31
|
+
* @type {string}
|
|
32
|
+
* @memberof CredentialPlacementDto
|
|
33
|
+
*/
|
|
34
|
+
'type': CredentialPlacementDtoTypeEnum;
|
|
35
|
+
/**
|
|
36
|
+
* Identity field type (for IDENTITY_FIELD type)
|
|
37
|
+
* @type {object}
|
|
38
|
+
* @memberof CredentialPlacementDto
|
|
39
|
+
*/
|
|
40
|
+
'identityType'?: object;
|
|
41
|
+
/**
|
|
42
|
+
* X position (0-100%)
|
|
43
|
+
* @type {number}
|
|
44
|
+
* @memberof CredentialPlacementDto
|
|
45
|
+
*/
|
|
46
|
+
'x': number;
|
|
47
|
+
/**
|
|
48
|
+
* Y position (0-100%)
|
|
49
|
+
* @type {number}
|
|
50
|
+
* @memberof CredentialPlacementDto
|
|
51
|
+
*/
|
|
52
|
+
'y': number;
|
|
53
|
+
/**
|
|
54
|
+
* Width (0-100%)
|
|
55
|
+
* @type {number}
|
|
56
|
+
* @memberof CredentialPlacementDto
|
|
57
|
+
*/
|
|
58
|
+
'width': number;
|
|
59
|
+
/**
|
|
60
|
+
* Height (0-100%)
|
|
61
|
+
* @type {number}
|
|
62
|
+
* @memberof CredentialPlacementDto
|
|
63
|
+
*/
|
|
64
|
+
'height': number;
|
|
65
|
+
/**
|
|
66
|
+
* 0-based page index
|
|
67
|
+
* @type {number}
|
|
68
|
+
* @memberof CredentialPlacementDto
|
|
69
|
+
*/
|
|
70
|
+
'pageIndex': number;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export const CredentialPlacementDtoTypeEnum = {
|
|
74
|
+
Signature: 'SIGNATURE',
|
|
75
|
+
Initials: 'INITIALS',
|
|
76
|
+
IdentityField: 'IDENTITY_FIELD',
|
|
77
|
+
OpenText: 'OPEN_TEXT',
|
|
78
|
+
Numeric: 'NUMERIC',
|
|
79
|
+
Date: 'DATE',
|
|
80
|
+
Checkbox: 'CHECKBOX'
|
|
81
|
+
} as const;
|
|
82
|
+
|
|
83
|
+
export type CredentialPlacementDtoTypeEnum = typeof CredentialPlacementDtoTypeEnum[keyof typeof CredentialPlacementDtoTypeEnum];
|
|
84
|
+
|
|
85
|
+
|
|
@@ -21,10 +21,12 @@
|
|
|
21
21
|
*/
|
|
22
22
|
|
|
23
23
|
export const CredentialStatus = {
|
|
24
|
-
|
|
25
|
-
|
|
24
|
+
Draft: 'DRAFT',
|
|
25
|
+
Active: 'ACTIVE',
|
|
26
26
|
Rejected: 'REJECTED',
|
|
27
|
-
|
|
27
|
+
Canceled: 'CANCELED',
|
|
28
|
+
Revoked: 'REVOKED',
|
|
29
|
+
Expired: 'EXPIRED'
|
|
28
30
|
} as const;
|
|
29
31
|
|
|
30
32
|
export type CredentialStatus = typeof CredentialStatus[keyof typeof CredentialStatus];
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Humanos API
|
|
5
|
+
* Humanos API
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
*
|
|
19
|
+
* @export
|
|
20
|
+
* @interface CredentialsDetail404Response
|
|
21
|
+
*/
|
|
22
|
+
export interface CredentialsDetail404Response {
|
|
23
|
+
/**
|
|
24
|
+
*
|
|
25
|
+
* @type {number}
|
|
26
|
+
* @memberof CredentialsDetail404Response
|
|
27
|
+
*/
|
|
28
|
+
'statusCode'?: number;
|
|
29
|
+
/**
|
|
30
|
+
*
|
|
31
|
+
* @type {string}
|
|
32
|
+
* @memberof CredentialsDetail404Response
|
|
33
|
+
*/
|
|
34
|
+
'message'?: string;
|
|
35
|
+
/**
|
|
36
|
+
*
|
|
37
|
+
* @type {string}
|
|
38
|
+
* @memberof CredentialsDetail404Response
|
|
39
|
+
*/
|
|
40
|
+
'error'?: string;
|
|
41
|
+
}
|
|
42
|
+
|