From b239f328fcb90115fb2f13caba0b0c7ca3390b70 Mon Sep 17 00:00:00 2001 From: Marat Shakirov Date: Thu, 5 Dec 2024 10:33:20 +0000 Subject: [PATCH] feat: update client all --- .../.openapi-generator/FILES | 21 + .../dart/credential_issuance_client/README.md | 35 +- .../doc/ChangeCredentialStatusInput.md | 16 + .../doc/DefaultApi.md | 160 +++++ .../doc/FlowData.md | 29 + .../doc/FlowDataStatusListsDetailsInner.md | 21 + .../doc/GetStatusListResultDto.md | 15 + .../doc/ListIssuanceRecordResponse.md | 16 + .../doc/StartIssuanceInputDataInner.md | 11 +- ...nceInputDataInnerStatusListDetailsInner.md | 16 + .../credential_issuance_client/lib/api.dart | 7 + .../lib/api/default_api.dart | 219 ++++++ .../lib/api_client.dart | 12 + .../model/change_credential_status_input.dart | 135 ++++ .../lib/model/flow_data.dart | 291 ++++++++ .../flow_data_status_lists_details_inner.dart | 326 +++++++++ .../lib/model/get_status_list_result_dto.dart | 109 +++ .../model/list_issuance_record_response.dart | 125 ++++ .../start_issuance_input_data_inner.dart | 10 +- ..._data_inner_status_list_details_inner.dart | 268 +++++++ .../change_credential_status_input_test.dart | 32 + .../test/default_api_test.dart | 48 ++ ..._data_status_lists_details_inner_test.dart | 63 ++ .../test/flow_data_test.dart | 105 +++ .../test/get_status_list_result_dto_test.dart | 27 + .../list_issuance_record_response_test.dart | 32 + ..._inner_status_list_details_inner_test.dart | 32 + clients/dart/iota_client/README.md | 8 +- .../iota_client/doc/AwsExchangeCredentials.md | 6 +- .../doc/AwsExchangeCredentialsProjectToken.md | 10 +- clients/dart/iota_client/doc/CallbackApi.md | 10 +- clients/dart/iota_client/doc/CallbackInput.md | 16 +- .../iota_client/doc/CallbackResponseOK.md | 10 +- .../dart/iota_client/doc/ConfigurationsApi.md | 50 +- clients/dart/iota_client/doc/ConsentDto.md | 22 +- .../doc/CreateIotaConfigurationInput.md | 26 +- .../iota_client/doc/CreatePexQueryInput.md | 10 +- clients/dart/iota_client/doc/DefaultApi.md | 6 +- .../doc/FetchIOTAVPResponseInput.md | 12 +- .../iota_client/doc/FetchIOTAVPResponseOK.md | 10 +- .../doc/GetIotaConfigurationMetaDataOK.md | 10 +- .../doc/InitiateDataSharingRequestInput.md | 18 +- clients/dart/iota_client/doc/IotaApi.md | 10 +- .../iota_client/doc/IotaConfigurationDto.md | 30 +- .../doc/IotaConfigurationDtoClientMetadata.md | 10 +- .../doc/IotaExchangeCredentials.md | 6 +- clients/dart/iota_client/doc/PexQueryApi.md | 92 +-- clients/dart/iota_client/doc/PexQueryDto.md | 16 +- .../dart/iota_client/doc/PrepareRequest.md | 14 +- .../doc/PrepareRequestCreatedData.md | 8 +- .../SavePexQueriesUpdateInputQueriesInner.md | 10 +- .../doc/UpdateConfigurationByIdInput.md | 26 +- .../iota_client/doc/UpdatePexQueryInput.md | 8 +- .../iota_client/lib/api/callback_api.dart | 8 +- .../lib/api/configurations_api.dart | 60 +- .../dart/iota_client/lib/api/default_api.dart | 8 +- .../dart/iota_client/lib/api/iota_api.dart | 20 +- .../iota_client/lib/api/pex_query_api.dart | 87 ++- .../lib/model/aws_exchange_credentials.dart | 2 +- ...ws_exchange_credentials_project_token.dart | 6 +- .../iota_client/lib/model/callback_input.dart | 12 +- .../lib/model/callback_response_ok.dart | 6 +- .../iota_client/lib/model/consent_dto.dart | 10 +- .../create_iota_configuration_input.dart | 20 +- .../lib/model/create_pex_query_input.dart | 5 +- .../model/fetch_iotavp_response_input.dart | 8 +- .../lib/model/fetch_iotavp_response_ok.dart | 6 +- .../get_iota_configuration_meta_data_ok.dart | 6 +- .../initiate_data_sharing_request_input.dart | 14 +- .../lib/model/iota_configuration_dto.dart | 22 +- ...ota_configuration_dto_client_metadata.dart | 6 +- .../lib/model/iota_exchange_credentials.dart | 2 +- .../iota_client/lib/model/pex_query_dto.dart | 7 +- .../lib/model/prepare_request.dart | 3 +- .../model/prepare_request_created_data.dart | 1 + ...ex_queries_update_input_queries_inner.dart | 3 + .../update_configuration_by_id_input.dart | 20 +- .../lib/model/update_pex_query_input.dart | 3 +- .../.openapi-generator/FILES | 21 + .../credential_issuance_client/README.md | 35 +- .../__init__.py | 7 + .../api/__init__.py | 1 + .../api/default_api.py | 499 +++++++++++++ .../models/__init__.py | 6 + .../models/change_credential_status_input.py | 74 ++ .../models/flow_data.py | 108 +++ .../flow_data_status_lists_details_inner.py | 98 +++ .../models/get_status_list_result_dto.py | 72 ++ .../models/list_issuance_record_response.py | 82 +++ .../models/start_issuance_input_data_inner.py | 16 +- ...ut_data_inner_status_list_details_inner.py | 94 +++ .../docs/ChangeCredentialStatusInput.md | 28 + .../docs/DefaultApi.md | 249 +++++++ .../docs/FlowData.md | 41 ++ .../docs/FlowDataStatusListsDetailsInner.md | 33 + .../docs/GetStatusListResultDto.md | 29 + .../docs/ListIssuanceRecordResponse.md | 30 + .../docs/StartIssuanceInputDataInner.md | 11 +- ...nceInputDataInnerStatusListDetailsInner.md | 28 + .../test_change_credential_status_input.py | 54 ++ .../test/test_default_api.py | 53 ++ .../test/test_flow_data.py | 83 +++ ...st_flow_data_status_lists_details_inner.py | 64 ++ .../test/test_get_status_list_result_dto.py | 54 ++ .../test_list_issuance_record_response.py | 80 +++ ...ut_data_inner_status_list_details_inner.py | 54 ++ clients/python/iota_client/README.md | 9 +- .../api/callback_api.py | 8 +- .../api/configurations_api.py | 48 +- .../api/default_api.py | 12 +- .../affinidi_tdk_iota_client/api/iota_api.py | 21 +- .../api/pex_query_api.py | 90 +-- .../models/aws_exchange_credentials.py | 2 +- .../aws_exchange_credentials_project_token.py | 6 +- .../models/callback_input.py | 12 +- .../models/callback_response_ok.py | 6 +- .../models/consent_dto.py | 10 +- .../models/create_iota_configuration_input.py | 20 +- .../models/create_pex_query_input.py | 6 +- .../models/fetch_iotavp_response_input.py | 8 +- .../models/fetch_iotavp_response_ok.py | 6 +- .../get_iota_configuration_meta_data_ok.py | 6 +- .../initiate_data_sharing_request_input.py | 14 +- .../models/iota_configuration_dto.py | 24 +- .../iota_configuration_dto_client_metadata.py | 8 +- .../models/iota_exchange_credentials.py | 2 +- .../models/pex_query_dto.py | 12 +- .../models/prepare_request.py | 4 +- .../models/prepare_request_created_data.py | 2 +- ..._pex_queries_update_input_queries_inner.py | 6 +- .../update_configuration_by_id_input.py | 20 +- .../models/update_pex_query_input.py | 4 +- .../docs/AwsExchangeCredentials.md | 6 +- .../AwsExchangeCredentialsProjectToken.md | 10 +- .../python/iota_client/docs/CallbackApi.md | 11 +- .../python/iota_client/docs/CallbackInput.md | 16 +- .../iota_client/docs/CallbackResponseOK.md | 10 +- .../iota_client/docs/ConfigurationsApi.md | 50 +- clients/python/iota_client/docs/ConsentDto.md | 22 +- .../docs/CreateIotaConfigurationInput.md | 26 +- .../iota_client/docs/CreatePexQueryInput.md | 10 +- clients/python/iota_client/docs/DefaultApi.md | 6 +- .../docs/FetchIOTAVPResponseInput.md | 12 +- .../iota_client/docs/FetchIOTAVPResponseOK.md | 10 +- .../docs/GetIotaConfigurationMetaDataOK.md | 10 +- .../docs/InitiateDataSharingRequestInput.md | 18 +- clients/python/iota_client/docs/IotaApi.md | 11 +- .../iota_client/docs/IotaConfigurationDto.md | 30 +- .../IotaConfigurationDtoClientMetadata.md | 12 +- .../docs/IotaExchangeCredentials.md | 6 +- .../python/iota_client/docs/PexQueryApi.md | 93 +-- .../python/iota_client/docs/PexQueryDto.md | 16 +- .../python/iota_client/docs/PrepareRequest.md | 14 +- .../docs/PrepareRequestCreatedData.md | 8 +- .../SavePexQueriesUpdateInputQueriesInner.md | 10 +- .../docs/UpdateConfigurationByIdInput.md | 26 +- .../iota_client/docs/UpdatePexQueryInput.md | 8 +- .../credential-issuance-client/api.ts | 677 ++++++++++++++++++ .../docs/.openapi-generator/FILES | 7 + .../docs/Apis/DefaultApi.md | 99 +++ .../Models/ChangeCredentialStatusInput.md | 10 + .../docs/Models/FlowData.md | 23 + .../FlowData_statusListsDetails_inner.md | 15 + .../docs/Models/GetStatusListResultDto.md | 9 + .../docs/Models/ListIssuanceRecordResponse.md | 10 + .../Models/StartIssuanceInput_data_inner.md | 11 +- ...nput_data_inner_statusListDetails_inner.md | 10 + .../credential-issuance-client/docs/README.md | 35 +- clients/typescript/iota-client/api.ts | 474 ++++++------ .../iota-client/docs/Apis/CallbackApi.md | 10 +- .../docs/Apis/ConfigurationsApi.md | 40 +- .../iota-client/docs/Apis/DefaultApi.md | 4 +- .../iota-client/docs/Apis/IotaApi.md | 10 +- .../iota-client/docs/Apis/PexQueryApi.md | 84 ++- .../docs/Models/AwsExchangeCredentials.md | 6 +- .../AwsExchangeCredentialsProjectToken.md | 10 +- .../iota-client/docs/Models/CallbackInput.md | 16 +- .../docs/Models/CallbackResponseOK.md | 10 +- .../iota-client/docs/Models/ConsentDto.md | 22 +- .../Models/CreateIotaConfigurationInput.md | 26 +- .../docs/Models/CreatePexQueryInput.md | 10 +- .../docs/Models/FetchIOTAVPResponseInput.md | 12 +- .../docs/Models/FetchIOTAVPResponseOK.md | 10 +- .../Models/GetIotaConfigurationMetaDataOK.md | 10 +- .../Models/InitiateDataSharingRequestInput.md | 18 +- .../docs/Models/IotaConfigurationDto.md | 30 +- .../IotaConfigurationDto_clientMetadata.md | 10 +- .../docs/Models/IotaExchangeCredentials.md | 6 +- .../iota-client/docs/Models/PexQueryDto.md | 16 +- .../iota-client/docs/Models/PrepareRequest.md | 14 +- .../docs/Models/PrepareRequestCreated_data.md | 8 +- ...SavePexQueriesUpdateInput_queries_inner.md | 10 +- .../Models/UpdateConfigurationByIdInput.md | 26 +- .../docs/Models/UpdatePexQueryInput.md | 8 +- clients/typescript/iota-client/docs/README.md | 44 +- package-lock.json | 4 +- 196 files changed, 6383 insertions(+), 1272 deletions(-) create mode 100644 clients/dart/credential_issuance_client/doc/ChangeCredentialStatusInput.md create mode 100644 clients/dart/credential_issuance_client/doc/DefaultApi.md create mode 100644 clients/dart/credential_issuance_client/doc/FlowData.md create mode 100644 clients/dart/credential_issuance_client/doc/FlowDataStatusListsDetailsInner.md create mode 100644 clients/dart/credential_issuance_client/doc/GetStatusListResultDto.md create mode 100644 clients/dart/credential_issuance_client/doc/ListIssuanceRecordResponse.md create mode 100644 clients/dart/credential_issuance_client/doc/StartIssuanceInputDataInnerStatusListDetailsInner.md create mode 100644 clients/dart/credential_issuance_client/lib/api/default_api.dart create mode 100644 clients/dart/credential_issuance_client/lib/model/change_credential_status_input.dart create mode 100644 clients/dart/credential_issuance_client/lib/model/flow_data.dart create mode 100644 clients/dart/credential_issuance_client/lib/model/flow_data_status_lists_details_inner.dart create mode 100644 clients/dart/credential_issuance_client/lib/model/get_status_list_result_dto.dart create mode 100644 clients/dart/credential_issuance_client/lib/model/list_issuance_record_response.dart create mode 100644 clients/dart/credential_issuance_client/lib/model/start_issuance_input_data_inner_status_list_details_inner.dart create mode 100644 clients/dart/credential_issuance_client/test/change_credential_status_input_test.dart create mode 100644 clients/dart/credential_issuance_client/test/default_api_test.dart create mode 100644 clients/dart/credential_issuance_client/test/flow_data_status_lists_details_inner_test.dart create mode 100644 clients/dart/credential_issuance_client/test/flow_data_test.dart create mode 100644 clients/dart/credential_issuance_client/test/get_status_list_result_dto_test.dart create mode 100644 clients/dart/credential_issuance_client/test/list_issuance_record_response_test.dart create mode 100644 clients/dart/credential_issuance_client/test/start_issuance_input_data_inner_status_list_details_inner_test.dart create mode 100644 clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/api/default_api.py create mode 100644 clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/change_credential_status_input.py create mode 100644 clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/flow_data.py create mode 100644 clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/flow_data_status_lists_details_inner.py create mode 100644 clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/get_status_list_result_dto.py create mode 100644 clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/list_issuance_record_response.py create mode 100644 clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/start_issuance_input_data_inner_status_list_details_inner.py create mode 100644 clients/python/credential_issuance_client/docs/ChangeCredentialStatusInput.md create mode 100644 clients/python/credential_issuance_client/docs/DefaultApi.md create mode 100644 clients/python/credential_issuance_client/docs/FlowData.md create mode 100644 clients/python/credential_issuance_client/docs/FlowDataStatusListsDetailsInner.md create mode 100644 clients/python/credential_issuance_client/docs/GetStatusListResultDto.md create mode 100644 clients/python/credential_issuance_client/docs/ListIssuanceRecordResponse.md create mode 100644 clients/python/credential_issuance_client/docs/StartIssuanceInputDataInnerStatusListDetailsInner.md create mode 100644 clients/python/credential_issuance_client/test/test_change_credential_status_input.py create mode 100644 clients/python/credential_issuance_client/test/test_default_api.py create mode 100644 clients/python/credential_issuance_client/test/test_flow_data.py create mode 100644 clients/python/credential_issuance_client/test/test_flow_data_status_lists_details_inner.py create mode 100644 clients/python/credential_issuance_client/test/test_get_status_list_result_dto.py create mode 100644 clients/python/credential_issuance_client/test/test_list_issuance_record_response.py create mode 100644 clients/python/credential_issuance_client/test/test_start_issuance_input_data_inner_status_list_details_inner.py create mode 100644 clients/typescript/credential-issuance-client/docs/Apis/DefaultApi.md create mode 100644 clients/typescript/credential-issuance-client/docs/Models/ChangeCredentialStatusInput.md create mode 100644 clients/typescript/credential-issuance-client/docs/Models/FlowData.md create mode 100644 clients/typescript/credential-issuance-client/docs/Models/FlowData_statusListsDetails_inner.md create mode 100644 clients/typescript/credential-issuance-client/docs/Models/GetStatusListResultDto.md create mode 100644 clients/typescript/credential-issuance-client/docs/Models/ListIssuanceRecordResponse.md create mode 100644 clients/typescript/credential-issuance-client/docs/Models/StartIssuanceInput_data_inner_statusListDetails_inner.md diff --git a/clients/dart/credential_issuance_client/.openapi-generator/FILES b/clients/dart/credential_issuance_client/.openapi-generator/FILES index 6b389a60..db35ccb2 100644 --- a/clients/dart/credential_issuance_client/.openapi-generator/FILES +++ b/clients/dart/credential_issuance_client/.openapi-generator/FILES @@ -4,6 +4,7 @@ README.md analysis_options.yaml doc/ActionForbiddenError.md doc/ActionForbiddenErrorDetailsInner.md +doc/ChangeCredentialStatusInput.md doc/ConfigurationApi.md doc/CorsGenerateCredentialsOK.md doc/CorsGetCredentialOfferOK.md @@ -27,9 +28,13 @@ doc/CredentialResponseImmediateCredential.md doc/CredentialSubjectNotValidError.md doc/CredentialSupportedObject.md doc/CredentialsApi.md +doc/DefaultApi.md doc/DeferredCredentialInput.md +doc/FlowData.md +doc/FlowDataStatusListsDetailsInner.md doc/GenerateCredentials400Response.md doc/GetCredentialOffer400Response.md +doc/GetStatusListResultDto.md doc/InvalidCredentialRequestError.md doc/InvalidCredentialTypeError.md doc/InvalidIssuerWalletError.md @@ -41,6 +46,7 @@ doc/IssuanceConfigDto.md doc/IssuanceConfigListResponse.md doc/IssuanceConfigMiniDto.md doc/IssuanceStateResponse.md +doc/ListIssuanceRecordResponse.md doc/ListIssuanceResponse.md doc/ListIssuanceResponseIssuancesInner.md doc/MissingHolderDidError.md @@ -52,6 +58,7 @@ doc/StartIssuance400Response.md doc/StartIssuanceInput.md doc/StartIssuanceInputDataInner.md doc/StartIssuanceInputDataInnerMetaData.md +doc/StartIssuanceInputDataInnerStatusListDetailsInner.md doc/StartIssuanceResponse.md doc/SupportedCredentialMetadata.md doc/SupportedCredentialMetadataDisplayInner.md @@ -64,6 +71,7 @@ doc/WellKnownOpenIdCredentialIssuerResponseCredentialsSupportedInner.md lib/api.dart lib/api/configuration_api.dart lib/api/credentials_api.dart +lib/api/default_api.dart lib/api/issuance_api.dart lib/api/offer_api.dart lib/api/well_known_api.dart @@ -77,6 +85,7 @@ lib/auth/http_bearer_auth.dart lib/auth/oauth.dart lib/model/action_forbidden_error.dart lib/model/action_forbidden_error_details_inner.dart +lib/model/change_credential_status_input.dart lib/model/cors_generate_credentials_ok.dart lib/model/cors_get_credential_offer_ok.dart lib/model/cors_get_well_known_open_id_credential_issuer_ok.dart @@ -99,8 +108,11 @@ lib/model/credential_response_immediate_credential.dart lib/model/credential_subject_not_valid_error.dart lib/model/credential_supported_object.dart lib/model/deferred_credential_input.dart +lib/model/flow_data.dart +lib/model/flow_data_status_lists_details_inner.dart lib/model/generate_credentials400_response.dart lib/model/get_credential_offer400_response.dart +lib/model/get_status_list_result_dto.dart lib/model/invalid_credential_request_error.dart lib/model/invalid_credential_type_error.dart lib/model/invalid_issuer_wallet_error.dart @@ -111,6 +123,7 @@ lib/model/issuance_config_dto.dart lib/model/issuance_config_list_response.dart lib/model/issuance_config_mini_dto.dart lib/model/issuance_state_response.dart +lib/model/list_issuance_record_response.dart lib/model/list_issuance_response.dart lib/model/list_issuance_response_issuances_inner.dart lib/model/missing_holder_did_error.dart @@ -121,6 +134,7 @@ lib/model/start_issuance400_response.dart lib/model/start_issuance_input.dart lib/model/start_issuance_input_data_inner.dart lib/model/start_issuance_input_data_inner_meta_data.dart +lib/model/start_issuance_input_data_inner_status_list_details_inner.dart lib/model/start_issuance_response.dart lib/model/supported_credential_metadata.dart lib/model/supported_credential_metadata_display_inner.dart @@ -130,3 +144,10 @@ lib/model/vc_claimed_error.dart lib/model/well_known_open_id_credential_issuer_response.dart lib/model/well_known_open_id_credential_issuer_response_credentials_supported_inner.dart pubspec.yaml +test/change_credential_status_input_test.dart +test/default_api_test.dart +test/flow_data_status_lists_details_inner_test.dart +test/flow_data_test.dart +test/get_status_list_result_dto_test.dart +test/list_issuance_record_response_test.dart +test/start_issuance_input_data_inner_status_list_details_inner_test.dart diff --git a/clients/dart/credential_issuance_client/README.md b/clients/dart/credential_issuance_client/README.md index e9723b7e..0819fb1b 100644 --- a/clients/dart/credential_issuance_client/README.md +++ b/clients/dart/credential_issuance_client/README.md @@ -67,24 +67,28 @@ try { All URIs are relative to *https://apse1.api.affinidi.io/cis* -| Class | Method | HTTP request | Description | -| ------------------ | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | ----------- | -| _ConfigurationApi_ | [**createIssuanceConfig**](doc//ConfigurationApi.md#createissuanceconfig) | **POST** /v1/configurations | -| _ConfigurationApi_ | [**deleteIssuanceConfigById**](doc//ConfigurationApi.md#deleteissuanceconfigbyid) | **DELETE** /v1/configurations/{configurationId} | -| _ConfigurationApi_ | [**getIssuanceConfigById**](doc//ConfigurationApi.md#getissuanceconfigbyid) | **GET** /v1/configurations/{configurationId} | -| _ConfigurationApi_ | [**getIssuanceConfigList**](doc//ConfigurationApi.md#getissuanceconfiglist) | **GET** /v1/configurations | -| _ConfigurationApi_ | [**updateIssuanceConfigById**](doc//ConfigurationApi.md#updateissuanceconfigbyid) | **PUT** /v1/configurations/{configurationId} | -| _CredentialsApi_ | [**generateCredentials**](doc//CredentialsApi.md#generatecredentials) | **POST** /v1/{projectId}/credential | -| _IssuanceApi_ | [**issuanceState**](doc//IssuanceApi.md#issuancestate) | **GET** /v1/{projectId}/issuance/state/{issuanceId} | -| _IssuanceApi_ | [**listIssuance**](doc//IssuanceApi.md#listissuance) | **GET** /v1/{projectId}/issuance | -| _IssuanceApi_ | [**startIssuance**](doc//IssuanceApi.md#startissuance) | **POST** /v1/{projectId}/issuance/start | -| _OfferApi_ | [**getCredentialOffer**](doc//OfferApi.md#getcredentialoffer) | **GET** /v1/{projectId}/offers/{issuanceId} | -| _WellKnownApi_ | [**getWellKnownOpenIdCredentialIssuer**](doc//WellKnownApi.md#getwellknownopenidcredentialissuer) | **GET** /v1/{projectId}/.well-known/openid-credential-issuer | +| Class | Method | HTTP request | Description | +| ------------------ | ------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | ----------------------------- | +| _ConfigurationApi_ | [**createIssuanceConfig**](doc//ConfigurationApi.md#createissuanceconfig) | **POST** /v1/configurations | +| _ConfigurationApi_ | [**deleteIssuanceConfigById**](doc//ConfigurationApi.md#deleteissuanceconfigbyid) | **DELETE** /v1/configurations/{configurationId} | +| _ConfigurationApi_ | [**getIssuanceConfigById**](doc//ConfigurationApi.md#getissuanceconfigbyid) | **GET** /v1/configurations/{configurationId} | +| _ConfigurationApi_ | [**getIssuanceConfigList**](doc//ConfigurationApi.md#getissuanceconfiglist) | **GET** /v1/configurations | +| _ConfigurationApi_ | [**updateIssuanceConfigById**](doc//ConfigurationApi.md#updateissuanceconfigbyid) | **PUT** /v1/configurations/{configurationId} | +| _CredentialsApi_ | [**generateCredentials**](doc//CredentialsApi.md#generatecredentials) | **POST** /v1/{projectId}/credential | +| _DefaultApi_ | [**changeCredentialSatatus**](doc//DefaultApi.md#changecredentialsatatus) | **POST** /v1/{projectId}/configurations/{configurationId}/issuance/change-status | change credential status. | +| _DefaultApi_ | [**getStatusList**](doc//DefaultApi.md#getstatuslist) | **GET** /v1/{projectId}/status-list/{statusListId} | Return status list credential | +| _DefaultApi_ | [**listIssuanceDataRecords**](doc//DefaultApi.md#listissuancedatarecords) | **GET** /v1/{projectId}/configurations/{configurationId}/issuance/issuance-data-records | List records | +| _IssuanceApi_ | [**issuanceState**](doc//IssuanceApi.md#issuancestate) | **GET** /v1/{projectId}/issuance/state/{issuanceId} | +| _IssuanceApi_ | [**listIssuance**](doc//IssuanceApi.md#listissuance) | **GET** /v1/{projectId}/issuance | +| _IssuanceApi_ | [**startIssuance**](doc//IssuanceApi.md#startissuance) | **POST** /v1/{projectId}/issuance/start | +| _OfferApi_ | [**getCredentialOffer**](doc//OfferApi.md#getcredentialoffer) | **GET** /v1/{projectId}/offers/{issuanceId} | +| _WellKnownApi_ | [**getWellKnownOpenIdCredentialIssuer**](doc//WellKnownApi.md#getwellknownopenidcredentialissuer) | **GET** /v1/{projectId}/.well-known/openid-credential-issuer | ## Documentation For Models - [ActionForbiddenError](doc//ActionForbiddenError.md) - [ActionForbiddenErrorDetailsInner](doc//ActionForbiddenErrorDetailsInner.md) +- [ChangeCredentialStatusInput](doc//ChangeCredentialStatusInput.md) - [CorsGenerateCredentialsOK](doc//CorsGenerateCredentialsOK.md) - [CorsGetCredentialOfferOK](doc//CorsGetCredentialOfferOK.md) - [CorsGetWellKnownOpenIdCredentialIssuerOK](doc//CorsGetWellKnownOpenIdCredentialIssuerOK.md) @@ -107,8 +111,11 @@ All URIs are relative to *https://apse1.api.affinidi.io/cis* - [CredentialSubjectNotValidError](doc//CredentialSubjectNotValidError.md) - [CredentialSupportedObject](doc//CredentialSupportedObject.md) - [DeferredCredentialInput](doc//DeferredCredentialInput.md) +- [FlowData](doc//FlowData.md) +- [FlowDataStatusListsDetailsInner](doc//FlowDataStatusListsDetailsInner.md) - [GenerateCredentials400Response](doc//GenerateCredentials400Response.md) - [GetCredentialOffer400Response](doc//GetCredentialOffer400Response.md) +- [GetStatusListResultDto](doc//GetStatusListResultDto.md) - [InvalidCredentialRequestError](doc//InvalidCredentialRequestError.md) - [InvalidCredentialTypeError](doc//InvalidCredentialTypeError.md) - [InvalidIssuerWalletError](doc//InvalidIssuerWalletError.md) @@ -119,6 +126,7 @@ All URIs are relative to *https://apse1.api.affinidi.io/cis* - [IssuanceConfigListResponse](doc//IssuanceConfigListResponse.md) - [IssuanceConfigMiniDto](doc//IssuanceConfigMiniDto.md) - [IssuanceStateResponse](doc//IssuanceStateResponse.md) +- [ListIssuanceRecordResponse](doc//ListIssuanceRecordResponse.md) - [ListIssuanceResponse](doc//ListIssuanceResponse.md) - [ListIssuanceResponseIssuancesInner](doc//ListIssuanceResponseIssuancesInner.md) - [MissingHolderDidError](doc//MissingHolderDidError.md) @@ -129,6 +137,7 @@ All URIs are relative to *https://apse1.api.affinidi.io/cis* - [StartIssuanceInput](doc//StartIssuanceInput.md) - [StartIssuanceInputDataInner](doc//StartIssuanceInputDataInner.md) - [StartIssuanceInputDataInnerMetaData](doc//StartIssuanceInputDataInnerMetaData.md) +- [StartIssuanceInputDataInnerStatusListDetailsInner](doc//StartIssuanceInputDataInnerStatusListDetailsInner.md) - [StartIssuanceResponse](doc//StartIssuanceResponse.md) - [SupportedCredentialMetadata](doc//SupportedCredentialMetadata.md) - [SupportedCredentialMetadataDisplayInner](doc//SupportedCredentialMetadataDisplayInner.md) diff --git a/clients/dart/credential_issuance_client/doc/ChangeCredentialStatusInput.md b/clients/dart/credential_issuance_client/doc/ChangeCredentialStatusInput.md new file mode 100644 index 00000000..564f5276 --- /dev/null +++ b/clients/dart/credential_issuance_client/doc/ChangeCredentialStatusInput.md @@ -0,0 +1,16 @@ +# affinidi_tdk_credential_issuance_client.model.ChangeCredentialStatusInput + +## Load the model package + +```dart +import 'package:affinidi_tdk_credential_issuance_client/api.dart'; +``` + +## Properties + +| Name | Type | Description | Notes | +| ---------------------- | ---------- | ----------- | ---------- | +| **changeReason** | **String** | | [optional] | +| **issuanceFlowDataId** | **String** | | [optional] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/dart/credential_issuance_client/doc/DefaultApi.md b/clients/dart/credential_issuance_client/doc/DefaultApi.md new file mode 100644 index 00000000..2d911a17 --- /dev/null +++ b/clients/dart/credential_issuance_client/doc/DefaultApi.md @@ -0,0 +1,160 @@ +# affinidi_tdk_credential_issuance_client.api.DefaultApi + +## Load the API package + +```dart +import 'package:affinidi_tdk_credential_issuance_client/api.dart'; +``` + +All URIs are relative to *https://apse1.api.affinidi.io/cis* + +| Method | HTTP request | Description | +| -------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | ----------------------------- | +| [**changeCredentialSatatus**](DefaultApi.md#changecredentialsatatus) | **POST** /v1/{projectId}/configurations/{configurationId}/issuance/change-status | change credential status. | +| [**getStatusList**](DefaultApi.md#getstatuslist) | **GET** /v1/{projectId}/status-list/{statusListId} | Return status list credential | +| [**listIssuanceDataRecords**](DefaultApi.md#listissuancedatarecords) | **GET** /v1/{projectId}/configurations/{configurationId}/issuance/issuance-data-records | List records | + +# **changeCredentialSatatus** + +> FlowData changeCredentialSatatus(projectId, configurationId) + +change credential status. + +change credential status. + +### Example + +```dart +import 'package:affinidi_tdk_credential_issuance_client/api.dart'; +// TODO Configure API key authorization: ProjectTokenAuth +//defaultApiClient.getAuthentication('ProjectTokenAuth').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('ProjectTokenAuth').apiKeyPrefix = 'Bearer'; + +final api_instance = DefaultApi(); +final projectId = projectId_example; // String | project id +final configurationId = configurationId_example; // String | configuration id + +try { + final result = api_instance.changeCredentialSatatus(projectId, configurationId); + print(result); +} catch (e) { + print('Exception when calling DefaultApi->changeCredentialSatatus: $e\n'); +} +``` + +### Parameters + +| Name | Type | Description | Notes | +| ------------------- | ---------- | ---------------- | ----- | +| **projectId** | **String** | project id | +| **configurationId** | **String** | configuration id | + +### Return type + +[**FlowData**](FlowData.md) + +### Authorization + +[ProjectTokenAuth](../README.md#ProjectTokenAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getStatusList** + +> GetStatusListResultDto getStatusList(projectId, statusListId) + +Return status list credential + +Return status list credential + +### Example + +```dart +import 'package:affinidi_tdk_credential_issuance_client/api.dart'; + +final api_instance = DefaultApi(); +final projectId = projectId_example; // String | +final statusListId = statusListId_example; // String | id of the status list + +try { + final result = api_instance.getStatusList(projectId, statusListId); + print(result); +} catch (e) { + print('Exception when calling DefaultApi->getStatusList: $e\n'); +} +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---------------- | ---------- | --------------------- | ----- | +| **projectId** | **String** | | +| **statusListId** | **String** | id of the status list | + +### Return type + +[**GetStatusListResultDto**](GetStatusListResultDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listIssuanceDataRecords** + +> ListIssuanceRecordResponse listIssuanceDataRecords(limit, exclusiveStartKey) + +List records + +Retrieve a list of issuance data records. + +### Example + +```dart +import 'package:affinidi_tdk_credential_issuance_client/api.dart'; + +final api_instance = DefaultApi(); +final limit = 56; // int | Maximum number of records to fetch in a list +final exclusiveStartKey = exclusiveStartKey_example; // String | exclusiveStartKey for retrieving the next batch of data. + +try { + final result = api_instance.listIssuanceDataRecords(limit, exclusiveStartKey); + print(result); +} catch (e) { + print('Exception when calling DefaultApi->listIssuanceDataRecords: $e\n'); +} +``` + +### Parameters + +| Name | Type | Description | Notes | +| --------------------- | ---------- | -------------------------------------------------------- | -------------------------- | +| **limit** | **int** | Maximum number of records to fetch in a list | [optional] [default to 10] | +| **exclusiveStartKey** | **String** | exclusiveStartKey for retrieving the next batch of data. | [optional] | + +### Return type + +[**ListIssuanceRecordResponse**](ListIssuanceRecordResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/clients/dart/credential_issuance_client/doc/FlowData.md b/clients/dart/credential_issuance_client/doc/FlowData.md new file mode 100644 index 00000000..b87bace8 --- /dev/null +++ b/clients/dart/credential_issuance_client/doc/FlowData.md @@ -0,0 +1,29 @@ +# affinidi_tdk_credential_issuance_client.model.FlowData + +## Load the model package + +```dart +import 'package:affinidi_tdk_credential_issuance_client/api.dart'; +``` + +## Properties + +| Name | Type | Description | Notes | +| ------------------------------------------ | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------- | +| **createdAt** | **String** | [GEN] ISO 8601 string of the creation date/time the entity | +| **modifiedAt** | **String** | [GEN] ISO 8601 string of the modification date/time the entity | +| **id** | **String** | | +| **projectId** | **String** | | [optional] | +| **flowId** | **String** | | +| **credentialTypeId** | **String** | | +| **jsonLdContextUrl** | **String** | | +| **jsonSchemaUrl** | **String** | | +| **configurationId** | **String** | Id of configuration, used to issue VC. | [optional] | +| **issuedAt** | **String** | when credential was issued to the holder (holder invoked generateCredentials endpoint) | [optional] | +| **walletId** | **String** | Id of wallet, used to issue VC. | [optional] | +| **projectIdConfigurationId** | **String** | Id of configuration with which VC was issued. To use as an index, it is grouped together with projectId, as \"{projectIdConfigurationId}#{configurationId}\" | [optional] | +| **projectIdConfigurationIdWalletId** | **String** | Id of wallet which issued VC. To use as an index, it is grouped together with projectId, as \"{projectIdConfigurationId}#{walletId}\" | [optional] | +| **projectIdConfigurationIdCredentialType** | **String** | VC.type value. To use as an index, it is grouped together with projectId, as \"{projectIdConfigurationId}#{credentialType}\" | [optional] | +| **statusListsDetails** | [**List**](FlowDataStatusListsDetailsInner.md) | | [optional] [default to const []] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/dart/credential_issuance_client/doc/FlowDataStatusListsDetailsInner.md b/clients/dart/credential_issuance_client/doc/FlowDataStatusListsDetailsInner.md new file mode 100644 index 00000000..ffe23a77 --- /dev/null +++ b/clients/dart/credential_issuance_client/doc/FlowDataStatusListsDetailsInner.md @@ -0,0 +1,21 @@ +# affinidi_tdk_credential_issuance_client.model.FlowDataStatusListsDetailsInner + +## Load the model package + +```dart +import 'package:affinidi_tdk_credential_issuance_client/api.dart'; +``` + +## Properties + +| Name | Type | Description | Notes | +| -------------------------- | ---------- | ------------------------------------------------------------------- | ---------- | +| **statusListPurpose** | **String** | Purpose of status list to which credential is added | +| **statusListId** | **String** | id of status list | +| **statusListIndex** | **String** | as usual it is a number, but all standards use a string | +| **standard** | **String** | | +| **isActive** | **bool** | indicates status is true or not. Default false. | +| **statusActivationReason** | **String** | text reasoning why the status is true (if true). Optional. | [optional] | +| **statusActivatedAt** | **String** | ISO 8601 string of the modification date/time the status. Optional. | [optional] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/dart/credential_issuance_client/doc/GetStatusListResultDto.md b/clients/dart/credential_issuance_client/doc/GetStatusListResultDto.md new file mode 100644 index 00000000..be1c8555 --- /dev/null +++ b/clients/dart/credential_issuance_client/doc/GetStatusListResultDto.md @@ -0,0 +1,15 @@ +# affinidi_tdk_credential_issuance_client.model.GetStatusListResultDto + +## Load the model package + +```dart +import 'package:affinidi_tdk_credential_issuance_client/api.dart'; +``` + +## Properties + +| Name | Type | Description | Notes | +| ---------------------------- | ----------------- | ----------- | ----- | +| **revocationListCredential** | [**Object**](.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/dart/credential_issuance_client/doc/ListIssuanceRecordResponse.md b/clients/dart/credential_issuance_client/doc/ListIssuanceRecordResponse.md new file mode 100644 index 00000000..93ecb1f8 --- /dev/null +++ b/clients/dart/credential_issuance_client/doc/ListIssuanceRecordResponse.md @@ -0,0 +1,16 @@ +# affinidi_tdk_credential_issuance_client.model.ListIssuanceRecordResponse + +## Load the model package + +```dart +import 'package:affinidi_tdk_credential_issuance_client/api.dart'; +``` + +## Properties + +| Name | Type | Description | Notes | +| -------------------- | --------------------------------- | ----------- | -------------------------------- | +| **flowData** | [**List**](FlowData.md) | | [optional] [default to const []] | +| **lastEvaluatedKey** | **String** | | [optional] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/dart/credential_issuance_client/doc/StartIssuanceInputDataInner.md b/clients/dart/credential_issuance_client/doc/StartIssuanceInputDataInner.md index 330173fd..4e0b48a0 100644 --- a/clients/dart/credential_issuance_client/doc/StartIssuanceInputDataInner.md +++ b/clients/dart/credential_issuance_client/doc/StartIssuanceInputDataInner.md @@ -8,10 +8,11 @@ import 'package:affinidi_tdk_credential_issuance_client/api.dart'; ## Properties -| Name | Type | Description | Notes | -| -------------------- | --------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | --------------------- | -| **credentialTypeId** | **String** | It is a String that identifies a Credential that is being requested to be issued. | -| **credentialData** | [**Map**](Object.md) | Object of data to be included in the issued credential ,should match the credential type | [default to const {}] | -| **metaData** | [**StartIssuanceInputDataInnerMetaData**](StartIssuanceInputDataInnerMetaData.md) | | [optional] | +| Name | Type | Description | Notes | +| --------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------- | +| **credentialTypeId** | **String** | It is a String that identifies a Credential that is being requested to be issued. | +| **credentialData** | [**Map**](Object.md) | Object of data to be included in the issued credential ,should match the credential type | [default to const {}] | +| **statusListDetails** | [**List**](StartIssuanceInputDataInnerStatusListDetailsInner.md) | Types of status lists to which the credential should be added once issued. If not provided or empty, the credential is not added to any of the status lists. | [optional] [default to const []] | +| **metaData** | [**StartIssuanceInputDataInnerMetaData**](StartIssuanceInputDataInnerMetaData.md) | | [optional] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/dart/credential_issuance_client/doc/StartIssuanceInputDataInnerStatusListDetailsInner.md b/clients/dart/credential_issuance_client/doc/StartIssuanceInputDataInnerStatusListDetailsInner.md new file mode 100644 index 00000000..945acd17 --- /dev/null +++ b/clients/dart/credential_issuance_client/doc/StartIssuanceInputDataInnerStatusListDetailsInner.md @@ -0,0 +1,16 @@ +# affinidi_tdk_credential_issuance_client.model.StartIssuanceInputDataInnerStatusListDetailsInner + +## Load the model package + +```dart +import 'package:affinidi_tdk_credential_issuance_client/api.dart'; +``` + +## Properties + +| Name | Type | Description | Notes | +| ------------ | ---------- | ----------- | ---------- | +| **purpose** | **String** | | [optional] | +| **standard** | **String** | | [optional] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/dart/credential_issuance_client/lib/api.dart b/clients/dart/credential_issuance_client/lib/api.dart index a88b7466..2cfe1ad7 100644 --- a/clients/dart/credential_issuance_client/lib/api.dart +++ b/clients/dart/credential_issuance_client/lib/api.dart @@ -30,12 +30,14 @@ part 'auth/http_bearer_auth.dart'; part 'api/configuration_api.dart'; part 'api/credentials_api.dart'; +part 'api/default_api.dart'; part 'api/issuance_api.dart'; part 'api/offer_api.dart'; part 'api/well_known_api.dart'; part 'model/action_forbidden_error.dart'; part 'model/action_forbidden_error_details_inner.dart'; +part 'model/change_credential_status_input.dart'; part 'model/cors_generate_credentials_ok.dart'; part 'model/cors_get_credential_offer_ok.dart'; part 'model/cors_get_well_known_open_id_credential_issuer_ok.dart'; @@ -58,8 +60,11 @@ part 'model/credential_response_immediate_credential.dart'; part 'model/credential_subject_not_valid_error.dart'; part 'model/credential_supported_object.dart'; part 'model/deferred_credential_input.dart'; +part 'model/flow_data.dart'; +part 'model/flow_data_status_lists_details_inner.dart'; part 'model/generate_credentials400_response.dart'; part 'model/get_credential_offer400_response.dart'; +part 'model/get_status_list_result_dto.dart'; part 'model/invalid_credential_request_error.dart'; part 'model/invalid_credential_type_error.dart'; part 'model/invalid_issuer_wallet_error.dart'; @@ -70,6 +75,7 @@ part 'model/issuance_config_dto.dart'; part 'model/issuance_config_list_response.dart'; part 'model/issuance_config_mini_dto.dart'; part 'model/issuance_state_response.dart'; +part 'model/list_issuance_record_response.dart'; part 'model/list_issuance_response.dart'; part 'model/list_issuance_response_issuances_inner.dart'; part 'model/missing_holder_did_error.dart'; @@ -80,6 +86,7 @@ part 'model/start_issuance400_response.dart'; part 'model/start_issuance_input.dart'; part 'model/start_issuance_input_data_inner.dart'; part 'model/start_issuance_input_data_inner_meta_data.dart'; +part 'model/start_issuance_input_data_inner_status_list_details_inner.dart'; part 'model/start_issuance_response.dart'; part 'model/supported_credential_metadata.dart'; part 'model/supported_credential_metadata_display_inner.dart'; diff --git a/clients/dart/credential_issuance_client/lib/api/default_api.dart b/clients/dart/credential_issuance_client/lib/api/default_api.dart new file mode 100644 index 00000000..90ec271c --- /dev/null +++ b/clients/dart/credential_issuance_client/lib/api/default_api.dart @@ -0,0 +1,219 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +part of openapi.api; + + +class DefaultApi { + DefaultApi([ApiClient? apiClient]) : apiClient = apiClient ?? defaultApiClient; + + final ApiClient apiClient; + + /// change credential status. + /// + /// change credential status. + /// + /// Note: This method returns the HTTP [Response]. + /// + /// Parameters: + /// + /// * [String] projectId (required): + /// project id + /// + /// * [String] configurationId (required): + /// configuration id + Future changeCredentialSatatusWithHttpInfo(String projectId, String configurationId,) async { + // ignore: prefer_const_declarations + final path = r'/v1/{projectId}/configurations/{configurationId}/issuance/change-status' + .replaceAll('{projectId}', projectId) + .replaceAll('{configurationId}', configurationId); + + // ignore: prefer_final_locals + Object? postBody; + + final queryParams = []; + final headerParams = {}; + final formParams = {}; + + const contentTypes = []; + + + return apiClient.invokeAPI( + path, + 'POST', + queryParams, + postBody, + headerParams, + formParams, + contentTypes.isEmpty ? null : contentTypes.first, + ); + } + + /// change credential status. + /// + /// change credential status. + /// + /// Parameters: + /// + /// * [String] projectId (required): + /// project id + /// + /// * [String] configurationId (required): + /// configuration id + Future changeCredentialSatatus(String projectId, String configurationId,) async { + final response = await changeCredentialSatatusWithHttpInfo(projectId, configurationId,); + if (response.statusCode >= HttpStatus.badRequest) { + throw ApiException(response.statusCode, await _decodeBodyBytes(response)); + } + // When a remote server returns no body with a status of 204, we shall not decode it. + // At the time of writing this, `dart:convert` will throw an "Unexpected end of input" + // FormatException when trying to decode an empty string. + if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) { + return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'FlowData',) as FlowData; + + } + return null; + } + + /// Return status list credential + /// + /// Return status list credential + /// + /// Note: This method returns the HTTP [Response]. + /// + /// Parameters: + /// + /// * [String] projectId (required): + /// + /// * [String] statusListId (required): + /// id of the status list + Future getStatusListWithHttpInfo(String projectId, String statusListId,) async { + // ignore: prefer_const_declarations + final path = r'/v1/{projectId}/status-list/{statusListId}' + .replaceAll('{projectId}', projectId) + .replaceAll('{statusListId}', statusListId); + + // ignore: prefer_final_locals + Object? postBody; + + final queryParams = []; + final headerParams = {}; + final formParams = {}; + + const contentTypes = []; + + + return apiClient.invokeAPI( + path, + 'GET', + queryParams, + postBody, + headerParams, + formParams, + contentTypes.isEmpty ? null : contentTypes.first, + ); + } + + /// Return status list credential + /// + /// Return status list credential + /// + /// Parameters: + /// + /// * [String] projectId (required): + /// + /// * [String] statusListId (required): + /// id of the status list + Future getStatusList(String projectId, String statusListId,) async { + final response = await getStatusListWithHttpInfo(projectId, statusListId,); + if (response.statusCode >= HttpStatus.badRequest) { + throw ApiException(response.statusCode, await _decodeBodyBytes(response)); + } + // When a remote server returns no body with a status of 204, we shall not decode it. + // At the time of writing this, `dart:convert` will throw an "Unexpected end of input" + // FormatException when trying to decode an empty string. + if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) { + return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'GetStatusListResultDto',) as GetStatusListResultDto; + + } + return null; + } + + /// List records + /// + /// Retrieve a list of issuance data records. + /// + /// Note: This method returns the HTTP [Response]. + /// + /// Parameters: + /// + /// * [int] limit: + /// Maximum number of records to fetch in a list + /// + /// * [String] exclusiveStartKey: + /// exclusiveStartKey for retrieving the next batch of data. + Future listIssuanceDataRecordsWithHttpInfo({ int? limit, String? exclusiveStartKey, }) async { + // ignore: prefer_const_declarations + final path = r'/v1/{projectId}/configurations/{configurationId}/issuance/issuance-data-records'; + + // ignore: prefer_final_locals + Object? postBody; + + final queryParams = []; + final headerParams = {}; + final formParams = {}; + + if (limit != null) { + queryParams.addAll(_queryParams('', 'limit', limit)); + } + if (exclusiveStartKey != null) { + queryParams.addAll(_queryParams('', 'exclusiveStartKey', exclusiveStartKey)); + } + + const contentTypes = []; + + + return apiClient.invokeAPI( + path, + 'GET', + queryParams, + postBody, + headerParams, + formParams, + contentTypes.isEmpty ? null : contentTypes.first, + ); + } + + /// List records + /// + /// Retrieve a list of issuance data records. + /// + /// Parameters: + /// + /// * [int] limit: + /// Maximum number of records to fetch in a list + /// + /// * [String] exclusiveStartKey: + /// exclusiveStartKey for retrieving the next batch of data. + Future listIssuanceDataRecords({ int? limit, String? exclusiveStartKey, }) async { + final response = await listIssuanceDataRecordsWithHttpInfo( limit: limit, exclusiveStartKey: exclusiveStartKey, ); + if (response.statusCode >= HttpStatus.badRequest) { + throw ApiException(response.statusCode, await _decodeBodyBytes(response)); + } + // When a remote server returns no body with a status of 204, we shall not decode it. + // At the time of writing this, `dart:convert` will throw an "Unexpected end of input" + // FormatException when trying to decode an empty string. + if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) { + return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'ListIssuanceRecordResponse',) as ListIssuanceRecordResponse; + + } + return null; + } +} diff --git a/clients/dart/credential_issuance_client/lib/api_client.dart b/clients/dart/credential_issuance_client/lib/api_client.dart index f481aaa8..4ab8b31c 100644 --- a/clients/dart/credential_issuance_client/lib/api_client.dart +++ b/clients/dart/credential_issuance_client/lib/api_client.dart @@ -186,6 +186,8 @@ class ApiClient { return ActionForbiddenError.fromJson(value); case 'ActionForbiddenErrorDetailsInner': return ActionForbiddenErrorDetailsInner.fromJson(value); + case 'ChangeCredentialStatusInput': + return ChangeCredentialStatusInput.fromJson(value); case 'CorsGenerateCredentialsOK': return CorsGenerateCredentialsOK.fromJson(value); case 'CorsGetCredentialOfferOK': @@ -230,10 +232,16 @@ class ApiClient { return CredentialSupportedObject.fromJson(value); case 'DeferredCredentialInput': return DeferredCredentialInput.fromJson(value); + case 'FlowData': + return FlowData.fromJson(value); + case 'FlowDataStatusListsDetailsInner': + return FlowDataStatusListsDetailsInner.fromJson(value); case 'GenerateCredentials400Response': return GenerateCredentials400Response.fromJson(value); case 'GetCredentialOffer400Response': return GetCredentialOffer400Response.fromJson(value); + case 'GetStatusListResultDto': + return GetStatusListResultDto.fromJson(value); case 'InvalidCredentialRequestError': return InvalidCredentialRequestError.fromJson(value); case 'InvalidCredentialTypeError': @@ -254,6 +262,8 @@ class ApiClient { return IssuanceConfigMiniDto.fromJson(value); case 'IssuanceStateResponse': return IssuanceStateResponse.fromJson(value); + case 'ListIssuanceRecordResponse': + return ListIssuanceRecordResponse.fromJson(value); case 'ListIssuanceResponse': return ListIssuanceResponse.fromJson(value); case 'ListIssuanceResponseIssuancesInner': @@ -274,6 +284,8 @@ class ApiClient { return StartIssuanceInputDataInner.fromJson(value); case 'StartIssuanceInputDataInnerMetaData': return StartIssuanceInputDataInnerMetaData.fromJson(value); + case 'StartIssuanceInputDataInnerStatusListDetailsInner': + return StartIssuanceInputDataInnerStatusListDetailsInner.fromJson(value); case 'StartIssuanceResponse': return StartIssuanceResponse.fromJson(value); case 'SupportedCredentialMetadata': diff --git a/clients/dart/credential_issuance_client/lib/model/change_credential_status_input.dart b/clients/dart/credential_issuance_client/lib/model/change_credential_status_input.dart new file mode 100644 index 00000000..a5551969 --- /dev/null +++ b/clients/dart/credential_issuance_client/lib/model/change_credential_status_input.dart @@ -0,0 +1,135 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +part of openapi.api; + +class ChangeCredentialStatusInput { + /// Returns a new [ChangeCredentialStatusInput] instance. + ChangeCredentialStatusInput({ + this.changeReason, + this.issuanceFlowDataId, + }); + + /// + /// Please note: This property should have been non-nullable! Since the specification file + /// does not include a default value (using the "default:" property), however, the generated + /// source code must fall back to having a nullable type. + /// Consider adding a "default:" property in the specification file to hide this note. + /// + String? changeReason; + + /// + /// Please note: This property should have been non-nullable! Since the specification file + /// does not include a default value (using the "default:" property), however, the generated + /// source code must fall back to having a nullable type. + /// Consider adding a "default:" property in the specification file to hide this note. + /// + String? issuanceFlowDataId; + + @override + bool operator ==(Object other) => identical(this, other) || other is ChangeCredentialStatusInput && + other.changeReason == changeReason && + other.issuanceFlowDataId == issuanceFlowDataId; + + @override + int get hashCode => + // ignore: unnecessary_parenthesis + (changeReason == null ? 0 : changeReason!.hashCode) + + (issuanceFlowDataId == null ? 0 : issuanceFlowDataId!.hashCode); + + @override + String toString() => 'ChangeCredentialStatusInput[changeReason=$changeReason, issuanceFlowDataId=$issuanceFlowDataId]'; + + Map toJson() { + final json = {}; + if (this.changeReason != null) { + json[r'changeReason'] = this.changeReason; + } else { + json[r'changeReason'] = null; + } + if (this.issuanceFlowDataId != null) { + json[r'issuanceFlowDataId'] = this.issuanceFlowDataId; + } else { + json[r'issuanceFlowDataId'] = null; + } + return json; + } + + /// Returns a new [ChangeCredentialStatusInput] instance and imports its values from + /// [value] if it's a [Map], null otherwise. + // ignore: prefer_constructors_over_static_methods + static ChangeCredentialStatusInput? fromJson(dynamic value) { + if (value is Map) { + final json = value.cast(); + + // Ensure that the map contains the required keys. + // Note 1: the values aren't checked for validity beyond being non-null. + // Note 2: this code is stripped in release mode! + assert(() { + requiredKeys.forEach((key) { + assert(json.containsKey(key), 'Required key "ChangeCredentialStatusInput[$key]" is missing from JSON.'); + assert(json[key] != null, 'Required key "ChangeCredentialStatusInput[$key]" has a null value in JSON.'); + }); + return true; + }()); + + return ChangeCredentialStatusInput( + changeReason: mapValueOfType(json, r'changeReason'), + issuanceFlowDataId: mapValueOfType(json, r'issuanceFlowDataId'), + ); + } + return null; + } + + static List listFromJson(dynamic json, {bool growable = false,}) { + final result = []; + if (json is List && json.isNotEmpty) { + for (final row in json) { + final value = ChangeCredentialStatusInput.fromJson(row); + if (value != null) { + result.add(value); + } + } + } + return result.toList(growable: growable); + } + + static Map mapFromJson(dynamic json) { + final map = {}; + if (json is Map && json.isNotEmpty) { + json = json.cast(); // ignore: parameter_assignments + for (final entry in json.entries) { + final value = ChangeCredentialStatusInput.fromJson(entry.value); + if (value != null) { + map[entry.key] = value; + } + } + } + return map; + } + + // maps a json object with a list of ChangeCredentialStatusInput-objects as value to a dart map + static Map> mapListFromJson(dynamic json, {bool growable = false,}) { + final map = >{}; + if (json is Map && json.isNotEmpty) { + // ignore: parameter_assignments + json = json.cast(); + for (final entry in json.entries) { + map[entry.key] = ChangeCredentialStatusInput.listFromJson(entry.value, growable: growable,); + } + } + return map; + } + + /// The list of required keys that must be present in a JSON. + static const requiredKeys = { + }; +} + diff --git a/clients/dart/credential_issuance_client/lib/model/flow_data.dart b/clients/dart/credential_issuance_client/lib/model/flow_data.dart new file mode 100644 index 00000000..c2d2a843 --- /dev/null +++ b/clients/dart/credential_issuance_client/lib/model/flow_data.dart @@ -0,0 +1,291 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +part of openapi.api; + +class FlowData { + /// Returns a new [FlowData] instance. + FlowData({ + required this.createdAt, + required this.modifiedAt, + required this.id, + this.projectId, + required this.flowId, + required this.credentialTypeId, + required this.jsonLdContextUrl, + required this.jsonSchemaUrl, + this.configurationId, + this.issuedAt, + this.walletId, + this.projectIdConfigurationId, + this.projectIdConfigurationIdWalletId, + this.projectIdConfigurationIdCredentialType, + this.statusListsDetails = const [], + }); + + /// [GEN] ISO 8601 string of the creation date/time the entity + String createdAt; + + /// [GEN] ISO 8601 string of the modification date/time the entity + String modifiedAt; + + String id; + + /// + /// Please note: This property should have been non-nullable! Since the specification file + /// does not include a default value (using the "default:" property), however, the generated + /// source code must fall back to having a nullable type. + /// Consider adding a "default:" property in the specification file to hide this note. + /// + String? projectId; + + String flowId; + + String credentialTypeId; + + String jsonLdContextUrl; + + String jsonSchemaUrl; + + /// Id of configuration, used to issue VC. + /// + /// Please note: This property should have been non-nullable! Since the specification file + /// does not include a default value (using the "default:" property), however, the generated + /// source code must fall back to having a nullable type. + /// Consider adding a "default:" property in the specification file to hide this note. + /// + String? configurationId; + + /// when credential was issued to the holder (holder invoked generateCredentials endpoint) + /// + /// Please note: This property should have been non-nullable! Since the specification file + /// does not include a default value (using the "default:" property), however, the generated + /// source code must fall back to having a nullable type. + /// Consider adding a "default:" property in the specification file to hide this note. + /// + String? issuedAt; + + /// Id of wallet, used to issue VC. + /// + /// Please note: This property should have been non-nullable! Since the specification file + /// does not include a default value (using the "default:" property), however, the generated + /// source code must fall back to having a nullable type. + /// Consider adding a "default:" property in the specification file to hide this note. + /// + String? walletId; + + /// Id of configuration with which VC was issued. To use as an index, it is grouped together with projectId, as \"{projectIdConfigurationId}#{configurationId}\" + /// + /// Please note: This property should have been non-nullable! Since the specification file + /// does not include a default value (using the "default:" property), however, the generated + /// source code must fall back to having a nullable type. + /// Consider adding a "default:" property in the specification file to hide this note. + /// + String? projectIdConfigurationId; + + /// Id of wallet which issued VC. To use as an index, it is grouped together with projectId, as \"{projectIdConfigurationId}#{walletId}\" + /// + /// Please note: This property should have been non-nullable! Since the specification file + /// does not include a default value (using the "default:" property), however, the generated + /// source code must fall back to having a nullable type. + /// Consider adding a "default:" property in the specification file to hide this note. + /// + String? projectIdConfigurationIdWalletId; + + /// VC.type value. To use as an index, it is grouped together with projectId, as \"{projectIdConfigurationId}#{credentialType}\" + /// + /// Please note: This property should have been non-nullable! Since the specification file + /// does not include a default value (using the "default:" property), however, the generated + /// source code must fall back to having a nullable type. + /// Consider adding a "default:" property in the specification file to hide this note. + /// + String? projectIdConfigurationIdCredentialType; + + List statusListsDetails; + + @override + bool operator ==(Object other) => identical(this, other) || other is FlowData && + other.createdAt == createdAt && + other.modifiedAt == modifiedAt && + other.id == id && + other.projectId == projectId && + other.flowId == flowId && + other.credentialTypeId == credentialTypeId && + other.jsonLdContextUrl == jsonLdContextUrl && + other.jsonSchemaUrl == jsonSchemaUrl && + other.configurationId == configurationId && + other.issuedAt == issuedAt && + other.walletId == walletId && + other.projectIdConfigurationId == projectIdConfigurationId && + other.projectIdConfigurationIdWalletId == projectIdConfigurationIdWalletId && + other.projectIdConfigurationIdCredentialType == projectIdConfigurationIdCredentialType && + _deepEquality.equals(other.statusListsDetails, statusListsDetails); + + @override + int get hashCode => + // ignore: unnecessary_parenthesis + (createdAt.hashCode) + + (modifiedAt.hashCode) + + (id.hashCode) + + (projectId == null ? 0 : projectId!.hashCode) + + (flowId.hashCode) + + (credentialTypeId.hashCode) + + (jsonLdContextUrl.hashCode) + + (jsonSchemaUrl.hashCode) + + (configurationId == null ? 0 : configurationId!.hashCode) + + (issuedAt == null ? 0 : issuedAt!.hashCode) + + (walletId == null ? 0 : walletId!.hashCode) + + (projectIdConfigurationId == null ? 0 : projectIdConfigurationId!.hashCode) + + (projectIdConfigurationIdWalletId == null ? 0 : projectIdConfigurationIdWalletId!.hashCode) + + (projectIdConfigurationIdCredentialType == null ? 0 : projectIdConfigurationIdCredentialType!.hashCode) + + (statusListsDetails.hashCode); + + @override + String toString() => 'FlowData[createdAt=$createdAt, modifiedAt=$modifiedAt, id=$id, projectId=$projectId, flowId=$flowId, credentialTypeId=$credentialTypeId, jsonLdContextUrl=$jsonLdContextUrl, jsonSchemaUrl=$jsonSchemaUrl, configurationId=$configurationId, issuedAt=$issuedAt, walletId=$walletId, projectIdConfigurationId=$projectIdConfigurationId, projectIdConfigurationIdWalletId=$projectIdConfigurationIdWalletId, projectIdConfigurationIdCredentialType=$projectIdConfigurationIdCredentialType, statusListsDetails=$statusListsDetails]'; + + Map toJson() { + final json = {}; + json[r'createdAt'] = this.createdAt; + json[r'modifiedAt'] = this.modifiedAt; + json[r'id'] = this.id; + if (this.projectId != null) { + json[r'projectId'] = this.projectId; + } else { + json[r'projectId'] = null; + } + json[r'flowId'] = this.flowId; + json[r'credentialTypeId'] = this.credentialTypeId; + json[r'jsonLdContextUrl'] = this.jsonLdContextUrl; + json[r'jsonSchemaUrl'] = this.jsonSchemaUrl; + if (this.configurationId != null) { + json[r'configurationId'] = this.configurationId; + } else { + json[r'configurationId'] = null; + } + if (this.issuedAt != null) { + json[r'issuedAt'] = this.issuedAt; + } else { + json[r'issuedAt'] = null; + } + if (this.walletId != null) { + json[r'walletId'] = this.walletId; + } else { + json[r'walletId'] = null; + } + if (this.projectIdConfigurationId != null) { + json[r'projectIdConfigurationId'] = this.projectIdConfigurationId; + } else { + json[r'projectIdConfigurationId'] = null; + } + if (this.projectIdConfigurationIdWalletId != null) { + json[r'projectIdConfigurationIdWalletId'] = this.projectIdConfigurationIdWalletId; + } else { + json[r'projectIdConfigurationIdWalletId'] = null; + } + if (this.projectIdConfigurationIdCredentialType != null) { + json[r'projectIdConfigurationIdCredentialType'] = this.projectIdConfigurationIdCredentialType; + } else { + json[r'projectIdConfigurationIdCredentialType'] = null; + } + json[r'statusListsDetails'] = this.statusListsDetails; + return json; + } + + /// Returns a new [FlowData] instance and imports its values from + /// [value] if it's a [Map], null otherwise. + // ignore: prefer_constructors_over_static_methods + static FlowData? fromJson(dynamic value) { + if (value is Map) { + final json = value.cast(); + + // Ensure that the map contains the required keys. + // Note 1: the values aren't checked for validity beyond being non-null. + // Note 2: this code is stripped in release mode! + assert(() { + requiredKeys.forEach((key) { + assert(json.containsKey(key), 'Required key "FlowData[$key]" is missing from JSON.'); + assert(json[key] != null, 'Required key "FlowData[$key]" has a null value in JSON.'); + }); + return true; + }()); + + return FlowData( + createdAt: mapValueOfType(json, r'createdAt')!, + modifiedAt: mapValueOfType(json, r'modifiedAt')!, + id: mapValueOfType(json, r'id')!, + projectId: mapValueOfType(json, r'projectId'), + flowId: mapValueOfType(json, r'flowId')!, + credentialTypeId: mapValueOfType(json, r'credentialTypeId')!, + jsonLdContextUrl: mapValueOfType(json, r'jsonLdContextUrl')!, + jsonSchemaUrl: mapValueOfType(json, r'jsonSchemaUrl')!, + configurationId: mapValueOfType(json, r'configurationId'), + issuedAt: mapValueOfType(json, r'issuedAt'), + walletId: mapValueOfType(json, r'walletId'), + projectIdConfigurationId: mapValueOfType(json, r'projectIdConfigurationId'), + projectIdConfigurationIdWalletId: mapValueOfType(json, r'projectIdConfigurationIdWalletId'), + projectIdConfigurationIdCredentialType: mapValueOfType(json, r'projectIdConfigurationIdCredentialType'), + statusListsDetails: FlowDataStatusListsDetailsInner.listFromJson(json[r'statusListsDetails']), + ); + } + return null; + } + + static List listFromJson(dynamic json, {bool growable = false,}) { + final result = []; + if (json is List && json.isNotEmpty) { + for (final row in json) { + final value = FlowData.fromJson(row); + if (value != null) { + result.add(value); + } + } + } + return result.toList(growable: growable); + } + + static Map mapFromJson(dynamic json) { + final map = {}; + if (json is Map && json.isNotEmpty) { + json = json.cast(); // ignore: parameter_assignments + for (final entry in json.entries) { + final value = FlowData.fromJson(entry.value); + if (value != null) { + map[entry.key] = value; + } + } + } + return map; + } + + // maps a json object with a list of FlowData-objects as value to a dart map + static Map> mapListFromJson(dynamic json, {bool growable = false,}) { + final map = >{}; + if (json is Map && json.isNotEmpty) { + // ignore: parameter_assignments + json = json.cast(); + for (final entry in json.entries) { + map[entry.key] = FlowData.listFromJson(entry.value, growable: growable,); + } + } + return map; + } + + /// The list of required keys that must be present in a JSON. + static const requiredKeys = { + 'createdAt', + 'modifiedAt', + 'id', + 'flowId', + 'credentialTypeId', + 'jsonLdContextUrl', + 'jsonSchemaUrl', + }; +} + diff --git a/clients/dart/credential_issuance_client/lib/model/flow_data_status_lists_details_inner.dart b/clients/dart/credential_issuance_client/lib/model/flow_data_status_lists_details_inner.dart new file mode 100644 index 00000000..865bae08 --- /dev/null +++ b/clients/dart/credential_issuance_client/lib/model/flow_data_status_lists_details_inner.dart @@ -0,0 +1,326 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +part of openapi.api; + +class FlowDataStatusListsDetailsInner { + /// Returns a new [FlowDataStatusListsDetailsInner] instance. + FlowDataStatusListsDetailsInner({ + required this.statusListPurpose, + required this.statusListId, + required this.statusListIndex, + required this.standard, + required this.isActive, + this.statusActivationReason, + this.statusActivatedAt, + }); + + /// Purpose of status list to which credential is added + FlowDataStatusListsDetailsInnerStatusListPurposeEnum statusListPurpose; + + /// id of status list + String statusListId; + + /// as usual it is a number, but all standards use a string + String statusListIndex; + + FlowDataStatusListsDetailsInnerStandardEnum standard; + + /// indicates status is true or not. Default false. + bool isActive; + + /// text reasoning why the status is true (if true). Optional. + /// + /// Please note: This property should have been non-nullable! Since the specification file + /// does not include a default value (using the "default:" property), however, the generated + /// source code must fall back to having a nullable type. + /// Consider adding a "default:" property in the specification file to hide this note. + /// + String? statusActivationReason; + + /// ISO 8601 string of the modification date/time the status. Optional. + /// + /// Please note: This property should have been non-nullable! Since the specification file + /// does not include a default value (using the "default:" property), however, the generated + /// source code must fall back to having a nullable type. + /// Consider adding a "default:" property in the specification file to hide this note. + /// + String? statusActivatedAt; + + @override + bool operator ==(Object other) => identical(this, other) || other is FlowDataStatusListsDetailsInner && + other.statusListPurpose == statusListPurpose && + other.statusListId == statusListId && + other.statusListIndex == statusListIndex && + other.standard == standard && + other.isActive == isActive && + other.statusActivationReason == statusActivationReason && + other.statusActivatedAt == statusActivatedAt; + + @override + int get hashCode => + // ignore: unnecessary_parenthesis + (statusListPurpose.hashCode) + + (statusListId.hashCode) + + (statusListIndex.hashCode) + + (standard.hashCode) + + (isActive.hashCode) + + (statusActivationReason == null ? 0 : statusActivationReason!.hashCode) + + (statusActivatedAt == null ? 0 : statusActivatedAt!.hashCode); + + @override + String toString() => 'FlowDataStatusListsDetailsInner[statusListPurpose=$statusListPurpose, statusListId=$statusListId, statusListIndex=$statusListIndex, standard=$standard, isActive=$isActive, statusActivationReason=$statusActivationReason, statusActivatedAt=$statusActivatedAt]'; + + Map toJson() { + final json = {}; + json[r'statusListPurpose'] = this.statusListPurpose; + json[r'statusListId'] = this.statusListId; + json[r'statusListIndex'] = this.statusListIndex; + json[r'standard'] = this.standard; + json[r'isActive'] = this.isActive; + if (this.statusActivationReason != null) { + json[r'statusActivationReason'] = this.statusActivationReason; + } else { + json[r'statusActivationReason'] = null; + } + if (this.statusActivatedAt != null) { + json[r'statusActivatedAt'] = this.statusActivatedAt; + } else { + json[r'statusActivatedAt'] = null; + } + return json; + } + + /// Returns a new [FlowDataStatusListsDetailsInner] instance and imports its values from + /// [value] if it's a [Map], null otherwise. + // ignore: prefer_constructors_over_static_methods + static FlowDataStatusListsDetailsInner? fromJson(dynamic value) { + if (value is Map) { + final json = value.cast(); + + // Ensure that the map contains the required keys. + // Note 1: the values aren't checked for validity beyond being non-null. + // Note 2: this code is stripped in release mode! + assert(() { + requiredKeys.forEach((key) { + assert(json.containsKey(key), 'Required key "FlowDataStatusListsDetailsInner[$key]" is missing from JSON.'); + assert(json[key] != null, 'Required key "FlowDataStatusListsDetailsInner[$key]" has a null value in JSON.'); + }); + return true; + }()); + + return FlowDataStatusListsDetailsInner( + statusListPurpose: FlowDataStatusListsDetailsInnerStatusListPurposeEnum.fromJson(json[r'statusListPurpose'])!, + statusListId: mapValueOfType(json, r'statusListId')!, + statusListIndex: mapValueOfType(json, r'statusListIndex')!, + standard: FlowDataStatusListsDetailsInnerStandardEnum.fromJson(json[r'standard'])!, + isActive: mapValueOfType(json, r'isActive')!, + statusActivationReason: mapValueOfType(json, r'statusActivationReason'), + statusActivatedAt: mapValueOfType(json, r'statusActivatedAt'), + ); + } + return null; + } + + static List listFromJson(dynamic json, {bool growable = false,}) { + final result = []; + if (json is List && json.isNotEmpty) { + for (final row in json) { + final value = FlowDataStatusListsDetailsInner.fromJson(row); + if (value != null) { + result.add(value); + } + } + } + return result.toList(growable: growable); + } + + static Map mapFromJson(dynamic json) { + final map = {}; + if (json is Map && json.isNotEmpty) { + json = json.cast(); // ignore: parameter_assignments + for (final entry in json.entries) { + final value = FlowDataStatusListsDetailsInner.fromJson(entry.value); + if (value != null) { + map[entry.key] = value; + } + } + } + return map; + } + + // maps a json object with a list of FlowDataStatusListsDetailsInner-objects as value to a dart map + static Map> mapListFromJson(dynamic json, {bool growable = false,}) { + final map = >{}; + if (json is Map && json.isNotEmpty) { + // ignore: parameter_assignments + json = json.cast(); + for (final entry in json.entries) { + map[entry.key] = FlowDataStatusListsDetailsInner.listFromJson(entry.value, growable: growable,); + } + } + return map; + } + + /// The list of required keys that must be present in a JSON. + static const requiredKeys = { + 'statusListPurpose', + 'statusListId', + 'statusListIndex', + 'standard', + 'isActive', + }; +} + +/// Purpose of status list to which credential is added +class FlowDataStatusListsDetailsInnerStatusListPurposeEnum { + /// Instantiate a new enum with the provided [value]. + const FlowDataStatusListsDetailsInnerStatusListPurposeEnum._(this.value); + + /// The underlying value of this enum member. + final String value; + + @override + String toString() => value; + + String toJson() => value; + + static const REVOKED = FlowDataStatusListsDetailsInnerStatusListPurposeEnum._(r'REVOKED'); + + /// List of all possible values in this [enum][FlowDataStatusListsDetailsInnerStatusListPurposeEnum]. + static const values = [ + REVOKED, + ]; + + static FlowDataStatusListsDetailsInnerStatusListPurposeEnum? fromJson(dynamic value) => FlowDataStatusListsDetailsInnerStatusListPurposeEnumTypeTransformer().decode(value); + + static List listFromJson(dynamic json, {bool growable = false,}) { + final result = []; + if (json is List && json.isNotEmpty) { + for (final row in json) { + final value = FlowDataStatusListsDetailsInnerStatusListPurposeEnum.fromJson(row); + if (value != null) { + result.add(value); + } + } + } + return result.toList(growable: growable); + } +} + +/// Transformation class that can [encode] an instance of [FlowDataStatusListsDetailsInnerStatusListPurposeEnum] to String, +/// and [decode] dynamic data back to [FlowDataStatusListsDetailsInnerStatusListPurposeEnum]. +class FlowDataStatusListsDetailsInnerStatusListPurposeEnumTypeTransformer { + factory FlowDataStatusListsDetailsInnerStatusListPurposeEnumTypeTransformer() => _instance ??= const FlowDataStatusListsDetailsInnerStatusListPurposeEnumTypeTransformer._(); + + const FlowDataStatusListsDetailsInnerStatusListPurposeEnumTypeTransformer._(); + + String encode(FlowDataStatusListsDetailsInnerStatusListPurposeEnum data) => data.value; + + /// Decodes a [dynamic value][data] to a FlowDataStatusListsDetailsInnerStatusListPurposeEnum. + /// + /// If [allowNull] is true and the [dynamic value][data] cannot be decoded successfully, + /// then null is returned. However, if [allowNull] is false and the [dynamic value][data] + /// cannot be decoded successfully, then an [UnimplementedError] is thrown. + /// + /// The [allowNull] is very handy when an API changes and a new enum value is added or removed, + /// and users are still using an old app with the old code. + FlowDataStatusListsDetailsInnerStatusListPurposeEnum? decode(dynamic data, {bool allowNull = true}) { + if (data != null) { + switch (data) { + case r'REVOKED': return FlowDataStatusListsDetailsInnerStatusListPurposeEnum.REVOKED; + default: + if (!allowNull) { + throw ArgumentError('Unknown enum value to decode: $data'); + } + } + } + return null; + } + + /// Singleton [FlowDataStatusListsDetailsInnerStatusListPurposeEnumTypeTransformer] instance. + static FlowDataStatusListsDetailsInnerStatusListPurposeEnumTypeTransformer? _instance; +} + + + +class FlowDataStatusListsDetailsInnerStandardEnum { + /// Instantiate a new enum with the provided [value]. + const FlowDataStatusListsDetailsInnerStandardEnum._(this.value); + + /// The underlying value of this enum member. + final String value; + + @override + String toString() => value; + + String toJson() => value; + + static const revocationList2020 = FlowDataStatusListsDetailsInnerStandardEnum._(r'RevocationList2020'); + static const bitstringStatusListV1 = FlowDataStatusListsDetailsInnerStandardEnum._(r'BitstringStatusListV1'); + + /// List of all possible values in this [enum][FlowDataStatusListsDetailsInnerStandardEnum]. + static const values = [ + revocationList2020, + bitstringStatusListV1, + ]; + + static FlowDataStatusListsDetailsInnerStandardEnum? fromJson(dynamic value) => FlowDataStatusListsDetailsInnerStandardEnumTypeTransformer().decode(value); + + static List listFromJson(dynamic json, {bool growable = false,}) { + final result = []; + if (json is List && json.isNotEmpty) { + for (final row in json) { + final value = FlowDataStatusListsDetailsInnerStandardEnum.fromJson(row); + if (value != null) { + result.add(value); + } + } + } + return result.toList(growable: growable); + } +} + +/// Transformation class that can [encode] an instance of [FlowDataStatusListsDetailsInnerStandardEnum] to String, +/// and [decode] dynamic data back to [FlowDataStatusListsDetailsInnerStandardEnum]. +class FlowDataStatusListsDetailsInnerStandardEnumTypeTransformer { + factory FlowDataStatusListsDetailsInnerStandardEnumTypeTransformer() => _instance ??= const FlowDataStatusListsDetailsInnerStandardEnumTypeTransformer._(); + + const FlowDataStatusListsDetailsInnerStandardEnumTypeTransformer._(); + + String encode(FlowDataStatusListsDetailsInnerStandardEnum data) => data.value; + + /// Decodes a [dynamic value][data] to a FlowDataStatusListsDetailsInnerStandardEnum. + /// + /// If [allowNull] is true and the [dynamic value][data] cannot be decoded successfully, + /// then null is returned. However, if [allowNull] is false and the [dynamic value][data] + /// cannot be decoded successfully, then an [UnimplementedError] is thrown. + /// + /// The [allowNull] is very handy when an API changes and a new enum value is added or removed, + /// and users are still using an old app with the old code. + FlowDataStatusListsDetailsInnerStandardEnum? decode(dynamic data, {bool allowNull = true}) { + if (data != null) { + switch (data) { + case r'RevocationList2020': return FlowDataStatusListsDetailsInnerStandardEnum.revocationList2020; + case r'BitstringStatusListV1': return FlowDataStatusListsDetailsInnerStandardEnum.bitstringStatusListV1; + default: + if (!allowNull) { + throw ArgumentError('Unknown enum value to decode: $data'); + } + } + } + return null; + } + + /// Singleton [FlowDataStatusListsDetailsInnerStandardEnumTypeTransformer] instance. + static FlowDataStatusListsDetailsInnerStandardEnumTypeTransformer? _instance; +} + + diff --git a/clients/dart/credential_issuance_client/lib/model/get_status_list_result_dto.dart b/clients/dart/credential_issuance_client/lib/model/get_status_list_result_dto.dart new file mode 100644 index 00000000..f812b2c8 --- /dev/null +++ b/clients/dart/credential_issuance_client/lib/model/get_status_list_result_dto.dart @@ -0,0 +1,109 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +part of openapi.api; + +class GetStatusListResultDto { + /// Returns a new [GetStatusListResultDto] instance. + GetStatusListResultDto({ + required this.revocationListCredential, + }); + + Object revocationListCredential; + + @override + bool operator ==(Object other) => identical(this, other) || other is GetStatusListResultDto && + other.revocationListCredential == revocationListCredential; + + @override + int get hashCode => + // ignore: unnecessary_parenthesis + (revocationListCredential.hashCode); + + @override + String toString() => 'GetStatusListResultDto[revocationListCredential=$revocationListCredential]'; + + Map toJson() { + final json = {}; + json[r'revocationListCredential'] = this.revocationListCredential; + return json; + } + + /// Returns a new [GetStatusListResultDto] instance and imports its values from + /// [value] if it's a [Map], null otherwise. + // ignore: prefer_constructors_over_static_methods + static GetStatusListResultDto? fromJson(dynamic value) { + if (value is Map) { + final json = value.cast(); + + // Ensure that the map contains the required keys. + // Note 1: the values aren't checked for validity beyond being non-null. + // Note 2: this code is stripped in release mode! + assert(() { + requiredKeys.forEach((key) { + assert(json.containsKey(key), 'Required key "GetStatusListResultDto[$key]" is missing from JSON.'); + assert(json[key] != null, 'Required key "GetStatusListResultDto[$key]" has a null value in JSON.'); + }); + return true; + }()); + + return GetStatusListResultDto( + revocationListCredential: mapValueOfType(json, r'revocationListCredential')!, + ); + } + return null; + } + + static List listFromJson(dynamic json, {bool growable = false,}) { + final result = []; + if (json is List && json.isNotEmpty) { + for (final row in json) { + final value = GetStatusListResultDto.fromJson(row); + if (value != null) { + result.add(value); + } + } + } + return result.toList(growable: growable); + } + + static Map mapFromJson(dynamic json) { + final map = {}; + if (json is Map && json.isNotEmpty) { + json = json.cast(); // ignore: parameter_assignments + for (final entry in json.entries) { + final value = GetStatusListResultDto.fromJson(entry.value); + if (value != null) { + map[entry.key] = value; + } + } + } + return map; + } + + // maps a json object with a list of GetStatusListResultDto-objects as value to a dart map + static Map> mapListFromJson(dynamic json, {bool growable = false,}) { + final map = >{}; + if (json is Map && json.isNotEmpty) { + // ignore: parameter_assignments + json = json.cast(); + for (final entry in json.entries) { + map[entry.key] = GetStatusListResultDto.listFromJson(entry.value, growable: growable,); + } + } + return map; + } + + /// The list of required keys that must be present in a JSON. + static const requiredKeys = { + 'revocationListCredential', + }; +} + diff --git a/clients/dart/credential_issuance_client/lib/model/list_issuance_record_response.dart b/clients/dart/credential_issuance_client/lib/model/list_issuance_record_response.dart new file mode 100644 index 00000000..64dd637e --- /dev/null +++ b/clients/dart/credential_issuance_client/lib/model/list_issuance_record_response.dart @@ -0,0 +1,125 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +part of openapi.api; + +class ListIssuanceRecordResponse { + /// Returns a new [ListIssuanceRecordResponse] instance. + ListIssuanceRecordResponse({ + this.flowData = const [], + this.lastEvaluatedKey, + }); + + List flowData; + + /// + /// Please note: This property should have been non-nullable! Since the specification file + /// does not include a default value (using the "default:" property), however, the generated + /// source code must fall back to having a nullable type. + /// Consider adding a "default:" property in the specification file to hide this note. + /// + String? lastEvaluatedKey; + + @override + bool operator ==(Object other) => identical(this, other) || other is ListIssuanceRecordResponse && + _deepEquality.equals(other.flowData, flowData) && + other.lastEvaluatedKey == lastEvaluatedKey; + + @override + int get hashCode => + // ignore: unnecessary_parenthesis + (flowData.hashCode) + + (lastEvaluatedKey == null ? 0 : lastEvaluatedKey!.hashCode); + + @override + String toString() => 'ListIssuanceRecordResponse[flowData=$flowData, lastEvaluatedKey=$lastEvaluatedKey]'; + + Map toJson() { + final json = {}; + json[r'flowData'] = this.flowData; + if (this.lastEvaluatedKey != null) { + json[r'lastEvaluatedKey'] = this.lastEvaluatedKey; + } else { + json[r'lastEvaluatedKey'] = null; + } + return json; + } + + /// Returns a new [ListIssuanceRecordResponse] instance and imports its values from + /// [value] if it's a [Map], null otherwise. + // ignore: prefer_constructors_over_static_methods + static ListIssuanceRecordResponse? fromJson(dynamic value) { + if (value is Map) { + final json = value.cast(); + + // Ensure that the map contains the required keys. + // Note 1: the values aren't checked for validity beyond being non-null. + // Note 2: this code is stripped in release mode! + assert(() { + requiredKeys.forEach((key) { + assert(json.containsKey(key), 'Required key "ListIssuanceRecordResponse[$key]" is missing from JSON.'); + assert(json[key] != null, 'Required key "ListIssuanceRecordResponse[$key]" has a null value in JSON.'); + }); + return true; + }()); + + return ListIssuanceRecordResponse( + flowData: FlowData.listFromJson(json[r'flowData']), + lastEvaluatedKey: mapValueOfType(json, r'lastEvaluatedKey'), + ); + } + return null; + } + + static List listFromJson(dynamic json, {bool growable = false,}) { + final result = []; + if (json is List && json.isNotEmpty) { + for (final row in json) { + final value = ListIssuanceRecordResponse.fromJson(row); + if (value != null) { + result.add(value); + } + } + } + return result.toList(growable: growable); + } + + static Map mapFromJson(dynamic json) { + final map = {}; + if (json is Map && json.isNotEmpty) { + json = json.cast(); // ignore: parameter_assignments + for (final entry in json.entries) { + final value = ListIssuanceRecordResponse.fromJson(entry.value); + if (value != null) { + map[entry.key] = value; + } + } + } + return map; + } + + // maps a json object with a list of ListIssuanceRecordResponse-objects as value to a dart map + static Map> mapListFromJson(dynamic json, {bool growable = false,}) { + final map = >{}; + if (json is Map && json.isNotEmpty) { + // ignore: parameter_assignments + json = json.cast(); + for (final entry in json.entries) { + map[entry.key] = ListIssuanceRecordResponse.listFromJson(entry.value, growable: growable,); + } + } + return map; + } + + /// The list of required keys that must be present in a JSON. + static const requiredKeys = { + }; +} + diff --git a/clients/dart/credential_issuance_client/lib/model/start_issuance_input_data_inner.dart b/clients/dart/credential_issuance_client/lib/model/start_issuance_input_data_inner.dart index 58f76a8a..b4698f38 100644 --- a/clients/dart/credential_issuance_client/lib/model/start_issuance_input_data_inner.dart +++ b/clients/dart/credential_issuance_client/lib/model/start_issuance_input_data_inner.dart @@ -15,6 +15,7 @@ class StartIssuanceInputDataInner { StartIssuanceInputDataInner({ required this.credentialTypeId, this.credentialData = const {}, + this.statusListDetails = const [], this.metaData, }); @@ -24,6 +25,9 @@ class StartIssuanceInputDataInner { /// Object of data to be included in the issued credential ,should match the credential type Map credentialData; + /// Types of status lists to which the credential should be added once issued. If not provided or empty, the credential is not added to any of the status lists. + List statusListDetails; + /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated @@ -36,6 +40,7 @@ class StartIssuanceInputDataInner { bool operator ==(Object other) => identical(this, other) || other is StartIssuanceInputDataInner && other.credentialTypeId == credentialTypeId && _deepEquality.equals(other.credentialData, credentialData) && + _deepEquality.equals(other.statusListDetails, statusListDetails) && other.metaData == metaData; @override @@ -43,15 +48,17 @@ class StartIssuanceInputDataInner { // ignore: unnecessary_parenthesis (credentialTypeId.hashCode) + (credentialData.hashCode) + + (statusListDetails.hashCode) + (metaData == null ? 0 : metaData!.hashCode); @override - String toString() => 'StartIssuanceInputDataInner[credentialTypeId=$credentialTypeId, credentialData=$credentialData, metaData=$metaData]'; + String toString() => 'StartIssuanceInputDataInner[credentialTypeId=$credentialTypeId, credentialData=$credentialData, statusListDetails=$statusListDetails, metaData=$metaData]'; Map toJson() { final json = {}; json[r'credentialTypeId'] = this.credentialTypeId; json[r'credentialData'] = this.credentialData; + json[r'statusListDetails'] = this.statusListDetails; if (this.metaData != null) { json[r'metaData'] = this.metaData; } else { @@ -81,6 +88,7 @@ class StartIssuanceInputDataInner { return StartIssuanceInputDataInner( credentialTypeId: mapValueOfType(json, r'credentialTypeId')!, credentialData: mapCastOfType(json, r'credentialData')!, + statusListDetails: StartIssuanceInputDataInnerStatusListDetailsInner.listFromJson(json[r'statusListDetails']), metaData: StartIssuanceInputDataInnerMetaData.fromJson(json[r'metaData']), ); } diff --git a/clients/dart/credential_issuance_client/lib/model/start_issuance_input_data_inner_status_list_details_inner.dart b/clients/dart/credential_issuance_client/lib/model/start_issuance_input_data_inner_status_list_details_inner.dart new file mode 100644 index 00000000..ba415a19 --- /dev/null +++ b/clients/dart/credential_issuance_client/lib/model/start_issuance_input_data_inner_status_list_details_inner.dart @@ -0,0 +1,268 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +part of openapi.api; + +class StartIssuanceInputDataInnerStatusListDetailsInner { + /// Returns a new [StartIssuanceInputDataInnerStatusListDetailsInner] instance. + StartIssuanceInputDataInnerStatusListDetailsInner({ + this.purpose, + this.standard, + }); + + StartIssuanceInputDataInnerStatusListDetailsInnerPurposeEnum? purpose; + + StartIssuanceInputDataInnerStatusListDetailsInnerStandardEnum? standard; + + @override + bool operator ==(Object other) => identical(this, other) || other is StartIssuanceInputDataInnerStatusListDetailsInner && + other.purpose == purpose && + other.standard == standard; + + @override + int get hashCode => + // ignore: unnecessary_parenthesis + (purpose == null ? 0 : purpose!.hashCode) + + (standard == null ? 0 : standard!.hashCode); + + @override + String toString() => 'StartIssuanceInputDataInnerStatusListDetailsInner[purpose=$purpose, standard=$standard]'; + + Map toJson() { + final json = {}; + if (this.purpose != null) { + json[r'purpose'] = this.purpose; + } else { + json[r'purpose'] = null; + } + if (this.standard != null) { + json[r'standard'] = this.standard; + } else { + json[r'standard'] = null; + } + return json; + } + + /// Returns a new [StartIssuanceInputDataInnerStatusListDetailsInner] instance and imports its values from + /// [value] if it's a [Map], null otherwise. + // ignore: prefer_constructors_over_static_methods + static StartIssuanceInputDataInnerStatusListDetailsInner? fromJson(dynamic value) { + if (value is Map) { + final json = value.cast(); + + // Ensure that the map contains the required keys. + // Note 1: the values aren't checked for validity beyond being non-null. + // Note 2: this code is stripped in release mode! + assert(() { + requiredKeys.forEach((key) { + assert(json.containsKey(key), 'Required key "StartIssuanceInputDataInnerStatusListDetailsInner[$key]" is missing from JSON.'); + assert(json[key] != null, 'Required key "StartIssuanceInputDataInnerStatusListDetailsInner[$key]" has a null value in JSON.'); + }); + return true; + }()); + + return StartIssuanceInputDataInnerStatusListDetailsInner( + purpose: StartIssuanceInputDataInnerStatusListDetailsInnerPurposeEnum.fromJson(json[r'purpose']), + standard: StartIssuanceInputDataInnerStatusListDetailsInnerStandardEnum.fromJson(json[r'standard']), + ); + } + return null; + } + + static List listFromJson(dynamic json, {bool growable = false,}) { + final result = []; + if (json is List && json.isNotEmpty) { + for (final row in json) { + final value = StartIssuanceInputDataInnerStatusListDetailsInner.fromJson(row); + if (value != null) { + result.add(value); + } + } + } + return result.toList(growable: growable); + } + + static Map mapFromJson(dynamic json) { + final map = {}; + if (json is Map && json.isNotEmpty) { + json = json.cast(); // ignore: parameter_assignments + for (final entry in json.entries) { + final value = StartIssuanceInputDataInnerStatusListDetailsInner.fromJson(entry.value); + if (value != null) { + map[entry.key] = value; + } + } + } + return map; + } + + // maps a json object with a list of StartIssuanceInputDataInnerStatusListDetailsInner-objects as value to a dart map + static Map> mapListFromJson(dynamic json, {bool growable = false,}) { + final map = >{}; + if (json is Map && json.isNotEmpty) { + // ignore: parameter_assignments + json = json.cast(); + for (final entry in json.entries) { + map[entry.key] = StartIssuanceInputDataInnerStatusListDetailsInner.listFromJson(entry.value, growable: growable,); + } + } + return map; + } + + /// The list of required keys that must be present in a JSON. + static const requiredKeys = { + }; +} + + +class StartIssuanceInputDataInnerStatusListDetailsInnerPurposeEnum { + /// Instantiate a new enum with the provided [value]. + const StartIssuanceInputDataInnerStatusListDetailsInnerPurposeEnum._(this.value); + + /// The underlying value of this enum member. + final String value; + + @override + String toString() => value; + + String toJson() => value; + + static const REVOCABLE = StartIssuanceInputDataInnerStatusListDetailsInnerPurposeEnum._(r'REVOCABLE'); + + /// List of all possible values in this [enum][StartIssuanceInputDataInnerStatusListDetailsInnerPurposeEnum]. + static const values = [ + REVOCABLE, + ]; + + static StartIssuanceInputDataInnerStatusListDetailsInnerPurposeEnum? fromJson(dynamic value) => StartIssuanceInputDataInnerStatusListDetailsInnerPurposeEnumTypeTransformer().decode(value); + + static List listFromJson(dynamic json, {bool growable = false,}) { + final result = []; + if (json is List && json.isNotEmpty) { + for (final row in json) { + final value = StartIssuanceInputDataInnerStatusListDetailsInnerPurposeEnum.fromJson(row); + if (value != null) { + result.add(value); + } + } + } + return result.toList(growable: growable); + } +} + +/// Transformation class that can [encode] an instance of [StartIssuanceInputDataInnerStatusListDetailsInnerPurposeEnum] to String, +/// and [decode] dynamic data back to [StartIssuanceInputDataInnerStatusListDetailsInnerPurposeEnum]. +class StartIssuanceInputDataInnerStatusListDetailsInnerPurposeEnumTypeTransformer { + factory StartIssuanceInputDataInnerStatusListDetailsInnerPurposeEnumTypeTransformer() => _instance ??= const StartIssuanceInputDataInnerStatusListDetailsInnerPurposeEnumTypeTransformer._(); + + const StartIssuanceInputDataInnerStatusListDetailsInnerPurposeEnumTypeTransformer._(); + + String encode(StartIssuanceInputDataInnerStatusListDetailsInnerPurposeEnum data) => data.value; + + /// Decodes a [dynamic value][data] to a StartIssuanceInputDataInnerStatusListDetailsInnerPurposeEnum. + /// + /// If [allowNull] is true and the [dynamic value][data] cannot be decoded successfully, + /// then null is returned. However, if [allowNull] is false and the [dynamic value][data] + /// cannot be decoded successfully, then an [UnimplementedError] is thrown. + /// + /// The [allowNull] is very handy when an API changes and a new enum value is added or removed, + /// and users are still using an old app with the old code. + StartIssuanceInputDataInnerStatusListDetailsInnerPurposeEnum? decode(dynamic data, {bool allowNull = true}) { + if (data != null) { + switch (data) { + case r'REVOCABLE': return StartIssuanceInputDataInnerStatusListDetailsInnerPurposeEnum.REVOCABLE; + default: + if (!allowNull) { + throw ArgumentError('Unknown enum value to decode: $data'); + } + } + } + return null; + } + + /// Singleton [StartIssuanceInputDataInnerStatusListDetailsInnerPurposeEnumTypeTransformer] instance. + static StartIssuanceInputDataInnerStatusListDetailsInnerPurposeEnumTypeTransformer? _instance; +} + + + +class StartIssuanceInputDataInnerStatusListDetailsInnerStandardEnum { + /// Instantiate a new enum with the provided [value]. + const StartIssuanceInputDataInnerStatusListDetailsInnerStandardEnum._(this.value); + + /// The underlying value of this enum member. + final String value; + + @override + String toString() => value; + + String toJson() => value; + + static const revocationList2020 = StartIssuanceInputDataInnerStatusListDetailsInnerStandardEnum._(r'RevocationList2020'); + static const bitstringStatusListV1 = StartIssuanceInputDataInnerStatusListDetailsInnerStandardEnum._(r'BitstringStatusListV1'); + + /// List of all possible values in this [enum][StartIssuanceInputDataInnerStatusListDetailsInnerStandardEnum]. + static const values = [ + revocationList2020, + bitstringStatusListV1, + ]; + + static StartIssuanceInputDataInnerStatusListDetailsInnerStandardEnum? fromJson(dynamic value) => StartIssuanceInputDataInnerStatusListDetailsInnerStandardEnumTypeTransformer().decode(value); + + static List listFromJson(dynamic json, {bool growable = false,}) { + final result = []; + if (json is List && json.isNotEmpty) { + for (final row in json) { + final value = StartIssuanceInputDataInnerStatusListDetailsInnerStandardEnum.fromJson(row); + if (value != null) { + result.add(value); + } + } + } + return result.toList(growable: growable); + } +} + +/// Transformation class that can [encode] an instance of [StartIssuanceInputDataInnerStatusListDetailsInnerStandardEnum] to String, +/// and [decode] dynamic data back to [StartIssuanceInputDataInnerStatusListDetailsInnerStandardEnum]. +class StartIssuanceInputDataInnerStatusListDetailsInnerStandardEnumTypeTransformer { + factory StartIssuanceInputDataInnerStatusListDetailsInnerStandardEnumTypeTransformer() => _instance ??= const StartIssuanceInputDataInnerStatusListDetailsInnerStandardEnumTypeTransformer._(); + + const StartIssuanceInputDataInnerStatusListDetailsInnerStandardEnumTypeTransformer._(); + + String encode(StartIssuanceInputDataInnerStatusListDetailsInnerStandardEnum data) => data.value; + + /// Decodes a [dynamic value][data] to a StartIssuanceInputDataInnerStatusListDetailsInnerStandardEnum. + /// + /// If [allowNull] is true and the [dynamic value][data] cannot be decoded successfully, + /// then null is returned. However, if [allowNull] is false and the [dynamic value][data] + /// cannot be decoded successfully, then an [UnimplementedError] is thrown. + /// + /// The [allowNull] is very handy when an API changes and a new enum value is added or removed, + /// and users are still using an old app with the old code. + StartIssuanceInputDataInnerStatusListDetailsInnerStandardEnum? decode(dynamic data, {bool allowNull = true}) { + if (data != null) { + switch (data) { + case r'RevocationList2020': return StartIssuanceInputDataInnerStatusListDetailsInnerStandardEnum.revocationList2020; + case r'BitstringStatusListV1': return StartIssuanceInputDataInnerStatusListDetailsInnerStandardEnum.bitstringStatusListV1; + default: + if (!allowNull) { + throw ArgumentError('Unknown enum value to decode: $data'); + } + } + } + return null; + } + + /// Singleton [StartIssuanceInputDataInnerStatusListDetailsInnerStandardEnumTypeTransformer] instance. + static StartIssuanceInputDataInnerStatusListDetailsInnerStandardEnumTypeTransformer? _instance; +} + + diff --git a/clients/dart/credential_issuance_client/test/change_credential_status_input_test.dart b/clients/dart/credential_issuance_client/test/change_credential_status_input_test.dart new file mode 100644 index 00000000..b55254be --- /dev/null +++ b/clients/dart/credential_issuance_client/test/change_credential_status_input_test.dart @@ -0,0 +1,32 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:affinidi_tdk_credential_issuance_client/api.dart'; +import 'package:test/test.dart'; + +// tests for ChangeCredentialStatusInput +void main() { + // final instance = ChangeCredentialStatusInput(); + + group('test ChangeCredentialStatusInput', () { + // String changeReason + test('to test the property `changeReason`', () async { + // TODO + }); + + // String issuanceFlowDataId + test('to test the property `issuanceFlowDataId`', () async { + // TODO + }); + + + }); + +} diff --git a/clients/dart/credential_issuance_client/test/default_api_test.dart b/clients/dart/credential_issuance_client/test/default_api_test.dart new file mode 100644 index 00000000..8c5119b0 --- /dev/null +++ b/clients/dart/credential_issuance_client/test/default_api_test.dart @@ -0,0 +1,48 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:affinidi_tdk_credential_issuance_client/api.dart'; +import 'package:test/test.dart'; + + +/// tests for DefaultApi +void main() { + // final instance = DefaultApi(); + + group('tests for DefaultApi', () { + // change credential status. + // + // change credential status. + // + //Future changeCredentialSatatus(String projectId, String configurationId) async + test('test changeCredentialSatatus', () async { + // TODO + }); + + // Return status list credential + // + // Return status list credential + // + //Future getStatusList(String projectId, String statusListId) async + test('test getStatusList', () async { + // TODO + }); + + // List records + // + // Retrieve a list of issuance data records. + // + //Future listIssuanceDataRecords({ int limit, String exclusiveStartKey }) async + test('test listIssuanceDataRecords', () async { + // TODO + }); + + }); +} diff --git a/clients/dart/credential_issuance_client/test/flow_data_status_lists_details_inner_test.dart b/clients/dart/credential_issuance_client/test/flow_data_status_lists_details_inner_test.dart new file mode 100644 index 00000000..14ea47c5 --- /dev/null +++ b/clients/dart/credential_issuance_client/test/flow_data_status_lists_details_inner_test.dart @@ -0,0 +1,63 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:affinidi_tdk_credential_issuance_client/api.dart'; +import 'package:test/test.dart'; + +// tests for FlowDataStatusListsDetailsInner +void main() { + // final instance = FlowDataStatusListsDetailsInner(); + + group('test FlowDataStatusListsDetailsInner', () { + // Purpose of status list to which credential is added + // String statusListPurpose + test('to test the property `statusListPurpose`', () async { + // TODO + }); + + // id of status list + // String statusListId + test('to test the property `statusListId`', () async { + // TODO + }); + + // as usual it is a number, but all standards use a string + // String statusListIndex + test('to test the property `statusListIndex`', () async { + // TODO + }); + + // String standard + test('to test the property `standard`', () async { + // TODO + }); + + // indicates status is true or not. Default false. + // bool isActive + test('to test the property `isActive`', () async { + // TODO + }); + + // text reasoning why the status is true (if true). Optional. + // String statusActivationReason + test('to test the property `statusActivationReason`', () async { + // TODO + }); + + // ISO 8601 string of the modification date/time the status. Optional. + // String statusActivatedAt + test('to test the property `statusActivatedAt`', () async { + // TODO + }); + + + }); + +} diff --git a/clients/dart/credential_issuance_client/test/flow_data_test.dart b/clients/dart/credential_issuance_client/test/flow_data_test.dart new file mode 100644 index 00000000..5a5af596 --- /dev/null +++ b/clients/dart/credential_issuance_client/test/flow_data_test.dart @@ -0,0 +1,105 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:affinidi_tdk_credential_issuance_client/api.dart'; +import 'package:test/test.dart'; + +// tests for FlowData +void main() { + // final instance = FlowData(); + + group('test FlowData', () { + // [GEN] ISO 8601 string of the creation date/time the entity + // String createdAt + test('to test the property `createdAt`', () async { + // TODO + }); + + // [GEN] ISO 8601 string of the modification date/time the entity + // String modifiedAt + test('to test the property `modifiedAt`', () async { + // TODO + }); + + // String id + test('to test the property `id`', () async { + // TODO + }); + + // String projectId + test('to test the property `projectId`', () async { + // TODO + }); + + // String flowId + test('to test the property `flowId`', () async { + // TODO + }); + + // String credentialTypeId + test('to test the property `credentialTypeId`', () async { + // TODO + }); + + // String jsonLdContextUrl + test('to test the property `jsonLdContextUrl`', () async { + // TODO + }); + + // String jsonSchemaUrl + test('to test the property `jsonSchemaUrl`', () async { + // TODO + }); + + // Id of configuration, used to issue VC. + // String configurationId + test('to test the property `configurationId`', () async { + // TODO + }); + + // when credential was issued to the holder (holder invoked generateCredentials endpoint) + // String issuedAt + test('to test the property `issuedAt`', () async { + // TODO + }); + + // Id of wallet, used to issue VC. + // String walletId + test('to test the property `walletId`', () async { + // TODO + }); + + // Id of configuration with which VC was issued. To use as an index, it is grouped together with projectId, as \"{projectIdConfigurationId}#{configurationId}\" + // String projectIdConfigurationId + test('to test the property `projectIdConfigurationId`', () async { + // TODO + }); + + // Id of wallet which issued VC. To use as an index, it is grouped together with projectId, as \"{projectIdConfigurationId}#{walletId}\" + // String projectIdConfigurationIdWalletId + test('to test the property `projectIdConfigurationIdWalletId`', () async { + // TODO + }); + + // VC.type value. To use as an index, it is grouped together with projectId, as \"{projectIdConfigurationId}#{credentialType}\" + // String projectIdConfigurationIdCredentialType + test('to test the property `projectIdConfigurationIdCredentialType`', () async { + // TODO + }); + + // List statusListsDetails (default value: const []) + test('to test the property `statusListsDetails`', () async { + // TODO + }); + + + }); + +} diff --git a/clients/dart/credential_issuance_client/test/get_status_list_result_dto_test.dart b/clients/dart/credential_issuance_client/test/get_status_list_result_dto_test.dart new file mode 100644 index 00000000..07d022a1 --- /dev/null +++ b/clients/dart/credential_issuance_client/test/get_status_list_result_dto_test.dart @@ -0,0 +1,27 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:affinidi_tdk_credential_issuance_client/api.dart'; +import 'package:test/test.dart'; + +// tests for GetStatusListResultDto +void main() { + // final instance = GetStatusListResultDto(); + + group('test GetStatusListResultDto', () { + // Object revocationListCredential + test('to test the property `revocationListCredential`', () async { + // TODO + }); + + + }); + +} diff --git a/clients/dart/credential_issuance_client/test/list_issuance_record_response_test.dart b/clients/dart/credential_issuance_client/test/list_issuance_record_response_test.dart new file mode 100644 index 00000000..68f0ed3f --- /dev/null +++ b/clients/dart/credential_issuance_client/test/list_issuance_record_response_test.dart @@ -0,0 +1,32 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:affinidi_tdk_credential_issuance_client/api.dart'; +import 'package:test/test.dart'; + +// tests for ListIssuanceRecordResponse +void main() { + // final instance = ListIssuanceRecordResponse(); + + group('test ListIssuanceRecordResponse', () { + // List flowData (default value: const []) + test('to test the property `flowData`', () async { + // TODO + }); + + // String lastEvaluatedKey + test('to test the property `lastEvaluatedKey`', () async { + // TODO + }); + + + }); + +} diff --git a/clients/dart/credential_issuance_client/test/start_issuance_input_data_inner_status_list_details_inner_test.dart b/clients/dart/credential_issuance_client/test/start_issuance_input_data_inner_status_list_details_inner_test.dart new file mode 100644 index 00000000..5462eed7 --- /dev/null +++ b/clients/dart/credential_issuance_client/test/start_issuance_input_data_inner_status_list_details_inner_test.dart @@ -0,0 +1,32 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:affinidi_tdk_credential_issuance_client/api.dart'; +import 'package:test/test.dart'; + +// tests for StartIssuanceInputDataInnerStatusListDetailsInner +void main() { + // final instance = StartIssuanceInputDataInnerStatusListDetailsInner(); + + group('test StartIssuanceInputDataInnerStatusListDetailsInner', () { + // String purpose + test('to test the property `purpose`', () async { + // TODO + }); + + // String standard + test('to test the property `standard`', () async { + // TODO + }); + + + }); + +} diff --git a/clients/dart/iota_client/README.md b/clients/dart/iota_client/README.md index d2ff2a7a..0b3c98f9 100644 --- a/clients/dart/iota_client/README.md +++ b/clients/dart/iota_client/README.md @@ -63,9 +63,9 @@ try { All URIs are relative to *https://apse1.api.affinidi.io/ais* -| Class | Method | HTTP request | Description | -| ------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | ---------------------------------------- | -| _CallbackApi_ | [**iotOIDC4VPCallback**](doc//CallbackApi.md#iotoidc4vpcallback) | **POST** /v1/callback | Processes the callback for OIDC4VP flows | +| Class | Method | HTTP request | Description | +| ------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | ----------- | +| _CallbackApi_ | [**iotOIDC4VPCallback**](doc//CallbackApi.md#iotoidc4vpcallback) | **POST** /v1/callback | | _ConfigurationsApi_ | [**createIotaConfiguration**](doc//ConfigurationsApi.md#createiotaconfiguration) | **POST** /v1/configurations | | _ConfigurationsApi_ | [**deleteIotaConfigurationById**](doc//ConfigurationsApi.md#deleteiotaconfigurationbyid) | **DELETE** /v1/configurations/{configurationId} | | _ConfigurationsApi_ | [**getIotaConfigurationById**](doc//ConfigurationsApi.md#getiotaconfigurationbyid) | **GET** /v1/configurations/{configurationId} | @@ -79,7 +79,7 @@ All URIs are relative to *https://apse1.api.affinidi.io/ais* | _IotaApi_ | [**initiateDataSharingRequest**](doc//IotaApi.md#initiatedatasharingrequest) | **POST** /v1/initiate-data-sharing-request | | _IotaApi_ | [**iotaExchangeCredentials**](doc//IotaApi.md#iotaexchangecredentials) | **POST** /v1/exchange-credentials | | _PexQueryApi_ | [**createPexQuery**](doc//PexQueryApi.md#createpexquery) | **POST** /v1/configurations/{configurationId}/pex-queries | -| _PexQueryApi_ | [**deletePexQueries**](doc//PexQueryApi.md#deletepexqueries) | **POST** /v1/configurations/{configurationId}/delete-queries | deletes pex queries | +| _PexQueryApi_ | [**deletePexQueries**](doc//PexQueryApi.md#deletepexqueries) | **POST** /v1/configurations/{configurationId}/delete-queries | | _PexQueryApi_ | [**deletePexQueryById**](doc//PexQueryApi.md#deletepexquerybyid) | **DELETE** /v1/configurations/{configurationId}/pex-queries/{queryId} | | _PexQueryApi_ | [**getPexQueryById**](doc//PexQueryApi.md#getpexquerybyid) | **GET** /v1/configurations/{configurationId}/pex-queries/{queryId} | | _PexQueryApi_ | [**listPexQueries**](doc//PexQueryApi.md#listpexqueries) | **GET** /v1/configurations/{configurationId}/pex-queries | diff --git a/clients/dart/iota_client/doc/AwsExchangeCredentials.md b/clients/dart/iota_client/doc/AwsExchangeCredentials.md index 9aee06e5..bde5a867 100644 --- a/clients/dart/iota_client/doc/AwsExchangeCredentials.md +++ b/clients/dart/iota_client/doc/AwsExchangeCredentials.md @@ -8,8 +8,8 @@ import 'package:affinidi_tdk_iota_client/api.dart'; ## Properties -| Name | Type | Description | Notes | -| ------------- | ---------- | ------------------------------------------------------------------------ | ----- | -| **assertion** | **String** | JWT signed with a machine token used to secure the web socket connection | +| Name | Type | Description | Notes | +| ------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | +| **assertion** | **String** | A valid JSON Web Token (JWT) that secures the WebSocket connection. The JWT is signed with the key pair's private key used to create the Personal Access Token (PAT). | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/dart/iota_client/doc/AwsExchangeCredentialsProjectToken.md b/clients/dart/iota_client/doc/AwsExchangeCredentialsProjectToken.md index 98a56090..c1d9a767 100644 --- a/clients/dart/iota_client/doc/AwsExchangeCredentialsProjectToken.md +++ b/clients/dart/iota_client/doc/AwsExchangeCredentialsProjectToken.md @@ -8,10 +8,10 @@ import 'package:affinidi_tdk_iota_client/api.dart'; ## Properties -| Name | Type | Description | Notes | -| ------------------- | ---------- | ----------------------------- | ----- | -| **sessionId** | **String** | sessionId generated by client | -| **configurationId** | **String** | iotaConfiguration Id | -| **did** | **String** | Vault DID of the user | +| Name | Type | Description | Notes | +| ------------------- | ---------- | ------------------------------------------------ | ----- | +| **sessionId** | **String** | ID of the session generated by a client. | +| **configurationId** | **String** | ID of the Affinidi Iota Framework configuration. | +| **did** | **String** | The Decentalised Identifier (DID) of the user. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/dart/iota_client/doc/CallbackApi.md b/clients/dart/iota_client/doc/CallbackApi.md index 3ffc0c00..0a987e48 100644 --- a/clients/dart/iota_client/doc/CallbackApi.md +++ b/clients/dart/iota_client/doc/CallbackApi.md @@ -8,17 +8,15 @@ import 'package:affinidi_tdk_iota_client/api.dart'; All URIs are relative to *https://apse1.api.affinidi.io/ais* -| Method | HTTP request | Description | -| ----------------------------------------------------------- | --------------------- | ---------------------------------------- | -| [**iotOIDC4VPCallback**](CallbackApi.md#iotoidc4vpcallback) | **POST** /v1/callback | Processes the callback for OIDC4VP flows | +| Method | HTTP request | Description | +| ----------------------------------------------------------- | --------------------- | ----------- | +| [**iotOIDC4VPCallback**](CallbackApi.md#iotoidc4vpcallback) | **POST** /v1/callback | # **iotOIDC4VPCallback** > CallbackResponseOK iotOIDC4VPCallback(callbackInput) -Processes the callback for OIDC4VP flows - -This endpoint handles callbacks from clients with data from OIDC4VP transactions, including state, presentation submission, and verification tokens. It updates the flow status based on the provided state and communicates the outcome through MQTT, ensuring the transaction's completion or notifying of any errors. +It handles the client's (e.g., Affinidi Vault) callback about the result of the data-sharing request. It may contain the data shared by the user, including the presentation submission, verification token, and state. Using the MQTT protocol, it communicates the completion of the request or if any error occurred. ### Example diff --git a/clients/dart/iota_client/doc/CallbackInput.md b/clients/dart/iota_client/doc/CallbackInput.md index d650adea..ec6f1367 100644 --- a/clients/dart/iota_client/doc/CallbackInput.md +++ b/clients/dart/iota_client/doc/CallbackInput.md @@ -8,13 +8,13 @@ import 'package:affinidi_tdk_iota_client/api.dart'; ## Properties -| Name | Type | Description | Notes | -| -------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------ | ---------- | -| **state** | **String** | A string that must be a valid UUID (version 1-5). | -| **presentationSubmission** | **String** | A string that must be a valid JSON object. The structure of presentation submission should follow OID4VP standard. | [optional] | -| **vpToken** | **String** | A string that must be a valid JSON object. Ensure to escape special characters properly.. | [optional] | -| **error** | **String** | The error should follow the OAuth2 error format (e.g. invalid_request, login_required). Defaults to access_denied | [optional] | -| **errorDescription** | **String** | Description of the error in a human readable format | [optional] | -| **onboarded** | **bool** | Specifies whether the Iota share triggered the creation of a Vault | [optional] | +| Name | Type | Description | Notes | +| -------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **state** | **String** | A randomly generated string that follows a valid UUID (version 1-5) format to validate the session. | +| **presentationSubmission** | **String** | A JSON string format that describes the link between the Verifiable Presentation and Presentation Definition for the verifier. The presentation submission follows the OID4VP standard. | [optional] | +| **vpToken** | **String** | A JSON string format containing the data the user consented to share in a Verifiable Presentation format. The VP Token follows the OID4VP standard. | [optional] | +| **error** | **String** | A short string indicating the error code reported by the service. It follows the OAuth 2.0 error code format (e.g., invalid_request, access_denied). The default is access_denied. | [optional] | +| **errorDescription** | **String** | A human-readable description that provides detailed information about the error. | [optional] | +| **onboarded** | **bool** | It specifies whether the data sharing flow triggered an onboarding process to the Affinidi Vault [New User]. | [optional] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/dart/iota_client/doc/CallbackResponseOK.md b/clients/dart/iota_client/doc/CallbackResponseOK.md index 7664c9a6..2ad6a28e 100644 --- a/clients/dart/iota_client/doc/CallbackResponseOK.md +++ b/clients/dart/iota_client/doc/CallbackResponseOK.md @@ -8,10 +8,10 @@ import 'package:affinidi_tdk_iota_client/api.dart'; ## Properties -| Name | Type | Description | Notes | -| ---------------- | ---------- | ----------------------------------------------------------------- | ---------- | -| **redirectUri** | **String** | URL to which vault will redirect | [optional] | -| **responseCode** | **String** | Code which will be used along with transactionId to retrieve data | [optional] | -| **message** | **String** | A message to vault that flow is updated successfully | +| Name | Type | Description | Notes | +| ---------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **redirectUri** | **String** | The URL to which Affinidi Vault will redirect the user. | [optional] | +| **responseCode** | **String** | A unique identifier to fetch the callback response data. Send this value together with the transactionId to successfully fetch the data. | [optional] | +| **message** | **String** | A message to the Affinidi Vault indicating that the update was successful. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/dart/iota_client/doc/ConfigurationsApi.md b/clients/dart/iota_client/doc/ConfigurationsApi.md index 513053a5..11ddd47e 100644 --- a/clients/dart/iota_client/doc/ConfigurationsApi.md +++ b/clients/dart/iota_client/doc/ConfigurationsApi.md @@ -21,6 +21,8 @@ All URIs are relative to *https://apse1.api.affinidi.io/ais* > IotaConfigurationDto createIotaConfiguration(createIotaConfigurationInput) +Creates a new Affinidi Iota Framework configuration. + ### Example ```dart @@ -66,6 +68,8 @@ try { > deleteIotaConfigurationById(configurationId) +Deletes an Affinidi Iota Framework configuration by ID. + ### Example ```dart @@ -76,7 +80,7 @@ import 'package:affinidi_tdk_iota_client/api.dart'; //defaultApiClient.getAuthentication('ProjectTokenAuth').apiKeyPrefix = 'Bearer'; final api_instance = ConfigurationsApi(); -final configurationId = configurationId_example; // String | iotaConfiguration Id +final configurationId = configurationId_example; // String | ID of the Affinidi Iota Framework configuration. try { api_instance.deleteIotaConfigurationById(configurationId); @@ -87,9 +91,9 @@ try { ### Parameters -| Name | Type | Description | Notes | -| ------------------- | ---------- | -------------------- | ----- | -| **configurationId** | **String** | iotaConfiguration Id | +| Name | Type | Description | Notes | +| ------------------- | ---------- | ------------------------------------------------ | ----- | +| **configurationId** | **String** | ID of the Affinidi Iota Framework configuration. | ### Return type @@ -110,6 +114,8 @@ void (empty response body) > IotaConfigurationDto getIotaConfigurationById(configurationId) +Retrieves the details of an Affinidi Iota Framework configuration. + ### Example ```dart @@ -120,7 +126,7 @@ import 'package:affinidi_tdk_iota_client/api.dart'; //defaultApiClient.getAuthentication('ProjectTokenAuth').apiKeyPrefix = 'Bearer'; final api_instance = ConfigurationsApi(); -final configurationId = configurationId_example; // String | iotaConfiguration Id +final configurationId = configurationId_example; // String | ID of the Affinidi Iota Framework configuration. try { final result = api_instance.getIotaConfigurationById(configurationId); @@ -132,9 +138,9 @@ try { ### Parameters -| Name | Type | Description | Notes | -| ------------------- | ---------- | -------------------- | ----- | -| **configurationId** | **String** | iotaConfiguration Id | +| Name | Type | Description | Notes | +| ------------------- | ---------- | ------------------------------------------------ | ----- | +| **configurationId** | **String** | ID of the Affinidi Iota Framework configuration. | ### Return type @@ -155,14 +161,16 @@ try { > GetIotaConfigurationMetaDataOK getIotaConfigurationMetaData(projectId, configurationId) +Retrieves the client metadata of an Affinidi Iota Framework configuration. + ### Example ```dart import 'package:affinidi_tdk_iota_client/api.dart'; final api_instance = ConfigurationsApi(); -final projectId = projectId_example; // String | project Id -final configurationId = configurationId_example; // String | iotaConfiguration Id +final projectId = projectId_example; // String | The ID of the project. +final configurationId = configurationId_example; // String | ID of the Affinidi Iota Framework configuration. try { final result = api_instance.getIotaConfigurationMetaData(projectId, configurationId); @@ -174,10 +182,10 @@ try { ### Parameters -| Name | Type | Description | Notes | -| ------------------- | ---------- | -------------------- | ----- | -| **projectId** | **String** | project Id | -| **configurationId** | **String** | iotaConfiguration Id | +| Name | Type | Description | Notes | +| ------------------- | ---------- | ------------------------------------------------ | ----- | +| **projectId** | **String** | The ID of the project. | +| **configurationId** | **String** | ID of the Affinidi Iota Framework configuration. | ### Return type @@ -198,6 +206,8 @@ No authorization required > ListConfigurationOK listIotaConfigurations() +List all Affinidi Iota Framework configurations. + ### Example ```dart @@ -240,6 +250,8 @@ This endpoint does not need any parameter. > IotaConfigurationDto updateIotaConfigurationById(configurationId, updateConfigurationByIdInput) +Updates the details of an Affinidi Iota Framework configuration by ID. + ### Example ```dart @@ -250,7 +262,7 @@ import 'package:affinidi_tdk_iota_client/api.dart'; //defaultApiClient.getAuthentication('ProjectTokenAuth').apiKeyPrefix = 'Bearer'; final api_instance = ConfigurationsApi(); -final configurationId = configurationId_example; // String | iotaConfiguration Id +final configurationId = configurationId_example; // String | ID of the Affinidi Iota Framework configuration. final updateConfigurationByIdInput = UpdateConfigurationByIdInput(); // UpdateConfigurationByIdInput | UpdateConfigurationById try { @@ -263,10 +275,10 @@ try { ### Parameters -| Name | Type | Description | Notes | -| -------------------------------- | ------------------------------------------------------------------- | ----------------------- | ----- | -| **configurationId** | **String** | iotaConfiguration Id | -| **updateConfigurationByIdInput** | [**UpdateConfigurationByIdInput**](UpdateConfigurationByIdInput.md) | UpdateConfigurationById | +| Name | Type | Description | Notes | +| -------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------ | ----- | +| **configurationId** | **String** | ID of the Affinidi Iota Framework configuration. | +| **updateConfigurationByIdInput** | [**UpdateConfigurationByIdInput**](UpdateConfigurationByIdInput.md) | UpdateConfigurationById | ### Return type diff --git a/clients/dart/iota_client/doc/ConsentDto.md b/clients/dart/iota_client/doc/ConsentDto.md index f0d97d2a..37ebda62 100644 --- a/clients/dart/iota_client/doc/ConsentDto.md +++ b/clients/dart/iota_client/doc/ConsentDto.md @@ -8,16 +8,16 @@ import 'package:affinidi_tdk_iota_client/api.dart'; ## Properties -| Name | Type | Description | Notes | -| -------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | -| **projectId** | **String** | | -| **id** | **String** | id of the record | -| **userId** | **String** | unique identifier of the user | -| **vcType** | **String** | VC type of shared vc. If the actual VC has several VC types (excluding base types as VerifiableCredential) then for each of the a separate record will be added | -| **status** | **String** | | -| **modifiedAt** | **String** | | -| **modifiedBy** | **String** | | -| **createdAt** | **String** | | -| **createdBy** | **String** | | +| Name | Type | Description | Notes | +| -------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------- | ----- | +| **projectId** | **String** | The ID of the project. | +| **id** | **String** | Unique identifier for the record. | +| **userId** | **String** | Unique identifier for the user. | +| **vcType** | **String** | Type of the VC shared by the user. It creates a consent record for each VC type shared except for the base type VerifiableCredential. | +| **status** | **String** | Status of the consent. | +| **modifiedAt** | **String** | | +| **modifiedBy** | **String** | | +| **createdAt** | **String** | | +| **createdBy** | **String** | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/dart/iota_client/doc/CreateIotaConfigurationInput.md b/clients/dart/iota_client/doc/CreateIotaConfigurationInput.md index 1c390946..2659d12d 100644 --- a/clients/dart/iota_client/doc/CreateIotaConfigurationInput.md +++ b/clients/dart/iota_client/doc/CreateIotaConfigurationInput.md @@ -8,18 +8,18 @@ import 'package:affinidi_tdk_iota_client/api.dart'; ## Properties -| Name | Type | Description | Notes | -| -------------------------- | ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | -| **name** | **String** | The name of the configuration | -| **description** | **String** | Description of the configuration | [optional] | -| **walletAri** | **String** | The wallet Ari that will be used to sign | -| **iotaResponseWebhookURL** | **String** | webhook to call when data is ready | [optional] | -| **enableVerification** | **bool** | | -| **enableConsentAuditLog** | **bool** | | -| **tokenMaxAge** | **int** | token time to live in seconds | [optional] | -| **clientMetadata** | [**IotaConfigurationDtoClientMetadata**](IotaConfigurationDtoClientMetadata.md) | | -| **mode** | **String** | indicates whether the flow is a WebSocket flow or a Redirect flow. This value is used in Vault to determine how to process the data flow request. | [optional] [default to 'websocket'] | -| **redirectUris** | **List** | the URL that the user will be redirected to after the request has been processed; should be provided by the developer of the client application.Required only if mode is Redirect. | [optional] [default to const []] | -| **enableIdvProviders** | **bool** | enables third party IDV provider verification for the given configuration | [optional] | +| Name | Type | Description | Notes | +| -------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------- | +| **name** | **String** | The name of the configuration to quickly identify the resource. | +| **description** | **String** | An optional description of what the configuration is used for. | [optional] | +| **walletAri** | **String** | The unique resource identifier of the Wallet used to sign the request token. | +| **iotaResponseWebhookURL** | **String** | The webhook URL is used for callback when the data is ready. | [optional] | +| **enableVerification** | **bool** | Cryptographically verifies the data shared by the user when enabled. | +| **enableConsentAuditLog** | **bool** | Records the user's consent when they share their data, including the type of data shared when enabled. | +| **tokenMaxAge** | **int** | This is the lifetime of the signed request token during the data-sharing flow. | [optional] | +| **clientMetadata** | [**IotaConfigurationDtoClientMetadata**](IotaConfigurationDtoClientMetadata.md) | | +| **mode** | **String** | Determines whether to handle the data-sharing request using the WebSocket or Redirect flow. | [optional] [default to 'websocket'] | +| **redirectUris** | **List** | List of allowed URLs to redirect users, including the response from the request. This is required if the selected data-sharing mode is Redirect. | [optional] [default to const []] | +| **enableIdvProviders** | **bool** | Enables identity verification from user with a 3rd-party provider when a verified identity document is not found. | [optional] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/dart/iota_client/doc/CreatePexQueryInput.md b/clients/dart/iota_client/doc/CreatePexQueryInput.md index fa23d7a5..7f2968f0 100644 --- a/clients/dart/iota_client/doc/CreatePexQueryInput.md +++ b/clients/dart/iota_client/doc/CreatePexQueryInput.md @@ -8,10 +8,10 @@ import 'package:affinidi_tdk_iota_client/api.dart'; ## Properties -| Name | Type | Description | Notes | -| ---------------- | ---------- | -------------------------------------- | ---------- | -| **name** | **String** | | -| **vpDefinition** | **String** | VP definition in JSON stringify format | -| **description** | **String** | Description of query | [optional] | +| Name | Type | Description | Notes | +| ---------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **name** | **String** | The name of the presentation definition to quickly identify the query. | +| **vpDefinition** | **String** | The presentation definition describing the data requirement that must be satisfied by the user. The value is in a JSON stringify format. | +| **description** | **String** | An optional description of what the query is used for. | [optional] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/dart/iota_client/doc/DefaultApi.md b/clients/dart/iota_client/doc/DefaultApi.md index 554ff107..00936ddf 100644 --- a/clients/dart/iota_client/doc/DefaultApi.md +++ b/clients/dart/iota_client/doc/DefaultApi.md @@ -16,7 +16,7 @@ All URIs are relative to *https://apse1.api.affinidi.io/ais* > ListLoggedConsentsOK listLoggedConsents(configurationId, userId, limit, exclusiveStartKey) -returns a list of logged consents for the project +Lists all the logged consents for a project. ### Example @@ -30,7 +30,7 @@ import 'package:affinidi_tdk_iota_client/api.dart'; final api_instance = DefaultApi(); final configurationId = configurationId_example; // String | final userId = userId_example; // String | -final limit = 56; // int | Maximum number of records to fetch in a list +final limit = 56; // int | The maximum number of records to fetch from the list of logged consents. final exclusiveStartKey = exclusiveStartKey_example; // String | The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation. try { @@ -47,7 +47,7 @@ try { | --------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | | **configurationId** | **String** | | [optional] | | **userId** | **String** | | [optional] | -| **limit** | **int** | Maximum number of records to fetch in a list | [optional] | +| **limit** | **int** | The maximum number of records to fetch from the list of logged consents. | [optional] | | **exclusiveStartKey** | **String** | The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation. | [optional] | ### Return type diff --git a/clients/dart/iota_client/doc/FetchIOTAVPResponseInput.md b/clients/dart/iota_client/doc/FetchIOTAVPResponseInput.md index 07d944fe..139440f5 100644 --- a/clients/dart/iota_client/doc/FetchIOTAVPResponseInput.md +++ b/clients/dart/iota_client/doc/FetchIOTAVPResponseInput.md @@ -8,11 +8,11 @@ import 'package:affinidi_tdk_iota_client/api.dart'; ## Properties -| Name | Type | Description | Notes | -| ------------------- | ---------- | -------------------- | ----- | -| **correlationId** | **String** | The correlation ID | -| **transactionId** | **String** | The transaction ID | -| **responseCode** | **String** | The response code. | -| **configurationId** | **String** | The configuration ID | +| Name | Type | Description | Notes | +| ------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | +| **correlationId** | **String** | A unique, randomly generated identifier that correlates the request and response in the data-sharing request flow. | +| **transactionId** | **String** | A unique, randomly generated identifier data-sharing request flow is initiated. This value is used with the response code to fetch the callback response data. | +| **responseCode** | **String** | A unique identifier to fetch the callback response data. Send this value together with the transactionId to successfully fetch the data. | +| **configurationId** | **String** | ID of the Affinidi Iota Framework configuration. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/dart/iota_client/doc/FetchIOTAVPResponseOK.md b/clients/dart/iota_client/doc/FetchIOTAVPResponseOK.md index e98044cb..92dc0156 100644 --- a/clients/dart/iota_client/doc/FetchIOTAVPResponseOK.md +++ b/clients/dart/iota_client/doc/FetchIOTAVPResponseOK.md @@ -8,10 +8,10 @@ import 'package:affinidi_tdk_iota_client/api.dart'; ## Properties -| Name | Type | Description | Notes | -| -------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------ | ---------- | -| **correlationId** | **String** | A correlationId used for the flow | [optional] | -| **presentationSubmission** | **String** | A string that must be a valid JSON object. The structure of presentation submission should follow OID4VP standard. | [optional] | -| **vpToken** | **String** | A string that must be a valid JSON object. Ensure to escape special characters properly.. | [optional] | +| Name | Type | Description | Notes | +| -------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **correlationId** | **String** | A unique, randomly generated identifier that correlates the request and response in the data-sharing request flow. | [optional] | +| **presentationSubmission** | **String** | A JSON string format that describes the link between the Verifiable Presentation and Presentation Definition for the verifier. The presentation submission follows the OID4VP standard. | [optional] | +| **vpToken** | **String** | A JSON string format containing the data the user consented to share in a Verifiable Presentation format. The VP Token follows the OID4VP standard. | [optional] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/dart/iota_client/doc/GetIotaConfigurationMetaDataOK.md b/clients/dart/iota_client/doc/GetIotaConfigurationMetaDataOK.md index 0171bcae..c4e7612e 100644 --- a/clients/dart/iota_client/doc/GetIotaConfigurationMetaDataOK.md +++ b/clients/dart/iota_client/doc/GetIotaConfigurationMetaDataOK.md @@ -8,10 +8,10 @@ import 'package:affinidi_tdk_iota_client/api.dart'; ## Properties -| Name | Type | Description | Notes | -| ---------- | ---------- | ------------------------------------------------------- | ----- | -| **name** | **String** | application name that will be displayed in consent page | -| **origin** | **String** | origin url that will be displayed in consent page | -| **logo** | **String** | logo url that will be displayed in consent page | +| Name | Type | Description | Notes | +| ---------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----- | +| **name** | **String** | The name displayed on the consent page indicates who is requesting data from the user. It can be the application or website's name. | +| **origin** | **String** | The URL of the requester displayed on the consent page indicates the request's origin. | +| **logo** | **String** | The logo of the requester displayed on the consent page, allowing users to easily recognise who requests the data. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/dart/iota_client/doc/InitiateDataSharingRequestInput.md b/clients/dart/iota_client/doc/InitiateDataSharingRequestInput.md index 046770aa..b9891946 100644 --- a/clients/dart/iota_client/doc/InitiateDataSharingRequestInput.md +++ b/clients/dart/iota_client/doc/InitiateDataSharingRequestInput.md @@ -8,14 +8,14 @@ import 'package:affinidi_tdk_iota_client/api.dart'; ## Properties -| Name | Type | Description | Notes | -| ------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | -| **queryId** | **String** | | -| **correlationId** | **String** | | -| **tokenMaxAge** | **int** | token time to live in seconds | [optional] | -| **nonce** | **String** | Random value used to prevent replay attacks | -| **redirectUri** | **String** | the URL that the user will be redirected to after the request has been processed; should be provided by the developer of the client application. | -| **configurationId** | **String** | id of the IOTA configuration used | -| **mode** | **String** | indicates whether the flow is a WebSocket flow or a Redirect flow. This value is used in Vault to determine how to process the data flow request. | +| Name | Type | Description | Notes | +| ------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ---------- | +| **queryId** | **String** | The ID of the query. | +| **correlationId** | **String** | A unique, randomly generated identifier that correlates the request and response in the data-sharing request flow. | +| **tokenMaxAge** | **int** | This is the lifetime of the signed request token during the data-sharing flow. | [optional] | +| **nonce** | **String** | A randomly generated value that is added in the request and response to prevent replay attacks. | +| **redirectUri** | **String** | List of allowed URLs to redirect users, including the response from the request. This is required if the selected data-sharing mode is Redirect. | +| **configurationId** | **String** | ID of the Affinidi Iota Framework configuration. | +| **mode** | **String** | Determines whether to handle the data-sharing request using the WebSocket or Redirect flow. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/dart/iota_client/doc/IotaApi.md b/clients/dart/iota_client/doc/IotaApi.md index 58925269..ea826819 100644 --- a/clients/dart/iota_client/doc/IotaApi.md +++ b/clients/dart/iota_client/doc/IotaApi.md @@ -20,7 +20,7 @@ All URIs are relative to *https://apse1.api.affinidi.io/ais* > AwsExchangeCredentialsOK awsExchangeCredentials(awsExchangeCredentials) -It exchanges limited token into cognito +Exchange a limited-scoped token into a Cognito credential to generate the identity credential. The identity credential initiates the secure WebSocket connection from the client. This method is used only in WebSocket data-sharing mode. ### Example @@ -63,7 +63,7 @@ No authorization required > IotaExchangeCredentialsOK awsExchangeCredentialsProjectToken(awsExchangeCredentialsProjectToken) -It exchanges project token into cognito +Exchange a Project Scoped Token into an identity credential directly to initiate a secure WebSocket connection. This method is used only in WebSocket data-sharing mode. ### Example @@ -110,7 +110,7 @@ try { > FetchIOTAVPResponseOK fetchIotaVpResponse(fetchIOTAVPResponseInput) -This will get the final data response +Fetches the client's callback that contains the user's shared data in a Verifiable Presentation format after a successful data-sharing flow. ### Example @@ -157,7 +157,7 @@ try { > InitiateDataSharingRequestOK initiateDataSharingRequest(initiateDataSharingRequestInput) -This will initiate data sharing request for the data sharing flow +Generates the request token for the Redirect mode to initiate the data-sharing flow. ### Example @@ -204,7 +204,7 @@ try { > IotaExchangeCredentialsOK iotaExchangeCredentials(iotaExchangeCredentials) -It exchanges limited token into cognito sts identity credentials +Exchange a limited-scoped token into an identity credential directly to initiate a secure WebSocket connection. This method is used only in WebSocket data-sharing mode. ### Example diff --git a/clients/dart/iota_client/doc/IotaConfigurationDto.md b/clients/dart/iota_client/doc/IotaConfigurationDto.md index 052c0645..cfb94360 100644 --- a/clients/dart/iota_client/doc/IotaConfigurationDto.md +++ b/clients/dart/iota_client/doc/IotaConfigurationDto.md @@ -8,20 +8,20 @@ import 'package:affinidi_tdk_iota_client/api.dart'; ## Properties -| Name | Type | Description | Notes | -| -------------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | -| **ari** | **String** | The ARI of the config | -| **configurationId** | **String** | | -| **name** | **String** | The name of the config | -| **projectId** | **String** | | -| **walletAri** | **String** | The wallet Ari that will be used to sign | -| **tokenMaxAge** | **int** | token time to live in seconds | -| **iotaResponseWebhookURL** | **String** | webhook to call when data is ready | [optional] | -| **enableVerification** | **bool** | | -| **enableConsentAuditLog** | **bool** | | -| **clientMetadata** | [**IotaConfigurationDtoClientMetadata**](IotaConfigurationDtoClientMetadata.md) | | -| **mode** | **String** | indicates whether the flow is a WebSocket flow or a Redirect flow. This value is used in Vault to determine how to process the data flow request. | [optional] [default to 'websocket'] | -| **redirectUris** | **List** | the URLs that the user will be redirected to after the request has been processed; should be provided by the developer of the client application.Required only if mode is Redirect. | [optional] [default to const []] | -| **enableIdvProviders** | **bool** | enables third party IDV provider verification for the given configuration | [optional] | +| Name | Type | Description | Notes | +| -------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------- | +| **ari** | **String** | This is a unique resource identifier of the Affinidi Iota Framework configuration. | +| **configurationId** | **String** | ID of the Affinidi Iota Framework configuration. | +| **name** | **String** | The name of the configuration to quickly identify the resource. | +| **projectId** | **String** | The ID of the project. | +| **walletAri** | **String** | The unique resource identifier of the Wallet used to sign the request token. | +| **tokenMaxAge** | **int** | This is the lifetime of the signed request token during the data-sharing flow. | +| **iotaResponseWebhookURL** | **String** | The webhook URL is used for callback when the data is ready. | [optional] | +| **enableVerification** | **bool** | Cryptographically verifies the data shared by the user when enabled. | +| **enableConsentAuditLog** | **bool** | Records the consent the user gave when they shared their data, including the type of data shared. | +| **clientMetadata** | [**IotaConfigurationDtoClientMetadata**](IotaConfigurationDtoClientMetadata.md) | | +| **mode** | **String** | Determines whether to handle the data-sharing request using the WebSocket or Redirect flow. | [optional] [default to 'websocket'] | +| **redirectUris** | **List** | List of allowed URLs to redirect users, including the response from the request. This is required if the selected data-sharing mode is Redirect. | [optional] [default to const []] | +| **enableIdvProviders** | **bool** | Enables identity verification from user with a 3rd-party provider when a verified identity document is not found. | [optional] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/dart/iota_client/doc/IotaConfigurationDtoClientMetadata.md b/clients/dart/iota_client/doc/IotaConfigurationDtoClientMetadata.md index 7447f6fa..d4797356 100644 --- a/clients/dart/iota_client/doc/IotaConfigurationDtoClientMetadata.md +++ b/clients/dart/iota_client/doc/IotaConfigurationDtoClientMetadata.md @@ -8,10 +8,10 @@ import 'package:affinidi_tdk_iota_client/api.dart'; ## Properties -| Name | Type | Description | Notes | -| ---------- | ---------- | ------------------------------------------------------- | ----- | -| **name** | **String** | application name that will be displayed in consent page | -| **origin** | **String** | origin url that will be displayed in consent page | -| **logo** | **String** | logo url that will be displayed in consent page | +| Name | Type | Description | Notes | +| ---------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----- | +| **name** | **String** | The name displayed on the consent page indicates who is requesting data from the user. It can be the application or website's name. | +| **origin** | **String** | The URL of the requester displayed on the consent page indicates the request's origin. | +| **logo** | **String** | The logo of the requester displayed on the consent page, allowing users to easily recognise who requests the data. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/dart/iota_client/doc/IotaExchangeCredentials.md b/clients/dart/iota_client/doc/IotaExchangeCredentials.md index 694f266e..54fbf730 100644 --- a/clients/dart/iota_client/doc/IotaExchangeCredentials.md +++ b/clients/dart/iota_client/doc/IotaExchangeCredentials.md @@ -8,8 +8,8 @@ import 'package:affinidi_tdk_iota_client/api.dart'; ## Properties -| Name | Type | Description | Notes | -| ------------- | ---------- | ------------------------------------------------------------------------ | ----- | -| **assertion** | **String** | JWT signed with a machine token used to secure the web socket connection | +| Name | Type | Description | Notes | +| ------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | +| **assertion** | **String** | A valid JSON Web Token (JWT) that secures the WebSocket connection. The JWT is signed with the key pair's private key used to create the Personal Access Token (PAT). | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/dart/iota_client/doc/PexQueryApi.md b/clients/dart/iota_client/doc/PexQueryApi.md index 577cee05..165049d8 100644 --- a/clients/dart/iota_client/doc/PexQueryApi.md +++ b/clients/dart/iota_client/doc/PexQueryApi.md @@ -8,10 +8,10 @@ import 'package:affinidi_tdk_iota_client/api.dart'; All URIs are relative to *https://apse1.api.affinidi.io/ais* -| Method | HTTP request | Description | -| ----------------------------------------------------------- | --------------------------------------------------------------------- | ------------------- | +| Method | HTTP request | Description | +| ----------------------------------------------------------- | --------------------------------------------------------------------- | ----------- | | [**createPexQuery**](PexQueryApi.md#createpexquery) | **POST** /v1/configurations/{configurationId}/pex-queries | -| [**deletePexQueries**](PexQueryApi.md#deletepexqueries) | **POST** /v1/configurations/{configurationId}/delete-queries | deletes pex queries | +| [**deletePexQueries**](PexQueryApi.md#deletepexqueries) | **POST** /v1/configurations/{configurationId}/delete-queries | | [**deletePexQueryById**](PexQueryApi.md#deletepexquerybyid) | **DELETE** /v1/configurations/{configurationId}/pex-queries/{queryId} | | [**getPexQueryById**](PexQueryApi.md#getpexquerybyid) | **GET** /v1/configurations/{configurationId}/pex-queries/{queryId} | | [**listPexQueries**](PexQueryApi.md#listpexqueries) | **GET** /v1/configurations/{configurationId}/pex-queries | @@ -22,6 +22,8 @@ All URIs are relative to *https://apse1.api.affinidi.io/ais* > PexQueryDto createPexQuery(configurationId, createPexQueryInput) +Creates a new Presentation Definition in the configuration to query data. + ### Example ```dart @@ -32,7 +34,7 @@ import 'package:affinidi_tdk_iota_client/api.dart'; //defaultApiClient.getAuthentication('ProjectTokenAuth').apiKeyPrefix = 'Bearer'; final api_instance = PexQueryApi(); -final configurationId = configurationId_example; // String | iotaConfiguration Id +final configurationId = configurationId_example; // String | ID of the Affinidi Iota Framework configuration. final createPexQueryInput = CreatePexQueryInput(); // CreatePexQueryInput | CreatePexQuery try { @@ -45,10 +47,10 @@ try { ### Parameters -| Name | Type | Description | Notes | -| ----------------------- | ------------------------------------------------- | -------------------- | ----- | -| **configurationId** | **String** | iotaConfiguration Id | -| **createPexQueryInput** | [**CreatePexQueryInput**](CreatePexQueryInput.md) | CreatePexQuery | +| Name | Type | Description | Notes | +| ----------------------- | ------------------------------------------------- | ------------------------------------------------ | ----- | +| **configurationId** | **String** | ID of the Affinidi Iota Framework configuration. | +| **createPexQueryInput** | [**CreatePexQueryInput**](CreatePexQueryInput.md) | CreatePexQuery | ### Return type @@ -69,9 +71,7 @@ try { > deletePexQueries(configurationId) -deletes pex queries - -deletes pex queries +Deletes all Presentation Definition queries of a configuration. ### Example @@ -83,7 +83,7 @@ import 'package:affinidi_tdk_iota_client/api.dart'; //defaultApiClient.getAuthentication('ProjectTokenAuth').apiKeyPrefix = 'Bearer'; final api_instance = PexQueryApi(); -final configurationId = configurationId_example; // String | iotaConfiguration Id +final configurationId = configurationId_example; // String | ID of the Affinidi Iota Framework configuration. try { api_instance.deletePexQueries(configurationId); @@ -94,9 +94,9 @@ try { ### Parameters -| Name | Type | Description | Notes | -| ------------------- | ---------- | -------------------- | ----- | -| **configurationId** | **String** | iotaConfiguration Id | +| Name | Type | Description | Notes | +| ------------------- | ---------- | ------------------------------------------------ | ----- | +| **configurationId** | **String** | ID of the Affinidi Iota Framework configuration. | ### Return type @@ -117,6 +117,8 @@ void (empty response body) > deletePexQueryById(configurationId, queryId) +Deletes a Presentation Definition in the configuration by ID. + ### Example ```dart @@ -127,8 +129,8 @@ import 'package:affinidi_tdk_iota_client/api.dart'; //defaultApiClient.getAuthentication('ProjectTokenAuth').apiKeyPrefix = 'Bearer'; final api_instance = PexQueryApi(); -final configurationId = configurationId_example; // String | iotaConfiguration Id -final queryId = queryId_example; // String | pex-query Id +final configurationId = configurationId_example; // String | ID of the Affinidi Iota Framework configuration. +final queryId = queryId_example; // String | The ID of the query. try { api_instance.deletePexQueryById(configurationId, queryId); @@ -139,10 +141,10 @@ try { ### Parameters -| Name | Type | Description | Notes | -| ------------------- | ---------- | -------------------- | ----- | -| **configurationId** | **String** | iotaConfiguration Id | -| **queryId** | **String** | pex-query Id | +| Name | Type | Description | Notes | +| ------------------- | ---------- | ------------------------------------------------ | ----- | +| **configurationId** | **String** | ID of the Affinidi Iota Framework configuration. | +| **queryId** | **String** | The ID of the query. | ### Return type @@ -163,6 +165,8 @@ void (empty response body) > PexQueryDto getPexQueryById(configurationId, queryId) +Retrieves a Presentation Definition in the configuration by ID. + ### Example ```dart @@ -173,8 +177,8 @@ import 'package:affinidi_tdk_iota_client/api.dart'; //defaultApiClient.getAuthentication('ProjectTokenAuth').apiKeyPrefix = 'Bearer'; final api_instance = PexQueryApi(); -final configurationId = configurationId_example; // String | iotaConfiguration Id -final queryId = queryId_example; // String | pex-query Id +final configurationId = configurationId_example; // String | ID of the Affinidi Iota Framework configuration. +final queryId = queryId_example; // String | The ID of the query. try { final result = api_instance.getPexQueryById(configurationId, queryId); @@ -186,10 +190,10 @@ try { ### Parameters -| Name | Type | Description | Notes | -| ------------------- | ---------- | -------------------- | ----- | -| **configurationId** | **String** | iotaConfiguration Id | -| **queryId** | **String** | pex-query Id | +| Name | Type | Description | Notes | +| ------------------- | ---------- | ------------------------------------------------ | ----- | +| **configurationId** | **String** | ID of the Affinidi Iota Framework configuration. | +| **queryId** | **String** | The ID of the query. | ### Return type @@ -210,6 +214,8 @@ try { > ListPexQueriesOK listPexQueries(configurationId, limit, exclusiveStartKey) +Lists all Presentation Definitions in the configuration. + ### Example ```dart @@ -220,7 +226,7 @@ import 'package:affinidi_tdk_iota_client/api.dart'; //defaultApiClient.getAuthentication('ProjectTokenAuth').apiKeyPrefix = 'Bearer'; final api_instance = PexQueryApi(); -final configurationId = configurationId_example; // String | iotaConfiguration Id +final configurationId = configurationId_example; // String | ID of the Affinidi Iota Framework configuration. final limit = 56; // int | Maximum number of records to fetch in a list final exclusiveStartKey = exclusiveStartKey_example; // String | The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation. @@ -236,7 +242,7 @@ try { | Name | Type | Description | Notes | | --------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | -| **configurationId** | **String** | iotaConfiguration Id | +| **configurationId** | **String** | ID of the Affinidi Iota Framework configuration. | | **limit** | **int** | Maximum number of records to fetch in a list | [optional] | | **exclusiveStartKey** | **String** | The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation. | [optional] | @@ -259,7 +265,7 @@ try { > Object savePexQueries(configurationId, savePexQueriesUpdateInput) -saves all pex queries +Saves all Presentation Definition queries of a configuration. ### Example @@ -271,7 +277,7 @@ import 'package:affinidi_tdk_iota_client/api.dart'; //defaultApiClient.getAuthentication('ProjectTokenAuth').apiKeyPrefix = 'Bearer'; final api_instance = PexQueryApi(); -final configurationId = configurationId_example; // String | iotaConfiguration Id +final configurationId = configurationId_example; // String | ID of the Affinidi Iota Framework configuration. final savePexQueriesUpdateInput = SavePexQueriesUpdateInput(); // SavePexQueriesUpdateInput | SavePexQueriesInput try { @@ -284,10 +290,10 @@ try { ### Parameters -| Name | Type | Description | Notes | -| ----------------------------- | ------------------------------------------------------------- | -------------------- | ----- | -| **configurationId** | **String** | iotaConfiguration Id | -| **savePexQueriesUpdateInput** | [**SavePexQueriesUpdateInput**](SavePexQueriesUpdateInput.md) | SavePexQueriesInput | +| Name | Type | Description | Notes | +| ----------------------------- | ------------------------------------------------------------- | ------------------------------------------------ | ----- | +| **configurationId** | **String** | ID of the Affinidi Iota Framework configuration. | +| **savePexQueriesUpdateInput** | [**SavePexQueriesUpdateInput**](SavePexQueriesUpdateInput.md) | SavePexQueriesInput | ### Return type @@ -308,6 +314,8 @@ try { > PexQueryDto updatePexQueryById(configurationId, queryId, updatePexQueryInput) +Updates the Presentation Definition in the configuration by ID. + ### Example ```dart @@ -318,8 +326,8 @@ import 'package:affinidi_tdk_iota_client/api.dart'; //defaultApiClient.getAuthentication('ProjectTokenAuth').apiKeyPrefix = 'Bearer'; final api_instance = PexQueryApi(); -final configurationId = configurationId_example; // String | iotaConfiguration Id -final queryId = queryId_example; // String | pex-query Id +final configurationId = configurationId_example; // String | ID of the Affinidi Iota Framework configuration. +final queryId = queryId_example; // String | The ID of the query. final updatePexQueryInput = UpdatePexQueryInput(); // UpdatePexQueryInput | UpdatePexQueryById try { @@ -332,11 +340,11 @@ try { ### Parameters -| Name | Type | Description | Notes | -| ----------------------- | ------------------------------------------------- | -------------------- | ----- | -| **configurationId** | **String** | iotaConfiguration Id | -| **queryId** | **String** | pex-query Id | -| **updatePexQueryInput** | [**UpdatePexQueryInput**](UpdatePexQueryInput.md) | UpdatePexQueryById | +| Name | Type | Description | Notes | +| ----------------------- | ------------------------------------------------- | ------------------------------------------------ | ----- | +| **configurationId** | **String** | ID of the Affinidi Iota Framework configuration. | +| **queryId** | **String** | The ID of the query. | +| **updatePexQueryInput** | [**UpdatePexQueryInput**](UpdatePexQueryInput.md) | UpdatePexQueryById | ### Return type diff --git a/clients/dart/iota_client/doc/PexQueryDto.md b/clients/dart/iota_client/doc/PexQueryDto.md index 59eccf82..8c75d53c 100644 --- a/clients/dart/iota_client/doc/PexQueryDto.md +++ b/clients/dart/iota_client/doc/PexQueryDto.md @@ -8,13 +8,13 @@ import 'package:affinidi_tdk_iota_client/api.dart'; ## Properties -| Name | Type | Description | Notes | -| -------------------- | ---------- | -------------------------------------- | ----- | -| **ari** | **String** | | -| **queryId** | **String** | | -| **name** | **String** | | -| **description** | **String** | | -| **configurationAri** | **String** | | -| **vpDefinition** | **String** | VP definition in JSON stringify format | +| Name | Type | Description | Notes | +| -------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ----- | +| **ari** | **String** | The unique resource identifier of the qeuery. | +| **queryId** | **String** | The ID of the query. | +| **name** | **String** | The name of the presentation definition to quickly identify the query. | +| **description** | **String** | An optional description of what the query is used for. | +| **configurationAri** | **String** | The unique resource identifier of the related configuration where the query is defined. | +| **vpDefinition** | **String** | The presentation definition describing the data requirement that must be satisfied by the user. The value is in a JSON stringify format. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/dart/iota_client/doc/PrepareRequest.md b/clients/dart/iota_client/doc/PrepareRequest.md index f0999924..1e2d8c76 100644 --- a/clients/dart/iota_client/doc/PrepareRequest.md +++ b/clients/dart/iota_client/doc/PrepareRequest.md @@ -8,12 +8,12 @@ import 'package:affinidi_tdk_iota_client/api.dart'; ## Properties -| Name | Type | Description | Notes | -| ---------------------- | ---------- | ----------------------------- | ---------- | -| **connectionClientId** | **String** | | -| **queryId** | **String** | | -| **correlationId** | **String** | | -| **tokenMaxAge** | **int** | token time to live in seconds | [optional] | -| **audience** | **String** | | [optional] | +| Name | Type | Description | Notes | +| ---------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------ | ---------- | +| **connectionClientId** | **String** | | +| **queryId** | **String** | | +| **correlationId** | **String** | A unique, randomly generated identifier that correlates the request and response in the data-sharing request flow. | +| **tokenMaxAge** | **int** | This is the lifetime of the signed request token during the data-sharing flow. | [optional] | +| **audience** | **String** | | [optional] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/dart/iota_client/doc/PrepareRequestCreatedData.md b/clients/dart/iota_client/doc/PrepareRequestCreatedData.md index e5a638ff..d4501cc5 100644 --- a/clients/dart/iota_client/doc/PrepareRequestCreatedData.md +++ b/clients/dart/iota_client/doc/PrepareRequestCreatedData.md @@ -8,9 +8,9 @@ import 'package:affinidi_tdk_iota_client/api.dart'; ## Properties -| Name | Type | Description | Notes | -| ----------------- | ---------- | ----------- | ----- | -| **jwt** | **String** | | -| **correlationId** | **String** | | +| Name | Type | Description | Notes | +| ----------------- | ---------- | ------------------------------------------------------------------------------------------------------------------ | ----- | +| **jwt** | **String** | | +| **correlationId** | **String** | A unique, randomly generated identifier that correlates the request and response in the data-sharing request flow. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/dart/iota_client/doc/SavePexQueriesUpdateInputQueriesInner.md b/clients/dart/iota_client/doc/SavePexQueriesUpdateInputQueriesInner.md index 4d89153c..1e7f5724 100644 --- a/clients/dart/iota_client/doc/SavePexQueriesUpdateInputQueriesInner.md +++ b/clients/dart/iota_client/doc/SavePexQueriesUpdateInputQueriesInner.md @@ -8,10 +8,10 @@ import 'package:affinidi_tdk_iota_client/api.dart'; ## Properties -| Name | Type | Description | Notes | -| ---------------- | ---------- | ----------- | ---------- | -| **queryId** | **String** | | -| **vpDefinition** | **String** | | [optional] | -| **description** | **String** | | [optional] | +| Name | Type | Description | Notes | +| ---------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **queryId** | **String** | The ID of the query. | +| **vpDefinition** | **String** | The presentation definition describing the data requirement that must be satisfied by the user. The value is in a JSON stringify format. | [optional] | +| **description** | **String** | An optional description of what the query is used for. | [optional] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/dart/iota_client/doc/UpdateConfigurationByIdInput.md b/clients/dart/iota_client/doc/UpdateConfigurationByIdInput.md index 5e377030..08018410 100644 --- a/clients/dart/iota_client/doc/UpdateConfigurationByIdInput.md +++ b/clients/dart/iota_client/doc/UpdateConfigurationByIdInput.md @@ -8,18 +8,18 @@ import 'package:affinidi_tdk_iota_client/api.dart'; ## Properties -| Name | Type | Description | Notes | -| -------------------------- | ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | -| **name** | **String** | The name of the config | [optional] | -| **walletAri** | **String** | The wallet Ari that will be used to sign | [optional] | -| **iotaResponseWebhookURL** | **String** | webhook to call when data is ready | [optional] | -| **enableVerification** | **bool** | | [optional] | -| **enableConsentAuditLog** | **bool** | | [optional] | -| **tokenMaxAge** | **int** | token time to live in seconds | [optional] | -| **description** | **String** | The description of the config | [optional] | -| **clientMetadata** | [**IotaConfigurationDtoClientMetadata**](IotaConfigurationDtoClientMetadata.md) | | [optional] | -| **mode** | **String** | indicates whether the flow is a WebSocket flow or a Redirect flow. This value is used in Vault to determine how to process the data flow request. | [optional] | -| **redirectUris** | **List** | the URL that the user will be redirected to after the request has been processed; should be provided by the developer of the client application.Required only if mode is Redirect. | [optional] [default to const []] | -| **enableIdvProviders** | **bool** | enables third party IDV provider verification for the given configuration | [optional] | +| Name | Type | Description | Notes | +| -------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------- | +| **name** | **String** | The name of the configuration to quickly identify the resource. | [optional] | +| **walletAri** | **String** | The unique resource identifier of the Wallet used to sign the request token. | [optional] | +| **iotaResponseWebhookURL** | **String** | The webhook URL is used for callback when the data is ready. | [optional] | +| **enableVerification** | **bool** | Cryptographically verifies the data shared by the user when enabled. | [optional] | +| **enableConsentAuditLog** | **bool** | Records the user's consent when they share their data, including the type of data shared when enabled. | [optional] | +| **tokenMaxAge** | **int** | This is the lifetime of the signed request token during the data-sharing flow. | [optional] | +| **description** | **String** | An optional description of what the configuration is used for. | [optional] | +| **clientMetadata** | [**IotaConfigurationDtoClientMetadata**](IotaConfigurationDtoClientMetadata.md) | | [optional] | +| **mode** | **String** | Determines whether to handle the data-sharing request using the WebSocket or Redirect flow. | [optional] | +| **redirectUris** | **List** | List of allowed URLs to redirect users, including the response from the request. This is required if the selected data-sharing mode is Redirect. | [optional] [default to const []] | +| **enableIdvProviders** | **bool** | Enables identity verification from user with a 3rd-party provider when a verified identity document is not found. | [optional] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/dart/iota_client/doc/UpdatePexQueryInput.md b/clients/dart/iota_client/doc/UpdatePexQueryInput.md index 5dd752bf..9d1cc0ce 100644 --- a/clients/dart/iota_client/doc/UpdatePexQueryInput.md +++ b/clients/dart/iota_client/doc/UpdatePexQueryInput.md @@ -8,9 +8,9 @@ import 'package:affinidi_tdk_iota_client/api.dart'; ## Properties -| Name | Type | Description | Notes | -| ---------------- | ---------- | -------------------------------------- | ---------- | -| **vpDefinition** | **String** | VP definition in JSON stringify format | [optional] | -| **description** | **String** | | [optional] | +| Name | Type | Description | Notes | +| ---------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **vpDefinition** | **String** | The presentation definition describing the data requirement that must be satisfied by the user. The value is in a JSON stringify format. | [optional] | +| **description** | **String** | An optional description of what the query is used for. | [optional] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/dart/iota_client/lib/api/callback_api.dart b/clients/dart/iota_client/lib/api/callback_api.dart index 9e89915c..d2ae49f6 100644 --- a/clients/dart/iota_client/lib/api/callback_api.dart +++ b/clients/dart/iota_client/lib/api/callback_api.dart @@ -16,9 +16,7 @@ class CallbackApi { final ApiClient apiClient; - /// Processes the callback for OIDC4VP flows - /// - /// This endpoint handles callbacks from clients with data from OIDC4VP transactions, including state, presentation submission, and verification tokens. It updates the flow status based on the provided state and communicates the outcome through MQTT, ensuring the transaction's completion or notifying of any errors. + /// It handles the client's (e.g., Affinidi Vault) callback about the result of the data-sharing request. It may contain the data shared by the user, including the presentation submission, verification token, and state. Using the MQTT protocol, it communicates the completion of the request or if any error occurred. /// /// Note: This method returns the HTTP [Response]. /// @@ -51,9 +49,7 @@ class CallbackApi { ); } - /// Processes the callback for OIDC4VP flows - /// - /// This endpoint handles callbacks from clients with data from OIDC4VP transactions, including state, presentation submission, and verification tokens. It updates the flow status based on the provided state and communicates the outcome through MQTT, ensuring the transaction's completion or notifying of any errors. + /// It handles the client's (e.g., Affinidi Vault) callback about the result of the data-sharing request. It may contain the data shared by the user, including the presentation submission, verification token, and state. Using the MQTT protocol, it communicates the completion of the request or if any error occurred. /// /// Parameters: /// diff --git a/clients/dart/iota_client/lib/api/configurations_api.dart b/clients/dart/iota_client/lib/api/configurations_api.dart index 92744b71..96dfce1a 100644 --- a/clients/dart/iota_client/lib/api/configurations_api.dart +++ b/clients/dart/iota_client/lib/api/configurations_api.dart @@ -16,7 +16,10 @@ class ConfigurationsApi { final ApiClient apiClient; - /// Performs an HTTP 'POST /v1/configurations' operation and returns the [Response]. + /// Creates a new Affinidi Iota Framework configuration. + /// + /// Note: This method returns the HTTP [Response]. + /// /// Parameters: /// /// * [CreateIotaConfigurationInput] createIotaConfigurationInput (required): @@ -46,6 +49,8 @@ class ConfigurationsApi { ); } + /// Creates a new Affinidi Iota Framework configuration. + /// /// Parameters: /// /// * [CreateIotaConfigurationInput] createIotaConfigurationInput (required): @@ -65,11 +70,14 @@ class ConfigurationsApi { return null; } - /// Performs an HTTP 'DELETE /v1/configurations/{configurationId}' operation and returns the [Response]. + /// Deletes an Affinidi Iota Framework configuration by ID. + /// + /// Note: This method returns the HTTP [Response]. + /// /// Parameters: /// /// * [String] configurationId (required): - /// iotaConfiguration Id + /// ID of the Affinidi Iota Framework configuration. Future deleteIotaConfigurationByIdWithHttpInfo(String configurationId,) async { // ignore: prefer_const_declarations final path = r'/v1/configurations/{configurationId}' @@ -96,10 +104,12 @@ class ConfigurationsApi { ); } + /// Deletes an Affinidi Iota Framework configuration by ID. + /// /// Parameters: /// /// * [String] configurationId (required): - /// iotaConfiguration Id + /// ID of the Affinidi Iota Framework configuration. Future deleteIotaConfigurationById(String configurationId,) async { final response = await deleteIotaConfigurationByIdWithHttpInfo(configurationId,); if (response.statusCode >= HttpStatus.badRequest) { @@ -107,11 +117,14 @@ class ConfigurationsApi { } } - /// Performs an HTTP 'GET /v1/configurations/{configurationId}' operation and returns the [Response]. + /// Retrieves the details of an Affinidi Iota Framework configuration. + /// + /// Note: This method returns the HTTP [Response]. + /// /// Parameters: /// /// * [String] configurationId (required): - /// iotaConfiguration Id + /// ID of the Affinidi Iota Framework configuration. Future getIotaConfigurationByIdWithHttpInfo(String configurationId,) async { // ignore: prefer_const_declarations final path = r'/v1/configurations/{configurationId}' @@ -138,10 +151,12 @@ class ConfigurationsApi { ); } + /// Retrieves the details of an Affinidi Iota Framework configuration. + /// /// Parameters: /// /// * [String] configurationId (required): - /// iotaConfiguration Id + /// ID of the Affinidi Iota Framework configuration. Future getIotaConfigurationById(String configurationId,) async { final response = await getIotaConfigurationByIdWithHttpInfo(configurationId,); if (response.statusCode >= HttpStatus.badRequest) { @@ -157,14 +172,17 @@ class ConfigurationsApi { return null; } - /// Performs an HTTP 'GET /v1/projects/{projectId}/configurations/{configurationId}/metadata' operation and returns the [Response]. + /// Retrieves the client metadata of an Affinidi Iota Framework configuration. + /// + /// Note: This method returns the HTTP [Response]. + /// /// Parameters: /// /// * [String] projectId (required): - /// project Id + /// The ID of the project. /// /// * [String] configurationId (required): - /// iotaConfiguration Id + /// ID of the Affinidi Iota Framework configuration. Future getIotaConfigurationMetaDataWithHttpInfo(String projectId, String configurationId,) async { // ignore: prefer_const_declarations final path = r'/v1/projects/{projectId}/configurations/{configurationId}/metadata' @@ -192,13 +210,15 @@ class ConfigurationsApi { ); } + /// Retrieves the client metadata of an Affinidi Iota Framework configuration. + /// /// Parameters: /// /// * [String] projectId (required): - /// project Id + /// The ID of the project. /// /// * [String] configurationId (required): - /// iotaConfiguration Id + /// ID of the Affinidi Iota Framework configuration. Future getIotaConfigurationMetaData(String projectId, String configurationId,) async { final response = await getIotaConfigurationMetaDataWithHttpInfo(projectId, configurationId,); if (response.statusCode >= HttpStatus.badRequest) { @@ -214,7 +234,9 @@ class ConfigurationsApi { return null; } - /// Performs an HTTP 'GET /v1/configurations' operation and returns the [Response]. + /// List all Affinidi Iota Framework configurations. + /// + /// Note: This method returns the HTTP [Response]. Future listIotaConfigurationsWithHttpInfo() async { // ignore: prefer_const_declarations final path = r'/v1/configurations'; @@ -240,6 +262,7 @@ class ConfigurationsApi { ); } + /// List all Affinidi Iota Framework configurations. Future listIotaConfigurations() async { final response = await listIotaConfigurationsWithHttpInfo(); if (response.statusCode >= HttpStatus.badRequest) { @@ -255,11 +278,14 @@ class ConfigurationsApi { return null; } - /// Performs an HTTP 'PATCH /v1/configurations/{configurationId}' operation and returns the [Response]. + /// Updates the details of an Affinidi Iota Framework configuration by ID. + /// + /// Note: This method returns the HTTP [Response]. + /// /// Parameters: /// /// * [String] configurationId (required): - /// iotaConfiguration Id + /// ID of the Affinidi Iota Framework configuration. /// /// * [UpdateConfigurationByIdInput] updateConfigurationByIdInput (required): /// UpdateConfigurationById @@ -289,10 +315,12 @@ class ConfigurationsApi { ); } + /// Updates the details of an Affinidi Iota Framework configuration by ID. + /// /// Parameters: /// /// * [String] configurationId (required): - /// iotaConfiguration Id + /// ID of the Affinidi Iota Framework configuration. /// /// * [UpdateConfigurationByIdInput] updateConfigurationByIdInput (required): /// UpdateConfigurationById diff --git a/clients/dart/iota_client/lib/api/default_api.dart b/clients/dart/iota_client/lib/api/default_api.dart index 89fdc975..5ecaa9e6 100644 --- a/clients/dart/iota_client/lib/api/default_api.dart +++ b/clients/dart/iota_client/lib/api/default_api.dart @@ -16,7 +16,7 @@ class DefaultApi { final ApiClient apiClient; - /// returns a list of logged consents for the project + /// Lists all the logged consents for a project. /// /// Note: This method returns the HTTP [Response]. /// @@ -27,7 +27,7 @@ class DefaultApi { /// * [String] userId: /// /// * [int] limit: - /// Maximum number of records to fetch in a list + /// The maximum number of records to fetch from the list of logged consents. /// /// * [String] exclusiveStartKey: /// The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation. @@ -69,7 +69,7 @@ class DefaultApi { ); } - /// returns a list of logged consents for the project + /// Lists all the logged consents for a project. /// /// Parameters: /// @@ -78,7 +78,7 @@ class DefaultApi { /// * [String] userId: /// /// * [int] limit: - /// Maximum number of records to fetch in a list + /// The maximum number of records to fetch from the list of logged consents. /// /// * [String] exclusiveStartKey: /// The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation. diff --git a/clients/dart/iota_client/lib/api/iota_api.dart b/clients/dart/iota_client/lib/api/iota_api.dart index 872cfa10..2682e8fe 100644 --- a/clients/dart/iota_client/lib/api/iota_api.dart +++ b/clients/dart/iota_client/lib/api/iota_api.dart @@ -16,7 +16,7 @@ class IotaApi { final ApiClient apiClient; - /// It exchanges limited token into cognito + /// Exchange a limited-scoped token into a Cognito credential to generate the identity credential. The identity credential initiates the secure WebSocket connection from the client. This method is used only in WebSocket data-sharing mode. /// /// Note: This method returns the HTTP [Response]. /// @@ -49,7 +49,7 @@ class IotaApi { ); } - /// It exchanges limited token into cognito + /// Exchange a limited-scoped token into a Cognito credential to generate the identity credential. The identity credential initiates the secure WebSocket connection from the client. This method is used only in WebSocket data-sharing mode. /// /// Parameters: /// @@ -70,7 +70,7 @@ class IotaApi { return null; } - /// It exchanges project token into cognito + /// Exchange a Project Scoped Token into an identity credential directly to initiate a secure WebSocket connection. This method is used only in WebSocket data-sharing mode. /// /// Note: This method returns the HTTP [Response]. /// @@ -103,7 +103,7 @@ class IotaApi { ); } - /// It exchanges project token into cognito + /// Exchange a Project Scoped Token into an identity credential directly to initiate a secure WebSocket connection. This method is used only in WebSocket data-sharing mode. /// /// Parameters: /// @@ -124,7 +124,7 @@ class IotaApi { return null; } - /// This will get the final data response + /// Fetches the client's callback that contains the user's shared data in a Verifiable Presentation format after a successful data-sharing flow. /// /// Note: This method returns the HTTP [Response]. /// @@ -157,7 +157,7 @@ class IotaApi { ); } - /// This will get the final data response + /// Fetches the client's callback that contains the user's shared data in a Verifiable Presentation format after a successful data-sharing flow. /// /// Parameters: /// @@ -178,7 +178,7 @@ class IotaApi { return null; } - /// This will initiate data sharing request for the data sharing flow + /// Generates the request token for the Redirect mode to initiate the data-sharing flow. /// /// Note: This method returns the HTTP [Response]. /// @@ -211,7 +211,7 @@ class IotaApi { ); } - /// This will initiate data sharing request for the data sharing flow + /// Generates the request token for the Redirect mode to initiate the data-sharing flow. /// /// Parameters: /// @@ -232,7 +232,7 @@ class IotaApi { return null; } - /// It exchanges limited token into cognito sts identity credentials + /// Exchange a limited-scoped token into an identity credential directly to initiate a secure WebSocket connection. This method is used only in WebSocket data-sharing mode. /// /// Note: This method returns the HTTP [Response]. /// @@ -265,7 +265,7 @@ class IotaApi { ); } - /// It exchanges limited token into cognito sts identity credentials + /// Exchange a limited-scoped token into an identity credential directly to initiate a secure WebSocket connection. This method is used only in WebSocket data-sharing mode. /// /// Parameters: /// diff --git a/clients/dart/iota_client/lib/api/pex_query_api.dart b/clients/dart/iota_client/lib/api/pex_query_api.dart index ab4b67f9..480c325a 100644 --- a/clients/dart/iota_client/lib/api/pex_query_api.dart +++ b/clients/dart/iota_client/lib/api/pex_query_api.dart @@ -16,11 +16,14 @@ class PexQueryApi { final ApiClient apiClient; - /// Performs an HTTP 'POST /v1/configurations/{configurationId}/pex-queries' operation and returns the [Response]. + /// Creates a new Presentation Definition in the configuration to query data. + /// + /// Note: This method returns the HTTP [Response]. + /// /// Parameters: /// /// * [String] configurationId (required): - /// iotaConfiguration Id + /// ID of the Affinidi Iota Framework configuration. /// /// * [CreatePexQueryInput] createPexQueryInput (required): /// CreatePexQuery @@ -50,10 +53,12 @@ class PexQueryApi { ); } + /// Creates a new Presentation Definition in the configuration to query data. + /// /// Parameters: /// /// * [String] configurationId (required): - /// iotaConfiguration Id + /// ID of the Affinidi Iota Framework configuration. /// /// * [CreatePexQueryInput] createPexQueryInput (required): /// CreatePexQuery @@ -72,16 +77,14 @@ class PexQueryApi { return null; } - /// deletes pex queries - /// - /// deletes pex queries + /// Deletes all Presentation Definition queries of a configuration. /// /// Note: This method returns the HTTP [Response]. /// /// Parameters: /// /// * [String] configurationId (required): - /// iotaConfiguration Id + /// ID of the Affinidi Iota Framework configuration. Future deletePexQueriesWithHttpInfo(String configurationId,) async { // ignore: prefer_const_declarations final path = r'/v1/configurations/{configurationId}/delete-queries' @@ -108,14 +111,12 @@ class PexQueryApi { ); } - /// deletes pex queries - /// - /// deletes pex queries + /// Deletes all Presentation Definition queries of a configuration. /// /// Parameters: /// /// * [String] configurationId (required): - /// iotaConfiguration Id + /// ID of the Affinidi Iota Framework configuration. Future deletePexQueries(String configurationId,) async { final response = await deletePexQueriesWithHttpInfo(configurationId,); if (response.statusCode >= HttpStatus.badRequest) { @@ -123,14 +124,17 @@ class PexQueryApi { } } - /// Performs an HTTP 'DELETE /v1/configurations/{configurationId}/pex-queries/{queryId}' operation and returns the [Response]. + /// Deletes a Presentation Definition in the configuration by ID. + /// + /// Note: This method returns the HTTP [Response]. + /// /// Parameters: /// /// * [String] configurationId (required): - /// iotaConfiguration Id + /// ID of the Affinidi Iota Framework configuration. /// /// * [String] queryId (required): - /// pex-query Id + /// The ID of the query. Future deletePexQueryByIdWithHttpInfo(String configurationId, String queryId,) async { // ignore: prefer_const_declarations final path = r'/v1/configurations/{configurationId}/pex-queries/{queryId}' @@ -158,13 +162,15 @@ class PexQueryApi { ); } + /// Deletes a Presentation Definition in the configuration by ID. + /// /// Parameters: /// /// * [String] configurationId (required): - /// iotaConfiguration Id + /// ID of the Affinidi Iota Framework configuration. /// /// * [String] queryId (required): - /// pex-query Id + /// The ID of the query. Future deletePexQueryById(String configurationId, String queryId,) async { final response = await deletePexQueryByIdWithHttpInfo(configurationId, queryId,); if (response.statusCode >= HttpStatus.badRequest) { @@ -172,14 +178,17 @@ class PexQueryApi { } } - /// Performs an HTTP 'GET /v1/configurations/{configurationId}/pex-queries/{queryId}' operation and returns the [Response]. + /// Retrieves a Presentation Definition in the configuration by ID. + /// + /// Note: This method returns the HTTP [Response]. + /// /// Parameters: /// /// * [String] configurationId (required): - /// iotaConfiguration Id + /// ID of the Affinidi Iota Framework configuration. /// /// * [String] queryId (required): - /// pex-query Id + /// The ID of the query. Future getPexQueryByIdWithHttpInfo(String configurationId, String queryId,) async { // ignore: prefer_const_declarations final path = r'/v1/configurations/{configurationId}/pex-queries/{queryId}' @@ -207,13 +216,15 @@ class PexQueryApi { ); } + /// Retrieves a Presentation Definition in the configuration by ID. + /// /// Parameters: /// /// * [String] configurationId (required): - /// iotaConfiguration Id + /// ID of the Affinidi Iota Framework configuration. /// /// * [String] queryId (required): - /// pex-query Id + /// The ID of the query. Future getPexQueryById(String configurationId, String queryId,) async { final response = await getPexQueryByIdWithHttpInfo(configurationId, queryId,); if (response.statusCode >= HttpStatus.badRequest) { @@ -229,11 +240,14 @@ class PexQueryApi { return null; } - /// Performs an HTTP 'GET /v1/configurations/{configurationId}/pex-queries' operation and returns the [Response]. + /// Lists all Presentation Definitions in the configuration. + /// + /// Note: This method returns the HTTP [Response]. + /// /// Parameters: /// /// * [String] configurationId (required): - /// iotaConfiguration Id + /// ID of the Affinidi Iota Framework configuration. /// /// * [int] limit: /// Maximum number of records to fetch in a list @@ -273,10 +287,12 @@ class PexQueryApi { ); } + /// Lists all Presentation Definitions in the configuration. + /// /// Parameters: /// /// * [String] configurationId (required): - /// iotaConfiguration Id + /// ID of the Affinidi Iota Framework configuration. /// /// * [int] limit: /// Maximum number of records to fetch in a list @@ -298,14 +314,14 @@ class PexQueryApi { return null; } - /// saves all pex queries + /// Saves all Presentation Definition queries of a configuration. /// /// Note: This method returns the HTTP [Response]. /// /// Parameters: /// /// * [String] configurationId (required): - /// iotaConfiguration Id + /// ID of the Affinidi Iota Framework configuration. /// /// * [SavePexQueriesUpdateInput] savePexQueriesUpdateInput (required): /// SavePexQueriesInput @@ -335,12 +351,12 @@ class PexQueryApi { ); } - /// saves all pex queries + /// Saves all Presentation Definition queries of a configuration. /// /// Parameters: /// /// * [String] configurationId (required): - /// iotaConfiguration Id + /// ID of the Affinidi Iota Framework configuration. /// /// * [SavePexQueriesUpdateInput] savePexQueriesUpdateInput (required): /// SavePexQueriesInput @@ -359,14 +375,17 @@ class PexQueryApi { return null; } - /// Performs an HTTP 'PATCH /v1/configurations/{configurationId}/pex-queries/{queryId}' operation and returns the [Response]. + /// Updates the Presentation Definition in the configuration by ID. + /// + /// Note: This method returns the HTTP [Response]. + /// /// Parameters: /// /// * [String] configurationId (required): - /// iotaConfiguration Id + /// ID of the Affinidi Iota Framework configuration. /// /// * [String] queryId (required): - /// pex-query Id + /// The ID of the query. /// /// * [UpdatePexQueryInput] updatePexQueryInput (required): /// UpdatePexQueryById @@ -397,13 +416,15 @@ class PexQueryApi { ); } + /// Updates the Presentation Definition in the configuration by ID. + /// /// Parameters: /// /// * [String] configurationId (required): - /// iotaConfiguration Id + /// ID of the Affinidi Iota Framework configuration. /// /// * [String] queryId (required): - /// pex-query Id + /// The ID of the query. /// /// * [UpdatePexQueryInput] updatePexQueryInput (required): /// UpdatePexQueryById diff --git a/clients/dart/iota_client/lib/model/aws_exchange_credentials.dart b/clients/dart/iota_client/lib/model/aws_exchange_credentials.dart index 85099981..6f4e2912 100644 --- a/clients/dart/iota_client/lib/model/aws_exchange_credentials.dart +++ b/clients/dart/iota_client/lib/model/aws_exchange_credentials.dart @@ -16,7 +16,7 @@ class AwsExchangeCredentials { required this.assertion, }); - /// JWT signed with a machine token used to secure the web socket connection + /// A valid JSON Web Token (JWT) that secures the WebSocket connection. The JWT is signed with the key pair's private key used to create the Personal Access Token (PAT). String assertion; @override diff --git a/clients/dart/iota_client/lib/model/aws_exchange_credentials_project_token.dart b/clients/dart/iota_client/lib/model/aws_exchange_credentials_project_token.dart index 919e956d..cd74cecc 100644 --- a/clients/dart/iota_client/lib/model/aws_exchange_credentials_project_token.dart +++ b/clients/dart/iota_client/lib/model/aws_exchange_credentials_project_token.dart @@ -18,13 +18,13 @@ class AwsExchangeCredentialsProjectToken { required this.did, }); - /// sessionId generated by client + /// ID of the session generated by a client. String sessionId; - /// iotaConfiguration Id + /// ID of the Affinidi Iota Framework configuration. String configurationId; - /// Vault DID of the user + /// The Decentalised Identifier (DID) of the user. String did; @override diff --git a/clients/dart/iota_client/lib/model/callback_input.dart b/clients/dart/iota_client/lib/model/callback_input.dart index f19155c4..c596b654 100644 --- a/clients/dart/iota_client/lib/model/callback_input.dart +++ b/clients/dart/iota_client/lib/model/callback_input.dart @@ -21,10 +21,10 @@ class CallbackInput { this.onboarded, }); - /// A string that must be a valid UUID (version 1-5). + /// A randomly generated string that follows a valid UUID (version 1-5) format to validate the session. String state; - /// A string that must be a valid JSON object. The structure of presentation submission should follow OID4VP standard. + /// A JSON string format that describes the link between the Verifiable Presentation and Presentation Definition for the verifier. The presentation submission follows the OID4VP standard. /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated @@ -33,7 +33,7 @@ class CallbackInput { /// String? presentationSubmission; - /// A string that must be a valid JSON object. Ensure to escape special characters properly.. + /// A JSON string format containing the data the user consented to share in a Verifiable Presentation format. The VP Token follows the OID4VP standard. /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated @@ -42,7 +42,7 @@ class CallbackInput { /// String? vpToken; - /// The error should follow the OAuth2 error format (e.g. invalid_request, login_required). Defaults to access_denied + /// A short string indicating the error code reported by the service. It follows the OAuth 2.0 error code format (e.g., invalid_request, access_denied). The default is access_denied. /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated @@ -51,7 +51,7 @@ class CallbackInput { /// String? error; - /// Description of the error in a human readable format + /// A human-readable description that provides detailed information about the error. /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated @@ -60,7 +60,7 @@ class CallbackInput { /// String? errorDescription; - /// Specifies whether the Iota share triggered the creation of a Vault + /// It specifies whether the data sharing flow triggered an onboarding process to the Affinidi Vault [New User]. /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated diff --git a/clients/dart/iota_client/lib/model/callback_response_ok.dart b/clients/dart/iota_client/lib/model/callback_response_ok.dart index 68f77139..dfe87917 100644 --- a/clients/dart/iota_client/lib/model/callback_response_ok.dart +++ b/clients/dart/iota_client/lib/model/callback_response_ok.dart @@ -18,7 +18,7 @@ class CallbackResponseOK { required this.message, }); - /// URL to which vault will redirect + /// The URL to which Affinidi Vault will redirect the user. /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated @@ -27,7 +27,7 @@ class CallbackResponseOK { /// String? redirectUri; - /// Code which will be used along with transactionId to retrieve data + /// A unique identifier to fetch the callback response data. Send this value together with the transactionId to successfully fetch the data. /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated @@ -36,7 +36,7 @@ class CallbackResponseOK { /// String? responseCode; - /// A message to vault that flow is updated successfully + /// A message to the Affinidi Vault indicating that the update was successful. String message; @override diff --git a/clients/dart/iota_client/lib/model/consent_dto.dart b/clients/dart/iota_client/lib/model/consent_dto.dart index aec7c387..6ab3cf73 100644 --- a/clients/dart/iota_client/lib/model/consent_dto.dart +++ b/clients/dart/iota_client/lib/model/consent_dto.dart @@ -24,17 +24,19 @@ class ConsentDto { required this.createdBy, }); + /// The ID of the project. String projectId; - /// id of the record + /// Unique identifier for the record. String id; - /// unique identifier of the user + /// Unique identifier for the user. String userId; - /// VC type of shared vc. If the actual VC has several VC types (excluding base types as VerifiableCredential) then for each of the a separate record will be added + /// Type of the VC shared by the user. It creates a consent record for each VC type shared except for the base type VerifiableCredential. String vcType; + /// Status of the consent. ConsentDtoStatusEnum status; String modifiedAt; @@ -174,7 +176,7 @@ class ConsentDto { }; } - +/// Status of the consent. class ConsentDtoStatusEnum { /// Instantiate a new enum with the provided [value]. const ConsentDtoStatusEnum._(this.value); diff --git a/clients/dart/iota_client/lib/model/create_iota_configuration_input.dart b/clients/dart/iota_client/lib/model/create_iota_configuration_input.dart index 84464ef2..dc2ff33f 100644 --- a/clients/dart/iota_client/lib/model/create_iota_configuration_input.dart +++ b/clients/dart/iota_client/lib/model/create_iota_configuration_input.dart @@ -26,10 +26,10 @@ class CreateIotaConfigurationInput { this.enableIdvProviders, }); - /// The name of the configuration + /// The name of the configuration to quickly identify the resource. String name; - /// Description of the configuration + /// An optional description of what the configuration is used for. /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated @@ -38,10 +38,10 @@ class CreateIotaConfigurationInput { /// String? description; - /// The wallet Ari that will be used to sign + /// The unique resource identifier of the Wallet used to sign the request token. String walletAri; - /// webhook to call when data is ready + /// The webhook URL is used for callback when the data is ready. /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated @@ -50,11 +50,13 @@ class CreateIotaConfigurationInput { /// String? iotaResponseWebhookURL; + /// Cryptographically verifies the data shared by the user when enabled. bool enableVerification; + /// Records the user's consent when they share their data, including the type of data shared when enabled. bool enableConsentAuditLog; - /// token time to live in seconds + /// This is the lifetime of the signed request token during the data-sharing flow. /// /// Minimum value: 1 /// @@ -67,13 +69,13 @@ class CreateIotaConfigurationInput { IotaConfigurationDtoClientMetadata clientMetadata; - /// indicates whether the flow is a WebSocket flow or a Redirect flow. This value is used in Vault to determine how to process the data flow request. + /// Determines whether to handle the data-sharing request using the WebSocket or Redirect flow. CreateIotaConfigurationInputModeEnum mode; - /// the URL that the user will be redirected to after the request has been processed; should be provided by the developer of the client application.Required only if mode is Redirect. + /// List of allowed URLs to redirect users, including the response from the request. This is required if the selected data-sharing mode is Redirect. List redirectUris; - /// enables third party IDV provider verification for the given configuration + /// Enables identity verification from user with a 3rd-party provider when a verified identity document is not found. /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated @@ -233,7 +235,7 @@ class CreateIotaConfigurationInput { }; } -/// indicates whether the flow is a WebSocket flow or a Redirect flow. This value is used in Vault to determine how to process the data flow request. +/// Determines whether to handle the data-sharing request using the WebSocket or Redirect flow. class CreateIotaConfigurationInputModeEnum { /// Instantiate a new enum with the provided [value]. const CreateIotaConfigurationInputModeEnum._(this.value); diff --git a/clients/dart/iota_client/lib/model/create_pex_query_input.dart b/clients/dart/iota_client/lib/model/create_pex_query_input.dart index 8b3d77ad..e80564d4 100644 --- a/clients/dart/iota_client/lib/model/create_pex_query_input.dart +++ b/clients/dart/iota_client/lib/model/create_pex_query_input.dart @@ -18,12 +18,13 @@ class CreatePexQueryInput { this.description, }); + /// The name of the presentation definition to quickly identify the query. String name; - /// VP definition in JSON stringify format + /// The presentation definition describing the data requirement that must be satisfied by the user. The value is in a JSON stringify format. String vpDefinition; - /// Description of query + /// An optional description of what the query is used for. /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated diff --git a/clients/dart/iota_client/lib/model/fetch_iotavp_response_input.dart b/clients/dart/iota_client/lib/model/fetch_iotavp_response_input.dart index 49b6ba31..ababd48a 100644 --- a/clients/dart/iota_client/lib/model/fetch_iotavp_response_input.dart +++ b/clients/dart/iota_client/lib/model/fetch_iotavp_response_input.dart @@ -19,16 +19,16 @@ class FetchIOTAVPResponseInput { required this.configurationId, }); - /// The correlation ID + /// A unique, randomly generated identifier that correlates the request and response in the data-sharing request flow. String correlationId; - /// The transaction ID + /// A unique, randomly generated identifier data-sharing request flow is initiated. This value is used with the response code to fetch the callback response data. String transactionId; - /// The response code. + /// A unique identifier to fetch the callback response data. Send this value together with the transactionId to successfully fetch the data. String responseCode; - /// The configuration ID + /// ID of the Affinidi Iota Framework configuration. String configurationId; @override diff --git a/clients/dart/iota_client/lib/model/fetch_iotavp_response_ok.dart b/clients/dart/iota_client/lib/model/fetch_iotavp_response_ok.dart index e99ee04a..4ae36184 100644 --- a/clients/dart/iota_client/lib/model/fetch_iotavp_response_ok.dart +++ b/clients/dart/iota_client/lib/model/fetch_iotavp_response_ok.dart @@ -18,7 +18,7 @@ class FetchIOTAVPResponseOK { this.vpToken, }); - /// A correlationId used for the flow + /// A unique, randomly generated identifier that correlates the request and response in the data-sharing request flow. /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated @@ -27,7 +27,7 @@ class FetchIOTAVPResponseOK { /// String? correlationId; - /// A string that must be a valid JSON object. The structure of presentation submission should follow OID4VP standard. + /// A JSON string format that describes the link between the Verifiable Presentation and Presentation Definition for the verifier. The presentation submission follows the OID4VP standard. /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated @@ -36,7 +36,7 @@ class FetchIOTAVPResponseOK { /// String? presentationSubmission; - /// A string that must be a valid JSON object. Ensure to escape special characters properly.. + /// A JSON string format containing the data the user consented to share in a Verifiable Presentation format. The VP Token follows the OID4VP standard. /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated diff --git a/clients/dart/iota_client/lib/model/get_iota_configuration_meta_data_ok.dart b/clients/dart/iota_client/lib/model/get_iota_configuration_meta_data_ok.dart index 21fa176e..fcbe75e6 100644 --- a/clients/dart/iota_client/lib/model/get_iota_configuration_meta_data_ok.dart +++ b/clients/dart/iota_client/lib/model/get_iota_configuration_meta_data_ok.dart @@ -18,13 +18,13 @@ class GetIotaConfigurationMetaDataOK { required this.logo, }); - /// application name that will be displayed in consent page + /// The name displayed on the consent page indicates who is requesting data from the user. It can be the application or website's name. String name; - /// origin url that will be displayed in consent page + /// The URL of the requester displayed on the consent page indicates the request's origin. String origin; - /// logo url that will be displayed in consent page + /// The logo of the requester displayed on the consent page, allowing users to easily recognise who requests the data. String logo; @override diff --git a/clients/dart/iota_client/lib/model/initiate_data_sharing_request_input.dart b/clients/dart/iota_client/lib/model/initiate_data_sharing_request_input.dart index a6ba6e71..b34af34d 100644 --- a/clients/dart/iota_client/lib/model/initiate_data_sharing_request_input.dart +++ b/clients/dart/iota_client/lib/model/initiate_data_sharing_request_input.dart @@ -22,11 +22,13 @@ class InitiateDataSharingRequestInput { required this.mode, }); + /// The ID of the query. String queryId; + /// A unique, randomly generated identifier that correlates the request and response in the data-sharing request flow. String correlationId; - /// token time to live in seconds + /// This is the lifetime of the signed request token during the data-sharing flow. /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated @@ -35,16 +37,16 @@ class InitiateDataSharingRequestInput { /// int? tokenMaxAge; - /// Random value used to prevent replay attacks + /// A randomly generated value that is added in the request and response to prevent replay attacks. String nonce; - /// the URL that the user will be redirected to after the request has been processed; should be provided by the developer of the client application. + /// List of allowed URLs to redirect users, including the response from the request. This is required if the selected data-sharing mode is Redirect. String redirectUri; - /// id of the IOTA configuration used + /// ID of the Affinidi Iota Framework configuration. String configurationId; - /// indicates whether the flow is a WebSocket flow or a Redirect flow. This value is used in Vault to determine how to process the data flow request. + /// Determines whether to handle the data-sharing request using the WebSocket or Redirect flow. InitiateDataSharingRequestInputModeEnum mode; @override @@ -169,7 +171,7 @@ class InitiateDataSharingRequestInput { }; } -/// indicates whether the flow is a WebSocket flow or a Redirect flow. This value is used in Vault to determine how to process the data flow request. +/// Determines whether to handle the data-sharing request using the WebSocket or Redirect flow. class InitiateDataSharingRequestInputModeEnum { /// Instantiate a new enum with the provided [value]. const InitiateDataSharingRequestInputModeEnum._(this.value); diff --git a/clients/dart/iota_client/lib/model/iota_configuration_dto.dart b/clients/dart/iota_client/lib/model/iota_configuration_dto.dart index a5c036e1..1908eeea 100644 --- a/clients/dart/iota_client/lib/model/iota_configuration_dto.dart +++ b/clients/dart/iota_client/lib/model/iota_configuration_dto.dart @@ -28,23 +28,25 @@ class IotaConfigurationDto { this.enableIdvProviders, }); - /// The ARI of the config + /// This is a unique resource identifier of the Affinidi Iota Framework configuration. String ari; + /// ID of the Affinidi Iota Framework configuration. String configurationId; - /// The name of the config + /// The name of the configuration to quickly identify the resource. String name; + /// The ID of the project. String projectId; - /// The wallet Ari that will be used to sign + /// The unique resource identifier of the Wallet used to sign the request token. String walletAri; - /// token time to live in seconds + /// This is the lifetime of the signed request token during the data-sharing flow. int tokenMaxAge; - /// webhook to call when data is ready + /// The webhook URL is used for callback when the data is ready. /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated @@ -53,19 +55,21 @@ class IotaConfigurationDto { /// String? iotaResponseWebhookURL; + /// Cryptographically verifies the data shared by the user when enabled. bool enableVerification; + /// Records the consent the user gave when they shared their data, including the type of data shared. bool enableConsentAuditLog; IotaConfigurationDtoClientMetadata clientMetadata; - /// indicates whether the flow is a WebSocket flow or a Redirect flow. This value is used in Vault to determine how to process the data flow request. + /// Determines whether to handle the data-sharing request using the WebSocket or Redirect flow. IotaConfigurationDtoModeEnum mode; - /// the URLs that the user will be redirected to after the request has been processed; should be provided by the developer of the client application.Required only if mode is Redirect. + /// List of allowed URLs to redirect users, including the response from the request. This is required if the selected data-sharing mode is Redirect. List redirectUris; - /// enables third party IDV provider verification for the given configuration + /// Enables identity verification from user with a 3rd-party provider when a verified identity document is not found. /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated @@ -229,7 +233,7 @@ class IotaConfigurationDto { }; } -/// indicates whether the flow is a WebSocket flow or a Redirect flow. This value is used in Vault to determine how to process the data flow request. +/// Determines whether to handle the data-sharing request using the WebSocket or Redirect flow. class IotaConfigurationDtoModeEnum { /// Instantiate a new enum with the provided [value]. const IotaConfigurationDtoModeEnum._(this.value); diff --git a/clients/dart/iota_client/lib/model/iota_configuration_dto_client_metadata.dart b/clients/dart/iota_client/lib/model/iota_configuration_dto_client_metadata.dart index e02e8a42..ab39cad5 100644 --- a/clients/dart/iota_client/lib/model/iota_configuration_dto_client_metadata.dart +++ b/clients/dart/iota_client/lib/model/iota_configuration_dto_client_metadata.dart @@ -18,13 +18,13 @@ class IotaConfigurationDtoClientMetadata { required this.logo, }); - /// application name that will be displayed in consent page + /// The name displayed on the consent page indicates who is requesting data from the user. It can be the application or website's name. String name; - /// origin url that will be displayed in consent page + /// The URL of the requester displayed on the consent page indicates the request's origin. String origin; - /// logo url that will be displayed in consent page + /// The logo of the requester displayed on the consent page, allowing users to easily recognise who requests the data. String logo; @override diff --git a/clients/dart/iota_client/lib/model/iota_exchange_credentials.dart b/clients/dart/iota_client/lib/model/iota_exchange_credentials.dart index 52f04b64..66267f43 100644 --- a/clients/dart/iota_client/lib/model/iota_exchange_credentials.dart +++ b/clients/dart/iota_client/lib/model/iota_exchange_credentials.dart @@ -16,7 +16,7 @@ class IotaExchangeCredentials { required this.assertion, }); - /// JWT signed with a machine token used to secure the web socket connection + /// A valid JSON Web Token (JWT) that secures the WebSocket connection. The JWT is signed with the key pair's private key used to create the Personal Access Token (PAT). String assertion; @override diff --git a/clients/dart/iota_client/lib/model/pex_query_dto.dart b/clients/dart/iota_client/lib/model/pex_query_dto.dart index 8786f1f2..488faa6e 100644 --- a/clients/dart/iota_client/lib/model/pex_query_dto.dart +++ b/clients/dart/iota_client/lib/model/pex_query_dto.dart @@ -21,17 +21,22 @@ class PexQueryDto { required this.vpDefinition, }); + /// The unique resource identifier of the qeuery. String ari; + /// The ID of the query. String queryId; + /// The name of the presentation definition to quickly identify the query. String name; + /// An optional description of what the query is used for. String description; + /// The unique resource identifier of the related configuration where the query is defined. String configurationAri; - /// VP definition in JSON stringify format + /// The presentation definition describing the data requirement that must be satisfied by the user. The value is in a JSON stringify format. String vpDefinition; @override diff --git a/clients/dart/iota_client/lib/model/prepare_request.dart b/clients/dart/iota_client/lib/model/prepare_request.dart index cd75d6ec..81d144cb 100644 --- a/clients/dart/iota_client/lib/model/prepare_request.dart +++ b/clients/dart/iota_client/lib/model/prepare_request.dart @@ -24,9 +24,10 @@ class PrepareRequest { String queryId; + /// A unique, randomly generated identifier that correlates the request and response in the data-sharing request flow. String correlationId; - /// token time to live in seconds + /// This is the lifetime of the signed request token during the data-sharing flow. /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated diff --git a/clients/dart/iota_client/lib/model/prepare_request_created_data.dart b/clients/dart/iota_client/lib/model/prepare_request_created_data.dart index 989f12ab..68d874bd 100644 --- a/clients/dart/iota_client/lib/model/prepare_request_created_data.dart +++ b/clients/dart/iota_client/lib/model/prepare_request_created_data.dart @@ -19,6 +19,7 @@ class PrepareRequestCreatedData { String jwt; + /// A unique, randomly generated identifier that correlates the request and response in the data-sharing request flow. String correlationId; @override diff --git a/clients/dart/iota_client/lib/model/save_pex_queries_update_input_queries_inner.dart b/clients/dart/iota_client/lib/model/save_pex_queries_update_input_queries_inner.dart index 559a51b6..2a8a2fea 100644 --- a/clients/dart/iota_client/lib/model/save_pex_queries_update_input_queries_inner.dart +++ b/clients/dart/iota_client/lib/model/save_pex_queries_update_input_queries_inner.dart @@ -18,8 +18,10 @@ class SavePexQueriesUpdateInputQueriesInner { this.description, }); + /// The ID of the query. String queryId; + /// The presentation definition describing the data requirement that must be satisfied by the user. The value is in a JSON stringify format. /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated @@ -28,6 +30,7 @@ class SavePexQueriesUpdateInputQueriesInner { /// String? vpDefinition; + /// An optional description of what the query is used for. /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated diff --git a/clients/dart/iota_client/lib/model/update_configuration_by_id_input.dart b/clients/dart/iota_client/lib/model/update_configuration_by_id_input.dart index d4103b54..41480bbc 100644 --- a/clients/dart/iota_client/lib/model/update_configuration_by_id_input.dart +++ b/clients/dart/iota_client/lib/model/update_configuration_by_id_input.dart @@ -26,7 +26,7 @@ class UpdateConfigurationByIdInput { this.enableIdvProviders, }); - /// The name of the config + /// The name of the configuration to quickly identify the resource. /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated @@ -35,7 +35,7 @@ class UpdateConfigurationByIdInput { /// String? name; - /// The wallet Ari that will be used to sign + /// The unique resource identifier of the Wallet used to sign the request token. /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated @@ -44,7 +44,7 @@ class UpdateConfigurationByIdInput { /// String? walletAri; - /// webhook to call when data is ready + /// The webhook URL is used for callback when the data is ready. /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated @@ -53,6 +53,7 @@ class UpdateConfigurationByIdInput { /// String? iotaResponseWebhookURL; + /// Cryptographically verifies the data shared by the user when enabled. /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated @@ -61,6 +62,7 @@ class UpdateConfigurationByIdInput { /// bool? enableVerification; + /// Records the user's consent when they share their data, including the type of data shared when enabled. /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated @@ -69,7 +71,7 @@ class UpdateConfigurationByIdInput { /// bool? enableConsentAuditLog; - /// token time to live in seconds + /// This is the lifetime of the signed request token during the data-sharing flow. /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated @@ -78,7 +80,7 @@ class UpdateConfigurationByIdInput { /// int? tokenMaxAge; - /// The description of the config + /// An optional description of what the configuration is used for. /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated @@ -95,13 +97,13 @@ class UpdateConfigurationByIdInput { /// IotaConfigurationDtoClientMetadata? clientMetadata; - /// indicates whether the flow is a WebSocket flow or a Redirect flow. This value is used in Vault to determine how to process the data flow request. + /// Determines whether to handle the data-sharing request using the WebSocket or Redirect flow. UpdateConfigurationByIdInputModeEnum? mode; - /// the URL that the user will be redirected to after the request has been processed; should be provided by the developer of the client application.Required only if mode is Redirect. + /// List of allowed URLs to redirect users, including the response from the request. This is required if the selected data-sharing mode is Redirect. List redirectUris; - /// enables third party IDV provider verification for the given configuration + /// Enables identity verification from user with a 3rd-party provider when a verified identity document is not found. /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated @@ -280,7 +282,7 @@ class UpdateConfigurationByIdInput { }; } -/// indicates whether the flow is a WebSocket flow or a Redirect flow. This value is used in Vault to determine how to process the data flow request. +/// Determines whether to handle the data-sharing request using the WebSocket or Redirect flow. class UpdateConfigurationByIdInputModeEnum { /// Instantiate a new enum with the provided [value]. const UpdateConfigurationByIdInputModeEnum._(this.value); diff --git a/clients/dart/iota_client/lib/model/update_pex_query_input.dart b/clients/dart/iota_client/lib/model/update_pex_query_input.dart index 467dd196..0768a9a1 100644 --- a/clients/dart/iota_client/lib/model/update_pex_query_input.dart +++ b/clients/dart/iota_client/lib/model/update_pex_query_input.dart @@ -17,7 +17,7 @@ class UpdatePexQueryInput { this.description, }); - /// VP definition in JSON stringify format + /// The presentation definition describing the data requirement that must be satisfied by the user. The value is in a JSON stringify format. /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated @@ -26,6 +26,7 @@ class UpdatePexQueryInput { /// String? vpDefinition; + /// An optional description of what the query is used for. /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated diff --git a/clients/python/credential_issuance_client/.openapi-generator/FILES b/clients/python/credential_issuance_client/.openapi-generator/FILES index 00763e3c..567cbe19 100644 --- a/clients/python/credential_issuance_client/.openapi-generator/FILES +++ b/clients/python/credential_issuance_client/.openapi-generator/FILES @@ -7,6 +7,7 @@ affinidi_tdk_credential_issuance_client/__init__.py affinidi_tdk_credential_issuance_client/api/__init__.py affinidi_tdk_credential_issuance_client/api/configuration_api.py affinidi_tdk_credential_issuance_client/api/credentials_api.py +affinidi_tdk_credential_issuance_client/api/default_api.py affinidi_tdk_credential_issuance_client/api/issuance_api.py affinidi_tdk_credential_issuance_client/api/offer_api.py affinidi_tdk_credential_issuance_client/api/well_known_api.py @@ -17,6 +18,7 @@ affinidi_tdk_credential_issuance_client/exceptions.py affinidi_tdk_credential_issuance_client/models/__init__.py affinidi_tdk_credential_issuance_client/models/action_forbidden_error.py affinidi_tdk_credential_issuance_client/models/action_forbidden_error_details_inner.py +affinidi_tdk_credential_issuance_client/models/change_credential_status_input.py affinidi_tdk_credential_issuance_client/models/cors_generate_credentials_ok.py affinidi_tdk_credential_issuance_client/models/cors_get_credential_offer_ok.py affinidi_tdk_credential_issuance_client/models/cors_get_well_known_open_id_credential_issuer_ok.py @@ -39,8 +41,11 @@ affinidi_tdk_credential_issuance_client/models/credential_response_immediate_cre affinidi_tdk_credential_issuance_client/models/credential_subject_not_valid_error.py affinidi_tdk_credential_issuance_client/models/credential_supported_object.py affinidi_tdk_credential_issuance_client/models/deferred_credential_input.py +affinidi_tdk_credential_issuance_client/models/flow_data.py +affinidi_tdk_credential_issuance_client/models/flow_data_status_lists_details_inner.py affinidi_tdk_credential_issuance_client/models/generate_credentials400_response.py affinidi_tdk_credential_issuance_client/models/get_credential_offer400_response.py +affinidi_tdk_credential_issuance_client/models/get_status_list_result_dto.py affinidi_tdk_credential_issuance_client/models/invalid_credential_request_error.py affinidi_tdk_credential_issuance_client/models/invalid_credential_type_error.py affinidi_tdk_credential_issuance_client/models/invalid_issuer_wallet_error.py @@ -51,6 +56,7 @@ affinidi_tdk_credential_issuance_client/models/issuance_config_dto.py affinidi_tdk_credential_issuance_client/models/issuance_config_list_response.py affinidi_tdk_credential_issuance_client/models/issuance_config_mini_dto.py affinidi_tdk_credential_issuance_client/models/issuance_state_response.py +affinidi_tdk_credential_issuance_client/models/list_issuance_record_response.py affinidi_tdk_credential_issuance_client/models/list_issuance_response.py affinidi_tdk_credential_issuance_client/models/list_issuance_response_issuances_inner.py affinidi_tdk_credential_issuance_client/models/missing_holder_did_error.py @@ -61,6 +67,7 @@ affinidi_tdk_credential_issuance_client/models/start_issuance400_response.py affinidi_tdk_credential_issuance_client/models/start_issuance_input.py affinidi_tdk_credential_issuance_client/models/start_issuance_input_data_inner.py affinidi_tdk_credential_issuance_client/models/start_issuance_input_data_inner_meta_data.py +affinidi_tdk_credential_issuance_client/models/start_issuance_input_data_inner_status_list_details_inner.py affinidi_tdk_credential_issuance_client/models/start_issuance_response.py affinidi_tdk_credential_issuance_client/models/supported_credential_metadata.py affinidi_tdk_credential_issuance_client/models/supported_credential_metadata_display_inner.py @@ -73,6 +80,7 @@ affinidi_tdk_credential_issuance_client/py.typed affinidi_tdk_credential_issuance_client/rest.py docs/ActionForbiddenError.md docs/ActionForbiddenErrorDetailsInner.md +docs/ChangeCredentialStatusInput.md docs/ConfigurationApi.md docs/CorsGenerateCredentialsOK.md docs/CorsGetCredentialOfferOK.md @@ -96,9 +104,13 @@ docs/CredentialResponseImmediateCredential.md docs/CredentialSubjectNotValidError.md docs/CredentialSupportedObject.md docs/CredentialsApi.md +docs/DefaultApi.md docs/DeferredCredentialInput.md +docs/FlowData.md +docs/FlowDataStatusListsDetailsInner.md docs/GenerateCredentials400Response.md docs/GetCredentialOffer400Response.md +docs/GetStatusListResultDto.md docs/InvalidCredentialRequestError.md docs/InvalidCredentialTypeError.md docs/InvalidIssuerWalletError.md @@ -110,6 +122,7 @@ docs/IssuanceConfigDto.md docs/IssuanceConfigListResponse.md docs/IssuanceConfigMiniDto.md docs/IssuanceStateResponse.md +docs/ListIssuanceRecordResponse.md docs/ListIssuanceResponse.md docs/ListIssuanceResponseIssuancesInner.md docs/MissingHolderDidError.md @@ -121,6 +134,7 @@ docs/StartIssuance400Response.md docs/StartIssuanceInput.md docs/StartIssuanceInputDataInner.md docs/StartIssuanceInputDataInnerMetaData.md +docs/StartIssuanceInputDataInnerStatusListDetailsInner.md docs/StartIssuanceResponse.md docs/SupportedCredentialMetadata.md docs/SupportedCredentialMetadataDisplayInner.md @@ -137,4 +151,11 @@ setup.cfg setup.py test-requirements.txt test/__init__.py +test/test_change_credential_status_input.py +test/test_default_api.py +test/test_flow_data.py +test/test_flow_data_status_lists_details_inner.py +test/test_get_status_list_result_dto.py +test/test_list_issuance_record_response.py +test/test_start_issuance_input_data_inner_status_list_details_inner.py tox.ini diff --git a/clients/python/credential_issuance_client/README.md b/clients/python/credential_issuance_client/README.md index 1dba207e..5f15e7d5 100644 --- a/clients/python/credential_issuance_client/README.md +++ b/clients/python/credential_issuance_client/README.md @@ -107,24 +107,28 @@ with affinidi_tdk_credential_issuance_client.ApiClient(configuration) as api_cli All URIs are relative to *https://apse1.api.affinidi.io/cis* -| Class | Method | HTTP request | Description | -| ------------------ | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | ----------- | -| _ConfigurationApi_ | [**create_issuance_config**](docs/ConfigurationApi.md#create_issuance_config) | **POST** /v1/configurations | -| _ConfigurationApi_ | [**delete_issuance_config_by_id**](docs/ConfigurationApi.md#delete_issuance_config_by_id) | **DELETE** /v1/configurations/{configurationId} | -| _ConfigurationApi_ | [**get_issuance_config_by_id**](docs/ConfigurationApi.md#get_issuance_config_by_id) | **GET** /v1/configurations/{configurationId} | -| _ConfigurationApi_ | [**get_issuance_config_list**](docs/ConfigurationApi.md#get_issuance_config_list) | **GET** /v1/configurations | -| _ConfigurationApi_ | [**update_issuance_config_by_id**](docs/ConfigurationApi.md#update_issuance_config_by_id) | **PUT** /v1/configurations/{configurationId} | -| _CredentialsApi_ | [**generate_credentials**](docs/CredentialsApi.md#generate_credentials) | **POST** /v1/{projectId}/credential | -| _IssuanceApi_ | [**issuance_state**](docs/IssuanceApi.md#issuance_state) | **GET** /v1/{projectId}/issuance/state/{issuanceId} | -| _IssuanceApi_ | [**list_issuance**](docs/IssuanceApi.md#list_issuance) | **GET** /v1/{projectId}/issuance | -| _IssuanceApi_ | [**start_issuance**](docs/IssuanceApi.md#start_issuance) | **POST** /v1/{projectId}/issuance/start | -| _OfferApi_ | [**get_credential_offer**](docs/OfferApi.md#get_credential_offer) | **GET** /v1/{projectId}/offers/{issuanceId} | -| _WellKnownApi_ | [**get_well_known_open_id_credential_issuer**](docs/WellKnownApi.md#get_well_known_open_id_credential_issuer) | **GET** /v1/{projectId}/.well-known/openid-credential-issuer | +| Class | Method | HTTP request | Description | +| ------------------ | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | ----------------------------- | +| _ConfigurationApi_ | [**create_issuance_config**](docs/ConfigurationApi.md#create_issuance_config) | **POST** /v1/configurations | +| _ConfigurationApi_ | [**delete_issuance_config_by_id**](docs/ConfigurationApi.md#delete_issuance_config_by_id) | **DELETE** /v1/configurations/{configurationId} | +| _ConfigurationApi_ | [**get_issuance_config_by_id**](docs/ConfigurationApi.md#get_issuance_config_by_id) | **GET** /v1/configurations/{configurationId} | +| _ConfigurationApi_ | [**get_issuance_config_list**](docs/ConfigurationApi.md#get_issuance_config_list) | **GET** /v1/configurations | +| _ConfigurationApi_ | [**update_issuance_config_by_id**](docs/ConfigurationApi.md#update_issuance_config_by_id) | **PUT** /v1/configurations/{configurationId} | +| _CredentialsApi_ | [**generate_credentials**](docs/CredentialsApi.md#generate_credentials) | **POST** /v1/{projectId}/credential | +| _DefaultApi_ | [**change_credential_satatus**](docs/DefaultApi.md#change_credential_satatus) | **POST** /v1/{projectId}/configurations/{configurationId}/issuance/change-status | change credential status. | +| _DefaultApi_ | [**get_status_list**](docs/DefaultApi.md#get_status_list) | **GET** /v1/{projectId}/status-list/{statusListId} | Return status list credential | +| _DefaultApi_ | [**list_issuance_data_records**](docs/DefaultApi.md#list_issuance_data_records) | **GET** /v1/{projectId}/configurations/{configurationId}/issuance/issuance-data-records | List records | +| _IssuanceApi_ | [**issuance_state**](docs/IssuanceApi.md#issuance_state) | **GET** /v1/{projectId}/issuance/state/{issuanceId} | +| _IssuanceApi_ | [**list_issuance**](docs/IssuanceApi.md#list_issuance) | **GET** /v1/{projectId}/issuance | +| _IssuanceApi_ | [**start_issuance**](docs/IssuanceApi.md#start_issuance) | **POST** /v1/{projectId}/issuance/start | +| _OfferApi_ | [**get_credential_offer**](docs/OfferApi.md#get_credential_offer) | **GET** /v1/{projectId}/offers/{issuanceId} | +| _WellKnownApi_ | [**get_well_known_open_id_credential_issuer**](docs/WellKnownApi.md#get_well_known_open_id_credential_issuer) | **GET** /v1/{projectId}/.well-known/openid-credential-issuer | ## Documentation For Models - [ActionForbiddenError](docs/ActionForbiddenError.md) - [ActionForbiddenErrorDetailsInner](docs/ActionForbiddenErrorDetailsInner.md) +- [ChangeCredentialStatusInput](docs/ChangeCredentialStatusInput.md) - [CorsGenerateCredentialsOK](docs/CorsGenerateCredentialsOK.md) - [CorsGetCredentialOfferOK](docs/CorsGetCredentialOfferOK.md) - [CorsGetWellKnownOpenIdCredentialIssuerOK](docs/CorsGetWellKnownOpenIdCredentialIssuerOK.md) @@ -147,8 +151,11 @@ All URIs are relative to *https://apse1.api.affinidi.io/cis* - [CredentialSubjectNotValidError](docs/CredentialSubjectNotValidError.md) - [CredentialSupportedObject](docs/CredentialSupportedObject.md) - [DeferredCredentialInput](docs/DeferredCredentialInput.md) +- [FlowData](docs/FlowData.md) +- [FlowDataStatusListsDetailsInner](docs/FlowDataStatusListsDetailsInner.md) - [GenerateCredentials400Response](docs/GenerateCredentials400Response.md) - [GetCredentialOffer400Response](docs/GetCredentialOffer400Response.md) +- [GetStatusListResultDto](docs/GetStatusListResultDto.md) - [InvalidCredentialRequestError](docs/InvalidCredentialRequestError.md) - [InvalidCredentialTypeError](docs/InvalidCredentialTypeError.md) - [InvalidIssuerWalletError](docs/InvalidIssuerWalletError.md) @@ -159,6 +166,7 @@ All URIs are relative to *https://apse1.api.affinidi.io/cis* - [IssuanceConfigListResponse](docs/IssuanceConfigListResponse.md) - [IssuanceConfigMiniDto](docs/IssuanceConfigMiniDto.md) - [IssuanceStateResponse](docs/IssuanceStateResponse.md) +- [ListIssuanceRecordResponse](docs/ListIssuanceRecordResponse.md) - [ListIssuanceResponse](docs/ListIssuanceResponse.md) - [ListIssuanceResponseIssuancesInner](docs/ListIssuanceResponseIssuancesInner.md) - [MissingHolderDidError](docs/MissingHolderDidError.md) @@ -169,6 +177,7 @@ All URIs are relative to *https://apse1.api.affinidi.io/cis* - [StartIssuanceInput](docs/StartIssuanceInput.md) - [StartIssuanceInputDataInner](docs/StartIssuanceInputDataInner.md) - [StartIssuanceInputDataInnerMetaData](docs/StartIssuanceInputDataInnerMetaData.md) +- [StartIssuanceInputDataInnerStatusListDetailsInner](docs/StartIssuanceInputDataInnerStatusListDetailsInner.md) - [StartIssuanceResponse](docs/StartIssuanceResponse.md) - [SupportedCredentialMetadata](docs/SupportedCredentialMetadata.md) - [SupportedCredentialMetadataDisplayInner](docs/SupportedCredentialMetadataDisplayInner.md) diff --git a/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/__init__.py b/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/__init__.py index 81a4349a..75c797d5 100644 --- a/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/__init__.py +++ b/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/__init__.py @@ -20,6 +20,7 @@ # import apis into sdk package from affinidi_tdk_credential_issuance_client.api.configuration_api import ConfigurationApi from affinidi_tdk_credential_issuance_client.api.credentials_api import CredentialsApi +from affinidi_tdk_credential_issuance_client.api.default_api import DefaultApi from affinidi_tdk_credential_issuance_client.api.issuance_api import IssuanceApi from affinidi_tdk_credential_issuance_client.api.offer_api import OfferApi from affinidi_tdk_credential_issuance_client.api.well_known_api import WellKnownApi @@ -38,6 +39,7 @@ # import models into sdk package from affinidi_tdk_credential_issuance_client.models.action_forbidden_error import ActionForbiddenError from affinidi_tdk_credential_issuance_client.models.action_forbidden_error_details_inner import ActionForbiddenErrorDetailsInner +from affinidi_tdk_credential_issuance_client.models.change_credential_status_input import ChangeCredentialStatusInput from affinidi_tdk_credential_issuance_client.models.cors_generate_credentials_ok import CorsGenerateCredentialsOK from affinidi_tdk_credential_issuance_client.models.cors_get_credential_offer_ok import CorsGetCredentialOfferOK from affinidi_tdk_credential_issuance_client.models.cors_get_well_known_open_id_credential_issuer_ok import CorsGetWellKnownOpenIdCredentialIssuerOK @@ -60,8 +62,11 @@ from affinidi_tdk_credential_issuance_client.models.credential_subject_not_valid_error import CredentialSubjectNotValidError from affinidi_tdk_credential_issuance_client.models.credential_supported_object import CredentialSupportedObject from affinidi_tdk_credential_issuance_client.models.deferred_credential_input import DeferredCredentialInput +from affinidi_tdk_credential_issuance_client.models.flow_data import FlowData +from affinidi_tdk_credential_issuance_client.models.flow_data_status_lists_details_inner import FlowDataStatusListsDetailsInner from affinidi_tdk_credential_issuance_client.models.generate_credentials400_response import GenerateCredentials400Response from affinidi_tdk_credential_issuance_client.models.get_credential_offer400_response import GetCredentialOffer400Response +from affinidi_tdk_credential_issuance_client.models.get_status_list_result_dto import GetStatusListResultDto from affinidi_tdk_credential_issuance_client.models.invalid_credential_request_error import InvalidCredentialRequestError from affinidi_tdk_credential_issuance_client.models.invalid_credential_type_error import InvalidCredentialTypeError from affinidi_tdk_credential_issuance_client.models.invalid_issuer_wallet_error import InvalidIssuerWalletError @@ -72,6 +77,7 @@ from affinidi_tdk_credential_issuance_client.models.issuance_config_list_response import IssuanceConfigListResponse from affinidi_tdk_credential_issuance_client.models.issuance_config_mini_dto import IssuanceConfigMiniDto from affinidi_tdk_credential_issuance_client.models.issuance_state_response import IssuanceStateResponse +from affinidi_tdk_credential_issuance_client.models.list_issuance_record_response import ListIssuanceRecordResponse from affinidi_tdk_credential_issuance_client.models.list_issuance_response import ListIssuanceResponse from affinidi_tdk_credential_issuance_client.models.list_issuance_response_issuances_inner import ListIssuanceResponseIssuancesInner from affinidi_tdk_credential_issuance_client.models.missing_holder_did_error import MissingHolderDidError @@ -82,6 +88,7 @@ from affinidi_tdk_credential_issuance_client.models.start_issuance_input import StartIssuanceInput from affinidi_tdk_credential_issuance_client.models.start_issuance_input_data_inner import StartIssuanceInputDataInner from affinidi_tdk_credential_issuance_client.models.start_issuance_input_data_inner_meta_data import StartIssuanceInputDataInnerMetaData +from affinidi_tdk_credential_issuance_client.models.start_issuance_input_data_inner_status_list_details_inner import StartIssuanceInputDataInnerStatusListDetailsInner from affinidi_tdk_credential_issuance_client.models.start_issuance_response import StartIssuanceResponse from affinidi_tdk_credential_issuance_client.models.supported_credential_metadata import SupportedCredentialMetadata from affinidi_tdk_credential_issuance_client.models.supported_credential_metadata_display_inner import SupportedCredentialMetadataDisplayInner diff --git a/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/api/__init__.py b/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/api/__init__.py index bd09cbcc..9675954d 100644 --- a/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/api/__init__.py +++ b/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/api/__init__.py @@ -3,6 +3,7 @@ # import apis into api package from affinidi_tdk_credential_issuance_client.api.configuration_api import ConfigurationApi from affinidi_tdk_credential_issuance_client.api.credentials_api import CredentialsApi +from affinidi_tdk_credential_issuance_client.api.default_api import DefaultApi from affinidi_tdk_credential_issuance_client.api.issuance_api import IssuanceApi from affinidi_tdk_credential_issuance_client.api.offer_api import OfferApi from affinidi_tdk_credential_issuance_client.api.well_known_api import WellKnownApi diff --git a/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/api/default_api.py b/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/api/default_api.py new file mode 100644 index 00000000..96cf6d05 --- /dev/null +++ b/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/api/default_api.py @@ -0,0 +1,499 @@ +# coding: utf-8 + +""" + 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 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import re # noqa: F401 +import io +import warnings + +from pydantic import validate_arguments, ValidationError + +from typing_extensions import Annotated +from pydantic import Field, StrictStr, conint, constr + +from typing import Optional + +from affinidi_tdk_credential_issuance_client.models.flow_data import FlowData +from affinidi_tdk_credential_issuance_client.models.get_status_list_result_dto import GetStatusListResultDto +from affinidi_tdk_credential_issuance_client.models.list_issuance_record_response import ListIssuanceRecordResponse + +from affinidi_tdk_credential_issuance_client.api_client import ApiClient +from affinidi_tdk_credential_issuance_client.api_response import ApiResponse +from affinidi_tdk_credential_issuance_client.exceptions import ( # noqa: F401 + ApiTypeError, + ApiValueError +) + + +class DefaultApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + @validate_arguments + def change_credential_satatus(self, project_id : Annotated[StrictStr, Field(..., description="project id")], configuration_id : Annotated[StrictStr, Field(..., description="configuration id")], **kwargs) -> FlowData: # noqa: E501 + """change credential status. # noqa: E501 + + change credential status. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.change_credential_satatus(project_id, configuration_id, async_req=True) + >>> result = thread.get() + + :param project_id: project id (required) + :type project_id: str + :param configuration_id: configuration id (required) + :type configuration_id: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: FlowData + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the change_credential_satatus_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.change_credential_satatus_with_http_info(project_id, configuration_id, **kwargs) # noqa: E501 + + @validate_arguments + def change_credential_satatus_with_http_info(self, project_id : Annotated[StrictStr, Field(..., description="project id")], configuration_id : Annotated[StrictStr, Field(..., description="configuration id")], **kwargs) -> ApiResponse: # noqa: E501 + """change credential status. # noqa: E501 + + change credential status. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.change_credential_satatus_with_http_info(project_id, configuration_id, async_req=True) + >>> result = thread.get() + + :param project_id: project id (required) + :type project_id: str + :param configuration_id: configuration id (required) + :type configuration_id: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(FlowData, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'project_id', + 'configuration_id' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method change_credential_satatus" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['project_id'] is not None: + _path_params['projectId'] = _params['project_id'] + + if _params['configuration_id'] is not None: + _path_params['configurationId'] = _params['configuration_id'] + + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # authentication setting + _auth_settings = ['ProjectTokenAuth'] # noqa: E501 + + _response_types_map = { + '200': "FlowData", + '400': "InvalidParameterError", + '404': "NotFoundError", + } + + return self.api_client.call_api( + '/v1/{projectId}/configurations/{configurationId}/issuance/change-status', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def get_status_list(self, project_id : StrictStr, status_list_id : Annotated[StrictStr, Field(..., description="id of the status list")], **kwargs) -> GetStatusListResultDto: # noqa: E501 + """Return status list credential # noqa: E501 + + Return status list credential # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_status_list(project_id, status_list_id, async_req=True) + >>> result = thread.get() + + :param project_id: (required) + :type project_id: str + :param status_list_id: id of the status list (required) + :type status_list_id: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: GetStatusListResultDto + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the get_status_list_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.get_status_list_with_http_info(project_id, status_list_id, **kwargs) # noqa: E501 + + @validate_arguments + def get_status_list_with_http_info(self, project_id : StrictStr, status_list_id : Annotated[StrictStr, Field(..., description="id of the status list")], **kwargs) -> ApiResponse: # noqa: E501 + """Return status list credential # noqa: E501 + + Return status list credential # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_status_list_with_http_info(project_id, status_list_id, async_req=True) + >>> result = thread.get() + + :param project_id: (required) + :type project_id: str + :param status_list_id: id of the status list (required) + :type status_list_id: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(GetStatusListResultDto, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'project_id', + 'status_list_id' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method get_status_list" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['project_id'] is not None: + _path_params['projectId'] = _params['project_id'] + + if _params['status_list_id'] is not None: + _path_params['statusListId'] = _params['status_list_id'] + + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "GetStatusListResultDto", + '400': "InvalidParameterError", + '404': "NotFoundError", + } + + return self.api_client.call_api( + '/v1/{projectId}/status-list/{statusListId}', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def list_issuance_data_records(self, limit : Annotated[Optional[conint(strict=True, le=100, ge=1)], Field(description="Maximum number of records to fetch in a list")] = None, exclusive_start_key : Annotated[Optional[constr(strict=True, max_length=3000)], Field(description="exclusiveStartKey for retrieving the next batch of data.")] = None, **kwargs) -> ListIssuanceRecordResponse: # noqa: E501 + """List records # noqa: E501 + + Retrieve a list of issuance data records. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_issuance_data_records(limit, exclusive_start_key, async_req=True) + >>> result = thread.get() + + :param limit: Maximum number of records to fetch in a list + :type limit: int + :param exclusive_start_key: exclusiveStartKey for retrieving the next batch of data. + :type exclusive_start_key: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: ListIssuanceRecordResponse + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the list_issuance_data_records_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.list_issuance_data_records_with_http_info(limit, exclusive_start_key, **kwargs) # noqa: E501 + + @validate_arguments + def list_issuance_data_records_with_http_info(self, limit : Annotated[Optional[conint(strict=True, le=100, ge=1)], Field(description="Maximum number of records to fetch in a list")] = None, exclusive_start_key : Annotated[Optional[constr(strict=True, max_length=3000)], Field(description="exclusiveStartKey for retrieving the next batch of data.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """List records # noqa: E501 + + Retrieve a list of issuance data records. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_issuance_data_records_with_http_info(limit, exclusive_start_key, async_req=True) + >>> result = thread.get() + + :param limit: Maximum number of records to fetch in a list + :type limit: int + :param exclusive_start_key: exclusiveStartKey for retrieving the next batch of data. + :type exclusive_start_key: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(ListIssuanceRecordResponse, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'limit', + 'exclusive_start_key' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method list_issuance_data_records" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + if _params.get('limit') is not None: # noqa: E501 + _query_params.append(('limit', _params['limit'])) + + if _params.get('exclusive_start_key') is not None: # noqa: E501 + _query_params.append(('exclusiveStartKey', _params['exclusive_start_key'])) + + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "ListIssuanceRecordResponse", + '400': "InvalidParameterError", + '404': "NotFoundError", + } + + return self.api_client.call_api( + '/v1/{projectId}/configurations/{configurationId}/issuance/issuance-data-records', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) diff --git a/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/__init__.py b/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/__init__.py index bbf31381..2cc360b4 100644 --- a/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/__init__.py +++ b/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/__init__.py @@ -17,6 +17,7 @@ # import models into model package from affinidi_tdk_credential_issuance_client.models.action_forbidden_error import ActionForbiddenError from affinidi_tdk_credential_issuance_client.models.action_forbidden_error_details_inner import ActionForbiddenErrorDetailsInner +from affinidi_tdk_credential_issuance_client.models.change_credential_status_input import ChangeCredentialStatusInput from affinidi_tdk_credential_issuance_client.models.cors_generate_credentials_ok import CorsGenerateCredentialsOK from affinidi_tdk_credential_issuance_client.models.cors_get_credential_offer_ok import CorsGetCredentialOfferOK from affinidi_tdk_credential_issuance_client.models.cors_get_well_known_open_id_credential_issuer_ok import CorsGetWellKnownOpenIdCredentialIssuerOK @@ -39,8 +40,11 @@ from affinidi_tdk_credential_issuance_client.models.credential_subject_not_valid_error import CredentialSubjectNotValidError from affinidi_tdk_credential_issuance_client.models.credential_supported_object import CredentialSupportedObject from affinidi_tdk_credential_issuance_client.models.deferred_credential_input import DeferredCredentialInput +from affinidi_tdk_credential_issuance_client.models.flow_data import FlowData +from affinidi_tdk_credential_issuance_client.models.flow_data_status_lists_details_inner import FlowDataStatusListsDetailsInner from affinidi_tdk_credential_issuance_client.models.generate_credentials400_response import GenerateCredentials400Response from affinidi_tdk_credential_issuance_client.models.get_credential_offer400_response import GetCredentialOffer400Response +from affinidi_tdk_credential_issuance_client.models.get_status_list_result_dto import GetStatusListResultDto from affinidi_tdk_credential_issuance_client.models.invalid_credential_request_error import InvalidCredentialRequestError from affinidi_tdk_credential_issuance_client.models.invalid_credential_type_error import InvalidCredentialTypeError from affinidi_tdk_credential_issuance_client.models.invalid_issuer_wallet_error import InvalidIssuerWalletError @@ -51,6 +55,7 @@ from affinidi_tdk_credential_issuance_client.models.issuance_config_list_response import IssuanceConfigListResponse from affinidi_tdk_credential_issuance_client.models.issuance_config_mini_dto import IssuanceConfigMiniDto from affinidi_tdk_credential_issuance_client.models.issuance_state_response import IssuanceStateResponse +from affinidi_tdk_credential_issuance_client.models.list_issuance_record_response import ListIssuanceRecordResponse from affinidi_tdk_credential_issuance_client.models.list_issuance_response import ListIssuanceResponse from affinidi_tdk_credential_issuance_client.models.list_issuance_response_issuances_inner import ListIssuanceResponseIssuancesInner from affinidi_tdk_credential_issuance_client.models.missing_holder_did_error import MissingHolderDidError @@ -61,6 +66,7 @@ from affinidi_tdk_credential_issuance_client.models.start_issuance_input import StartIssuanceInput from affinidi_tdk_credential_issuance_client.models.start_issuance_input_data_inner import StartIssuanceInputDataInner from affinidi_tdk_credential_issuance_client.models.start_issuance_input_data_inner_meta_data import StartIssuanceInputDataInnerMetaData +from affinidi_tdk_credential_issuance_client.models.start_issuance_input_data_inner_status_list_details_inner import StartIssuanceInputDataInnerStatusListDetailsInner from affinidi_tdk_credential_issuance_client.models.start_issuance_response import StartIssuanceResponse from affinidi_tdk_credential_issuance_client.models.supported_credential_metadata import SupportedCredentialMetadata from affinidi_tdk_credential_issuance_client.models.supported_credential_metadata_display_inner import SupportedCredentialMetadataDisplayInner diff --git a/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/change_credential_status_input.py b/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/change_credential_status_input.py new file mode 100644 index 00000000..7d7940ca --- /dev/null +++ b/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/change_credential_status_input.py @@ -0,0 +1,74 @@ +# coding: utf-8 + +""" + 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 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional +from pydantic import BaseModel, Field, StrictStr + +class ChangeCredentialStatusInput(BaseModel): + """ + ChangeCredentialStatusInput + """ + change_reason: Optional[StrictStr] = Field(default=None, alias="changeReason") + issuance_flow_data_id: Optional[StrictStr] = Field(default=None, alias="issuanceFlowDataId") + __properties = ["changeReason", "issuanceFlowDataId"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> ChangeCredentialStatusInput: + """Create an instance of ChangeCredentialStatusInput from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> ChangeCredentialStatusInput: + """Create an instance of ChangeCredentialStatusInput from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return ChangeCredentialStatusInput.parse_obj(obj) + + _obj = ChangeCredentialStatusInput.parse_obj({ + "change_reason": obj.get("changeReason"), + "issuance_flow_data_id": obj.get("issuanceFlowDataId") + }) + return _obj + + diff --git a/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/flow_data.py b/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/flow_data.py new file mode 100644 index 00000000..07166c31 --- /dev/null +++ b/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/flow_data.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + 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 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import List, Optional +from pydantic import BaseModel, Field, StrictStr, conlist +from affinidi_tdk_credential_issuance_client.models.flow_data_status_lists_details_inner import FlowDataStatusListsDetailsInner + +class FlowData(BaseModel): + """ + FlowData + """ + created_at: StrictStr = Field(default=..., alias="createdAt", description="[GEN] ISO 8601 string of the creation date/time the entity") + modified_at: StrictStr = Field(default=..., alias="modifiedAt", description="[GEN] ISO 8601 string of the modification date/time the entity") + id: StrictStr = Field(...) + project_id: Optional[StrictStr] = Field(default=None, alias="projectId") + flow_id: StrictStr = Field(default=..., alias="flowId") + credential_type_id: StrictStr = Field(default=..., alias="credentialTypeId") + json_ld_context_url: StrictStr = Field(default=..., alias="jsonLdContextUrl") + json_schema_url: StrictStr = Field(default=..., alias="jsonSchemaUrl") + configuration_id: Optional[StrictStr] = Field(default=None, alias="configurationId", description="Id of configuration, used to issue VC.") + issued_at: Optional[StrictStr] = Field(default=None, alias="issuedAt", description="when credential was issued to the holder (holder invoked generateCredentials endpoint)") + wallet_id: Optional[StrictStr] = Field(default=None, alias="walletId", description="Id of wallet, used to issue VC.") + project_id_configuration_id: Optional[StrictStr] = Field(default=None, alias="projectIdConfigurationId", description="Id of configuration with which VC was issued. To use as an index, it is grouped together with projectId, as \"{projectIdConfigurationId}#{configurationId}\"") + project_id_configuration_id_wallet_id: Optional[StrictStr] = Field(default=None, alias="projectIdConfigurationIdWalletId", description="Id of wallet which issued VC. To use as an index, it is grouped together with projectId, as \"{projectIdConfigurationId}#{walletId}\"") + project_id_configuration_id_credential_type: Optional[StrictStr] = Field(default=None, alias="projectIdConfigurationIdCredentialType", description="VC.type value. To use as an index, it is grouped together with projectId, as \"{projectIdConfigurationId}#{credentialType}\"") + status_lists_details: Optional[conlist(FlowDataStatusListsDetailsInner)] = Field(default=None, alias="statusListsDetails") + __properties = ["createdAt", "modifiedAt", "id", "projectId", "flowId", "credentialTypeId", "jsonLdContextUrl", "jsonSchemaUrl", "configurationId", "issuedAt", "walletId", "projectIdConfigurationId", "projectIdConfigurationIdWalletId", "projectIdConfigurationIdCredentialType", "statusListsDetails"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> FlowData: + """Create an instance of FlowData from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of each item in status_lists_details (list) + _items = [] + if self.status_lists_details: + for _item in self.status_lists_details: + if _item: + _items.append(_item.to_dict()) + _dict['statusListsDetails'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> FlowData: + """Create an instance of FlowData from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return FlowData.parse_obj(obj) + + _obj = FlowData.parse_obj({ + "created_at": obj.get("createdAt"), + "modified_at": obj.get("modifiedAt"), + "id": obj.get("id"), + "project_id": obj.get("projectId"), + "flow_id": obj.get("flowId"), + "credential_type_id": obj.get("credentialTypeId"), + "json_ld_context_url": obj.get("jsonLdContextUrl"), + "json_schema_url": obj.get("jsonSchemaUrl"), + "configuration_id": obj.get("configurationId"), + "issued_at": obj.get("issuedAt"), + "wallet_id": obj.get("walletId"), + "project_id_configuration_id": obj.get("projectIdConfigurationId"), + "project_id_configuration_id_wallet_id": obj.get("projectIdConfigurationIdWalletId"), + "project_id_configuration_id_credential_type": obj.get("projectIdConfigurationIdCredentialType"), + "status_lists_details": [FlowDataStatusListsDetailsInner.from_dict(_item) for _item in obj.get("statusListsDetails")] if obj.get("statusListsDetails") is not None else None + }) + return _obj + + diff --git a/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/flow_data_status_lists_details_inner.py b/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/flow_data_status_lists_details_inner.py new file mode 100644 index 00000000..614ef767 --- /dev/null +++ b/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/flow_data_status_lists_details_inner.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + 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 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional +from pydantic import BaseModel, Field, StrictBool, StrictStr, validator + +class FlowDataStatusListsDetailsInner(BaseModel): + """ + FlowDataStatusListsDetailsInner + """ + status_list_purpose: StrictStr = Field(default=..., alias="statusListPurpose", description="Purpose of status list to which credential is added") + status_list_id: StrictStr = Field(default=..., alias="statusListId", description="id of status list") + status_list_index: StrictStr = Field(default=..., alias="statusListIndex", description="as usual it is a number, but all standards use a string") + standard: StrictStr = Field(...) + is_active: StrictBool = Field(default=..., alias="isActive", description="indicates status is true or not. Default false.") + status_activation_reason: Optional[StrictStr] = Field(default=None, alias="statusActivationReason", description="text reasoning why the status is true (if true). Optional.") + status_activated_at: Optional[StrictStr] = Field(default=None, alias="statusActivatedAt", description="ISO 8601 string of the modification date/time the status. Optional.") + __properties = ["statusListPurpose", "statusListId", "statusListIndex", "standard", "isActive", "statusActivationReason", "statusActivatedAt"] + + @validator('status_list_purpose') + def status_list_purpose_validate_enum(cls, value): + """Validates the enum""" + if value not in ('REVOKED'): + raise ValueError("must be one of enum values ('REVOKED')") + return value + + @validator('standard') + def standard_validate_enum(cls, value): + """Validates the enum""" + if value not in ('RevocationList2020', 'BitstringStatusListV1'): + raise ValueError("must be one of enum values ('RevocationList2020', 'BitstringStatusListV1')") + return value + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> FlowDataStatusListsDetailsInner: + """Create an instance of FlowDataStatusListsDetailsInner from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> FlowDataStatusListsDetailsInner: + """Create an instance of FlowDataStatusListsDetailsInner from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return FlowDataStatusListsDetailsInner.parse_obj(obj) + + _obj = FlowDataStatusListsDetailsInner.parse_obj({ + "status_list_purpose": obj.get("statusListPurpose"), + "status_list_id": obj.get("statusListId"), + "status_list_index": obj.get("statusListIndex"), + "standard": obj.get("standard"), + "is_active": obj.get("isActive"), + "status_activation_reason": obj.get("statusActivationReason"), + "status_activated_at": obj.get("statusActivatedAt") + }) + return _obj + + diff --git a/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/get_status_list_result_dto.py b/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/get_status_list_result_dto.py new file mode 100644 index 00000000..43dba799 --- /dev/null +++ b/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/get_status_list_result_dto.py @@ -0,0 +1,72 @@ +# coding: utf-8 + +""" + 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 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, Dict +from pydantic import BaseModel, Field + +class GetStatusListResultDto(BaseModel): + """ + DTO contains revocation list credential # noqa: E501 + """ + revocation_list_credential: Dict[str, Any] = Field(default=..., alias="revocationListCredential") + __properties = ["revocationListCredential"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> GetStatusListResultDto: + """Create an instance of GetStatusListResultDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> GetStatusListResultDto: + """Create an instance of GetStatusListResultDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return GetStatusListResultDto.parse_obj(obj) + + _obj = GetStatusListResultDto.parse_obj({ + "revocation_list_credential": obj.get("revocationListCredential") + }) + return _obj + + diff --git a/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/list_issuance_record_response.py b/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/list_issuance_record_response.py new file mode 100644 index 00000000..9a30799c --- /dev/null +++ b/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/list_issuance_record_response.py @@ -0,0 +1,82 @@ +# coding: utf-8 + +""" + 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 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import List, Optional +from pydantic import BaseModel, Field, StrictStr, conlist +from affinidi_tdk_credential_issuance_client.models.flow_data import FlowData + +class ListIssuanceRecordResponse(BaseModel): + """ + list of issuance data records # noqa: E501 + """ + flow_data: Optional[conlist(FlowData)] = Field(default=None, alias="flowData") + last_evaluated_key: Optional[StrictStr] = Field(default=None, alias="lastEvaluatedKey") + __properties = ["flowData", "lastEvaluatedKey"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> ListIssuanceRecordResponse: + """Create an instance of ListIssuanceRecordResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of each item in flow_data (list) + _items = [] + if self.flow_data: + for _item in self.flow_data: + if _item: + _items.append(_item.to_dict()) + _dict['flowData'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> ListIssuanceRecordResponse: + """Create an instance of ListIssuanceRecordResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return ListIssuanceRecordResponse.parse_obj(obj) + + _obj = ListIssuanceRecordResponse.parse_obj({ + "flow_data": [FlowData.from_dict(_item) for _item in obj.get("flowData")] if obj.get("flowData") is not None else None, + "last_evaluated_key": obj.get("lastEvaluatedKey") + }) + return _obj + + diff --git a/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/start_issuance_input_data_inner.py b/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/start_issuance_input_data_inner.py index c696d7d5..5fa4eb6d 100644 --- a/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/start_issuance_input_data_inner.py +++ b/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/start_issuance_input_data_inner.py @@ -19,9 +19,10 @@ import json -from typing import Any, Dict, Optional -from pydantic import BaseModel, Field, StrictStr +from typing import Any, Dict, List, Optional +from pydantic import BaseModel, Field, StrictStr, conlist from affinidi_tdk_credential_issuance_client.models.start_issuance_input_data_inner_meta_data import StartIssuanceInputDataInnerMetaData +from affinidi_tdk_credential_issuance_client.models.start_issuance_input_data_inner_status_list_details_inner import StartIssuanceInputDataInnerStatusListDetailsInner class StartIssuanceInputDataInner(BaseModel): """ @@ -29,8 +30,9 @@ class StartIssuanceInputDataInner(BaseModel): """ credential_type_id: StrictStr = Field(default=..., alias="credentialTypeId", description="It is a String that identifies a Credential that is being requested to be issued.") credential_data: Dict[str, Any] = Field(default=..., alias="credentialData", description="Object of data to be included in the issued credential ,should match the credential type") + status_list_details: Optional[conlist(StartIssuanceInputDataInnerStatusListDetailsInner)] = Field(default=None, alias="statusListDetails", description="Types of status lists to which the credential should be added once issued. If not provided or empty, the credential is not added to any of the status lists.") meta_data: Optional[StartIssuanceInputDataInnerMetaData] = Field(default=None, alias="metaData") - __properties = ["credentialTypeId", "credentialData", "metaData"] + __properties = ["credentialTypeId", "credentialData", "statusListDetails", "metaData"] class Config: """Pydantic configuration""" @@ -56,6 +58,13 @@ def to_dict(self): exclude={ }, exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of each item in status_list_details (list) + _items = [] + if self.status_list_details: + for _item in self.status_list_details: + if _item: + _items.append(_item.to_dict()) + _dict['statusListDetails'] = _items # override the default output from pydantic by calling `to_dict()` of meta_data if self.meta_data: _dict['metaData'] = self.meta_data.to_dict() @@ -73,6 +82,7 @@ def from_dict(cls, obj: dict) -> StartIssuanceInputDataInner: _obj = StartIssuanceInputDataInner.parse_obj({ "credential_type_id": obj.get("credentialTypeId"), "credential_data": obj.get("credentialData"), + "status_list_details": [StartIssuanceInputDataInnerStatusListDetailsInner.from_dict(_item) for _item in obj.get("statusListDetails")] if obj.get("statusListDetails") is not None else None, "meta_data": StartIssuanceInputDataInnerMetaData.from_dict(obj.get("metaData")) if obj.get("metaData") is not None else None }) return _obj diff --git a/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/start_issuance_input_data_inner_status_list_details_inner.py b/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/start_issuance_input_data_inner_status_list_details_inner.py new file mode 100644 index 00000000..1598c03b --- /dev/null +++ b/clients/python/credential_issuance_client/affinidi_tdk_credential_issuance_client/models/start_issuance_input_data_inner_status_list_details_inner.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + 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 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional +from pydantic import BaseModel, StrictStr, validator + +class StartIssuanceInputDataInnerStatusListDetailsInner(BaseModel): + """ + StartIssuanceInputDataInnerStatusListDetailsInner + """ + purpose: Optional[StrictStr] = None + standard: Optional[StrictStr] = None + __properties = ["purpose", "standard"] + + @validator('purpose') + def purpose_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in ('REVOCABLE'): + raise ValueError("must be one of enum values ('REVOCABLE')") + return value + + @validator('standard') + def standard_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in ('RevocationList2020', 'BitstringStatusListV1'): + raise ValueError("must be one of enum values ('RevocationList2020', 'BitstringStatusListV1')") + return value + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> StartIssuanceInputDataInnerStatusListDetailsInner: + """Create an instance of StartIssuanceInputDataInnerStatusListDetailsInner from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> StartIssuanceInputDataInnerStatusListDetailsInner: + """Create an instance of StartIssuanceInputDataInnerStatusListDetailsInner from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return StartIssuanceInputDataInnerStatusListDetailsInner.parse_obj(obj) + + _obj = StartIssuanceInputDataInnerStatusListDetailsInner.parse_obj({ + "purpose": obj.get("purpose"), + "standard": obj.get("standard") + }) + return _obj + + diff --git a/clients/python/credential_issuance_client/docs/ChangeCredentialStatusInput.md b/clients/python/credential_issuance_client/docs/ChangeCredentialStatusInput.md new file mode 100644 index 00000000..38ea8c71 --- /dev/null +++ b/clients/python/credential_issuance_client/docs/ChangeCredentialStatusInput.md @@ -0,0 +1,28 @@ +# ChangeCredentialStatusInput + +## Properties + +| Name | Type | Description | Notes | +| ------------------------- | ------- | ----------- | ---------- | +| **change_reason** | **str** | | [optional] | +| **issuance_flow_data_id** | **str** | | [optional] | + +## Example + +```python +from affinidi_tdk_credential_issuance_client.models.change_credential_status_input import ChangeCredentialStatusInput + +# TODO update the JSON string below +json = "{}" +# create an instance of ChangeCredentialStatusInput from a JSON string +change_credential_status_input_instance = ChangeCredentialStatusInput.from_json(json) +# print the JSON string representation of the object +print ChangeCredentialStatusInput.to_json() + +# convert the object into a dict +change_credential_status_input_dict = change_credential_status_input_instance.to_dict() +# create an instance of ChangeCredentialStatusInput from a dict +change_credential_status_input_from_dict = ChangeCredentialStatusInput.from_dict(change_credential_status_input_dict) +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/python/credential_issuance_client/docs/DefaultApi.md b/clients/python/credential_issuance_client/docs/DefaultApi.md new file mode 100644 index 00000000..f9189ce4 --- /dev/null +++ b/clients/python/credential_issuance_client/docs/DefaultApi.md @@ -0,0 +1,249 @@ +# affinidi_tdk_credential_issuance_client.DefaultApi + +All URIs are relative to *https://apse1.api.affinidi.io/cis* + +| Method | HTTP request | Description | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | ----------------------------- | +| [**change_credential_satatus**](DefaultApi.md#change_credential_satatus) | **POST** /v1/{projectId}/configurations/{configurationId}/issuance/change-status | change credential status. | +| [**get_status_list**](DefaultApi.md#get_status_list) | **GET** /v1/{projectId}/status-list/{statusListId} | Return status list credential | +| [**list_issuance_data_records**](DefaultApi.md#list_issuance_data_records) | **GET** /v1/{projectId}/configurations/{configurationId}/issuance/issuance-data-records | List records | + +# **change_credential_satatus** + +> FlowData change_credential_satatus(project_id, configuration_id) + +change credential status. + +change credential status. + +### Example + +- Api Key Authentication (ProjectTokenAuth): + +```python +import time +import os +import affinidi_tdk_credential_issuance_client +from affinidi_tdk_credential_issuance_client.models.flow_data import FlowData +from affinidi_tdk_credential_issuance_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://apse1.api.affinidi.io/cis +# See configuration.py for a list of all supported configuration parameters. +configuration = affinidi_tdk_credential_issuance_client.Configuration( + host = "https://apse1.api.affinidi.io/cis" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: ProjectTokenAuth +configuration.api_key['ProjectTokenAuth'] = os.environ["API_KEY"] + +# Configure a hook to auto-refresh API key for your personal access token (PAT), if expired +import affinidi_tdk_auth_provider + +stats = { + apiGatewayUrl, + keyId, + passphrase, + privateKey, + projectId, + tokenEndpoint, + tokenId, +} +authProvider = affinidi_tdk_auth_provider.AuthProvider(stats) +configuration.refresh_api_key_hook = lambda api_client: authProvider.fetch_project_scoped_token() + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ProjectTokenAuth'] = 'Bearer' + +# Enter a context with an instance of the API client +with affinidi_tdk_credential_issuance_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = affinidi_tdk_credential_issuance_client.DefaultApi(api_client) + project_id = 'project_id_example' # str | project id + configuration_id = 'configuration_id_example' # str | configuration id + + try: + # change credential status. + api_response = api_instance.change_credential_satatus(project_id, configuration_id) + print("The response of DefaultApi->change_credential_satatus:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DefaultApi->change_credential_satatus: %s\n" % e) +``` + +### Parameters + +| Name | Type | Description | Notes | +| -------------------- | ------- | ---------------- | ----- | +| **project_id** | **str** | project id | +| **configuration_id** | **str** | configuration id | + +### Return type + +[**FlowData**](FlowData.md) + +### Authorization + +[ProjectTokenAuth](../README.md#ProjectTokenAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +| ----------- | ------------------------- | ---------------- | +| **200** | updated credential entity | - | +| **400** | BadRequestError | - | +| **404** | NotFoundError | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_status_list** + +> GetStatusListResultDto get_status_list(project_id, status_list_id) + +Return status list credential + +Return status list credential + +### Example + +```python +import time +import os +import affinidi_tdk_credential_issuance_client +from affinidi_tdk_credential_issuance_client.models.get_status_list_result_dto import GetStatusListResultDto +from affinidi_tdk_credential_issuance_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://apse1.api.affinidi.io/cis +# See configuration.py for a list of all supported configuration parameters. +configuration = affinidi_tdk_credential_issuance_client.Configuration( + host = "https://apse1.api.affinidi.io/cis" +) + + +# Enter a context with an instance of the API client +with affinidi_tdk_credential_issuance_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = affinidi_tdk_credential_issuance_client.DefaultApi(api_client) + project_id = 'project_id_example' # str | + status_list_id = 'status_list_id_example' # str | id of the status list + + try: + # Return status list credential + api_response = api_instance.get_status_list(project_id, status_list_id) + print("The response of DefaultApi->get_status_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DefaultApi->get_status_list: %s\n" % e) +``` + +### Parameters + +| Name | Type | Description | Notes | +| ------------------ | ------- | --------------------- | ----- | +| **project_id** | **str** | | +| **status_list_id** | **str** | id of the status list | + +### Return type + +[**GetStatusListResultDto**](GetStatusListResultDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +| ----------- | ------------------------------- | ---------------- | +| **200** | GetRevocationCredentialStatusOK | - | +| **400** | BadRequestError | - | +| **404** | NotFoundError | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_issuance_data_records** + +> ListIssuanceRecordResponse list_issuance_data_records(limit=limit, exclusive_start_key=exclusive_start_key) + +List records + +Retrieve a list of issuance data records. + +### Example + +```python +import time +import os +import affinidi_tdk_credential_issuance_client +from affinidi_tdk_credential_issuance_client.models.list_issuance_record_response import ListIssuanceRecordResponse +from affinidi_tdk_credential_issuance_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://apse1.api.affinidi.io/cis +# See configuration.py for a list of all supported configuration parameters. +configuration = affinidi_tdk_credential_issuance_client.Configuration( + host = "https://apse1.api.affinidi.io/cis" +) + + +# Enter a context with an instance of the API client +with affinidi_tdk_credential_issuance_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = affinidi_tdk_credential_issuance_client.DefaultApi(api_client) + limit = 10 # int | Maximum number of records to fetch in a list (optional) (default to 10) + exclusive_start_key = 'exclusive_start_key_example' # str | exclusiveStartKey for retrieving the next batch of data. (optional) + + try: + # List records + api_response = api_instance.list_issuance_data_records(limit=limit, exclusive_start_key=exclusive_start_key) + print("The response of DefaultApi->list_issuance_data_records:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DefaultApi->list_issuance_data_records: %s\n" % e) +``` + +### Parameters + +| Name | Type | Description | Notes | +| ----------------------- | ------- | -------------------------------------------------------- | -------------------------- | +| **limit** | **int** | Maximum number of records to fetch in a list | [optional] [default to 10] | +| **exclusive_start_key** | **str** | exclusiveStartKey for retrieving the next batch of data. | [optional] | + +### Return type + +[**ListIssuanceRecordResponse**](ListIssuanceRecordResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +| ----------- | --------------- | ---------------- | +| **200** | Ok | - | +| **400** | BadRequestError | - | +| **404** | NotFoundError | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/clients/python/credential_issuance_client/docs/FlowData.md b/clients/python/credential_issuance_client/docs/FlowData.md new file mode 100644 index 00000000..92ba4b42 --- /dev/null +++ b/clients/python/credential_issuance_client/docs/FlowData.md @@ -0,0 +1,41 @@ +# FlowData + +## Properties + +| Name | Type | Description | Notes | +| ----------------------------------------------- | ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **created_at** | **str** | [GEN] ISO 8601 string of the creation date/time the entity | +| **modified_at** | **str** | [GEN] ISO 8601 string of the modification date/time the entity | +| **id** | **str** | | +| **project_id** | **str** | | [optional] | +| **flow_id** | **str** | | +| **credential_type_id** | **str** | | +| **json_ld_context_url** | **str** | | +| **json_schema_url** | **str** | | +| **configuration_id** | **str** | Id of configuration, used to issue VC. | [optional] | +| **issued_at** | **str** | when credential was issued to the holder (holder invoked generateCredentials endpoint) | [optional] | +| **wallet_id** | **str** | Id of wallet, used to issue VC. | [optional] | +| **project_id_configuration_id** | **str** | Id of configuration with which VC was issued. To use as an index, it is grouped together with projectId, as \"{projectIdConfigurationId}#{configurationId}\" | [optional] | +| **project_id_configuration_id_wallet_id** | **str** | Id of wallet which issued VC. To use as an index, it is grouped together with projectId, as \"{projectIdConfigurationId}#{walletId}\" | [optional] | +| **project_id_configuration_id_credential_type** | **str** | VC.type value. To use as an index, it is grouped together with projectId, as \"{projectIdConfigurationId}#{credentialType}\" | [optional] | +| **status_lists_details** | [**List[FlowDataStatusListsDetailsInner]**](FlowDataStatusListsDetailsInner.md) | | [optional] | + +## Example + +```python +from affinidi_tdk_credential_issuance_client.models.flow_data import FlowData + +# TODO update the JSON string below +json = "{}" +# create an instance of FlowData from a JSON string +flow_data_instance = FlowData.from_json(json) +# print the JSON string representation of the object +print FlowData.to_json() + +# convert the object into a dict +flow_data_dict = flow_data_instance.to_dict() +# create an instance of FlowData from a dict +flow_data_from_dict = FlowData.from_dict(flow_data_dict) +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/python/credential_issuance_client/docs/FlowDataStatusListsDetailsInner.md b/clients/python/credential_issuance_client/docs/FlowDataStatusListsDetailsInner.md new file mode 100644 index 00000000..b30ddbbe --- /dev/null +++ b/clients/python/credential_issuance_client/docs/FlowDataStatusListsDetailsInner.md @@ -0,0 +1,33 @@ +# FlowDataStatusListsDetailsInner + +## Properties + +| Name | Type | Description | Notes | +| ---------------------------- | -------- | ------------------------------------------------------------------- | ---------- | +| **status_list_purpose** | **str** | Purpose of status list to which credential is added | +| **status_list_id** | **str** | id of status list | +| **status_list_index** | **str** | as usual it is a number, but all standards use a string | +| **standard** | **str** | | +| **is_active** | **bool** | indicates status is true or not. Default false. | +| **status_activation_reason** | **str** | text reasoning why the status is true (if true). Optional. | [optional] | +| **status_activated_at** | **str** | ISO 8601 string of the modification date/time the status. Optional. | [optional] | + +## Example + +```python +from affinidi_tdk_credential_issuance_client.models.flow_data_status_lists_details_inner import FlowDataStatusListsDetailsInner + +# TODO update the JSON string below +json = "{}" +# create an instance of FlowDataStatusListsDetailsInner from a JSON string +flow_data_status_lists_details_inner_instance = FlowDataStatusListsDetailsInner.from_json(json) +# print the JSON string representation of the object +print FlowDataStatusListsDetailsInner.to_json() + +# convert the object into a dict +flow_data_status_lists_details_inner_dict = flow_data_status_lists_details_inner_instance.to_dict() +# create an instance of FlowDataStatusListsDetailsInner from a dict +flow_data_status_lists_details_inner_from_dict = FlowDataStatusListsDetailsInner.from_dict(flow_data_status_lists_details_inner_dict) +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/python/credential_issuance_client/docs/GetStatusListResultDto.md b/clients/python/credential_issuance_client/docs/GetStatusListResultDto.md new file mode 100644 index 00000000..ba4f0cdd --- /dev/null +++ b/clients/python/credential_issuance_client/docs/GetStatusListResultDto.md @@ -0,0 +1,29 @@ +# GetStatusListResultDto + +DTO contains revocation list credential + +## Properties + +| Name | Type | Description | Notes | +| ------------------------------ | ---------- | ----------- | ----- | +| **revocation_list_credential** | **object** | | + +## Example + +```python +from affinidi_tdk_credential_issuance_client.models.get_status_list_result_dto import GetStatusListResultDto + +# TODO update the JSON string below +json = "{}" +# create an instance of GetStatusListResultDto from a JSON string +get_status_list_result_dto_instance = GetStatusListResultDto.from_json(json) +# print the JSON string representation of the object +print GetStatusListResultDto.to_json() + +# convert the object into a dict +get_status_list_result_dto_dict = get_status_list_result_dto_instance.to_dict() +# create an instance of GetStatusListResultDto from a dict +get_status_list_result_dto_from_dict = GetStatusListResultDto.from_dict(get_status_list_result_dto_dict) +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/python/credential_issuance_client/docs/ListIssuanceRecordResponse.md b/clients/python/credential_issuance_client/docs/ListIssuanceRecordResponse.md new file mode 100644 index 00000000..b37ee2e4 --- /dev/null +++ b/clients/python/credential_issuance_client/docs/ListIssuanceRecordResponse.md @@ -0,0 +1,30 @@ +# ListIssuanceRecordResponse + +list of issuance data records + +## Properties + +| Name | Type | Description | Notes | +| ---------------------- | --------------------------------- | ----------- | ---------- | +| **flow_data** | [**List[FlowData]**](FlowData.md) | | [optional] | +| **last_evaluated_key** | **str** | | [optional] | + +## Example + +```python +from affinidi_tdk_credential_issuance_client.models.list_issuance_record_response import ListIssuanceRecordResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of ListIssuanceRecordResponse from a JSON string +list_issuance_record_response_instance = ListIssuanceRecordResponse.from_json(json) +# print the JSON string representation of the object +print ListIssuanceRecordResponse.to_json() + +# convert the object into a dict +list_issuance_record_response_dict = list_issuance_record_response_instance.to_dict() +# create an instance of ListIssuanceRecordResponse from a dict +list_issuance_record_response_from_dict = ListIssuanceRecordResponse.from_dict(list_issuance_record_response_dict) +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/python/credential_issuance_client/docs/StartIssuanceInputDataInner.md b/clients/python/credential_issuance_client/docs/StartIssuanceInputDataInner.md index 61bd82ab..443c08fc 100644 --- a/clients/python/credential_issuance_client/docs/StartIssuanceInputDataInner.md +++ b/clients/python/credential_issuance_client/docs/StartIssuanceInputDataInner.md @@ -4,11 +4,12 @@ Data to be included in issued credential ## Properties -| Name | Type | Description | Notes | -| ---------------------- | --------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------- | -| **credential_type_id** | **str** | It is a String that identifies a Credential that is being requested to be issued. | -| **credential_data** | **Dict[str, object]** | Object of data to be included in the issued credential ,should match the credential type | -| **meta_data** | [**StartIssuanceInputDataInnerMetaData**](StartIssuanceInputDataInnerMetaData.md) | | [optional] | +| Name | Type | Description | Notes | +| ----------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------- | +| **credential_type_id** | **str** | It is a String that identifies a Credential that is being requested to be issued. | +| **credential_data** | **Dict[str, object]** | Object of data to be included in the issued credential ,should match the credential type | +| **status_list_details** | [**List[StartIssuanceInputDataInnerStatusListDetailsInner]**](StartIssuanceInputDataInnerStatusListDetailsInner.md) | Types of status lists to which the credential should be added once issued. If not provided or empty, the credential is not added to any of the status lists. | [optional] | +| **meta_data** | [**StartIssuanceInputDataInnerMetaData**](StartIssuanceInputDataInnerMetaData.md) | | [optional] | ## Example diff --git a/clients/python/credential_issuance_client/docs/StartIssuanceInputDataInnerStatusListDetailsInner.md b/clients/python/credential_issuance_client/docs/StartIssuanceInputDataInnerStatusListDetailsInner.md new file mode 100644 index 00000000..68fab274 --- /dev/null +++ b/clients/python/credential_issuance_client/docs/StartIssuanceInputDataInnerStatusListDetailsInner.md @@ -0,0 +1,28 @@ +# StartIssuanceInputDataInnerStatusListDetailsInner + +## Properties + +| Name | Type | Description | Notes | +| ------------ | ------- | ----------- | ---------- | +| **purpose** | **str** | | [optional] | +| **standard** | **str** | | [optional] | + +## Example + +```python +from affinidi_tdk_credential_issuance_client.models.start_issuance_input_data_inner_status_list_details_inner import StartIssuanceInputDataInnerStatusListDetailsInner + +# TODO update the JSON string below +json = "{}" +# create an instance of StartIssuanceInputDataInnerStatusListDetailsInner from a JSON string +start_issuance_input_data_inner_status_list_details_inner_instance = StartIssuanceInputDataInnerStatusListDetailsInner.from_json(json) +# print the JSON string representation of the object +print StartIssuanceInputDataInnerStatusListDetailsInner.to_json() + +# convert the object into a dict +start_issuance_input_data_inner_status_list_details_inner_dict = start_issuance_input_data_inner_status_list_details_inner_instance.to_dict() +# create an instance of StartIssuanceInputDataInnerStatusListDetailsInner from a dict +start_issuance_input_data_inner_status_list_details_inner_from_dict = StartIssuanceInputDataInnerStatusListDetailsInner.from_dict(start_issuance_input_data_inner_status_list_details_inner_dict) +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/python/credential_issuance_client/test/test_change_credential_status_input.py b/clients/python/credential_issuance_client/test/test_change_credential_status_input.py new file mode 100644 index 00000000..e3ae3af4 --- /dev/null +++ b/clients/python/credential_issuance_client/test/test_change_credential_status_input.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + 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 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from affinidi_tdk_credential_issuance_client.models.change_credential_status_input import ChangeCredentialStatusInput # noqa: E501 + +class TestChangeCredentialStatusInput(unittest.TestCase): + """ChangeCredentialStatusInput unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ChangeCredentialStatusInput: + """Test ChangeCredentialStatusInput + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ChangeCredentialStatusInput` + """ + model = ChangeCredentialStatusInput() # noqa: E501 + if include_optional: + return ChangeCredentialStatusInput( + change_reason = '', + issuance_flow_data_id = '' + ) + else: + return ChangeCredentialStatusInput( + ) + """ + + def testChangeCredentialStatusInput(self): + """Test ChangeCredentialStatusInput""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/clients/python/credential_issuance_client/test/test_default_api.py b/clients/python/credential_issuance_client/test/test_default_api.py new file mode 100644 index 00000000..a857f1f4 --- /dev/null +++ b/clients/python/credential_issuance_client/test/test_default_api.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + 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 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from affinidi_tdk_credential_issuance_client.api.default_api import DefaultApi # noqa: E501 + + +class TestDefaultApi(unittest.TestCase): + """DefaultApi unit test stubs""" + + def setUp(self) -> None: + self.api = DefaultApi() + + def tearDown(self) -> None: + pass + + def test_change_credential_satatus(self) -> None: + """Test case for change_credential_satatus + + change credential status. # noqa: E501 + """ + pass + + def test_get_status_list(self) -> None: + """Test case for get_status_list + + Return status list credential # noqa: E501 + """ + pass + + def test_list_issuance_data_records(self) -> None: + """Test case for list_issuance_data_records + + List records # noqa: E501 + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/clients/python/credential_issuance_client/test/test_flow_data.py b/clients/python/credential_issuance_client/test/test_flow_data.py new file mode 100644 index 00000000..44b062e6 --- /dev/null +++ b/clients/python/credential_issuance_client/test/test_flow_data.py @@ -0,0 +1,83 @@ +# coding: utf-8 + +""" + 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 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from affinidi_tdk_credential_issuance_client.models.flow_data import FlowData # noqa: E501 + +class TestFlowData(unittest.TestCase): + """FlowData unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> FlowData: + """Test FlowData + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `FlowData` + """ + model = FlowData() # noqa: E501 + if include_optional: + return FlowData( + created_at = '', + modified_at = '', + id = '', + project_id = '', + flow_id = '', + credential_type_id = '', + json_ld_context_url = '', + json_schema_url = '', + configuration_id = '', + issued_at = '', + wallet_id = '', + project_id_configuration_id = '', + project_id_configuration_id_wallet_id = '', + project_id_configuration_id_credential_type = '', + status_lists_details = [ + affinidi_tdk_credential_issuance_client.models.flow_data_status_lists_details_inner.FlowData_statusListsDetails_inner( + status_list_purpose = 'REVOKED', + status_list_id = '', + status_list_index = '', + standard = 'RevocationList2020', + is_active = True, + status_activation_reason = '', + status_activated_at = '', ) + ] + ) + else: + return FlowData( + created_at = '', + modified_at = '', + id = '', + flow_id = '', + credential_type_id = '', + json_ld_context_url = '', + json_schema_url = '', + ) + """ + + def testFlowData(self): + """Test FlowData""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/clients/python/credential_issuance_client/test/test_flow_data_status_lists_details_inner.py b/clients/python/credential_issuance_client/test/test_flow_data_status_lists_details_inner.py new file mode 100644 index 00000000..948dc299 --- /dev/null +++ b/clients/python/credential_issuance_client/test/test_flow_data_status_lists_details_inner.py @@ -0,0 +1,64 @@ +# coding: utf-8 + +""" + 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 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from affinidi_tdk_credential_issuance_client.models.flow_data_status_lists_details_inner import FlowDataStatusListsDetailsInner # noqa: E501 + +class TestFlowDataStatusListsDetailsInner(unittest.TestCase): + """FlowDataStatusListsDetailsInner unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> FlowDataStatusListsDetailsInner: + """Test FlowDataStatusListsDetailsInner + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `FlowDataStatusListsDetailsInner` + """ + model = FlowDataStatusListsDetailsInner() # noqa: E501 + if include_optional: + return FlowDataStatusListsDetailsInner( + status_list_purpose = 'REVOKED', + status_list_id = '', + status_list_index = '', + standard = 'RevocationList2020', + is_active = True, + status_activation_reason = '', + status_activated_at = '' + ) + else: + return FlowDataStatusListsDetailsInner( + status_list_purpose = 'REVOKED', + status_list_id = '', + status_list_index = '', + standard = 'RevocationList2020', + is_active = True, + ) + """ + + def testFlowDataStatusListsDetailsInner(self): + """Test FlowDataStatusListsDetailsInner""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/clients/python/credential_issuance_client/test/test_get_status_list_result_dto.py b/clients/python/credential_issuance_client/test/test_get_status_list_result_dto.py new file mode 100644 index 00000000..459dbe01 --- /dev/null +++ b/clients/python/credential_issuance_client/test/test_get_status_list_result_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + 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 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from affinidi_tdk_credential_issuance_client.models.get_status_list_result_dto import GetStatusListResultDto # noqa: E501 + +class TestGetStatusListResultDto(unittest.TestCase): + """GetStatusListResultDto unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> GetStatusListResultDto: + """Test GetStatusListResultDto + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `GetStatusListResultDto` + """ + model = GetStatusListResultDto() # noqa: E501 + if include_optional: + return GetStatusListResultDto( + revocation_list_credential = None + ) + else: + return GetStatusListResultDto( + revocation_list_credential = None, + ) + """ + + def testGetStatusListResultDto(self): + """Test GetStatusListResultDto""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/clients/python/credential_issuance_client/test/test_list_issuance_record_response.py b/clients/python/credential_issuance_client/test/test_list_issuance_record_response.py new file mode 100644 index 00000000..bd53d2dd --- /dev/null +++ b/clients/python/credential_issuance_client/test/test_list_issuance_record_response.py @@ -0,0 +1,80 @@ +# coding: utf-8 + +""" + 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 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from affinidi_tdk_credential_issuance_client.models.list_issuance_record_response import ListIssuanceRecordResponse # noqa: E501 + +class TestListIssuanceRecordResponse(unittest.TestCase): + """ListIssuanceRecordResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ListIssuanceRecordResponse: + """Test ListIssuanceRecordResponse + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ListIssuanceRecordResponse` + """ + model = ListIssuanceRecordResponse() # noqa: E501 + if include_optional: + return ListIssuanceRecordResponse( + flow_data = [ + affinidi_tdk_credential_issuance_client.models.flow_data.FlowData( + created_at = '', + modified_at = '', + id = '', + project_id = '', + flow_id = '', + credential_type_id = '', + json_ld_context_url = '', + json_schema_url = '', + configuration_id = '', + issued_at = '', + wallet_id = '', + project_id_configuration_id = '', + project_id_configuration_id_wallet_id = '', + project_id_configuration_id_credential_type = '', + status_lists_details = [ + affinidi_tdk_credential_issuance_client.models.flow_data_status_lists_details_inner.FlowData_statusListsDetails_inner( + status_list_purpose = 'REVOKED', + status_list_id = '', + status_list_index = '', + standard = 'RevocationList2020', + is_active = True, + status_activation_reason = '', + status_activated_at = '', ) + ], ) + ], + last_evaluated_key = '' + ) + else: + return ListIssuanceRecordResponse( + ) + """ + + def testListIssuanceRecordResponse(self): + """Test ListIssuanceRecordResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/clients/python/credential_issuance_client/test/test_start_issuance_input_data_inner_status_list_details_inner.py b/clients/python/credential_issuance_client/test/test_start_issuance_input_data_inner_status_list_details_inner.py new file mode 100644 index 00000000..f8be5ff9 --- /dev/null +++ b/clients/python/credential_issuance_client/test/test_start_issuance_input_data_inner_status_list_details_inner.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + 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 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from affinidi_tdk_credential_issuance_client.models.start_issuance_input_data_inner_status_list_details_inner import StartIssuanceInputDataInnerStatusListDetailsInner # noqa: E501 + +class TestStartIssuanceInputDataInnerStatusListDetailsInner(unittest.TestCase): + """StartIssuanceInputDataInnerStatusListDetailsInner unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> StartIssuanceInputDataInnerStatusListDetailsInner: + """Test StartIssuanceInputDataInnerStatusListDetailsInner + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `StartIssuanceInputDataInnerStatusListDetailsInner` + """ + model = StartIssuanceInputDataInnerStatusListDetailsInner() # noqa: E501 + if include_optional: + return StartIssuanceInputDataInnerStatusListDetailsInner( + purpose = 'REVOCABLE', + standard = 'RevocationList2020' + ) + else: + return StartIssuanceInputDataInnerStatusListDetailsInner( + ) + """ + + def testStartIssuanceInputDataInnerStatusListDetailsInner(self): + """Test StartIssuanceInputDataInnerStatusListDetailsInner""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/clients/python/iota_client/README.md b/clients/python/iota_client/README.md index 73d76c83..f245d6b6 100644 --- a/clients/python/iota_client/README.md +++ b/clients/python/iota_client/README.md @@ -70,7 +70,6 @@ with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: callback_input = affinidi_tdk_iota_client.CallbackInput() # CallbackInput | CallbackRequestInput try: - # Processes the callback for OIDC4VP flows api_response = api_instance.iot_oidc4_vp_callback(callback_input) print("The response of CallbackApi->iot_oidc4_vp_callback:\n") pprint(api_response) @@ -83,9 +82,9 @@ with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: All URIs are relative to *https://apse1.api.affinidi.io/ais* -| Class | Method | HTTP request | Description | -| ------------------- | ---------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | ---------------------------------------- | -| _CallbackApi_ | [**iot_oidc4_vp_callback**](docs/CallbackApi.md#iot_oidc4_vp_callback) | **POST** /v1/callback | Processes the callback for OIDC4VP flows | +| Class | Method | HTTP request | Description | +| ------------------- | ---------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | ----------- | +| _CallbackApi_ | [**iot_oidc4_vp_callback**](docs/CallbackApi.md#iot_oidc4_vp_callback) | **POST** /v1/callback | | _ConfigurationsApi_ | [**create_iota_configuration**](docs/ConfigurationsApi.md#create_iota_configuration) | **POST** /v1/configurations | | _ConfigurationsApi_ | [**delete_iota_configuration_by_id**](docs/ConfigurationsApi.md#delete_iota_configuration_by_id) | **DELETE** /v1/configurations/{configurationId} | | _ConfigurationsApi_ | [**get_iota_configuration_by_id**](docs/ConfigurationsApi.md#get_iota_configuration_by_id) | **GET** /v1/configurations/{configurationId} | @@ -99,7 +98,7 @@ All URIs are relative to *https://apse1.api.affinidi.io/ais* | _IotaApi_ | [**initiate_data_sharing_request**](docs/IotaApi.md#initiate_data_sharing_request) | **POST** /v1/initiate-data-sharing-request | | _IotaApi_ | [**iota_exchange_credentials**](docs/IotaApi.md#iota_exchange_credentials) | **POST** /v1/exchange-credentials | | _PexQueryApi_ | [**create_pex_query**](docs/PexQueryApi.md#create_pex_query) | **POST** /v1/configurations/{configurationId}/pex-queries | -| _PexQueryApi_ | [**delete_pex_queries**](docs/PexQueryApi.md#delete_pex_queries) | **POST** /v1/configurations/{configurationId}/delete-queries | deletes pex queries | +| _PexQueryApi_ | [**delete_pex_queries**](docs/PexQueryApi.md#delete_pex_queries) | **POST** /v1/configurations/{configurationId}/delete-queries | | _PexQueryApi_ | [**delete_pex_query_by_id**](docs/PexQueryApi.md#delete_pex_query_by_id) | **DELETE** /v1/configurations/{configurationId}/pex-queries/{queryId} | | _PexQueryApi_ | [**get_pex_query_by_id**](docs/PexQueryApi.md#get_pex_query_by_id) | **GET** /v1/configurations/{configurationId}/pex-queries/{queryId} | | _PexQueryApi_ | [**list_pex_queries**](docs/PexQueryApi.md#list_pex_queries) | **GET** /v1/configurations/{configurationId}/pex-queries | diff --git a/clients/python/iota_client/affinidi_tdk_iota_client/api/callback_api.py b/clients/python/iota_client/affinidi_tdk_iota_client/api/callback_api.py index 5499fedf..a0cc099d 100644 --- a/clients/python/iota_client/affinidi_tdk_iota_client/api/callback_api.py +++ b/clients/python/iota_client/affinidi_tdk_iota_client/api/callback_api.py @@ -47,9 +47,9 @@ def __init__(self, api_client=None) -> None: @validate_arguments def iot_oidc4_vp_callback(self, callback_input : Annotated[CallbackInput, Field(..., description="CallbackRequestInput")], **kwargs) -> CallbackResponseOK: # noqa: E501 - """Processes the callback for OIDC4VP flows # noqa: E501 + """iot_oidc4_vp_callback # noqa: E501 - This endpoint handles callbacks from clients with data from OIDC4VP transactions, including state, presentation submission, and verification tokens. It updates the flow status based on the provided state and communicates the outcome through MQTT, ensuring the transaction's completion or notifying of any errors. # noqa: E501 + It handles the client's (e.g., Affinidi Vault) callback about the result of the data-sharing request. It may contain the data shared by the user, including the presentation submission, verification token, and state. Using the MQTT protocol, it communicates the completion of the request or if any error occurred. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -77,9 +77,9 @@ def iot_oidc4_vp_callback(self, callback_input : Annotated[CallbackInput, Field( @validate_arguments def iot_oidc4_vp_callback_with_http_info(self, callback_input : Annotated[CallbackInput, Field(..., description="CallbackRequestInput")], **kwargs) -> ApiResponse: # noqa: E501 - """Processes the callback for OIDC4VP flows # noqa: E501 + """iot_oidc4_vp_callback # noqa: E501 - This endpoint handles callbacks from clients with data from OIDC4VP transactions, including state, presentation submission, and verification tokens. It updates the flow status based on the provided state and communicates the outcome through MQTT, ensuring the transaction's completion or notifying of any errors. # noqa: E501 + It handles the client's (e.g., Affinidi Vault) callback about the result of the data-sharing request. It may contain the data shared by the user, including the presentation submission, verification token, and state. Using the MQTT protocol, it communicates the completion of the request or if any error occurred. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/clients/python/iota_client/affinidi_tdk_iota_client/api/configurations_api.py b/clients/python/iota_client/affinidi_tdk_iota_client/api/configurations_api.py index ff1b3636..40d08eb2 100644 --- a/clients/python/iota_client/affinidi_tdk_iota_client/api/configurations_api.py +++ b/clients/python/iota_client/affinidi_tdk_iota_client/api/configurations_api.py @@ -52,6 +52,7 @@ def __init__(self, api_client=None) -> None: def create_iota_configuration(self, create_iota_configuration_input : Annotated[CreateIotaConfigurationInput, Field(..., description="CreateConfiguration")], **kwargs) -> IotaConfigurationDto: # noqa: E501 """create_iota_configuration # noqa: E501 + Creates a new Affinidi Iota Framework configuration. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -81,6 +82,7 @@ def create_iota_configuration(self, create_iota_configuration_input : Annotated[ def create_iota_configuration_with_http_info(self, create_iota_configuration_input : Annotated[CreateIotaConfigurationInput, Field(..., description="CreateConfiguration")], **kwargs) -> ApiResponse: # noqa: E501 """create_iota_configuration # noqa: E501 + Creates a new Affinidi Iota Framework configuration. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -198,16 +200,17 @@ def create_iota_configuration_with_http_info(self, create_iota_configuration_inp _request_auth=_params.get('_request_auth')) @validate_arguments - def delete_iota_configuration_by_id(self, configuration_id : Annotated[StrictStr, Field(..., description="iotaConfiguration Id")], **kwargs) -> None: # noqa: E501 + def delete_iota_configuration_by_id(self, configuration_id : Annotated[StrictStr, Field(..., description="ID of the Affinidi Iota Framework configuration.")], **kwargs) -> None: # noqa: E501 """delete_iota_configuration_by_id # noqa: E501 + Deletes an Affinidi Iota Framework configuration by ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_iota_configuration_by_id(configuration_id, async_req=True) >>> result = thread.get() - :param configuration_id: iotaConfiguration Id (required) + :param configuration_id: ID of the Affinidi Iota Framework configuration. (required) :type configuration_id: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional @@ -227,16 +230,17 @@ def delete_iota_configuration_by_id(self, configuration_id : Annotated[StrictStr return self.delete_iota_configuration_by_id_with_http_info(configuration_id, **kwargs) # noqa: E501 @validate_arguments - def delete_iota_configuration_by_id_with_http_info(self, configuration_id : Annotated[StrictStr, Field(..., description="iotaConfiguration Id")], **kwargs) -> ApiResponse: # noqa: E501 + def delete_iota_configuration_by_id_with_http_info(self, configuration_id : Annotated[StrictStr, Field(..., description="ID of the Affinidi Iota Framework configuration.")], **kwargs) -> ApiResponse: # noqa: E501 """delete_iota_configuration_by_id # noqa: E501 + Deletes an Affinidi Iota Framework configuration by ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_iota_configuration_by_id_with_http_info(configuration_id, async_req=True) >>> result = thread.get() - :param configuration_id: iotaConfiguration Id (required) + :param configuration_id: ID of the Affinidi Iota Framework configuration. (required) :type configuration_id: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional @@ -334,16 +338,17 @@ def delete_iota_configuration_by_id_with_http_info(self, configuration_id : Anno _request_auth=_params.get('_request_auth')) @validate_arguments - def get_iota_configuration_by_id(self, configuration_id : Annotated[StrictStr, Field(..., description="iotaConfiguration Id")], **kwargs) -> IotaConfigurationDto: # noqa: E501 + def get_iota_configuration_by_id(self, configuration_id : Annotated[StrictStr, Field(..., description="ID of the Affinidi Iota Framework configuration.")], **kwargs) -> IotaConfigurationDto: # noqa: E501 """get_iota_configuration_by_id # noqa: E501 + Retrieves the details of an Affinidi Iota Framework configuration. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_iota_configuration_by_id(configuration_id, async_req=True) >>> result = thread.get() - :param configuration_id: iotaConfiguration Id (required) + :param configuration_id: ID of the Affinidi Iota Framework configuration. (required) :type configuration_id: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional @@ -363,16 +368,17 @@ def get_iota_configuration_by_id(self, configuration_id : Annotated[StrictStr, F return self.get_iota_configuration_by_id_with_http_info(configuration_id, **kwargs) # noqa: E501 @validate_arguments - def get_iota_configuration_by_id_with_http_info(self, configuration_id : Annotated[StrictStr, Field(..., description="iotaConfiguration Id")], **kwargs) -> ApiResponse: # noqa: E501 + def get_iota_configuration_by_id_with_http_info(self, configuration_id : Annotated[StrictStr, Field(..., description="ID of the Affinidi Iota Framework configuration.")], **kwargs) -> ApiResponse: # noqa: E501 """get_iota_configuration_by_id # noqa: E501 + Retrieves the details of an Affinidi Iota Framework configuration. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_iota_configuration_by_id_with_http_info(configuration_id, async_req=True) >>> result = thread.get() - :param configuration_id: iotaConfiguration Id (required) + :param configuration_id: ID of the Affinidi Iota Framework configuration. (required) :type configuration_id: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional @@ -475,18 +481,19 @@ def get_iota_configuration_by_id_with_http_info(self, configuration_id : Annotat _request_auth=_params.get('_request_auth')) @validate_arguments - def get_iota_configuration_meta_data(self, project_id : Annotated[StrictStr, Field(..., description="project Id")], configuration_id : Annotated[StrictStr, Field(..., description="iotaConfiguration Id")], **kwargs) -> GetIotaConfigurationMetaDataOK: # noqa: E501 + def get_iota_configuration_meta_data(self, project_id : Annotated[StrictStr, Field(..., description="The ID of the project.")], configuration_id : Annotated[StrictStr, Field(..., description="ID of the Affinidi Iota Framework configuration.")], **kwargs) -> GetIotaConfigurationMetaDataOK: # noqa: E501 """get_iota_configuration_meta_data # noqa: E501 + Retrieves the client metadata of an Affinidi Iota Framework configuration. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_iota_configuration_meta_data(project_id, configuration_id, async_req=True) >>> result = thread.get() - :param project_id: project Id (required) + :param project_id: The ID of the project. (required) :type project_id: str - :param configuration_id: iotaConfiguration Id (required) + :param configuration_id: ID of the Affinidi Iota Framework configuration. (required) :type configuration_id: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional @@ -506,18 +513,19 @@ def get_iota_configuration_meta_data(self, project_id : Annotated[StrictStr, Fie return self.get_iota_configuration_meta_data_with_http_info(project_id, configuration_id, **kwargs) # noqa: E501 @validate_arguments - def get_iota_configuration_meta_data_with_http_info(self, project_id : Annotated[StrictStr, Field(..., description="project Id")], configuration_id : Annotated[StrictStr, Field(..., description="iotaConfiguration Id")], **kwargs) -> ApiResponse: # noqa: E501 + def get_iota_configuration_meta_data_with_http_info(self, project_id : Annotated[StrictStr, Field(..., description="The ID of the project.")], configuration_id : Annotated[StrictStr, Field(..., description="ID of the Affinidi Iota Framework configuration.")], **kwargs) -> ApiResponse: # noqa: E501 """get_iota_configuration_meta_data # noqa: E501 + Retrieves the client metadata of an Affinidi Iota Framework configuration. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_iota_configuration_meta_data_with_http_info(project_id, configuration_id, async_req=True) >>> result = thread.get() - :param project_id: project Id (required) + :param project_id: The ID of the project. (required) :type project_id: str - :param configuration_id: iotaConfiguration Id (required) + :param configuration_id: ID of the Affinidi Iota Framework configuration. (required) :type configuration_id: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional @@ -626,6 +634,7 @@ def get_iota_configuration_meta_data_with_http_info(self, project_id : Annotated def list_iota_configurations(self, **kwargs) -> ListConfigurationOK: # noqa: E501 """list_iota_configurations # noqa: E501 + List all Affinidi Iota Framework configurations. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -653,6 +662,7 @@ def list_iota_configurations(self, **kwargs) -> ListConfigurationOK: # noqa: E5 def list_iota_configurations_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 """list_iota_configurations # noqa: E501 + List all Affinidi Iota Framework configurations. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -755,16 +765,17 @@ def list_iota_configurations_with_http_info(self, **kwargs) -> ApiResponse: # n _request_auth=_params.get('_request_auth')) @validate_arguments - def update_iota_configuration_by_id(self, configuration_id : Annotated[StrictStr, Field(..., description="iotaConfiguration Id")], update_configuration_by_id_input : Annotated[UpdateConfigurationByIdInput, Field(..., description="UpdateConfigurationById")], **kwargs) -> IotaConfigurationDto: # noqa: E501 + def update_iota_configuration_by_id(self, configuration_id : Annotated[StrictStr, Field(..., description="ID of the Affinidi Iota Framework configuration.")], update_configuration_by_id_input : Annotated[UpdateConfigurationByIdInput, Field(..., description="UpdateConfigurationById")], **kwargs) -> IotaConfigurationDto: # noqa: E501 """update_iota_configuration_by_id # noqa: E501 + Updates the details of an Affinidi Iota Framework configuration by ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_iota_configuration_by_id(configuration_id, update_configuration_by_id_input, async_req=True) >>> result = thread.get() - :param configuration_id: iotaConfiguration Id (required) + :param configuration_id: ID of the Affinidi Iota Framework configuration. (required) :type configuration_id: str :param update_configuration_by_id_input: UpdateConfigurationById (required) :type update_configuration_by_id_input: UpdateConfigurationByIdInput @@ -786,16 +797,17 @@ def update_iota_configuration_by_id(self, configuration_id : Annotated[StrictStr return self.update_iota_configuration_by_id_with_http_info(configuration_id, update_configuration_by_id_input, **kwargs) # noqa: E501 @validate_arguments - def update_iota_configuration_by_id_with_http_info(self, configuration_id : Annotated[StrictStr, Field(..., description="iotaConfiguration Id")], update_configuration_by_id_input : Annotated[UpdateConfigurationByIdInput, Field(..., description="UpdateConfigurationById")], **kwargs) -> ApiResponse: # noqa: E501 + def update_iota_configuration_by_id_with_http_info(self, configuration_id : Annotated[StrictStr, Field(..., description="ID of the Affinidi Iota Framework configuration.")], update_configuration_by_id_input : Annotated[UpdateConfigurationByIdInput, Field(..., description="UpdateConfigurationById")], **kwargs) -> ApiResponse: # noqa: E501 """update_iota_configuration_by_id # noqa: E501 + Updates the details of an Affinidi Iota Framework configuration by ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_iota_configuration_by_id_with_http_info(configuration_id, update_configuration_by_id_input, async_req=True) >>> result = thread.get() - :param configuration_id: iotaConfiguration Id (required) + :param configuration_id: ID of the Affinidi Iota Framework configuration. (required) :type configuration_id: str :param update_configuration_by_id_input: UpdateConfigurationById (required) :type update_configuration_by_id_input: UpdateConfigurationByIdInput diff --git a/clients/python/iota_client/affinidi_tdk_iota_client/api/default_api.py b/clients/python/iota_client/affinidi_tdk_iota_client/api/default_api.py index 8fe65ce1..85ce2462 100644 --- a/clients/python/iota_client/affinidi_tdk_iota_client/api/default_api.py +++ b/clients/python/iota_client/affinidi_tdk_iota_client/api/default_api.py @@ -47,10 +47,10 @@ def __init__(self, api_client=None) -> None: self.api_client = api_client @validate_arguments - def list_logged_consents(self, configuration_id : Optional[StrictStr] = None, user_id : Optional[StrictStr] = None, limit : Annotated[Optional[conint(strict=True, le=100, ge=1)], Field(description="Maximum number of records to fetch in a list")] = None, exclusive_start_key : Annotated[Optional[constr(strict=True, max_length=3000)], Field(description="The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation.")] = None, **kwargs) -> ListLoggedConsentsOK: # noqa: E501 + def list_logged_consents(self, configuration_id : Optional[StrictStr] = None, user_id : Optional[StrictStr] = None, limit : Annotated[Optional[conint(strict=True, le=100, ge=1)], Field(description="The maximum number of records to fetch from the list of logged consents.")] = None, exclusive_start_key : Annotated[Optional[constr(strict=True, max_length=3000)], Field(description="The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation.")] = None, **kwargs) -> ListLoggedConsentsOK: # noqa: E501 """list_logged_consents # noqa: E501 - returns a list of logged consents for the project # noqa: E501 + Lists all the logged consents for a project. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -61,7 +61,7 @@ def list_logged_consents(self, configuration_id : Optional[StrictStr] = None, us :type configuration_id: str :param user_id: :type user_id: str - :param limit: Maximum number of records to fetch in a list + :param limit: The maximum number of records to fetch from the list of logged consents. :type limit: int :param exclusive_start_key: The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation. :type exclusive_start_key: str @@ -83,10 +83,10 @@ def list_logged_consents(self, configuration_id : Optional[StrictStr] = None, us return self.list_logged_consents_with_http_info(configuration_id, user_id, limit, exclusive_start_key, **kwargs) # noqa: E501 @validate_arguments - def list_logged_consents_with_http_info(self, configuration_id : Optional[StrictStr] = None, user_id : Optional[StrictStr] = None, limit : Annotated[Optional[conint(strict=True, le=100, ge=1)], Field(description="Maximum number of records to fetch in a list")] = None, exclusive_start_key : Annotated[Optional[constr(strict=True, max_length=3000)], Field(description="The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + def list_logged_consents_with_http_info(self, configuration_id : Optional[StrictStr] = None, user_id : Optional[StrictStr] = None, limit : Annotated[Optional[conint(strict=True, le=100, ge=1)], Field(description="The maximum number of records to fetch from the list of logged consents.")] = None, exclusive_start_key : Annotated[Optional[constr(strict=True, max_length=3000)], Field(description="The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation.")] = None, **kwargs) -> ApiResponse: # noqa: E501 """list_logged_consents # noqa: E501 - returns a list of logged consents for the project # noqa: E501 + Lists all the logged consents for a project. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -97,7 +97,7 @@ def list_logged_consents_with_http_info(self, configuration_id : Optional[Strict :type configuration_id: str :param user_id: :type user_id: str - :param limit: Maximum number of records to fetch in a list + :param limit: The maximum number of records to fetch from the list of logged consents. :type limit: int :param exclusive_start_key: The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation. :type exclusive_start_key: str diff --git a/clients/python/iota_client/affinidi_tdk_iota_client/api/iota_api.py b/clients/python/iota_client/affinidi_tdk_iota_client/api/iota_api.py index cb2e70a8..52f4832f 100644 --- a/clients/python/iota_client/affinidi_tdk_iota_client/api/iota_api.py +++ b/clients/python/iota_client/affinidi_tdk_iota_client/api/iota_api.py @@ -56,7 +56,7 @@ def __init__(self, api_client=None) -> None: def aws_exchange_credentials(self, aws_exchange_credentials : Annotated[AwsExchangeCredentials, Field(..., description="AwsExchangeCredentials")], **kwargs) -> AwsExchangeCredentialsOK: # noqa: E501 """aws_exchange_credentials # noqa: E501 - It exchanges limited token into cognito # noqa: E501 + Exchange a limited-scoped token into a Cognito credential to generate the identity credential. The identity credential initiates the secure WebSocket connection from the client. This method is used only in WebSocket data-sharing mode. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -86,7 +86,7 @@ def aws_exchange_credentials(self, aws_exchange_credentials : Annotated[AwsExcha def aws_exchange_credentials_with_http_info(self, aws_exchange_credentials : Annotated[AwsExchangeCredentials, Field(..., description="AwsExchangeCredentials")], **kwargs) -> ApiResponse: # noqa: E501 """aws_exchange_credentials # noqa: E501 - It exchanges limited token into cognito # noqa: E501 + Exchange a limited-scoped token into a Cognito credential to generate the identity credential. The identity credential initiates the secure WebSocket connection from the client. This method is used only in WebSocket data-sharing mode. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -205,7 +205,7 @@ def aws_exchange_credentials_with_http_info(self, aws_exchange_credentials : Ann def aws_exchange_credentials_project_token(self, aws_exchange_credentials_project_token : Annotated[AwsExchangeCredentialsProjectToken, Field(..., description="AwsExchangeCredentialsProjectToken")], **kwargs) -> IotaExchangeCredentialsOK: # noqa: E501 """aws_exchange_credentials_project_token # noqa: E501 - It exchanges project token into cognito # noqa: E501 + Exchange a Project Scoped Token into an identity credential directly to initiate a secure WebSocket connection. This method is used only in WebSocket data-sharing mode. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -235,7 +235,7 @@ def aws_exchange_credentials_project_token(self, aws_exchange_credentials_projec def aws_exchange_credentials_project_token_with_http_info(self, aws_exchange_credentials_project_token : Annotated[AwsExchangeCredentialsProjectToken, Field(..., description="AwsExchangeCredentialsProjectToken")], **kwargs) -> ApiResponse: # noqa: E501 """aws_exchange_credentials_project_token # noqa: E501 - It exchanges project token into cognito # noqa: E501 + Exchange a Project Scoped Token into an identity credential directly to initiate a secure WebSocket connection. This method is used only in WebSocket data-sharing mode. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -354,7 +354,7 @@ def aws_exchange_credentials_project_token_with_http_info(self, aws_exchange_cre def fetch_iota_vp_response(self, fetch_iotavp_response_input : Annotated[FetchIOTAVPResponseInput, Field(..., description="FetchIOTAVPResponseInput")], **kwargs) -> FetchIOTAVPResponseOK: # noqa: E501 """fetch_iota_vp_response # noqa: E501 - This will get the final data response # noqa: E501 + Fetches the client's callback that contains the user's shared data in a Verifiable Presentation format after a successful data-sharing flow. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -384,7 +384,7 @@ def fetch_iota_vp_response(self, fetch_iotavp_response_input : Annotated[FetchIO def fetch_iota_vp_response_with_http_info(self, fetch_iotavp_response_input : Annotated[FetchIOTAVPResponseInput, Field(..., description="FetchIOTAVPResponseInput")], **kwargs) -> ApiResponse: # noqa: E501 """fetch_iota_vp_response # noqa: E501 - This will get the final data response # noqa: E501 + Fetches the client's callback that contains the user's shared data in a Verifiable Presentation format after a successful data-sharing flow. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -480,6 +480,7 @@ def fetch_iota_vp_response_with_http_info(self, fetch_iotavp_response_input : An '200': "FetchIOTAVPResponseOK", '400': "InvalidParameterError", '403': "OperationForbiddenError", + '404': "NotFoundError", } return self.api_client.call_api( @@ -503,7 +504,7 @@ def fetch_iota_vp_response_with_http_info(self, fetch_iotavp_response_input : An def initiate_data_sharing_request(self, initiate_data_sharing_request_input : Annotated[InitiateDataSharingRequestInput, Field(..., description="InitiateDataSharingRequestInput")], **kwargs) -> InitiateDataSharingRequestOK: # noqa: E501 """initiate_data_sharing_request # noqa: E501 - This will initiate data sharing request for the data sharing flow # noqa: E501 + Generates the request token for the Redirect mode to initiate the data-sharing flow. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -533,7 +534,7 @@ def initiate_data_sharing_request(self, initiate_data_sharing_request_input : An def initiate_data_sharing_request_with_http_info(self, initiate_data_sharing_request_input : Annotated[InitiateDataSharingRequestInput, Field(..., description="InitiateDataSharingRequestInput")], **kwargs) -> ApiResponse: # noqa: E501 """initiate_data_sharing_request # noqa: E501 - This will initiate data sharing request for the data sharing flow # noqa: E501 + Generates the request token for the Redirect mode to initiate the data-sharing flow. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -652,7 +653,7 @@ def initiate_data_sharing_request_with_http_info(self, initiate_data_sharing_req def iota_exchange_credentials(self, iota_exchange_credentials : Annotated[IotaExchangeCredentials, Field(..., description="IotaAwsExchangeCredentials")], **kwargs) -> IotaExchangeCredentialsOK: # noqa: E501 """iota_exchange_credentials # noqa: E501 - It exchanges limited token into cognito sts identity credentials # noqa: E501 + Exchange a limited-scoped token into an identity credential directly to initiate a secure WebSocket connection. This method is used only in WebSocket data-sharing mode. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -682,7 +683,7 @@ def iota_exchange_credentials(self, iota_exchange_credentials : Annotated[IotaEx def iota_exchange_credentials_with_http_info(self, iota_exchange_credentials : Annotated[IotaExchangeCredentials, Field(..., description="IotaAwsExchangeCredentials")], **kwargs) -> ApiResponse: # noqa: E501 """iota_exchange_credentials # noqa: E501 - It exchanges limited token into cognito sts identity credentials # noqa: E501 + Exchange a limited-scoped token into an identity credential directly to initiate a secure WebSocket connection. This method is used only in WebSocket data-sharing mode. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/clients/python/iota_client/affinidi_tdk_iota_client/api/pex_query_api.py b/clients/python/iota_client/affinidi_tdk_iota_client/api/pex_query_api.py index ed56d053..b0dd65c1 100644 --- a/clients/python/iota_client/affinidi_tdk_iota_client/api/pex_query_api.py +++ b/clients/python/iota_client/affinidi_tdk_iota_client/api/pex_query_api.py @@ -51,16 +51,17 @@ def __init__(self, api_client=None) -> None: self.api_client = api_client @validate_arguments - def create_pex_query(self, configuration_id : Annotated[StrictStr, Field(..., description="iotaConfiguration Id")], create_pex_query_input : Annotated[CreatePexQueryInput, Field(..., description="CreatePexQuery")], **kwargs) -> PexQueryDto: # noqa: E501 + def create_pex_query(self, configuration_id : Annotated[StrictStr, Field(..., description="ID of the Affinidi Iota Framework configuration.")], create_pex_query_input : Annotated[CreatePexQueryInput, Field(..., description="CreatePexQuery")], **kwargs) -> PexQueryDto: # noqa: E501 """create_pex_query # noqa: E501 + Creates a new Presentation Definition in the configuration to query data. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_pex_query(configuration_id, create_pex_query_input, async_req=True) >>> result = thread.get() - :param configuration_id: iotaConfiguration Id (required) + :param configuration_id: ID of the Affinidi Iota Framework configuration. (required) :type configuration_id: str :param create_pex_query_input: CreatePexQuery (required) :type create_pex_query_input: CreatePexQueryInput @@ -82,16 +83,17 @@ def create_pex_query(self, configuration_id : Annotated[StrictStr, Field(..., de return self.create_pex_query_with_http_info(configuration_id, create_pex_query_input, **kwargs) # noqa: E501 @validate_arguments - def create_pex_query_with_http_info(self, configuration_id : Annotated[StrictStr, Field(..., description="iotaConfiguration Id")], create_pex_query_input : Annotated[CreatePexQueryInput, Field(..., description="CreatePexQuery")], **kwargs) -> ApiResponse: # noqa: E501 + def create_pex_query_with_http_info(self, configuration_id : Annotated[StrictStr, Field(..., description="ID of the Affinidi Iota Framework configuration.")], create_pex_query_input : Annotated[CreatePexQueryInput, Field(..., description="CreatePexQuery")], **kwargs) -> ApiResponse: # noqa: E501 """create_pex_query # noqa: E501 + Creates a new Presentation Definition in the configuration to query data. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_pex_query_with_http_info(configuration_id, create_pex_query_input, async_req=True) >>> result = thread.get() - :param configuration_id: iotaConfiguration Id (required) + :param configuration_id: ID of the Affinidi Iota Framework configuration. (required) :type configuration_id: str :param create_pex_query_input: CreatePexQuery (required) :type create_pex_query_input: CreatePexQueryInput @@ -209,17 +211,17 @@ def create_pex_query_with_http_info(self, configuration_id : Annotated[StrictStr _request_auth=_params.get('_request_auth')) @validate_arguments - def delete_pex_queries(self, configuration_id : Annotated[StrictStr, Field(..., description="iotaConfiguration Id")], **kwargs) -> None: # noqa: E501 - """deletes pex queries # noqa: E501 + def delete_pex_queries(self, configuration_id : Annotated[StrictStr, Field(..., description="ID of the Affinidi Iota Framework configuration.")], **kwargs) -> None: # noqa: E501 + """delete_pex_queries # noqa: E501 - deletes pex queries # noqa: E501 + Deletes all Presentation Definition queries of a configuration. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_pex_queries(configuration_id, async_req=True) >>> result = thread.get() - :param configuration_id: iotaConfiguration Id (required) + :param configuration_id: ID of the Affinidi Iota Framework configuration. (required) :type configuration_id: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional @@ -239,17 +241,17 @@ def delete_pex_queries(self, configuration_id : Annotated[StrictStr, Field(..., return self.delete_pex_queries_with_http_info(configuration_id, **kwargs) # noqa: E501 @validate_arguments - def delete_pex_queries_with_http_info(self, configuration_id : Annotated[StrictStr, Field(..., description="iotaConfiguration Id")], **kwargs) -> ApiResponse: # noqa: E501 - """deletes pex queries # noqa: E501 + def delete_pex_queries_with_http_info(self, configuration_id : Annotated[StrictStr, Field(..., description="ID of the Affinidi Iota Framework configuration.")], **kwargs) -> ApiResponse: # noqa: E501 + """delete_pex_queries # noqa: E501 - deletes pex queries # noqa: E501 + Deletes all Presentation Definition queries of a configuration. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_pex_queries_with_http_info(configuration_id, async_req=True) >>> result = thread.get() - :param configuration_id: iotaConfiguration Id (required) + :param configuration_id: ID of the Affinidi Iota Framework configuration. (required) :type configuration_id: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional @@ -347,18 +349,19 @@ def delete_pex_queries_with_http_info(self, configuration_id : Annotated[StrictS _request_auth=_params.get('_request_auth')) @validate_arguments - def delete_pex_query_by_id(self, configuration_id : Annotated[StrictStr, Field(..., description="iotaConfiguration Id")], query_id : Annotated[StrictStr, Field(..., description="pex-query Id")], **kwargs) -> None: # noqa: E501 + def delete_pex_query_by_id(self, configuration_id : Annotated[StrictStr, Field(..., description="ID of the Affinidi Iota Framework configuration.")], query_id : Annotated[StrictStr, Field(..., description="The ID of the query.")], **kwargs) -> None: # noqa: E501 """delete_pex_query_by_id # noqa: E501 + Deletes a Presentation Definition in the configuration by ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_pex_query_by_id(configuration_id, query_id, async_req=True) >>> result = thread.get() - :param configuration_id: iotaConfiguration Id (required) + :param configuration_id: ID of the Affinidi Iota Framework configuration. (required) :type configuration_id: str - :param query_id: pex-query Id (required) + :param query_id: The ID of the query. (required) :type query_id: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional @@ -378,18 +381,19 @@ def delete_pex_query_by_id(self, configuration_id : Annotated[StrictStr, Field(. return self.delete_pex_query_by_id_with_http_info(configuration_id, query_id, **kwargs) # noqa: E501 @validate_arguments - def delete_pex_query_by_id_with_http_info(self, configuration_id : Annotated[StrictStr, Field(..., description="iotaConfiguration Id")], query_id : Annotated[StrictStr, Field(..., description="pex-query Id")], **kwargs) -> ApiResponse: # noqa: E501 + def delete_pex_query_by_id_with_http_info(self, configuration_id : Annotated[StrictStr, Field(..., description="ID of the Affinidi Iota Framework configuration.")], query_id : Annotated[StrictStr, Field(..., description="The ID of the query.")], **kwargs) -> ApiResponse: # noqa: E501 """delete_pex_query_by_id # noqa: E501 + Deletes a Presentation Definition in the configuration by ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_pex_query_by_id_with_http_info(configuration_id, query_id, async_req=True) >>> result = thread.get() - :param configuration_id: iotaConfiguration Id (required) + :param configuration_id: ID of the Affinidi Iota Framework configuration. (required) :type configuration_id: str - :param query_id: pex-query Id (required) + :param query_id: The ID of the query. (required) :type query_id: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional @@ -491,18 +495,19 @@ def delete_pex_query_by_id_with_http_info(self, configuration_id : Annotated[Str _request_auth=_params.get('_request_auth')) @validate_arguments - def get_pex_query_by_id(self, configuration_id : Annotated[StrictStr, Field(..., description="iotaConfiguration Id")], query_id : Annotated[StrictStr, Field(..., description="pex-query Id")], **kwargs) -> PexQueryDto: # noqa: E501 + def get_pex_query_by_id(self, configuration_id : Annotated[StrictStr, Field(..., description="ID of the Affinidi Iota Framework configuration.")], query_id : Annotated[StrictStr, Field(..., description="The ID of the query.")], **kwargs) -> PexQueryDto: # noqa: E501 """get_pex_query_by_id # noqa: E501 + Retrieves a Presentation Definition in the configuration by ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_pex_query_by_id(configuration_id, query_id, async_req=True) >>> result = thread.get() - :param configuration_id: iotaConfiguration Id (required) + :param configuration_id: ID of the Affinidi Iota Framework configuration. (required) :type configuration_id: str - :param query_id: pex-query Id (required) + :param query_id: The ID of the query. (required) :type query_id: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional @@ -522,18 +527,19 @@ def get_pex_query_by_id(self, configuration_id : Annotated[StrictStr, Field(..., return self.get_pex_query_by_id_with_http_info(configuration_id, query_id, **kwargs) # noqa: E501 @validate_arguments - def get_pex_query_by_id_with_http_info(self, configuration_id : Annotated[StrictStr, Field(..., description="iotaConfiguration Id")], query_id : Annotated[StrictStr, Field(..., description="pex-query Id")], **kwargs) -> ApiResponse: # noqa: E501 + def get_pex_query_by_id_with_http_info(self, configuration_id : Annotated[StrictStr, Field(..., description="ID of the Affinidi Iota Framework configuration.")], query_id : Annotated[StrictStr, Field(..., description="The ID of the query.")], **kwargs) -> ApiResponse: # noqa: E501 """get_pex_query_by_id # noqa: E501 + Retrieves a Presentation Definition in the configuration by ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_pex_query_by_id_with_http_info(configuration_id, query_id, async_req=True) >>> result = thread.get() - :param configuration_id: iotaConfiguration Id (required) + :param configuration_id: ID of the Affinidi Iota Framework configuration. (required) :type configuration_id: str - :param query_id: pex-query Id (required) + :param query_id: The ID of the query. (required) :type query_id: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional @@ -640,16 +646,17 @@ def get_pex_query_by_id_with_http_info(self, configuration_id : Annotated[Strict _request_auth=_params.get('_request_auth')) @validate_arguments - def list_pex_queries(self, configuration_id : Annotated[StrictStr, Field(..., description="iotaConfiguration Id")], limit : Annotated[Optional[conint(strict=True, le=100, ge=1)], Field(description="Maximum number of records to fetch in a list")] = None, exclusive_start_key : Annotated[Optional[constr(strict=True, max_length=3000)], Field(description="The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation.")] = None, **kwargs) -> ListPexQueriesOK: # noqa: E501 + def list_pex_queries(self, configuration_id : Annotated[StrictStr, Field(..., description="ID of the Affinidi Iota Framework configuration.")], limit : Annotated[Optional[conint(strict=True, le=100, ge=1)], Field(description="Maximum number of records to fetch in a list")] = None, exclusive_start_key : Annotated[Optional[constr(strict=True, max_length=3000)], Field(description="The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation.")] = None, **kwargs) -> ListPexQueriesOK: # noqa: E501 """list_pex_queries # noqa: E501 + Lists all Presentation Definitions in the configuration. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_pex_queries(configuration_id, limit, exclusive_start_key, async_req=True) >>> result = thread.get() - :param configuration_id: iotaConfiguration Id (required) + :param configuration_id: ID of the Affinidi Iota Framework configuration. (required) :type configuration_id: str :param limit: Maximum number of records to fetch in a list :type limit: int @@ -673,16 +680,17 @@ def list_pex_queries(self, configuration_id : Annotated[StrictStr, Field(..., de return self.list_pex_queries_with_http_info(configuration_id, limit, exclusive_start_key, **kwargs) # noqa: E501 @validate_arguments - def list_pex_queries_with_http_info(self, configuration_id : Annotated[StrictStr, Field(..., description="iotaConfiguration Id")], limit : Annotated[Optional[conint(strict=True, le=100, ge=1)], Field(description="Maximum number of records to fetch in a list")] = None, exclusive_start_key : Annotated[Optional[constr(strict=True, max_length=3000)], Field(description="The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + def list_pex_queries_with_http_info(self, configuration_id : Annotated[StrictStr, Field(..., description="ID of the Affinidi Iota Framework configuration.")], limit : Annotated[Optional[conint(strict=True, le=100, ge=1)], Field(description="Maximum number of records to fetch in a list")] = None, exclusive_start_key : Annotated[Optional[constr(strict=True, max_length=3000)], Field(description="The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation.")] = None, **kwargs) -> ApiResponse: # noqa: E501 """list_pex_queries # noqa: E501 + Lists all Presentation Definitions in the configuration. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_pex_queries_with_http_info(configuration_id, limit, exclusive_start_key, async_req=True) >>> result = thread.get() - :param configuration_id: iotaConfiguration Id (required) + :param configuration_id: ID of the Affinidi Iota Framework configuration. (required) :type configuration_id: str :param limit: Maximum number of records to fetch in a list :type limit: int @@ -797,17 +805,17 @@ def list_pex_queries_with_http_info(self, configuration_id : Annotated[StrictStr _request_auth=_params.get('_request_auth')) @validate_arguments - def save_pex_queries(self, configuration_id : Annotated[StrictStr, Field(..., description="iotaConfiguration Id")], save_pex_queries_update_input : Annotated[SavePexQueriesUpdateInput, Field(..., description="SavePexQueriesInput")], **kwargs) -> object: # noqa: E501 + def save_pex_queries(self, configuration_id : Annotated[StrictStr, Field(..., description="ID of the Affinidi Iota Framework configuration.")], save_pex_queries_update_input : Annotated[SavePexQueriesUpdateInput, Field(..., description="SavePexQueriesInput")], **kwargs) -> object: # noqa: E501 """save_pex_queries # noqa: E501 - saves all pex queries # noqa: E501 + Saves all Presentation Definition queries of a configuration. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.save_pex_queries(configuration_id, save_pex_queries_update_input, async_req=True) >>> result = thread.get() - :param configuration_id: iotaConfiguration Id (required) + :param configuration_id: ID of the Affinidi Iota Framework configuration. (required) :type configuration_id: str :param save_pex_queries_update_input: SavePexQueriesInput (required) :type save_pex_queries_update_input: SavePexQueriesUpdateInput @@ -829,17 +837,17 @@ def save_pex_queries(self, configuration_id : Annotated[StrictStr, Field(..., de return self.save_pex_queries_with_http_info(configuration_id, save_pex_queries_update_input, **kwargs) # noqa: E501 @validate_arguments - def save_pex_queries_with_http_info(self, configuration_id : Annotated[StrictStr, Field(..., description="iotaConfiguration Id")], save_pex_queries_update_input : Annotated[SavePexQueriesUpdateInput, Field(..., description="SavePexQueriesInput")], **kwargs) -> ApiResponse: # noqa: E501 + def save_pex_queries_with_http_info(self, configuration_id : Annotated[StrictStr, Field(..., description="ID of the Affinidi Iota Framework configuration.")], save_pex_queries_update_input : Annotated[SavePexQueriesUpdateInput, Field(..., description="SavePexQueriesInput")], **kwargs) -> ApiResponse: # noqa: E501 """save_pex_queries # noqa: E501 - saves all pex queries # noqa: E501 + Saves all Presentation Definition queries of a configuration. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.save_pex_queries_with_http_info(configuration_id, save_pex_queries_update_input, async_req=True) >>> result = thread.get() - :param configuration_id: iotaConfiguration Id (required) + :param configuration_id: ID of the Affinidi Iota Framework configuration. (required) :type configuration_id: str :param save_pex_queries_update_input: SavePexQueriesInput (required) :type save_pex_queries_update_input: SavePexQueriesUpdateInput @@ -954,18 +962,19 @@ def save_pex_queries_with_http_info(self, configuration_id : Annotated[StrictStr _request_auth=_params.get('_request_auth')) @validate_arguments - def update_pex_query_by_id(self, configuration_id : Annotated[StrictStr, Field(..., description="iotaConfiguration Id")], query_id : Annotated[StrictStr, Field(..., description="pex-query Id")], update_pex_query_input : Annotated[UpdatePexQueryInput, Field(..., description="UpdatePexQueryById")], **kwargs) -> PexQueryDto: # noqa: E501 + def update_pex_query_by_id(self, configuration_id : Annotated[StrictStr, Field(..., description="ID of the Affinidi Iota Framework configuration.")], query_id : Annotated[StrictStr, Field(..., description="The ID of the query.")], update_pex_query_input : Annotated[UpdatePexQueryInput, Field(..., description="UpdatePexQueryById")], **kwargs) -> PexQueryDto: # noqa: E501 """update_pex_query_by_id # noqa: E501 + Updates the Presentation Definition in the configuration by ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_pex_query_by_id(configuration_id, query_id, update_pex_query_input, async_req=True) >>> result = thread.get() - :param configuration_id: iotaConfiguration Id (required) + :param configuration_id: ID of the Affinidi Iota Framework configuration. (required) :type configuration_id: str - :param query_id: pex-query Id (required) + :param query_id: The ID of the query. (required) :type query_id: str :param update_pex_query_input: UpdatePexQueryById (required) :type update_pex_query_input: UpdatePexQueryInput @@ -987,18 +996,19 @@ def update_pex_query_by_id(self, configuration_id : Annotated[StrictStr, Field(. return self.update_pex_query_by_id_with_http_info(configuration_id, query_id, update_pex_query_input, **kwargs) # noqa: E501 @validate_arguments - def update_pex_query_by_id_with_http_info(self, configuration_id : Annotated[StrictStr, Field(..., description="iotaConfiguration Id")], query_id : Annotated[StrictStr, Field(..., description="pex-query Id")], update_pex_query_input : Annotated[UpdatePexQueryInput, Field(..., description="UpdatePexQueryById")], **kwargs) -> ApiResponse: # noqa: E501 + def update_pex_query_by_id_with_http_info(self, configuration_id : Annotated[StrictStr, Field(..., description="ID of the Affinidi Iota Framework configuration.")], query_id : Annotated[StrictStr, Field(..., description="The ID of the query.")], update_pex_query_input : Annotated[UpdatePexQueryInput, Field(..., description="UpdatePexQueryById")], **kwargs) -> ApiResponse: # noqa: E501 """update_pex_query_by_id # noqa: E501 + Updates the Presentation Definition in the configuration by ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_pex_query_by_id_with_http_info(configuration_id, query_id, update_pex_query_input, async_req=True) >>> result = thread.get() - :param configuration_id: iotaConfiguration Id (required) + :param configuration_id: ID of the Affinidi Iota Framework configuration. (required) :type configuration_id: str - :param query_id: pex-query Id (required) + :param query_id: The ID of the query. (required) :type query_id: str :param update_pex_query_input: UpdatePexQueryById (required) :type update_pex_query_input: UpdatePexQueryInput diff --git a/clients/python/iota_client/affinidi_tdk_iota_client/models/aws_exchange_credentials.py b/clients/python/iota_client/affinidi_tdk_iota_client/models/aws_exchange_credentials.py index b43294df..99c9bc74 100644 --- a/clients/python/iota_client/affinidi_tdk_iota_client/models/aws_exchange_credentials.py +++ b/clients/python/iota_client/affinidi_tdk_iota_client/models/aws_exchange_credentials.py @@ -26,7 +26,7 @@ class AwsExchangeCredentials(BaseModel): """ AwsExchangeCredentials """ - assertion: StrictStr = Field(default=..., description="JWT signed with a machine token used to secure the web socket connection") + assertion: StrictStr = Field(default=..., description="A valid JSON Web Token (JWT) that secures the WebSocket connection. The JWT is signed with the key pair's private key used to create the Personal Access Token (PAT).") __properties = ["assertion"] class Config: diff --git a/clients/python/iota_client/affinidi_tdk_iota_client/models/aws_exchange_credentials_project_token.py b/clients/python/iota_client/affinidi_tdk_iota_client/models/aws_exchange_credentials_project_token.py index 51fed0d9..a3ba3cf2 100644 --- a/clients/python/iota_client/affinidi_tdk_iota_client/models/aws_exchange_credentials_project_token.py +++ b/clients/python/iota_client/affinidi_tdk_iota_client/models/aws_exchange_credentials_project_token.py @@ -26,9 +26,9 @@ class AwsExchangeCredentialsProjectToken(BaseModel): """ AwsExchangeCredentialsProjectToken """ - session_id: StrictStr = Field(default=..., alias="sessionId", description="sessionId generated by client") - configuration_id: StrictStr = Field(default=..., alias="configurationId", description="iotaConfiguration Id") - did: StrictStr = Field(default=..., description="Vault DID of the user") + session_id: StrictStr = Field(default=..., alias="sessionId", description="ID of the session generated by a client.") + configuration_id: StrictStr = Field(default=..., alias="configurationId", description="ID of the Affinidi Iota Framework configuration.") + did: StrictStr = Field(default=..., description="The Decentalised Identifier (DID) of the user.") __properties = ["sessionId", "configurationId", "did"] class Config: diff --git a/clients/python/iota_client/affinidi_tdk_iota_client/models/callback_input.py b/clients/python/iota_client/affinidi_tdk_iota_client/models/callback_input.py index c6b74b8f..afb99596 100644 --- a/clients/python/iota_client/affinidi_tdk_iota_client/models/callback_input.py +++ b/clients/python/iota_client/affinidi_tdk_iota_client/models/callback_input.py @@ -26,12 +26,12 @@ class CallbackInput(BaseModel): """ CallbackInput """ - state: StrictStr = Field(default=..., description="A string that must be a valid UUID (version 1-5).") - presentation_submission: Optional[StrictStr] = Field(default=None, description="A string that must be a valid JSON object. The structure of presentation submission should follow OID4VP standard.") - vp_token: Optional[StrictStr] = Field(default=None, description="A string that must be a valid JSON object. Ensure to escape special characters properly..") - error: Optional[StrictStr] = Field(default=None, description="The error should follow the OAuth2 error format (e.g. invalid_request, login_required). Defaults to access_denied") - error_description: Optional[StrictStr] = Field(default=None, description="Description of the error in a human readable format") - onboarded: Optional[StrictBool] = Field(default=None, description="Specifies whether the Iota share triggered the creation of a Vault") + state: StrictStr = Field(default=..., description="A randomly generated string that follows a valid UUID (version 1-5) format to validate the session.") + presentation_submission: Optional[StrictStr] = Field(default=None, description="A JSON string format that describes the link between the Verifiable Presentation and Presentation Definition for the verifier. The presentation submission follows the OID4VP standard.") + vp_token: Optional[StrictStr] = Field(default=None, description="A JSON string format containing the data the user consented to share in a Verifiable Presentation format. The VP Token follows the OID4VP standard.") + error: Optional[StrictStr] = Field(default=None, description="A short string indicating the error code reported by the service. It follows the OAuth 2.0 error code format (e.g., invalid_request, access_denied). The default is access_denied.") + error_description: Optional[StrictStr] = Field(default=None, description="A human-readable description that provides detailed information about the error.") + onboarded: Optional[StrictBool] = Field(default=None, description="It specifies whether the data sharing flow triggered an onboarding process to the Affinidi Vault [New User].") __properties = ["state", "presentation_submission", "vp_token", "error", "error_description", "onboarded"] class Config: diff --git a/clients/python/iota_client/affinidi_tdk_iota_client/models/callback_response_ok.py b/clients/python/iota_client/affinidi_tdk_iota_client/models/callback_response_ok.py index 2526d739..ae04d757 100644 --- a/clients/python/iota_client/affinidi_tdk_iota_client/models/callback_response_ok.py +++ b/clients/python/iota_client/affinidi_tdk_iota_client/models/callback_response_ok.py @@ -26,9 +26,9 @@ class CallbackResponseOK(BaseModel): """ CallbackResponseOK """ - redirect_uri: Optional[StrictStr] = Field(default=None, description="URL to which vault will redirect") - response_code: Optional[StrictStr] = Field(default=None, description="Code which will be used along with transactionId to retrieve data") - message: StrictStr = Field(default=..., description="A message to vault that flow is updated successfully") + redirect_uri: Optional[StrictStr] = Field(default=None, description="The URL to which Affinidi Vault will redirect the user.") + response_code: Optional[StrictStr] = Field(default=None, description="A unique identifier to fetch the callback response data. Send this value together with the transactionId to successfully fetch the data.") + message: StrictStr = Field(default=..., description="A message to the Affinidi Vault indicating that the update was successful.") __properties = ["redirect_uri", "response_code", "message"] class Config: diff --git a/clients/python/iota_client/affinidi_tdk_iota_client/models/consent_dto.py b/clients/python/iota_client/affinidi_tdk_iota_client/models/consent_dto.py index 0d7f9746..e42ca554 100644 --- a/clients/python/iota_client/affinidi_tdk_iota_client/models/consent_dto.py +++ b/clients/python/iota_client/affinidi_tdk_iota_client/models/consent_dto.py @@ -26,11 +26,11 @@ class ConsentDto(BaseModel): """ ConsentDto """ - project_id: StrictStr = Field(default=..., alias="projectId") - id: StrictStr = Field(default=..., description="id of the record") - user_id: StrictStr = Field(default=..., alias="userId", description="unique identifier of the user") - vc_type: StrictStr = Field(default=..., alias="vcType", description="VC type of shared vc. If the actual VC has several VC types (excluding base types as VerifiableCredential) then for each of the a separate record will be added") - status: StrictStr = Field(...) + project_id: StrictStr = Field(default=..., alias="projectId", description="The ID of the project.") + id: StrictStr = Field(default=..., description="Unique identifier for the record.") + user_id: StrictStr = Field(default=..., alias="userId", description="Unique identifier for the user.") + vc_type: StrictStr = Field(default=..., alias="vcType", description="Type of the VC shared by the user. It creates a consent record for each VC type shared except for the base type VerifiableCredential.") + status: StrictStr = Field(default=..., description="Status of the consent.") modified_at: StrictStr = Field(default=..., alias="modifiedAt") modified_by: StrictStr = Field(default=..., alias="modifiedBy") created_at: StrictStr = Field(default=..., alias="createdAt") diff --git a/clients/python/iota_client/affinidi_tdk_iota_client/models/create_iota_configuration_input.py b/clients/python/iota_client/affinidi_tdk_iota_client/models/create_iota_configuration_input.py index a75fb7e9..cd603892 100644 --- a/clients/python/iota_client/affinidi_tdk_iota_client/models/create_iota_configuration_input.py +++ b/clients/python/iota_client/affinidi_tdk_iota_client/models/create_iota_configuration_input.py @@ -27,17 +27,17 @@ class CreateIotaConfigurationInput(BaseModel): """ CreateIotaConfigurationInput """ - name: StrictStr = Field(default=..., description="The name of the configuration") - description: Optional[StrictStr] = Field(default=None, description="Description of the configuration") - wallet_ari: StrictStr = Field(default=..., alias="walletAri", description="The wallet Ari that will be used to sign") - iota_response_webhook_url: Optional[StrictStr] = Field(default=None, alias="iotaResponseWebhookURL", description="webhook to call when data is ready") - enable_verification: StrictBool = Field(default=..., alias="enableVerification") - enable_consent_audit_log: StrictBool = Field(default=..., alias="enableConsentAuditLog") - token_max_age: Optional[Union[confloat(ge=1, strict=True), conint(ge=1, strict=True)]] = Field(default=None, alias="tokenMaxAge", description="token time to live in seconds") + name: StrictStr = Field(default=..., description="The name of the configuration to quickly identify the resource.") + description: Optional[StrictStr] = Field(default=None, description="An optional description of what the configuration is used for.") + wallet_ari: StrictStr = Field(default=..., alias="walletAri", description="The unique resource identifier of the Wallet used to sign the request token.") + iota_response_webhook_url: Optional[StrictStr] = Field(default=None, alias="iotaResponseWebhookURL", description="The webhook URL is used for callback when the data is ready.") + enable_verification: StrictBool = Field(default=..., alias="enableVerification", description="Cryptographically verifies the data shared by the user when enabled.") + enable_consent_audit_log: StrictBool = Field(default=..., alias="enableConsentAuditLog", description="Records the user's consent when they share their data, including the type of data shared when enabled.") + token_max_age: Optional[Union[confloat(ge=1, strict=True), conint(ge=1, strict=True)]] = Field(default=None, alias="tokenMaxAge", description="This is the lifetime of the signed request token during the data-sharing flow.") client_metadata: IotaConfigurationDtoClientMetadata = Field(default=..., alias="clientMetadata") - mode: Optional[StrictStr] = Field(default='websocket', description="indicates whether the flow is a WebSocket flow or a Redirect flow. This value is used in Vault to determine how to process the data flow request.") - redirect_uris: Optional[conlist(StrictStr)] = Field(default=None, alias="redirectUris", description="the URL that the user will be redirected to after the request has been processed; should be provided by the developer of the client application.Required only if mode is Redirect.") - enable_idv_providers: Optional[StrictBool] = Field(default=None, alias="enableIdvProviders", description="enables third party IDV provider verification for the given configuration") + mode: Optional[StrictStr] = Field(default='websocket', description="Determines whether to handle the data-sharing request using the WebSocket or Redirect flow.") + redirect_uris: Optional[conlist(StrictStr)] = Field(default=None, alias="redirectUris", description="List of allowed URLs to redirect users, including the response from the request. This is required if the selected data-sharing mode is Redirect.") + enable_idv_providers: Optional[StrictBool] = Field(default=None, alias="enableIdvProviders", description="Enables identity verification from user with a 3rd-party provider when a verified identity document is not found.") __properties = ["name", "description", "walletAri", "iotaResponseWebhookURL", "enableVerification", "enableConsentAuditLog", "tokenMaxAge", "clientMetadata", "mode", "redirectUris", "enableIdvProviders"] @validator('mode') diff --git a/clients/python/iota_client/affinidi_tdk_iota_client/models/create_pex_query_input.py b/clients/python/iota_client/affinidi_tdk_iota_client/models/create_pex_query_input.py index 892d59d5..641e721f 100644 --- a/clients/python/iota_client/affinidi_tdk_iota_client/models/create_pex_query_input.py +++ b/clients/python/iota_client/affinidi_tdk_iota_client/models/create_pex_query_input.py @@ -26,9 +26,9 @@ class CreatePexQueryInput(BaseModel): """ CreatePexQueryInput """ - name: StrictStr = Field(...) - vp_definition: StrictStr = Field(default=..., alias="vpDefinition", description="VP definition in JSON stringify format") - description: Optional[StrictStr] = Field(default=None, description="Description of query") + name: StrictStr = Field(default=..., description="The name of the presentation definition to quickly identify the query.") + vp_definition: StrictStr = Field(default=..., alias="vpDefinition", description="The presentation definition describing the data requirement that must be satisfied by the user. The value is in a JSON stringify format.") + description: Optional[StrictStr] = Field(default=None, description="An optional description of what the query is used for.") __properties = ["name", "vpDefinition", "description"] class Config: diff --git a/clients/python/iota_client/affinidi_tdk_iota_client/models/fetch_iotavp_response_input.py b/clients/python/iota_client/affinidi_tdk_iota_client/models/fetch_iotavp_response_input.py index fbc476df..9c328376 100644 --- a/clients/python/iota_client/affinidi_tdk_iota_client/models/fetch_iotavp_response_input.py +++ b/clients/python/iota_client/affinidi_tdk_iota_client/models/fetch_iotavp_response_input.py @@ -26,10 +26,10 @@ class FetchIOTAVPResponseInput(BaseModel): """ FetchIOTAVPResponseInput """ - correlation_id: StrictStr = Field(default=..., alias="correlationId", description="The correlation ID") - transaction_id: StrictStr = Field(default=..., alias="transactionId", description="The transaction ID") - response_code: constr(strict=True, max_length=255, min_length=1) = Field(default=..., alias="responseCode", description="The response code.") - configuration_id: StrictStr = Field(default=..., alias="configurationId", description="The configuration ID") + correlation_id: StrictStr = Field(default=..., alias="correlationId", description="A unique, randomly generated identifier that correlates the request and response in the data-sharing request flow.") + transaction_id: StrictStr = Field(default=..., alias="transactionId", description="A unique, randomly generated identifier data-sharing request flow is initiated. This value is used with the response code to fetch the callback response data.") + response_code: constr(strict=True, max_length=255, min_length=1) = Field(default=..., alias="responseCode", description="A unique identifier to fetch the callback response data. Send this value together with the transactionId to successfully fetch the data.") + configuration_id: StrictStr = Field(default=..., alias="configurationId", description="ID of the Affinidi Iota Framework configuration.") __properties = ["correlationId", "transactionId", "responseCode", "configurationId"] class Config: diff --git a/clients/python/iota_client/affinidi_tdk_iota_client/models/fetch_iotavp_response_ok.py b/clients/python/iota_client/affinidi_tdk_iota_client/models/fetch_iotavp_response_ok.py index e8d499c7..4939986e 100644 --- a/clients/python/iota_client/affinidi_tdk_iota_client/models/fetch_iotavp_response_ok.py +++ b/clients/python/iota_client/affinidi_tdk_iota_client/models/fetch_iotavp_response_ok.py @@ -26,9 +26,9 @@ class FetchIOTAVPResponseOK(BaseModel): """ FetchIOTAVPResponseOK """ - correlation_id: Optional[StrictStr] = Field(default=None, alias="correlationId", description="A correlationId used for the flow") - presentation_submission: Optional[StrictStr] = Field(default=None, description="A string that must be a valid JSON object. The structure of presentation submission should follow OID4VP standard.") - vp_token: Optional[StrictStr] = Field(default=None, description="A string that must be a valid JSON object. Ensure to escape special characters properly..") + correlation_id: Optional[StrictStr] = Field(default=None, alias="correlationId", description="A unique, randomly generated identifier that correlates the request and response in the data-sharing request flow.") + presentation_submission: Optional[StrictStr] = Field(default=None, description="A JSON string format that describes the link between the Verifiable Presentation and Presentation Definition for the verifier. The presentation submission follows the OID4VP standard.") + vp_token: Optional[StrictStr] = Field(default=None, description="A JSON string format containing the data the user consented to share in a Verifiable Presentation format. The VP Token follows the OID4VP standard.") additional_properties: Dict[str, Any] = {} __properties = ["correlationId", "presentation_submission", "vp_token"] diff --git a/clients/python/iota_client/affinidi_tdk_iota_client/models/get_iota_configuration_meta_data_ok.py b/clients/python/iota_client/affinidi_tdk_iota_client/models/get_iota_configuration_meta_data_ok.py index 7c3a0897..1036b8ab 100644 --- a/clients/python/iota_client/affinidi_tdk_iota_client/models/get_iota_configuration_meta_data_ok.py +++ b/clients/python/iota_client/affinidi_tdk_iota_client/models/get_iota_configuration_meta_data_ok.py @@ -26,9 +26,9 @@ class GetIotaConfigurationMetaDataOK(BaseModel): """ GetIotaConfigurationMetaDataOK """ - name: StrictStr = Field(default=..., description="application name that will be displayed in consent page") - origin: StrictStr = Field(default=..., description="origin url that will be displayed in consent page") - logo: StrictStr = Field(default=..., description="logo url that will be displayed in consent page") + name: StrictStr = Field(default=..., description="The name displayed on the consent page indicates who is requesting data from the user. It can be the application or website's name.") + origin: StrictStr = Field(default=..., description="The URL of the requester displayed on the consent page indicates the request's origin.") + logo: StrictStr = Field(default=..., description="The logo of the requester displayed on the consent page, allowing users to easily recognise who requests the data.") __properties = ["name", "origin", "logo"] class Config: diff --git a/clients/python/iota_client/affinidi_tdk_iota_client/models/initiate_data_sharing_request_input.py b/clients/python/iota_client/affinidi_tdk_iota_client/models/initiate_data_sharing_request_input.py index 3499ce42..00337224 100644 --- a/clients/python/iota_client/affinidi_tdk_iota_client/models/initiate_data_sharing_request_input.py +++ b/clients/python/iota_client/affinidi_tdk_iota_client/models/initiate_data_sharing_request_input.py @@ -26,13 +26,13 @@ class InitiateDataSharingRequestInput(BaseModel): """ InitiateDataSharingRequestInput """ - query_id: StrictStr = Field(default=..., alias="queryId") - correlation_id: StrictStr = Field(default=..., alias="correlationId") - token_max_age: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="tokenMaxAge", description="token time to live in seconds") - nonce: StrictStr = Field(default=..., description="Random value used to prevent replay attacks") - redirect_uri: StrictStr = Field(default=..., alias="redirectUri", description="the URL that the user will be redirected to after the request has been processed; should be provided by the developer of the client application.") - configuration_id: StrictStr = Field(default=..., alias="configurationId", description="id of the IOTA configuration used") - mode: StrictStr = Field(default=..., description="indicates whether the flow is a WebSocket flow or a Redirect flow. This value is used in Vault to determine how to process the data flow request.") + query_id: StrictStr = Field(default=..., alias="queryId", description="The ID of the query.") + correlation_id: StrictStr = Field(default=..., alias="correlationId", description="A unique, randomly generated identifier that correlates the request and response in the data-sharing request flow.") + token_max_age: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="tokenMaxAge", description="This is the lifetime of the signed request token during the data-sharing flow.") + nonce: StrictStr = Field(default=..., description="A randomly generated value that is added in the request and response to prevent replay attacks.") + redirect_uri: StrictStr = Field(default=..., alias="redirectUri", description="List of allowed URLs to redirect users, including the response from the request. This is required if the selected data-sharing mode is Redirect.") + configuration_id: StrictStr = Field(default=..., alias="configurationId", description="ID of the Affinidi Iota Framework configuration.") + mode: StrictStr = Field(default=..., description="Determines whether to handle the data-sharing request using the WebSocket or Redirect flow.") __properties = ["queryId", "correlationId", "tokenMaxAge", "nonce", "redirectUri", "configurationId", "mode"] @validator('mode') diff --git a/clients/python/iota_client/affinidi_tdk_iota_client/models/iota_configuration_dto.py b/clients/python/iota_client/affinidi_tdk_iota_client/models/iota_configuration_dto.py index 6418b17e..9986eaee 100644 --- a/clients/python/iota_client/affinidi_tdk_iota_client/models/iota_configuration_dto.py +++ b/clients/python/iota_client/affinidi_tdk_iota_client/models/iota_configuration_dto.py @@ -27,19 +27,19 @@ class IotaConfigurationDto(BaseModel): """ IotaConfigurationDto """ - ari: StrictStr = Field(default=..., description="The ARI of the config") - configuration_id: StrictStr = Field(default=..., alias="configurationId") - name: StrictStr = Field(default=..., description="The name of the config") - project_id: StrictStr = Field(default=..., alias="projectId") - wallet_ari: StrictStr = Field(default=..., alias="walletAri", description="The wallet Ari that will be used to sign") - token_max_age: Union[StrictFloat, StrictInt] = Field(default=..., alias="tokenMaxAge", description="token time to live in seconds") - iota_response_webhook_url: Optional[StrictStr] = Field(default=None, alias="iotaResponseWebhookURL", description="webhook to call when data is ready") - enable_verification: StrictBool = Field(default=..., alias="enableVerification") - enable_consent_audit_log: StrictBool = Field(default=..., alias="enableConsentAuditLog") + ari: StrictStr = Field(default=..., description="This is a unique resource identifier of the Affinidi Iota Framework configuration.") + configuration_id: StrictStr = Field(default=..., alias="configurationId", description="ID of the Affinidi Iota Framework configuration.") + name: StrictStr = Field(default=..., description="The name of the configuration to quickly identify the resource.") + project_id: StrictStr = Field(default=..., alias="projectId", description="The ID of the project.") + wallet_ari: StrictStr = Field(default=..., alias="walletAri", description="The unique resource identifier of the Wallet used to sign the request token.") + token_max_age: Union[StrictFloat, StrictInt] = Field(default=..., alias="tokenMaxAge", description="This is the lifetime of the signed request token during the data-sharing flow.") + iota_response_webhook_url: Optional[StrictStr] = Field(default=None, alias="iotaResponseWebhookURL", description="The webhook URL is used for callback when the data is ready.") + enable_verification: StrictBool = Field(default=..., alias="enableVerification", description="Cryptographically verifies the data shared by the user when enabled.") + enable_consent_audit_log: StrictBool = Field(default=..., alias="enableConsentAuditLog", description="Records the consent the user gave when they shared their data, including the type of data shared.") client_metadata: IotaConfigurationDtoClientMetadata = Field(default=..., alias="clientMetadata") - mode: Optional[StrictStr] = Field(default='websocket', description="indicates whether the flow is a WebSocket flow or a Redirect flow. This value is used in Vault to determine how to process the data flow request.") - redirect_uris: Optional[conlist(StrictStr)] = Field(default=None, alias="redirectUris", description="the URLs that the user will be redirected to after the request has been processed; should be provided by the developer of the client application.Required only if mode is Redirect.") - enable_idv_providers: Optional[StrictBool] = Field(default=None, alias="enableIdvProviders", description="enables third party IDV provider verification for the given configuration") + mode: Optional[StrictStr] = Field(default='websocket', description="Determines whether to handle the data-sharing request using the WebSocket or Redirect flow.") + redirect_uris: Optional[conlist(StrictStr)] = Field(default=None, alias="redirectUris", description="List of allowed URLs to redirect users, including the response from the request. This is required if the selected data-sharing mode is Redirect.") + enable_idv_providers: Optional[StrictBool] = Field(default=None, alias="enableIdvProviders", description="Enables identity verification from user with a 3rd-party provider when a verified identity document is not found.") __properties = ["ari", "configurationId", "name", "projectId", "walletAri", "tokenMaxAge", "iotaResponseWebhookURL", "enableVerification", "enableConsentAuditLog", "clientMetadata", "mode", "redirectUris", "enableIdvProviders"] @validator('mode') diff --git a/clients/python/iota_client/affinidi_tdk_iota_client/models/iota_configuration_dto_client_metadata.py b/clients/python/iota_client/affinidi_tdk_iota_client/models/iota_configuration_dto_client_metadata.py index efc739cc..369710cc 100644 --- a/clients/python/iota_client/affinidi_tdk_iota_client/models/iota_configuration_dto_client_metadata.py +++ b/clients/python/iota_client/affinidi_tdk_iota_client/models/iota_configuration_dto_client_metadata.py @@ -24,11 +24,11 @@ class IotaConfigurationDtoClientMetadata(BaseModel): """ - iota configuration client metadata # noqa: E501 + It contains information about the requester or verifier. # noqa: E501 """ - name: StrictStr = Field(default=..., description="application name that will be displayed in consent page") - origin: StrictStr = Field(default=..., description="origin url that will be displayed in consent page") - logo: StrictStr = Field(default=..., description="logo url that will be displayed in consent page") + name: StrictStr = Field(default=..., description="The name displayed on the consent page indicates who is requesting data from the user. It can be the application or website's name.") + origin: StrictStr = Field(default=..., description="The URL of the requester displayed on the consent page indicates the request's origin.") + logo: StrictStr = Field(default=..., description="The logo of the requester displayed on the consent page, allowing users to easily recognise who requests the data.") additional_properties: Dict[str, Any] = {} __properties = ["name", "origin", "logo"] diff --git a/clients/python/iota_client/affinidi_tdk_iota_client/models/iota_exchange_credentials.py b/clients/python/iota_client/affinidi_tdk_iota_client/models/iota_exchange_credentials.py index 363d8d67..cdabed72 100644 --- a/clients/python/iota_client/affinidi_tdk_iota_client/models/iota_exchange_credentials.py +++ b/clients/python/iota_client/affinidi_tdk_iota_client/models/iota_exchange_credentials.py @@ -26,7 +26,7 @@ class IotaExchangeCredentials(BaseModel): """ IotaExchangeCredentials """ - assertion: StrictStr = Field(default=..., description="JWT signed with a machine token used to secure the web socket connection") + assertion: StrictStr = Field(default=..., description="A valid JSON Web Token (JWT) that secures the WebSocket connection. The JWT is signed with the key pair's private key used to create the Personal Access Token (PAT).") __properties = ["assertion"] class Config: diff --git a/clients/python/iota_client/affinidi_tdk_iota_client/models/pex_query_dto.py b/clients/python/iota_client/affinidi_tdk_iota_client/models/pex_query_dto.py index 874a7b98..6adf0e20 100644 --- a/clients/python/iota_client/affinidi_tdk_iota_client/models/pex_query_dto.py +++ b/clients/python/iota_client/affinidi_tdk_iota_client/models/pex_query_dto.py @@ -26,12 +26,12 @@ class PexQueryDto(BaseModel): """ PexQueryDto """ - ari: StrictStr = Field(...) - query_id: StrictStr = Field(default=..., alias="queryId") - name: StrictStr = Field(...) - description: StrictStr = Field(...) - configuration_ari: StrictStr = Field(default=..., alias="configurationAri") - vp_definition: StrictStr = Field(default=..., alias="vpDefinition", description="VP definition in JSON stringify format") + ari: StrictStr = Field(default=..., description="The unique resource identifier of the qeuery.") + query_id: StrictStr = Field(default=..., alias="queryId", description="The ID of the query.") + name: StrictStr = Field(default=..., description="The name of the presentation definition to quickly identify the query.") + description: StrictStr = Field(default=..., description="An optional description of what the query is used for.") + configuration_ari: StrictStr = Field(default=..., alias="configurationAri", description="The unique resource identifier of the related configuration where the query is defined.") + vp_definition: StrictStr = Field(default=..., alias="vpDefinition", description="The presentation definition describing the data requirement that must be satisfied by the user. The value is in a JSON stringify format.") __properties = ["ari", "queryId", "name", "description", "configurationAri", "vpDefinition"] class Config: diff --git a/clients/python/iota_client/affinidi_tdk_iota_client/models/prepare_request.py b/clients/python/iota_client/affinidi_tdk_iota_client/models/prepare_request.py index f5e49953..7bb037d5 100644 --- a/clients/python/iota_client/affinidi_tdk_iota_client/models/prepare_request.py +++ b/clients/python/iota_client/affinidi_tdk_iota_client/models/prepare_request.py @@ -28,8 +28,8 @@ class PrepareRequest(BaseModel): """ connection_client_id: StrictStr = Field(default=..., alias="connectionClientId") query_id: StrictStr = Field(default=..., alias="queryId") - correlation_id: StrictStr = Field(default=..., alias="correlationId") - token_max_age: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="tokenMaxAge", description="token time to live in seconds") + correlation_id: StrictStr = Field(default=..., alias="correlationId", description="A unique, randomly generated identifier that correlates the request and response in the data-sharing request flow.") + token_max_age: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="tokenMaxAge", description="This is the lifetime of the signed request token during the data-sharing flow.") audience: Optional[StrictStr] = None __properties = ["connectionClientId", "queryId", "correlationId", "tokenMaxAge", "audience"] diff --git a/clients/python/iota_client/affinidi_tdk_iota_client/models/prepare_request_created_data.py b/clients/python/iota_client/affinidi_tdk_iota_client/models/prepare_request_created_data.py index 9c69ed14..d58af006 100644 --- a/clients/python/iota_client/affinidi_tdk_iota_client/models/prepare_request_created_data.py +++ b/clients/python/iota_client/affinidi_tdk_iota_client/models/prepare_request_created_data.py @@ -27,7 +27,7 @@ class PrepareRequestCreatedData(BaseModel): PrepareRequestCreatedData """ jwt: StrictStr = Field(...) - correlation_id: StrictStr = Field(default=..., alias="correlationId") + correlation_id: StrictStr = Field(default=..., alias="correlationId", description="A unique, randomly generated identifier that correlates the request and response in the data-sharing request flow.") __properties = ["jwt", "correlationId"] class Config: diff --git a/clients/python/iota_client/affinidi_tdk_iota_client/models/save_pex_queries_update_input_queries_inner.py b/clients/python/iota_client/affinidi_tdk_iota_client/models/save_pex_queries_update_input_queries_inner.py index 284237d1..cd1c7acb 100644 --- a/clients/python/iota_client/affinidi_tdk_iota_client/models/save_pex_queries_update_input_queries_inner.py +++ b/clients/python/iota_client/affinidi_tdk_iota_client/models/save_pex_queries_update_input_queries_inner.py @@ -26,9 +26,9 @@ class SavePexQueriesUpdateInputQueriesInner(BaseModel): """ SavePexQueriesUpdateInputQueriesInner """ - query_id: StrictStr = Field(default=..., alias="queryId") - vp_definition: Optional[StrictStr] = Field(default=None, alias="vpDefinition") - description: Optional[StrictStr] = None + query_id: StrictStr = Field(default=..., alias="queryId", description="The ID of the query.") + vp_definition: Optional[StrictStr] = Field(default=None, alias="vpDefinition", description="The presentation definition describing the data requirement that must be satisfied by the user. The value is in a JSON stringify format.") + description: Optional[StrictStr] = Field(default=None, description="An optional description of what the query is used for.") __properties = ["queryId", "vpDefinition", "description"] class Config: diff --git a/clients/python/iota_client/affinidi_tdk_iota_client/models/update_configuration_by_id_input.py b/clients/python/iota_client/affinidi_tdk_iota_client/models/update_configuration_by_id_input.py index 1b0286a4..30df4f7c 100644 --- a/clients/python/iota_client/affinidi_tdk_iota_client/models/update_configuration_by_id_input.py +++ b/clients/python/iota_client/affinidi_tdk_iota_client/models/update_configuration_by_id_input.py @@ -27,17 +27,17 @@ class UpdateConfigurationByIdInput(BaseModel): """ UpdateConfigurationByIdInput """ - name: Optional[StrictStr] = Field(default=None, description="The name of the config") - wallet_ari: Optional[StrictStr] = Field(default=None, alias="walletAri", description="The wallet Ari that will be used to sign") - iota_response_webhook_url: Optional[StrictStr] = Field(default=None, alias="iotaResponseWebhookURL", description="webhook to call when data is ready") - enable_verification: Optional[StrictBool] = Field(default=None, alias="enableVerification") - enable_consent_audit_log: Optional[StrictBool] = Field(default=None, alias="enableConsentAuditLog") - token_max_age: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="tokenMaxAge", description="token time to live in seconds") - description: Optional[StrictStr] = Field(default=None, description="The description of the config") + name: Optional[StrictStr] = Field(default=None, description="The name of the configuration to quickly identify the resource.") + wallet_ari: Optional[StrictStr] = Field(default=None, alias="walletAri", description="The unique resource identifier of the Wallet used to sign the request token.") + iota_response_webhook_url: Optional[StrictStr] = Field(default=None, alias="iotaResponseWebhookURL", description="The webhook URL is used for callback when the data is ready.") + enable_verification: Optional[StrictBool] = Field(default=None, alias="enableVerification", description="Cryptographically verifies the data shared by the user when enabled.") + enable_consent_audit_log: Optional[StrictBool] = Field(default=None, alias="enableConsentAuditLog", description="Records the user's consent when they share their data, including the type of data shared when enabled.") + token_max_age: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="tokenMaxAge", description="This is the lifetime of the signed request token during the data-sharing flow.") + description: Optional[StrictStr] = Field(default=None, description="An optional description of what the configuration is used for.") client_metadata: Optional[IotaConfigurationDtoClientMetadata] = Field(default=None, alias="clientMetadata") - mode: Optional[StrictStr] = Field(default=None, description="indicates whether the flow is a WebSocket flow or a Redirect flow. This value is used in Vault to determine how to process the data flow request.") - redirect_uris: Optional[conlist(StrictStr)] = Field(default=None, alias="redirectUris", description="the URL that the user will be redirected to after the request has been processed; should be provided by the developer of the client application.Required only if mode is Redirect.") - enable_idv_providers: Optional[StrictBool] = Field(default=None, alias="enableIdvProviders", description="enables third party IDV provider verification for the given configuration") + mode: Optional[StrictStr] = Field(default=None, description="Determines whether to handle the data-sharing request using the WebSocket or Redirect flow.") + redirect_uris: Optional[conlist(StrictStr)] = Field(default=None, alias="redirectUris", description="List of allowed URLs to redirect users, including the response from the request. This is required if the selected data-sharing mode is Redirect.") + enable_idv_providers: Optional[StrictBool] = Field(default=None, alias="enableIdvProviders", description="Enables identity verification from user with a 3rd-party provider when a verified identity document is not found.") __properties = ["name", "walletAri", "iotaResponseWebhookURL", "enableVerification", "enableConsentAuditLog", "tokenMaxAge", "description", "clientMetadata", "mode", "redirectUris", "enableIdvProviders"] @validator('mode') diff --git a/clients/python/iota_client/affinidi_tdk_iota_client/models/update_pex_query_input.py b/clients/python/iota_client/affinidi_tdk_iota_client/models/update_pex_query_input.py index b7e3c69c..8db49583 100644 --- a/clients/python/iota_client/affinidi_tdk_iota_client/models/update_pex_query_input.py +++ b/clients/python/iota_client/affinidi_tdk_iota_client/models/update_pex_query_input.py @@ -26,8 +26,8 @@ class UpdatePexQueryInput(BaseModel): """ UpdatePexQueryInput """ - vp_definition: Optional[StrictStr] = Field(default=None, alias="vpDefinition", description="VP definition in JSON stringify format") - description: Optional[StrictStr] = None + vp_definition: Optional[StrictStr] = Field(default=None, alias="vpDefinition", description="The presentation definition describing the data requirement that must be satisfied by the user. The value is in a JSON stringify format.") + description: Optional[StrictStr] = Field(default=None, description="An optional description of what the query is used for.") __properties = ["vpDefinition", "description"] class Config: diff --git a/clients/python/iota_client/docs/AwsExchangeCredentials.md b/clients/python/iota_client/docs/AwsExchangeCredentials.md index 2d41cd09..0456fb6f 100644 --- a/clients/python/iota_client/docs/AwsExchangeCredentials.md +++ b/clients/python/iota_client/docs/AwsExchangeCredentials.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ------------- | ------- | ------------------------------------------------------------------------ | ----- | -| **assertion** | **str** | JWT signed with a machine token used to secure the web socket connection | +| Name | Type | Description | Notes | +| ------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | +| **assertion** | **str** | A valid JSON Web Token (JWT) that secures the WebSocket connection. The JWT is signed with the key pair's private key used to create the Personal Access Token (PAT). | ## Example diff --git a/clients/python/iota_client/docs/AwsExchangeCredentialsProjectToken.md b/clients/python/iota_client/docs/AwsExchangeCredentialsProjectToken.md index 11537ff6..78f8f60c 100644 --- a/clients/python/iota_client/docs/AwsExchangeCredentialsProjectToken.md +++ b/clients/python/iota_client/docs/AwsExchangeCredentialsProjectToken.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| -------------------- | ------- | ----------------------------- | ----- | -| **session_id** | **str** | sessionId generated by client | -| **configuration_id** | **str** | iotaConfiguration Id | -| **did** | **str** | Vault DID of the user | +| Name | Type | Description | Notes | +| -------------------- | ------- | ------------------------------------------------ | ----- | +| **session_id** | **str** | ID of the session generated by a client. | +| **configuration_id** | **str** | ID of the Affinidi Iota Framework configuration. | +| **did** | **str** | The Decentalised Identifier (DID) of the user. | ## Example diff --git a/clients/python/iota_client/docs/CallbackApi.md b/clients/python/iota_client/docs/CallbackApi.md index abca5a17..ce9f1ca7 100644 --- a/clients/python/iota_client/docs/CallbackApi.md +++ b/clients/python/iota_client/docs/CallbackApi.md @@ -2,17 +2,15 @@ All URIs are relative to *https://apse1.api.affinidi.io/ais* -| Method | HTTP request | Description | -| ----------------------------------------------------------------- | --------------------- | ---------------------------------------- | -| [**iot_oidc4_vp_callback**](CallbackApi.md#iot_oidc4_vp_callback) | **POST** /v1/callback | Processes the callback for OIDC4VP flows | +| Method | HTTP request | Description | +| ----------------------------------------------------------------- | --------------------- | ----------- | +| [**iot_oidc4_vp_callback**](CallbackApi.md#iot_oidc4_vp_callback) | **POST** /v1/callback | # **iot_oidc4_vp_callback** > CallbackResponseOK iot_oidc4_vp_callback(callback_input) -Processes the callback for OIDC4VP flows - -This endpoint handles callbacks from clients with data from OIDC4VP transactions, including state, presentation submission, and verification tokens. It updates the flow status based on the provided state and communicates the outcome through MQTT, ensuring the transaction's completion or notifying of any errors. +It handles the client's (e.g., Affinidi Vault) callback about the result of the data-sharing request. It may contain the data shared by the user, including the presentation submission, verification token, and state. Using the MQTT protocol, it communicates the completion of the request or if any error occurred. ### Example @@ -39,7 +37,6 @@ with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: callback_input = affinidi_tdk_iota_client.CallbackInput() # CallbackInput | CallbackRequestInput try: - # Processes the callback for OIDC4VP flows api_response = api_instance.iot_oidc4_vp_callback(callback_input) print("The response of CallbackApi->iot_oidc4_vp_callback:\n") pprint(api_response) diff --git a/clients/python/iota_client/docs/CallbackInput.md b/clients/python/iota_client/docs/CallbackInput.md index 898c5f41..847033ea 100644 --- a/clients/python/iota_client/docs/CallbackInput.md +++ b/clients/python/iota_client/docs/CallbackInput.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| --------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------ | ---------- | -| **state** | **str** | A string that must be a valid UUID (version 1-5). | -| **presentation_submission** | **str** | A string that must be a valid JSON object. The structure of presentation submission should follow OID4VP standard. | [optional] | -| **vp_token** | **str** | A string that must be a valid JSON object. Ensure to escape special characters properly.. | [optional] | -| **error** | **str** | The error should follow the OAuth2 error format (e.g. invalid_request, login_required). Defaults to access_denied | [optional] | -| **error_description** | **str** | Description of the error in a human readable format | [optional] | -| **onboarded** | **bool** | Specifies whether the Iota share triggered the creation of a Vault | [optional] | +| Name | Type | Description | Notes | +| --------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **state** | **str** | A randomly generated string that follows a valid UUID (version 1-5) format to validate the session. | +| **presentation_submission** | **str** | A JSON string format that describes the link between the Verifiable Presentation and Presentation Definition for the verifier. The presentation submission follows the OID4VP standard. | [optional] | +| **vp_token** | **str** | A JSON string format containing the data the user consented to share in a Verifiable Presentation format. The VP Token follows the OID4VP standard. | [optional] | +| **error** | **str** | A short string indicating the error code reported by the service. It follows the OAuth 2.0 error code format (e.g., invalid_request, access_denied). The default is access_denied. | [optional] | +| **error_description** | **str** | A human-readable description that provides detailed information about the error. | [optional] | +| **onboarded** | **bool** | It specifies whether the data sharing flow triggered an onboarding process to the Affinidi Vault [New User]. | [optional] | ## Example diff --git a/clients/python/iota_client/docs/CallbackResponseOK.md b/clients/python/iota_client/docs/CallbackResponseOK.md index c0bc7a1b..ed1bc492 100644 --- a/clients/python/iota_client/docs/CallbackResponseOK.md +++ b/clients/python/iota_client/docs/CallbackResponseOK.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ----------------- | ------- | ----------------------------------------------------------------- | ---------- | -| **redirect_uri** | **str** | URL to which vault will redirect | [optional] | -| **response_code** | **str** | Code which will be used along with transactionId to retrieve data | [optional] | -| **message** | **str** | A message to vault that flow is updated successfully | +| Name | Type | Description | Notes | +| ----------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **redirect_uri** | **str** | The URL to which Affinidi Vault will redirect the user. | [optional] | +| **response_code** | **str** | A unique identifier to fetch the callback response data. Send this value together with the transactionId to successfully fetch the data. | [optional] | +| **message** | **str** | A message to the Affinidi Vault indicating that the update was successful. | ## Example diff --git a/clients/python/iota_client/docs/ConfigurationsApi.md b/clients/python/iota_client/docs/ConfigurationsApi.md index 7aaa2a3d..930eb8a6 100644 --- a/clients/python/iota_client/docs/ConfigurationsApi.md +++ b/clients/python/iota_client/docs/ConfigurationsApi.md @@ -15,6 +15,8 @@ All URIs are relative to *https://apse1.api.affinidi.io/ais* > IotaConfigurationDto create_iota_configuration(create_iota_configuration_input) +Creates a new Affinidi Iota Framework configuration. + ### Example - Api Key Authentication (ProjectTokenAuth): @@ -109,6 +111,8 @@ with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: > delete_iota_configuration_by_id(configuration_id) +Deletes an Affinidi Iota Framework configuration by ID. + ### Example - Api Key Authentication (ProjectTokenAuth): @@ -156,7 +160,7 @@ configuration.refresh_api_key_hook = lambda api_client: authProvider.fetch_proje with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = affinidi_tdk_iota_client.ConfigurationsApi(api_client) - configuration_id = 'configuration_id_example' # str | iotaConfiguration Id + configuration_id = 'configuration_id_example' # str | ID of the Affinidi Iota Framework configuration. try: api_instance.delete_iota_configuration_by_id(configuration_id) @@ -166,9 +170,9 @@ with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: ### Parameters -| Name | Type | Description | Notes | -| -------------------- | ------- | -------------------- | ----- | -| **configuration_id** | **str** | iotaConfiguration Id | +| Name | Type | Description | Notes | +| -------------------- | ------- | ------------------------------------------------ | ----- | +| **configuration_id** | **str** | ID of the Affinidi Iota Framework configuration. | ### Return type @@ -197,6 +201,8 @@ void (empty response body) > IotaConfigurationDto get_iota_configuration_by_id(configuration_id) +Retrieves the details of an Affinidi Iota Framework configuration. + ### Example - Api Key Authentication (ProjectTokenAuth): @@ -245,7 +251,7 @@ configuration.refresh_api_key_hook = lambda api_client: authProvider.fetch_proje with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = affinidi_tdk_iota_client.ConfigurationsApi(api_client) - configuration_id = 'configuration_id_example' # str | iotaConfiguration Id + configuration_id = 'configuration_id_example' # str | ID of the Affinidi Iota Framework configuration. try: api_response = api_instance.get_iota_configuration_by_id(configuration_id) @@ -257,9 +263,9 @@ with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: ### Parameters -| Name | Type | Description | Notes | -| -------------------- | ------- | -------------------- | ----- | -| **configuration_id** | **str** | iotaConfiguration Id | +| Name | Type | Description | Notes | +| -------------------- | ------- | ------------------------------------------------ | ----- | +| **configuration_id** | **str** | ID of the Affinidi Iota Framework configuration. | ### Return type @@ -289,6 +295,8 @@ with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: > GetIotaConfigurationMetaDataOK get_iota_configuration_meta_data(project_id, configuration_id) +Retrieves the client metadata of an Affinidi Iota Framework configuration. + ### Example ```python @@ -310,8 +318,8 @@ configuration = affinidi_tdk_iota_client.Configuration( with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = affinidi_tdk_iota_client.ConfigurationsApi(api_client) - project_id = 'project_id_example' # str | project Id - configuration_id = 'configuration_id_example' # str | iotaConfiguration Id + project_id = 'project_id_example' # str | The ID of the project. + configuration_id = 'configuration_id_example' # str | ID of the Affinidi Iota Framework configuration. try: api_response = api_instance.get_iota_configuration_meta_data(project_id, configuration_id) @@ -323,10 +331,10 @@ with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: ### Parameters -| Name | Type | Description | Notes | -| -------------------- | ------- | -------------------- | ----- | -| **project_id** | **str** | project Id | -| **configuration_id** | **str** | iotaConfiguration Id | +| Name | Type | Description | Notes | +| -------------------- | ------- | ------------------------------------------------ | ----- | +| **project_id** | **str** | The ID of the project. | +| **configuration_id** | **str** | ID of the Affinidi Iota Framework configuration. | ### Return type @@ -355,6 +363,8 @@ No authorization required > ListConfigurationOK list_iota_configurations() +List all Affinidi Iota Framework configurations. + ### Example - Api Key Authentication (ProjectTokenAuth): @@ -443,6 +453,8 @@ This endpoint does not need any parameter. > IotaConfigurationDto update_iota_configuration_by_id(configuration_id, update_configuration_by_id_input) +Updates the details of an Affinidi Iota Framework configuration by ID. + ### Example - Api Key Authentication (ProjectTokenAuth): @@ -492,7 +504,7 @@ configuration.refresh_api_key_hook = lambda api_client: authProvider.fetch_proje with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = affinidi_tdk_iota_client.ConfigurationsApi(api_client) - configuration_id = 'configuration_id_example' # str | iotaConfiguration Id + configuration_id = 'configuration_id_example' # str | ID of the Affinidi Iota Framework configuration. update_configuration_by_id_input = affinidi_tdk_iota_client.UpdateConfigurationByIdInput() # UpdateConfigurationByIdInput | UpdateConfigurationById try: @@ -505,10 +517,10 @@ with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: ### Parameters -| Name | Type | Description | Notes | -| ------------------------------------ | ------------------------------------------------------------------- | ----------------------- | ----- | -| **configuration_id** | **str** | iotaConfiguration Id | -| **update_configuration_by_id_input** | [**UpdateConfigurationByIdInput**](UpdateConfigurationByIdInput.md) | UpdateConfigurationById | +| Name | Type | Description | Notes | +| ------------------------------------ | ------------------------------------------------------------------- | ------------------------------------------------ | ----- | +| **configuration_id** | **str** | ID of the Affinidi Iota Framework configuration. | +| **update_configuration_by_id_input** | [**UpdateConfigurationByIdInput**](UpdateConfigurationByIdInput.md) | UpdateConfigurationById | ### Return type diff --git a/clients/python/iota_client/docs/ConsentDto.md b/clients/python/iota_client/docs/ConsentDto.md index 5e10e749..ec6cb8be 100644 --- a/clients/python/iota_client/docs/ConsentDto.md +++ b/clients/python/iota_client/docs/ConsentDto.md @@ -2,17 +2,17 @@ ## Properties -| Name | Type | Description | Notes | -| --------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | -| **project_id** | **str** | | -| **id** | **str** | id of the record | -| **user_id** | **str** | unique identifier of the user | -| **vc_type** | **str** | VC type of shared vc. If the actual VC has several VC types (excluding base types as VerifiableCredential) then for each of the a separate record will be added | -| **status** | **str** | | -| **modified_at** | **str** | | -| **modified_by** | **str** | | -| **created_at** | **str** | | -| **created_by** | **str** | | +| Name | Type | Description | Notes | +| --------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------- | ----- | +| **project_id** | **str** | The ID of the project. | +| **id** | **str** | Unique identifier for the record. | +| **user_id** | **str** | Unique identifier for the user. | +| **vc_type** | **str** | Type of the VC shared by the user. It creates a consent record for each VC type shared except for the base type VerifiableCredential. | +| **status** | **str** | Status of the consent. | +| **modified_at** | **str** | | +| **modified_by** | **str** | | +| **created_at** | **str** | | +| **created_by** | **str** | | ## Example diff --git a/clients/python/iota_client/docs/CreateIotaConfigurationInput.md b/clients/python/iota_client/docs/CreateIotaConfigurationInput.md index 157fadfd..5f6b1fef 100644 --- a/clients/python/iota_client/docs/CreateIotaConfigurationInput.md +++ b/clients/python/iota_client/docs/CreateIotaConfigurationInput.md @@ -2,19 +2,19 @@ ## Properties -| Name | Type | Description | Notes | -| ----------------------------- | ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | -| **name** | **str** | The name of the configuration | -| **description** | **str** | Description of the configuration | [optional] | -| **wallet_ari** | **str** | The wallet Ari that will be used to sign | -| **iota_response_webhook_url** | **str** | webhook to call when data is ready | [optional] | -| **enable_verification** | **bool** | | -| **enable_consent_audit_log** | **bool** | | -| **token_max_age** | **float** | token time to live in seconds | [optional] | -| **client_metadata** | [**IotaConfigurationDtoClientMetadata**](IotaConfigurationDtoClientMetadata.md) | | -| **mode** | **str** | indicates whether the flow is a WebSocket flow or a Redirect flow. This value is used in Vault to determine how to process the data flow request. | [optional] [default to 'websocket'] | -| **redirect_uris** | **List[str]** | the URL that the user will be redirected to after the request has been processed; should be provided by the developer of the client application.Required only if mode is Redirect. | [optional] | -| **enable_idv_providers** | **bool** | enables third party IDV provider verification for the given configuration | [optional] | +| Name | Type | Description | Notes | +| ----------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------- | +| **name** | **str** | The name of the configuration to quickly identify the resource. | +| **description** | **str** | An optional description of what the configuration is used for. | [optional] | +| **wallet_ari** | **str** | The unique resource identifier of the Wallet used to sign the request token. | +| **iota_response_webhook_url** | **str** | The webhook URL is used for callback when the data is ready. | [optional] | +| **enable_verification** | **bool** | Cryptographically verifies the data shared by the user when enabled. | +| **enable_consent_audit_log** | **bool** | Records the user's consent when they share their data, including the type of data shared when enabled. | +| **token_max_age** | **float** | This is the lifetime of the signed request token during the data-sharing flow. | [optional] | +| **client_metadata** | [**IotaConfigurationDtoClientMetadata**](IotaConfigurationDtoClientMetadata.md) | | +| **mode** | **str** | Determines whether to handle the data-sharing request using the WebSocket or Redirect flow. | [optional] [default to 'websocket'] | +| **redirect_uris** | **List[str]** | List of allowed URLs to redirect users, including the response from the request. This is required if the selected data-sharing mode is Redirect. | [optional] | +| **enable_idv_providers** | **bool** | Enables identity verification from user with a 3rd-party provider when a verified identity document is not found. | [optional] | ## Example diff --git a/clients/python/iota_client/docs/CreatePexQueryInput.md b/clients/python/iota_client/docs/CreatePexQueryInput.md index f432ad11..3cd4db41 100644 --- a/clients/python/iota_client/docs/CreatePexQueryInput.md +++ b/clients/python/iota_client/docs/CreatePexQueryInput.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ----------------- | ------- | -------------------------------------- | ---------- | -| **name** | **str** | | -| **vp_definition** | **str** | VP definition in JSON stringify format | -| **description** | **str** | Description of query | [optional] | +| Name | Type | Description | Notes | +| ----------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **name** | **str** | The name of the presentation definition to quickly identify the query. | +| **vp_definition** | **str** | The presentation definition describing the data requirement that must be satisfied by the user. The value is in a JSON stringify format. | +| **description** | **str** | An optional description of what the query is used for. | [optional] | ## Example diff --git a/clients/python/iota_client/docs/DefaultApi.md b/clients/python/iota_client/docs/DefaultApi.md index 5354bd20..9cd1a62a 100644 --- a/clients/python/iota_client/docs/DefaultApi.md +++ b/clients/python/iota_client/docs/DefaultApi.md @@ -10,7 +10,7 @@ All URIs are relative to *https://apse1.api.affinidi.io/ais* > ListLoggedConsentsOK list_logged_consents(configuration_id=configuration_id, user_id=user_id, limit=limit, exclusive_start_key=exclusive_start_key) -returns a list of logged consents for the project +Lists all the logged consents for a project. ### Example @@ -62,7 +62,7 @@ with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: api_instance = affinidi_tdk_iota_client.DefaultApi(api_client) configuration_id = 'configuration_id_example' # str | (optional) user_id = 'user_id_example' # str | (optional) - limit = 56 # int | Maximum number of records to fetch in a list (optional) + limit = 56 # int | The maximum number of records to fetch from the list of logged consents. (optional) exclusive_start_key = 'exclusive_start_key_example' # str | The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation. (optional) try: @@ -79,7 +79,7 @@ with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: | ----------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | | **configuration_id** | **str** | | [optional] | | **user_id** | **str** | | [optional] | -| **limit** | **int** | Maximum number of records to fetch in a list | [optional] | +| **limit** | **int** | The maximum number of records to fetch from the list of logged consents. | [optional] | | **exclusive_start_key** | **str** | The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation. | [optional] | ### Return type diff --git a/clients/python/iota_client/docs/FetchIOTAVPResponseInput.md b/clients/python/iota_client/docs/FetchIOTAVPResponseInput.md index 66668db6..c871c7ac 100644 --- a/clients/python/iota_client/docs/FetchIOTAVPResponseInput.md +++ b/clients/python/iota_client/docs/FetchIOTAVPResponseInput.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| -------------------- | ------- | -------------------- | ----- | -| **correlation_id** | **str** | The correlation ID | -| **transaction_id** | **str** | The transaction ID | -| **response_code** | **str** | The response code. | -| **configuration_id** | **str** | The configuration ID | +| Name | Type | Description | Notes | +| -------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | +| **correlation_id** | **str** | A unique, randomly generated identifier that correlates the request and response in the data-sharing request flow. | +| **transaction_id** | **str** | A unique, randomly generated identifier data-sharing request flow is initiated. This value is used with the response code to fetch the callback response data. | +| **response_code** | **str** | A unique identifier to fetch the callback response data. Send this value together with the transactionId to successfully fetch the data. | +| **configuration_id** | **str** | ID of the Affinidi Iota Framework configuration. | ## Example diff --git a/clients/python/iota_client/docs/FetchIOTAVPResponseOK.md b/clients/python/iota_client/docs/FetchIOTAVPResponseOK.md index a61544c1..02eadc3e 100644 --- a/clients/python/iota_client/docs/FetchIOTAVPResponseOK.md +++ b/clients/python/iota_client/docs/FetchIOTAVPResponseOK.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| --------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------ | ---------- | -| **correlation_id** | **str** | A correlationId used for the flow | [optional] | -| **presentation_submission** | **str** | A string that must be a valid JSON object. The structure of presentation submission should follow OID4VP standard. | [optional] | -| **vp_token** | **str** | A string that must be a valid JSON object. Ensure to escape special characters properly.. | [optional] | +| Name | Type | Description | Notes | +| --------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **correlation_id** | **str** | A unique, randomly generated identifier that correlates the request and response in the data-sharing request flow. | [optional] | +| **presentation_submission** | **str** | A JSON string format that describes the link between the Verifiable Presentation and Presentation Definition for the verifier. The presentation submission follows the OID4VP standard. | [optional] | +| **vp_token** | **str** | A JSON string format containing the data the user consented to share in a Verifiable Presentation format. The VP Token follows the OID4VP standard. | [optional] | ## Example diff --git a/clients/python/iota_client/docs/GetIotaConfigurationMetaDataOK.md b/clients/python/iota_client/docs/GetIotaConfigurationMetaDataOK.md index 6b543ad0..08762fb2 100644 --- a/clients/python/iota_client/docs/GetIotaConfigurationMetaDataOK.md +++ b/clients/python/iota_client/docs/GetIotaConfigurationMetaDataOK.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---------- | ------- | ------------------------------------------------------- | ----- | -| **name** | **str** | application name that will be displayed in consent page | -| **origin** | **str** | origin url that will be displayed in consent page | -| **logo** | **str** | logo url that will be displayed in consent page | +| Name | Type | Description | Notes | +| ---------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | ----- | +| **name** | **str** | The name displayed on the consent page indicates who is requesting data from the user. It can be the application or website's name. | +| **origin** | **str** | The URL of the requester displayed on the consent page indicates the request's origin. | +| **logo** | **str** | The logo of the requester displayed on the consent page, allowing users to easily recognise who requests the data. | ## Example diff --git a/clients/python/iota_client/docs/InitiateDataSharingRequestInput.md b/clients/python/iota_client/docs/InitiateDataSharingRequestInput.md index 3a6596f5..67d95577 100644 --- a/clients/python/iota_client/docs/InitiateDataSharingRequestInput.md +++ b/clients/python/iota_client/docs/InitiateDataSharingRequestInput.md @@ -2,15 +2,15 @@ ## Properties -| Name | Type | Description | Notes | -| -------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | -| **query_id** | **str** | | -| **correlation_id** | **str** | | -| **token_max_age** | **float** | token time to live in seconds | [optional] | -| **nonce** | **str** | Random value used to prevent replay attacks | -| **redirect_uri** | **str** | the URL that the user will be redirected to after the request has been processed; should be provided by the developer of the client application. | -| **configuration_id** | **str** | id of the IOTA configuration used | -| **mode** | **str** | indicates whether the flow is a WebSocket flow or a Redirect flow. This value is used in Vault to determine how to process the data flow request. | +| Name | Type | Description | Notes | +| -------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ---------- | +| **query_id** | **str** | The ID of the query. | +| **correlation_id** | **str** | A unique, randomly generated identifier that correlates the request and response in the data-sharing request flow. | +| **token_max_age** | **float** | This is the lifetime of the signed request token during the data-sharing flow. | [optional] | +| **nonce** | **str** | A randomly generated value that is added in the request and response to prevent replay attacks. | +| **redirect_uri** | **str** | List of allowed URLs to redirect users, including the response from the request. This is required if the selected data-sharing mode is Redirect. | +| **configuration_id** | **str** | ID of the Affinidi Iota Framework configuration. | +| **mode** | **str** | Determines whether to handle the data-sharing request using the WebSocket or Redirect flow. | ## Example diff --git a/clients/python/iota_client/docs/IotaApi.md b/clients/python/iota_client/docs/IotaApi.md index 6c50d9ca..fc8a30f3 100644 --- a/clients/python/iota_client/docs/IotaApi.md +++ b/clients/python/iota_client/docs/IotaApi.md @@ -14,7 +14,7 @@ All URIs are relative to *https://apse1.api.affinidi.io/ais* > AwsExchangeCredentialsOK aws_exchange_credentials(aws_exchange_credentials) -It exchanges limited token into cognito +Exchange a limited-scoped token into a Cognito credential to generate the identity credential. The identity credential initiates the secure WebSocket connection from the client. This method is used only in WebSocket data-sharing mode. ### Example @@ -81,7 +81,7 @@ No authorization required > IotaExchangeCredentialsOK aws_exchange_credentials_project_token(aws_exchange_credentials_project_token) -It exchanges project token into cognito +Exchange a Project Scoped Token into an identity credential directly to initiate a secure WebSocket connection. This method is used only in WebSocket data-sharing mode. ### Example @@ -175,7 +175,7 @@ with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: > FetchIOTAVPResponseOK fetch_iota_vp_response(fetch_iotavp_response_input) -This will get the final data response +Fetches the client's callback that contains the user's shared data in a Verifiable Presentation format after a successful data-sharing flow. ### Example @@ -262,6 +262,7 @@ with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: | **200** | FetchIOTAVPResponseOK | _ Access-Control-Allow-Origin -
_ Access-Control-Allow-Methods -
\* Access-Control-Allow-Headers -
| | **400** | BadRequestError | _ Access-Control-Allow-Origin -
_ Access-Control-Allow-Methods -
\* Access-Control-Allow-Headers -
| | **403** | ForbiddenError | _ Access-Control-Allow-Origin -
_ Access-Control-Allow-Methods -
\* Access-Control-Allow-Headers -
| +| **404** | NotFoundError | _ Access-Control-Allow-Origin -
_ Access-Control-Allow-Methods -
\* Access-Control-Allow-Headers -
| [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -269,7 +270,7 @@ with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: > InitiateDataSharingRequestOK initiate_data_sharing_request(initiate_data_sharing_request_input) -This will initiate data sharing request for the data sharing flow +Generates the request token for the Redirect mode to initiate the data-sharing flow. ### Example @@ -363,7 +364,7 @@ with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: > IotaExchangeCredentialsOK iota_exchange_credentials(iota_exchange_credentials) -It exchanges limited token into cognito sts identity credentials +Exchange a limited-scoped token into an identity credential directly to initiate a secure WebSocket connection. This method is used only in WebSocket data-sharing mode. ### Example diff --git a/clients/python/iota_client/docs/IotaConfigurationDto.md b/clients/python/iota_client/docs/IotaConfigurationDto.md index 8f5b1957..f21d475a 100644 --- a/clients/python/iota_client/docs/IotaConfigurationDto.md +++ b/clients/python/iota_client/docs/IotaConfigurationDto.md @@ -2,21 +2,21 @@ ## Properties -| Name | Type | Description | Notes | -| ----------------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | -| **ari** | **str** | The ARI of the config | -| **configuration_id** | **str** | | -| **name** | **str** | The name of the config | -| **project_id** | **str** | | -| **wallet_ari** | **str** | The wallet Ari that will be used to sign | -| **token_max_age** | **float** | token time to live in seconds | -| **iota_response_webhook_url** | **str** | webhook to call when data is ready | [optional] | -| **enable_verification** | **bool** | | -| **enable_consent_audit_log** | **bool** | | -| **client_metadata** | [**IotaConfigurationDtoClientMetadata**](IotaConfigurationDtoClientMetadata.md) | | -| **mode** | **str** | indicates whether the flow is a WebSocket flow or a Redirect flow. This value is used in Vault to determine how to process the data flow request. | [optional] [default to 'websocket'] | -| **redirect_uris** | **List[str]** | the URLs that the user will be redirected to after the request has been processed; should be provided by the developer of the client application.Required only if mode is Redirect. | [optional] | -| **enable_idv_providers** | **bool** | enables third party IDV provider verification for the given configuration | [optional] | +| Name | Type | Description | Notes | +| ----------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------- | +| **ari** | **str** | This is a unique resource identifier of the Affinidi Iota Framework configuration. | +| **configuration_id** | **str** | ID of the Affinidi Iota Framework configuration. | +| **name** | **str** | The name of the configuration to quickly identify the resource. | +| **project_id** | **str** | The ID of the project. | +| **wallet_ari** | **str** | The unique resource identifier of the Wallet used to sign the request token. | +| **token_max_age** | **float** | This is the lifetime of the signed request token during the data-sharing flow. | +| **iota_response_webhook_url** | **str** | The webhook URL is used for callback when the data is ready. | [optional] | +| **enable_verification** | **bool** | Cryptographically verifies the data shared by the user when enabled. | +| **enable_consent_audit_log** | **bool** | Records the consent the user gave when they shared their data, including the type of data shared. | +| **client_metadata** | [**IotaConfigurationDtoClientMetadata**](IotaConfigurationDtoClientMetadata.md) | | +| **mode** | **str** | Determines whether to handle the data-sharing request using the WebSocket or Redirect flow. | [optional] [default to 'websocket'] | +| **redirect_uris** | **List[str]** | List of allowed URLs to redirect users, including the response from the request. This is required if the selected data-sharing mode is Redirect. | [optional] | +| **enable_idv_providers** | **bool** | Enables identity verification from user with a 3rd-party provider when a verified identity document is not found. | [optional] | ## Example diff --git a/clients/python/iota_client/docs/IotaConfigurationDtoClientMetadata.md b/clients/python/iota_client/docs/IotaConfigurationDtoClientMetadata.md index 21f73fc8..949d4753 100644 --- a/clients/python/iota_client/docs/IotaConfigurationDtoClientMetadata.md +++ b/clients/python/iota_client/docs/IotaConfigurationDtoClientMetadata.md @@ -1,14 +1,14 @@ # IotaConfigurationDtoClientMetadata -iota configuration client metadata +It contains information about the requester or verifier. ## Properties -| Name | Type | Description | Notes | -| ---------- | ------- | ------------------------------------------------------- | ----- | -| **name** | **str** | application name that will be displayed in consent page | -| **origin** | **str** | origin url that will be displayed in consent page | -| **logo** | **str** | logo url that will be displayed in consent page | +| Name | Type | Description | Notes | +| ---------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | ----- | +| **name** | **str** | The name displayed on the consent page indicates who is requesting data from the user. It can be the application or website's name. | +| **origin** | **str** | The URL of the requester displayed on the consent page indicates the request's origin. | +| **logo** | **str** | The logo of the requester displayed on the consent page, allowing users to easily recognise who requests the data. | ## Example diff --git a/clients/python/iota_client/docs/IotaExchangeCredentials.md b/clients/python/iota_client/docs/IotaExchangeCredentials.md index f9b3a41d..a90e5bf4 100644 --- a/clients/python/iota_client/docs/IotaExchangeCredentials.md +++ b/clients/python/iota_client/docs/IotaExchangeCredentials.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ------------- | ------- | ------------------------------------------------------------------------ | ----- | -| **assertion** | **str** | JWT signed with a machine token used to secure the web socket connection | +| Name | Type | Description | Notes | +| ------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | +| **assertion** | **str** | A valid JSON Web Token (JWT) that secures the WebSocket connection. The JWT is signed with the key pair's private key used to create the Personal Access Token (PAT). | ## Example diff --git a/clients/python/iota_client/docs/PexQueryApi.md b/clients/python/iota_client/docs/PexQueryApi.md index b2b6062a..2fa7c046 100644 --- a/clients/python/iota_client/docs/PexQueryApi.md +++ b/clients/python/iota_client/docs/PexQueryApi.md @@ -2,10 +2,10 @@ All URIs are relative to *https://apse1.api.affinidi.io/ais* -| Method | HTTP request | Description | -| ------------------------------------------------------------------- | --------------------------------------------------------------------- | ------------------- | +| Method | HTTP request | Description | +| ------------------------------------------------------------------- | --------------------------------------------------------------------- | ----------- | | [**create_pex_query**](PexQueryApi.md#create_pex_query) | **POST** /v1/configurations/{configurationId}/pex-queries | -| [**delete_pex_queries**](PexQueryApi.md#delete_pex_queries) | **POST** /v1/configurations/{configurationId}/delete-queries | deletes pex queries | +| [**delete_pex_queries**](PexQueryApi.md#delete_pex_queries) | **POST** /v1/configurations/{configurationId}/delete-queries | | [**delete_pex_query_by_id**](PexQueryApi.md#delete_pex_query_by_id) | **DELETE** /v1/configurations/{configurationId}/pex-queries/{queryId} | | [**get_pex_query_by_id**](PexQueryApi.md#get_pex_query_by_id) | **GET** /v1/configurations/{configurationId}/pex-queries/{queryId} | | [**list_pex_queries**](PexQueryApi.md#list_pex_queries) | **GET** /v1/configurations/{configurationId}/pex-queries | @@ -16,6 +16,8 @@ All URIs are relative to *https://apse1.api.affinidi.io/ais* > PexQueryDto create_pex_query(configuration_id, create_pex_query_input) +Creates a new Presentation Definition in the configuration to query data. + ### Example - Api Key Authentication (ProjectTokenAuth): @@ -65,7 +67,7 @@ configuration.refresh_api_key_hook = lambda api_client: authProvider.fetch_proje with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = affinidi_tdk_iota_client.PexQueryApi(api_client) - configuration_id = 'configuration_id_example' # str | iotaConfiguration Id + configuration_id = 'configuration_id_example' # str | ID of the Affinidi Iota Framework configuration. create_pex_query_input = affinidi_tdk_iota_client.CreatePexQueryInput() # CreatePexQueryInput | CreatePexQuery try: @@ -78,10 +80,10 @@ with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: ### Parameters -| Name | Type | Description | Notes | -| -------------------------- | ------------------------------------------------- | -------------------- | ----- | -| **configuration_id** | **str** | iotaConfiguration Id | -| **create_pex_query_input** | [**CreatePexQueryInput**](CreatePexQueryInput.md) | CreatePexQuery | +| Name | Type | Description | Notes | +| -------------------------- | ------------------------------------------------- | ------------------------------------------------ | ----- | +| **configuration_id** | **str** | ID of the Affinidi Iota Framework configuration. | +| **create_pex_query_input** | [**CreatePexQueryInput**](CreatePexQueryInput.md) | CreatePexQuery | ### Return type @@ -113,9 +115,7 @@ with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: > delete_pex_queries(configuration_id) -deletes pex queries - -deletes pex queries +Deletes all Presentation Definition queries of a configuration. ### Example @@ -164,10 +164,9 @@ configuration.refresh_api_key_hook = lambda api_client: authProvider.fetch_proje with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = affinidi_tdk_iota_client.PexQueryApi(api_client) - configuration_id = 'configuration_id_example' # str | iotaConfiguration Id + configuration_id = 'configuration_id_example' # str | ID of the Affinidi Iota Framework configuration. try: - # deletes pex queries api_instance.delete_pex_queries(configuration_id) except Exception as e: print("Exception when calling PexQueryApi->delete_pex_queries: %s\n" % e) @@ -175,9 +174,9 @@ with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: ### Parameters -| Name | Type | Description | Notes | -| -------------------- | ------- | -------------------- | ----- | -| **configuration_id** | **str** | iotaConfiguration Id | +| Name | Type | Description | Notes | +| -------------------- | ------- | ------------------------------------------------ | ----- | +| **configuration_id** | **str** | ID of the Affinidi Iota Framework configuration. | ### Return type @@ -206,6 +205,8 @@ void (empty response body) > delete_pex_query_by_id(configuration_id, query_id) +Deletes a Presentation Definition in the configuration by ID. + ### Example - Api Key Authentication (ProjectTokenAuth): @@ -253,8 +254,8 @@ configuration.refresh_api_key_hook = lambda api_client: authProvider.fetch_proje with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = affinidi_tdk_iota_client.PexQueryApi(api_client) - configuration_id = 'configuration_id_example' # str | iotaConfiguration Id - query_id = 'query_id_example' # str | pex-query Id + configuration_id = 'configuration_id_example' # str | ID of the Affinidi Iota Framework configuration. + query_id = 'query_id_example' # str | The ID of the query. try: api_instance.delete_pex_query_by_id(configuration_id, query_id) @@ -264,10 +265,10 @@ with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: ### Parameters -| Name | Type | Description | Notes | -| -------------------- | ------- | -------------------- | ----- | -| **configuration_id** | **str** | iotaConfiguration Id | -| **query_id** | **str** | pex-query Id | +| Name | Type | Description | Notes | +| -------------------- | ------- | ------------------------------------------------ | ----- | +| **configuration_id** | **str** | ID of the Affinidi Iota Framework configuration. | +| **query_id** | **str** | The ID of the query. | ### Return type @@ -297,6 +298,8 @@ void (empty response body) > PexQueryDto get_pex_query_by_id(configuration_id, query_id) +Retrieves a Presentation Definition in the configuration by ID. + ### Example - Api Key Authentication (ProjectTokenAuth): @@ -345,8 +348,8 @@ configuration.refresh_api_key_hook = lambda api_client: authProvider.fetch_proje with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = affinidi_tdk_iota_client.PexQueryApi(api_client) - configuration_id = 'configuration_id_example' # str | iotaConfiguration Id - query_id = 'query_id_example' # str | pex-query Id + configuration_id = 'configuration_id_example' # str | ID of the Affinidi Iota Framework configuration. + query_id = 'query_id_example' # str | The ID of the query. try: api_response = api_instance.get_pex_query_by_id(configuration_id, query_id) @@ -358,10 +361,10 @@ with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: ### Parameters -| Name | Type | Description | Notes | -| -------------------- | ------- | -------------------- | ----- | -| **configuration_id** | **str** | iotaConfiguration Id | -| **query_id** | **str** | pex-query Id | +| Name | Type | Description | Notes | +| -------------------- | ------- | ------------------------------------------------ | ----- | +| **configuration_id** | **str** | ID of the Affinidi Iota Framework configuration. | +| **query_id** | **str** | The ID of the query. | ### Return type @@ -391,6 +394,8 @@ with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: > ListPexQueriesOK list_pex_queries(configuration_id, limit=limit, exclusive_start_key=exclusive_start_key) +Lists all Presentation Definitions in the configuration. + ### Example - Api Key Authentication (ProjectTokenAuth): @@ -439,7 +444,7 @@ configuration.refresh_api_key_hook = lambda api_client: authProvider.fetch_proje with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = affinidi_tdk_iota_client.PexQueryApi(api_client) - configuration_id = 'configuration_id_example' # str | iotaConfiguration Id + configuration_id = 'configuration_id_example' # str | ID of the Affinidi Iota Framework configuration. limit = 56 # int | Maximum number of records to fetch in a list (optional) exclusive_start_key = 'exclusive_start_key_example' # str | The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation. (optional) @@ -455,7 +460,7 @@ with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: | Name | Type | Description | Notes | | ----------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | -| **configuration_id** | **str** | iotaConfiguration Id | +| **configuration_id** | **str** | ID of the Affinidi Iota Framework configuration. | | **limit** | **int** | Maximum number of records to fetch in a list | [optional] | | **exclusive_start_key** | **str** | The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation. | [optional] | @@ -487,7 +492,7 @@ with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: > object save_pex_queries(configuration_id, save_pex_queries_update_input) -saves all pex queries +Saves all Presentation Definition queries of a configuration. ### Example @@ -537,7 +542,7 @@ configuration.refresh_api_key_hook = lambda api_client: authProvider.fetch_proje with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = affinidi_tdk_iota_client.PexQueryApi(api_client) - configuration_id = 'configuration_id_example' # str | iotaConfiguration Id + configuration_id = 'configuration_id_example' # str | ID of the Affinidi Iota Framework configuration. save_pex_queries_update_input = affinidi_tdk_iota_client.SavePexQueriesUpdateInput() # SavePexQueriesUpdateInput | SavePexQueriesInput try: @@ -550,10 +555,10 @@ with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: ### Parameters -| Name | Type | Description | Notes | -| --------------------------------- | ------------------------------------------------------------- | -------------------- | ----- | -| **configuration_id** | **str** | iotaConfiguration Id | -| **save_pex_queries_update_input** | [**SavePexQueriesUpdateInput**](SavePexQueriesUpdateInput.md) | SavePexQueriesInput | +| Name | Type | Description | Notes | +| --------------------------------- | ------------------------------------------------------------- | ------------------------------------------------ | ----- | +| **configuration_id** | **str** | ID of the Affinidi Iota Framework configuration. | +| **save_pex_queries_update_input** | [**SavePexQueriesUpdateInput**](SavePexQueriesUpdateInput.md) | SavePexQueriesInput | ### Return type @@ -582,6 +587,8 @@ with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: > PexQueryDto update_pex_query_by_id(configuration_id, query_id, update_pex_query_input) +Updates the Presentation Definition in the configuration by ID. + ### Example - Api Key Authentication (ProjectTokenAuth): @@ -631,8 +638,8 @@ configuration.refresh_api_key_hook = lambda api_client: authProvider.fetch_proje with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = affinidi_tdk_iota_client.PexQueryApi(api_client) - configuration_id = 'configuration_id_example' # str | iotaConfiguration Id - query_id = 'query_id_example' # str | pex-query Id + configuration_id = 'configuration_id_example' # str | ID of the Affinidi Iota Framework configuration. + query_id = 'query_id_example' # str | The ID of the query. update_pex_query_input = affinidi_tdk_iota_client.UpdatePexQueryInput() # UpdatePexQueryInput | UpdatePexQueryById try: @@ -645,11 +652,11 @@ with affinidi_tdk_iota_client.ApiClient(configuration) as api_client: ### Parameters -| Name | Type | Description | Notes | -| -------------------------- | ------------------------------------------------- | -------------------- | ----- | -| **configuration_id** | **str** | iotaConfiguration Id | -| **query_id** | **str** | pex-query Id | -| **update_pex_query_input** | [**UpdatePexQueryInput**](UpdatePexQueryInput.md) | UpdatePexQueryById | +| Name | Type | Description | Notes | +| -------------------------- | ------------------------------------------------- | ------------------------------------------------ | ----- | +| **configuration_id** | **str** | ID of the Affinidi Iota Framework configuration. | +| **query_id** | **str** | The ID of the query. | +| **update_pex_query_input** | [**UpdatePexQueryInput**](UpdatePexQueryInput.md) | UpdatePexQueryById | ### Return type diff --git a/clients/python/iota_client/docs/PexQueryDto.md b/clients/python/iota_client/docs/PexQueryDto.md index 2182c24a..6214dc2d 100644 --- a/clients/python/iota_client/docs/PexQueryDto.md +++ b/clients/python/iota_client/docs/PexQueryDto.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| --------------------- | ------- | -------------------------------------- | ----- | -| **ari** | **str** | | -| **query_id** | **str** | | -| **name** | **str** | | -| **description** | **str** | | -| **configuration_ari** | **str** | | -| **vp_definition** | **str** | VP definition in JSON stringify format | +| Name | Type | Description | Notes | +| --------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ----- | +| **ari** | **str** | The unique resource identifier of the qeuery. | +| **query_id** | **str** | The ID of the query. | +| **name** | **str** | The name of the presentation definition to quickly identify the query. | +| **description** | **str** | An optional description of what the query is used for. | +| **configuration_ari** | **str** | The unique resource identifier of the related configuration where the query is defined. | +| **vp_definition** | **str** | The presentation definition describing the data requirement that must be satisfied by the user. The value is in a JSON stringify format. | ## Example diff --git a/clients/python/iota_client/docs/PrepareRequest.md b/clients/python/iota_client/docs/PrepareRequest.md index 08245f18..7fd0db30 100644 --- a/clients/python/iota_client/docs/PrepareRequest.md +++ b/clients/python/iota_client/docs/PrepareRequest.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ------------------------ | --------- | ----------------------------- | ---------- | -| **connection_client_id** | **str** | | -| **query_id** | **str** | | -| **correlation_id** | **str** | | -| **token_max_age** | **float** | token time to live in seconds | [optional] | -| **audience** | **str** | | [optional] | +| Name | Type | Description | Notes | +| ------------------------ | --------- | ------------------------------------------------------------------------------------------------------------------ | ---------- | +| **connection_client_id** | **str** | | +| **query_id** | **str** | | +| **correlation_id** | **str** | A unique, randomly generated identifier that correlates the request and response in the data-sharing request flow. | +| **token_max_age** | **float** | This is the lifetime of the signed request token during the data-sharing flow. | [optional] | +| **audience** | **str** | | [optional] | ## Example diff --git a/clients/python/iota_client/docs/PrepareRequestCreatedData.md b/clients/python/iota_client/docs/PrepareRequestCreatedData.md index 65edcc8c..047323cc 100644 --- a/clients/python/iota_client/docs/PrepareRequestCreatedData.md +++ b/clients/python/iota_client/docs/PrepareRequestCreatedData.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ------------------ | ------- | ----------- | ----- | -| **jwt** | **str** | | -| **correlation_id** | **str** | | +| Name | Type | Description | Notes | +| ------------------ | ------- | ------------------------------------------------------------------------------------------------------------------ | ----- | +| **jwt** | **str** | | +| **correlation_id** | **str** | A unique, randomly generated identifier that correlates the request and response in the data-sharing request flow. | ## Example diff --git a/clients/python/iota_client/docs/SavePexQueriesUpdateInputQueriesInner.md b/clients/python/iota_client/docs/SavePexQueriesUpdateInputQueriesInner.md index 542955c7..d1dc25a1 100644 --- a/clients/python/iota_client/docs/SavePexQueriesUpdateInputQueriesInner.md +++ b/clients/python/iota_client/docs/SavePexQueriesUpdateInputQueriesInner.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ----------------- | ------- | ----------- | ---------- | -| **query_id** | **str** | | -| **vp_definition** | **str** | | [optional] | -| **description** | **str** | | [optional] | +| Name | Type | Description | Notes | +| ----------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **query_id** | **str** | The ID of the query. | +| **vp_definition** | **str** | The presentation definition describing the data requirement that must be satisfied by the user. The value is in a JSON stringify format. | [optional] | +| **description** | **str** | An optional description of what the query is used for. | [optional] | ## Example diff --git a/clients/python/iota_client/docs/UpdateConfigurationByIdInput.md b/clients/python/iota_client/docs/UpdateConfigurationByIdInput.md index 012fdf31..64c413e4 100644 --- a/clients/python/iota_client/docs/UpdateConfigurationByIdInput.md +++ b/clients/python/iota_client/docs/UpdateConfigurationByIdInput.md @@ -2,19 +2,19 @@ ## Properties -| Name | Type | Description | Notes | -| ----------------------------- | ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | -| **name** | **str** | The name of the config | [optional] | -| **wallet_ari** | **str** | The wallet Ari that will be used to sign | [optional] | -| **iota_response_webhook_url** | **str** | webhook to call when data is ready | [optional] | -| **enable_verification** | **bool** | | [optional] | -| **enable_consent_audit_log** | **bool** | | [optional] | -| **token_max_age** | **float** | token time to live in seconds | [optional] | -| **description** | **str** | The description of the config | [optional] | -| **client_metadata** | [**IotaConfigurationDtoClientMetadata**](IotaConfigurationDtoClientMetadata.md) | | [optional] | -| **mode** | **str** | indicates whether the flow is a WebSocket flow or a Redirect flow. This value is used in Vault to determine how to process the data flow request. | [optional] | -| **redirect_uris** | **List[str]** | the URL that the user will be redirected to after the request has been processed; should be provided by the developer of the client application.Required only if mode is Redirect. | [optional] | -| **enable_idv_providers** | **bool** | enables third party IDV provider verification for the given configuration | [optional] | +| Name | Type | Description | Notes | +| ----------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ---------- | +| **name** | **str** | The name of the configuration to quickly identify the resource. | [optional] | +| **wallet_ari** | **str** | The unique resource identifier of the Wallet used to sign the request token. | [optional] | +| **iota_response_webhook_url** | **str** | The webhook URL is used for callback when the data is ready. | [optional] | +| **enable_verification** | **bool** | Cryptographically verifies the data shared by the user when enabled. | [optional] | +| **enable_consent_audit_log** | **bool** | Records the user's consent when they share their data, including the type of data shared when enabled. | [optional] | +| **token_max_age** | **float** | This is the lifetime of the signed request token during the data-sharing flow. | [optional] | +| **description** | **str** | An optional description of what the configuration is used for. | [optional] | +| **client_metadata** | [**IotaConfigurationDtoClientMetadata**](IotaConfigurationDtoClientMetadata.md) | | [optional] | +| **mode** | **str** | Determines whether to handle the data-sharing request using the WebSocket or Redirect flow. | [optional] | +| **redirect_uris** | **List[str]** | List of allowed URLs to redirect users, including the response from the request. This is required if the selected data-sharing mode is Redirect. | [optional] | +| **enable_idv_providers** | **bool** | Enables identity verification from user with a 3rd-party provider when a verified identity document is not found. | [optional] | ## Example diff --git a/clients/python/iota_client/docs/UpdatePexQueryInput.md b/clients/python/iota_client/docs/UpdatePexQueryInput.md index 008e0ce0..6fd786ef 100644 --- a/clients/python/iota_client/docs/UpdatePexQueryInput.md +++ b/clients/python/iota_client/docs/UpdatePexQueryInput.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ----------------- | ------- | -------------------------------------- | ---------- | -| **vp_definition** | **str** | VP definition in JSON stringify format | [optional] | -| **description** | **str** | | [optional] | +| Name | Type | Description | Notes | +| ----------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **vp_definition** | **str** | The presentation definition describing the data requirement that must be satisfied by the user. The value is in a JSON stringify format. | [optional] | +| **description** | **str** | An optional description of what the query is used for. | [optional] | ## Example diff --git a/clients/typescript/credential-issuance-client/api.ts b/clients/typescript/credential-issuance-client/api.ts index fdf29963..a3068f43 100644 --- a/clients/typescript/credential-issuance-client/api.ts +++ b/clients/typescript/credential-issuance-client/api.ts @@ -128,6 +128,25 @@ export interface ActionForbiddenErrorDetailsInner { */ location?: string } +/** + * + * @export + * @interface ChangeCredentialStatusInput + */ +export interface ChangeCredentialStatusInput { + /** + * + * @type {string} + * @memberof ChangeCredentialStatusInput + */ + changeReason?: string + /** + * + * @type {string} + * @memberof ChangeCredentialStatusInput + */ + issuanceFlowDataId?: string +} /** * * @export @@ -717,6 +736,167 @@ export interface DeferredCredentialInput { */ transaction_id: string } +/** + * + * @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} + * @memberof FlowData + */ + statusListsDetails?: Array +} +/** + * + * @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 const FlowDataStatusListsDetailsInnerStatusListPurposeEnum = { + Revoked: 'REVOKED', +} as const + +export type FlowDataStatusListsDetailsInnerStatusListPurposeEnum = + (typeof FlowDataStatusListsDetailsInnerStatusListPurposeEnum)[keyof typeof FlowDataStatusListsDetailsInnerStatusListPurposeEnum] +export const FlowDataStatusListsDetailsInnerStandardEnum = { + RevocationList2020: 'RevocationList2020', + BitstringStatusListV1: 'BitstringStatusListV1', +} as const + +export type FlowDataStatusListsDetailsInnerStandardEnum = + (typeof FlowDataStatusListsDetailsInnerStandardEnum)[keyof typeof FlowDataStatusListsDetailsInnerStandardEnum] + /** * @type GenerateCredentials400Response * @export @@ -736,6 +916,19 @@ export type GetCredentialOffer400Response = | ProjectCredentialConfigNotExistError | VcClaimedError +/** + * DTO contains revocation list credential + * @export + * @interface GetStatusListResultDto + */ +export interface GetStatusListResultDto { + /** + * + * @type {object} + * @memberof GetStatusListResultDto + */ + revocationListCredential: object +} /** * * @export @@ -1295,6 +1488,25 @@ export const IssuanceStateResponseStatusEnum = { export type IssuanceStateResponseStatusEnum = (typeof IssuanceStateResponseStatusEnum)[keyof typeof IssuanceStateResponseStatusEnum] +/** + * list of issuance data records + * @export + * @interface ListIssuanceRecordResponse + */ +export interface ListIssuanceRecordResponse { + /** + * + * @type {Array} + * @memberof ListIssuanceRecordResponse + */ + flowData?: Array + /** + * + * @type {string} + * @memberof ListIssuanceRecordResponse + */ + lastEvaluatedKey?: string +} /** * * @export @@ -1622,6 +1834,12 @@ export interface StartIssuanceInputDataInner { * @memberof StartIssuanceInputDataInner */ credentialData: { [key: string]: any } + /** + * Types of status lists to which the credential should be added once issued. If not provided or empty, the credential is not added to any of the status lists. + * @type {Array} + * @memberof StartIssuanceInputDataInner + */ + statusListDetails?: Array /** * * @type {StartIssuanceInputDataInnerMetaData} @@ -1642,6 +1860,40 @@ export interface StartIssuanceInputDataInnerMetaData { */ expirationDate: string } +/** + * + * @export + * @interface StartIssuanceInputDataInnerStatusListDetailsInner + */ +export interface StartIssuanceInputDataInnerStatusListDetailsInner { + /** + * + * @type {string} + * @memberof StartIssuanceInputDataInnerStatusListDetailsInner + */ + purpose?: StartIssuanceInputDataInnerStatusListDetailsInnerPurposeEnum + /** + * + * @type {string} + * @memberof StartIssuanceInputDataInnerStatusListDetailsInner + */ + standard?: StartIssuanceInputDataInnerStatusListDetailsInnerStandardEnum +} + +export const StartIssuanceInputDataInnerStatusListDetailsInnerPurposeEnum = { + Revocable: 'REVOCABLE', +} as const + +export type StartIssuanceInputDataInnerStatusListDetailsInnerPurposeEnum = + (typeof StartIssuanceInputDataInnerStatusListDetailsInnerPurposeEnum)[keyof typeof StartIssuanceInputDataInnerStatusListDetailsInnerPurposeEnum] +export const StartIssuanceInputDataInnerStatusListDetailsInnerStandardEnum = { + RevocationList2020: 'RevocationList2020', + BitstringStatusListV1: 'BitstringStatusListV1', +} as const + +export type StartIssuanceInputDataInnerStatusListDetailsInnerStandardEnum = + (typeof StartIssuanceInputDataInnerStatusListDetailsInnerStandardEnum)[keyof typeof StartIssuanceInputDataInnerStatusListDetailsInnerStandardEnum] + /** * * @export @@ -2823,6 +3075,431 @@ export class CredentialsApi extends BaseAPI { } } +/** + * DefaultApi - axios parameter creator + * @export + */ +export const DefaultApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { + /** + * change credential status. + * @summary change credential status. + * @param {string} projectId project id + * @param {string} configurationId configuration id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + changeCredentialSatatus: async ( + projectId: string, + configurationId: string, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'projectId' is not null or undefined + assertParamExists('changeCredentialSatatus', 'projectId', projectId) + // verify required parameter 'configurationId' is not null or undefined + assertParamExists( + 'changeCredentialSatatus', + 'configurationId', + configurationId, + ) + const localVarPath = + `/v1/{projectId}/configurations/{configurationId}/issuance/change-status` + .replace(`{${'projectId'}}`, encodeURIComponent(String(projectId))) + .replace( + `{${'configurationId'}}`, + encodeURIComponent(String(configurationId)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: 'POST', + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + // authentication ProjectTokenAuth required + await setApiKeyToObject( + localVarHeaderParameter, + 'authorization', + configuration, + ) + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + /** + * Return status list credential + * @summary Return status list credential + * @param {string} projectId + * @param {string} statusListId id of the status list + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getStatusList: async ( + projectId: string, + statusListId: string, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'projectId' is not null or undefined + assertParamExists('getStatusList', 'projectId', projectId) + // verify required parameter 'statusListId' is not null or undefined + assertParamExists('getStatusList', 'statusListId', statusListId) + const localVarPath = `/v1/{projectId}/status-list/{statusListId}` + .replace(`{${'projectId'}}`, encodeURIComponent(String(projectId))) + .replace( + `{${'statusListId'}}`, + encodeURIComponent(String(statusListId)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: 'GET', + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + /** + * Retrieve a list of issuance data records. + * @summary List records + * @param {number} [limit] Maximum number of records to fetch in a list + * @param {string} [exclusiveStartKey] exclusiveStartKey for retrieving the next batch of data. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listIssuanceDataRecords: async ( + limit?: number, + exclusiveStartKey?: string, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/v1/{projectId}/configurations/{configurationId}/issuance/issuance-data-records` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: 'GET', + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit + } + + if (exclusiveStartKey !== undefined) { + localVarQueryParameter['exclusiveStartKey'] = exclusiveStartKey + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } +} + +/** + * DefaultApi - functional programming interface + * @export + */ +export const DefaultApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration) + return { + /** + * change credential status. + * @summary change credential status. + * @param {string} projectId project id + * @param {string} configurationId configuration id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async changeCredentialSatatus( + projectId: string, + configurationId: string, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.changeCredentialSatatus( + projectId, + configurationId, + options, + ) + const localVarOperationServerIndex = configuration?.serverIndex ?? 0 + const localVarOperationServerBasePath = + operationServerMap['DefaultApi.changeCredentialSatatus']?.[ + localVarOperationServerIndex + ]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, localVarOperationServerBasePath || basePath) + }, + /** + * Return status list credential + * @summary Return status list credential + * @param {string} projectId + * @param {string} statusListId id of the status list + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getStatusList( + projectId: string, + statusListId: string, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.getStatusList( + projectId, + statusListId, + options, + ) + const localVarOperationServerIndex = configuration?.serverIndex ?? 0 + const localVarOperationServerBasePath = + operationServerMap['DefaultApi.getStatusList']?.[ + localVarOperationServerIndex + ]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, localVarOperationServerBasePath || basePath) + }, + /** + * Retrieve a list of issuance data records. + * @summary List records + * @param {number} [limit] Maximum number of records to fetch in a list + * @param {string} [exclusiveStartKey] exclusiveStartKey for retrieving the next batch of data. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async listIssuanceDataRecords( + limit?: number, + exclusiveStartKey?: string, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.listIssuanceDataRecords( + limit, + exclusiveStartKey, + options, + ) + const localVarOperationServerIndex = configuration?.serverIndex ?? 0 + const localVarOperationServerBasePath = + operationServerMap['DefaultApi.listIssuanceDataRecords']?.[ + localVarOperationServerIndex + ]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, localVarOperationServerBasePath || basePath) + }, + } +} + +/** + * DefaultApi - factory interface + * @export + */ +export const DefaultApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = DefaultApiFp(configuration) + return { + /** + * change credential status. + * @summary change credential status. + * @param {string} projectId project id + * @param {string} configurationId configuration id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + changeCredentialSatatus( + projectId: string, + configurationId: string, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .changeCredentialSatatus(projectId, configurationId, options) + .then((request) => request(axios, basePath)) + }, + /** + * Return status list credential + * @summary Return status list credential + * @param {string} projectId + * @param {string} statusListId id of the status list + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getStatusList( + projectId: string, + statusListId: string, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .getStatusList(projectId, statusListId, options) + .then((request) => request(axios, basePath)) + }, + /** + * Retrieve a list of issuance data records. + * @summary List records + * @param {number} [limit] Maximum number of records to fetch in a list + * @param {string} [exclusiveStartKey] exclusiveStartKey for retrieving the next batch of data. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listIssuanceDataRecords( + limit?: number, + exclusiveStartKey?: string, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .listIssuanceDataRecords(limit, exclusiveStartKey, options) + .then((request) => request(axios, basePath)) + }, + } +} + +/** + * DefaultApi - object-oriented interface + * @export + * @class DefaultApi + * @extends {BaseAPI} + */ +export class DefaultApi extends BaseAPI { + /** + * change credential status. + * @summary change credential status. + * @param {string} projectId project id + * @param {string} configurationId configuration id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public changeCredentialSatatus( + projectId: string, + configurationId: string, + options?: RawAxiosRequestConfig, + ) { + return DefaultApiFp(this.configuration) + .changeCredentialSatatus(projectId, configurationId, options) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Return status list credential + * @summary Return status list credential + * @param {string} projectId + * @param {string} statusListId id of the status list + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public getStatusList( + projectId: string, + statusListId: string, + options?: RawAxiosRequestConfig, + ) { + return DefaultApiFp(this.configuration) + .getStatusList(projectId, statusListId, options) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Retrieve a list of issuance data records. + * @summary List records + * @param {number} [limit] Maximum number of records to fetch in a list + * @param {string} [exclusiveStartKey] exclusiveStartKey for retrieving the next batch of data. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public listIssuanceDataRecords( + limit?: number, + exclusiveStartKey?: string, + options?: RawAxiosRequestConfig, + ) { + return DefaultApiFp(this.configuration) + .listIssuanceDataRecords(limit, exclusiveStartKey, options) + .then((request) => request(this.axios, this.basePath)) + } +} + /** * IssuanceApi - axios parameter creator * @export diff --git a/clients/typescript/credential-issuance-client/docs/.openapi-generator/FILES b/clients/typescript/credential-issuance-client/docs/.openapi-generator/FILES index a813d2b6..2623cffe 100644 --- a/clients/typescript/credential-issuance-client/docs/.openapi-generator/FILES +++ b/clients/typescript/credential-issuance-client/docs/.openapi-generator/FILES @@ -1,11 +1,13 @@ .openapi-generator-ignore Apis/ConfigurationApi.md Apis/CredentialsApi.md +Apis/DefaultApi.md Apis/IssuanceApi.md Apis/OfferApi.md Apis/WellKnownApi.md Models/ActionForbiddenError.md Models/ActionForbiddenError_details_inner.md +Models/ChangeCredentialStatusInput.md Models/CorsGenerateCredentialsOK.md Models/CorsGetCredentialOfferOK.md Models/CorsGetWellKnownOpenIdCredentialIssuerOK.md @@ -27,6 +29,9 @@ Models/CredentialResponseImmediate_credential.md Models/CredentialSubjectNotValidError.md Models/CredentialSupportedObject.md Models/DeferredCredentialInput.md +Models/FlowData.md +Models/FlowData_statusListsDetails_inner.md +Models/GetStatusListResultDto.md Models/InvalidCredentialRequestError.md Models/InvalidCredentialTypeError.md Models/InvalidIssuerWalletError.md @@ -37,6 +42,7 @@ Models/IssuanceConfigDto.md Models/IssuanceConfigListResponse.md Models/IssuanceConfigMiniDto.md Models/IssuanceStateResponse.md +Models/ListIssuanceRecordResponse.md Models/ListIssuanceResponse.md Models/ListIssuanceResponse_issuances_inner.md Models/MissingHolderDidError.md @@ -46,6 +52,7 @@ Models/ProjectCredentialConfigNotExistError.md Models/StartIssuanceInput.md Models/StartIssuanceInput_data_inner.md Models/StartIssuanceInput_data_inner_metaData.md +Models/StartIssuanceInput_data_inner_statusListDetails_inner.md Models/StartIssuanceResponse.md Models/SupportedCredentialMetadata.md Models/SupportedCredentialMetadata_display_inner.md diff --git a/clients/typescript/credential-issuance-client/docs/Apis/DefaultApi.md b/clients/typescript/credential-issuance-client/docs/Apis/DefaultApi.md new file mode 100644 index 00000000..47756632 --- /dev/null +++ b/clients/typescript/credential-issuance-client/docs/Apis/DefaultApi.md @@ -0,0 +1,99 @@ +# DefaultApi + +All URIs are relative to *https://apse1.api.affinidi.io/cis* + +| Method | HTTP request | Description | +| -------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | ----------------------------- | +| [**changeCredentialSatatus**](DefaultApi.md#changeCredentialSatatus) | **POST** /v1/{projectId}/configurations/{configurationId}/issuance/change-status | change credential status. | +| [**getStatusList**](DefaultApi.md#getStatusList) | **GET** /v1/{projectId}/status-list/{statusListId} | Return status list credential | +| [**listIssuanceDataRecords**](DefaultApi.md#listIssuanceDataRecords) | **GET** /v1/{projectId}/configurations/{configurationId}/issuance/issuance-data-records | List records | + + + +# **changeCredentialSatatus** + +> FlowData changeCredentialSatatus(projectId, configurationId) + +change credential status. + + change credential status. + +### Parameters + +| Name | Type | Description | Notes | +| ------------------- | ---------- | ---------------- | ----------------- | +| **projectId** | **String** | project id | [default to null] | +| **configurationId** | **String** | configuration id | [default to null] | + +### Return type + +[**FlowData**](../Models/FlowData.md) + +### Authorization + +[ProjectTokenAuth](../README.md#ProjectTokenAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + + +# **getStatusList** + +> GetStatusListResultDto getStatusList(projectId, statusListId) + +Return status list credential + + Return status list credential + +### Parameters + +| Name | Type | Description | Notes | +| ---------------- | ---------- | --------------------- | ----------------- | +| **projectId** | **String** | | [default to null] | +| **statusListId** | **String** | id of the status list | [default to null] | + +### Return type + +[**GetStatusListResultDto**](../Models/GetStatusListResultDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + + +# **listIssuanceDataRecords** + +> ListIssuanceRecordResponse listIssuanceDataRecords(limit, exclusiveStartKey) + +List records + + Retrieve a list of issuance data records. + +### Parameters + +| Name | Type | Description | Notes | +| --------------------- | ----------- | -------------------------------------------------------- | ---------------------------- | +| **limit** | **Integer** | Maximum number of records to fetch in a list | [optional] [default to 10] | +| **exclusiveStartKey** | **String** | exclusiveStartKey for retrieving the next batch of data. | [optional] [default to null] | + +### Return type + +[**ListIssuanceRecordResponse**](../Models/ListIssuanceRecordResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json diff --git a/clients/typescript/credential-issuance-client/docs/Models/ChangeCredentialStatusInput.md b/clients/typescript/credential-issuance-client/docs/Models/ChangeCredentialStatusInput.md new file mode 100644 index 00000000..682b835e --- /dev/null +++ b/clients/typescript/credential-issuance-client/docs/Models/ChangeCredentialStatusInput.md @@ -0,0 +1,10 @@ +# ChangeCredentialStatusInput + +## Properties + +| Name | Type | Description | Notes | +| ---------------------- | ---------- | ----------- | ---------------------------- | +| **changeReason** | **String** | | [optional] [default to null] | +| **issuanceFlowDataId** | **String** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/typescript/credential-issuance-client/docs/Models/FlowData.md b/clients/typescript/credential-issuance-client/docs/Models/FlowData.md new file mode 100644 index 00000000..2f915329 --- /dev/null +++ b/clients/typescript/credential-issuance-client/docs/Models/FlowData.md @@ -0,0 +1,23 @@ +# FlowData + +## Properties + +| Name | Type | Description | Notes | +| ------------------------------------------ | ------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | +| **createdAt** | **String** | [GEN] ISO 8601 string of the creation date/time the entity | [default to null] | +| **modifiedAt** | **String** | [GEN] ISO 8601 string of the modification date/time the entity | [default to null] | +| **id** | **String** | | [default to null] | +| **projectId** | **String** | | [optional] [default to null] | +| **flowId** | **String** | | [default to null] | +| **credentialTypeId** | **String** | | [default to null] | +| **jsonLdContextUrl** | **String** | | [default to null] | +| **jsonSchemaUrl** | **String** | | [default to null] | +| **configurationId** | **String** | Id of configuration, used to issue VC. | [optional] [default to null] | +| **issuedAt** | **String** | when credential was issued to the holder (holder invoked generateCredentials endpoint) | [optional] [default to null] | +| **walletId** | **String** | Id of wallet, used to issue VC. | [optional] [default to null] | +| **projectIdConfigurationId** | **String** | Id of configuration with which VC was issued. To use as an index, it is grouped together with projectId, as \"{projectIdConfigurationId}#{configurationId}\" | [optional] [default to null] | +| **projectIdConfigurationIdWalletId** | **String** | Id of wallet which issued VC. To use as an index, it is grouped together with projectId, as \"{projectIdConfigurationId}#{walletId}\" | [optional] [default to null] | +| **projectIdConfigurationIdCredentialType** | **String** | VC.type value. To use as an index, it is grouped together with projectId, as \"{projectIdConfigurationId}#{credentialType}\" | [optional] [default to null] | +| **statusListsDetails** | [**List**](FlowData_statusListsDetails_inner.md) | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/typescript/credential-issuance-client/docs/Models/FlowData_statusListsDetails_inner.md b/clients/typescript/credential-issuance-client/docs/Models/FlowData_statusListsDetails_inner.md new file mode 100644 index 00000000..1f10cb15 --- /dev/null +++ b/clients/typescript/credential-issuance-client/docs/Models/FlowData_statusListsDetails_inner.md @@ -0,0 +1,15 @@ +# FlowData_statusListsDetails_inner + +## Properties + +| Name | Type | Description | Notes | +| -------------------------- | ----------- | ------------------------------------------------------------------- | ---------------------------- | +| **statusListPurpose** | **String** | Purpose of status list to which credential is added | [default to null] | +| **statusListId** | **String** | id of status list | [default to null] | +| **statusListIndex** | **String** | as usual it is a number, but all standards use a string | [default to null] | +| **standard** | **String** | | [default to null] | +| **isActive** | **Boolean** | indicates status is true or not. Default false. | [default to null] | +| **statusActivationReason** | **String** | text reasoning why the status is true (if true). Optional. | [optional] [default to null] | +| **statusActivatedAt** | **String** | ISO 8601 string of the modification date/time the status. Optional. | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/typescript/credential-issuance-client/docs/Models/GetStatusListResultDto.md b/clients/typescript/credential-issuance-client/docs/Models/GetStatusListResultDto.md new file mode 100644 index 00000000..60fa9dc4 --- /dev/null +++ b/clients/typescript/credential-issuance-client/docs/Models/GetStatusListResultDto.md @@ -0,0 +1,9 @@ +# GetStatusListResultDto + +## Properties + +| Name | Type | Description | Notes | +| ---------------------------- | ----------------- | ----------- | ----------------- | +| **revocationListCredential** | [**Object**](.md) | | [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/typescript/credential-issuance-client/docs/Models/ListIssuanceRecordResponse.md b/clients/typescript/credential-issuance-client/docs/Models/ListIssuanceRecordResponse.md new file mode 100644 index 00000000..1d222e4f --- /dev/null +++ b/clients/typescript/credential-issuance-client/docs/Models/ListIssuanceRecordResponse.md @@ -0,0 +1,10 @@ +# ListIssuanceRecordResponse + +## Properties + +| Name | Type | Description | Notes | +| -------------------- | ----------------------- | ----------- | ---------------------------- | +| **flowData** | [**List**](FlowData.md) | | [optional] [default to null] | +| **lastEvaluatedKey** | **String** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/typescript/credential-issuance-client/docs/Models/StartIssuanceInput_data_inner.md b/clients/typescript/credential-issuance-client/docs/Models/StartIssuanceInput_data_inner.md index e955778d..314511d5 100644 --- a/clients/typescript/credential-issuance-client/docs/Models/StartIssuanceInput_data_inner.md +++ b/clients/typescript/credential-issuance-client/docs/Models/StartIssuanceInput_data_inner.md @@ -2,10 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| -------------------- | --------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------- | -| **credentialTypeId** | **String** | It is a String that identifies a Credential that is being requested to be issued. | [default to null] | -| **credentialData** | [**Map**](AnyType.md) | Object of data to be included in the issued credential ,should match the credential type | [default to null] | -| **metaData** | [**StartIssuanceInput_data_inner_metaData**](StartIssuanceInput_data_inner_metaData.md) | | [optional] [default to null] | +| Name | Type | Description | Notes | +| --------------------- | --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------- | +| **credentialTypeId** | **String** | It is a String that identifies a Credential that is being requested to be issued. | [default to null] | +| **credentialData** | [**Map**](AnyType.md) | Object of data to be included in the issued credential ,should match the credential type | [default to null] | +| **statusListDetails** | [**List**](StartIssuanceInput_data_inner_statusListDetails_inner.md) | Types of status lists to which the credential should be added once issued. If not provided or empty, the credential is not added to any of the status lists. | [optional] [default to null] | +| **metaData** | [**StartIssuanceInput_data_inner_metaData**](StartIssuanceInput_data_inner_metaData.md) | | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/typescript/credential-issuance-client/docs/Models/StartIssuanceInput_data_inner_statusListDetails_inner.md b/clients/typescript/credential-issuance-client/docs/Models/StartIssuanceInput_data_inner_statusListDetails_inner.md new file mode 100644 index 00000000..52bd583c --- /dev/null +++ b/clients/typescript/credential-issuance-client/docs/Models/StartIssuanceInput_data_inner_statusListDetails_inner.md @@ -0,0 +1,10 @@ +# StartIssuanceInput_data_inner_statusListDetails_inner + +## Properties + +| Name | Type | Description | Notes | +| ------------ | ---------- | ----------- | ---------------------------- | +| **purpose** | **String** | | [optional] [default to null] | +| **standard** | **String** | | [optional] [default to null] | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/typescript/credential-issuance-client/docs/README.md b/clients/typescript/credential-issuance-client/docs/README.md index 3dd0d2be..d185282c 100644 --- a/clients/typescript/credential-issuance-client/docs/README.md +++ b/clients/typescript/credential-issuance-client/docs/README.md @@ -6,19 +6,22 @@ All URIs are relative to *https://apse1.api.affinidi.io/cis* -| Class | Method | HTTP request | Description | -| ------------------ | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| _ConfigurationApi_ | [**createIssuanceConfig**](Apis/ConfigurationApi.md#createissuanceconfig) | **POST** /v1/configurations | Create issuance configuration, project have only one configuration | -| _ConfigurationApi_ | [**deleteIssuanceConfigById**](Apis/ConfigurationApi.md#deleteissuanceconfigbyid) | **DELETE** /v1/configurations/{configurationId} | Delete project issuance configuration | -| _ConfigurationApi_ | [**getIssuanceConfigById**](Apis/ConfigurationApi.md#getissuanceconfigbyid) | **GET** /v1/configurations/{configurationId} | Get issuance configuration by id | -| _ConfigurationApi_ | [**getIssuanceConfigList**](Apis/ConfigurationApi.md#getissuanceconfiglist) | **GET** /v1/configurations | Get issuance configuration for my selected project | -| _ConfigurationApi_ | [**updateIssuanceConfigById**](Apis/ConfigurationApi.md#updateissuanceconfigbyid) | **PUT** /v1/configurations/{configurationId} | Update issuance configuration | -| _CredentialsApi_ | [**generateCredentials**](Apis/CredentialsApi.md#generatecredentials) | **POST** /v1/{projectId}/credential | Issue credential for end user upon presentation a valid access token. Since we don't immediate issue credential It's expected to return `transaction_id` and use this `transaction_id` to get the deferred credentials | -| _IssuanceApi_ | [**issuanceState**](Apis/IssuanceApi.md#issuancestate) | **GET** /v1/{projectId}/issuance/state/{issuanceId} | Get issuance status | -| _IssuanceApi_ | [**listIssuance**](Apis/IssuanceApi.md#listissuance) | **GET** /v1/{projectId}/issuance | List all issuances for Project | -| _IssuanceApi_ | [**startIssuance**](Apis/IssuanceApi.md#startissuance) | **POST** /v1/{projectId}/issuance/start | Endpoint used b websites to start the issuance process | -| _OfferApi_ | [**getCredentialOffer**](Apis/OfferApi.md#getcredentialoffer) | **GET** /v1/{projectId}/offers/{issuanceId} | Endpoint used to return Credential Offer details, used with `credential_offer_uri` response | -| _WellKnownApi_ | [**getWellKnownOpenIdCredentialIssuer**](Apis/WellKnownApi.md#getwellknownopenidcredentialissuer) | **GET** /v1/{projectId}/.well-known/openid-credential-issuer | | +| Class | Method | HTTP request | Description | +| ------------------ | ------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| _ConfigurationApi_ | [**createIssuanceConfig**](Apis/ConfigurationApi.md#createissuanceconfig) | **POST** /v1/configurations | Create issuance configuration, project have only one configuration | +| _ConfigurationApi_ | [**deleteIssuanceConfigById**](Apis/ConfigurationApi.md#deleteissuanceconfigbyid) | **DELETE** /v1/configurations/{configurationId} | Delete project issuance configuration | +| _ConfigurationApi_ | [**getIssuanceConfigById**](Apis/ConfigurationApi.md#getissuanceconfigbyid) | **GET** /v1/configurations/{configurationId} | Get issuance configuration by id | +| _ConfigurationApi_ | [**getIssuanceConfigList**](Apis/ConfigurationApi.md#getissuanceconfiglist) | **GET** /v1/configurations | Get issuance configuration for my selected project | +| _ConfigurationApi_ | [**updateIssuanceConfigById**](Apis/ConfigurationApi.md#updateissuanceconfigbyid) | **PUT** /v1/configurations/{configurationId} | Update issuance configuration | +| _CredentialsApi_ | [**generateCredentials**](Apis/CredentialsApi.md#generatecredentials) | **POST** /v1/{projectId}/credential | Issue credential for end user upon presentation a valid access token. Since we don't immediate issue credential It's expected to return `transaction_id` and use this `transaction_id` to get the deferred credentials | +| _DefaultApi_ | [**changeCredentialSatatus**](Apis/DefaultApi.md#changecredentialsatatus) | **POST** /v1/{projectId}/configurations/{configurationId}/issuance/change-status | change credential status. | +| _DefaultApi_ | [**getStatusList**](Apis/DefaultApi.md#getstatuslist) | **GET** /v1/{projectId}/status-list/{statusListId} | Return status list credential | +| _DefaultApi_ | [**listIssuanceDataRecords**](Apis/DefaultApi.md#listissuancedatarecords) | **GET** /v1/{projectId}/configurations/{configurationId}/issuance/issuance-data-records | List records | +| _IssuanceApi_ | [**issuanceState**](Apis/IssuanceApi.md#issuancestate) | **GET** /v1/{projectId}/issuance/state/{issuanceId} | Get issuance status | +| _IssuanceApi_ | [**listIssuance**](Apis/IssuanceApi.md#listissuance) | **GET** /v1/{projectId}/issuance | List all issuances for Project | +| _IssuanceApi_ | [**startIssuance**](Apis/IssuanceApi.md#startissuance) | **POST** /v1/{projectId}/issuance/start | Endpoint used b websites to start the issuance process | +| _OfferApi_ | [**getCredentialOffer**](Apis/OfferApi.md#getcredentialoffer) | **GET** /v1/{projectId}/offers/{issuanceId} | Endpoint used to return Credential Offer details, used with `credential_offer_uri` response | +| _WellKnownApi_ | [**getWellKnownOpenIdCredentialIssuer**](Apis/WellKnownApi.md#getwellknownopenidcredentialissuer) | **GET** /v1/{projectId}/.well-known/openid-credential-issuer | | @@ -26,6 +29,7 @@ All URIs are relative to *https://apse1.api.affinidi.io/cis* - [ActionForbiddenError](./Models/ActionForbiddenError.md) - [ActionForbiddenError_details_inner](./Models/ActionForbiddenError_details_inner.md) +- [ChangeCredentialStatusInput](./Models/ChangeCredentialStatusInput.md) - [CorsGenerateCredentialsOK](./Models/CorsGenerateCredentialsOK.md) - [CorsGetCredentialOfferOK](./Models/CorsGetCredentialOfferOK.md) - [CorsGetWellKnownOpenIdCredentialIssuerOK](./Models/CorsGetWellKnownOpenIdCredentialIssuerOK.md) @@ -47,6 +51,9 @@ All URIs are relative to *https://apse1.api.affinidi.io/cis* - [CredentialSubjectNotValidError](./Models/CredentialSubjectNotValidError.md) - [CredentialSupportedObject](./Models/CredentialSupportedObject.md) - [DeferredCredentialInput](./Models/DeferredCredentialInput.md) +- [FlowData](./Models/FlowData.md) +- [FlowData_statusListsDetails_inner](./Models/FlowData_statusListsDetails_inner.md) +- [GetStatusListResultDto](./Models/GetStatusListResultDto.md) - [InvalidCredentialRequestError](./Models/InvalidCredentialRequestError.md) - [InvalidCredentialTypeError](./Models/InvalidCredentialTypeError.md) - [InvalidIssuerWalletError](./Models/InvalidIssuerWalletError.md) @@ -57,6 +64,7 @@ All URIs are relative to *https://apse1.api.affinidi.io/cis* - [IssuanceConfigListResponse](./Models/IssuanceConfigListResponse.md) - [IssuanceConfigMiniDto](./Models/IssuanceConfigMiniDto.md) - [IssuanceStateResponse](./Models/IssuanceStateResponse.md) +- [ListIssuanceRecordResponse](./Models/ListIssuanceRecordResponse.md) - [ListIssuanceResponse](./Models/ListIssuanceResponse.md) - [ListIssuanceResponse_issuances_inner](./Models/ListIssuanceResponse_issuances_inner.md) - [MissingHolderDidError](./Models/MissingHolderDidError.md) @@ -66,6 +74,7 @@ All URIs are relative to *https://apse1.api.affinidi.io/cis* - [StartIssuanceInput](./Models/StartIssuanceInput.md) - [StartIssuanceInput_data_inner](./Models/StartIssuanceInput_data_inner.md) - [StartIssuanceInput_data_inner_metaData](./Models/StartIssuanceInput_data_inner_metaData.md) +- [StartIssuanceInput_data_inner_statusListDetails_inner](./Models/StartIssuanceInput_data_inner_statusListDetails_inner.md) - [StartIssuanceResponse](./Models/StartIssuanceResponse.md) - [SupportedCredentialMetadata](./Models/SupportedCredentialMetadata.md) - [SupportedCredentialMetadata_display_inner](./Models/SupportedCredentialMetadata_display_inner.md) diff --git a/clients/typescript/iota-client/api.ts b/clients/typescript/iota-client/api.ts index 6fb61e1f..a49e1e22 100644 --- a/clients/typescript/iota-client/api.ts +++ b/clients/typescript/iota-client/api.ts @@ -103,7 +103,7 @@ export type AlreadyExistsErrorHttpStatusCodeEnum = */ export interface AwsExchangeCredentials { /** - * JWT signed with a machine token used to secure the web socket connection + * A valid JSON Web Token (JWT) that secures the WebSocket connection. The JWT is signed with the key pair\'s private key used to create the Personal Access Token (PAT). * @type {string} * @memberof AwsExchangeCredentials */ @@ -135,19 +135,19 @@ export interface AwsExchangeCredentialsOK { */ export interface AwsExchangeCredentialsProjectToken { /** - * sessionId generated by client + * ID of the session generated by a client. * @type {string} * @memberof AwsExchangeCredentialsProjectToken */ sessionId: string /** - * iotaConfiguration Id + * ID of the Affinidi Iota Framework configuration. * @type {string} * @memberof AwsExchangeCredentialsProjectToken */ configurationId: string /** - * Vault DID of the user + * The Decentalised Identifier (DID) of the user. * @type {string} * @memberof AwsExchangeCredentialsProjectToken */ @@ -198,37 +198,37 @@ export interface AwsExchangeCredentialsProjectTokenOKCredentials { */ export interface CallbackInput { /** - * A string that must be a valid UUID (version 1-5). + * A randomly generated string that follows a valid UUID (version 1-5) format to validate the session. * @type {string} * @memberof CallbackInput */ state: string /** - * A string that must be a valid JSON object. The structure of presentation submission should follow OID4VP standard. + * A JSON string format that describes the link between the Verifiable Presentation and Presentation Definition for the verifier. The presentation submission follows the OID4VP standard. * @type {string} * @memberof CallbackInput */ presentation_submission?: string /** - * A string that must be a valid JSON object. Ensure to escape special characters properly.. + * A JSON string format containing the data the user consented to share in a Verifiable Presentation format. The VP Token follows the OID4VP standard. * @type {string} * @memberof CallbackInput */ vp_token?: string /** - * The error should follow the OAuth2 error format (e.g. invalid_request, login_required). Defaults to access_denied + * A short string indicating the error code reported by the service. It follows the OAuth 2.0 error code format (e.g., invalid_request, access_denied). The default is access_denied. * @type {string} * @memberof CallbackInput */ error?: string /** - * Description of the error in a human readable format + * A human-readable description that provides detailed information about the error. * @type {string} * @memberof CallbackInput */ error_description?: string /** - * Specifies whether the Iota share triggered the creation of a Vault + * It specifies whether the data sharing flow triggered an onboarding process to the Affinidi Vault [New User]. * @type {boolean} * @memberof CallbackInput */ @@ -241,19 +241,19 @@ export interface CallbackInput { */ export interface CallbackResponseOK { /** - * URL to which vault will redirect + * The URL to which Affinidi Vault will redirect the user. * @type {string} * @memberof CallbackResponseOK */ redirect_uri?: string /** - * Code which will be used along with transactionId to retrieve data + * A unique identifier to fetch the callback response data. Send this value together with the transactionId to successfully fetch the data. * @type {string} * @memberof CallbackResponseOK */ response_code?: string /** - * A message to vault that flow is updated successfully + * A message to the Affinidi Vault indicating that the update was successful. * @type {string} * @memberof CallbackResponseOK */ @@ -266,31 +266,31 @@ export interface CallbackResponseOK { */ export interface ConsentDto { /** - * + * The ID of the project. * @type {string} * @memberof ConsentDto */ projectId: string /** - * id of the record + * Unique identifier for the record. * @type {string} * @memberof ConsentDto */ id: string /** - * unique identifier of the user + * Unique identifier for the user. * @type {string} * @memberof ConsentDto */ userId: string /** - * VC type of shared vc. If the actual VC has several VC types (excluding base types as VerifiableCredential) then for each of the a separate record will be added + * Type of the VC shared by the user. It creates a consent record for each VC type shared except for the base type VerifiableCredential. * @type {string} * @memberof ConsentDto */ vcType: string /** - * + * Status of the consent. * @type {string} * @memberof ConsentDto */ @@ -413,43 +413,43 @@ export interface CorsIotaExchangeCredentialsOK { */ export interface CreateIotaConfigurationInput { /** - * The name of the configuration + * The name of the configuration to quickly identify the resource. * @type {string} * @memberof CreateIotaConfigurationInput */ name: string /** - * Description of the configuration + * An optional description of what the configuration is used for. * @type {string} * @memberof CreateIotaConfigurationInput */ description?: string /** - * The wallet Ari that will be used to sign + * The unique resource identifier of the Wallet used to sign the request token. * @type {string} * @memberof CreateIotaConfigurationInput */ walletAri: string /** - * webhook to call when data is ready + * The webhook URL is used for callback when the data is ready. * @type {string} * @memberof CreateIotaConfigurationInput */ iotaResponseWebhookURL?: string /** - * + * Cryptographically verifies the data shared by the user when enabled. * @type {boolean} * @memberof CreateIotaConfigurationInput */ enableVerification: boolean /** - * + * Records the user\'s consent when they share their data, including the type of data shared when enabled. * @type {boolean} * @memberof CreateIotaConfigurationInput */ enableConsentAuditLog: boolean /** - * token time to live in seconds + * This is the lifetime of the signed request token during the data-sharing flow. * @type {number} * @memberof CreateIotaConfigurationInput */ @@ -461,19 +461,19 @@ export interface CreateIotaConfigurationInput { */ clientMetadata: IotaConfigurationDtoClientMetadata /** - * indicates whether the flow is a WebSocket flow or a Redirect flow. This value is used in Vault to determine how to process the data flow request. + * Determines whether to handle the data-sharing request using the WebSocket or Redirect flow. * @type {string} * @memberof CreateIotaConfigurationInput */ mode?: CreateIotaConfigurationInputModeEnum /** - * the URL that the user will be redirected to after the request has been processed; should be provided by the developer of the client application.Required only if mode is Redirect. + * List of allowed URLs to redirect users, including the response from the request. This is required if the selected data-sharing mode is Redirect. * @type {Array} * @memberof CreateIotaConfigurationInput */ redirectUris?: Array /** - * enables third party IDV provider verification for the given configuration + * Enables identity verification from user with a 3rd-party provider when a verified identity document is not found. * @type {boolean} * @memberof CreateIotaConfigurationInput */ @@ -495,19 +495,19 @@ export type CreateIotaConfigurationInputModeEnum = */ export interface CreatePexQueryInput { /** - * + * The name of the presentation definition to quickly identify the query. * @type {string} * @memberof CreatePexQueryInput */ name: string /** - * VP definition in JSON stringify format + * The presentation definition describing the data requirement that must be satisfied by the user. The value is in a JSON stringify format. * @type {string} * @memberof CreatePexQueryInput */ vpDefinition: string /** - * Description of query + * An optional description of what the query is used for. * @type {string} * @memberof CreatePexQueryInput */ @@ -533,25 +533,25 @@ export interface DeletePexQueriesInput { */ export interface FetchIOTAVPResponseInput { /** - * The correlation ID + * A unique, randomly generated identifier that correlates the request and response in the data-sharing request flow. * @type {string} * @memberof FetchIOTAVPResponseInput */ correlationId: string /** - * The transaction ID + * A unique, randomly generated identifier data-sharing request flow is initiated. This value is used with the response code to fetch the callback response data. * @type {string} * @memberof FetchIOTAVPResponseInput */ transactionId: string /** - * The response code. + * A unique identifier to fetch the callback response data. Send this value together with the transactionId to successfully fetch the data. * @type {string} * @memberof FetchIOTAVPResponseInput */ responseCode: string /** - * The configuration ID + * ID of the Affinidi Iota Framework configuration. * @type {string} * @memberof FetchIOTAVPResponseInput */ @@ -566,19 +566,19 @@ export interface FetchIOTAVPResponseOK { [key: string]: any /** - * A correlationId used for the flow + * A unique, randomly generated identifier that correlates the request and response in the data-sharing request flow. * @type {string} * @memberof FetchIOTAVPResponseOK */ correlationId?: string /** - * A string that must be a valid JSON object. The structure of presentation submission should follow OID4VP standard. + * A JSON string format that describes the link between the Verifiable Presentation and Presentation Definition for the verifier. The presentation submission follows the OID4VP standard. * @type {string} * @memberof FetchIOTAVPResponseOK */ presentation_submission?: string /** - * A string that must be a valid JSON object. Ensure to escape special characters properly.. + * A JSON string format containing the data the user consented to share in a Verifiable Presentation format. The VP Token follows the OID4VP standard. * @type {string} * @memberof FetchIOTAVPResponseOK */ @@ -591,19 +591,19 @@ export interface FetchIOTAVPResponseOK { */ export interface GetIotaConfigurationMetaDataOK { /** - * application name that will be displayed in consent page + * The name displayed on the consent page indicates who is requesting data from the user. It can be the application or website\'s name. * @type {string} * @memberof GetIotaConfigurationMetaDataOK */ name: string /** - * origin url that will be displayed in consent page + * The URL of the requester displayed on the consent page indicates the request\'s origin. * @type {string} * @memberof GetIotaConfigurationMetaDataOK */ origin: string /** - * logo url that will be displayed in consent page + * The logo of the requester displayed on the consent page, allowing users to easily recognise who requests the data. * @type {string} * @memberof GetIotaConfigurationMetaDataOK */ @@ -616,43 +616,43 @@ export interface GetIotaConfigurationMetaDataOK { */ export interface InitiateDataSharingRequestInput { /** - * + * The ID of the query. * @type {string} * @memberof InitiateDataSharingRequestInput */ queryId: string /** - * + * A unique, randomly generated identifier that correlates the request and response in the data-sharing request flow. * @type {string} * @memberof InitiateDataSharingRequestInput */ correlationId: string /** - * token time to live in seconds + * This is the lifetime of the signed request token during the data-sharing flow. * @type {number} * @memberof InitiateDataSharingRequestInput */ tokenMaxAge?: number /** - * Random value used to prevent replay attacks + * A randomly generated value that is added in the request and response to prevent replay attacks. * @type {string} * @memberof InitiateDataSharingRequestInput */ nonce: string /** - * the URL that the user will be redirected to after the request has been processed; should be provided by the developer of the client application. + * List of allowed URLs to redirect users, including the response from the request. This is required if the selected data-sharing mode is Redirect. * @type {string} * @memberof InitiateDataSharingRequestInput */ redirectUri: string /** - * id of the IOTA configuration used + * ID of the Affinidi Iota Framework configuration. * @type {string} * @memberof InitiateDataSharingRequestInput */ configurationId: string /** - * indicates whether the flow is a WebSocket flow or a Redirect flow. This value is used in Vault to determine how to process the data flow request. + * Determines whether to handle the data-sharing request using the WebSocket or Redirect flow. * @type {string} * @memberof InitiateDataSharingRequestInput */ @@ -800,55 +800,55 @@ export interface InvalidParameterErrorDetailsInner { */ export interface IotaConfigurationDto { /** - * The ARI of the config + * This is a unique resource identifier of the Affinidi Iota Framework configuration. * @type {string} * @memberof IotaConfigurationDto */ ari: string /** - * + * ID of the Affinidi Iota Framework configuration. * @type {string} * @memberof IotaConfigurationDto */ configurationId: string /** - * The name of the config + * The name of the configuration to quickly identify the resource. * @type {string} * @memberof IotaConfigurationDto */ name: string /** - * + * The ID of the project. * @type {string} * @memberof IotaConfigurationDto */ projectId: string /** - * The wallet Ari that will be used to sign + * The unique resource identifier of the Wallet used to sign the request token. * @type {string} * @memberof IotaConfigurationDto */ walletAri: string /** - * token time to live in seconds + * This is the lifetime of the signed request token during the data-sharing flow. * @type {number} * @memberof IotaConfigurationDto */ tokenMaxAge: number /** - * webhook to call when data is ready + * The webhook URL is used for callback when the data is ready. * @type {string} * @memberof IotaConfigurationDto */ iotaResponseWebhookURL?: string /** - * + * Cryptographically verifies the data shared by the user when enabled. * @type {boolean} * @memberof IotaConfigurationDto */ enableVerification: boolean /** - * + * Records the consent the user gave when they shared their data, including the type of data shared. * @type {boolean} * @memberof IotaConfigurationDto */ @@ -860,19 +860,19 @@ export interface IotaConfigurationDto { */ clientMetadata: IotaConfigurationDtoClientMetadata /** - * indicates whether the flow is a WebSocket flow or a Redirect flow. This value is used in Vault to determine how to process the data flow request. + * Determines whether to handle the data-sharing request using the WebSocket or Redirect flow. * @type {string} * @memberof IotaConfigurationDto */ mode?: IotaConfigurationDtoModeEnum /** - * the URLs that the user will be redirected to after the request has been processed; should be provided by the developer of the client application.Required only if mode is Redirect. + * List of allowed URLs to redirect users, including the response from the request. This is required if the selected data-sharing mode is Redirect. * @type {Array} * @memberof IotaConfigurationDto */ redirectUris?: Array /** - * enables third party IDV provider verification for the given configuration + * Enables identity verification from user with a 3rd-party provider when a verified identity document is not found. * @type {boolean} * @memberof IotaConfigurationDto */ @@ -888,7 +888,7 @@ export type IotaConfigurationDtoModeEnum = (typeof IotaConfigurationDtoModeEnum)[keyof typeof IotaConfigurationDtoModeEnum] /** - * iota configuration client metadata + * It contains information about the requester or verifier. * @export * @interface IotaConfigurationDtoClientMetadata */ @@ -896,19 +896,19 @@ export interface IotaConfigurationDtoClientMetadata { [key: string]: any /** - * application name that will be displayed in consent page + * The name displayed on the consent page indicates who is requesting data from the user. It can be the application or website\'s name. * @type {string} * @memberof IotaConfigurationDtoClientMetadata */ name: string /** - * origin url that will be displayed in consent page + * The URL of the requester displayed on the consent page indicates the request\'s origin. * @type {string} * @memberof IotaConfigurationDtoClientMetadata */ origin: string /** - * logo url that will be displayed in consent page + * The logo of the requester displayed on the consent page, allowing users to easily recognise who requests the data. * @type {string} * @memberof IotaConfigurationDtoClientMetadata */ @@ -921,7 +921,7 @@ export interface IotaConfigurationDtoClientMetadata { */ export interface IotaExchangeCredentials { /** - * JWT signed with a machine token used to secure the web socket connection + * A valid JSON Web Token (JWT) that secures the WebSocket connection. The JWT is signed with the key pair\'s private key used to create the Personal Access Token (PAT). * @type {string} * @memberof IotaExchangeCredentials */ @@ -1206,37 +1206,37 @@ export type OperationForbiddenErrorHttpStatusCodeEnum = */ export interface PexQueryDto { /** - * + * The unique resource identifier of the qeuery. * @type {string} * @memberof PexQueryDto */ ari: string /** - * + * The ID of the query. * @type {string} * @memberof PexQueryDto */ queryId: string /** - * + * The name of the presentation definition to quickly identify the query. * @type {string} * @memberof PexQueryDto */ name: string /** - * + * An optional description of what the query is used for. * @type {string} * @memberof PexQueryDto */ description: string /** - * + * The unique resource identifier of the related configuration where the query is defined. * @type {string} * @memberof PexQueryDto */ configurationAri: string /** - * VP definition in JSON stringify format + * The presentation definition describing the data requirement that must be satisfied by the user. The value is in a JSON stringify format. * @type {string} * @memberof PexQueryDto */ @@ -1261,13 +1261,13 @@ export interface PrepareRequest { */ queryId: string /** - * + * A unique, randomly generated identifier that correlates the request and response in the data-sharing request flow. * @type {string} * @memberof PrepareRequest */ correlationId: string /** - * token time to live in seconds + * This is the lifetime of the signed request token during the data-sharing flow. * @type {number} * @memberof PrepareRequest */ @@ -1305,7 +1305,7 @@ export interface PrepareRequestCreatedData { */ jwt: string /** - * + * A unique, randomly generated identifier that correlates the request and response in the data-sharing request flow. * @type {string} * @memberof PrepareRequestCreatedData */ @@ -1388,19 +1388,19 @@ export interface SavePexQueriesUpdateInput { */ export interface SavePexQueriesUpdateInputQueriesInner { /** - * + * The ID of the query. * @type {string} * @memberof SavePexQueriesUpdateInputQueriesInner */ queryId: string /** - * + * The presentation definition describing the data requirement that must be satisfied by the user. The value is in a JSON stringify format. * @type {string} * @memberof SavePexQueriesUpdateInputQueriesInner */ vpDefinition?: string /** - * + * An optional description of what the query is used for. * @type {string} * @memberof SavePexQueriesUpdateInputQueriesInner */ @@ -1413,43 +1413,43 @@ export interface SavePexQueriesUpdateInputQueriesInner { */ export interface UpdateConfigurationByIdInput { /** - * The name of the config + * The name of the configuration to quickly identify the resource. * @type {string} * @memberof UpdateConfigurationByIdInput */ name?: string /** - * The wallet Ari that will be used to sign + * The unique resource identifier of the Wallet used to sign the request token. * @type {string} * @memberof UpdateConfigurationByIdInput */ walletAri?: string /** - * webhook to call when data is ready + * The webhook URL is used for callback when the data is ready. * @type {string} * @memberof UpdateConfigurationByIdInput */ iotaResponseWebhookURL?: string /** - * + * Cryptographically verifies the data shared by the user when enabled. * @type {boolean} * @memberof UpdateConfigurationByIdInput */ enableVerification?: boolean /** - * + * Records the user\'s consent when they share their data, including the type of data shared when enabled. * @type {boolean} * @memberof UpdateConfigurationByIdInput */ enableConsentAuditLog?: boolean /** - * token time to live in seconds + * This is the lifetime of the signed request token during the data-sharing flow. * @type {number} * @memberof UpdateConfigurationByIdInput */ tokenMaxAge?: number /** - * The description of the config + * An optional description of what the configuration is used for. * @type {string} * @memberof UpdateConfigurationByIdInput */ @@ -1461,19 +1461,19 @@ export interface UpdateConfigurationByIdInput { */ clientMetadata?: IotaConfigurationDtoClientMetadata /** - * indicates whether the flow is a WebSocket flow or a Redirect flow. This value is used in Vault to determine how to process the data flow request. + * Determines whether to handle the data-sharing request using the WebSocket or Redirect flow. * @type {string} * @memberof UpdateConfigurationByIdInput */ mode?: UpdateConfigurationByIdInputModeEnum /** - * the URL that the user will be redirected to after the request has been processed; should be provided by the developer of the client application.Required only if mode is Redirect. + * List of allowed URLs to redirect users, including the response from the request. This is required if the selected data-sharing mode is Redirect. * @type {Array} * @memberof UpdateConfigurationByIdInput */ redirectUris?: Array /** - * enables third party IDV provider verification for the given configuration + * Enables identity verification from user with a 3rd-party provider when a verified identity document is not found. * @type {boolean} * @memberof UpdateConfigurationByIdInput */ @@ -1508,13 +1508,13 @@ export interface UpdateConfigurationByIdOK { */ export interface UpdatePexQueryInput { /** - * VP definition in JSON stringify format + * The presentation definition describing the data requirement that must be satisfied by the user. The value is in a JSON stringify format. * @type {string} * @memberof UpdatePexQueryInput */ vpDefinition?: string /** - * + * An optional description of what the query is used for. * @type {string} * @memberof UpdatePexQueryInput */ @@ -1586,8 +1586,7 @@ export const CallbackApiAxiosParamCreator = function ( ) { return { /** - * This endpoint handles callbacks from clients with data from OIDC4VP transactions, including state, presentation submission, and verification tokens. It updates the flow status based on the provided state and communicates the outcome through MQTT, ensuring the transaction\'s completion or notifying of any errors. - * @summary Processes the callback for OIDC4VP flows + * It handles the client\'s (e.g., Affinidi Vault) callback about the result of the data-sharing request. It may contain the data shared by the user, including the presentation submission, verification token, and state. Using the MQTT protocol, it communicates the completion of the request or if any error occurred. * @param {CallbackInput} callbackInput CallbackRequestInput * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1646,8 +1645,7 @@ export const CallbackApiFp = function (configuration?: Configuration) { const localVarAxiosParamCreator = CallbackApiAxiosParamCreator(configuration) return { /** - * This endpoint handles callbacks from clients with data from OIDC4VP transactions, including state, presentation submission, and verification tokens. It updates the flow status based on the provided state and communicates the outcome through MQTT, ensuring the transaction\'s completion or notifying of any errors. - * @summary Processes the callback for OIDC4VP flows + * It handles the client\'s (e.g., Affinidi Vault) callback about the result of the data-sharing request. It may contain the data shared by the user, including the presentation submission, verification token, and state. Using the MQTT protocol, it communicates the completion of the request or if any error occurred. * @param {CallbackInput} callbackInput CallbackRequestInput * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1694,8 +1692,7 @@ export const CallbackApiFactory = function ( const localVarFp = CallbackApiFp(configuration) return { /** - * This endpoint handles callbacks from clients with data from OIDC4VP transactions, including state, presentation submission, and verification tokens. It updates the flow status based on the provided state and communicates the outcome through MQTT, ensuring the transaction\'s completion or notifying of any errors. - * @summary Processes the callback for OIDC4VP flows + * It handles the client\'s (e.g., Affinidi Vault) callback about the result of the data-sharing request. It may contain the data shared by the user, including the presentation submission, verification token, and state. Using the MQTT protocol, it communicates the completion of the request or if any error occurred. * @param {CallbackInput} callbackInput CallbackRequestInput * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1719,8 +1716,7 @@ export const CallbackApiFactory = function ( */ export class CallbackApi extends BaseAPI { /** - * This endpoint handles callbacks from clients with data from OIDC4VP transactions, including state, presentation submission, and verification tokens. It updates the flow status based on the provided state and communicates the outcome through MQTT, ensuring the transaction\'s completion or notifying of any errors. - * @summary Processes the callback for OIDC4VP flows + * It handles the client\'s (e.g., Affinidi Vault) callback about the result of the data-sharing request. It may contain the data shared by the user, including the presentation submission, verification token, and state. Using the MQTT protocol, it communicates the completion of the request or if any error occurred. * @param {CallbackInput} callbackInput CallbackRequestInput * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1745,7 +1741,7 @@ export const ConfigurationsApiAxiosParamCreator = function ( ) { return { /** - * + * Creates a new Affinidi Iota Framework configuration. * @param {CreateIotaConfigurationInput} createIotaConfigurationInput CreateConfiguration * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1805,8 +1801,8 @@ export const ConfigurationsApiAxiosParamCreator = function ( } }, /** - * - * @param {string} configurationId iotaConfiguration Id + * Deletes an Affinidi Iota Framework configuration by ID. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1861,8 +1857,8 @@ export const ConfigurationsApiAxiosParamCreator = function ( } }, /** - * - * @param {string} configurationId iotaConfiguration Id + * Retrieves the details of an Affinidi Iota Framework configuration. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1917,9 +1913,9 @@ export const ConfigurationsApiAxiosParamCreator = function ( } }, /** - * - * @param {string} projectId project Id - * @param {string} configurationId iotaConfiguration Id + * Retrieves the client metadata of an Affinidi Iota Framework configuration. + * @param {string} projectId The ID of the project. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -1973,7 +1969,7 @@ export const ConfigurationsApiAxiosParamCreator = function ( } }, /** - * + * List all Affinidi Iota Framework configurations. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2018,8 +2014,8 @@ export const ConfigurationsApiAxiosParamCreator = function ( } }, /** - * - * @param {string} configurationId iotaConfiguration Id + * Updates the details of an Affinidi Iota Framework configuration by ID. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {UpdateConfigurationByIdInput} updateConfigurationByIdInput UpdateConfigurationById * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2100,7 +2096,7 @@ export const ConfigurationsApiFp = function (configuration?: Configuration) { ConfigurationsApiAxiosParamCreator(configuration) return { /** - * + * Creates a new Affinidi Iota Framework configuration. * @param {CreateIotaConfigurationInput} createIotaConfigurationInput CreateConfiguration * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2133,8 +2129,8 @@ export const ConfigurationsApiFp = function (configuration?: Configuration) { )(axios, localVarOperationServerBasePath || basePath) }, /** - * - * @param {string} configurationId iotaConfiguration Id + * Deletes an Affinidi Iota Framework configuration by ID. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2163,8 +2159,8 @@ export const ConfigurationsApiFp = function (configuration?: Configuration) { )(axios, localVarOperationServerBasePath || basePath) }, /** - * - * @param {string} configurationId iotaConfiguration Id + * Retrieves the details of an Affinidi Iota Framework configuration. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2196,9 +2192,9 @@ export const ConfigurationsApiFp = function (configuration?: Configuration) { )(axios, localVarOperationServerBasePath || basePath) }, /** - * - * @param {string} projectId project Id - * @param {string} configurationId iotaConfiguration Id + * Retrieves the client metadata of an Affinidi Iota Framework configuration. + * @param {string} projectId The ID of the project. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2232,7 +2228,7 @@ export const ConfigurationsApiFp = function (configuration?: Configuration) { )(axios, localVarOperationServerBasePath || basePath) }, /** - * + * List all Affinidi Iota Framework configurations. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2260,8 +2256,8 @@ export const ConfigurationsApiFp = function (configuration?: Configuration) { )(axios, localVarOperationServerBasePath || basePath) }, /** - * - * @param {string} configurationId iotaConfiguration Id + * Updates the details of an Affinidi Iota Framework configuration by ID. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {UpdateConfigurationByIdInput} updateConfigurationByIdInput UpdateConfigurationById * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2310,7 +2306,7 @@ export const ConfigurationsApiFactory = function ( const localVarFp = ConfigurationsApiFp(configuration) return { /** - * + * Creates a new Affinidi Iota Framework configuration. * @param {CreateIotaConfigurationInput} createIotaConfigurationInput CreateConfiguration * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2324,8 +2320,8 @@ export const ConfigurationsApiFactory = function ( .then((request) => request(axios, basePath)) }, /** - * - * @param {string} configurationId iotaConfiguration Id + * Deletes an Affinidi Iota Framework configuration by ID. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2338,8 +2334,8 @@ export const ConfigurationsApiFactory = function ( .then((request) => request(axios, basePath)) }, /** - * - * @param {string} configurationId iotaConfiguration Id + * Retrieves the details of an Affinidi Iota Framework configuration. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2352,9 +2348,9 @@ export const ConfigurationsApiFactory = function ( .then((request) => request(axios, basePath)) }, /** - * - * @param {string} projectId project Id - * @param {string} configurationId iotaConfiguration Id + * Retrieves the client metadata of an Affinidi Iota Framework configuration. + * @param {string} projectId The ID of the project. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2368,7 +2364,7 @@ export const ConfigurationsApiFactory = function ( .then((request) => request(axios, basePath)) }, /** - * + * List all Affinidi Iota Framework configurations. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2380,8 +2376,8 @@ export const ConfigurationsApiFactory = function ( .then((request) => request(axios, basePath)) }, /** - * - * @param {string} configurationId iotaConfiguration Id + * Updates the details of an Affinidi Iota Framework configuration by ID. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {UpdateConfigurationByIdInput} updateConfigurationByIdInput UpdateConfigurationById * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2410,7 +2406,7 @@ export const ConfigurationsApiFactory = function ( */ export class ConfigurationsApi extends BaseAPI { /** - * + * Creates a new Affinidi Iota Framework configuration. * @param {CreateIotaConfigurationInput} createIotaConfigurationInput CreateConfiguration * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2426,8 +2422,8 @@ export class ConfigurationsApi extends BaseAPI { } /** - * - * @param {string} configurationId iotaConfiguration Id + * Deletes an Affinidi Iota Framework configuration by ID. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConfigurationsApi @@ -2442,8 +2438,8 @@ export class ConfigurationsApi extends BaseAPI { } /** - * - * @param {string} configurationId iotaConfiguration Id + * Retrieves the details of an Affinidi Iota Framework configuration. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConfigurationsApi @@ -2458,9 +2454,9 @@ export class ConfigurationsApi extends BaseAPI { } /** - * - * @param {string} projectId project Id - * @param {string} configurationId iotaConfiguration Id + * Retrieves the client metadata of an Affinidi Iota Framework configuration. + * @param {string} projectId The ID of the project. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConfigurationsApi @@ -2476,7 +2472,7 @@ export class ConfigurationsApi extends BaseAPI { } /** - * + * List all Affinidi Iota Framework configurations. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConfigurationsApi @@ -2488,8 +2484,8 @@ export class ConfigurationsApi extends BaseAPI { } /** - * - * @param {string} configurationId iotaConfiguration Id + * Updates the details of an Affinidi Iota Framework configuration by ID. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {UpdateConfigurationByIdInput} updateConfigurationByIdInput UpdateConfigurationById * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2519,10 +2515,10 @@ export const DefaultApiAxiosParamCreator = function ( ) { return { /** - * returns a list of logged consents for the project + * Lists all the logged consents for a project. * @param {string} [configurationId] * @param {string} [userId] - * @param {number} [limit] Maximum number of records to fetch in a list + * @param {number} [limit] The maximum number of records to fetch from the list of logged consents. * @param {string} [exclusiveStartKey] The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2598,10 +2594,10 @@ export const DefaultApiFp = function (configuration?: Configuration) { const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration) return { /** - * returns a list of logged consents for the project + * Lists all the logged consents for a project. * @param {string} [configurationId] * @param {string} [userId] - * @param {number} [limit] Maximum number of records to fetch in a list + * @param {number} [limit] The maximum number of records to fetch from the list of logged consents. * @param {string} [exclusiveStartKey] The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2654,10 +2650,10 @@ export const DefaultApiFactory = function ( const localVarFp = DefaultApiFp(configuration) return { /** - * returns a list of logged consents for the project + * Lists all the logged consents for a project. * @param {string} [configurationId] * @param {string} [userId] - * @param {number} [limit] Maximum number of records to fetch in a list + * @param {number} [limit] The maximum number of records to fetch from the list of logged consents. * @param {string} [exclusiveStartKey] The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2690,10 +2686,10 @@ export const DefaultApiFactory = function ( */ export class DefaultApi extends BaseAPI { /** - * returns a list of logged consents for the project + * Lists all the logged consents for a project. * @param {string} [configurationId] * @param {string} [userId] - * @param {number} [limit] Maximum number of records to fetch in a list + * @param {number} [limit] The maximum number of records to fetch from the list of logged consents. * @param {string} [exclusiveStartKey] The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2727,7 +2723,7 @@ export const IotaApiAxiosParamCreator = function ( ) { return { /** - * It exchanges limited token into cognito + * Exchange a limited-scoped token into a Cognito credential to generate the identity credential. The identity credential initiates the secure WebSocket connection from the client. This method is used only in WebSocket data-sharing mode. * @param {AwsExchangeCredentials} awsExchangeCredentials AwsExchangeCredentials * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2780,7 +2776,7 @@ export const IotaApiAxiosParamCreator = function ( } }, /** - * It exchanges project token into cognito + * Exchange a Project Scoped Token into an identity credential directly to initiate a secure WebSocket connection. This method is used only in WebSocket data-sharing mode. * @param {AwsExchangeCredentialsProjectToken} awsExchangeCredentialsProjectToken AwsExchangeCredentialsProjectToken * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2840,7 +2836,7 @@ export const IotaApiAxiosParamCreator = function ( } }, /** - * This will get the final data response + * Fetches the client\'s callback that contains the user\'s shared data in a Verifiable Presentation format after a successful data-sharing flow. * @param {FetchIOTAVPResponseInput} fetchIOTAVPResponseInput FetchIOTAVPResponseInput * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2900,7 +2896,7 @@ export const IotaApiAxiosParamCreator = function ( } }, /** - * This will initiate data sharing request for the data sharing flow + * Generates the request token for the Redirect mode to initiate the data-sharing flow. * @param {InitiateDataSharingRequestInput} initiateDataSharingRequestInput InitiateDataSharingRequestInput * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2960,7 +2956,7 @@ export const IotaApiAxiosParamCreator = function ( } }, /** - * It exchanges limited token into cognito sts identity credentials + * Exchange a limited-scoped token into an identity credential directly to initiate a secure WebSocket connection. This method is used only in WebSocket data-sharing mode. * @param {IotaExchangeCredentials} iotaExchangeCredentials IotaAwsExchangeCredentials * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3023,7 +3019,7 @@ export const IotaApiFp = function (configuration?: Configuration) { const localVarAxiosParamCreator = IotaApiAxiosParamCreator(configuration) return { /** - * It exchanges limited token into cognito + * Exchange a limited-scoped token into a Cognito credential to generate the identity credential. The identity credential initiates the secure WebSocket connection from the client. This method is used only in WebSocket data-sharing mode. * @param {AwsExchangeCredentials} awsExchangeCredentials AwsExchangeCredentials * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3056,7 +3052,7 @@ export const IotaApiFp = function (configuration?: Configuration) { )(axios, localVarOperationServerBasePath || basePath) }, /** - * It exchanges project token into cognito + * Exchange a Project Scoped Token into an identity credential directly to initiate a secure WebSocket connection. This method is used only in WebSocket data-sharing mode. * @param {AwsExchangeCredentialsProjectToken} awsExchangeCredentialsProjectToken AwsExchangeCredentialsProjectToken * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3089,7 +3085,7 @@ export const IotaApiFp = function (configuration?: Configuration) { )(axios, localVarOperationServerBasePath || basePath) }, /** - * This will get the final data response + * Fetches the client\'s callback that contains the user\'s shared data in a Verifiable Presentation format after a successful data-sharing flow. * @param {FetchIOTAVPResponseInput} fetchIOTAVPResponseInput FetchIOTAVPResponseInput * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3122,7 +3118,7 @@ export const IotaApiFp = function (configuration?: Configuration) { )(axios, localVarOperationServerBasePath || basePath) }, /** - * This will initiate data sharing request for the data sharing flow + * Generates the request token for the Redirect mode to initiate the data-sharing flow. * @param {InitiateDataSharingRequestInput} initiateDataSharingRequestInput InitiateDataSharingRequestInput * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3155,7 +3151,7 @@ export const IotaApiFp = function (configuration?: Configuration) { )(axios, localVarOperationServerBasePath || basePath) }, /** - * It exchanges limited token into cognito sts identity credentials + * Exchange a limited-scoped token into an identity credential directly to initiate a secure WebSocket connection. This method is used only in WebSocket data-sharing mode. * @param {IotaExchangeCredentials} iotaExchangeCredentials IotaAwsExchangeCredentials * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3202,7 +3198,7 @@ export const IotaApiFactory = function ( const localVarFp = IotaApiFp(configuration) return { /** - * It exchanges limited token into cognito + * Exchange a limited-scoped token into a Cognito credential to generate the identity credential. The identity credential initiates the secure WebSocket connection from the client. This method is used only in WebSocket data-sharing mode. * @param {AwsExchangeCredentials} awsExchangeCredentials AwsExchangeCredentials * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3216,7 +3212,7 @@ export const IotaApiFactory = function ( .then((request) => request(axios, basePath)) }, /** - * It exchanges project token into cognito + * Exchange a Project Scoped Token into an identity credential directly to initiate a secure WebSocket connection. This method is used only in WebSocket data-sharing mode. * @param {AwsExchangeCredentialsProjectToken} awsExchangeCredentialsProjectToken AwsExchangeCredentialsProjectToken * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3233,7 +3229,7 @@ export const IotaApiFactory = function ( .then((request) => request(axios, basePath)) }, /** - * This will get the final data response + * Fetches the client\'s callback that contains the user\'s shared data in a Verifiable Presentation format after a successful data-sharing flow. * @param {FetchIOTAVPResponseInput} fetchIOTAVPResponseInput FetchIOTAVPResponseInput * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3247,7 +3243,7 @@ export const IotaApiFactory = function ( .then((request) => request(axios, basePath)) }, /** - * This will initiate data sharing request for the data sharing flow + * Generates the request token for the Redirect mode to initiate the data-sharing flow. * @param {InitiateDataSharingRequestInput} initiateDataSharingRequestInput InitiateDataSharingRequestInput * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3261,7 +3257,7 @@ export const IotaApiFactory = function ( .then((request) => request(axios, basePath)) }, /** - * It exchanges limited token into cognito sts identity credentials + * Exchange a limited-scoped token into an identity credential directly to initiate a secure WebSocket connection. This method is used only in WebSocket data-sharing mode. * @param {IotaExchangeCredentials} iotaExchangeCredentials IotaAwsExchangeCredentials * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3285,7 +3281,7 @@ export const IotaApiFactory = function ( */ export class IotaApi extends BaseAPI { /** - * It exchanges limited token into cognito + * Exchange a limited-scoped token into a Cognito credential to generate the identity credential. The identity credential initiates the secure WebSocket connection from the client. This method is used only in WebSocket data-sharing mode. * @param {AwsExchangeCredentials} awsExchangeCredentials AwsExchangeCredentials * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3301,7 +3297,7 @@ export class IotaApi extends BaseAPI { } /** - * It exchanges project token into cognito + * Exchange a Project Scoped Token into an identity credential directly to initiate a secure WebSocket connection. This method is used only in WebSocket data-sharing mode. * @param {AwsExchangeCredentialsProjectToken} awsExchangeCredentialsProjectToken AwsExchangeCredentialsProjectToken * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3320,7 +3316,7 @@ export class IotaApi extends BaseAPI { } /** - * This will get the final data response + * Fetches the client\'s callback that contains the user\'s shared data in a Verifiable Presentation format after a successful data-sharing flow. * @param {FetchIOTAVPResponseInput} fetchIOTAVPResponseInput FetchIOTAVPResponseInput * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3336,7 +3332,7 @@ export class IotaApi extends BaseAPI { } /** - * This will initiate data sharing request for the data sharing flow + * Generates the request token for the Redirect mode to initiate the data-sharing flow. * @param {InitiateDataSharingRequestInput} initiateDataSharingRequestInput InitiateDataSharingRequestInput * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3352,7 +3348,7 @@ export class IotaApi extends BaseAPI { } /** - * It exchanges limited token into cognito sts identity credentials + * Exchange a limited-scoped token into an identity credential directly to initiate a secure WebSocket connection. This method is used only in WebSocket data-sharing mode. * @param {IotaExchangeCredentials} iotaExchangeCredentials IotaAwsExchangeCredentials * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3377,8 +3373,8 @@ export const PexQueryApiAxiosParamCreator = function ( ) { return { /** - * - * @param {string} configurationId iotaConfiguration Id + * Creates a new Presentation Definition in the configuration to query data. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {CreatePexQueryInput} createPexQueryInput CreatePexQuery * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3445,9 +3441,8 @@ export const PexQueryApiAxiosParamCreator = function ( } }, /** - * deletes pex queries - * @summary deletes pex queries - * @param {string} configurationId iotaConfiguration Id + * Deletes all Presentation Definition queries of a configuration. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -3499,9 +3494,9 @@ export const PexQueryApiAxiosParamCreator = function ( } }, /** - * - * @param {string} configurationId iotaConfiguration Id - * @param {string} queryId pex-query Id + * Deletes a Presentation Definition in the configuration by ID. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. + * @param {string} queryId The ID of the query. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -3562,9 +3557,9 @@ export const PexQueryApiAxiosParamCreator = function ( } }, /** - * - * @param {string} configurationId iotaConfiguration Id - * @param {string} queryId pex-query Id + * Retrieves a Presentation Definition in the configuration by ID. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. + * @param {string} queryId The ID of the query. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -3621,8 +3616,8 @@ export const PexQueryApiAxiosParamCreator = function ( } }, /** - * - * @param {string} configurationId iotaConfiguration Id + * Lists all Presentation Definitions in the configuration. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {number} [limit] Maximum number of records to fetch in a list * @param {string} [exclusiveStartKey] The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation. * @param {*} [options] Override http request option. @@ -3686,8 +3681,8 @@ export const PexQueryApiAxiosParamCreator = function ( } }, /** - * saves all pex queries - * @param {string} configurationId iotaConfiguration Id + * Saves all Presentation Definition queries of a configuration. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {SavePexQueriesUpdateInput} savePexQueriesUpdateInput SavePexQueriesInput * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3754,9 +3749,9 @@ export const PexQueryApiAxiosParamCreator = function ( } }, /** - * - * @param {string} configurationId iotaConfiguration Id - * @param {string} queryId pex-query Id + * Updates the Presentation Definition in the configuration by ID. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. + * @param {string} queryId The ID of the query. * @param {UpdatePexQueryInput} updatePexQueryInput UpdatePexQueryById * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3842,8 +3837,8 @@ export const PexQueryApiFp = function (configuration?: Configuration) { const localVarAxiosParamCreator = PexQueryApiAxiosParamCreator(configuration) return { /** - * - * @param {string} configurationId iotaConfiguration Id + * Creates a new Presentation Definition in the configuration to query data. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {CreatePexQueryInput} createPexQueryInput CreatePexQuery * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3874,9 +3869,8 @@ export const PexQueryApiFp = function (configuration?: Configuration) { )(axios, localVarOperationServerBasePath || basePath) }, /** - * deletes pex queries - * @summary deletes pex queries - * @param {string} configurationId iotaConfiguration Id + * Deletes all Presentation Definition queries of a configuration. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -3905,9 +3899,9 @@ export const PexQueryApiFp = function (configuration?: Configuration) { )(axios, localVarOperationServerBasePath || basePath) }, /** - * - * @param {string} configurationId iotaConfiguration Id - * @param {string} queryId pex-query Id + * Deletes a Presentation Definition in the configuration by ID. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. + * @param {string} queryId The ID of the query. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -3938,9 +3932,9 @@ export const PexQueryApiFp = function (configuration?: Configuration) { )(axios, localVarOperationServerBasePath || basePath) }, /** - * - * @param {string} configurationId iotaConfiguration Id - * @param {string} queryId pex-query Id + * Retrieves a Presentation Definition in the configuration by ID. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. + * @param {string} queryId The ID of the query. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -3970,8 +3964,8 @@ export const PexQueryApiFp = function (configuration?: Configuration) { )(axios, localVarOperationServerBasePath || basePath) }, /** - * - * @param {string} configurationId iotaConfiguration Id + * Lists all Presentation Definitions in the configuration. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {number} [limit] Maximum number of records to fetch in a list * @param {string} [exclusiveStartKey] The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation. * @param {*} [options] Override http request option. @@ -4008,8 +4002,8 @@ export const PexQueryApiFp = function (configuration?: Configuration) { )(axios, localVarOperationServerBasePath || basePath) }, /** - * saves all pex queries - * @param {string} configurationId iotaConfiguration Id + * Saves all Presentation Definition queries of a configuration. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {SavePexQueriesUpdateInput} savePexQueriesUpdateInput SavePexQueriesInput * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4040,9 +4034,9 @@ export const PexQueryApiFp = function (configuration?: Configuration) { )(axios, localVarOperationServerBasePath || basePath) }, /** - * - * @param {string} configurationId iotaConfiguration Id - * @param {string} queryId pex-query Id + * Updates the Presentation Definition in the configuration by ID. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. + * @param {string} queryId The ID of the query. * @param {UpdatePexQueryInput} updatePexQueryInput UpdatePexQueryById * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4090,8 +4084,8 @@ export const PexQueryApiFactory = function ( const localVarFp = PexQueryApiFp(configuration) return { /** - * - * @param {string} configurationId iotaConfiguration Id + * Creates a new Presentation Definition in the configuration to query data. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {CreatePexQueryInput} createPexQueryInput CreatePexQuery * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4106,9 +4100,8 @@ export const PexQueryApiFactory = function ( .then((request) => request(axios, basePath)) }, /** - * deletes pex queries - * @summary deletes pex queries - * @param {string} configurationId iotaConfiguration Id + * Deletes all Presentation Definition queries of a configuration. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4121,9 +4114,9 @@ export const PexQueryApiFactory = function ( .then((request) => request(axios, basePath)) }, /** - * - * @param {string} configurationId iotaConfiguration Id - * @param {string} queryId pex-query Id + * Deletes a Presentation Definition in the configuration by ID. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. + * @param {string} queryId The ID of the query. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4137,9 +4130,9 @@ export const PexQueryApiFactory = function ( .then((request) => request(axios, basePath)) }, /** - * - * @param {string} configurationId iotaConfiguration Id - * @param {string} queryId pex-query Id + * Retrieves a Presentation Definition in the configuration by ID. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. + * @param {string} queryId The ID of the query. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4153,8 +4146,8 @@ export const PexQueryApiFactory = function ( .then((request) => request(axios, basePath)) }, /** - * - * @param {string} configurationId iotaConfiguration Id + * Lists all Presentation Definitions in the configuration. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {number} [limit] Maximum number of records to fetch in a list * @param {string} [exclusiveStartKey] The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation. * @param {*} [options] Override http request option. @@ -4171,8 +4164,8 @@ export const PexQueryApiFactory = function ( .then((request) => request(axios, basePath)) }, /** - * saves all pex queries - * @param {string} configurationId iotaConfiguration Id + * Saves all Presentation Definition queries of a configuration. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {SavePexQueriesUpdateInput} savePexQueriesUpdateInput SavePexQueriesInput * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4187,9 +4180,9 @@ export const PexQueryApiFactory = function ( .then((request) => request(axios, basePath)) }, /** - * - * @param {string} configurationId iotaConfiguration Id - * @param {string} queryId pex-query Id + * Updates the Presentation Definition in the configuration by ID. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. + * @param {string} queryId The ID of the query. * @param {UpdatePexQueryInput} updatePexQueryInput UpdatePexQueryById * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4220,8 +4213,8 @@ export const PexQueryApiFactory = function ( */ export class PexQueryApi extends BaseAPI { /** - * - * @param {string} configurationId iotaConfiguration Id + * Creates a new Presentation Definition in the configuration to query data. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {CreatePexQueryInput} createPexQueryInput CreatePexQuery * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4238,9 +4231,8 @@ export class PexQueryApi extends BaseAPI { } /** - * deletes pex queries - * @summary deletes pex queries - * @param {string} configurationId iotaConfiguration Id + * Deletes all Presentation Definition queries of a configuration. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PexQueryApi @@ -4255,9 +4247,9 @@ export class PexQueryApi extends BaseAPI { } /** - * - * @param {string} configurationId iotaConfiguration Id - * @param {string} queryId pex-query Id + * Deletes a Presentation Definition in the configuration by ID. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. + * @param {string} queryId The ID of the query. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PexQueryApi @@ -4273,9 +4265,9 @@ export class PexQueryApi extends BaseAPI { } /** - * - * @param {string} configurationId iotaConfiguration Id - * @param {string} queryId pex-query Id + * Retrieves a Presentation Definition in the configuration by ID. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. + * @param {string} queryId The ID of the query. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PexQueryApi @@ -4291,8 +4283,8 @@ export class PexQueryApi extends BaseAPI { } /** - * - * @param {string} configurationId iotaConfiguration Id + * Lists all Presentation Definitions in the configuration. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {number} [limit] Maximum number of records to fetch in a list * @param {string} [exclusiveStartKey] The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation. * @param {*} [options] Override http request option. @@ -4311,8 +4303,8 @@ export class PexQueryApi extends BaseAPI { } /** - * saves all pex queries - * @param {string} configurationId iotaConfiguration Id + * Saves all Presentation Definition queries of a configuration. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. * @param {SavePexQueriesUpdateInput} savePexQueriesUpdateInput SavePexQueriesInput * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4329,9 +4321,9 @@ export class PexQueryApi extends BaseAPI { } /** - * - * @param {string} configurationId iotaConfiguration Id - * @param {string} queryId pex-query Id + * Updates the Presentation Definition in the configuration by ID. + * @param {string} configurationId ID of the Affinidi Iota Framework configuration. + * @param {string} queryId The ID of the query. * @param {UpdatePexQueryInput} updatePexQueryInput UpdatePexQueryById * @param {*} [options] Override http request option. * @throws {RequiredError} diff --git a/clients/typescript/iota-client/docs/Apis/CallbackApi.md b/clients/typescript/iota-client/docs/Apis/CallbackApi.md index 72fb6447..881fe080 100644 --- a/clients/typescript/iota-client/docs/Apis/CallbackApi.md +++ b/clients/typescript/iota-client/docs/Apis/CallbackApi.md @@ -2,9 +2,9 @@ All URIs are relative to *https://apse1.api.affinidi.io/ais* -| Method | HTTP request | Description | -| ----------------------------------------------------------- | --------------------- | ---------------------------------------- | -| [**iotOIDC4VPCallback**](CallbackApi.md#iotOIDC4VPCallback) | **POST** /v1/callback | Processes the callback for OIDC4VP flows | +| Method | HTTP request | Description | +| ----------------------------------------------------------- | --------------------- | ----------- | +| [**iotOIDC4VPCallback**](CallbackApi.md#iotOIDC4VPCallback) | **POST** /v1/callback | | @@ -12,9 +12,7 @@ All URIs are relative to *https://apse1.api.affinidi.io/ais* > CallbackResponseOK iotOIDC4VPCallback(CallbackInput) -Processes the callback for OIDC4VP flows - - This endpoint handles callbacks from clients with data from OIDC4VP transactions, including state, presentation submission, and verification tokens. It updates the flow status based on the provided state and communicates the outcome through MQTT, ensuring the transaction's completion or notifying of any errors. + It handles the client's (e.g., Affinidi Vault) callback about the result of the data-sharing request. It may contain the data shared by the user, including the presentation submission, verification token, and state. Using the MQTT protocol, it communicates the completion of the request or if any error occurred. ### Parameters diff --git a/clients/typescript/iota-client/docs/Apis/ConfigurationsApi.md b/clients/typescript/iota-client/docs/Apis/ConfigurationsApi.md index f16e4894..f49294bf 100644 --- a/clients/typescript/iota-client/docs/Apis/ConfigurationsApi.md +++ b/clients/typescript/iota-client/docs/Apis/ConfigurationsApi.md @@ -17,6 +17,8 @@ All URIs are relative to *https://apse1.api.affinidi.io/ais* > IotaConfigurationDto createIotaConfiguration(CreateIotaConfigurationInput) + Creates a new Affinidi Iota Framework configuration. + ### Parameters | Name | Type | Description | Notes | @@ -42,11 +44,13 @@ All URIs are relative to *https://apse1.api.affinidi.io/ais* > deleteIotaConfigurationById(configurationId) + Deletes an Affinidi Iota Framework configuration by ID. + ### Parameters -| Name | Type | Description | Notes | -| ------------------- | ---------- | -------------------- | ----------------- | -| **configurationId** | **String** | iotaConfiguration Id | [default to null] | +| Name | Type | Description | Notes | +| ------------------- | ---------- | ------------------------------------------------ | ----------------- | +| **configurationId** | **String** | ID of the Affinidi Iota Framework configuration. | [default to null] | ### Return type @@ -67,11 +71,13 @@ null (empty response body) > IotaConfigurationDto getIotaConfigurationById(configurationId) + Retrieves the details of an Affinidi Iota Framework configuration. + ### Parameters -| Name | Type | Description | Notes | -| ------------------- | ---------- | -------------------- | ----------------- | -| **configurationId** | **String** | iotaConfiguration Id | [default to null] | +| Name | Type | Description | Notes | +| ------------------- | ---------- | ------------------------------------------------ | ----------------- | +| **configurationId** | **String** | ID of the Affinidi Iota Framework configuration. | [default to null] | ### Return type @@ -92,12 +98,14 @@ null (empty response body) > GetIotaConfigurationMetaDataOK getIotaConfigurationMetaData(projectId, configurationId) + Retrieves the client metadata of an Affinidi Iota Framework configuration. + ### Parameters -| Name | Type | Description | Notes | -| ------------------- | ---------- | -------------------- | ----------------- | -| **projectId** | **String** | project Id | [default to null] | -| **configurationId** | **String** | iotaConfiguration Id | [default to null] | +| Name | Type | Description | Notes | +| ------------------- | ---------- | ------------------------------------------------ | ----------------- | +| **projectId** | **String** | The ID of the project. | [default to null] | +| **configurationId** | **String** | ID of the Affinidi Iota Framework configuration. | [default to null] | ### Return type @@ -118,6 +126,8 @@ No authorization required > ListConfigurationOK listIotaConfigurations() + List all Affinidi Iota Framework configurations. + ### Parameters This endpoint does not need any parameter. @@ -141,12 +151,14 @@ This endpoint does not need any parameter. > IotaConfigurationDto updateIotaConfigurationById(configurationId, UpdateConfigurationByIdInput) + Updates the details of an Affinidi Iota Framework configuration by ID. + ### Parameters -| Name | Type | Description | Notes | -| -------------------------------- | ----------------------------------------------------------------------------- | ----------------------- | ----------------- | -| **configurationId** | **String** | iotaConfiguration Id | [default to null] | -| **UpdateConfigurationByIdInput** | [**UpdateConfigurationByIdInput**](../Models/UpdateConfigurationByIdInput.md) | UpdateConfigurationById | | +| Name | Type | Description | Notes | +| -------------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------ | ----------------- | +| **configurationId** | **String** | ID of the Affinidi Iota Framework configuration. | [default to null] | +| **UpdateConfigurationByIdInput** | [**UpdateConfigurationByIdInput**](../Models/UpdateConfigurationByIdInput.md) | UpdateConfigurationById | | ### Return type diff --git a/clients/typescript/iota-client/docs/Apis/DefaultApi.md b/clients/typescript/iota-client/docs/Apis/DefaultApi.md index 0b6ccb64..743ceafb 100644 --- a/clients/typescript/iota-client/docs/Apis/DefaultApi.md +++ b/clients/typescript/iota-client/docs/Apis/DefaultApi.md @@ -12,7 +12,7 @@ All URIs are relative to *https://apse1.api.affinidi.io/ais* > ListLoggedConsentsOK listLoggedConsents(configurationId, userId, limit, exclusiveStartKey) - returns a list of logged consents for the project + Lists all the logged consents for a project. ### Parameters @@ -20,7 +20,7 @@ All URIs are relative to *https://apse1.api.affinidi.io/ais* | --------------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | | **configurationId** | **String** | | [optional] [default to null] | | **userId** | **String** | | [optional] [default to null] | -| **limit** | **Integer** | Maximum number of records to fetch in a list | [optional] [default to null] | +| **limit** | **Integer** | The maximum number of records to fetch from the list of logged consents. | [optional] [default to null] | | **exclusiveStartKey** | **String** | The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation. | [optional] [default to null] | ### Return type diff --git a/clients/typescript/iota-client/docs/Apis/IotaApi.md b/clients/typescript/iota-client/docs/Apis/IotaApi.md index eb4b9560..2efdbc6f 100644 --- a/clients/typescript/iota-client/docs/Apis/IotaApi.md +++ b/clients/typescript/iota-client/docs/Apis/IotaApi.md @@ -16,7 +16,7 @@ All URIs are relative to *https://apse1.api.affinidi.io/ais* > AwsExchangeCredentialsOK awsExchangeCredentials(AwsExchangeCredentials) - It exchanges limited token into cognito + Exchange a limited-scoped token into a Cognito credential to generate the identity credential. The identity credential initiates the secure WebSocket connection from the client. This method is used only in WebSocket data-sharing mode. ### Parameters @@ -43,7 +43,7 @@ No authorization required > IotaExchangeCredentialsOK awsExchangeCredentialsProjectToken(AwsExchangeCredentialsProjectToken) - It exchanges project token into cognito + Exchange a Project Scoped Token into an identity credential directly to initiate a secure WebSocket connection. This method is used only in WebSocket data-sharing mode. ### Parameters @@ -70,7 +70,7 @@ No authorization required > FetchIOTAVPResponseOK fetchIotaVpResponse(FetchIOTAVPResponseInput) - This will get the final data response + Fetches the client's callback that contains the user's shared data in a Verifiable Presentation format after a successful data-sharing flow. ### Parameters @@ -97,7 +97,7 @@ No authorization required > InitiateDataSharingRequestOK initiateDataSharingRequest(InitiateDataSharingRequestInput) - This will initiate data sharing request for the data sharing flow + Generates the request token for the Redirect mode to initiate the data-sharing flow. ### Parameters @@ -124,7 +124,7 @@ No authorization required > IotaExchangeCredentialsOK iotaExchangeCredentials(IotaExchangeCredentials) - It exchanges limited token into cognito sts identity credentials + Exchange a limited-scoped token into an identity credential directly to initiate a secure WebSocket connection. This method is used only in WebSocket data-sharing mode. ### Parameters diff --git a/clients/typescript/iota-client/docs/Apis/PexQueryApi.md b/clients/typescript/iota-client/docs/Apis/PexQueryApi.md index ba78c861..b83403b5 100644 --- a/clients/typescript/iota-client/docs/Apis/PexQueryApi.md +++ b/clients/typescript/iota-client/docs/Apis/PexQueryApi.md @@ -2,15 +2,15 @@ All URIs are relative to *https://apse1.api.affinidi.io/ais* -| Method | HTTP request | Description | -| ----------------------------------------------------------- | --------------------------------------------------------------------- | ------------------- | -| [**createPexQuery**](PexQueryApi.md#createPexQuery) | **POST** /v1/configurations/{configurationId}/pex-queries | | -| [**deletePexQueries**](PexQueryApi.md#deletePexQueries) | **POST** /v1/configurations/{configurationId}/delete-queries | deletes pex queries | -| [**deletePexQueryById**](PexQueryApi.md#deletePexQueryById) | **DELETE** /v1/configurations/{configurationId}/pex-queries/{queryId} | | -| [**getPexQueryById**](PexQueryApi.md#getPexQueryById) | **GET** /v1/configurations/{configurationId}/pex-queries/{queryId} | | -| [**listPexQueries**](PexQueryApi.md#listPexQueries) | **GET** /v1/configurations/{configurationId}/pex-queries | | -| [**savePexQueries**](PexQueryApi.md#savePexQueries) | **POST** /v1/configurations/{configurationId}/save-queries | | -| [**updatePexQueryById**](PexQueryApi.md#updatePexQueryById) | **PATCH** /v1/configurations/{configurationId}/pex-queries/{queryId} | | +| Method | HTTP request | Description | +| ----------------------------------------------------------- | --------------------------------------------------------------------- | ----------- | +| [**createPexQuery**](PexQueryApi.md#createPexQuery) | **POST** /v1/configurations/{configurationId}/pex-queries | | +| [**deletePexQueries**](PexQueryApi.md#deletePexQueries) | **POST** /v1/configurations/{configurationId}/delete-queries | | +| [**deletePexQueryById**](PexQueryApi.md#deletePexQueryById) | **DELETE** /v1/configurations/{configurationId}/pex-queries/{queryId} | | +| [**getPexQueryById**](PexQueryApi.md#getPexQueryById) | **GET** /v1/configurations/{configurationId}/pex-queries/{queryId} | | +| [**listPexQueries**](PexQueryApi.md#listPexQueries) | **GET** /v1/configurations/{configurationId}/pex-queries | | +| [**savePexQueries**](PexQueryApi.md#savePexQueries) | **POST** /v1/configurations/{configurationId}/save-queries | | +| [**updatePexQueryById**](PexQueryApi.md#updatePexQueryById) | **PATCH** /v1/configurations/{configurationId}/pex-queries/{queryId} | | @@ -18,12 +18,14 @@ All URIs are relative to *https://apse1.api.affinidi.io/ais* > PexQueryDto createPexQuery(configurationId, CreatePexQueryInput) + Creates a new Presentation Definition in the configuration to query data. + ### Parameters -| Name | Type | Description | Notes | -| ----------------------- | ----------------------------------------------------------- | -------------------- | ----------------- | -| **configurationId** | **String** | iotaConfiguration Id | [default to null] | -| **CreatePexQueryInput** | [**CreatePexQueryInput**](../Models/CreatePexQueryInput.md) | CreatePexQuery | | +| Name | Type | Description | Notes | +| ----------------------- | ----------------------------------------------------------- | ------------------------------------------------ | ----------------- | +| **configurationId** | **String** | ID of the Affinidi Iota Framework configuration. | [default to null] | +| **CreatePexQueryInput** | [**CreatePexQueryInput**](../Models/CreatePexQueryInput.md) | CreatePexQuery | | ### Return type @@ -44,15 +46,13 @@ All URIs are relative to *https://apse1.api.affinidi.io/ais* > deletePexQueries(configurationId) -deletes pex queries - - deletes pex queries + Deletes all Presentation Definition queries of a configuration. ### Parameters -| Name | Type | Description | Notes | -| ------------------- | ---------- | -------------------- | ----------------- | -| **configurationId** | **String** | iotaConfiguration Id | [default to null] | +| Name | Type | Description | Notes | +| ------------------- | ---------- | ------------------------------------------------ | ----------------- | +| **configurationId** | **String** | ID of the Affinidi Iota Framework configuration. | [default to null] | ### Return type @@ -73,12 +73,14 @@ null (empty response body) > deletePexQueryById(configurationId, queryId) + Deletes a Presentation Definition in the configuration by ID. + ### Parameters -| Name | Type | Description | Notes | -| ------------------- | ---------- | -------------------- | ----------------- | -| **configurationId** | **String** | iotaConfiguration Id | [default to null] | -| **queryId** | **String** | pex-query Id | [default to null] | +| Name | Type | Description | Notes | +| ------------------- | ---------- | ------------------------------------------------ | ----------------- | +| **configurationId** | **String** | ID of the Affinidi Iota Framework configuration. | [default to null] | +| **queryId** | **String** | The ID of the query. | [default to null] | ### Return type @@ -99,12 +101,14 @@ null (empty response body) > PexQueryDto getPexQueryById(configurationId, queryId) + Retrieves a Presentation Definition in the configuration by ID. + ### Parameters -| Name | Type | Description | Notes | -| ------------------- | ---------- | -------------------- | ----------------- | -| **configurationId** | **String** | iotaConfiguration Id | [default to null] | -| **queryId** | **String** | pex-query Id | [default to null] | +| Name | Type | Description | Notes | +| ------------------- | ---------- | ------------------------------------------------ | ----------------- | +| **configurationId** | **String** | ID of the Affinidi Iota Framework configuration. | [default to null] | +| **queryId** | **String** | The ID of the query. | [default to null] | ### Return type @@ -125,11 +129,13 @@ null (empty response body) > ListPexQueriesOK listPexQueries(configurationId, limit, exclusiveStartKey) + Lists all Presentation Definitions in the configuration. + ### Parameters | Name | Type | Description | Notes | | --------------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | -| **configurationId** | **String** | iotaConfiguration Id | [default to null] | +| **configurationId** | **String** | ID of the Affinidi Iota Framework configuration. | [default to null] | | **limit** | **Integer** | Maximum number of records to fetch in a list | [optional] [default to null] | | **exclusiveStartKey** | **String** | The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation. | [optional] [default to null] | @@ -152,14 +158,14 @@ null (empty response body) > Object savePexQueries(configurationId, SavePexQueriesUpdateInput) - saves all pex queries + Saves all Presentation Definition queries of a configuration. ### Parameters -| Name | Type | Description | Notes | -| ----------------------------- | ----------------------------------------------------------------------- | -------------------- | ----------------- | -| **configurationId** | **String** | iotaConfiguration Id | [default to null] | -| **SavePexQueriesUpdateInput** | [**SavePexQueriesUpdateInput**](../Models/SavePexQueriesUpdateInput.md) | SavePexQueriesInput | | +| Name | Type | Description | Notes | +| ----------------------------- | ----------------------------------------------------------------------- | ------------------------------------------------ | ----------------- | +| **configurationId** | **String** | ID of the Affinidi Iota Framework configuration. | [default to null] | +| **SavePexQueriesUpdateInput** | [**SavePexQueriesUpdateInput**](../Models/SavePexQueriesUpdateInput.md) | SavePexQueriesInput | | ### Return type @@ -180,13 +186,15 @@ null (empty response body) > PexQueryDto updatePexQueryById(configurationId, queryId, UpdatePexQueryInput) + Updates the Presentation Definition in the configuration by ID. + ### Parameters -| Name | Type | Description | Notes | -| ----------------------- | ----------------------------------------------------------- | -------------------- | ----------------- | -| **configurationId** | **String** | iotaConfiguration Id | [default to null] | -| **queryId** | **String** | pex-query Id | [default to null] | -| **UpdatePexQueryInput** | [**UpdatePexQueryInput**](../Models/UpdatePexQueryInput.md) | UpdatePexQueryById | | +| Name | Type | Description | Notes | +| ----------------------- | ----------------------------------------------------------- | ------------------------------------------------ | ----------------- | +| **configurationId** | **String** | ID of the Affinidi Iota Framework configuration. | [default to null] | +| **queryId** | **String** | The ID of the query. | [default to null] | +| **UpdatePexQueryInput** | [**UpdatePexQueryInput**](../Models/UpdatePexQueryInput.md) | UpdatePexQueryById | | ### Return type diff --git a/clients/typescript/iota-client/docs/Models/AwsExchangeCredentials.md b/clients/typescript/iota-client/docs/Models/AwsExchangeCredentials.md index b1d39334..892c3928 100644 --- a/clients/typescript/iota-client/docs/Models/AwsExchangeCredentials.md +++ b/clients/typescript/iota-client/docs/Models/AwsExchangeCredentials.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ------------- | ---------- | ------------------------------------------------------------------------ | ----------------- | -| **assertion** | **String** | JWT signed with a machine token used to secure the web socket connection | [default to null] | +| Name | Type | Description | Notes | +| ------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | +| **assertion** | **String** | A valid JSON Web Token (JWT) that secures the WebSocket connection. The JWT is signed with the key pair's private key used to create the Personal Access Token (PAT). | [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/typescript/iota-client/docs/Models/AwsExchangeCredentialsProjectToken.md b/clients/typescript/iota-client/docs/Models/AwsExchangeCredentialsProjectToken.md index 488e67ec..b0c73735 100644 --- a/clients/typescript/iota-client/docs/Models/AwsExchangeCredentialsProjectToken.md +++ b/clients/typescript/iota-client/docs/Models/AwsExchangeCredentialsProjectToken.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ------------------- | ---------- | ----------------------------- | ----------------- | -| **sessionId** | **String** | sessionId generated by client | [default to null] | -| **configurationId** | **String** | iotaConfiguration Id | [default to null] | -| **did** | **String** | Vault DID of the user | [default to null] | +| Name | Type | Description | Notes | +| ------------------- | ---------- | ------------------------------------------------ | ----------------- | +| **sessionId** | **String** | ID of the session generated by a client. | [default to null] | +| **configurationId** | **String** | ID of the Affinidi Iota Framework configuration. | [default to null] | +| **did** | **String** | The Decentalised Identifier (DID) of the user. | [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/typescript/iota-client/docs/Models/CallbackInput.md b/clients/typescript/iota-client/docs/Models/CallbackInput.md index a4141828..0d286e49 100644 --- a/clients/typescript/iota-client/docs/Models/CallbackInput.md +++ b/clients/typescript/iota-client/docs/Models/CallbackInput.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| --------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------ | ---------------------------- | -| **state** | **String** | A string that must be a valid UUID (version 1-5). | [default to null] | -| **presentation_submission** | **String** | A string that must be a valid JSON object. The structure of presentation submission should follow OID4VP standard. | [optional] [default to null] | -| **vp_token** | **String** | A string that must be a valid JSON object. Ensure to escape special characters properly.. | [optional] [default to null] | -| **error** | **String** | The error should follow the OAuth2 error format (e.g. invalid_request, login_required). Defaults to access_denied | [optional] [default to null] | -| **error_description** | **String** | Description of the error in a human readable format | [optional] [default to null] | -| **onboarded** | **Boolean** | Specifies whether the Iota share triggered the creation of a Vault | [optional] [default to null] | +| Name | Type | Description | Notes | +| --------------------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | +| **state** | **String** | A randomly generated string that follows a valid UUID (version 1-5) format to validate the session. | [default to null] | +| **presentation_submission** | **String** | A JSON string format that describes the link between the Verifiable Presentation and Presentation Definition for the verifier. The presentation submission follows the OID4VP standard. | [optional] [default to null] | +| **vp_token** | **String** | A JSON string format containing the data the user consented to share in a Verifiable Presentation format. The VP Token follows the OID4VP standard. | [optional] [default to null] | +| **error** | **String** | A short string indicating the error code reported by the service. It follows the OAuth 2.0 error code format (e.g., invalid_request, access_denied). The default is access_denied. | [optional] [default to null] | +| **error_description** | **String** | A human-readable description that provides detailed information about the error. | [optional] [default to null] | +| **onboarded** | **Boolean** | It specifies whether the data sharing flow triggered an onboarding process to the Affinidi Vault [New User]. | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/typescript/iota-client/docs/Models/CallbackResponseOK.md b/clients/typescript/iota-client/docs/Models/CallbackResponseOK.md index 9047cc92..664595ae 100644 --- a/clients/typescript/iota-client/docs/Models/CallbackResponseOK.md +++ b/clients/typescript/iota-client/docs/Models/CallbackResponseOK.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ----------------- | ---------- | ----------------------------------------------------------------- | ---------------------------- | -| **redirect_uri** | **String** | URL to which vault will redirect | [optional] [default to null] | -| **response_code** | **String** | Code which will be used along with transactionId to retrieve data | [optional] [default to null] | -| **message** | **String** | A message to vault that flow is updated successfully | [default to null] | +| Name | Type | Description | Notes | +| ----------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | +| **redirect_uri** | **String** | The URL to which Affinidi Vault will redirect the user. | [optional] [default to null] | +| **response_code** | **String** | A unique identifier to fetch the callback response data. Send this value together with the transactionId to successfully fetch the data. | [optional] [default to null] | +| **message** | **String** | A message to the Affinidi Vault indicating that the update was successful. | [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/typescript/iota-client/docs/Models/ConsentDto.md b/clients/typescript/iota-client/docs/Models/ConsentDto.md index cbe14d55..9d0a1dd1 100644 --- a/clients/typescript/iota-client/docs/Models/ConsentDto.md +++ b/clients/typescript/iota-client/docs/Models/ConsentDto.md @@ -2,16 +2,16 @@ ## Properties -| Name | Type | Description | Notes | -| -------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | -| **projectId** | **String** | | [default to null] | -| **id** | **String** | id of the record | [default to null] | -| **userId** | **String** | unique identifier of the user | [default to null] | -| **vcType** | **String** | VC type of shared vc. If the actual VC has several VC types (excluding base types as VerifiableCredential) then for each of the a separate record will be added | [default to null] | -| **status** | **String** | | [default to null] | -| **modifiedAt** | **String** | | [default to null] | -| **modifiedBy** | **String** | | [default to null] | -| **createdAt** | **String** | | [default to null] | -| **createdBy** | **String** | | [default to null] | +| Name | Type | Description | Notes | +| -------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | +| **projectId** | **String** | The ID of the project. | [default to null] | +| **id** | **String** | Unique identifier for the record. | [default to null] | +| **userId** | **String** | Unique identifier for the user. | [default to null] | +| **vcType** | **String** | Type of the VC shared by the user. It creates a consent record for each VC type shared except for the base type VerifiableCredential. | [default to null] | +| **status** | **String** | Status of the consent. | [default to null] | +| **modifiedAt** | **String** | | [default to null] | +| **modifiedBy** | **String** | | [default to null] | +| **createdAt** | **String** | | [default to null] | +| **createdBy** | **String** | | [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/typescript/iota-client/docs/Models/CreateIotaConfigurationInput.md b/clients/typescript/iota-client/docs/Models/CreateIotaConfigurationInput.md index fc31cbc2..fb8e75e2 100644 --- a/clients/typescript/iota-client/docs/Models/CreateIotaConfigurationInput.md +++ b/clients/typescript/iota-client/docs/Models/CreateIotaConfigurationInput.md @@ -2,18 +2,18 @@ ## Properties -| Name | Type | Description | Notes | -| -------------------------- | --------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | -| **name** | **String** | The name of the configuration | [default to null] | -| **description** | **String** | Description of the configuration | [optional] [default to null] | -| **walletAri** | **String** | The wallet Ari that will be used to sign | [default to null] | -| **iotaResponseWebhookURL** | **String** | webhook to call when data is ready | [optional] [default to null] | -| **enableVerification** | **Boolean** | | [default to null] | -| **enableConsentAuditLog** | **Boolean** | | [default to null] | -| **tokenMaxAge** | **BigDecimal** | token time to live in seconds | [optional] [default to null] | -| **clientMetadata** | [**IotaConfigurationDto_clientMetadata**](IotaConfigurationDto_clientMetadata.md) | | [default to null] | -| **mode** | **String** | indicates whether the flow is a WebSocket flow or a Redirect flow. This value is used in Vault to determine how to process the data flow request. | [optional] [default to websocket] | -| **redirectUris** | **List** | the URL that the user will be redirected to after the request has been processed; should be provided by the developer of the client application.Required only if mode is Redirect. | [optional] [default to null] | -| **enableIdvProviders** | **Boolean** | enables third party IDV provider verification for the given configuration | [optional] [default to null] | +| Name | Type | Description | Notes | +| -------------------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------- | +| **name** | **String** | The name of the configuration to quickly identify the resource. | [default to null] | +| **description** | **String** | An optional description of what the configuration is used for. | [optional] [default to null] | +| **walletAri** | **String** | The unique resource identifier of the Wallet used to sign the request token. | [default to null] | +| **iotaResponseWebhookURL** | **String** | The webhook URL is used for callback when the data is ready. | [optional] [default to null] | +| **enableVerification** | **Boolean** | Cryptographically verifies the data shared by the user when enabled. | [default to null] | +| **enableConsentAuditLog** | **Boolean** | Records the user's consent when they share their data, including the type of data shared when enabled. | [default to null] | +| **tokenMaxAge** | **BigDecimal** | This is the lifetime of the signed request token during the data-sharing flow. | [optional] [default to null] | +| **clientMetadata** | [**IotaConfigurationDto_clientMetadata**](IotaConfigurationDto_clientMetadata.md) | | [default to null] | +| **mode** | **String** | Determines whether to handle the data-sharing request using the WebSocket or Redirect flow. | [optional] [default to websocket] | +| **redirectUris** | **List** | List of allowed URLs to redirect users, including the response from the request. This is required if the selected data-sharing mode is Redirect. | [optional] [default to null] | +| **enableIdvProviders** | **Boolean** | Enables identity verification from user with a 3rd-party provider when a verified identity document is not found. | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/typescript/iota-client/docs/Models/CreatePexQueryInput.md b/clients/typescript/iota-client/docs/Models/CreatePexQueryInput.md index 6a1cdd49..cb71c0b1 100644 --- a/clients/typescript/iota-client/docs/Models/CreatePexQueryInput.md +++ b/clients/typescript/iota-client/docs/Models/CreatePexQueryInput.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---------------- | ---------- | -------------------------------------- | ---------------------------- | -| **name** | **String** | | [default to null] | -| **vpDefinition** | **String** | VP definition in JSON stringify format | [default to null] | -| **description** | **String** | Description of query | [optional] [default to null] | +| Name | Type | Description | Notes | +| ---------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | +| **name** | **String** | The name of the presentation definition to quickly identify the query. | [default to null] | +| **vpDefinition** | **String** | The presentation definition describing the data requirement that must be satisfied by the user. The value is in a JSON stringify format. | [default to null] | +| **description** | **String** | An optional description of what the query is used for. | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/typescript/iota-client/docs/Models/FetchIOTAVPResponseInput.md b/clients/typescript/iota-client/docs/Models/FetchIOTAVPResponseInput.md index ff6589aa..695a2337 100644 --- a/clients/typescript/iota-client/docs/Models/FetchIOTAVPResponseInput.md +++ b/clients/typescript/iota-client/docs/Models/FetchIOTAVPResponseInput.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ------------------- | ---------- | -------------------- | ----------------- | -| **correlationId** | **String** | The correlation ID | [default to null] | -| **transactionId** | **String** | The transaction ID | [default to null] | -| **responseCode** | **String** | The response code. | [default to null] | -| **configurationId** | **String** | The configuration ID | [default to null] | +| Name | Type | Description | Notes | +| ------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | +| **correlationId** | **String** | A unique, randomly generated identifier that correlates the request and response in the data-sharing request flow. | [default to null] | +| **transactionId** | **String** | A unique, randomly generated identifier data-sharing request flow is initiated. This value is used with the response code to fetch the callback response data. | [default to null] | +| **responseCode** | **String** | A unique identifier to fetch the callback response data. Send this value together with the transactionId to successfully fetch the data. | [default to null] | +| **configurationId** | **String** | ID of the Affinidi Iota Framework configuration. | [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/typescript/iota-client/docs/Models/FetchIOTAVPResponseOK.md b/clients/typescript/iota-client/docs/Models/FetchIOTAVPResponseOK.md index 3baabcbb..d2a1e718 100644 --- a/clients/typescript/iota-client/docs/Models/FetchIOTAVPResponseOK.md +++ b/clients/typescript/iota-client/docs/Models/FetchIOTAVPResponseOK.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| --------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------ | ---------------------------- | -| **correlationId** | **String** | A correlationId used for the flow | [optional] [default to null] | -| **presentation_submission** | **String** | A string that must be a valid JSON object. The structure of presentation submission should follow OID4VP standard. | [optional] [default to null] | -| **vp_token** | **String** | A string that must be a valid JSON object. Ensure to escape special characters properly.. | [optional] [default to null] | +| Name | Type | Description | Notes | +| --------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | +| **correlationId** | **String** | A unique, randomly generated identifier that correlates the request and response in the data-sharing request flow. | [optional] [default to null] | +| **presentation_submission** | **String** | A JSON string format that describes the link between the Verifiable Presentation and Presentation Definition for the verifier. The presentation submission follows the OID4VP standard. | [optional] [default to null] | +| **vp_token** | **String** | A JSON string format containing the data the user consented to share in a Verifiable Presentation format. The VP Token follows the OID4VP standard. | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/typescript/iota-client/docs/Models/GetIotaConfigurationMetaDataOK.md b/clients/typescript/iota-client/docs/Models/GetIotaConfigurationMetaDataOK.md index 867b0602..ef2d9a8e 100644 --- a/clients/typescript/iota-client/docs/Models/GetIotaConfigurationMetaDataOK.md +++ b/clients/typescript/iota-client/docs/Models/GetIotaConfigurationMetaDataOK.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---------- | ---------- | ------------------------------------------------------- | ----------------- | -| **name** | **String** | application name that will be displayed in consent page | [default to null] | -| **origin** | **String** | origin url that will be displayed in consent page | [default to null] | -| **logo** | **String** | logo url that will be displayed in consent page | [default to null] | +| Name | Type | Description | Notes | +| ---------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | +| **name** | **String** | The name displayed on the consent page indicates who is requesting data from the user. It can be the application or website's name. | [default to null] | +| **origin** | **String** | The URL of the requester displayed on the consent page indicates the request's origin. | [default to null] | +| **logo** | **String** | The logo of the requester displayed on the consent page, allowing users to easily recognise who requests the data. | [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/typescript/iota-client/docs/Models/InitiateDataSharingRequestInput.md b/clients/typescript/iota-client/docs/Models/InitiateDataSharingRequestInput.md index acd21603..52e08809 100644 --- a/clients/typescript/iota-client/docs/Models/InitiateDataSharingRequestInput.md +++ b/clients/typescript/iota-client/docs/Models/InitiateDataSharingRequestInput.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| ------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | -| **queryId** | **String** | | [default to null] | -| **correlationId** | **String** | | [default to null] | -| **tokenMaxAge** | **BigDecimal** | token time to live in seconds | [optional] [default to null] | -| **nonce** | **String** | Random value used to prevent replay attacks | [default to null] | -| **redirectUri** | **String** | the URL that the user will be redirected to after the request has been processed; should be provided by the developer of the client application. | [default to null] | -| **configurationId** | **String** | id of the IOTA configuration used | [default to null] | -| **mode** | **String** | indicates whether the flow is a WebSocket flow or a Redirect flow. This value is used in Vault to determine how to process the data flow request. | [default to null] | +| Name | Type | Description | Notes | +| ------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------- | +| **queryId** | **String** | The ID of the query. | [default to null] | +| **correlationId** | **String** | A unique, randomly generated identifier that correlates the request and response in the data-sharing request flow. | [default to null] | +| **tokenMaxAge** | **BigDecimal** | This is the lifetime of the signed request token during the data-sharing flow. | [optional] [default to null] | +| **nonce** | **String** | A randomly generated value that is added in the request and response to prevent replay attacks. | [default to null] | +| **redirectUri** | **String** | List of allowed URLs to redirect users, including the response from the request. This is required if the selected data-sharing mode is Redirect. | [default to null] | +| **configurationId** | **String** | ID of the Affinidi Iota Framework configuration. | [default to null] | +| **mode** | **String** | Determines whether to handle the data-sharing request using the WebSocket or Redirect flow. | [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/typescript/iota-client/docs/Models/IotaConfigurationDto.md b/clients/typescript/iota-client/docs/Models/IotaConfigurationDto.md index 9213e669..092b9a26 100644 --- a/clients/typescript/iota-client/docs/Models/IotaConfigurationDto.md +++ b/clients/typescript/iota-client/docs/Models/IotaConfigurationDto.md @@ -2,20 +2,20 @@ ## Properties -| Name | Type | Description | Notes | -| -------------------------- | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | -| **ari** | **String** | The ARI of the config | [default to null] | -| **configurationId** | **String** | | [default to null] | -| **name** | **String** | The name of the config | [default to null] | -| **projectId** | **String** | | [default to null] | -| **walletAri** | **String** | The wallet Ari that will be used to sign | [default to null] | -| **tokenMaxAge** | **BigDecimal** | token time to live in seconds | [default to null] | -| **iotaResponseWebhookURL** | **String** | webhook to call when data is ready | [optional] [default to null] | -| **enableVerification** | **Boolean** | | [default to null] | -| **enableConsentAuditLog** | **Boolean** | | [default to null] | -| **clientMetadata** | [**IotaConfigurationDto_clientMetadata**](IotaConfigurationDto_clientMetadata.md) | | [default to null] | -| **mode** | **String** | indicates whether the flow is a WebSocket flow or a Redirect flow. This value is used in Vault to determine how to process the data flow request. | [optional] [default to websocket] | -| **redirectUris** | **List** | the URLs that the user will be redirected to after the request has been processed; should be provided by the developer of the client application.Required only if mode is Redirect. | [optional] [default to null] | -| **enableIdvProviders** | **Boolean** | enables third party IDV provider verification for the given configuration | [optional] [default to null] | +| Name | Type | Description | Notes | +| -------------------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------- | +| **ari** | **String** | This is a unique resource identifier of the Affinidi Iota Framework configuration. | [default to null] | +| **configurationId** | **String** | ID of the Affinidi Iota Framework configuration. | [default to null] | +| **name** | **String** | The name of the configuration to quickly identify the resource. | [default to null] | +| **projectId** | **String** | The ID of the project. | [default to null] | +| **walletAri** | **String** | The unique resource identifier of the Wallet used to sign the request token. | [default to null] | +| **tokenMaxAge** | **BigDecimal** | This is the lifetime of the signed request token during the data-sharing flow. | [default to null] | +| **iotaResponseWebhookURL** | **String** | The webhook URL is used for callback when the data is ready. | [optional] [default to null] | +| **enableVerification** | **Boolean** | Cryptographically verifies the data shared by the user when enabled. | [default to null] | +| **enableConsentAuditLog** | **Boolean** | Records the consent the user gave when they shared their data, including the type of data shared. | [default to null] | +| **clientMetadata** | [**IotaConfigurationDto_clientMetadata**](IotaConfigurationDto_clientMetadata.md) | | [default to null] | +| **mode** | **String** | Determines whether to handle the data-sharing request using the WebSocket or Redirect flow. | [optional] [default to websocket] | +| **redirectUris** | **List** | List of allowed URLs to redirect users, including the response from the request. This is required if the selected data-sharing mode is Redirect. | [optional] [default to null] | +| **enableIdvProviders** | **Boolean** | Enables identity verification from user with a 3rd-party provider when a verified identity document is not found. | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/typescript/iota-client/docs/Models/IotaConfigurationDto_clientMetadata.md b/clients/typescript/iota-client/docs/Models/IotaConfigurationDto_clientMetadata.md index 05ed6b77..62760c4a 100644 --- a/clients/typescript/iota-client/docs/Models/IotaConfigurationDto_clientMetadata.md +++ b/clients/typescript/iota-client/docs/Models/IotaConfigurationDto_clientMetadata.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---------- | ---------- | ------------------------------------------------------- | ----------------- | -| **name** | **String** | application name that will be displayed in consent page | [default to null] | -| **origin** | **String** | origin url that will be displayed in consent page | [default to null] | -| **logo** | **String** | logo url that will be displayed in consent page | [default to null] | +| Name | Type | Description | Notes | +| ---------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | +| **name** | **String** | The name displayed on the consent page indicates who is requesting data from the user. It can be the application or website's name. | [default to null] | +| **origin** | **String** | The URL of the requester displayed on the consent page indicates the request's origin. | [default to null] | +| **logo** | **String** | The logo of the requester displayed on the consent page, allowing users to easily recognise who requests the data. | [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/typescript/iota-client/docs/Models/IotaExchangeCredentials.md b/clients/typescript/iota-client/docs/Models/IotaExchangeCredentials.md index a0018f34..16ed84ce 100644 --- a/clients/typescript/iota-client/docs/Models/IotaExchangeCredentials.md +++ b/clients/typescript/iota-client/docs/Models/IotaExchangeCredentials.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ------------- | ---------- | ------------------------------------------------------------------------ | ----------------- | -| **assertion** | **String** | JWT signed with a machine token used to secure the web socket connection | [default to null] | +| Name | Type | Description | Notes | +| ------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | +| **assertion** | **String** | A valid JSON Web Token (JWT) that secures the WebSocket connection. The JWT is signed with the key pair's private key used to create the Personal Access Token (PAT). | [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/typescript/iota-client/docs/Models/PexQueryDto.md b/clients/typescript/iota-client/docs/Models/PexQueryDto.md index 1f6a92ca..765fadb4 100644 --- a/clients/typescript/iota-client/docs/Models/PexQueryDto.md +++ b/clients/typescript/iota-client/docs/Models/PexQueryDto.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| -------------------- | ---------- | -------------------------------------- | ----------------- | -| **ari** | **String** | | [default to null] | -| **queryId** | **String** | | [default to null] | -| **name** | **String** | | [default to null] | -| **description** | **String** | | [default to null] | -| **configurationAri** | **String** | | [default to null] | -| **vpDefinition** | **String** | VP definition in JSON stringify format | [default to null] | +| Name | Type | Description | Notes | +| -------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | +| **ari** | **String** | The unique resource identifier of the qeuery. | [default to null] | +| **queryId** | **String** | The ID of the query. | [default to null] | +| **name** | **String** | The name of the presentation definition to quickly identify the query. | [default to null] | +| **description** | **String** | An optional description of what the query is used for. | [default to null] | +| **configurationAri** | **String** | The unique resource identifier of the related configuration where the query is defined. | [default to null] | +| **vpDefinition** | **String** | The presentation definition describing the data requirement that must be satisfied by the user. The value is in a JSON stringify format. | [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/typescript/iota-client/docs/Models/PrepareRequest.md b/clients/typescript/iota-client/docs/Models/PrepareRequest.md index d31459bc..19ad2181 100644 --- a/clients/typescript/iota-client/docs/Models/PrepareRequest.md +++ b/clients/typescript/iota-client/docs/Models/PrepareRequest.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---------------------- | -------------- | ----------------------------- | ---------------------------- | -| **connectionClientId** | **String** | | [default to null] | -| **queryId** | **String** | | [default to null] | -| **correlationId** | **String** | | [default to null] | -| **tokenMaxAge** | **BigDecimal** | token time to live in seconds | [optional] [default to null] | -| **audience** | **String** | | [optional] [default to null] | +| Name | Type | Description | Notes | +| ---------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------ | ---------------------------- | +| **connectionClientId** | **String** | | [default to null] | +| **queryId** | **String** | | [default to null] | +| **correlationId** | **String** | A unique, randomly generated identifier that correlates the request and response in the data-sharing request flow. | [default to null] | +| **tokenMaxAge** | **BigDecimal** | This is the lifetime of the signed request token during the data-sharing flow. | [optional] [default to null] | +| **audience** | **String** | | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/typescript/iota-client/docs/Models/PrepareRequestCreated_data.md b/clients/typescript/iota-client/docs/Models/PrepareRequestCreated_data.md index 18bb6bf6..eee6b07d 100644 --- a/clients/typescript/iota-client/docs/Models/PrepareRequestCreated_data.md +++ b/clients/typescript/iota-client/docs/Models/PrepareRequestCreated_data.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ----------------- | ---------- | ----------- | ----------------- | -| **jwt** | **String** | | [default to null] | -| **correlationId** | **String** | | [default to null] | +| Name | Type | Description | Notes | +| ----------------- | ---------- | ------------------------------------------------------------------------------------------------------------------ | ----------------- | +| **jwt** | **String** | | [default to null] | +| **correlationId** | **String** | A unique, randomly generated identifier that correlates the request and response in the data-sharing request flow. | [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/typescript/iota-client/docs/Models/SavePexQueriesUpdateInput_queries_inner.md b/clients/typescript/iota-client/docs/Models/SavePexQueriesUpdateInput_queries_inner.md index 5042e5d8..e1ccb2d4 100644 --- a/clients/typescript/iota-client/docs/Models/SavePexQueriesUpdateInput_queries_inner.md +++ b/clients/typescript/iota-client/docs/Models/SavePexQueriesUpdateInput_queries_inner.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---------------- | ---------- | ----------- | ---------------------------- | -| **queryId** | **String** | | [default to null] | -| **vpDefinition** | **String** | | [optional] [default to null] | -| **description** | **String** | | [optional] [default to null] | +| Name | Type | Description | Notes | +| ---------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | +| **queryId** | **String** | The ID of the query. | [default to null] | +| **vpDefinition** | **String** | The presentation definition describing the data requirement that must be satisfied by the user. The value is in a JSON stringify format. | [optional] [default to null] | +| **description** | **String** | An optional description of what the query is used for. | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/typescript/iota-client/docs/Models/UpdateConfigurationByIdInput.md b/clients/typescript/iota-client/docs/Models/UpdateConfigurationByIdInput.md index ecd34a15..0357d6c0 100644 --- a/clients/typescript/iota-client/docs/Models/UpdateConfigurationByIdInput.md +++ b/clients/typescript/iota-client/docs/Models/UpdateConfigurationByIdInput.md @@ -2,18 +2,18 @@ ## Properties -| Name | Type | Description | Notes | -| -------------------------- | --------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | -| **name** | **String** | The name of the config | [optional] [default to null] | -| **walletAri** | **String** | The wallet Ari that will be used to sign | [optional] [default to null] | -| **iotaResponseWebhookURL** | **String** | webhook to call when data is ready | [optional] [default to null] | -| **enableVerification** | **Boolean** | | [optional] [default to null] | -| **enableConsentAuditLog** | **Boolean** | | [optional] [default to null] | -| **tokenMaxAge** | **BigDecimal** | token time to live in seconds | [optional] [default to null] | -| **description** | **String** | The description of the config | [optional] [default to null] | -| **clientMetadata** | [**IotaConfigurationDto_clientMetadata**](IotaConfigurationDto_clientMetadata.md) | | [optional] [default to null] | -| **mode** | **String** | indicates whether the flow is a WebSocket flow or a Redirect flow. This value is used in Vault to determine how to process the data flow request. | [optional] [default to null] | -| **redirectUris** | **List** | the URL that the user will be redirected to after the request has been processed; should be provided by the developer of the client application.Required only if mode is Redirect. | [optional] [default to null] | -| **enableIdvProviders** | **Boolean** | enables third party IDV provider verification for the given configuration | [optional] [default to null] | +| Name | Type | Description | Notes | +| -------------------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------- | +| **name** | **String** | The name of the configuration to quickly identify the resource. | [optional] [default to null] | +| **walletAri** | **String** | The unique resource identifier of the Wallet used to sign the request token. | [optional] [default to null] | +| **iotaResponseWebhookURL** | **String** | The webhook URL is used for callback when the data is ready. | [optional] [default to null] | +| **enableVerification** | **Boolean** | Cryptographically verifies the data shared by the user when enabled. | [optional] [default to null] | +| **enableConsentAuditLog** | **Boolean** | Records the user's consent when they share their data, including the type of data shared when enabled. | [optional] [default to null] | +| **tokenMaxAge** | **BigDecimal** | This is the lifetime of the signed request token during the data-sharing flow. | [optional] [default to null] | +| **description** | **String** | An optional description of what the configuration is used for. | [optional] [default to null] | +| **clientMetadata** | [**IotaConfigurationDto_clientMetadata**](IotaConfigurationDto_clientMetadata.md) | | [optional] [default to null] | +| **mode** | **String** | Determines whether to handle the data-sharing request using the WebSocket or Redirect flow. | [optional] [default to null] | +| **redirectUris** | **List** | List of allowed URLs to redirect users, including the response from the request. This is required if the selected data-sharing mode is Redirect. | [optional] [default to null] | +| **enableIdvProviders** | **Boolean** | Enables identity verification from user with a 3rd-party provider when a verified identity document is not found. | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/typescript/iota-client/docs/Models/UpdatePexQueryInput.md b/clients/typescript/iota-client/docs/Models/UpdatePexQueryInput.md index cfb9a405..0f28c0ea 100644 --- a/clients/typescript/iota-client/docs/Models/UpdatePexQueryInput.md +++ b/clients/typescript/iota-client/docs/Models/UpdatePexQueryInput.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---------------- | ---------- | -------------------------------------- | ---------------------------- | -| **vpDefinition** | **String** | VP definition in JSON stringify format | [optional] [default to null] | -| **description** | **String** | | [optional] [default to null] | +| Name | Type | Description | Notes | +| ---------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | +| **vpDefinition** | **String** | The presentation definition describing the data requirement that must be satisfied by the user. The value is in a JSON stringify format. | [optional] [default to null] | +| **description** | **String** | An optional description of what the query is used for. | [optional] [default to null] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/typescript/iota-client/docs/README.md b/clients/typescript/iota-client/docs/README.md index 2d07b14e..f721b7b0 100644 --- a/clients/typescript/iota-client/docs/README.md +++ b/clients/typescript/iota-client/docs/README.md @@ -6,28 +6,28 @@ All URIs are relative to *https://apse1.api.affinidi.io/ais* -| Class | Method | HTTP request | Description | -| ------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | ----------------------------------------------------------------- | -| _CallbackApi_ | [**iotOIDC4VPCallback**](Apis/CallbackApi.md#iotoidc4vpcallback) | **POST** /v1/callback | Processes the callback for OIDC4VP flows | -| _ConfigurationsApi_ | [**createIotaConfiguration**](Apis/ConfigurationsApi.md#createiotaconfiguration) | **POST** /v1/configurations | | -| _ConfigurationsApi_ | [**deleteIotaConfigurationById**](Apis/ConfigurationsApi.md#deleteiotaconfigurationbyid) | **DELETE** /v1/configurations/{configurationId} | | -| _ConfigurationsApi_ | [**getIotaConfigurationById**](Apis/ConfigurationsApi.md#getiotaconfigurationbyid) | **GET** /v1/configurations/{configurationId} | | -| _ConfigurationsApi_ | [**getIotaConfigurationMetaData**](Apis/ConfigurationsApi.md#getiotaconfigurationmetadata) | **GET** /v1/projects/{projectId}/configurations/{configurationId}/metadata | | -| _ConfigurationsApi_ | [**listIotaConfigurations**](Apis/ConfigurationsApi.md#listiotaconfigurations) | **GET** /v1/configurations | | -| _ConfigurationsApi_ | [**updateIotaConfigurationById**](Apis/ConfigurationsApi.md#updateiotaconfigurationbyid) | **PATCH** /v1/configurations/{configurationId} | | -| _DefaultApi_ | [**listLoggedConsents**](Apis/DefaultApi.md#listloggedconsents) | **GET** /v1/logged-consents | returns a list of logged consents for the project | -| _IotaApi_ | [**awsExchangeCredentials**](Apis/IotaApi.md#awsexchangecredentials) | **POST** /v1/aws-exchange-credentials | It exchanges limited token into cognito | -| _IotaApi_ | [**awsExchangeCredentialsProjectToken**](Apis/IotaApi.md#awsexchangecredentialsprojecttoken) | **POST** /v1/aws-exchange-credentials/project-token | It exchanges project token into cognito | -| _IotaApi_ | [**fetchIotaVpResponse**](Apis/IotaApi.md#fetchiotavpresponse) | **POST** /v1/fetch-iota-response | This will get the final data response | -| _IotaApi_ | [**initiateDataSharingRequest**](Apis/IotaApi.md#initiatedatasharingrequest) | **POST** /v1/initiate-data-sharing-request | This will initiate data sharing request for the data sharing flow | -| _IotaApi_ | [**iotaExchangeCredentials**](Apis/IotaApi.md#iotaexchangecredentials) | **POST** /v1/exchange-credentials | It exchanges limited token into cognito sts identity credentials | -| _PexQueryApi_ | [**createPexQuery**](Apis/PexQueryApi.md#createpexquery) | **POST** /v1/configurations/{configurationId}/pex-queries | | -| _PexQueryApi_ | [**deletePexQueries**](Apis/PexQueryApi.md#deletepexqueries) | **POST** /v1/configurations/{configurationId}/delete-queries | deletes pex queries | -| _PexQueryApi_ | [**deletePexQueryById**](Apis/PexQueryApi.md#deletepexquerybyid) | **DELETE** /v1/configurations/{configurationId}/pex-queries/{queryId} | | -| _PexQueryApi_ | [**getPexQueryById**](Apis/PexQueryApi.md#getpexquerybyid) | **GET** /v1/configurations/{configurationId}/pex-queries/{queryId} | | -| _PexQueryApi_ | [**listPexQueries**](Apis/PexQueryApi.md#listpexqueries) | **GET** /v1/configurations/{configurationId}/pex-queries | | -| _PexQueryApi_ | [**savePexQueries**](Apis/PexQueryApi.md#savepexqueries) | **POST** /v1/configurations/{configurationId}/save-queries | saves all pex queries | -| _PexQueryApi_ | [**updatePexQueryById**](Apis/PexQueryApi.md#updatepexquerybyid) | **PATCH** /v1/configurations/{configurationId}/pex-queries/{queryId} | | +| Class | Method | HTTP request | Description | +| ------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| _CallbackApi_ | [**iotOIDC4VPCallback**](Apis/CallbackApi.md#iotoidc4vpcallback) | **POST** /v1/callback | It handles the client's (e.g., Affinidi Vault) callback about the result of the data-sharing request. It may contain the data shared by the user, including the presentation submission, verification token, and state. Using the MQTT protocol, it communicates the completion of the request or if any error occurred. | +| _ConfigurationsApi_ | [**createIotaConfiguration**](Apis/ConfigurationsApi.md#createiotaconfiguration) | **POST** /v1/configurations | Creates a new Affinidi Iota Framework configuration. | +| _ConfigurationsApi_ | [**deleteIotaConfigurationById**](Apis/ConfigurationsApi.md#deleteiotaconfigurationbyid) | **DELETE** /v1/configurations/{configurationId} | Deletes an Affinidi Iota Framework configuration by ID. | +| _ConfigurationsApi_ | [**getIotaConfigurationById**](Apis/ConfigurationsApi.md#getiotaconfigurationbyid) | **GET** /v1/configurations/{configurationId} | Retrieves the details of an Affinidi Iota Framework configuration. | +| _ConfigurationsApi_ | [**getIotaConfigurationMetaData**](Apis/ConfigurationsApi.md#getiotaconfigurationmetadata) | **GET** /v1/projects/{projectId}/configurations/{configurationId}/metadata | Retrieves the client metadata of an Affinidi Iota Framework configuration. | +| _ConfigurationsApi_ | [**listIotaConfigurations**](Apis/ConfigurationsApi.md#listiotaconfigurations) | **GET** /v1/configurations | List all Affinidi Iota Framework configurations. | +| _ConfigurationsApi_ | [**updateIotaConfigurationById**](Apis/ConfigurationsApi.md#updateiotaconfigurationbyid) | **PATCH** /v1/configurations/{configurationId} | Updates the details of an Affinidi Iota Framework configuration by ID. | +| _DefaultApi_ | [**listLoggedConsents**](Apis/DefaultApi.md#listloggedconsents) | **GET** /v1/logged-consents | Lists all the logged consents for a project. | +| _IotaApi_ | [**awsExchangeCredentials**](Apis/IotaApi.md#awsexchangecredentials) | **POST** /v1/aws-exchange-credentials | Exchange a limited-scoped token into a Cognito credential to generate the identity credential. The identity credential initiates the secure WebSocket connection from the client. This method is used only in WebSocket data-sharing mode. | +| _IotaApi_ | [**awsExchangeCredentialsProjectToken**](Apis/IotaApi.md#awsexchangecredentialsprojecttoken) | **POST** /v1/aws-exchange-credentials/project-token | Exchange a Project Scoped Token into an identity credential directly to initiate a secure WebSocket connection. This method is used only in WebSocket data-sharing mode. | +| _IotaApi_ | [**fetchIotaVpResponse**](Apis/IotaApi.md#fetchiotavpresponse) | **POST** /v1/fetch-iota-response | Fetches the client's callback that contains the user's shared data in a Verifiable Presentation format after a successful data-sharing flow. | +| _IotaApi_ | [**initiateDataSharingRequest**](Apis/IotaApi.md#initiatedatasharingrequest) | **POST** /v1/initiate-data-sharing-request | Generates the request token for the Redirect mode to initiate the data-sharing flow. | +| _IotaApi_ | [**iotaExchangeCredentials**](Apis/IotaApi.md#iotaexchangecredentials) | **POST** /v1/exchange-credentials | Exchange a limited-scoped token into an identity credential directly to initiate a secure WebSocket connection. This method is used only in WebSocket data-sharing mode. | +| _PexQueryApi_ | [**createPexQuery**](Apis/PexQueryApi.md#createpexquery) | **POST** /v1/configurations/{configurationId}/pex-queries | Creates a new Presentation Definition in the configuration to query data. | +| _PexQueryApi_ | [**deletePexQueries**](Apis/PexQueryApi.md#deletepexqueries) | **POST** /v1/configurations/{configurationId}/delete-queries | Deletes all Presentation Definition queries of a configuration. | +| _PexQueryApi_ | [**deletePexQueryById**](Apis/PexQueryApi.md#deletepexquerybyid) | **DELETE** /v1/configurations/{configurationId}/pex-queries/{queryId} | Deletes a Presentation Definition in the configuration by ID. | +| _PexQueryApi_ | [**getPexQueryById**](Apis/PexQueryApi.md#getpexquerybyid) | **GET** /v1/configurations/{configurationId}/pex-queries/{queryId} | Retrieves a Presentation Definition in the configuration by ID. | +| _PexQueryApi_ | [**listPexQueries**](Apis/PexQueryApi.md#listpexqueries) | **GET** /v1/configurations/{configurationId}/pex-queries | Lists all Presentation Definitions in the configuration. | +| _PexQueryApi_ | [**savePexQueries**](Apis/PexQueryApi.md#savepexqueries) | **POST** /v1/configurations/{configurationId}/save-queries | Saves all Presentation Definition queries of a configuration. | +| _PexQueryApi_ | [**updatePexQueryById**](Apis/PexQueryApi.md#updatepexquerybyid) | **PATCH** /v1/configurations/{configurationId}/pex-queries/{queryId} | Updates the Presentation Definition in the configuration by ID. | diff --git a/package-lock.json b/package-lock.json index 371c93ce..daeb6ebc 100644 --- a/package-lock.json +++ b/package-lock.json @@ -47,7 +47,7 @@ }, "clients/typescript/credential-issuance-client": { "name": "@affinidi-tdk/credential-issuance-client", - "version": "1.30.0", + "version": "1.31.0", "license": "Apache-2.0", "dependencies": { "axios": "^1.6.0", @@ -217,7 +217,7 @@ }, "clients/typescript/wallets-client": { "name": "@affinidi-tdk/wallets-client", - "version": "1.29.0", + "version": "1.30.0", "license": "Apache-2.0", "dependencies": { "axios": "^1.6.0",