humanos 1.0.5 → 1.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +551 -323
- package/dist/index.d.ts +551 -323
- package/dist/index.js +33 -31
- package/dist/index.mjs +32 -31
- package/generated/.openapi-generator/FILES +13 -7
- package/generated/api/approval-api.ts +0 -2
- package/generated/api/credentials-api.ts +15 -15
- package/generated/api/requests-api.ts +8 -4
- package/generated/api/webhooks-api.ts +4 -4
- package/generated/models/create-presentation-dto.ts +1 -1
- package/generated/models/create-subject-entity.ts +3 -6
- package/generated/models/credential-entity.ts +2 -2
- package/generated/models/{w3-cverifiable-credential-proofs-inner.ts → credential-proof.ts} +20 -8
- package/generated/models/generate-request-dto.ts +15 -27
- package/generated/models/generate-request-iframe-cookie-dto.ts +36 -0
- package/generated/models/generate-request-iframe-dto.ts +39 -0
- package/generated/models/generate-request-user-dto.ts +64 -0
- package/generated/models/generate-subject-entity.ts +2 -2
- package/generated/models/identity-event-decision.ts +0 -18
- package/generated/models/identity-event.ts +3 -3
- package/generated/models/{w3-cverifiable-credential-valid-from.ts → identity-webhook-issue-date.ts} +2 -2
- package/generated/models/identity-webhook.ts +117 -0
- package/generated/models/index.ts +13 -7
- package/generated/models/{w3-cverifiable-credential-evidences-inner.ts → mandate-action.ts} +7 -5
- package/generated/models/{w3-cverifiable-credential-credential-subject-mandate-context.ts → mandate-context.ts} +3 -3
- package/generated/models/{w3-cverifiable-credential-valid-until.ts → mandate-grantor.ts} +2 -2
- package/generated/models/mandate.ts +65 -0
- package/generated/models/presentation-entity.ts +45 -0
- package/generated/models/request-detail-subject-entity.ts +6 -0
- package/generated/models/request-subject-entity.ts +6 -0
- package/generated/models/{generate400-response.ts → requests-create402-response.ts} +5 -5
- package/generated/models/{create400-response.ts → requests-create409-response.ts} +5 -5
- package/generated/models/resource-entity.ts +0 -1
- package/generated/models/resource-minimal-entity.ts +0 -1
- package/generated/models/resource-query.ts +0 -1
- package/generated/models/revoke-credential-entity.ts +0 -9
- package/generated/models/verify-presentation-dto.ts +8 -2
- package/generated/models/w3-cverifiable-credential-credential-subject.ts +3 -3
- package/generated/models/w3-cverifiable-credential.ts +5 -5
- package/generated/models/webhook-call-event.ts +1 -1
- package/package.json +1 -1
- package/generated/models/action-ref-dto.ts +0 -36
- package/generated/models/constraints-dto.ts +0 -36
- package/generated/models/create-presentation400-response.ts +0 -42
- package/generated/models/create-presentation403-response.ts +0 -42
- package/generated/models/create-presentation404-response.ts +0 -42
- package/generated/models/credential-dto-data-inner.ts +0 -26
- package/generated/models/get-credential404-response.ts +0 -42
- package/generated/models/get-evidence404-response.ts +0 -42
- package/generated/models/get-request-detail404-response.ts +0 -42
- package/generated/models/get-subject400-response.ts +0 -42
- package/generated/models/get-subject404-response.ts +0 -42
- package/generated/models/identity-payload.ts +0 -84
- package/generated/models/json-value.ts +0 -27
- package/generated/models/otp-failed-event-otp-error.ts +0 -36
- package/generated/models/presentation-receipt-entity.ts +0 -42
- package/generated/models/presentation-response-entity.ts +0 -39
- package/generated/models/resend-otp403-response.ts +0 -42
- package/generated/models/revoke-credential400-response.ts +0 -42
- package/generated/models/revoke-credential409-response.ts +0 -42
- package/generated/models/revoke-receipt-entity.ts +0 -42
- package/generated/models/schema-entity.ts +0 -57
- package/generated/models/schema-list-entity.ts +0 -39
- package/generated/models/schema-query.ts +0 -48
- package/generated/models/schema-response-entity.ts +0 -45
- package/generated/models/schema-version-detail-entity.ts +0 -72
- package/generated/models/schema-version-list-entity.ts +0 -39
- package/generated/models/schema-version-response-entity.ts +0 -54
- package/generated/models/schema-version-summary-entity.ts +0 -48
- package/generated/models/subject-contact-entity.ts +0 -42
- package/generated/models/verify-receipt-entity.ts +0 -42
- package/generated/models/w3-cverifiable-credential-credential-subject-mandate-action.ts +0 -44
- package/generated/models/w3-cverifiable-credential-credential-subject-mandate-constraint-constraint-schema.ts +0 -44
- package/generated/models/w3-cverifiable-credential-credential-subject-mandate-constraint.ts +0 -41
- package/generated/models/w3-cverifiable-credential-credential-subject-mandate-grantor.ts +0 -24
- package/generated/models/w3-cverifiable-credential-credential-subject-mandate.ts +0 -65
- package/generated/models/webhook-event-type-credential.ts +0 -30
- package/generated/models/webhook-event-type-identity.ts +0 -30
- package/generated/models/webhook-event-type-otpfailed.ts +0 -30
- package/generated/models/webhook-event-type-test.ts +0 -30
- package/generated/models/webhook-event-type.ts +0 -33
package/dist/index.js
CHANGED
|
@@ -62,6 +62,7 @@ __export(index_exports, {
|
|
|
62
62
|
DIDApiFp: () => DIDApiFp,
|
|
63
63
|
DeliveryActionType: () => DeliveryActionType,
|
|
64
64
|
GenerateRequestDtoSecurityLevelEnum: () => GenerateRequestDtoSecurityLevelEnum,
|
|
65
|
+
GenerateRequestUserDtoLanguageEnum: () => GenerateRequestUserDtoLanguageEnum,
|
|
65
66
|
HumanosClient: () => HumanosClient,
|
|
66
67
|
IdentityEventEventTypeEnum: () => IdentityEventEventTypeEnum,
|
|
67
68
|
ListSecurityLevelEnum: () => ListSecurityLevelEnum,
|
|
@@ -773,7 +774,6 @@ var ListTypesEnum = {
|
|
|
773
774
|
Form: "FORM",
|
|
774
775
|
Document: "DOCUMENT",
|
|
775
776
|
Json: "JSON",
|
|
776
|
-
Payment: "PAYMENT",
|
|
777
777
|
Policy: "POLICY"
|
|
778
778
|
};
|
|
779
779
|
var WorkflowsTypesEnum = {
|
|
@@ -781,7 +781,6 @@ var WorkflowsTypesEnum = {
|
|
|
781
781
|
Form: "FORM",
|
|
782
782
|
Document: "DOCUMENT",
|
|
783
783
|
Json: "JSON",
|
|
784
|
-
Payment: "PAYMENT",
|
|
785
784
|
Policy: "POLICY"
|
|
786
785
|
};
|
|
787
786
|
|
|
@@ -852,7 +851,7 @@ var CredentialsApiAxiosParamCreator = function(configuration) {
|
|
|
852
851
|
/**
|
|
853
852
|
* Build and sign a W3C Verifiable Presentation for a stored credential. The API key must belong to the credential owner.
|
|
854
853
|
* @summary Issue VP
|
|
855
|
-
* @param {string} vcId
|
|
854
|
+
* @param {string} vcId URN of the credential to present.
|
|
856
855
|
* @param {CreatePresentationDto} createPresentationDto
|
|
857
856
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
858
857
|
* @param {*} [options] Override http request option.
|
|
@@ -884,7 +883,7 @@ var CredentialsApiAxiosParamCreator = function(configuration) {
|
|
|
884
883
|
};
|
|
885
884
|
},
|
|
886
885
|
/**
|
|
887
|
-
* Permanently revoke an active credential. Flips status to REVOKED, records revokedAt and revocationReason,
|
|
886
|
+
* Permanently revoke an active credential. Flips status to REVOKED, records revokedAt and revocationReason, Appends a REVOKE proof to the credential, and emits a MANDATE_REVOKED activity event. Subsequent /vp and /verify calls for this credential are denied with reason credential_revoked.
|
|
888
887
|
* @summary Revoke Credential
|
|
889
888
|
* @param {string} credentialId URN of the credential to revoke
|
|
890
889
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -917,7 +916,7 @@ var CredentialsApiAxiosParamCreator = function(configuration) {
|
|
|
917
916
|
};
|
|
918
917
|
},
|
|
919
918
|
/**
|
|
920
|
-
* Evaluate a VP against runtime context. On allow, returns
|
|
919
|
+
* Evaluate a VP against runtime context. On allow, returns 201 with the signed receipt. On deny, returns 403 with the reason, evaluations, and receipt in the error body. If the mandate has no constraint schema, only signatures, verifier access, and validity are checked. Supply the presentation exactly as returned by POST /credential/vp/:vcId — do not re-serialize or modify it. Pass it as either `presentation` (the signed VP object) or `presentationEncoded` (its base64 string); at least one is required (400 otherwise), and if both are sent `presentationEncoded` wins. `presentationEncoded` is the recommended field: being an opaque string it is immune to JSON re-serialization / formatting changes (e.g. some HTTP clients reformatting date strings) that would otherwise break the signature.
|
|
921
920
|
* @summary Verify VP
|
|
922
921
|
* @param {VerifyPresentationDto} verifyPresentationDto
|
|
923
922
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -984,7 +983,7 @@ var CredentialsApiFp = function(configuration) {
|
|
|
984
983
|
/**
|
|
985
984
|
* Build and sign a W3C Verifiable Presentation for a stored credential. The API key must belong to the credential owner.
|
|
986
985
|
* @summary Issue VP
|
|
987
|
-
* @param {string} vcId
|
|
986
|
+
* @param {string} vcId URN of the credential to present.
|
|
988
987
|
* @param {CreatePresentationDto} createPresentationDto
|
|
989
988
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
990
989
|
* @param {*} [options] Override http request option.
|
|
@@ -997,7 +996,7 @@ var CredentialsApiFp = function(configuration) {
|
|
|
997
996
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, import_axios5.default, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
998
997
|
},
|
|
999
998
|
/**
|
|
1000
|
-
* Permanently revoke an active credential. Flips status to REVOKED, records revokedAt and revocationReason,
|
|
999
|
+
* Permanently revoke an active credential. Flips status to REVOKED, records revokedAt and revocationReason, Appends a REVOKE proof to the credential, and emits a MANDATE_REVOKED activity event. Subsequent /vp and /verify calls for this credential are denied with reason credential_revoked.
|
|
1001
1000
|
* @summary Revoke Credential
|
|
1002
1001
|
* @param {string} credentialId URN of the credential to revoke
|
|
1003
1002
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -1012,7 +1011,7 @@ var CredentialsApiFp = function(configuration) {
|
|
|
1012
1011
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, import_axios5.default, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
1013
1012
|
},
|
|
1014
1013
|
/**
|
|
1015
|
-
* Evaluate a VP against runtime context. On allow, returns
|
|
1014
|
+
* Evaluate a VP against runtime context. On allow, returns 201 with the signed receipt. On deny, returns 403 with the reason, evaluations, and receipt in the error body. If the mandate has no constraint schema, only signatures, verifier access, and validity are checked. Supply the presentation exactly as returned by POST /credential/vp/:vcId — do not re-serialize or modify it. Pass it as either `presentation` (the signed VP object) or `presentationEncoded` (its base64 string); at least one is required (400 otherwise), and if both are sent `presentationEncoded` wins. `presentationEncoded` is the recommended field: being an opaque string it is immune to JSON re-serialization / formatting changes (e.g. some HTTP clients reformatting date strings) that would otherwise break the signature.
|
|
1016
1015
|
* @summary Verify VP
|
|
1017
1016
|
* @param {VerifyPresentationDto} verifyPresentationDto
|
|
1018
1017
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -1055,7 +1054,7 @@ var CredentialsApiFactory = function(configuration, basePath, axios2) {
|
|
|
1055
1054
|
/**
|
|
1056
1055
|
* Build and sign a W3C Verifiable Presentation for a stored credential. The API key must belong to the credential owner.
|
|
1057
1056
|
* @summary Issue VP
|
|
1058
|
-
* @param {string} vcId
|
|
1057
|
+
* @param {string} vcId URN of the credential to present.
|
|
1059
1058
|
* @param {CreatePresentationDto} createPresentationDto
|
|
1060
1059
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
1061
1060
|
* @param {*} [options] Override http request option.
|
|
@@ -1065,7 +1064,7 @@ var CredentialsApiFactory = function(configuration, basePath, axios2) {
|
|
|
1065
1064
|
return localVarFp.issueVP(vcId, createPresentationDto, aPIVersion, options).then((request) => request(axios2, basePath));
|
|
1066
1065
|
},
|
|
1067
1066
|
/**
|
|
1068
|
-
* Permanently revoke an active credential. Flips status to REVOKED, records revokedAt and revocationReason,
|
|
1067
|
+
* Permanently revoke an active credential. Flips status to REVOKED, records revokedAt and revocationReason, Appends a REVOKE proof to the credential, and emits a MANDATE_REVOKED activity event. Subsequent /vp and /verify calls for this credential are denied with reason credential_revoked.
|
|
1069
1068
|
* @summary Revoke Credential
|
|
1070
1069
|
* @param {string} credentialId URN of the credential to revoke
|
|
1071
1070
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -1077,7 +1076,7 @@ var CredentialsApiFactory = function(configuration, basePath, axios2) {
|
|
|
1077
1076
|
return localVarFp.revoke(credentialId, aPIVersion, revokeCredentialDto, options).then((request) => request(axios2, basePath));
|
|
1078
1077
|
},
|
|
1079
1078
|
/**
|
|
1080
|
-
* Evaluate a VP against runtime context. On allow, returns
|
|
1079
|
+
* Evaluate a VP against runtime context. On allow, returns 201 with the signed receipt. On deny, returns 403 with the reason, evaluations, and receipt in the error body. If the mandate has no constraint schema, only signatures, verifier access, and validity are checked. Supply the presentation exactly as returned by POST /credential/vp/:vcId — do not re-serialize or modify it. Pass it as either `presentation` (the signed VP object) or `presentationEncoded` (its base64 string); at least one is required (400 otherwise), and if both are sent `presentationEncoded` wins. `presentationEncoded` is the recommended field: being an opaque string it is immune to JSON re-serialization / formatting changes (e.g. some HTTP clients reformatting date strings) that would otherwise break the signature.
|
|
1081
1080
|
* @summary Verify VP
|
|
1082
1081
|
* @param {VerifyPresentationDto} verifyPresentationDto
|
|
1083
1082
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -1117,7 +1116,7 @@ var CredentialsApi = class extends BaseAPI {
|
|
|
1117
1116
|
/**
|
|
1118
1117
|
* Build and sign a W3C Verifiable Presentation for a stored credential. The API key must belong to the credential owner.
|
|
1119
1118
|
* @summary Issue VP
|
|
1120
|
-
* @param {string} vcId
|
|
1119
|
+
* @param {string} vcId URN of the credential to present.
|
|
1121
1120
|
* @param {CreatePresentationDto} createPresentationDto
|
|
1122
1121
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
1123
1122
|
* @param {*} [options] Override http request option.
|
|
@@ -1128,7 +1127,7 @@ var CredentialsApi = class extends BaseAPI {
|
|
|
1128
1127
|
return CredentialsApiFp(this.configuration).issueVP(vcId, createPresentationDto, aPIVersion, options).then((request) => request(this.axios, this.basePath));
|
|
1129
1128
|
}
|
|
1130
1129
|
/**
|
|
1131
|
-
* Permanently revoke an active credential. Flips status to REVOKED, records revokedAt and revocationReason,
|
|
1130
|
+
* Permanently revoke an active credential. Flips status to REVOKED, records revokedAt and revocationReason, Appends a REVOKE proof to the credential, and emits a MANDATE_REVOKED activity event. Subsequent /vp and /verify calls for this credential are denied with reason credential_revoked.
|
|
1132
1131
|
* @summary Revoke Credential
|
|
1133
1132
|
* @param {string} credentialId URN of the credential to revoke
|
|
1134
1133
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -1141,7 +1140,7 @@ var CredentialsApi = class extends BaseAPI {
|
|
|
1141
1140
|
return CredentialsApiFp(this.configuration).revoke(credentialId, aPIVersion, revokeCredentialDto, options).then((request) => request(this.axios, this.basePath));
|
|
1142
1141
|
}
|
|
1143
1142
|
/**
|
|
1144
|
-
* Evaluate a VP against runtime context. On allow, returns
|
|
1143
|
+
* Evaluate a VP against runtime context. On allow, returns 201 with the signed receipt. On deny, returns 403 with the reason, evaluations, and receipt in the error body. If the mandate has no constraint schema, only signatures, verifier access, and validity are checked. Supply the presentation exactly as returned by POST /credential/vp/:vcId — do not re-serialize or modify it. Pass it as either `presentation` (the signed VP object) or `presentationEncoded` (its base64 string); at least one is required (400 otherwise), and if both are sent `presentationEncoded` wins. `presentationEncoded` is the recommended field: being an opaque string it is immune to JSON re-serialization / formatting changes (e.g. some HTTP clients reformatting date strings) that would otherwise break the signature.
|
|
1145
1144
|
* @summary Verify VP
|
|
1146
1145
|
* @param {VerifyPresentationDto} verifyPresentationDto
|
|
1147
1146
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -1401,7 +1400,7 @@ var RequestsApiAxiosParamCreator = function(configuration) {
|
|
|
1401
1400
|
};
|
|
1402
1401
|
},
|
|
1403
1402
|
/**
|
|
1404
|
-
* Resend a One-Time Password (OTP) to a subject for credential approval, via email or SMS
|
|
1403
|
+
* Resend a One-Time Password (OTP) to a subject for credential approval, via email or SMS. The endpoint validates: - The request is not canceled - Maximum attempts have not been reached, only successful OTP sends count towards resend limits - Sufficient time has passed since the last successful resend - Billing restrictions apply
|
|
1405
1404
|
* @summary Resend OTP
|
|
1406
1405
|
* @param {string} requestId Unique identifier of the request.
|
|
1407
1406
|
* @param {string} [contact] Verified contact value (email or phone)
|
|
@@ -1516,7 +1515,7 @@ var RequestsApiFp = function(configuration) {
|
|
|
1516
1515
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, import_axios7.default, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
1517
1516
|
},
|
|
1518
1517
|
/**
|
|
1519
|
-
* Resend a One-Time Password (OTP) to a subject for credential approval, via email or SMS
|
|
1518
|
+
* Resend a One-Time Password (OTP) to a subject for credential approval, via email or SMS. The endpoint validates: - The request is not canceled - Maximum attempts have not been reached, only successful OTP sends count towards resend limits - Sufficient time has passed since the last successful resend - Billing restrictions apply
|
|
1520
1519
|
* @summary Resend OTP
|
|
1521
1520
|
* @param {string} requestId Unique identifier of the request.
|
|
1522
1521
|
* @param {string} [contact] Verified contact value (email or phone)
|
|
@@ -1591,7 +1590,7 @@ var RequestsApiFactory = function(configuration, basePath, axios2) {
|
|
|
1591
1590
|
return localVarFp.list(pageIndex, pageSize, search, dateFrom, dateTo, subject, internalId, securityLevel, aPIVersion, options).then((request) => request(axios2, basePath));
|
|
1592
1591
|
},
|
|
1593
1592
|
/**
|
|
1594
|
-
* Resend a One-Time Password (OTP) to a subject for credential approval, via email or SMS
|
|
1593
|
+
* Resend a One-Time Password (OTP) to a subject for credential approval, via email or SMS. The endpoint validates: - The request is not canceled - Maximum attempts have not been reached, only successful OTP sends count towards resend limits - Sufficient time has passed since the last successful resend - Billing restrictions apply
|
|
1595
1594
|
* @summary Resend OTP
|
|
1596
1595
|
* @param {string} requestId Unique identifier of the request.
|
|
1597
1596
|
* @param {string} [contact] Verified contact value (email or phone)
|
|
@@ -1665,7 +1664,7 @@ var RequestsApi = class extends BaseAPI {
|
|
|
1665
1664
|
return RequestsApiFp(this.configuration).list(pageIndex, pageSize, search, dateFrom, dateTo, subject, internalId, securityLevel, aPIVersion, options).then((request) => request(this.axios, this.basePath));
|
|
1666
1665
|
}
|
|
1667
1666
|
/**
|
|
1668
|
-
* Resend a One-Time Password (OTP) to a subject for credential approval, via email or SMS
|
|
1667
|
+
* Resend a One-Time Password (OTP) to a subject for credential approval, via email or SMS. The endpoint validates: - The request is not canceled - Maximum attempts have not been reached, only successful OTP sends count towards resend limits - Sufficient time has passed since the last successful resend - Billing restrictions apply
|
|
1669
1668
|
* @summary Resend OTP
|
|
1670
1669
|
* @param {string} requestId Unique identifier of the request.
|
|
1671
1670
|
* @param {string} [contact] Verified contact value (email or phone)
|
|
@@ -1935,7 +1934,7 @@ var WebhooksApiAxiosParamCreator = function(configuration) {
|
|
|
1935
1934
|
};
|
|
1936
1935
|
},
|
|
1937
1936
|
/**
|
|
1938
|
-
* Fired when an OTP delivery to the
|
|
1937
|
+
* Fired when an OTP **SMS** could not be delivered: every eligible SMS provider was tried (synchronously or via carrier delivery reports) and none succeeded. Email OTP failures do not emit this event. Carrier delivery reports are asynchronous and occasionally corrected to \"delivered\" afterwards, so treat this event as *Humanos stopped retrying*, not as a guarantee the SMS never arrived. The safe reaction is to `PATCH` the `otp.resendEndpoint` URL exactly as delivered — a resend issues a fresh code and invalidates the old one, so it is harmless even if the original message did arrive late. **Inbound webhook callback** — Humanos POSTs this payload to your registered webhook URL. This is not an endpoint you call; it is documented as a path so SDK code generators emit a typed payload model.
|
|
1939
1938
|
* @summary OTP Failed Event
|
|
1940
1939
|
* @param {OtpFailedEvent} otpFailedEvent
|
|
1941
1940
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -2032,7 +2031,7 @@ var WebhooksApiFp = function(configuration) {
|
|
|
2032
2031
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, import_axios9.default, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
2033
2032
|
},
|
|
2034
2033
|
/**
|
|
2035
|
-
* Fired when an OTP delivery to the
|
|
2034
|
+
* Fired when an OTP **SMS** could not be delivered: every eligible SMS provider was tried (synchronously or via carrier delivery reports) and none succeeded. Email OTP failures do not emit this event. Carrier delivery reports are asynchronous and occasionally corrected to \"delivered\" afterwards, so treat this event as *Humanos stopped retrying*, not as a guarantee the SMS never arrived. The safe reaction is to `PATCH` the `otp.resendEndpoint` URL exactly as delivered — a resend issues a fresh code and invalidates the old one, so it is harmless even if the original message did arrive late. **Inbound webhook callback** — Humanos POSTs this payload to your registered webhook URL. This is not an endpoint you call; it is documented as a path so SDK code generators emit a typed payload model.
|
|
2036
2035
|
* @summary OTP Failed Event
|
|
2037
2036
|
* @param {OtpFailedEvent} otpFailedEvent
|
|
2038
2037
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -2087,7 +2086,7 @@ var WebhooksApiFactory = function(configuration, basePath, axios2) {
|
|
|
2087
2086
|
return localVarFp.identity(identityEvent, aPIVersion, options).then((request) => request(axios2, basePath));
|
|
2088
2087
|
},
|
|
2089
2088
|
/**
|
|
2090
|
-
* Fired when an OTP delivery to the
|
|
2089
|
+
* Fired when an OTP **SMS** could not be delivered: every eligible SMS provider was tried (synchronously or via carrier delivery reports) and none succeeded. Email OTP failures do not emit this event. Carrier delivery reports are asynchronous and occasionally corrected to \"delivered\" afterwards, so treat this event as *Humanos stopped retrying*, not as a guarantee the SMS never arrived. The safe reaction is to `PATCH` the `otp.resendEndpoint` URL exactly as delivered — a resend issues a fresh code and invalidates the old one, so it is harmless even if the original message did arrive late. **Inbound webhook callback** — Humanos POSTs this payload to your registered webhook URL. This is not an endpoint you call; it is documented as a path so SDK code generators emit a typed payload model.
|
|
2091
2090
|
* @summary OTP Failed Event
|
|
2092
2091
|
* @param {OtpFailedEvent} otpFailedEvent
|
|
2093
2092
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -2136,7 +2135,7 @@ var WebhooksApi = class extends BaseAPI {
|
|
|
2136
2135
|
return WebhooksApiFp(this.configuration).identity(identityEvent, aPIVersion, options).then((request) => request(this.axios, this.basePath));
|
|
2137
2136
|
}
|
|
2138
2137
|
/**
|
|
2139
|
-
* Fired when an OTP delivery to the
|
|
2138
|
+
* Fired when an OTP **SMS** could not be delivered: every eligible SMS provider was tried (synchronously or via carrier delivery reports) and none succeeded. Email OTP failures do not emit this event. Carrier delivery reports are asynchronous and occasionally corrected to \"delivered\" afterwards, so treat this event as *Humanos stopped retrying*, not as a guarantee the SMS never arrived. The safe reaction is to `PATCH` the `otp.resendEndpoint` URL exactly as delivered — a resend issues a fresh code and invalidates the old one, so it is harmless even if the original message did arrive late. **Inbound webhook callback** — Humanos POSTs this payload to your registered webhook URL. This is not an endpoint you call; it is documented as a path so SDK code generators emit a typed payload model.
|
|
2140
2139
|
* @summary OTP Failed Event
|
|
2141
2140
|
* @param {OtpFailedEvent} otpFailedEvent
|
|
2142
2141
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -2223,14 +2222,11 @@ var ActivityQueryTypeEnum = {
|
|
|
2223
2222
|
|
|
2224
2223
|
// generated/models/create-subject-entity.ts
|
|
2225
2224
|
var CreateSubjectEntityStatusEnum = {
|
|
2226
|
-
NUMBER_200: 200,
|
|
2227
2225
|
NUMBER_201: 201,
|
|
2228
2226
|
NUMBER_400: 400,
|
|
2229
|
-
NUMBER_402: 402,
|
|
2230
|
-
NUMBER_407: 407,
|
|
2231
|
-
NUMBER_408: 408,
|
|
2232
2227
|
NUMBER_409: 409,
|
|
2233
|
-
NUMBER_410: 410
|
|
2228
|
+
NUMBER_410: 410,
|
|
2229
|
+
NUMBER_500: 500
|
|
2234
2230
|
};
|
|
2235
2231
|
|
|
2236
2232
|
// generated/models/credential-dto.ts
|
|
@@ -2291,6 +2287,14 @@ var GenerateRequestDtoSecurityLevelEnum = {
|
|
|
2291
2287
|
HumanosRevalidation: "HUMANOS_REVALIDATION"
|
|
2292
2288
|
};
|
|
2293
2289
|
|
|
2290
|
+
// generated/models/generate-request-user-dto.ts
|
|
2291
|
+
var GenerateRequestUserDtoLanguageEnum = {
|
|
2292
|
+
Eng: "ENG",
|
|
2293
|
+
Prt: "PRT",
|
|
2294
|
+
Spa: "SPA",
|
|
2295
|
+
Fra: "FRA"
|
|
2296
|
+
};
|
|
2297
|
+
|
|
2294
2298
|
// generated/models/identity-event.ts
|
|
2295
2299
|
var IdentityEventEventTypeEnum = {
|
|
2296
2300
|
Identity: "identity"
|
|
@@ -2355,7 +2359,6 @@ var ResourceEntityTypeEnum = {
|
|
|
2355
2359
|
Form: "FORM",
|
|
2356
2360
|
Document: "DOCUMENT",
|
|
2357
2361
|
Json: "JSON",
|
|
2358
|
-
Payment: "PAYMENT",
|
|
2359
2362
|
Policy: "POLICY"
|
|
2360
2363
|
};
|
|
2361
2364
|
|
|
@@ -2365,7 +2368,6 @@ var ResourceMinimalEntityTypeEnum = {
|
|
|
2365
2368
|
Form: "FORM",
|
|
2366
2369
|
Document: "DOCUMENT",
|
|
2367
2370
|
Json: "JSON",
|
|
2368
|
-
Payment: "PAYMENT",
|
|
2369
2371
|
Policy: "POLICY"
|
|
2370
2372
|
};
|
|
2371
2373
|
|
|
@@ -2375,7 +2377,6 @@ var ResourceQueryTypesEnum = {
|
|
|
2375
2377
|
Form: "FORM",
|
|
2376
2378
|
Document: "DOCUMENT",
|
|
2377
2379
|
Json: "JSON",
|
|
2378
|
-
Payment: "PAYMENT",
|
|
2379
2380
|
Policy: "POLICY"
|
|
2380
2381
|
};
|
|
2381
2382
|
|
|
@@ -2452,7 +2453,7 @@ function applySignatureInterceptor(axiosInstance, signatureSecret) {
|
|
|
2452
2453
|
}
|
|
2453
2454
|
|
|
2454
2455
|
// src/client.ts
|
|
2455
|
-
var API_VERSION = "2026-
|
|
2456
|
+
var API_VERSION = "2026-07-07";
|
|
2456
2457
|
var SDK_LANGUAGE = "typescript";
|
|
2457
2458
|
var HumanosClient = class {
|
|
2458
2459
|
constructor(clientConfig) {
|
|
@@ -2602,6 +2603,7 @@ function createWebhookHandler(config, handler) {
|
|
|
2602
2603
|
DIDApiFp,
|
|
2603
2604
|
DeliveryActionType,
|
|
2604
2605
|
GenerateRequestDtoSecurityLevelEnum,
|
|
2606
|
+
GenerateRequestUserDtoLanguageEnum,
|
|
2605
2607
|
HumanosClient,
|
|
2606
2608
|
IdentityEventEventTypeEnum,
|
|
2607
2609
|
ListSecurityLevelEnum,
|
package/dist/index.mjs
CHANGED
|
@@ -663,7 +663,6 @@ var ListTypesEnum = {
|
|
|
663
663
|
Form: "FORM",
|
|
664
664
|
Document: "DOCUMENT",
|
|
665
665
|
Json: "JSON",
|
|
666
|
-
Payment: "PAYMENT",
|
|
667
666
|
Policy: "POLICY"
|
|
668
667
|
};
|
|
669
668
|
var WorkflowsTypesEnum = {
|
|
@@ -671,7 +670,6 @@ var WorkflowsTypesEnum = {
|
|
|
671
670
|
Form: "FORM",
|
|
672
671
|
Document: "DOCUMENT",
|
|
673
672
|
Json: "JSON",
|
|
674
|
-
Payment: "PAYMENT",
|
|
675
673
|
Policy: "POLICY"
|
|
676
674
|
};
|
|
677
675
|
|
|
@@ -742,7 +740,7 @@ var CredentialsApiAxiosParamCreator = function(configuration) {
|
|
|
742
740
|
/**
|
|
743
741
|
* Build and sign a W3C Verifiable Presentation for a stored credential. The API key must belong to the credential owner.
|
|
744
742
|
* @summary Issue VP
|
|
745
|
-
* @param {string} vcId
|
|
743
|
+
* @param {string} vcId URN of the credential to present.
|
|
746
744
|
* @param {CreatePresentationDto} createPresentationDto
|
|
747
745
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
748
746
|
* @param {*} [options] Override http request option.
|
|
@@ -774,7 +772,7 @@ var CredentialsApiAxiosParamCreator = function(configuration) {
|
|
|
774
772
|
};
|
|
775
773
|
},
|
|
776
774
|
/**
|
|
777
|
-
* Permanently revoke an active credential. Flips status to REVOKED, records revokedAt and revocationReason,
|
|
775
|
+
* Permanently revoke an active credential. Flips status to REVOKED, records revokedAt and revocationReason, Appends a REVOKE proof to the credential, and emits a MANDATE_REVOKED activity event. Subsequent /vp and /verify calls for this credential are denied with reason credential_revoked.
|
|
778
776
|
* @summary Revoke Credential
|
|
779
777
|
* @param {string} credentialId URN of the credential to revoke
|
|
780
778
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -807,7 +805,7 @@ var CredentialsApiAxiosParamCreator = function(configuration) {
|
|
|
807
805
|
};
|
|
808
806
|
},
|
|
809
807
|
/**
|
|
810
|
-
* Evaluate a VP against runtime context. On allow, returns
|
|
808
|
+
* Evaluate a VP against runtime context. On allow, returns 201 with the signed receipt. On deny, returns 403 with the reason, evaluations, and receipt in the error body. If the mandate has no constraint schema, only signatures, verifier access, and validity are checked. Supply the presentation exactly as returned by POST /credential/vp/:vcId — do not re-serialize or modify it. Pass it as either `presentation` (the signed VP object) or `presentationEncoded` (its base64 string); at least one is required (400 otherwise), and if both are sent `presentationEncoded` wins. `presentationEncoded` is the recommended field: being an opaque string it is immune to JSON re-serialization / formatting changes (e.g. some HTTP clients reformatting date strings) that would otherwise break the signature.
|
|
811
809
|
* @summary Verify VP
|
|
812
810
|
* @param {VerifyPresentationDto} verifyPresentationDto
|
|
813
811
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -874,7 +872,7 @@ var CredentialsApiFp = function(configuration) {
|
|
|
874
872
|
/**
|
|
875
873
|
* Build and sign a W3C Verifiable Presentation for a stored credential. The API key must belong to the credential owner.
|
|
876
874
|
* @summary Issue VP
|
|
877
|
-
* @param {string} vcId
|
|
875
|
+
* @param {string} vcId URN of the credential to present.
|
|
878
876
|
* @param {CreatePresentationDto} createPresentationDto
|
|
879
877
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
880
878
|
* @param {*} [options] Override http request option.
|
|
@@ -887,7 +885,7 @@ var CredentialsApiFp = function(configuration) {
|
|
|
887
885
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
888
886
|
},
|
|
889
887
|
/**
|
|
890
|
-
* Permanently revoke an active credential. Flips status to REVOKED, records revokedAt and revocationReason,
|
|
888
|
+
* Permanently revoke an active credential. Flips status to REVOKED, records revokedAt and revocationReason, Appends a REVOKE proof to the credential, and emits a MANDATE_REVOKED activity event. Subsequent /vp and /verify calls for this credential are denied with reason credential_revoked.
|
|
891
889
|
* @summary Revoke Credential
|
|
892
890
|
* @param {string} credentialId URN of the credential to revoke
|
|
893
891
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -902,7 +900,7 @@ var CredentialsApiFp = function(configuration) {
|
|
|
902
900
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
903
901
|
},
|
|
904
902
|
/**
|
|
905
|
-
* Evaluate a VP against runtime context. On allow, returns
|
|
903
|
+
* Evaluate a VP against runtime context. On allow, returns 201 with the signed receipt. On deny, returns 403 with the reason, evaluations, and receipt in the error body. If the mandate has no constraint schema, only signatures, verifier access, and validity are checked. Supply the presentation exactly as returned by POST /credential/vp/:vcId — do not re-serialize or modify it. Pass it as either `presentation` (the signed VP object) or `presentationEncoded` (its base64 string); at least one is required (400 otherwise), and if both are sent `presentationEncoded` wins. `presentationEncoded` is the recommended field: being an opaque string it is immune to JSON re-serialization / formatting changes (e.g. some HTTP clients reformatting date strings) that would otherwise break the signature.
|
|
906
904
|
* @summary Verify VP
|
|
907
905
|
* @param {VerifyPresentationDto} verifyPresentationDto
|
|
908
906
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -945,7 +943,7 @@ var CredentialsApiFactory = function(configuration, basePath, axios2) {
|
|
|
945
943
|
/**
|
|
946
944
|
* Build and sign a W3C Verifiable Presentation for a stored credential. The API key must belong to the credential owner.
|
|
947
945
|
* @summary Issue VP
|
|
948
|
-
* @param {string} vcId
|
|
946
|
+
* @param {string} vcId URN of the credential to present.
|
|
949
947
|
* @param {CreatePresentationDto} createPresentationDto
|
|
950
948
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
951
949
|
* @param {*} [options] Override http request option.
|
|
@@ -955,7 +953,7 @@ var CredentialsApiFactory = function(configuration, basePath, axios2) {
|
|
|
955
953
|
return localVarFp.issueVP(vcId, createPresentationDto, aPIVersion, options).then((request) => request(axios2, basePath));
|
|
956
954
|
},
|
|
957
955
|
/**
|
|
958
|
-
* Permanently revoke an active credential. Flips status to REVOKED, records revokedAt and revocationReason,
|
|
956
|
+
* Permanently revoke an active credential. Flips status to REVOKED, records revokedAt and revocationReason, Appends a REVOKE proof to the credential, and emits a MANDATE_REVOKED activity event. Subsequent /vp and /verify calls for this credential are denied with reason credential_revoked.
|
|
959
957
|
* @summary Revoke Credential
|
|
960
958
|
* @param {string} credentialId URN of the credential to revoke
|
|
961
959
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -967,7 +965,7 @@ var CredentialsApiFactory = function(configuration, basePath, axios2) {
|
|
|
967
965
|
return localVarFp.revoke(credentialId, aPIVersion, revokeCredentialDto, options).then((request) => request(axios2, basePath));
|
|
968
966
|
},
|
|
969
967
|
/**
|
|
970
|
-
* Evaluate a VP against runtime context. On allow, returns
|
|
968
|
+
* Evaluate a VP against runtime context. On allow, returns 201 with the signed receipt. On deny, returns 403 with the reason, evaluations, and receipt in the error body. If the mandate has no constraint schema, only signatures, verifier access, and validity are checked. Supply the presentation exactly as returned by POST /credential/vp/:vcId — do not re-serialize or modify it. Pass it as either `presentation` (the signed VP object) or `presentationEncoded` (its base64 string); at least one is required (400 otherwise), and if both are sent `presentationEncoded` wins. `presentationEncoded` is the recommended field: being an opaque string it is immune to JSON re-serialization / formatting changes (e.g. some HTTP clients reformatting date strings) that would otherwise break the signature.
|
|
971
969
|
* @summary Verify VP
|
|
972
970
|
* @param {VerifyPresentationDto} verifyPresentationDto
|
|
973
971
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -1007,7 +1005,7 @@ var CredentialsApi = class extends BaseAPI {
|
|
|
1007
1005
|
/**
|
|
1008
1006
|
* Build and sign a W3C Verifiable Presentation for a stored credential. The API key must belong to the credential owner.
|
|
1009
1007
|
* @summary Issue VP
|
|
1010
|
-
* @param {string} vcId
|
|
1008
|
+
* @param {string} vcId URN of the credential to present.
|
|
1011
1009
|
* @param {CreatePresentationDto} createPresentationDto
|
|
1012
1010
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
1013
1011
|
* @param {*} [options] Override http request option.
|
|
@@ -1018,7 +1016,7 @@ var CredentialsApi = class extends BaseAPI {
|
|
|
1018
1016
|
return CredentialsApiFp(this.configuration).issueVP(vcId, createPresentationDto, aPIVersion, options).then((request) => request(this.axios, this.basePath));
|
|
1019
1017
|
}
|
|
1020
1018
|
/**
|
|
1021
|
-
* Permanently revoke an active credential. Flips status to REVOKED, records revokedAt and revocationReason,
|
|
1019
|
+
* Permanently revoke an active credential. Flips status to REVOKED, records revokedAt and revocationReason, Appends a REVOKE proof to the credential, and emits a MANDATE_REVOKED activity event. Subsequent /vp and /verify calls for this credential are denied with reason credential_revoked.
|
|
1022
1020
|
* @summary Revoke Credential
|
|
1023
1021
|
* @param {string} credentialId URN of the credential to revoke
|
|
1024
1022
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -1031,7 +1029,7 @@ var CredentialsApi = class extends BaseAPI {
|
|
|
1031
1029
|
return CredentialsApiFp(this.configuration).revoke(credentialId, aPIVersion, revokeCredentialDto, options).then((request) => request(this.axios, this.basePath));
|
|
1032
1030
|
}
|
|
1033
1031
|
/**
|
|
1034
|
-
* Evaluate a VP against runtime context. On allow, returns
|
|
1032
|
+
* Evaluate a VP against runtime context. On allow, returns 201 with the signed receipt. On deny, returns 403 with the reason, evaluations, and receipt in the error body. If the mandate has no constraint schema, only signatures, verifier access, and validity are checked. Supply the presentation exactly as returned by POST /credential/vp/:vcId — do not re-serialize or modify it. Pass it as either `presentation` (the signed VP object) or `presentationEncoded` (its base64 string); at least one is required (400 otherwise), and if both are sent `presentationEncoded` wins. `presentationEncoded` is the recommended field: being an opaque string it is immune to JSON re-serialization / formatting changes (e.g. some HTTP clients reformatting date strings) that would otherwise break the signature.
|
|
1035
1033
|
* @summary Verify VP
|
|
1036
1034
|
* @param {VerifyPresentationDto} verifyPresentationDto
|
|
1037
1035
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -1291,7 +1289,7 @@ var RequestsApiAxiosParamCreator = function(configuration) {
|
|
|
1291
1289
|
};
|
|
1292
1290
|
},
|
|
1293
1291
|
/**
|
|
1294
|
-
* Resend a One-Time Password (OTP) to a subject for credential approval, via email or SMS
|
|
1292
|
+
* Resend a One-Time Password (OTP) to a subject for credential approval, via email or SMS. The endpoint validates: - The request is not canceled - Maximum attempts have not been reached, only successful OTP sends count towards resend limits - Sufficient time has passed since the last successful resend - Billing restrictions apply
|
|
1295
1293
|
* @summary Resend OTP
|
|
1296
1294
|
* @param {string} requestId Unique identifier of the request.
|
|
1297
1295
|
* @param {string} [contact] Verified contact value (email or phone)
|
|
@@ -1406,7 +1404,7 @@ var RequestsApiFp = function(configuration) {
|
|
|
1406
1404
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios7, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
1407
1405
|
},
|
|
1408
1406
|
/**
|
|
1409
|
-
* Resend a One-Time Password (OTP) to a subject for credential approval, via email or SMS
|
|
1407
|
+
* Resend a One-Time Password (OTP) to a subject for credential approval, via email or SMS. The endpoint validates: - The request is not canceled - Maximum attempts have not been reached, only successful OTP sends count towards resend limits - Sufficient time has passed since the last successful resend - Billing restrictions apply
|
|
1410
1408
|
* @summary Resend OTP
|
|
1411
1409
|
* @param {string} requestId Unique identifier of the request.
|
|
1412
1410
|
* @param {string} [contact] Verified contact value (email or phone)
|
|
@@ -1481,7 +1479,7 @@ var RequestsApiFactory = function(configuration, basePath, axios2) {
|
|
|
1481
1479
|
return localVarFp.list(pageIndex, pageSize, search, dateFrom, dateTo, subject, internalId, securityLevel, aPIVersion, options).then((request) => request(axios2, basePath));
|
|
1482
1480
|
},
|
|
1483
1481
|
/**
|
|
1484
|
-
* Resend a One-Time Password (OTP) to a subject for credential approval, via email or SMS
|
|
1482
|
+
* Resend a One-Time Password (OTP) to a subject for credential approval, via email or SMS. The endpoint validates: - The request is not canceled - Maximum attempts have not been reached, only successful OTP sends count towards resend limits - Sufficient time has passed since the last successful resend - Billing restrictions apply
|
|
1485
1483
|
* @summary Resend OTP
|
|
1486
1484
|
* @param {string} requestId Unique identifier of the request.
|
|
1487
1485
|
* @param {string} [contact] Verified contact value (email or phone)
|
|
@@ -1555,7 +1553,7 @@ var RequestsApi = class extends BaseAPI {
|
|
|
1555
1553
|
return RequestsApiFp(this.configuration).list(pageIndex, pageSize, search, dateFrom, dateTo, subject, internalId, securityLevel, aPIVersion, options).then((request) => request(this.axios, this.basePath));
|
|
1556
1554
|
}
|
|
1557
1555
|
/**
|
|
1558
|
-
* Resend a One-Time Password (OTP) to a subject for credential approval, via email or SMS
|
|
1556
|
+
* Resend a One-Time Password (OTP) to a subject for credential approval, via email or SMS. The endpoint validates: - The request is not canceled - Maximum attempts have not been reached, only successful OTP sends count towards resend limits - Sufficient time has passed since the last successful resend - Billing restrictions apply
|
|
1559
1557
|
* @summary Resend OTP
|
|
1560
1558
|
* @param {string} requestId Unique identifier of the request.
|
|
1561
1559
|
* @param {string} [contact] Verified contact value (email or phone)
|
|
@@ -1825,7 +1823,7 @@ var WebhooksApiAxiosParamCreator = function(configuration) {
|
|
|
1825
1823
|
};
|
|
1826
1824
|
},
|
|
1827
1825
|
/**
|
|
1828
|
-
* Fired when an OTP delivery to the
|
|
1826
|
+
* Fired when an OTP **SMS** could not be delivered: every eligible SMS provider was tried (synchronously or via carrier delivery reports) and none succeeded. Email OTP failures do not emit this event. Carrier delivery reports are asynchronous and occasionally corrected to \"delivered\" afterwards, so treat this event as *Humanos stopped retrying*, not as a guarantee the SMS never arrived. The safe reaction is to `PATCH` the `otp.resendEndpoint` URL exactly as delivered — a resend issues a fresh code and invalidates the old one, so it is harmless even if the original message did arrive late. **Inbound webhook callback** — Humanos POSTs this payload to your registered webhook URL. This is not an endpoint you call; it is documented as a path so SDK code generators emit a typed payload model.
|
|
1829
1827
|
* @summary OTP Failed Event
|
|
1830
1828
|
* @param {OtpFailedEvent} otpFailedEvent
|
|
1831
1829
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -1922,7 +1920,7 @@ var WebhooksApiFp = function(configuration) {
|
|
|
1922
1920
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios9, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
1923
1921
|
},
|
|
1924
1922
|
/**
|
|
1925
|
-
* Fired when an OTP delivery to the
|
|
1923
|
+
* Fired when an OTP **SMS** could not be delivered: every eligible SMS provider was tried (synchronously or via carrier delivery reports) and none succeeded. Email OTP failures do not emit this event. Carrier delivery reports are asynchronous and occasionally corrected to \"delivered\" afterwards, so treat this event as *Humanos stopped retrying*, not as a guarantee the SMS never arrived. The safe reaction is to `PATCH` the `otp.resendEndpoint` URL exactly as delivered — a resend issues a fresh code and invalidates the old one, so it is harmless even if the original message did arrive late. **Inbound webhook callback** — Humanos POSTs this payload to your registered webhook URL. This is not an endpoint you call; it is documented as a path so SDK code generators emit a typed payload model.
|
|
1926
1924
|
* @summary OTP Failed Event
|
|
1927
1925
|
* @param {OtpFailedEvent} otpFailedEvent
|
|
1928
1926
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -1977,7 +1975,7 @@ var WebhooksApiFactory = function(configuration, basePath, axios2) {
|
|
|
1977
1975
|
return localVarFp.identity(identityEvent, aPIVersion, options).then((request) => request(axios2, basePath));
|
|
1978
1976
|
},
|
|
1979
1977
|
/**
|
|
1980
|
-
* Fired when an OTP delivery to the
|
|
1978
|
+
* Fired when an OTP **SMS** could not be delivered: every eligible SMS provider was tried (synchronously or via carrier delivery reports) and none succeeded. Email OTP failures do not emit this event. Carrier delivery reports are asynchronous and occasionally corrected to \"delivered\" afterwards, so treat this event as *Humanos stopped retrying*, not as a guarantee the SMS never arrived. The safe reaction is to `PATCH` the `otp.resendEndpoint` URL exactly as delivered — a resend issues a fresh code and invalidates the old one, so it is harmless even if the original message did arrive late. **Inbound webhook callback** — Humanos POSTs this payload to your registered webhook URL. This is not an endpoint you call; it is documented as a path so SDK code generators emit a typed payload model.
|
|
1981
1979
|
* @summary OTP Failed Event
|
|
1982
1980
|
* @param {OtpFailedEvent} otpFailedEvent
|
|
1983
1981
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -2026,7 +2024,7 @@ var WebhooksApi = class extends BaseAPI {
|
|
|
2026
2024
|
return WebhooksApiFp(this.configuration).identity(identityEvent, aPIVersion, options).then((request) => request(this.axios, this.basePath));
|
|
2027
2025
|
}
|
|
2028
2026
|
/**
|
|
2029
|
-
* Fired when an OTP delivery to the
|
|
2027
|
+
* Fired when an OTP **SMS** could not be delivered: every eligible SMS provider was tried (synchronously or via carrier delivery reports) and none succeeded. Email OTP failures do not emit this event. Carrier delivery reports are asynchronous and occasionally corrected to \"delivered\" afterwards, so treat this event as *Humanos stopped retrying*, not as a guarantee the SMS never arrived. The safe reaction is to `PATCH` the `otp.resendEndpoint` URL exactly as delivered — a resend issues a fresh code and invalidates the old one, so it is harmless even if the original message did arrive late. **Inbound webhook callback** — Humanos POSTs this payload to your registered webhook URL. This is not an endpoint you call; it is documented as a path so SDK code generators emit a typed payload model.
|
|
2030
2028
|
* @summary OTP Failed Event
|
|
2031
2029
|
* @param {OtpFailedEvent} otpFailedEvent
|
|
2032
2030
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -2113,14 +2111,11 @@ var ActivityQueryTypeEnum = {
|
|
|
2113
2111
|
|
|
2114
2112
|
// generated/models/create-subject-entity.ts
|
|
2115
2113
|
var CreateSubjectEntityStatusEnum = {
|
|
2116
|
-
NUMBER_200: 200,
|
|
2117
2114
|
NUMBER_201: 201,
|
|
2118
2115
|
NUMBER_400: 400,
|
|
2119
|
-
NUMBER_402: 402,
|
|
2120
|
-
NUMBER_407: 407,
|
|
2121
|
-
NUMBER_408: 408,
|
|
2122
2116
|
NUMBER_409: 409,
|
|
2123
|
-
NUMBER_410: 410
|
|
2117
|
+
NUMBER_410: 410,
|
|
2118
|
+
NUMBER_500: 500
|
|
2124
2119
|
};
|
|
2125
2120
|
|
|
2126
2121
|
// generated/models/credential-dto.ts
|
|
@@ -2181,6 +2176,14 @@ var GenerateRequestDtoSecurityLevelEnum = {
|
|
|
2181
2176
|
HumanosRevalidation: "HUMANOS_REVALIDATION"
|
|
2182
2177
|
};
|
|
2183
2178
|
|
|
2179
|
+
// generated/models/generate-request-user-dto.ts
|
|
2180
|
+
var GenerateRequestUserDtoLanguageEnum = {
|
|
2181
|
+
Eng: "ENG",
|
|
2182
|
+
Prt: "PRT",
|
|
2183
|
+
Spa: "SPA",
|
|
2184
|
+
Fra: "FRA"
|
|
2185
|
+
};
|
|
2186
|
+
|
|
2184
2187
|
// generated/models/identity-event.ts
|
|
2185
2188
|
var IdentityEventEventTypeEnum = {
|
|
2186
2189
|
Identity: "identity"
|
|
@@ -2245,7 +2248,6 @@ var ResourceEntityTypeEnum = {
|
|
|
2245
2248
|
Form: "FORM",
|
|
2246
2249
|
Document: "DOCUMENT",
|
|
2247
2250
|
Json: "JSON",
|
|
2248
|
-
Payment: "PAYMENT",
|
|
2249
2251
|
Policy: "POLICY"
|
|
2250
2252
|
};
|
|
2251
2253
|
|
|
@@ -2255,7 +2257,6 @@ var ResourceMinimalEntityTypeEnum = {
|
|
|
2255
2257
|
Form: "FORM",
|
|
2256
2258
|
Document: "DOCUMENT",
|
|
2257
2259
|
Json: "JSON",
|
|
2258
|
-
Payment: "PAYMENT",
|
|
2259
2260
|
Policy: "POLICY"
|
|
2260
2261
|
};
|
|
2261
2262
|
|
|
@@ -2265,7 +2266,6 @@ var ResourceQueryTypesEnum = {
|
|
|
2265
2266
|
Form: "FORM",
|
|
2266
2267
|
Document: "DOCUMENT",
|
|
2267
2268
|
Json: "JSON",
|
|
2268
|
-
Payment: "PAYMENT",
|
|
2269
2269
|
Policy: "POLICY"
|
|
2270
2270
|
};
|
|
2271
2271
|
|
|
@@ -2342,7 +2342,7 @@ function applySignatureInterceptor(axiosInstance, signatureSecret) {
|
|
|
2342
2342
|
}
|
|
2343
2343
|
|
|
2344
2344
|
// src/client.ts
|
|
2345
|
-
var API_VERSION = "2026-
|
|
2345
|
+
var API_VERSION = "2026-07-07";
|
|
2346
2346
|
var SDK_LANGUAGE = "typescript";
|
|
2347
2347
|
var HumanosClient = class {
|
|
2348
2348
|
constructor(clientConfig) {
|
|
@@ -2491,6 +2491,7 @@ export {
|
|
|
2491
2491
|
DIDApiFp,
|
|
2492
2492
|
DeliveryActionType,
|
|
2493
2493
|
GenerateRequestDtoSecurityLevelEnum,
|
|
2494
|
+
GenerateRequestUserDtoLanguageEnum,
|
|
2494
2495
|
HumanosClient,
|
|
2495
2496
|
IdentityEventEventTypeEnum,
|
|
2496
2497
|
ListSecurityLevelEnum,
|
|
@@ -37,6 +37,7 @@ models/credential-event-decision.ts
|
|
|
37
37
|
models/credential-event-user.ts
|
|
38
38
|
models/credential-event.ts
|
|
39
39
|
models/credential-placement-dto.ts
|
|
40
|
+
models/credential-proof.ts
|
|
40
41
|
models/credential-status.ts
|
|
41
42
|
models/credentials-detail404-response.ts
|
|
42
43
|
models/credentials-evidence404-response.ts
|
|
@@ -51,6 +52,9 @@ models/evidence.ts
|
|
|
51
52
|
models/generate-credential-entity.ts
|
|
52
53
|
models/generate-request-dto.ts
|
|
53
54
|
models/generate-request-entity.ts
|
|
55
|
+
models/generate-request-iframe-cookie-dto.ts
|
|
56
|
+
models/generate-request-iframe-dto.ts
|
|
57
|
+
models/generate-request-user-dto.ts
|
|
54
58
|
models/generate-subject-entity.ts
|
|
55
59
|
models/group-entity.ts
|
|
56
60
|
models/groups-entity.ts
|
|
@@ -58,14 +62,19 @@ models/identity-dto.ts
|
|
|
58
62
|
models/identity-event-decision.ts
|
|
59
63
|
models/identity-event-user.ts
|
|
60
64
|
models/identity-event.ts
|
|
61
|
-
models/identity-
|
|
65
|
+
models/identity-webhook-issue-date.ts
|
|
66
|
+
models/identity-webhook.ts
|
|
62
67
|
models/index.ts
|
|
68
|
+
models/mandate-action.ts
|
|
69
|
+
models/mandate-context.ts
|
|
70
|
+
models/mandate-grantor.ts
|
|
71
|
+
models/mandate.ts
|
|
63
72
|
models/organization-data-entity.ts
|
|
64
73
|
models/otp-error.ts
|
|
65
74
|
models/otp-failed-event-otp.ts
|
|
66
75
|
models/otp-failed-event.ts
|
|
67
76
|
models/partial-subject-entity.ts
|
|
68
|
-
models/presentation-
|
|
77
|
+
models/presentation-entity.ts
|
|
69
78
|
models/receipt-entity.ts
|
|
70
79
|
models/request-credential-entity.ts
|
|
71
80
|
models/request-detail-entity.ts
|
|
@@ -74,6 +83,8 @@ models/request-entity.ts
|
|
|
74
83
|
models/request-query.ts
|
|
75
84
|
models/request-subject-entity.ts
|
|
76
85
|
models/requests-create400-response.ts
|
|
86
|
+
models/requests-create402-response.ts
|
|
87
|
+
models/requests-create409-response.ts
|
|
77
88
|
models/requests-detail404-response.ts
|
|
78
89
|
models/requests-entity.ts
|
|
79
90
|
models/requests-resend-otp403-response.ts
|
|
@@ -95,12 +106,7 @@ models/verify-allow-response-entity.ts
|
|
|
95
106
|
models/verify-deny-response-entity.ts
|
|
96
107
|
models/verify-evaluation-entity.ts
|
|
97
108
|
models/verify-presentation-dto.ts
|
|
98
|
-
models/w3-cverifiable-credential-credential-subject-mandate-action.ts
|
|
99
|
-
models/w3-cverifiable-credential-credential-subject-mandate-context.ts
|
|
100
|
-
models/w3-cverifiable-credential-credential-subject-mandate-grantor.ts
|
|
101
|
-
models/w3-cverifiable-credential-credential-subject-mandate.ts
|
|
102
109
|
models/w3-cverifiable-credential-credential-subject.ts
|
|
103
|
-
models/w3-cverifiable-credential-proofs-inner.ts
|
|
104
110
|
models/w3-cverifiable-credential.ts
|
|
105
111
|
models/webhook-call-event.ts
|
|
106
112
|
package.json
|
|
@@ -304,7 +304,6 @@ export const ListTypesEnum = {
|
|
|
304
304
|
Form: 'FORM',
|
|
305
305
|
Document: 'DOCUMENT',
|
|
306
306
|
Json: 'JSON',
|
|
307
|
-
Payment: 'PAYMENT',
|
|
308
307
|
Policy: 'POLICY'
|
|
309
308
|
} as const;
|
|
310
309
|
export type ListTypesEnum = typeof ListTypesEnum[keyof typeof ListTypesEnum];
|
|
@@ -316,7 +315,6 @@ export const WorkflowsTypesEnum = {
|
|
|
316
315
|
Form: 'FORM',
|
|
317
316
|
Document: 'DOCUMENT',
|
|
318
317
|
Json: 'JSON',
|
|
319
|
-
Payment: 'PAYMENT',
|
|
320
318
|
Policy: 'POLICY'
|
|
321
319
|
} as const;
|
|
322
320
|
export type WorkflowsTypesEnum = typeof WorkflowsTypesEnum[keyof typeof WorkflowsTypesEnum];
|