UNPKG

@affinidi-tdk/credential-issuance-client

Version:

Affinidi TDK typescript client for Affinidi CREDENTIAL ISSUANCE

1,665 lines 107 kB
/** * CredentialIssuanceService * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 1.0.0 * Contact: info@affinidi.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from './configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import type { RequestArgs } from './base'; import { BaseAPI } from './base'; /** * * @export * @interface ActionForbiddenError */ export interface ActionForbiddenError { /** * * @type {string} * @memberof ActionForbiddenError */ name: ActionForbiddenErrorNameEnum; /** * * @type {string} * @memberof ActionForbiddenError */ message: ActionForbiddenErrorMessageEnum; /** * * @type {number} * @memberof ActionForbiddenError */ httpStatusCode: ActionForbiddenErrorHttpStatusCodeEnum; /** * * @type {string} * @memberof ActionForbiddenError */ traceId: string; /** * * @type {Array<ActionForbiddenErrorDetailsInner>} * @memberof ActionForbiddenError */ details?: Array<ActionForbiddenErrorDetailsInner>; } export declare const ActionForbiddenErrorNameEnum: { readonly ActionForbiddenError: "ActionForbiddenError"; }; export type ActionForbiddenErrorNameEnum = (typeof ActionForbiddenErrorNameEnum)[keyof typeof ActionForbiddenErrorNameEnum]; export declare const ActionForbiddenErrorMessageEnum: { readonly PrincipalCanNotExecuteActionOnGivenResource: "Principal can not execute action on given resource"; }; export type ActionForbiddenErrorMessageEnum = (typeof ActionForbiddenErrorMessageEnum)[keyof typeof ActionForbiddenErrorMessageEnum]; export declare const ActionForbiddenErrorHttpStatusCodeEnum: { readonly NUMBER_403: 403; }; export type ActionForbiddenErrorHttpStatusCodeEnum = (typeof ActionForbiddenErrorHttpStatusCodeEnum)[keyof typeof ActionForbiddenErrorHttpStatusCodeEnum]; /** * * @export * @interface ActionForbiddenErrorDetailsInner */ export interface ActionForbiddenErrorDetailsInner { /** * * @type {string} * @memberof ActionForbiddenErrorDetailsInner */ issue: string; /** * * @type {string} * @memberof ActionForbiddenErrorDetailsInner */ field?: string; /** * * @type {string} * @memberof ActionForbiddenErrorDetailsInner */ value?: string; /** * * @type {string} * @memberof ActionForbiddenErrorDetailsInner */ location?: string; } /** * * @export * @interface BatchCredentialInput */ export interface BatchCredentialInput { /** * Array that contains Credential Request objects. * @type {Array<BatchCredentialInputCredentialRequestsInner>} * @memberof BatchCredentialInput */ credential_requests: Array<BatchCredentialInputCredentialRequestsInner>; } /** * * @export * @interface BatchCredentialInputCredentialRequestsInner */ export interface BatchCredentialInputCredentialRequestsInner { /** * It is a String that identifies a Credential that is being requested to be issued. * @type {string} * @memberof BatchCredentialInputCredentialRequestsInner */ credential_identifier?: string; /** * * @type {CredentialProof} * @memberof BatchCredentialInputCredentialRequestsInner */ proof: CredentialProof; } /** * * @export * @interface BatchCredentialResponse */ export interface BatchCredentialResponse { /** * * @type {Array<BatchCredentialResponseCredentialResponsesInner>} * @memberof BatchCredentialResponse */ credential_responses: Array<BatchCredentialResponseCredentialResponsesInner>; /** * * @type {string} * @memberof BatchCredentialResponse */ c_nonce?: string; /** * Expiration time in seconds * @type {number} * @memberof BatchCredentialResponse */ c_nonce_expires_in?: number; } /** * * @export * @interface BatchCredentialResponseCredentialResponsesInner */ export interface BatchCredentialResponseCredentialResponsesInner { /** * Issued Credential, It can be a string or an object, depending on the Credential format. default format is `ldp_vc`. * @type {any} * @memberof BatchCredentialResponseCredentialResponsesInner */ credential: any; } /** * @type ChangeCredentialStatus400Response * @export */ export type ChangeCredentialStatus400Response = ChangeStatusForbiddenError | InvalidParameterError; /** * * @export * @interface ChangeCredentialStatusInput */ export interface ChangeCredentialStatusInput { /** * reason for revocation * @type {string} * @memberof ChangeCredentialStatusInput */ changeReason?: ChangeCredentialStatusInputChangeReasonEnum; /** * * @type {string} * @memberof ChangeCredentialStatusInput */ issuanceRecordId?: string; } export declare const ChangeCredentialStatusInputChangeReasonEnum: { readonly InvalidCredential: "INVALID_CREDENTIAL"; readonly CompromisedIssuer: "COMPROMISED_ISSUER"; }; export type ChangeCredentialStatusInputChangeReasonEnum = (typeof ChangeCredentialStatusInputChangeReasonEnum)[keyof typeof ChangeCredentialStatusInputChangeReasonEnum]; /** * * @export * @interface ChangeStatusForbiddenError */ export interface ChangeStatusForbiddenError { /** * * @type {string} * @memberof ChangeStatusForbiddenError */ name: ChangeStatusForbiddenErrorNameEnum; /** * * @type {string} * @memberof ChangeStatusForbiddenError */ message: ChangeStatusForbiddenErrorMessageEnum; /** * * @type {number} * @memberof ChangeStatusForbiddenError */ httpStatusCode: ChangeStatusForbiddenErrorHttpStatusCodeEnum; /** * * @type {string} * @memberof ChangeStatusForbiddenError */ traceId: string; /** * * @type {Array<ActionForbiddenErrorDetailsInner>} * @memberof ChangeStatusForbiddenError */ details?: Array<ActionForbiddenErrorDetailsInner>; } export declare const ChangeStatusForbiddenErrorNameEnum: { readonly ChangeStatusForbiddenError: "ChangeStatusForbiddenError"; }; export type ChangeStatusForbiddenErrorNameEnum = (typeof ChangeStatusForbiddenErrorNameEnum)[keyof typeof ChangeStatusForbiddenErrorNameEnum]; export declare const ChangeStatusForbiddenErrorMessageEnum: { readonly RelatedVcStatusCannotBeChanged: "Related VC status cannot be changed"; }; export type ChangeStatusForbiddenErrorMessageEnum = (typeof ChangeStatusForbiddenErrorMessageEnum)[keyof typeof ChangeStatusForbiddenErrorMessageEnum]; export declare const ChangeStatusForbiddenErrorHttpStatusCodeEnum: { readonly NUMBER_400: 400; }; export type ChangeStatusForbiddenErrorHttpStatusCodeEnum = (typeof ChangeStatusForbiddenErrorHttpStatusCodeEnum)[keyof typeof ChangeStatusForbiddenErrorHttpStatusCodeEnum]; /** * Webhook setting to notify developers for claimed VC * @export * @interface CisConfigurationWebhookSetting */ export interface CisConfigurationWebhookSetting { /** * flag to enabled or disabled the webhook * @type {boolean} * @memberof CisConfigurationWebhookSetting */ enabled: boolean; /** * * @type {CisConfigurationWebhookSettingEndpoint} * @memberof CisConfigurationWebhookSetting */ endpoint?: CisConfigurationWebhookSettingEndpoint; } /** * * @export * @interface CisConfigurationWebhookSettingEndpoint */ export interface CisConfigurationWebhookSettingEndpoint { /** * url endpoint where notification will be sent with issuanceId after user has claimed the VC related to issuanceId * @type {string} * @memberof CisConfigurationWebhookSettingEndpoint */ url?: string; } /** * List of claimed credential * @export * @interface ClaimedCredentialListResponse */ export interface ClaimedCredentialListResponse { /** * list of credentials * @type {Array<{ [key: string]: any; }>} * @memberof ClaimedCredentialListResponse */ credentials?: Array<{ [key: string]: any; }>; /** * for pagination to fetch next set of records * @type {string} * @memberof ClaimedCredentialListResponse */ lastEvaluatedKey?: string; } /** * Response for getting the claimed VC * @export * @interface ClaimedCredentialResponse */ export interface ClaimedCredentialResponse { /** * claimed credential for a single issuance * @type {{ [key: string]: any; }} * @memberof ClaimedCredentialResponse * @deprecated */ credential?: { [key: string]: any; }; /** * claimed credentials for batch issuances * @type {Array<{ [key: string]: any; }>} * @memberof ClaimedCredentialResponse */ credentials?: Array<{ [key: string]: any; }>; } /** * * @export * @interface CreateCredentialInput */ export interface CreateCredentialInput { /** * It is a String that identifies a Credential that is being requested to be issued. * @type {string} * @memberof CreateCredentialInput */ credential_identifier?: string; /** * * @type {CredentialProof} * @memberof CreateCredentialInput */ proof: CredentialProof; } /** * @type CreateIssuanceConfig400Response * @export */ export type CreateIssuanceConfig400Response = InvalidIssuerWalletError | ProjectCredentialConfigExistError | ProjectCredentialConfigNotExistError; /** * * @export * @interface CreateIssuanceConfigInput */ export interface CreateIssuanceConfigInput { /** * * @type {string} * @memberof CreateIssuanceConfigInput */ name?: string; /** * * @type {string} * @memberof CreateIssuanceConfigInput */ description?: string; /** * Issuer Wallet id * @type {string} * @memberof CreateIssuanceConfigInput */ issuerWalletId: string; /** * credential offer duration in second * @type {number} * @memberof CreateIssuanceConfigInput */ credentialOfferDuration?: number; /** * String identifying the format of this Credential, i.e., ldp_vc. Depending on the format value, the object contains further elements defining the type * @type {string} * @memberof CreateIssuanceConfigInput */ format?: CreateIssuanceConfigInputFormatEnum; /** * * @type {Array<CredentialSupportedObject>} * @memberof CreateIssuanceConfigInput */ credentialSupported: Array<CredentialSupportedObject>; /** * Issuer public information wallet may want to show to user during consent confirmation * @type {{ [key: string]: any; }} * @memberof CreateIssuanceConfigInput */ issuerMetadata?: { [key: string]: any; }; /** * List of allowed URIs to be returned to after issuance * @type {Array<string>} * @memberof CreateIssuanceConfigInput */ returnUris?: Array<string>; /** * * @type {CisConfigurationWebhookSetting} * @memberof CreateIssuanceConfigInput */ webhook?: CisConfigurationWebhookSetting; } export declare const CreateIssuanceConfigInputFormatEnum: { readonly LdpVc: "ldp_vc"; readonly JwtVcJsonLd: "jwt_vc_json-ld"; readonly SdJwtVcJsonLd: "sd_jwt_vc_json-ld"; }; export type CreateIssuanceConfigInputFormatEnum = (typeof CreateIssuanceConfigInputFormatEnum)[keyof typeof CreateIssuanceConfigInputFormatEnum]; /** * * @export * @interface CredentialIssuanceIdExistError */ export interface CredentialIssuanceIdExistError { /** * * @type {string} * @memberof CredentialIssuanceIdExistError */ name: CredentialIssuanceIdExistErrorNameEnum; /** * * @type {string} * @memberof CredentialIssuanceIdExistError */ message: CredentialIssuanceIdExistErrorMessageEnum; /** * * @type {number} * @memberof CredentialIssuanceIdExistError */ httpStatusCode: CredentialIssuanceIdExistErrorHttpStatusCodeEnum; /** * * @type {string} * @memberof CredentialIssuanceIdExistError */ traceId: string; /** * * @type {Array<ActionForbiddenErrorDetailsInner>} * @memberof CredentialIssuanceIdExistError */ details?: Array<ActionForbiddenErrorDetailsInner>; } export declare const CredentialIssuanceIdExistErrorNameEnum: { readonly CredentialIssuanceIdExistError: "CredentialIssuanceIdExistError"; }; export type CredentialIssuanceIdExistErrorNameEnum = (typeof CredentialIssuanceIdExistErrorNameEnum)[keyof typeof CredentialIssuanceIdExistErrorNameEnum]; export declare const CredentialIssuanceIdExistErrorMessageEnum: { readonly IssuanceIdExistForTheProjectPleaseUseDifferentIssuanceId: "issuanceId exist for the project, please use different issuanceId"; }; export type CredentialIssuanceIdExistErrorMessageEnum = (typeof CredentialIssuanceIdExistErrorMessageEnum)[keyof typeof CredentialIssuanceIdExistErrorMessageEnum]; export declare const CredentialIssuanceIdExistErrorHttpStatusCodeEnum: { readonly NUMBER_400: 400; }; export type CredentialIssuanceIdExistErrorHttpStatusCodeEnum = (typeof CredentialIssuanceIdExistErrorHttpStatusCodeEnum)[keyof typeof CredentialIssuanceIdExistErrorHttpStatusCodeEnum]; /** * * @export * @interface CredentialOfferClaimedError */ export interface CredentialOfferClaimedError { /** * * @type {string} * @memberof CredentialOfferClaimedError */ name: CredentialOfferClaimedErrorNameEnum; /** * * @type {string} * @memberof CredentialOfferClaimedError */ message: CredentialOfferClaimedErrorMessageEnum; /** * * @type {number} * @memberof CredentialOfferClaimedError */ httpStatusCode: CredentialOfferClaimedErrorHttpStatusCodeEnum; /** * * @type {string} * @memberof CredentialOfferClaimedError */ traceId: string; /** * * @type {Array<ActionForbiddenErrorDetailsInner>} * @memberof CredentialOfferClaimedError */ details?: Array<ActionForbiddenErrorDetailsInner>; } export declare const CredentialOfferClaimedErrorNameEnum: { readonly CredentialOfferClaimedError: "CredentialOfferClaimedError"; }; export type CredentialOfferClaimedErrorNameEnum = (typeof CredentialOfferClaimedErrorNameEnum)[keyof typeof CredentialOfferClaimedErrorNameEnum]; export declare const CredentialOfferClaimedErrorMessageEnum: { readonly CredentialOfferIsAlreadyClaimed: "Credential offer is already claimed"; }; export type CredentialOfferClaimedErrorMessageEnum = (typeof CredentialOfferClaimedErrorMessageEnum)[keyof typeof CredentialOfferClaimedErrorMessageEnum]; export declare const CredentialOfferClaimedErrorHttpStatusCodeEnum: { readonly NUMBER_400: 400; }; export type CredentialOfferClaimedErrorHttpStatusCodeEnum = (typeof CredentialOfferClaimedErrorHttpStatusCodeEnum)[keyof typeof CredentialOfferClaimedErrorHttpStatusCodeEnum]; /** * * @export * @interface CredentialOfferExpiredError */ export interface CredentialOfferExpiredError { /** * * @type {string} * @memberof CredentialOfferExpiredError */ name: CredentialOfferExpiredErrorNameEnum; /** * * @type {string} * @memberof CredentialOfferExpiredError */ message: CredentialOfferExpiredErrorMessageEnum; /** * * @type {number} * @memberof CredentialOfferExpiredError */ httpStatusCode: CredentialOfferExpiredErrorHttpStatusCodeEnum; /** * * @type {string} * @memberof CredentialOfferExpiredError */ traceId: string; /** * * @type {Array<ActionForbiddenErrorDetailsInner>} * @memberof CredentialOfferExpiredError */ details?: Array<ActionForbiddenErrorDetailsInner>; } export declare const CredentialOfferExpiredErrorNameEnum: { readonly CredentialOfferExpiredError: "CredentialOfferExpiredError"; }; export type CredentialOfferExpiredErrorNameEnum = (typeof CredentialOfferExpiredErrorNameEnum)[keyof typeof CredentialOfferExpiredErrorNameEnum]; export declare const CredentialOfferExpiredErrorMessageEnum: { readonly CredentialOfferIsExpired: "Credential offer is expired"; }; export type CredentialOfferExpiredErrorMessageEnum = (typeof CredentialOfferExpiredErrorMessageEnum)[keyof typeof CredentialOfferExpiredErrorMessageEnum]; export declare const CredentialOfferExpiredErrorHttpStatusCodeEnum: { readonly NUMBER_400: 400; }; export type CredentialOfferExpiredErrorHttpStatusCodeEnum = (typeof CredentialOfferExpiredErrorHttpStatusCodeEnum)[keyof typeof CredentialOfferExpiredErrorHttpStatusCodeEnum]; /** * * @export * @interface CredentialOfferResponse */ export interface CredentialOfferResponse { /** * The URL of the Credential Issuer * @type {string} * @memberof CredentialOfferResponse */ credential_issuer: string; /** * Array of unique strings that each identify one of the keys in the name/value pairs stored in the credentialSupported * @type {Array<string>} * @memberof CredentialOfferResponse */ credential_configuration_ids: Array<string>; /** * * @type {CredentialOfferResponseGrants} * @memberof CredentialOfferResponse */ grants: CredentialOfferResponseGrants; } /** * Object indicating to the Wallet the Grant Types the Credential Issuer\'s Authorization Server is prepared to process for this Credential Offer. * @export * @interface CredentialOfferResponseGrants */ export interface CredentialOfferResponseGrants { /** * * @type {CredentialOfferResponseGrantsUrnIetfParamsOauthGrantTypePreAuthorizedCode} * @memberof CredentialOfferResponseGrants */ 'urn:ietf:params:oauth:grant-type:pre-authorized_code': CredentialOfferResponseGrantsUrnIetfParamsOauthGrantTypePreAuthorizedCode; } /** * Grant type for `pre-authorized_code` flow * @export * @interface CredentialOfferResponseGrantsUrnIetfParamsOauthGrantTypePreAuthorizedCode */ export interface CredentialOfferResponseGrantsUrnIetfParamsOauthGrantTypePreAuthorizedCode { /** * pre authorized code to be exchanged with jwt token * @type {string} * @memberof CredentialOfferResponseGrantsUrnIetfParamsOauthGrantTypePreAuthorizedCode */ 'pre-authorized_code': string; /** * * @type {CredentialOfferResponseGrantsUrnIetfParamsOauthGrantTypePreAuthorizedCodeTxCode} * @memberof CredentialOfferResponseGrantsUrnIetfParamsOauthGrantTypePreAuthorizedCode */ tx_code?: CredentialOfferResponseGrantsUrnIetfParamsOauthGrantTypePreAuthorizedCodeTxCode; } /** * Object specifying whether the Authorization Server expects presentation of a Transaction Code by the End-User along with the Token Request in a Pre-Authorized Code Flow * @export * @interface CredentialOfferResponseGrantsUrnIetfParamsOauthGrantTypePreAuthorizedCodeTxCode */ export interface CredentialOfferResponseGrantsUrnIetfParamsOauthGrantTypePreAuthorizedCodeTxCode { /** * Integer specifying the length of the Transaction Code * @type {number} * @memberof CredentialOfferResponseGrantsUrnIetfParamsOauthGrantTypePreAuthorizedCodeTxCode */ length?: number; /** * String specifying the input character set. Possible values are numeric (only digits) and text (any characters). * @type {string} * @memberof CredentialOfferResponseGrantsUrnIetfParamsOauthGrantTypePreAuthorizedCodeTxCode */ input_mode?: string; /** * String containing guidance for the Holder of the Wallet on how to obtain the Transaction Code * @type {string} * @memberof CredentialOfferResponseGrantsUrnIetfParamsOauthGrantTypePreAuthorizedCodeTxCode */ description?: string; } /** * Object containing the proof of possession of the cryptographic key material the issued Credential would be bound to. * @export * @interface CredentialProof */ export interface CredentialProof { /** * String denoting the key proof type. * @type {string} * @memberof CredentialProof */ proof_type: CredentialProofProofTypeEnum; /** * * @type {string} * @memberof CredentialProof */ jwt: string; } export declare const CredentialProofProofTypeEnum: { readonly Jwt: "jwt"; }; export type CredentialProofProofTypeEnum = (typeof CredentialProofProofTypeEnum)[keyof typeof CredentialProofProofTypeEnum]; /** * @type CredentialResponse * @export */ export type CredentialResponse = CredentialResponseDeferred | CredentialResponseImmediate; /** * * @export * @interface CredentialResponseDeferred */ export interface CredentialResponseDeferred { /** * String identifying a Deferred Issuance transaction. This claim is contained in the response if the Credential Issuer was unable to immediately issue the Credential. * @type {string} * @memberof CredentialResponseDeferred */ transaction_id: string; /** * String containing a nonce to be used when creating a proof of possession of the key proof * @type {string} * @memberof CredentialResponseDeferred */ c_nonce: string; /** * Lifetime in seconds of the c_nonce * @type {number} * @memberof CredentialResponseDeferred */ c_nonce_expires_in: number; } /** * * @export * @interface CredentialResponseImmediate */ export interface CredentialResponseImmediate { /** * * @type {CredentialResponseImmediateCredential} * @memberof CredentialResponseImmediate */ credential: CredentialResponseImmediateCredential; /** * String containing a nonce to be used when creating a proof of possession of the key proof * @type {string} * @memberof CredentialResponseImmediate */ c_nonce: string; /** * * @type {CredentialResponseImmediateCNonceExpiresIn} * @memberof CredentialResponseImmediate */ c_nonce_expires_in: CredentialResponseImmediateCNonceExpiresIn; } /** * @type CredentialResponseImmediateCNonceExpiresIn * @export */ export type CredentialResponseImmediateCNonceExpiresIn = number | string; /** * @type CredentialResponseImmediateCredential * @export */ export type CredentialResponseImmediateCredential = string | { [key: string]: any; }; /** * * @export * @interface CredentialSubjectNotValidError */ export interface CredentialSubjectNotValidError { /** * * @type {string} * @memberof CredentialSubjectNotValidError */ name: CredentialSubjectNotValidErrorNameEnum; /** * * @type {string} * @memberof CredentialSubjectNotValidError */ message: CredentialSubjectNotValidErrorMessageEnum; /** * * @type {number} * @memberof CredentialSubjectNotValidError */ httpStatusCode: CredentialSubjectNotValidErrorHttpStatusCodeEnum; /** * * @type {string} * @memberof CredentialSubjectNotValidError */ traceId: string; /** * * @type {Array<ActionForbiddenErrorDetailsInner>} * @memberof CredentialSubjectNotValidError */ details?: Array<ActionForbiddenErrorDetailsInner>; } export declare const CredentialSubjectNotValidErrorNameEnum: { readonly CredentialSubjectNotValidError: "CredentialSubjectNotValidError"; }; export type CredentialSubjectNotValidErrorNameEnum = (typeof CredentialSubjectNotValidErrorNameEnum)[keyof typeof CredentialSubjectNotValidErrorNameEnum]; export declare const CredentialSubjectNotValidErrorMessageEnum: { readonly CredentialSubjectIsNotAccordingToTheVcSchema: "Credential subject is not according to the vc schema"; }; export type CredentialSubjectNotValidErrorMessageEnum = (typeof CredentialSubjectNotValidErrorMessageEnum)[keyof typeof CredentialSubjectNotValidErrorMessageEnum]; export declare const CredentialSubjectNotValidErrorHttpStatusCodeEnum: { readonly NUMBER_400: 400; }; export type CredentialSubjectNotValidErrorHttpStatusCodeEnum = (typeof CredentialSubjectNotValidErrorHttpStatusCodeEnum)[keyof typeof CredentialSubjectNotValidErrorHttpStatusCodeEnum]; /** * * @export * @interface CredentialSupportedObject */ export interface CredentialSupportedObject { /** * It is a String that identifies a Credential that is being requested to be issued. * @type {string} * @memberof CredentialSupportedObject */ credentialTypeId: string; /** * credential jsonLdContextUrl * @type {string} * @memberof CredentialSupportedObject */ jsonSchemaUrl: string; /** * credential jsonSchemaUrl * @type {string} * @memberof CredentialSupportedObject */ jsonLdContextUrl: string; /** * * @type {SupportedCredentialMetadata} * @memberof CredentialSupportedObject */ metadata?: SupportedCredentialMetadata; } /** * * @export * @interface FlowData */ export interface FlowData { /** * [GEN] ISO 8601 string of the creation date/time the entity * @type {string} * @memberof FlowData */ createdAt: string; /** * [GEN] ISO 8601 string of the modification date/time the entity * @type {string} * @memberof FlowData */ modifiedAt: string; /** * * @type {string} * @memberof FlowData */ id: string; /** * * @type {string} * @memberof FlowData */ projectId?: string; /** * * @type {string} * @memberof FlowData */ flowId: string; /** * * @type {string} * @memberof FlowData */ credentialTypeId: string; /** * * @type {string} * @memberof FlowData */ jsonLdContextUrl: string; /** * * @type {string} * @memberof FlowData */ jsonSchemaUrl: string; /** * Id of configuration, used to issue VC. * @type {string} * @memberof FlowData */ configurationId?: string; /** * when credential was issued to the holder (holder invoked generateCredentials endpoint) * @type {string} * @memberof FlowData */ issuedAt?: string; /** * Id of wallet, used to issue VC. * @type {string} * @memberof FlowData */ walletId?: string; /** * Id of configuration with which VC was issued. To use as an index, it is grouped together with projectId, as \"{projectIdConfigurationId}#{configurationId}\" * @type {string} * @memberof FlowData */ projectIdConfigurationId?: string; /** * Id of wallet which issued VC. To use as an index, it is grouped together with projectId, as \"{projectIdConfigurationId}#{walletId}\" * @type {string} * @memberof FlowData */ projectIdConfigurationIdWalletId?: string; /** * VC.type value. To use as an index, it is grouped together with projectId, as \"{projectIdConfigurationId}#{credentialType}\" * @type {string} * @memberof FlowData */ projectIdConfigurationIdCredentialType?: string; /** * * @type {Array<FlowDataStatusListsDetailsInner>} * @memberof FlowData */ statusListsDetails?: Array<FlowDataStatusListsDetailsInner>; } /** * * @export * @interface FlowDataStatusListsDetailsInner */ export interface FlowDataStatusListsDetailsInner { /** * Purpose of status list to which credential is added * @type {string} * @memberof FlowDataStatusListsDetailsInner */ statusListPurpose: FlowDataStatusListsDetailsInnerStatusListPurposeEnum; /** * id of status list * @type {string} * @memberof FlowDataStatusListsDetailsInner */ statusListId: string; /** * as usual it is a number, but all standards use a string * @type {string} * @memberof FlowDataStatusListsDetailsInner */ statusListIndex: string; /** * * @type {string} * @memberof FlowDataStatusListsDetailsInner */ standard: FlowDataStatusListsDetailsInnerStandardEnum; /** * indicates status is true or not. Default false. * @type {boolean} * @memberof FlowDataStatusListsDetailsInner */ isActive: boolean; /** * text reasoning why the status is true (if true). Optional. * @type {string} * @memberof FlowDataStatusListsDetailsInner */ statusActivationReason?: string; /** * ISO 8601 string of the modification date/time the status. Optional. * @type {string} * @memberof FlowDataStatusListsDetailsInner */ statusActivatedAt?: string; } export declare const FlowDataStatusListsDetailsInnerStatusListPurposeEnum: { readonly Revoked: "REVOKED"; }; export type FlowDataStatusListsDetailsInnerStatusListPurposeEnum = (typeof FlowDataStatusListsDetailsInnerStatusListPurposeEnum)[keyof typeof FlowDataStatusListsDetailsInnerStatusListPurposeEnum]; export declare const FlowDataStatusListsDetailsInnerStandardEnum: { readonly RevocationList2020: "RevocationList2020"; }; export type FlowDataStatusListsDetailsInnerStandardEnum = (typeof FlowDataStatusListsDetailsInnerStandardEnum)[keyof typeof FlowDataStatusListsDetailsInnerStandardEnum]; /** * @type GenerateCredentials400Response * @export */ export type GenerateCredentials400Response = InvalidCredentialRequestError | InvalidProofError; /** * @type GetCredentialOffer400Response * @export */ export type GetCredentialOffer400Response = CredentialOfferClaimedError | CredentialOfferExpiredError | InvalidParameterError | ProjectCredentialConfigNotExistError | VcClaimedError; /** * * @export * @interface InvalidCredentialRequestError */ export interface InvalidCredentialRequestError { /** * * @type {string} * @memberof InvalidCredentialRequestError */ name: InvalidCredentialRequestErrorNameEnum; /** * * @type {string} * @memberof InvalidCredentialRequestError */ message: InvalidCredentialRequestErrorMessageEnum; /** * * @type {number} * @memberof InvalidCredentialRequestError */ httpStatusCode: InvalidCredentialRequestErrorHttpStatusCodeEnum; /** * * @type {string} * @memberof InvalidCredentialRequestError */ traceId: string; /** * * @type {Array<ActionForbiddenErrorDetailsInner>} * @memberof InvalidCredentialRequestError */ details?: Array<ActionForbiddenErrorDetailsInner>; } export declare const InvalidCredentialRequestErrorNameEnum: { readonly InvalidCredentialRequestError: "InvalidCredentialRequestError"; }; export type InvalidCredentialRequestErrorNameEnum = (typeof InvalidCredentialRequestErrorNameEnum)[keyof typeof InvalidCredentialRequestErrorNameEnum]; export declare const InvalidCredentialRequestErrorMessageEnum: { readonly CredentialRequestIsInvalid: "Credential Request is invalid"; }; export type InvalidCredentialRequestErrorMessageEnum = (typeof InvalidCredentialRequestErrorMessageEnum)[keyof typeof InvalidCredentialRequestErrorMessageEnum]; export declare const InvalidCredentialRequestErrorHttpStatusCodeEnum: { readonly NUMBER_400: 400; }; export type InvalidCredentialRequestErrorHttpStatusCodeEnum = (typeof InvalidCredentialRequestErrorHttpStatusCodeEnum)[keyof typeof InvalidCredentialRequestErrorHttpStatusCodeEnum]; /** * * @export * @interface InvalidCredentialTypeError */ export interface InvalidCredentialTypeError { /** * * @type {string} * @memberof InvalidCredentialTypeError */ name: InvalidCredentialTypeErrorNameEnum; /** * * @type {string} * @memberof InvalidCredentialTypeError */ message: InvalidCredentialTypeErrorMessageEnum; /** * * @type {number} * @memberof InvalidCredentialTypeError */ httpStatusCode: InvalidCredentialTypeErrorHttpStatusCodeEnum; /** * * @type {string} * @memberof InvalidCredentialTypeError */ traceId: string; /** * * @type {Array<ActionForbiddenErrorDetailsInner>} * @memberof InvalidCredentialTypeError */ details?: Array<ActionForbiddenErrorDetailsInner>; } export declare const InvalidCredentialTypeErrorNameEnum: { readonly InvalidCredentialTypeError: "InvalidCredentialTypeError"; }; export type InvalidCredentialTypeErrorNameEnum = (typeof InvalidCredentialTypeErrorNameEnum)[keyof typeof InvalidCredentialTypeErrorNameEnum]; export declare const InvalidCredentialTypeErrorMessageEnum: { readonly TheRequestedCredentialTypeIsNotSupported: "The requested credential type is not supported"; }; export type InvalidCredentialTypeErrorMessageEnum = (typeof InvalidCredentialTypeErrorMessageEnum)[keyof typeof InvalidCredentialTypeErrorMessageEnum]; export declare const InvalidCredentialTypeErrorHttpStatusCodeEnum: { readonly NUMBER_400: 400; }; export type InvalidCredentialTypeErrorHttpStatusCodeEnum = (typeof InvalidCredentialTypeErrorHttpStatusCodeEnum)[keyof typeof InvalidCredentialTypeErrorHttpStatusCodeEnum]; /** * * @export * @interface InvalidIssuerWalletError */ export interface InvalidIssuerWalletError { /** * * @type {string} * @memberof InvalidIssuerWalletError */ name: InvalidIssuerWalletErrorNameEnum; /** * * @type {string} * @memberof InvalidIssuerWalletError */ message: InvalidIssuerWalletErrorMessageEnum; /** * * @type {number} * @memberof InvalidIssuerWalletError */ httpStatusCode: InvalidIssuerWalletErrorHttpStatusCodeEnum; /** * * @type {string} * @memberof InvalidIssuerWalletError */ traceId: string; /** * * @type {Array<ActionForbiddenErrorDetailsInner>} * @memberof InvalidIssuerWalletError */ details?: Array<ActionForbiddenErrorDetailsInner>; } export declare const InvalidIssuerWalletErrorNameEnum: { readonly InvalidIssuerWalletError: "InvalidIssuerWalletError"; }; export type InvalidIssuerWalletErrorNameEnum = (typeof InvalidIssuerWalletErrorNameEnum)[keyof typeof InvalidIssuerWalletErrorNameEnum]; export declare const InvalidIssuerWalletErrorMessageEnum: { readonly IssuerWalletIdIsInvalid: "issuer wallet id is invalid"; }; export type InvalidIssuerWalletErrorMessageEnum = (typeof InvalidIssuerWalletErrorMessageEnum)[keyof typeof InvalidIssuerWalletErrorMessageEnum]; export declare const InvalidIssuerWalletErrorHttpStatusCodeEnum: { readonly NUMBER_400: 400; }; export type InvalidIssuerWalletErrorHttpStatusCodeEnum = (typeof InvalidIssuerWalletErrorHttpStatusCodeEnum)[keyof typeof InvalidIssuerWalletErrorHttpStatusCodeEnum]; /** * * @export * @interface InvalidJwtTokenError */ export interface InvalidJwtTokenError { /** * * @type {string} * @memberof InvalidJwtTokenError */ name: InvalidJwtTokenErrorNameEnum; /** * * @type {string} * @memberof InvalidJwtTokenError */ message: InvalidJwtTokenErrorMessageEnum; /** * * @type {number} * @memberof InvalidJwtTokenError */ httpStatusCode: InvalidJwtTokenErrorHttpStatusCodeEnum; /** * * @type {string} * @memberof InvalidJwtTokenError */ traceId: string; /** * * @type {Array<ActionForbiddenErrorDetailsInner>} * @memberof InvalidJwtTokenError */ details?: Array<ActionForbiddenErrorDetailsInner>; } export declare const InvalidJwtTokenErrorNameEnum: { readonly InvalidJwtTokenError: "InvalidJwtTokenError"; }; export type InvalidJwtTokenErrorNameEnum = (typeof InvalidJwtTokenErrorNameEnum)[keyof typeof InvalidJwtTokenErrorNameEnum]; export declare const InvalidJwtTokenErrorMessageEnum: { readonly JwtTokenIsInvalid: "JWT token is invalid"; }; export type InvalidJwtTokenErrorMessageEnum = (typeof InvalidJwtTokenErrorMessageEnum)[keyof typeof InvalidJwtTokenErrorMessageEnum]; export declare const InvalidJwtTokenErrorHttpStatusCodeEnum: { readonly NUMBER_401: 401; }; export type InvalidJwtTokenErrorHttpStatusCodeEnum = (typeof InvalidJwtTokenErrorHttpStatusCodeEnum)[keyof typeof InvalidJwtTokenErrorHttpStatusCodeEnum]; /** * * @export * @interface InvalidParameterError */ export interface InvalidParameterError { /** * * @type {string} * @memberof InvalidParameterError */ name: InvalidParameterErrorNameEnum; /** * * @type {string} * @memberof InvalidParameterError */ message: InvalidParameterErrorMessageEnum; /** * * @type {number} * @memberof InvalidParameterError */ httpStatusCode: InvalidParameterErrorHttpStatusCodeEnum; /** * * @type {string} * @memberof InvalidParameterError */ traceId: string; /** * * @type {Array<ActionForbiddenErrorDetailsInner>} * @memberof InvalidParameterError */ details?: Array<ActionForbiddenErrorDetailsInner>; } export declare const InvalidParameterErrorNameEnum: { readonly InvalidParameterError: "InvalidParameterError"; }; export type InvalidParameterErrorNameEnum = (typeof InvalidParameterErrorNameEnum)[keyof typeof InvalidParameterErrorNameEnum]; export declare const InvalidParameterErrorMessageEnum: { readonly InvalidParameterParam: "Invalid parameter: ${param}."; }; export type InvalidParameterErrorMessageEnum = (typeof InvalidParameterErrorMessageEnum)[keyof typeof InvalidParameterErrorMessageEnum]; export declare const InvalidParameterErrorHttpStatusCodeEnum: { readonly NUMBER_400: 400; }; export type InvalidParameterErrorHttpStatusCodeEnum = (typeof InvalidParameterErrorHttpStatusCodeEnum)[keyof typeof InvalidParameterErrorHttpStatusCodeEnum]; /** * * @export * @interface InvalidProofError */ export interface InvalidProofError { /** * * @type {string} * @memberof InvalidProofError */ name: InvalidProofErrorNameEnum; /** * * @type {string} * @memberof InvalidProofError */ message: InvalidProofErrorMessageEnum; /** * * @type {number} * @memberof InvalidProofError */ httpStatusCode: InvalidProofErrorHttpStatusCodeEnum; /** * * @type {string} * @memberof InvalidProofError */ traceId: string; /** * * @type {Array<ActionForbiddenErrorDetailsInner>} * @memberof InvalidProofError */ details?: Array<ActionForbiddenErrorDetailsInner>; } export declare const InvalidProofErrorNameEnum: { readonly InvalidProofError: "InvalidProofError"; }; export type InvalidProofErrorNameEnum = (typeof InvalidProofErrorNameEnum)[keyof typeof InvalidProofErrorNameEnum]; export declare const InvalidProofErrorMessageEnum: { readonly TheProofInTheCredentialRequestIsInvalid: "The proof in the Credential Request is invalid"; }; export type InvalidProofErrorMessageEnum = (typeof InvalidProofErrorMessageEnum)[keyof typeof InvalidProofErrorMessageEnum]; export declare const InvalidProofErrorHttpStatusCodeEnum: { readonly NUMBER_400: 400; }; export type InvalidProofErrorHttpStatusCodeEnum = (typeof InvalidProofErrorHttpStatusCodeEnum)[keyof typeof InvalidProofErrorHttpStatusCodeEnum]; /** * * @export * @interface IssuanceConfigDto */ export interface IssuanceConfigDto { /** * * @type {string} * @memberof IssuanceConfigDto */ id?: string; /** * * @type {string} * @memberof IssuanceConfigDto */ name?: string; /** * * @type {string} * @memberof IssuanceConfigDto */ description?: string; /** * Issuer DID * @type {string} * @memberof IssuanceConfigDto */ issuerDid?: string; /** * Issuer Wallet id * @type {string} * @memberof IssuanceConfigDto */ issuerWalletId?: string; /** * credential offer duration in second * @type {number} * @memberof IssuanceConfigDto */ credentialOfferDuration?: number; /** * c_nonce duration in second * @type {number} * @memberof IssuanceConfigDto */ cNonceDuration?: number; /** * String identifying the format of this Credential, i.e., jwt_vc_json-ld or ldp_vc. Depending on the format value, the object contains further elements defining the type * @type {string} * @memberof IssuanceConfigDto */ format?: IssuanceConfigDtoFormatEnum; /** * Issuer URI * @type {string} * @memberof IssuanceConfigDto */ issuerUri?: string; /** * * @type {Array<CredentialSupportedObject>} * @memberof IssuanceConfigDto */ credentialSupported?: Array<CredentialSupportedObject>; /** * Issuer public information wallet may want to show to user during consent confirmation * @type {{ [key: string]: any; }} * @memberof IssuanceConfigDto */ issuerMetadata?: { [key: string]: any; }; /** * * @type {number} * @memberof IssuanceConfigDto */ version?: number; /** * List of allowed URIs to be returned to after issuance * @type {Array<string>} * @memberof IssuanceConfigDto */ returnUris?: Array<string>; /** * * @type {CisConfigurationWebhookSetting} * @memberof IssuanceConfigDto */ webhook?: CisConfigurationWebhookSetting; } export declare const IssuanceConfigDtoFormatEnum: { readonly LdpVc: "ldp_vc"; readonly JwtVcJsonLd: "jwt_vc_json-ld"; readonly SdJwtVcJsonLd: "sd_jwt_vc_json-ld"; }; export type IssuanceConfigDtoFormatEnum = (typeof IssuanceConfigDtoFormatEnum)[keyof typeof IssuanceConfigDtoFormatEnum]; /** * * @export * @interface IssuanceConfigListResponse */ export interface IssuanceConfigListResponse { /** * * @type {Array<IssuanceConfigMiniDto>} * @memberof IssuanceConfigListResponse */ configurations: Array<IssuanceConfigMiniDto>; } /** * * @export * @interface IssuanceConfigMiniDto */ export interface IssuanceConfigMiniDto { /** * * @type {string} * @memberof IssuanceConfigMiniDto */ id: string; /** * * @type {string} * @memberof IssuanceConfigMiniDto */ name?: string; /** * Issuer DID * @type {string} * @memberof IssuanceConfigMiniDto */ issuerDid?: string; /** * Issuer Wallet id * @type {string} * @memberof IssuanceConfigMiniDto */ issuerWalletId?: string; /** * credential offer duration in second * @type {number} * @memberof IssuanceConfigMiniDto */ credentialOfferDuration?: number; /** * c_nonce duration in second * @type {number} * @memberof IssuanceConfigMiniDto */ cNonceDuration?: number; /** * String identifying the format of this Credential, i.e., jwt_vc_json-ld or ldp_vc. Depending on the format value, the object contains further elements defining the type * @type {string} * @memberof IssuanceConfigMiniDto */ format?: IssuanceConfigMiniDtoFormatEnum; /** * Issuer URI * @type {string} * @memberof IssuanceConfigMiniDto */ issuerUri?: string; /** * Issuer public information wallet may want to show to user during consent confirmation * @type {{ [key: string]: any; }} * @memberof IssuanceConfigMiniDto */ issuerMetadata?: { [key: string]: any; }; /** * * @type {number} * @memberof IssuanceConfigMiniDto */ version?: number; } export declare const IssuanceConfigMiniDtoFormatEnum: { readonly LdpVc: "ldp_vc"; readonly JwtVcJsonLd: "jwt_vc_json-ld"; readonly SdJwtVcJsonLd: "sd_jwt_vc_json-ld"; }; export type IssuanceConfigMiniDtoFormatEnum = (typeof IssuanceConfigMiniDtoFormatEnum)[keyof typeof IssuanceConfigMiniDtoFormatEnum]; /** * * @export * @interface IssuanceStateResponse */ export interface IssuanceStateResponse { /** * Website\'s internal identifier. Website may use to get info about the status of issuance flow. If it is not provided, CIS will generate one. * @type {string} * @memberof IssuanceStateResponse */ issuanceId: string; /** * String describing the status of the issuance * @type {string} * @memberof IssuanceStateResponse */ status: IssuanceStateResponseStatusEnum; } export declare const IssuanceStateResponseStatusEnum: { readonly Init: "INIT"; readonly OfferDelivered: "OFFER_DELIVERED"; readonly VcClaimed: "VC_CLAIMED"; readonly Timeout: "TIMEOUT"; }; export type IssuanceStateResponseStatusEnum = (typeof IssuanceStateResponseStatusEnum)[keyof typeof IssuanceStateResponseStatusEnum]; /** * list of issuance data records * @export * @interface ListIssuanceRecordResponse */ export interface ListIssuanceRecordResponse { /** * * @type {Array<FlowData>} * @memberof ListIssuanceRecordResponse */ flowData?: Array<FlowData>; /** * * @type {string} * @memberof ListIssuanceRecordResponse */ lastEvaluatedKey?: string; } /** * * @export * @interface ListIssuanceResponse */ export interface ListIssuanceResponse { /** * The list of all issuances for the Project * @type {Array<ListIssuanceResponseIssuancesInner>} * @memberof ListIssuanceResponse */ issuances: Array<ListIssuanceResponseIssuancesInner>; } /** * * @export * @interface ListIssuanceResponseIssuancesInner */ export interface ListIssuanceResponseIssuancesInner { /** * issuance id * @type {string} * @memberof ListIssuanceResponseIssuancesInner */ id: string; } /** * * @export * @interface MissingHolderDidError */ export interface MissingHolderDidError { /** * * @type {string} * @memberof MissingHolderDidError */ name: MissingHolderDidErrorNameEnum; /** * * @type {string} * @memberof MissingHolderDidError */ message: MissingHolderDidErrorMessageEnum; /** * * @type {number} * @memberof MissingHolderDidError */ httpStatusCode: MissingHolderDidErrorHttpStatusCodeEnum; /** * * @type {string} * @memberof MissingHolderDidError */ traceId: string; /** * * @type {Array<ActionForbiddenErrorDetailsInner>} * @memberof MissingHolderDidError */ details?: Array<ActionForbiddenErrorDetailsInner>; } export declare const MissingHolderDidErrorNameEnum: { readonly MissingHolderDidError: "MissingHolderDidError"; }; export type MissingHolderDidErrorNameEnum = (typeof MissingHolderDidErrorNameEnum)[keyof typeof MissingHolderDidErrorNameEnum]; export declare const MissingHolderDidErrorMessageEnum: { readonly HolderDidIsRequiredInThisClaimMode: "holderDID is required in this claimMode"; }; export type MissingHolderDidErrorMessageEnum = (typeof MissingHolderDidErrorMessageEnum)[keyof typeof MissingHolderDidErrorMessageEnum]; export declare const MissingHolderDidErrorHttpStatusCodeEnum: { readonly NUMBER_400: 400; }; export type MissingHolderDidErrorHttpStatusCodeEnum = (typeof MissingHolderDidErrorHttpStatusCodeEnum)[keyof typeof MissingHolderDidErrorHttpStatusCodeEnum]; /** * * @export * @interface NotFoundError */ export interface NotFoundError { /** * * @type {string} * @memberof NotFoundError */ name: NotFoundErrorNameEnum; /** * * @type {string} * @memberof NotFoundError */ message: NotFoundErrorMessageEnum; /** * * @type {number} * @memberof NotFoundError */ httpStatusCode: NotFoundErrorHttpStatusCodeEnum; /** * * @type {string} * @memberof NotFoundError */ traceId: string; /** * * @type {Array<ActionForbiddenErrorDetailsInner>} * @memberof NotFoundError */ details?: Array<ActionForbiddenErrorDetailsInner>; } export declare const NotFoundErrorNameEnum: { readonly NotFoundError: "NotFoundError"; }; export type NotFoundErrorNameEnum = (typeof NotFoundErrorNameEnum)[keyof typeof NotFoundErrorNameEnum]; export declare const NotFoundErrorMessageEnum: { readonly NotFoundParam: "Not found: ${param}."; }; export type NotFoundErrorMessageEnum = (typeof NotFoundErrorMessageEnum)[keyof typeof NotFoundErrorMessageEnum]; export declare const NotFoundErrorHttpStatusCodeEnum: { readonly NUMBER_404: 404; }; export type NotFoundErrorHttpStatusCodeEnum = (typeof NotFoundErrorHttpStatusCodeEnum)[keyof typeof NotFoundErrorHttpStatusCodeEnum]; /** * * @export * @interface ProjectCredentialConfigExistError */ export interface ProjectCredentialConfigExistError { /** * * @type {string} * @memberof ProjectCredentialConfigExistError */ name: ProjectCredentialConfigExistErrorNameEnum; /** * * @type {string} * @memberof ProjectCredentialConfigExistError */ message: ProjectCredentialConfigExistErrorMessageEnum; /** * * @type {number} * @memberof ProjectCredentialConfigExistError */ httpStatusCode: ProjectCredentialConfigExistErrorHttpStatusCodeEnum; /** * * @type {string} * @memberof ProjectCredentialConfigExistError */ traceId: string; /** * * @type {Array<ActionForbiddenErrorDetailsInner>} * @memberof ProjectCredentialConfigExistError */ details?: Array<ActionForbiddenErrorDetailsInner>; } export declare const ProjectCredentialConfigExistErrorNameEnum: { readonly ProjectCredentialConfigExistError: "ProjectCredentialConfigEx