npm - @meeco/svx-api-sdk - Versions diffs - 1.0.0-develop.20250108184711.803db02 → 1.0.0-develop.20250304125747.40d9c59 - Mend

@meeco/svx-api-sdk 1.0.0-develop.20250108184711.803db02 → 1.0.0-develop.20250304125747.40d9c59

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1099) hide show

package/lib/types/apis/VerifiableCredentialsApi.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * SVX API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.1.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -167,12 +167,12 @@ export declare class VerifiableCredentialsApi extends runtime.BaseAPI {
      */
     credentialTypesPost(meecoOrganisationID: string, vCCreateCredentialTypePayloadDto: VCCreateCredentialTypePayloadDto, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VCCredentialTypeResponseDto>;
     /**
-     * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br /><hr /><p>Generates unsigned verifiable credential token in JWT format. Client is expected to sign it with a private key.</p><hr /><p>An example of credential signing in Javascript:</p><pre><code>import { Ed25519 } from \'@meeco/sdk\'; <br />import { EdDSASigner, hexToBytes } from \'did-jwt\'; <br /><br />const key = new Ed25519(hexToBytes(SEED_HEX)); <br />const signerFn = EdDSASigner(key.getSecretKey()); <br /><br />const signature = await signerFn(unsignedJwt); <br />const vcJwt = [unsignedJwt, signature].join(\'.\');</code></pre><hr /><br /><h4>Issuer property caveat</h4><p>We use <b>openapi-generator</b> to generate Typescript SDK for the given API swagger definition. However, <b>openapi-generator</b> does not support <b>oneOf</b> configuration properly and generates an invalid Typescript SDK. To avoid the problem, swagger defines <b>issuer</b> property only as string for the moment. While in fact, endpoint accepts issuer as an object in format of <code>{id: string; name: string;}</code> as well.</p><br /><h4>Type property caveat</h4><p> <code>Type</code> is required for <code>vc+sd-jwt</code> format and must be a string <br /> however, endpoint accepts <code>Type</code> as an Array of string for <code>JWT VC</code> in format of <code>[\"VerifiableCredential\", \"AlumniCredential\"]</code> as well. <br /></p>
+     * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br /><hr /><p>Generates unsigned verifiable credential token in JWT format. Client is expected to sign it with a private key.</p><hr /><p>An example of credential signing in Javascript:</p><pre><code>import { Ed25519 } from \'@meeco/sdk\'; <br />import { EdDSASigner, hexToBytes } from \'did-jwt\'; <br /><br />const key = new Ed25519(hexToBytes(SEED_HEX)); <br />const signerFn = EdDSASigner(key.getSecretKey()); <br /><br />const signature = await signerFn(unsignedJwt); <br />const vcJwt = [unsignedJwt, signature].join(\'.\');</code></pre><hr /><br /><h4>Issuer property caveat</h4><p>We use <b>openapi-generator</b> to generate Typescript SDK for the given API swagger definition. However, <b>openapi-generator</b> does not support <b>oneOf</b> configuration properly and generates an invalid Typescript SDK. To avoid the problem, swagger defines <b>issuer</b> property only as string for the moment. While in fact, endpoint accepts issuer as an object in format of <code>{id: string; name: string;}</code> as well.</p><br /><h4>Type property caveat</h4><p><code>type</code> is required for <code>vc+sd-jwt</code> format and must be a string.<br />However, endpoint accepts <code>type</code> as an array of string for <code>JWT VC</code> in format of <code>[\"VerifiableCredential\", \"AlumniCredential\"]</code> as well. <br /></p>
      * Generate credential based on type and claims provided
      */
     credentialsGeneratePostRaw(requestParameters: CredentialsGeneratePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VCUnsignedCredentialResponseDto>>;
     /**
-     * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br /><hr /><p>Generates unsigned verifiable credential token in JWT format. Client is expected to sign it with a private key.</p><hr /><p>An example of credential signing in Javascript:</p><pre><code>import { Ed25519 } from \'@meeco/sdk\'; <br />import { EdDSASigner, hexToBytes } from \'did-jwt\'; <br /><br />const key = new Ed25519(hexToBytes(SEED_HEX)); <br />const signerFn = EdDSASigner(key.getSecretKey()); <br /><br />const signature = await signerFn(unsignedJwt); <br />const vcJwt = [unsignedJwt, signature].join(\'.\');</code></pre><hr /><br /><h4>Issuer property caveat</h4><p>We use <b>openapi-generator</b> to generate Typescript SDK for the given API swagger definition. However, <b>openapi-generator</b> does not support <b>oneOf</b> configuration properly and generates an invalid Typescript SDK. To avoid the problem, swagger defines <b>issuer</b> property only as string for the moment. While in fact, endpoint accepts issuer as an object in format of <code>{id: string; name: string;}</code> as well.</p><br /><h4>Type property caveat</h4><p> <code>Type</code> is required for <code>vc+sd-jwt</code> format and must be a string <br /> however, endpoint accepts <code>Type</code> as an Array of string for <code>JWT VC</code> in format of <code>[\"VerifiableCredential\", \"AlumniCredential\"]</code> as well. <br /></p>
+     * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br /><hr /><p>Generates unsigned verifiable credential token in JWT format. Client is expected to sign it with a private key.</p><hr /><p>An example of credential signing in Javascript:</p><pre><code>import { Ed25519 } from \'@meeco/sdk\'; <br />import { EdDSASigner, hexToBytes } from \'did-jwt\'; <br /><br />const key = new Ed25519(hexToBytes(SEED_HEX)); <br />const signerFn = EdDSASigner(key.getSecretKey()); <br /><br />const signature = await signerFn(unsignedJwt); <br />const vcJwt = [unsignedJwt, signature].join(\'.\');</code></pre><hr /><br /><h4>Issuer property caveat</h4><p>We use <b>openapi-generator</b> to generate Typescript SDK for the given API swagger definition. However, <b>openapi-generator</b> does not support <b>oneOf</b> configuration properly and generates an invalid Typescript SDK. To avoid the problem, swagger defines <b>issuer</b> property only as string for the moment. While in fact, endpoint accepts issuer as an object in format of <code>{id: string; name: string;}</code> as well.</p><br /><h4>Type property caveat</h4><p><code>type</code> is required for <code>vc+sd-jwt</code> format and must be a string.<br />However, endpoint accepts <code>type</code> as an array of string for <code>JWT VC</code> in format of <code>[\"VerifiableCredential\", \"AlumniCredential\"]</code> as well. <br /></p>
      * Generate credential based on type and claims provided
      */
     credentialsGeneratePost(meecoOrganisationID: string, vCGenerateCredentialPayloadDto: VCGenerateCredentialPayloadDto, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VCUnsignedCredentialResponseDto>;
@@ -187,22 +187,22 @@ export declare class VerifiableCredentialsApi extends runtime.BaseAPI {
      */
     credentialsGenerateValidatePayloadPost(meecoOrganisationID: string, vCGenerateCredentialPayloadDto: VCGenerateCredentialPayloadDto, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br />Lists credentials that selected organisation has issued.
+     * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br /><p>Lists credentials that selected organisation has issued.</p>
      * Get a list of credentials organisation has issued
      */
     credentialsGetRaw(requestParameters: CredentialsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VCPaginatedCredentialsResponseDto>>;
     /**
-     * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br />Lists credentials that selected organisation has issued.
+     * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br /><p>Lists credentials that selected organisation has issued.</p>
      * Get a list of credentials organisation has issued
      */
     credentialsGet(meecoOrganisationID: string, order?: CredentialsGetOrderEnum, orderBy?: CredentialsGetOrderByEnum, perPage?: any, page?: any, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VCPaginatedCredentialsResponseDto>;
     /**
-     * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br />Fetch information about a credential organisation has issued by credential ID.
+     * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br /><p>Fetch information about a credential organisation has issued by credential ID.</p>
      * Fetch information about a credential organistaion has issued
      */
     credentialsIdGetRaw(requestParameters: CredentialsIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VCCredentialResponseDto>>;
     /**
-     * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br />Fetch information about a credential organisation has issued by credential ID.
+     * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br /><p>Fetch information about a credential organisation has issued by credential ID.</p>
      * Fetch information about a credential organistaion has issued
      */
     credentialsIdGet(id: string, meecoOrganisationID: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VCCredentialResponseDto>;
@@ -217,13 +217,13 @@ export declare class VerifiableCredentialsApi extends runtime.BaseAPI {
      */
     credentialsStatusPost(meecoOrganisationID: string, vCUpdateCredentialStatusRequestDto: VCUpdateCredentialStatusRequestDto, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * <p>Verify a Verifiable Credential JWT</p><p>Current supports the following formats</p><ul><li><code>jwt_vc_json</code></li><li><code>vc+sd-jwt</code></li></ul><p><b>Checks performed:</b><ul><li> <code>format</code> </li><li> <code>signature</code>. </li><li> <code>expiration</code> date is validated when the <code>expirationDate</code> attribute is present. </li><li> <code>issued at</code> date is validated when the <code>iat</code> attribute is present. </li><li> The <code>keyBindingJWT</code> check is optional and is only performed if it is included in the <code>vc+sd-jwt</code> along with disclosures.</li><li> When <code>keyBindingJWT</code> is included in the <code>vc+sd-jwt</code>, the <code>kb_audience</code> and <code>kb_nonce</code> must be included in the verification options.</li><li> In the case of <code>vc+sd-jwt</code> if the iss is a URL. The public key will be retrieved from the .well-known endpoint according to the <a target=\"_blank\" href=\"https://www.ietf.org/archive/id/draft-ietf-oauth-sd-jwt-vc-04.html\"><code>vc+sd-jwt</code> specification</a></li><li> Verifiable credential <code>schema</code> </li><li> Verifiable credential <code>revocation</code> list status and its validity</li></ul></p><p>Credential expiration, schema and revocation status related checks are not considered critical and will be returned under <code>warnings</code> attribute. It is up for the client application to decide how these should be handled. All other failed checks will be served under <code>errors</code> attribute.</p><p><b>Verification options</b><br /> <br />You can optionally specify checks for the provided <code>VC JWT</code>. If specified, only these checks will run. <br />By default, <code>format</code>, <code>signature</code>, <code>expiration</code> checks are mandatory and can not be taken out from checks list. <br/> No further checks will be performed if <code>JWT Token Format</code> is invalid.</p><pre><code>{ <br />  \"credential\": { ... }, <br />  \"options\": { <br />      \"checks\": [\"format\", \"signature\", \"expiration\", \"schema\", \"revocation_status\"], <br />      \"kb_audience\": \"verifier DID or URL\", <br />      \"kb_nonce\": \"nonce\", <br />  }, <br />} <br /></code></pre><p><code>failed_to_verify_jwt</code> error might appear in both: errors and warnings list. <br />In case of <code>vc+sd-jwt</code> it wraps any error that <code>@meeco/sd-jwt-vc</code> might throw. <br />In case of <code>jwt_vc_json</code> it wraps any error that <code>did-jwt-vc</code> might throw. <br />So far, the only case when <code>failed_to_verify_jwt</code> appears in the warnings list is when credential is expired.</p>
-     * Verify a Verifiable Credential (VC) JWT
+     * <p>Verify a Verifiable Credential</p><p>Current supports the following formats</p><ul><li><code>jwt_vc_json</code></li><li><code>vc+sd-jwt</code></li><li><code>mso_mdoc</code></li></ul><p>If credential.format is not provided, the credential token is assumed to be a JWT.</p><p><b>Checks performed:</b><ul><li> <code>format</code> </li><li> <code>signature</code>. </li><li> <code>expiration</code> date is validated when the <code>expirationDate</code> attribute is present. </li><li> <code>issued at</code> date is validated when the <code>iat</code> attribute is present. </li><li> The <code>keyBindingJWT</code> check is optional and is only performed if it is included in the <code>vc+sd-jwt</code> along with disclosures.</li><li> When <code>keyBindingJWT</code> is included in the <code>vc+sd-jwt</code>, the <code>kb_audience</code> and <code>kb_nonce</code> must be included in the verification options.</li><li> In the case of <code>vc+sd-jwt</code> if the iss is a URL. The public key will be retrieved from the .well-known endpoint according to the <a target=\"_blank\" href=\"https://www.ietf.org/archive/id/draft-ietf-oauth-sd-jwt-vc-04.html\"><code>vc+sd-jwt</code> specification</a></li><li> Verifiable credential <code>schema</code> </li><li> Verifiable credential <code>revocation</code> list status and its validity</li></ul></p><p>Credential expiration, schema and revocation status related checks are not considered critical and will be returned under <code>warnings</code> attribute. It is up for the client application to decide how these should be handled. All other failed checks will be served under <code>errors</code> attribute.</p><p><b>Verification options</b><br /> <br />You can optionally specify checks for the provided <code>VC JWT</code>. If specified, only these checks will run. <br />By default, <code>format</code>, <code>signature</code>, <code>expiration</code> checks are mandatory and can not be taken out from checks list. <br/> No further checks will be performed if <code>JWT Token Format</code> is invalid.</p><pre><code>{ <br />  \"credential\": { ... }, <br />  \"options\": { <br />      \"checks\": [\"format\", \"signature\", \"expiration\", \"schema\", \"revocation_status\"], <br />      \"kb_audience\": \"verifier DID or URL\", <br />      \"kb_nonce\": \"nonce\", <br />  }, <br />} <br /></code></pre><p><code>failed_to_verify_jwt</code> error might appear in both: errors and warnings list. <br />In case of <code>vc+sd-jwt</code> it wraps any error that <code>@meeco/sd-jwt-vc</code> might throw. <br />In case of <code>jwt_vc_json</code> it wraps any error that <code>did-jwt-vc</code> might throw. <br />So far, the only case when <code>failed_to_verify_jwt</code> appears in the warnings list is when credential is expired.</p>
+     * Verify a Verifiable Credential (VC)
      */
     credentialsVerifyPostRaw(requestParameters: CredentialsVerifyPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VCCredentialVerificationResultResponseDto>>;
     /**
-     * <p>Verify a Verifiable Credential JWT</p><p>Current supports the following formats</p><ul><li><code>jwt_vc_json</code></li><li><code>vc+sd-jwt</code></li></ul><p><b>Checks performed:</b><ul><li> <code>format</code> </li><li> <code>signature</code>. </li><li> <code>expiration</code> date is validated when the <code>expirationDate</code> attribute is present. </li><li> <code>issued at</code> date is validated when the <code>iat</code> attribute is present. </li><li> The <code>keyBindingJWT</code> check is optional and is only performed if it is included in the <code>vc+sd-jwt</code> along with disclosures.</li><li> When <code>keyBindingJWT</code> is included in the <code>vc+sd-jwt</code>, the <code>kb_audience</code> and <code>kb_nonce</code> must be included in the verification options.</li><li> In the case of <code>vc+sd-jwt</code> if the iss is a URL. The public key will be retrieved from the .well-known endpoint according to the <a target=\"_blank\" href=\"https://www.ietf.org/archive/id/draft-ietf-oauth-sd-jwt-vc-04.html\"><code>vc+sd-jwt</code> specification</a></li><li> Verifiable credential <code>schema</code> </li><li> Verifiable credential <code>revocation</code> list status and its validity</li></ul></p><p>Credential expiration, schema and revocation status related checks are not considered critical and will be returned under <code>warnings</code> attribute. It is up for the client application to decide how these should be handled. All other failed checks will be served under <code>errors</code> attribute.</p><p><b>Verification options</b><br /> <br />You can optionally specify checks for the provided <code>VC JWT</code>. If specified, only these checks will run. <br />By default, <code>format</code>, <code>signature</code>, <code>expiration</code> checks are mandatory and can not be taken out from checks list. <br/> No further checks will be performed if <code>JWT Token Format</code> is invalid.</p><pre><code>{ <br />  \"credential\": { ... }, <br />  \"options\": { <br />      \"checks\": [\"format\", \"signature\", \"expiration\", \"schema\", \"revocation_status\"], <br />      \"kb_audience\": \"verifier DID or URL\", <br />      \"kb_nonce\": \"nonce\", <br />  }, <br />} <br /></code></pre><p><code>failed_to_verify_jwt</code> error might appear in both: errors and warnings list. <br />In case of <code>vc+sd-jwt</code> it wraps any error that <code>@meeco/sd-jwt-vc</code> might throw. <br />In case of <code>jwt_vc_json</code> it wraps any error that <code>did-jwt-vc</code> might throw. <br />So far, the only case when <code>failed_to_verify_jwt</code> appears in the warnings list is when credential is expired.</p>
-     * Verify a Verifiable Credential (VC) JWT
+     * <p>Verify a Verifiable Credential</p><p>Current supports the following formats</p><ul><li><code>jwt_vc_json</code></li><li><code>vc+sd-jwt</code></li><li><code>mso_mdoc</code></li></ul><p>If credential.format is not provided, the credential token is assumed to be a JWT.</p><p><b>Checks performed:</b><ul><li> <code>format</code> </li><li> <code>signature</code>. </li><li> <code>expiration</code> date is validated when the <code>expirationDate</code> attribute is present. </li><li> <code>issued at</code> date is validated when the <code>iat</code> attribute is present. </li><li> The <code>keyBindingJWT</code> check is optional and is only performed if it is included in the <code>vc+sd-jwt</code> along with disclosures.</li><li> When <code>keyBindingJWT</code> is included in the <code>vc+sd-jwt</code>, the <code>kb_audience</code> and <code>kb_nonce</code> must be included in the verification options.</li><li> In the case of <code>vc+sd-jwt</code> if the iss is a URL. The public key will be retrieved from the .well-known endpoint according to the <a target=\"_blank\" href=\"https://www.ietf.org/archive/id/draft-ietf-oauth-sd-jwt-vc-04.html\"><code>vc+sd-jwt</code> specification</a></li><li> Verifiable credential <code>schema</code> </li><li> Verifiable credential <code>revocation</code> list status and its validity</li></ul></p><p>Credential expiration, schema and revocation status related checks are not considered critical and will be returned under <code>warnings</code> attribute. It is up for the client application to decide how these should be handled. All other failed checks will be served under <code>errors</code> attribute.</p><p><b>Verification options</b><br /> <br />You can optionally specify checks for the provided <code>VC JWT</code>. If specified, only these checks will run. <br />By default, <code>format</code>, <code>signature</code>, <code>expiration</code> checks are mandatory and can not be taken out from checks list. <br/> No further checks will be performed if <code>JWT Token Format</code> is invalid.</p><pre><code>{ <br />  \"credential\": { ... }, <br />  \"options\": { <br />      \"checks\": [\"format\", \"signature\", \"expiration\", \"schema\", \"revocation_status\"], <br />      \"kb_audience\": \"verifier DID or URL\", <br />      \"kb_nonce\": \"nonce\", <br />  }, <br />} <br /></code></pre><p><code>failed_to_verify_jwt</code> error might appear in both: errors and warnings list. <br />In case of <code>vc+sd-jwt</code> it wraps any error that <code>@meeco/sd-jwt-vc</code> might throw. <br />In case of <code>jwt_vc_json</code> it wraps any error that <code>did-jwt-vc</code> might throw. <br />So far, the only case when <code>failed_to_verify_jwt</code> appears in the warnings list is when credential is expired.</p>
+     * Verify a Verifiable Credential (VC)
      */
     credentialsVerifyPost(vCVerifySignedCredentialRequestPayloadDto: VCVerifySignedCredentialRequestPayloadDto, meecoOrganisationID?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VCCredentialVerificationResultResponseDto>;
     /**
@@ -287,12 +287,12 @@ export declare class VerifiableCredentialsApi extends runtime.BaseAPI {
      */
     schemasIdVersionSchemaJsonGet(id: string, version: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SchemasIdVersionSchemaJsonGet200Response>;
     /**
-     * <h4>Requires the following security rights:</h4><ul><li><code>vc:tenant:manage</code></li></ul><br /><p><b>schema_json</b> property must comply with <a target=\"_blank\" href=\"https://www.w3.org/TR/vc-json-schema/\">specification<a>.</p><p>Schema validity can be checked by using one of the Web (Online) validators listed at <a target=\"_blank\" href=\"https://json-schema.org/tools?query=&sortBy=name&sortOrder=ascending&groupBy=toolingTypes&licenses=&languages=&drafts=&toolingTypes=validator\">JSON schema specification site</a>.</p><p><b>schema_json.$id</b> attribute is not expected in the payload. API is going to assign its own internal version of it even if one is being passed.</p><hr /><p>Example (the most minimal set of attributes schema should contain):<p><pre><code>{ <br />  \"$schema\": \"https://json-schema.org/draft/2020-12/schema\", <br />  \"title\": \"EmailCredential\", <br />  \"description\": \"EmailCredential using JsonSchema\", <br />  \"type\": \"object\", <br />  \"properties\": { <br />    \"credentialSubject\": { <br />      \"type\": \"object\", <br />      \"properties\": { <br />        \"emailAddress\": { <br />          \"type\": \"string\", <br />          \"format\": \"email\" <br />        } <br />      }, <br />      \"required\": [ <br />        \"emailAddress\" <br />      ] <br />    } <br />  } <br />} <br /></code></pre><hr /><p>Example (vc+sd-jwt credential format):<p><pre><code>{ <br />  \"$schema\": \"https://json-schema.org/draft/2020-12/schema\", <br />  \"type\": \"object\", <br />  \"properties\": { <br />    \"vct\": { <br />      \"type\": \"string\" <br />    }, <br />    \"iss\": { <br />      \"type\": \"string\" <br />    }, <br />    \"cnf\": { <br />      \"type\": \"object\" <br />    }, <br />    \"email\": { <br />      \"type\": \"string\" <br />    }, <br />    \"is_over_18\": { <br />      \"type\": \"boolean\" <br />    } <br />  }, <br />  \"required\": [ <br />    \"iss\", <br />    \"vct\", <br />    \"cnf\", <br />    \"email\", <br />    \"is_over_18\" <br />  ] <br />} <br /></code></pre>
+     * <h4>Requires the following security rights:</h4><ul><li><code>vc:tenant:manage</code></li></ul><br /><p><b>schema_json</b> property must comply with <a target=\"_blank\" href=\"https://www.w3.org/TR/vc-json-schema/\">specification<a>.</p><p>Schema validity can be checked by using one of the Web (Online) validators listed at <a target=\"_blank\" href=\"https://json-schema.org/tools?query=&sortBy=name&sortOrder=ascending&groupBy=toolingTypes&licenses=&languages=&drafts=&toolingTypes=validator\">JSON schema specification site</a>.</p><p><b>schema_json.$id</b> attribute is not expected in the payload. API is going to assign its own internal version of it even if one is being passed.</p><hr /><p>Example (the most minimal set of attributes schema should contain):<p><pre><code>{ <br />  \"$schema\": \"https://json-schema.org/draft/2020-12/schema\", <br />  \"title\": \"EmailCredential\", <br />  \"description\": \"EmailCredential using JsonSchema\", <br />  \"type\": \"object\", <br />  \"properties\": { <br />    \"credentialSubject\": { <br />      \"type\": \"object\", <br />      \"properties\": { <br />        \"emailAddress\": { <br />          \"type\": \"string\", <br />          \"format\": \"email\" <br />        } <br />      }, <br />      \"required\": [ <br />        \"emailAddress\" <br />      ] <br />    } <br />  } <br />} <br /></code></pre><hr /><p>Example (vc+sd-jwt credential format):<p><pre><code>{ <br />  \"$schema\": \"https://json-schema.org/draft/2020-12/schema\", <br />  \"type\": \"object\", <br />  \"properties\": { <br />    \"vct\": { <br />      \"type\": \"string\" <br />    }, <br />    \"iss\": { <br />      \"type\": \"string\" <br />    }, <br />    \"cnf\": { <br />      \"type\": \"object\" <br />    }, <br />    \"email\": { <br />      \"type\": \"string\" <br />    }, <br />    \"is_over_18\": { <br />      \"type\": \"boolean\" <br />    } <br />  }, <br />  \"required\": [ <br />    \"iss\", <br />    \"vct\", <br />    \"cnf\", <br />    \"email\", <br />    \"is_over_18\" <br />  ] <br />} <br /></code></pre><hr /><p>Example (mso_mdoc credential format):<p><pre><code>{ <br />  \"$schema\": \"https://json-schema.org/draft/2020-12/schema\", <br />  \"type\": \"object\", <br />  \"properties\": { <br />    \"org.iso.18013.5.1\": { <br />      \"type\": \"object\" <br />      \"properties\": { <br />        \"email\": { <br />          \"type\": \"string\" <br />        }, <br />        \"portrait\": { <br />          \"type\": \"string\" <br />          \"description\": \"jpeg as base64url encoded\" <br />          \"x-cbor-encoding\": \"bstr\" <br />        }, <br />      } <br />    }, <br />  }, <br />  \"required\": [ <br />    \"email\", <br />    \"portrait\" <br />  ] <br />} <br /></code></pre>
      * Create schema
      */
     schemasPostRaw(requestParameters: SchemasPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VCSchemaResponseDto>>;
     /**
-     * <h4>Requires the following security rights:</h4><ul><li><code>vc:tenant:manage</code></li></ul><br /><p><b>schema_json</b> property must comply with <a target=\"_blank\" href=\"https://www.w3.org/TR/vc-json-schema/\">specification<a>.</p><p>Schema validity can be checked by using one of the Web (Online) validators listed at <a target=\"_blank\" href=\"https://json-schema.org/tools?query=&sortBy=name&sortOrder=ascending&groupBy=toolingTypes&licenses=&languages=&drafts=&toolingTypes=validator\">JSON schema specification site</a>.</p><p><b>schema_json.$id</b> attribute is not expected in the payload. API is going to assign its own internal version of it even if one is being passed.</p><hr /><p>Example (the most minimal set of attributes schema should contain):<p><pre><code>{ <br />  \"$schema\": \"https://json-schema.org/draft/2020-12/schema\", <br />  \"title\": \"EmailCredential\", <br />  \"description\": \"EmailCredential using JsonSchema\", <br />  \"type\": \"object\", <br />  \"properties\": { <br />    \"credentialSubject\": { <br />      \"type\": \"object\", <br />      \"properties\": { <br />        \"emailAddress\": { <br />          \"type\": \"string\", <br />          \"format\": \"email\" <br />        } <br />      }, <br />      \"required\": [ <br />        \"emailAddress\" <br />      ] <br />    } <br />  } <br />} <br /></code></pre><hr /><p>Example (vc+sd-jwt credential format):<p><pre><code>{ <br />  \"$schema\": \"https://json-schema.org/draft/2020-12/schema\", <br />  \"type\": \"object\", <br />  \"properties\": { <br />    \"vct\": { <br />      \"type\": \"string\" <br />    }, <br />    \"iss\": { <br />      \"type\": \"string\" <br />    }, <br />    \"cnf\": { <br />      \"type\": \"object\" <br />    }, <br />    \"email\": { <br />      \"type\": \"string\" <br />    }, <br />    \"is_over_18\": { <br />      \"type\": \"boolean\" <br />    } <br />  }, <br />  \"required\": [ <br />    \"iss\", <br />    \"vct\", <br />    \"cnf\", <br />    \"email\", <br />    \"is_over_18\" <br />  ] <br />} <br /></code></pre>
+     * <h4>Requires the following security rights:</h4><ul><li><code>vc:tenant:manage</code></li></ul><br /><p><b>schema_json</b> property must comply with <a target=\"_blank\" href=\"https://www.w3.org/TR/vc-json-schema/\">specification<a>.</p><p>Schema validity can be checked by using one of the Web (Online) validators listed at <a target=\"_blank\" href=\"https://json-schema.org/tools?query=&sortBy=name&sortOrder=ascending&groupBy=toolingTypes&licenses=&languages=&drafts=&toolingTypes=validator\">JSON schema specification site</a>.</p><p><b>schema_json.$id</b> attribute is not expected in the payload. API is going to assign its own internal version of it even if one is being passed.</p><hr /><p>Example (the most minimal set of attributes schema should contain):<p><pre><code>{ <br />  \"$schema\": \"https://json-schema.org/draft/2020-12/schema\", <br />  \"title\": \"EmailCredential\", <br />  \"description\": \"EmailCredential using JsonSchema\", <br />  \"type\": \"object\", <br />  \"properties\": { <br />    \"credentialSubject\": { <br />      \"type\": \"object\", <br />      \"properties\": { <br />        \"emailAddress\": { <br />          \"type\": \"string\", <br />          \"format\": \"email\" <br />        } <br />      }, <br />      \"required\": [ <br />        \"emailAddress\" <br />      ] <br />    } <br />  } <br />} <br /></code></pre><hr /><p>Example (vc+sd-jwt credential format):<p><pre><code>{ <br />  \"$schema\": \"https://json-schema.org/draft/2020-12/schema\", <br />  \"type\": \"object\", <br />  \"properties\": { <br />    \"vct\": { <br />      \"type\": \"string\" <br />    }, <br />    \"iss\": { <br />      \"type\": \"string\" <br />    }, <br />    \"cnf\": { <br />      \"type\": \"object\" <br />    }, <br />    \"email\": { <br />      \"type\": \"string\" <br />    }, <br />    \"is_over_18\": { <br />      \"type\": \"boolean\" <br />    } <br />  }, <br />  \"required\": [ <br />    \"iss\", <br />    \"vct\", <br />    \"cnf\", <br />    \"email\", <br />    \"is_over_18\" <br />  ] <br />} <br /></code></pre><hr /><p>Example (mso_mdoc credential format):<p><pre><code>{ <br />  \"$schema\": \"https://json-schema.org/draft/2020-12/schema\", <br />  \"type\": \"object\", <br />  \"properties\": { <br />    \"org.iso.18013.5.1\": { <br />      \"type\": \"object\" <br />      \"properties\": { <br />        \"email\": { <br />          \"type\": \"string\" <br />        }, <br />        \"portrait\": { <br />          \"type\": \"string\" <br />          \"description\": \"jpeg as base64url encoded\" <br />          \"x-cbor-encoding\": \"bstr\" <br />        }, <br />      } <br />    }, <br />  }, <br />  \"required\": [ <br />    \"email\", <br />    \"portrait\" <br />  ] <br />} <br /></code></pre>
      * Create schema
      */
     schemasPost(vCCreateSchemaPayloadDto: VCCreateSchemaPayloadDto, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VCSchemaResponseDto>;
@@ -322,6 +322,7 @@ export type CredentialTypesGetStatusEnum = typeof CredentialTypesGetStatusEnum[k
 export declare const CredentialTypesGetFormatEnum: {
     readonly VcsdJwt: "vc+sd-jwt";
     readonly JwtVcJson: "jwt_vc_json";
+    readonly MsoMdoc: "mso_mdoc";
 };
 export type CredentialTypesGetFormatEnum = typeof CredentialTypesGetFormatEnum[keyof typeof CredentialTypesGetFormatEnum];
 /**

package/lib/types/apis/VerifiablePresentationsApi.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * SVX API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.1.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -81,12 +81,12 @@ export interface PresentationsVerifyPostRequest {
  */
 export declare class VerifiablePresentationsApi extends runtime.BaseAPI {
     /**
-     * <h4>Depending on the presence of the <code>Meeco-Organisation-ID</code> header, endpoint requires one of the following security rights:</h4><ul><li><code>vc:tenant:manage</code> if <code>Meeco-Organisation-ID</code> is not specified</li><li><code>vc:org:manage</code> if <code>Meeco-Organisation-ID</code> is specified</li></ul><br />It gets registered Presentation Requests own by organisation
+     * <h4>Depending on the presence of the <code>Meeco-Organisation-ID</code> header, endpoint requires one of the following security rights:</h4><ul><li><code>vc:tenant:manage</code> if <code>Meeco-Organisation-ID</code> is not specified</li><li><code>vc:org:manage</code> if <code>Meeco-Organisation-ID</code> is specified</li></ul><br /><p>It gets registered Presentation Requests own by a tenancy or an organisation.</p>
      * Get a list of Presentation Requests registered for organisation
      */
     openidPresentationsRequestsGetRaw(requestParameters: OpenidPresentationsRequestsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VCPaginatedPresentationRequestResponseDto>>;
     /**
-     * <h4>Depending on the presence of the <code>Meeco-Organisation-ID</code> header, endpoint requires one of the following security rights:</h4><ul><li><code>vc:tenant:manage</code> if <code>Meeco-Organisation-ID</code> is not specified</li><li><code>vc:org:manage</code> if <code>Meeco-Organisation-ID</code> is specified</li></ul><br />It gets registered Presentation Requests own by organisation
+     * <h4>Depending on the presence of the <code>Meeco-Organisation-ID</code> header, endpoint requires one of the following security rights:</h4><ul><li><code>vc:tenant:manage</code> if <code>Meeco-Organisation-ID</code> is not specified</li><li><code>vc:org:manage</code> if <code>Meeco-Organisation-ID</code> is specified</li></ul><br /><p>It gets registered Presentation Requests own by a tenancy or an organisation.</p>
      * Get a list of Presentation Requests registered for organisation
      */
     openidPresentationsRequestsGet(status?: OpenidPresentationsRequestsGetStatusEnum, search?: string, meecoOrganisationID?: string, order?: OpenidPresentationsRequestsGetOrderEnum, orderBy?: OpenidPresentationsRequestsGetOrderByEnum, perPage?: any, page?: any, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VCPaginatedPresentationRequestResponseDto>;
@@ -101,12 +101,12 @@ export declare class VerifiablePresentationsApi extends runtime.BaseAPI {
      */
     openidPresentationsRequestsIdArchivePost(id: string, meecoOrganisationID?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VCPresentationRequestResponseDto>;
     /**
-     * <h4>Depending on the presence of the <code>Meeco-Organisation-ID</code> header, endpoint requires one of the following security rights:</h4><ul><li><code>vc:tenant:manage</code> if <code>Meeco-Organisation-ID</code> is not specified</li><li><code>vc:org:manage</code> if <code>Meeco-Organisation-ID</code> is specified</li></ul><br />Get Presentation Request for organisation by ID
+     * <h4>Depending on the presence of the <code>Meeco-Organisation-ID</code> header, endpoint requires one of the following security rights:</h4><ul><li><code>vc:tenant:manage</code> if <code>Meeco-Organisation-ID</code> is not specified</li><li><code>vc:org:manage</code> if <code>Meeco-Organisation-ID</code> is specified</li></ul><br /><p>Get a Presentation Request for a tenant or an organisation by ID.</p>
      * Get Presentation Request
      */
     openidPresentationsRequestsIdGetRaw(requestParameters: OpenidPresentationsRequestsIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VCPresentationRequestResponseDto>>;
     /**
-     * <h4>Depending on the presence of the <code>Meeco-Organisation-ID</code> header, endpoint requires one of the following security rights:</h4><ul><li><code>vc:tenant:manage</code> if <code>Meeco-Organisation-ID</code> is not specified</li><li><code>vc:org:manage</code> if <code>Meeco-Organisation-ID</code> is specified</li></ul><br />Get Presentation Request for organisation by ID
+     * <h4>Depending on the presence of the <code>Meeco-Organisation-ID</code> header, endpoint requires one of the following security rights:</h4><ul><li><code>vc:tenant:manage</code> if <code>Meeco-Organisation-ID</code> is not specified</li><li><code>vc:org:manage</code> if <code>Meeco-Organisation-ID</code> is specified</li></ul><br /><p>Get a Presentation Request for a tenant or an organisation by ID.</p>
      * Get Presentation Request
      */
     openidPresentationsRequestsIdGet(id: string, meecoOrganisationID?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VCPresentationRequestResponseDto>;
@@ -121,82 +121,82 @@ export declare class VerifiablePresentationsApi extends runtime.BaseAPI {
      */
     openidPresentationsRequestsIdRestorePost(id: string, meecoOrganisationID?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VCPresentationRequestResponseDto>;
     /**
-     * <h4>Depending on the presence of the <code>Meeco-Organisation-ID</code> header, endpoint requires one of the following security rights:</h4><ul><li><code>vc:tenant:manage</code> if <code>Meeco-Organisation-ID</code> is not specified</li><li><code>vc:org:manage</code> if <code>Meeco-Organisation-ID</code> is specified</li></ul><br />Register Presentation Request for organisation
+     * <h4>Depending on the presence of the <code>Meeco-Organisation-ID</code> header, endpoint requires one of the following security rights:</h4><ul><li><code>vc:tenant:manage</code> if <code>Meeco-Organisation-ID</code> is not specified</li><li><code>vc:org:manage</code> if <code>Meeco-Organisation-ID</code> is specified</li></ul><br /><p>Register a Presentation Request for organisation.</p>
      * Create a Presentation Request
      */
     openidPresentationsRequestsPostRaw(requestParameters: OpenidPresentationsRequestsPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VCPresentationRequestResponseDto>>;
     /**
-     * <h4>Depending on the presence of the <code>Meeco-Organisation-ID</code> header, endpoint requires one of the following security rights:</h4><ul><li><code>vc:tenant:manage</code> if <code>Meeco-Organisation-ID</code> is not specified</li><li><code>vc:org:manage</code> if <code>Meeco-Organisation-ID</code> is specified</li></ul><br />Register Presentation Request for organisation
+     * <h4>Depending on the presence of the <code>Meeco-Organisation-ID</code> header, endpoint requires one of the following security rights:</h4><ul><li><code>vc:tenant:manage</code> if <code>Meeco-Organisation-ID</code> is not specified</li><li><code>vc:org:manage</code> if <code>Meeco-Organisation-ID</code> is specified</li></ul><br /><p>Register a Presentation Request for organisation.</p>
      * Create a Presentation Request
      */
     openidPresentationsRequestsPost(vCCreatePresentationRequestPayloadDto: VCCreatePresentationRequestPayloadDto, meecoOrganisationID?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VCPresentationRequestResponseDto>;
     /**
-     * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br /><p>Verify a Presentation Request Submission</p><p><b>Checks performed:</b><ul><li>Presentation Request Submission Id Token</li><li>Presentation Request Submission VP Token</li><li>Signature for all of the above</li><li>Format for all of the above</li><li>Expiration for all of the above</li><li>Revocation status for credentials within vp token</li><li>Presentation_definition uri match credential schema uri within vp token</li></ul></p><p><b>Verification options</b></p><p>Certain set of checks is executed against each presentation request response attribute separately. Depending on the use-case some of those checks might not be necessary and could be disabled. To see the list of available check options - look at the schema of the verification options. If verification options were not provided all available checks will be executed. </p><p>Imagine expiration of the verifiable presentation is not relevant to our use-case. We can skip that check so no errors or wranings related to it would appear. Here is verification options payload example:</p><pre><code>{ <br />  \"presentation_request_response\": { ... }, <br />  \"options\": { <br />    \"vp_token\": { <br />      \"checks\": [\"format\", \"signature\", \"nonce\"], <br />    } <br />  }, <br />} <br /></code></pre><p>However, <b>some of the checks are mandatory</b>. If checks list includes <b>format</b> or <b>signature</b> option - it cannnot be taken out. Every other check is optional.</p><p>In case of <code>id_token</code>, <code>failed_to_verify_jwt</code> error might appear in both: errors and warnings list. <br />So far, the only case when <code>failed_to_verify_jwt</code> appears in the warnings list is when <code>id_token</code> is expired. <br /></p>
-     * Verify a Presentation Request Submission
+     * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br /><p>Verify a Presentation Request Response</p><p><b>Checks performed:</b><ul><li>Presentation Request Response <code>id_token</code></li><li>Presentation Request Response <code>vp_token</code></li><li>Presentation Request Response <code>presentation_submission</code> data</li><li>Signature for all of the above</li><li>Format for all of the above</li><li>Expiration for all of the above</li><li>Revocation status for credentials within <code>vp_token</code></li><li>Presentation Definition constraints for the provided <code>vp_token</code></li></ul></p><p><b>Verification options</b></p><p>Certain set of checks is executed against each Presentation Request Response attribute separately. Depending on the use-case some of those checks might not be necessary and could be disabled. To see the list of available check options - look at the schema of the verification options. If verification options were not provided all available checks will be executed. </p><p>Imagine nonce value check is not relevant to our use-case. We can skip that check so no errors or wranings related to it would appear. Here is verification options payload example:</p><pre><code>{ <br />  \"presentation_request_response\": { ... }, <br />  \"options\": { <br />    \"vp_token\": { <br />      \"checks\": [\"format\", \"signature\", \"expiration\"], <br />    } <br />  }, <br />} <br /></code></pre><p>However, <b>some of the checks are mandatory</b>. Please check each option schema separately to find this information.</p><p>In case of <code>id_token</code>, <code>failed_to_verify_jwt</code> error might appear in both: errors and warnings list. <br />So far, the only case when <code>failed_to_verify_jwt</code> appears in the warnings list is when <code>id_token</code> is expired. <br /></p>
+     * Verify a Presentation Request Response
      */
     openidPresentationsResponseVerifyPostRaw(requestParameters: OpenidPresentationsResponseVerifyPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VCPresentationRequestResponseVerificationResultResponseDto>>;
     /**
-     * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br /><p>Verify a Presentation Request Submission</p><p><b>Checks performed:</b><ul><li>Presentation Request Submission Id Token</li><li>Presentation Request Submission VP Token</li><li>Signature for all of the above</li><li>Format for all of the above</li><li>Expiration for all of the above</li><li>Revocation status for credentials within vp token</li><li>Presentation_definition uri match credential schema uri within vp token</li></ul></p><p><b>Verification options</b></p><p>Certain set of checks is executed against each presentation request response attribute separately. Depending on the use-case some of those checks might not be necessary and could be disabled. To see the list of available check options - look at the schema of the verification options. If verification options were not provided all available checks will be executed. </p><p>Imagine expiration of the verifiable presentation is not relevant to our use-case. We can skip that check so no errors or wranings related to it would appear. Here is verification options payload example:</p><pre><code>{ <br />  \"presentation_request_response\": { ... }, <br />  \"options\": { <br />    \"vp_token\": { <br />      \"checks\": [\"format\", \"signature\", \"nonce\"], <br />    } <br />  }, <br />} <br /></code></pre><p>However, <b>some of the checks are mandatory</b>. If checks list includes <b>format</b> or <b>signature</b> option - it cannnot be taken out. Every other check is optional.</p><p>In case of <code>id_token</code>, <code>failed_to_verify_jwt</code> error might appear in both: errors and warnings list. <br />So far, the only case when <code>failed_to_verify_jwt</code> appears in the warnings list is when <code>id_token</code> is expired. <br /></p>
-     * Verify a Presentation Request Submission
+     * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br /><p>Verify a Presentation Request Response</p><p><b>Checks performed:</b><ul><li>Presentation Request Response <code>id_token</code></li><li>Presentation Request Response <code>vp_token</code></li><li>Presentation Request Response <code>presentation_submission</code> data</li><li>Signature for all of the above</li><li>Format for all of the above</li><li>Expiration for all of the above</li><li>Revocation status for credentials within <code>vp_token</code></li><li>Presentation Definition constraints for the provided <code>vp_token</code></li></ul></p><p><b>Verification options</b></p><p>Certain set of checks is executed against each Presentation Request Response attribute separately. Depending on the use-case some of those checks might not be necessary and could be disabled. To see the list of available check options - look at the schema of the verification options. If verification options were not provided all available checks will be executed. </p><p>Imagine nonce value check is not relevant to our use-case. We can skip that check so no errors or wranings related to it would appear. Here is verification options payload example:</p><pre><code>{ <br />  \"presentation_request_response\": { ... }, <br />  \"options\": { <br />    \"vp_token\": { <br />      \"checks\": [\"format\", \"signature\", \"expiration\"], <br />    } <br />  }, <br />} <br /></code></pre><p>However, <b>some of the checks are mandatory</b>. Please check each option schema separately to find this information.</p><p>In case of <code>id_token</code>, <code>failed_to_verify_jwt</code> error might appear in both: errors and warnings list. <br />So far, the only case when <code>failed_to_verify_jwt</code> appears in the warnings list is when <code>id_token</code> is expired. <br /></p>
+     * Verify a Presentation Request Response
      */
     openidPresentationsResponseVerifyPost(vCVerifyPresentationRequestResponsePayloadDto: VCVerifyPresentationRequestResponsePayloadDto, meecoOrganisationID?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VCPresentationRequestResponseVerificationResultResponseDto>;
     /**
-     * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br />It gets registered Presentation Definitions own by organisation
+     * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br /><p>It gets registered Presentation Definitions own by organisation.</p>
      * Get a list of Presentation Definitions registered for organisation
      */
     presentationDefinitionsGetRaw(requestParameters: PresentationDefinitionsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VCPaginatedPresentationDefinitionsResponseDto>>;
     /**
-     * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br />It gets registered Presentation Definitions own by organisation
+     * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br /><p>It gets registered Presentation Definitions own by organisation.</p>
      * Get a list of Presentation Definitions registered for organisation
      */
     presentationDefinitionsGet(meecoOrganisationID: string, status?: PresentationDefinitionsGetStatusEnum, search?: string, order?: PresentationDefinitionsGetOrderEnum, orderBy?: PresentationDefinitionsGetOrderByEnum, perPage?: any, page?: any, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VCPaginatedPresentationDefinitionsResponseDto>;
     /**
      * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br />
-     * Archive presentation definition
+     * Archive a Presentation Definition
      */
     presentationDefinitionsIdArchivePostRaw(requestParameters: PresentationDefinitionsIdArchivePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VCPresentationDefinitionResponseDto>>;
     /**
      * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br />
-     * Archive presentation definition
+     * Archive a Presentation Definition
      */
     presentationDefinitionsIdArchivePost(id: string, meecoOrganisationID: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VCPresentationDefinitionResponseDto>;
     /**
-     * Get JSON representation of Presentation Definition
+     * Get a JSON representation of Presentation Definition
      * Get Presentation Definition JSON representation
      */
     presentationDefinitionsIdDefinitionJsonGetRaw(requestParameters: PresentationDefinitionsIdDefinitionJsonGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VCPresentationDefinitionJsonResponseDto>>;
     /**
-     * Get JSON representation of Presentation Definition
+     * Get a JSON representation of Presentation Definition
      * Get Presentation Definition JSON representation
      */
     presentationDefinitionsIdDefinitionJsonGet(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VCPresentationDefinitionJsonResponseDto>;
     /**
-     * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br />Get Presentation Definition for organisation by ID
+     * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br /><p>Get Presentation Definition for organisation by ID.</p>
      * Get Presentation Definition
      */
     presentationDefinitionsIdGetRaw(requestParameters: PresentationDefinitionsIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VCPresentationDefinitionResponseDto>>;
     /**
-     * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br />Get Presentation Definition for organisation by ID
+     * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br /><p>Get Presentation Definition for organisation by ID.</p>
      * Get Presentation Definition
      */
     presentationDefinitionsIdGet(id: string, meecoOrganisationID: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VCPresentationDefinitionResponseDto>;
     /**
      * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br />
-     * restore presentation definition from archive
+     * Restore an archived Presentation Definition
      */
     presentationDefinitionsIdRestorePostRaw(requestParameters: PresentationDefinitionsIdRestorePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VCPresentationDefinitionResponseDto>>;
     /**
      * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br />
-     * restore presentation definition from archive
+     * Restore an archived Presentation Definition
      */
     presentationDefinitionsIdRestorePost(id: string, meecoOrganisationID: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VCPresentationDefinitionResponseDto>;
     /**
-     * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br />Register Presentation Definitions for organisation<br /><p><code>input_descriptors</code> property MUST follow the <a target=\"_blank\" href=\"https://identity.foundation/presentation-exchange/spec/v2.1.1/#input-descriptor\">DIF Presentation Exchange Specification</a></p>
+     * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br /><p>Register Presentation Definitions for organisation.</p><p><code>input_descriptors</code> property MUST follow the <a target=\"_blank\" href=\"https://identity.foundation/presentation-exchange/spec/v2.1.1/#input-descriptor\">DIF Presentation Exchange Specification</a></p>
      * Create a Presentation Definition
      */
     presentationDefinitionsPostRaw(requestParameters: PresentationDefinitionsPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VCPresentationDefinitionResponseDto>>;
     /**
-     * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br />Register Presentation Definitions for organisation<br /><p><code>input_descriptors</code> property MUST follow the <a target=\"_blank\" href=\"https://identity.foundation/presentation-exchange/spec/v2.1.1/#input-descriptor\">DIF Presentation Exchange Specification</a></p>
+     * <h4>Requires the following security rights:</h4><ul><li><code>vc:org:manage</code></li></ul><br /><p>Register Presentation Definitions for organisation.</p><p><code>input_descriptors</code> property MUST follow the <a target=\"_blank\" href=\"https://identity.foundation/presentation-exchange/spec/v2.1.1/#input-descriptor\">DIF Presentation Exchange Specification</a></p>
      * Create a Presentation Definition
      */
     presentationDefinitionsPost(meecoOrganisationID: string, vCCreatePresentationDefinitionPayloadDto: VCCreatePresentationDefinitionPayloadDto, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VCPresentationDefinitionResponseDto>;

package/lib/types/models/ATOMActiveAndArchivedOrgList.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * SVX API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.1.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/lib/types/models/ATOMAdmin.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * SVX API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.1.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/lib/types/models/ATOMAdministeredArchivedOrg.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * SVX API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.1.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/lib/types/models/ATOMAdministeredOrg.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * SVX API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.1.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/lib/types/models/ATOMAssignSecurityRightsRequest.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * SVX API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.1.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/lib/types/models/ATOMCreateOrUpdateOrgRequest.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * SVX API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.1.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/lib/types/models/ATOMCreateOrUpdateTenantRequest.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * SVX API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.1.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/lib/types/models/ATOMError.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * SVX API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.1.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/lib/types/models/ATOMOneOrg.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * SVX API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.1.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/lib/types/models/ATOMOneTenant.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * SVX API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.1.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/lib/types/models/ATOMOrg.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * SVX API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.1.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/lib/types/models/ATOMOrgDescription.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * SVX API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.1.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/lib/types/models/ATOMOrgList.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * SVX API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.1.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/lib/types/models/ATOMPaginatedAdminList.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * SVX API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.1.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/lib/types/models/ATOMPaginatedOrgList.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * SVX API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.1.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/lib/types/models/ATOMPaginatedTenantList.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * SVX API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.1.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/lib/types/models/ATOMSecurityRightGroupSpec.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * SVX API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.1.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/lib/types/models/ATOMSecurityRightInRegistry.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * SVX API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.1.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/lib/types/models/ATOMSecurityRightSpecInRegistry.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * SVX API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.1.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/lib/types/models/ATOMSecurityRights.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * SVX API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.1.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/lib/types/models/ATOMSecurityRightsGroup.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * SVX API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.1.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/lib/types/models/ATOMSecurityRightsOfUser.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * SVX API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.1.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/lib/types/models/ATOMSecurityRightsRegistry.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * SVX API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.1.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).