@meeco/svx-api-sdk 1.0.0-stage.20240502114933.d123429 → 1.0.0-stage.20240624095554.3e253ce
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +2 -0
- package/lib/esm/apis/ConnectionsApi.js +69 -69
- package/lib/esm/apis/HelpersApi.js +14 -8
- package/lib/esm/apis/ItemsApi.js +24 -24
- package/lib/esm/apis/OrganisationsApi.js +176 -176
- package/lib/esm/apis/SecurityRightsApi.js +80 -80
- package/lib/esm/apis/SharesApi.js +24 -24
- package/lib/esm/apis/TenantsApi.js +174 -174
- package/lib/esm/apis/VerifiableCredentialsApi.js +12 -6
- package/lib/esm/apis/VerifiablePresentationsApi.js +1 -0
- package/lib/esm/models/ATOMBlobInfo.js +8 -0
- package/lib/esm/models/ATOMBlobPublicInfo.js +6 -0
- package/lib/esm/models/ATOMFileStorageBackend.js +45 -0
- package/lib/esm/models/ATOMFileStorageConfiguration.js +46 -0
- package/lib/esm/models/VCCredentialTypeModelDtoSchema.js +6 -0
- package/lib/esm/models/VCCredentialTypeSchemaDto.js +6 -0
- package/lib/esm/models/VCInputDescriptorsDto.js +3 -0
- package/lib/esm/models/VCPresentationDefinitionDto.js +0 -3
- package/lib/esm/models/VCPresentationDefinitionToSchemaModel.js +3 -0
- package/lib/esm/models/VCVerifyPresentationRequestResponseDto.js +3 -2
- package/lib/esm/models/index.js +2 -0
- package/lib/types/apis/ConnectionsApi.d.ts +36 -36
- package/lib/types/apis/HelpersApi.d.ts +8 -7
- package/lib/types/apis/ItemsApi.d.ts +18 -18
- package/lib/types/apis/OrganisationsApi.d.ts +82 -82
- package/lib/types/apis/SecurityRightsApi.d.ts +28 -28
- package/lib/types/apis/SharesApi.d.ts +16 -16
- package/lib/types/apis/TenantsApi.d.ts +82 -82
- package/lib/types/apis/VerifiableCredentialsApi.d.ts +6 -4
- package/lib/types/apis/VerifiablePresentationsApi.d.ts +1 -0
- package/lib/types/models/ATOMBlobInfo.d.ts +18 -0
- package/lib/types/models/ATOMBlobPublicInfo.d.ts +12 -0
- package/lib/types/models/ATOMFileStorageBackend.d.ts +37 -0
- package/lib/types/models/ATOMFileStorageConfiguration.d.ts +38 -0
- package/lib/types/models/VCCredentialTypeModelDtoSchema.d.ts +12 -0
- package/lib/types/models/VCCredentialTypeSchemaDto.d.ts +12 -0
- package/lib/types/models/VCInputDescriptorsDto.d.ts +7 -0
- package/lib/types/models/VCPresentationDefinitionDto.d.ts +0 -7
- package/lib/types/models/VCPresentationDefinitionToSchemaModel.d.ts +6 -0
- package/lib/types/models/VCVerifyPresentationRequestResponseDto.d.ts +7 -1
- package/lib/types/models/index.d.ts +2 -0
- package/lib/umd/apis/ConnectionsApi.js +69 -69
- package/lib/umd/apis/HelpersApi.js +14 -8
- package/lib/umd/apis/ItemsApi.js +24 -24
- package/lib/umd/apis/OrganisationsApi.js +176 -176
- package/lib/umd/apis/SecurityRightsApi.js +80 -80
- package/lib/umd/apis/SharesApi.js +24 -24
- package/lib/umd/apis/TenantsApi.js +174 -174
- package/lib/umd/apis/VerifiableCredentialsApi.js +12 -6
- package/lib/umd/apis/VerifiablePresentationsApi.js +1 -0
- package/lib/umd/models/ATOMBlobInfo.js +8 -0
- package/lib/umd/models/ATOMBlobPublicInfo.js +6 -0
- package/lib/umd/models/ATOMFileStorageBackend.js +52 -0
- package/lib/umd/models/ATOMFileStorageConfiguration.js +53 -0
- package/lib/umd/models/VCCredentialTypeModelDtoSchema.js +6 -0
- package/lib/umd/models/VCCredentialTypeSchemaDto.js +6 -0
- package/lib/umd/models/VCInputDescriptorsDto.js +3 -0
- package/lib/umd/models/VCPresentationDefinitionDto.js +0 -3
- package/lib/umd/models/VCPresentationDefinitionToSchemaModel.js +3 -0
- package/lib/umd/models/VCVerifyPresentationRequestResponseDto.js +3 -2
- package/lib/umd/models/index.js +2 -0
- package/package.json +1 -1
|
@@ -39,6 +39,9 @@ export class VerifiableCredentialsApi extends runtime.BaseAPI {
|
|
|
39
39
|
if (requestParameters.status !== undefined) {
|
|
40
40
|
queryParameters['status'] = requestParameters.status;
|
|
41
41
|
}
|
|
42
|
+
if (requestParameters.search !== undefined) {
|
|
43
|
+
queryParameters['search'] = requestParameters.search;
|
|
44
|
+
}
|
|
42
45
|
if (requestParameters.order !== undefined) {
|
|
43
46
|
queryParameters['order'] = requestParameters.order;
|
|
44
47
|
}
|
|
@@ -75,9 +78,9 @@ export class VerifiableCredentialsApi extends runtime.BaseAPI {
|
|
|
75
78
|
* <h4>Requires no security rights</h4><br /><p>Endpoint works for a tenant and organisation user based on the <b>Meeco-Organisation-ID</b> header.</p><p>Returns a list of credential types available to the caller.</p><p>In case of tenant context, endpoint returns all credential types available in the tenancy.</p><p>In case of organization context, <b>organizations</b> list always contains only one item - caller organization ID.</p>
|
|
76
79
|
* List available credential types
|
|
77
80
|
*/
|
|
78
|
-
credentialTypesGet(externalIssuerEnabled, status, meecoOrganisationID, order, orderBy, perPage, page, initOverrides) {
|
|
81
|
+
credentialTypesGet(externalIssuerEnabled, status, search, meecoOrganisationID, order, orderBy, perPage, page, initOverrides) {
|
|
79
82
|
return __awaiter(this, void 0, void 0, function* () {
|
|
80
|
-
const response = yield this.credentialTypesGetRaw({ externalIssuerEnabled: externalIssuerEnabled, status: status, meecoOrganisationID: meecoOrganisationID, order: order, orderBy: orderBy, perPage: perPage, page: page }, initOverrides);
|
|
83
|
+
const response = yield this.credentialTypesGetRaw({ externalIssuerEnabled: externalIssuerEnabled, status: status, search: search, meecoOrganisationID: meecoOrganisationID, order: order, orderBy: orderBy, perPage: perPage, page: page }, initOverrides);
|
|
81
84
|
return yield response.value();
|
|
82
85
|
});
|
|
83
86
|
}
|
|
@@ -304,7 +307,7 @@ export class VerifiableCredentialsApi extends runtime.BaseAPI {
|
|
|
304
307
|
});
|
|
305
308
|
}
|
|
306
309
|
/**
|
|
307
|
-
* <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 how credential signing in Javascript:</p><pre><code>import {
|
|
310
|
+
* <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 how 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>
|
|
308
311
|
* Generate credential based on type and claims provided
|
|
309
312
|
*/
|
|
310
313
|
credentialsGeneratePostRaw(requestParameters, initOverrides) {
|
|
@@ -342,7 +345,7 @@ export class VerifiableCredentialsApi extends runtime.BaseAPI {
|
|
|
342
345
|
});
|
|
343
346
|
}
|
|
344
347
|
/**
|
|
345
|
-
* <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 how credential signing in Javascript:</p><pre><code>import {
|
|
348
|
+
* <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 how 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>
|
|
346
349
|
* Generate credential based on type and claims provided
|
|
347
350
|
*/
|
|
348
351
|
credentialsGeneratePost(meecoOrganisationID, vCGenerateCredentialPayloadDto, accept, initOverrides) {
|
|
@@ -542,6 +545,9 @@ export class VerifiableCredentialsApi extends runtime.BaseAPI {
|
|
|
542
545
|
if (requestParameters.status !== undefined) {
|
|
543
546
|
queryParameters['status'] = requestParameters.status;
|
|
544
547
|
}
|
|
548
|
+
if (requestParameters.search !== undefined) {
|
|
549
|
+
queryParameters['search'] = requestParameters.search;
|
|
550
|
+
}
|
|
545
551
|
if (requestParameters.order !== undefined) {
|
|
546
552
|
queryParameters['order'] = requestParameters.order;
|
|
547
553
|
}
|
|
@@ -578,9 +584,9 @@ export class VerifiableCredentialsApi extends runtime.BaseAPI {
|
|
|
578
584
|
* <p>Endpoint works for a tenant and organisation user based on the <b>Meeco-Organisation-ID</b> header.</p><p>Returns a list of schemas available to the caller.</p><p>In case of organization context, <b>organization_ids</b> list always contains only one item - caller organization ID.</p>
|
|
579
585
|
* List available schemas
|
|
580
586
|
*/
|
|
581
|
-
schemasGet(status, meecoOrganisationID, order, orderBy, perPage, page, initOverrides) {
|
|
587
|
+
schemasGet(status, search, meecoOrganisationID, order, orderBy, perPage, page, initOverrides) {
|
|
582
588
|
return __awaiter(this, void 0, void 0, function* () {
|
|
583
|
-
const response = yield this.schemasGetRaw({ status: status, meecoOrganisationID: meecoOrganisationID, order: order, orderBy: orderBy, perPage: perPage, page: page }, initOverrides);
|
|
589
|
+
const response = yield this.schemasGetRaw({ status: status, search: search, meecoOrganisationID: meecoOrganisationID, order: order, orderBy: orderBy, perPage: perPage, page: page }, initOverrides);
|
|
584
590
|
return yield response.value();
|
|
585
591
|
});
|
|
586
592
|
}
|
|
@@ -20,6 +20,8 @@ export function instanceOfATOMBlobInfo(value) {
|
|
|
20
20
|
isInstance = isInstance && "content_type" in value;
|
|
21
21
|
isInstance = isInstance && "filename" in value;
|
|
22
22
|
isInstance = isInstance && "key" in value;
|
|
23
|
+
isInstance = isInstance && "storage_backend_name" in value;
|
|
24
|
+
isInstance = isInstance && "storage_backend_type" in value;
|
|
23
25
|
isInstance = isInstance && "uploaded" in value;
|
|
24
26
|
return isInstance;
|
|
25
27
|
}
|
|
@@ -35,6 +37,9 @@ export function ATOMBlobInfoFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
35
37
|
'filename': json['filename'],
|
|
36
38
|
'key': json['key'],
|
|
37
39
|
'read_url': !exists(json, 'read_url') ? undefined : json['read_url'],
|
|
40
|
+
'storage_backend_name': json['storage_backend_name'],
|
|
41
|
+
'storage_backend_type': json['storage_backend_type'],
|
|
42
|
+
'upload_headers': !exists(json, 'upload_headers') ? undefined : json['upload_headers'],
|
|
38
43
|
'upload_url': !exists(json, 'upload_url') ? undefined : json['upload_url'],
|
|
39
44
|
'upload_url_expires_in_seconds': !exists(json, 'upload_url_expires_in_seconds') ? undefined : json['upload_url_expires_in_seconds'],
|
|
40
45
|
'uploaded': json['uploaded'],
|
|
@@ -52,6 +57,9 @@ export function ATOMBlobInfoToJSON(value) {
|
|
|
52
57
|
'filename': value.filename,
|
|
53
58
|
'key': value.key,
|
|
54
59
|
'read_url': value.read_url,
|
|
60
|
+
'storage_backend_name': value.storage_backend_name,
|
|
61
|
+
'storage_backend_type': value.storage_backend_type,
|
|
62
|
+
'upload_headers': value.upload_headers,
|
|
55
63
|
'upload_url': value.upload_url,
|
|
56
64
|
'upload_url_expires_in_seconds': value.upload_url_expires_in_seconds,
|
|
57
65
|
'uploaded': value.uploaded,
|
|
@@ -20,6 +20,8 @@ export function instanceOfATOMBlobPublicInfo(value) {
|
|
|
20
20
|
isInstance = isInstance && "content_type" in value;
|
|
21
21
|
isInstance = isInstance && "filename" in value;
|
|
22
22
|
isInstance = isInstance && "key" in value;
|
|
23
|
+
isInstance = isInstance && "storage_backend_name" in value;
|
|
24
|
+
isInstance = isInstance && "storage_backend_type" in value;
|
|
23
25
|
isInstance = isInstance && "uploaded" in value;
|
|
24
26
|
return isInstance;
|
|
25
27
|
}
|
|
@@ -35,6 +37,8 @@ export function ATOMBlobPublicInfoFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
35
37
|
'filename': json['filename'],
|
|
36
38
|
'key': json['key'],
|
|
37
39
|
'read_url': !exists(json, 'read_url') ? undefined : json['read_url'],
|
|
40
|
+
'storage_backend_name': json['storage_backend_name'],
|
|
41
|
+
'storage_backend_type': json['storage_backend_type'],
|
|
38
42
|
'uploaded': json['uploaded'],
|
|
39
43
|
};
|
|
40
44
|
}
|
|
@@ -50,6 +54,8 @@ export function ATOMBlobPublicInfoToJSON(value) {
|
|
|
50
54
|
'filename': value.filename,
|
|
51
55
|
'key': value.key,
|
|
52
56
|
'read_url': value.read_url,
|
|
57
|
+
'storage_backend_name': value.storage_backend_name,
|
|
58
|
+
'storage_backend_type': value.storage_backend_type,
|
|
53
59
|
'uploaded': value.uploaded,
|
|
54
60
|
};
|
|
55
61
|
}
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* SVX API
|
|
5
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.3.5
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import { exists } from '../runtime';
|
|
15
|
+
/**
|
|
16
|
+
* Check if a given object implements the ATOMFileStorageBackend interface.
|
|
17
|
+
*/
|
|
18
|
+
export function instanceOfATOMFileStorageBackend(value) {
|
|
19
|
+
let isInstance = true;
|
|
20
|
+
return isInstance;
|
|
21
|
+
}
|
|
22
|
+
export function ATOMFileStorageBackendFromJSON(json) {
|
|
23
|
+
return ATOMFileStorageBackendFromJSONTyped(json, false);
|
|
24
|
+
}
|
|
25
|
+
export function ATOMFileStorageBackendFromJSONTyped(json, ignoreDiscriminator) {
|
|
26
|
+
if ((json === undefined) || (json === null)) {
|
|
27
|
+
return json;
|
|
28
|
+
}
|
|
29
|
+
return {
|
|
30
|
+
'cloud': !exists(json, 'cloud') ? undefined : json['cloud'],
|
|
31
|
+
'name': !exists(json, 'name') ? undefined : json['name'],
|
|
32
|
+
};
|
|
33
|
+
}
|
|
34
|
+
export function ATOMFileStorageBackendToJSON(value) {
|
|
35
|
+
if (value === undefined) {
|
|
36
|
+
return undefined;
|
|
37
|
+
}
|
|
38
|
+
if (value === null) {
|
|
39
|
+
return null;
|
|
40
|
+
}
|
|
41
|
+
return {
|
|
42
|
+
'cloud': value.cloud,
|
|
43
|
+
'name': value.name,
|
|
44
|
+
};
|
|
45
|
+
}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* SVX API
|
|
5
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.3.5
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import { exists } from '../runtime';
|
|
15
|
+
import { ATOMFileStorageBackendFromJSON, ATOMFileStorageBackendToJSON, } from './ATOMFileStorageBackend';
|
|
16
|
+
/**
|
|
17
|
+
* Check if a given object implements the ATOMFileStorageConfiguration interface.
|
|
18
|
+
*/
|
|
19
|
+
export function instanceOfATOMFileStorageConfiguration(value) {
|
|
20
|
+
let isInstance = true;
|
|
21
|
+
return isInstance;
|
|
22
|
+
}
|
|
23
|
+
export function ATOMFileStorageConfigurationFromJSON(json) {
|
|
24
|
+
return ATOMFileStorageConfigurationFromJSONTyped(json, false);
|
|
25
|
+
}
|
|
26
|
+
export function ATOMFileStorageConfigurationFromJSONTyped(json, ignoreDiscriminator) {
|
|
27
|
+
if ((json === undefined) || (json === null)) {
|
|
28
|
+
return json;
|
|
29
|
+
}
|
|
30
|
+
return {
|
|
31
|
+
'default_storage_backend': !exists(json, 'default_storage_backend') ? undefined : json['default_storage_backend'],
|
|
32
|
+
'storage_backends': !exists(json, 'storage_backends') ? undefined : (json['storage_backends'].map(ATOMFileStorageBackendFromJSON)),
|
|
33
|
+
};
|
|
34
|
+
}
|
|
35
|
+
export function ATOMFileStorageConfigurationToJSON(value) {
|
|
36
|
+
if (value === undefined) {
|
|
37
|
+
return undefined;
|
|
38
|
+
}
|
|
39
|
+
if (value === null) {
|
|
40
|
+
return null;
|
|
41
|
+
}
|
|
42
|
+
return {
|
|
43
|
+
'default_storage_backend': value.default_storage_backend,
|
|
44
|
+
'storage_backends': value.storage_backends === undefined ? undefined : (value.storage_backends.map(ATOMFileStorageBackendToJSON)),
|
|
45
|
+
};
|
|
46
|
+
}
|
|
@@ -19,6 +19,8 @@ export function instanceOfVCCredentialTypeModelDtoSchema(value) {
|
|
|
19
19
|
isInstance = isInstance && "id" in value;
|
|
20
20
|
isInstance = isInstance && "schema_url" in value;
|
|
21
21
|
isInstance = isInstance && "name" in value;
|
|
22
|
+
isInstance = isInstance && "archived" in value;
|
|
23
|
+
isInstance = isInstance && "version" in value;
|
|
22
24
|
return isInstance;
|
|
23
25
|
}
|
|
24
26
|
export function VCCredentialTypeModelDtoSchemaFromJSON(json) {
|
|
@@ -32,6 +34,8 @@ export function VCCredentialTypeModelDtoSchemaFromJSONTyped(json, ignoreDiscrimi
|
|
|
32
34
|
'id': json['id'],
|
|
33
35
|
'schema_url': json['schema_url'],
|
|
34
36
|
'name': json['name'],
|
|
37
|
+
'archived': json['archived'],
|
|
38
|
+
'version': json['version'],
|
|
35
39
|
};
|
|
36
40
|
}
|
|
37
41
|
export function VCCredentialTypeModelDtoSchemaToJSON(value) {
|
|
@@ -45,5 +49,7 @@ export function VCCredentialTypeModelDtoSchemaToJSON(value) {
|
|
|
45
49
|
'id': value.id,
|
|
46
50
|
'schema_url': value.schema_url,
|
|
47
51
|
'name': value.name,
|
|
52
|
+
'archived': value.archived,
|
|
53
|
+
'version': value.version,
|
|
48
54
|
};
|
|
49
55
|
}
|
|
@@ -19,6 +19,8 @@ export function instanceOfVCCredentialTypeSchemaDto(value) {
|
|
|
19
19
|
isInstance = isInstance && "id" in value;
|
|
20
20
|
isInstance = isInstance && "schema_url" in value;
|
|
21
21
|
isInstance = isInstance && "name" in value;
|
|
22
|
+
isInstance = isInstance && "archived" in value;
|
|
23
|
+
isInstance = isInstance && "version" in value;
|
|
22
24
|
return isInstance;
|
|
23
25
|
}
|
|
24
26
|
export function VCCredentialTypeSchemaDtoFromJSON(json) {
|
|
@@ -32,6 +34,8 @@ export function VCCredentialTypeSchemaDtoFromJSONTyped(json, ignoreDiscriminator
|
|
|
32
34
|
'id': json['id'],
|
|
33
35
|
'schema_url': json['schema_url'],
|
|
34
36
|
'name': json['name'],
|
|
37
|
+
'archived': json['archived'],
|
|
38
|
+
'version': json['version'],
|
|
35
39
|
};
|
|
36
40
|
}
|
|
37
41
|
export function VCCredentialTypeSchemaDtoToJSON(value) {
|
|
@@ -45,5 +49,7 @@ export function VCCredentialTypeSchemaDtoToJSON(value) {
|
|
|
45
49
|
'id': value.id,
|
|
46
50
|
'schema_url': value.schema_url,
|
|
47
51
|
'name': value.name,
|
|
52
|
+
'archived': value.archived,
|
|
53
|
+
'version': value.version,
|
|
48
54
|
};
|
|
49
55
|
}
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
*/
|
|
14
14
|
import { exists } from '../runtime';
|
|
15
15
|
import { VCConstraintsDtoFromJSON, VCConstraintsDtoToJSON, } from './VCConstraintsDto';
|
|
16
|
+
import { VCFormatDtoFromJSON, VCFormatDtoToJSON, } from './VCFormatDto';
|
|
16
17
|
import { VCShemasDtoFromJSON, VCShemasDtoToJSON, } from './VCShemasDto';
|
|
17
18
|
/**
|
|
18
19
|
* Check if a given object implements the VCInputDescriptorsDto interface.
|
|
@@ -36,6 +37,7 @@ export function VCInputDescriptorsDtoFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
36
37
|
'name': !exists(json, 'name') ? undefined : json['name'],
|
|
37
38
|
'purpose': !exists(json, 'purpose') ? undefined : json['purpose'],
|
|
38
39
|
'constraints': !exists(json, 'constraints') ? undefined : VCConstraintsDtoFromJSON(json['constraints']),
|
|
40
|
+
'format': !exists(json, 'format') ? undefined : VCFormatDtoFromJSON(json['format']),
|
|
39
41
|
};
|
|
40
42
|
}
|
|
41
43
|
export function VCInputDescriptorsDtoToJSON(value) {
|
|
@@ -51,5 +53,6 @@ export function VCInputDescriptorsDtoToJSON(value) {
|
|
|
51
53
|
'name': value.name,
|
|
52
54
|
'purpose': value.purpose,
|
|
53
55
|
'constraints': VCConstraintsDtoToJSON(value.constraints),
|
|
56
|
+
'format': VCFormatDtoToJSON(value.format),
|
|
54
57
|
};
|
|
55
58
|
}
|
|
@@ -12,7 +12,6 @@
|
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
14
|
import { exists } from '../runtime';
|
|
15
|
-
import { VCFormatDtoFromJSON, VCFormatDtoToJSON, } from './VCFormatDto';
|
|
16
15
|
import { VCInputDescriptorsDtoFromJSON, VCInputDescriptorsDtoToJSON, } from './VCInputDescriptorsDto';
|
|
17
16
|
/**
|
|
18
17
|
* Check if a given object implements the VCPresentationDefinitionDto interface.
|
|
@@ -35,7 +34,6 @@ export function VCPresentationDefinitionDtoFromJSONTyped(json, ignoreDiscriminat
|
|
|
35
34
|
'input_descriptors': (json['input_descriptors'].map(VCInputDescriptorsDtoFromJSON)),
|
|
36
35
|
'name': !exists(json, 'name') ? undefined : json['name'],
|
|
37
36
|
'purpose': !exists(json, 'purpose') ? undefined : json['purpose'],
|
|
38
|
-
'format': !exists(json, 'format') ? undefined : VCFormatDtoFromJSON(json['format']),
|
|
39
37
|
};
|
|
40
38
|
}
|
|
41
39
|
export function VCPresentationDefinitionDtoToJSON(value) {
|
|
@@ -50,6 +48,5 @@ export function VCPresentationDefinitionDtoToJSON(value) {
|
|
|
50
48
|
'input_descriptors': (value.input_descriptors.map(VCInputDescriptorsDtoToJSON)),
|
|
51
49
|
'name': value.name,
|
|
52
50
|
'purpose': value.purpose,
|
|
53
|
-
'format': VCFormatDtoToJSON(value.format),
|
|
54
51
|
};
|
|
55
52
|
}
|
|
@@ -21,6 +21,7 @@ export function instanceOfVCPresentationDefinitionToSchemaModel(value) {
|
|
|
21
21
|
isInstance = isInstance && "schema_id" in value;
|
|
22
22
|
isInstance = isInstance && "schema_name" in value;
|
|
23
23
|
isInstance = isInstance && "schema_version" in value;
|
|
24
|
+
isInstance = isInstance && "archived" in value;
|
|
24
25
|
isInstance = isInstance && "constraints" in value;
|
|
25
26
|
return isInstance;
|
|
26
27
|
}
|
|
@@ -36,6 +37,7 @@ export function VCPresentationDefinitionToSchemaModelFromJSONTyped(json, ignoreD
|
|
|
36
37
|
'schema_id': json['schema_id'],
|
|
37
38
|
'schema_name': json['schema_name'],
|
|
38
39
|
'schema_version': json['schema_version'],
|
|
40
|
+
'archived': json['archived'],
|
|
39
41
|
'constraints': VCPresentationDefinitionToSchemaModelConstraintsFromJSON(json['constraints']),
|
|
40
42
|
};
|
|
41
43
|
}
|
|
@@ -51,6 +53,7 @@ export function VCPresentationDefinitionToSchemaModelToJSON(value) {
|
|
|
51
53
|
'schema_id': value.schema_id,
|
|
52
54
|
'schema_name': value.schema_name,
|
|
53
55
|
'schema_version': value.schema_version,
|
|
56
|
+
'archived': value.archived,
|
|
54
57
|
'constraints': VCPresentationDefinitionToSchemaModelConstraintsToJSON(value.constraints),
|
|
55
58
|
};
|
|
56
59
|
}
|
|
@@ -18,7 +18,6 @@ import { exists } from '../runtime';
|
|
|
18
18
|
export function instanceOfVCVerifyPresentationRequestResponseDto(value) {
|
|
19
19
|
let isInstance = true;
|
|
20
20
|
isInstance = isInstance && "request_uri" in value;
|
|
21
|
-
isInstance = isInstance && "id_token" in value;
|
|
22
21
|
return isInstance;
|
|
23
22
|
}
|
|
24
23
|
export function VCVerifyPresentationRequestResponseDtoFromJSON(json) {
|
|
@@ -30,8 +29,9 @@ export function VCVerifyPresentationRequestResponseDtoFromJSONTyped(json, ignore
|
|
|
30
29
|
}
|
|
31
30
|
return {
|
|
32
31
|
'request_uri': json['request_uri'],
|
|
33
|
-
'id_token': json['id_token'],
|
|
32
|
+
'id_token': !exists(json, 'id_token') ? undefined : json['id_token'],
|
|
34
33
|
'vp_token': !exists(json, 'vp_token') ? undefined : json['vp_token'],
|
|
34
|
+
'presentation_submission': !exists(json, 'presentation_submission') ? undefined : json['presentation_submission'],
|
|
35
35
|
'state': !exists(json, 'state') ? undefined : json['state'],
|
|
36
36
|
};
|
|
37
37
|
}
|
|
@@ -46,6 +46,7 @@ export function VCVerifyPresentationRequestResponseDtoToJSON(value) {
|
|
|
46
46
|
'request_uri': value.request_uri,
|
|
47
47
|
'id_token': value.id_token,
|
|
48
48
|
'vp_token': value.vp_token,
|
|
49
|
+
'presentation_submission': value.presentation_submission,
|
|
49
50
|
'state': value.state,
|
|
50
51
|
};
|
|
51
52
|
}
|
package/lib/esm/models/index.js
CHANGED
|
@@ -18,6 +18,8 @@ export * from './ATOMComponent';
|
|
|
18
18
|
export * from './ATOMCreateOrUpdateOrgRequest';
|
|
19
19
|
export * from './ATOMCreateOrUpdateTenantRequest';
|
|
20
20
|
export * from './ATOMError';
|
|
21
|
+
export * from './ATOMFileStorageBackend';
|
|
22
|
+
export * from './ATOMFileStorageConfiguration';
|
|
21
23
|
export * from './ATOMGenesisRequest';
|
|
22
24
|
export * from './ATOMNewAgentRequest';
|
|
23
25
|
export * from './ATOMOneAgent';
|
|
@@ -42,15 +42,11 @@ export interface InvitationsGetRequest {
|
|
|
42
42
|
meecoDelegationId?: string;
|
|
43
43
|
meecoOrganisationId?: string;
|
|
44
44
|
}
|
|
45
|
-
export interface
|
|
46
|
-
|
|
47
|
-
meecoDelegationId?: string;
|
|
48
|
-
meecoOrganisationId?: string;
|
|
49
|
-
}
|
|
50
|
-
export interface InvitationsIdGetRequest {
|
|
51
|
-
id: string;
|
|
45
|
+
export interface InvitationsInvitationIdAcceptPostRequest {
|
|
46
|
+
invitationId: string;
|
|
52
47
|
meecoDelegationId?: string;
|
|
53
48
|
meecoOrganisationId?: string;
|
|
49
|
+
acceptInvitationsRequest?: AcceptInvitationsRequest;
|
|
54
50
|
}
|
|
55
51
|
export interface InvitationsInvitationIdCancelDeleteRequest {
|
|
56
52
|
invitationId: string;
|
|
@@ -63,14 +59,18 @@ export interface InvitationsInvitationIdConfirmPostRequest {
|
|
|
63
59
|
meecoOrganisationId?: string;
|
|
64
60
|
acceptInvitationsRequest1?: AcceptInvitationsRequest1;
|
|
65
61
|
}
|
|
66
|
-
export interface
|
|
67
|
-
|
|
62
|
+
export interface InvitationsInvitationIdDeleteRequest {
|
|
63
|
+
invitationId: string;
|
|
68
64
|
meecoDelegationId?: string;
|
|
69
65
|
meecoOrganisationId?: string;
|
|
70
|
-
acceptInvitationsRequest?: AcceptInvitationsRequest;
|
|
71
66
|
}
|
|
72
|
-
export interface
|
|
73
|
-
|
|
67
|
+
export interface InvitationsInvitationIdGetRequest {
|
|
68
|
+
invitationId: string;
|
|
69
|
+
meecoDelegationId?: string;
|
|
70
|
+
meecoOrganisationId?: string;
|
|
71
|
+
}
|
|
72
|
+
export interface InvitationsInvitationIdRejectDeleteRequest {
|
|
73
|
+
invitationId: string;
|
|
74
74
|
meecoDelegationId?: string;
|
|
75
75
|
meecoOrganisationId?: string;
|
|
76
76
|
}
|
|
@@ -130,25 +130,15 @@ export declare class ConnectionsApi extends runtime.BaseAPI {
|
|
|
130
130
|
*/
|
|
131
131
|
invitationsGet(state?: string, nextPageAfter?: string, perPage?: number, page?: number, meecoDelegationId?: string, meecoOrganisationId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InvitationsResponse>;
|
|
132
132
|
/**
|
|
133
|
-
*
|
|
134
|
-
*
|
|
135
|
-
*/
|
|
136
|
-
invitationsIdDeleteRaw(requestParameters: InvitationsIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
137
|
-
/**
|
|
138
|
-
* Delete an invitation by its token or ID. Only the user who created the invitation may delete it.
|
|
139
|
-
* Delete an invitation
|
|
140
|
-
*/
|
|
141
|
-
invitationsIdDelete(id: string, meecoDelegationId?: string, meecoOrganisationId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
142
|
-
/**
|
|
143
|
-
* Read an invitation by its token or ID. Can be used by both the invitation sender, and someone with an invitation token.Fields `id` and `keypair_external_id` are NULL if the current user is not the sender of the invitation
|
|
144
|
-
* Read an invitation
|
|
133
|
+
* Accept an invitation. This endpoint is only available if the multistep invitation flow is enabled. Accepting an endpoint does not create a connection. After an invitation is accepted, the sender of the invitation needs to confirm it. --- If there is already a connection between these two users, then * the response will contain the existing connection * field `invitation` will be set to `NULL` * field `connection_existed_already` will be set to `true` * any share intents attached to the invitation will be used to create shares
|
|
134
|
+
* Accept an invitation
|
|
145
135
|
*/
|
|
146
|
-
|
|
136
|
+
invitationsInvitationIdAcceptPostRaw(requestParameters: InvitationsInvitationIdAcceptPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VaultInvitationAcceptedResponse>>;
|
|
147
137
|
/**
|
|
148
|
-
*
|
|
149
|
-
*
|
|
138
|
+
* Accept an invitation. This endpoint is only available if the multistep invitation flow is enabled. Accepting an endpoint does not create a connection. After an invitation is accepted, the sender of the invitation needs to confirm it. --- If there is already a connection between these two users, then * the response will contain the existing connection * field `invitation` will be set to `NULL` * field `connection_existed_already` will be set to `true` * any share intents attached to the invitation will be used to create shares
|
|
139
|
+
* Accept an invitation
|
|
150
140
|
*/
|
|
151
|
-
|
|
141
|
+
invitationsInvitationIdAcceptPost(invitationId: string, meecoDelegationId?: string, meecoOrganisationId?: string, acceptInvitationsRequest?: AcceptInvitationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VaultInvitationAcceptedResponse>;
|
|
152
142
|
/**
|
|
153
143
|
* Reject an accepted invitation. This endpoint is only available if the multistep invitation flow is enabled. First an invitation recipient accepts an an invitation is accepted, and then the sender of the invitation can reject it using this endpoint. Only the sender of the invitation can call this endpoint.
|
|
154
144
|
* Reject an accepted invitation
|
|
@@ -170,25 +160,35 @@ export declare class ConnectionsApi extends runtime.BaseAPI {
|
|
|
170
160
|
*/
|
|
171
161
|
invitationsInvitationIdConfirmPost(invitationId: string, meecoDelegationId?: string, meecoOrganisationId?: string, acceptInvitationsRequest1?: AcceptInvitationsRequest1, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VaultInvitationAcceptedResponse>;
|
|
172
162
|
/**
|
|
173
|
-
*
|
|
174
|
-
*
|
|
163
|
+
* Delete an invitation by its token or ID. Only the user who created the invitation may delete it.
|
|
164
|
+
* Delete an invitation
|
|
175
165
|
*/
|
|
176
|
-
|
|
166
|
+
invitationsInvitationIdDeleteRaw(requestParameters: InvitationsInvitationIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
177
167
|
/**
|
|
178
|
-
*
|
|
179
|
-
*
|
|
168
|
+
* Delete an invitation by its token or ID. Only the user who created the invitation may delete it.
|
|
169
|
+
* Delete an invitation
|
|
170
|
+
*/
|
|
171
|
+
invitationsInvitationIdDelete(invitationId: string, meecoDelegationId?: string, meecoOrganisationId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
172
|
+
/**
|
|
173
|
+
* Read an invitation by its token or ID. Can be used by both the invitation sender, and someone with an invitation token.Fields `id` and `keypair_external_id` are NULL if the current user is not the sender of the invitation
|
|
174
|
+
* Read an invitation
|
|
175
|
+
*/
|
|
176
|
+
invitationsInvitationIdGetRaw(requestParameters: InvitationsInvitationIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InvitationWithShareIntentsResponse>>;
|
|
177
|
+
/**
|
|
178
|
+
* Read an invitation by its token or ID. Can be used by both the invitation sender, and someone with an invitation token.Fields `id` and `keypair_external_id` are NULL if the current user is not the sender of the invitation
|
|
179
|
+
* Read an invitation
|
|
180
180
|
*/
|
|
181
|
-
|
|
181
|
+
invitationsInvitationIdGet(invitationId: string, meecoDelegationId?: string, meecoOrganisationId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InvitationWithShareIntentsResponse>;
|
|
182
182
|
/**
|
|
183
183
|
* Reject an invitation. This endpoint is only available if the multistep invitation flow is enabled.
|
|
184
184
|
* Reject an invitation
|
|
185
185
|
*/
|
|
186
|
-
|
|
186
|
+
invitationsInvitationIdRejectDeleteRaw(requestParameters: InvitationsInvitationIdRejectDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InvitationRejectedResponse>>;
|
|
187
187
|
/**
|
|
188
188
|
* Reject an invitation. This endpoint is only available if the multistep invitation flow is enabled.
|
|
189
189
|
* Reject an invitation
|
|
190
190
|
*/
|
|
191
|
-
|
|
191
|
+
invitationsInvitationIdRejectDelete(invitationId: string, meecoDelegationId?: string, meecoOrganisationId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InvitationRejectedResponse>;
|
|
192
192
|
/**
|
|
193
193
|
* Invite another user to connect. An invitation does not specify a recipient directly, instead the result of this operation is an invitation token which can then be sent to a recipient by a client application or some other means, mand the recipient can create a connection using this token and endpoint `POST /connections` --- Invitations and connections have 3 special use-cases: 1. a connection between an organization agent and an organization member 2. a connection between a service agent and a user of the service 3. a connection between a user and a delegate user who has been granted permissions to act on behalf of the user Blindly accepting an invitation by submitting an invitation token to `POST /connections` might have serious consequences, so client applications are advised to first read the invitation with `GET /invitations/{token}`before creating a connection. The intent of an invitation is in JSON field `integration_data`. --- For the membership invitation parameter `organization_member_role` is used to specify the role we are inviting the user with. There are currently 2 organization member roles: * `owner` - can do everything * `admin` (default) - can only manage organization services If param `organization_member_role` is not provided then role `admin` will be assigned to the invited member. --- For the delegation connection parameters `delegate_role` and `delegation_token` are mandatory. `delegation_token` should be obtained by running `POST /delegations` in the keystore. If `delegate_role` and `delegation_token` are present, a recipient is invited to become a delegate user who has rights to perform actions on behalf of the user who has created the invitation. Currently there are three delegate roles: * `owner` * `admin` * `reader` --- The vault supports two invitations workflows: * Simple - a sender creates an invitation. A recipient then accepts the invitation, and a connection is created. * Multistep - a sender creates an invitation. A recipient then accepts the invitation, no connection is created yet. The recipient then confirms the invitation, and a connection is created. An invitation is marked as belonging to one of these two workflows when created, boolean parameter `multistep_workflow` can be used for this. Values \'1\' and \'true\' are interpreted as true, as multistep invitation workflow. Each vault instance is configured to have a default invitation workflow. In case `multistep_workflow` is not submitted or is `null`, the default workflow is used.
|
|
194
194
|
* Create an invitation
|
|
@@ -24,6 +24,7 @@ export interface BlobsIdPutRequest {
|
|
|
24
24
|
id: string;
|
|
25
25
|
}
|
|
26
26
|
export interface BlobsPostRequest {
|
|
27
|
+
storageName: string;
|
|
27
28
|
aTOMBlobUploadUrlRequest: ATOMBlobUploadUrlRequest;
|
|
28
29
|
}
|
|
29
30
|
export interface TenantsTenantIdLogoGetRequest {
|
|
@@ -34,13 +35,13 @@ export interface TenantsTenantIdLogoGetRequest {
|
|
|
34
35
|
*/
|
|
35
36
|
export declare class HelpersApi extends runtime.BaseAPI {
|
|
36
37
|
/**
|
|
37
|
-
* Redirect to a file in
|
|
38
|
-
* Redirect to a file in
|
|
38
|
+
* Redirect to a file in a cloud file storage. This endpoint is public and it only requires the file key in the URL. The `Content Disposition` header in the response is hardcoded to be `inline` for now, but it can be made a parameter to this endpoint in future if needed. The filename and the content type included in `Content Disposition` are taken from the database record created in `POST /blobs`.\"
|
|
39
|
+
* Redirect to a file in a cloud file storage
|
|
39
40
|
*/
|
|
40
41
|
blobsIdGetRaw(requestParameters: BlobsIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
41
42
|
/**
|
|
42
|
-
* Redirect to a file in
|
|
43
|
-
* Redirect to a file in
|
|
43
|
+
* Redirect to a file in a cloud file storage. This endpoint is public and it only requires the file key in the URL. The `Content Disposition` header in the response is hardcoded to be `inline` for now, but it can be made a parameter to this endpoint in future if needed. The filename and the content type included in `Content Disposition` are taken from the database record created in `POST /blobs`.\"
|
|
44
|
+
* Redirect to a file in a cloud file storage
|
|
44
45
|
*/
|
|
45
46
|
blobsIdGet(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
46
47
|
/**
|
|
@@ -74,15 +75,15 @@ export declare class HelpersApi extends runtime.BaseAPI {
|
|
|
74
75
|
*/
|
|
75
76
|
blobsIdPut(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMBlobInfoResponse>;
|
|
76
77
|
/**
|
|
77
|
-
* Create a signed upload URL. This endpoint is the first step in creating a file. Just like most ATOM endpoints, this endpoint requires a valid user (that is, an IDP JWT) and some security rights. The security rights are those which might require to attach files to entities like organisations, tenants, and so on. Any of the following security rights grants a permission to create an upload URL * `atom:global:create_tenant` * `atom:global:create_org` * `atom:global:create_tenant_agent` * `atom:tenant:create_org` * `atom:tenant:create_agent` * `atom:org:create_agent` * `atom:tenant:create_tenant_agent` * `vc:tenant:manage` * `vc:org:manage` ATOM generates a random key under which a file will be registered, and creates a record in the database where the key is stored along with the filename and the content type. A client is then expected to use a signed URL present in response field `upload_url` to upload a file to
|
|
78
|
+
* Create a signed upload URL for one of the supported file storages. This endpoint is the first step in creating a file. Just like most ATOM endpoints, this endpoint requires a valid user (that is, an IDP JWT) and some security rights. The security rights are those which might require to attach files to entities like organisations, tenants, and so on. Any of the following security rights grants a permission to create an upload URL * `atom:global:create_tenant` * `atom:global:create_org` * `atom:global:create_tenant_agent` * `atom:tenant:create_org` * `atom:tenant:create_agent` * `atom:org:create_agent` * `atom:tenant:create_tenant_agent` * `vc:tenant:manage` * `vc:org:manage` ATOM generates a random key under which a file will be registered, and creates a record in the database where the key is stored along with the filename and the content type. A client is then expected to use a signed URL present in response field `upload_url` to upload a file to a cloud file storage. This URL is only valid for a short period of time specified in response field `upload_url_expires_in_seconds`. Uploading is done via HTTP method `PUT`. The response of this endpoint contains a list of headers which much be included in the `PUT` request. The following is an example curl command to upload a file: ``` curl --location --request PUT \\ \'https://meecodevstorage0.blob.core.windows.net/dev/66c35456-eb64-42fb-a31a-806530786fe2?se=2023-01-23T08%3A49%3A29Z&sig=mzuonk01F8L%2F0q7avsMvvenk2NwLFVXYsyWJeu5Jdgc%3D&sp=rw&sr=b&sv=2018-11-09\' \\ --header \'x-ms-blob-type: BlockBlob\' \\ --data-binary \'@/home/john/file.jpg\' ``` After the file is uploaded to Azure Blob Storage, the client is supposed to confirm this upload calling `PUT /blobs/{key}`. The response to `POST /blobs` also contains a URL to retrieve the file, but that functionality is only available after the upload has been confirmed, otherwise it will result in `404 NotFound`. All expired and not confirmed records created with this endpoint will be removed after a while.
|
|
78
79
|
* Obtain a signed upload URL
|
|
79
80
|
*/
|
|
80
81
|
blobsPostRaw(requestParameters: BlobsPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMBlobInfoResponse>>;
|
|
81
82
|
/**
|
|
82
|
-
* Create a signed upload URL. This endpoint is the first step in creating a file. Just like most ATOM endpoints, this endpoint requires a valid user (that is, an IDP JWT) and some security rights. The security rights are those which might require to attach files to entities like organisations, tenants, and so on. Any of the following security rights grants a permission to create an upload URL * `atom:global:create_tenant` * `atom:global:create_org` * `atom:global:create_tenant_agent` * `atom:tenant:create_org` * `atom:tenant:create_agent` * `atom:org:create_agent` * `atom:tenant:create_tenant_agent` * `vc:tenant:manage` * `vc:org:manage` ATOM generates a random key under which a file will be registered, and creates a record in the database where the key is stored along with the filename and the content type. A client is then expected to use a signed URL present in response field `upload_url` to upload a file to
|
|
83
|
+
* Create a signed upload URL for one of the supported file storages. This endpoint is the first step in creating a file. Just like most ATOM endpoints, this endpoint requires a valid user (that is, an IDP JWT) and some security rights. The security rights are those which might require to attach files to entities like organisations, tenants, and so on. Any of the following security rights grants a permission to create an upload URL * `atom:global:create_tenant` * `atom:global:create_org` * `atom:global:create_tenant_agent` * `atom:tenant:create_org` * `atom:tenant:create_agent` * `atom:org:create_agent` * `atom:tenant:create_tenant_agent` * `vc:tenant:manage` * `vc:org:manage` ATOM generates a random key under which a file will be registered, and creates a record in the database where the key is stored along with the filename and the content type. A client is then expected to use a signed URL present in response field `upload_url` to upload a file to a cloud file storage. This URL is only valid for a short period of time specified in response field `upload_url_expires_in_seconds`. Uploading is done via HTTP method `PUT`. The response of this endpoint contains a list of headers which much be included in the `PUT` request. The following is an example curl command to upload a file: ``` curl --location --request PUT \\ \'https://meecodevstorage0.blob.core.windows.net/dev/66c35456-eb64-42fb-a31a-806530786fe2?se=2023-01-23T08%3A49%3A29Z&sig=mzuonk01F8L%2F0q7avsMvvenk2NwLFVXYsyWJeu5Jdgc%3D&sp=rw&sr=b&sv=2018-11-09\' \\ --header \'x-ms-blob-type: BlockBlob\' \\ --data-binary \'@/home/john/file.jpg\' ``` After the file is uploaded to Azure Blob Storage, the client is supposed to confirm this upload calling `PUT /blobs/{key}`. The response to `POST /blobs` also contains a URL to retrieve the file, but that functionality is only available after the upload has been confirmed, otherwise it will result in `404 NotFound`. All expired and not confirmed records created with this endpoint will be removed after a while.
|
|
83
84
|
* Obtain a signed upload URL
|
|
84
85
|
*/
|
|
85
|
-
blobsPost(aTOMBlobUploadUrlRequest: ATOMBlobUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMBlobInfoResponse>;
|
|
86
|
+
blobsPost(storageName: string, aTOMBlobUploadUrlRequest: ATOMBlobUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMBlobInfoResponse>;
|
|
86
87
|
/**
|
|
87
88
|
* Redirect to the logo of a tenant. This endpoint is public and it only requires the tenant ID in the URL.
|
|
88
89
|
* Redirect to the logo of a tenant
|