@sphereon/ssi-sdk.kms-rest-client 0.34.1-feature.IDK.11.48

package/src/models/KeyProvider.ts

@@ -0,0 +1,82 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KMS REST Server API
+ * A REST API for managing cryptographic keys and performing signing and verification operations.
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * Contact: support@sphereon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import type { KeyProviderType } from './KeyProviderType';
+import {
+    KeyProviderTypeFromJSON,
+    KeyProviderTypeToJSON,
+} from './KeyProviderType';
+
+/**
+ * Response body containing the details of a Key Provider instance.
+ * @export
+ * @interface KeyProvider
+ */
+export interface KeyProvider {
+    /**
+     * The unique identifier assigned to the Key Provider instance upon creation.
+     * @type {string}
+     * @memberof KeyProvider
+     */
+    providerId: string;
+    /**
+     *
+     * @type {KeyProviderType}
+     * @memberof KeyProvider
+     */
+    type: KeyProviderType;
+}
+
+
+
+/**
+ * Check if a given object implements the KeyProvider interface.
+ */
+export function instanceOfKeyProvider(value: object): value is KeyProvider {
+    if (!('providerId' in value) || value['providerId'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    return true;
+}
+
+export function KeyProviderFromJSON(json: any): KeyProvider {
+    return KeyProviderFromJSONTyped(json, false);
+}
+
+export function KeyProviderFromJSONTyped(json: any, ignoreDiscriminator: boolean): KeyProvider {
+    if (json == null) {
+        return json;
+    }
+    return {
+
+        'providerId': json['providerId'],
+        'type': KeyProviderTypeFromJSON(json['type']),
+    };
+}
+
+export function KeyProviderToJSON(json: any): KeyProvider {
+    return KeyProviderToJSONTyped(json, false);
+}
+
+export function KeyProviderToJSONTyped(value?: KeyProvider | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+
+        'providerId': value['providerId'],
+        'type': KeyProviderTypeToJSON(value['type']),
+    };
+}
+

package/src/models/KeyProviderResponse.ts

@@ -0,0 +1,82 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KMS REST Server API
+ * A REST API for managing cryptographic keys and performing signing and verification operations.
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * Contact: support@sphereon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import type { KeyProviderType } from './KeyProviderType';
+import {
+    KeyProviderTypeFromJSON,
+    KeyProviderTypeToJSON,
+} from './KeyProviderType';
+
+/**
+ * Response body containing the details of a Key Provider instance.
+ * @export
+ * @interface KeyProviderResponse
+ */
+export interface KeyProviderResponse {
+    /**
+     * The unique identifier assigned to the Key Provider instance upon creation.
+     * @type {string}
+     * @memberof KeyProviderResponse
+     */
+    providerId: string;
+    /**
+     *
+     * @type {KeyProviderType}
+     * @memberof KeyProviderResponse
+     */
+    type: KeyProviderType;
+}
+
+
+
+/**
+ * Check if a given object implements the KeyProviderResponse interface.
+ */
+export function instanceOfKeyProviderResponse(value: object): value is KeyProviderResponse {
+    if (!('providerId' in value) || value['providerId'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    return true;
+}
+
+export function KeyProviderResponseFromJSON(json: any): KeyProviderResponse {
+    return KeyProviderResponseFromJSONTyped(json, false);
+}
+
+export function KeyProviderResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): KeyProviderResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+
+        'providerId': json['providerId'],
+        'type': KeyProviderTypeFromJSON(json['type']),
+    };
+}
+
+export function KeyProviderResponseToJSON(json: any): KeyProviderResponse {
+    return KeyProviderResponseToJSONTyped(json, false);
+}
+
+export function KeyProviderResponseToJSONTyped(value?: KeyProviderResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+
+        'providerId': value['providerId'],
+        'type': KeyProviderTypeToJSON(value['type']),
+    };
+}
+

package/src/models/KeyProviderType.ts

@@ -0,0 +1,54 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KMS REST Server API
+ * A REST API for managing cryptographic keys and performing signing and verification operations. 
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * Contact: support@sphereon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * The type of Key Provider. Determines the required configuration settings. - AZURE_KEYVAULT: Microsoft Azure Key Vault or Managed HSM. - AWS_KMS: Amazon Web Services Key Management Service.
+ * @export
+ */
+export const KeyProviderType = {
+    Software: 'SOFTWARE',
+    AzureKeyvault: 'AZURE_KEYVAULT',
+    AwsKms: 'AWS_KMS'
+} as const;
+export type KeyProviderType = typeof KeyProviderType[keyof typeof KeyProviderType];
+
+
+export function instanceOfKeyProviderType(value: any): boolean {
+    for (const key in KeyProviderType) {
+        if (Object.prototype.hasOwnProperty.call(KeyProviderType, key)) {
+            if (KeyProviderType[key as keyof typeof KeyProviderType] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function KeyProviderTypeFromJSON(json: any): KeyProviderType {
+    return KeyProviderTypeFromJSONTyped(json, false);
+}
+
+export function KeyProviderTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): KeyProviderType {
+    return json as KeyProviderType;
+}
+
+export function KeyProviderTypeToJSON(value?: KeyProviderType | null): any {
+    return value as any;
+}
+
+export function KeyProviderTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): KeyProviderType {
+    return value as KeyProviderType;
+}
+

package/src/models/KeyResolver.ts

@@ -0,0 +1,92 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KMS REST Server API
+ * A REST API for managing cryptographic keys and performing signing and verification operations.
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * Contact: support@sphereon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import type { KeyType } from './KeyType';
+import {
+    KeyTypeFromJSON,
+    KeyTypeToJSON,
+} from './KeyType';
+import type { IdentifierMethod } from './IdentifierMethod';
+import {
+    IdentifierMethodFromJSON,
+    IdentifierMethodToJSON,
+} from './IdentifierMethod';
+
+/**
+ * Represents a key resolver instance with detailed configuration.
+ * @export
+ * @interface KeyResolver
+ */
+export interface KeyResolver {
+    /**
+     * Unique identifier for the resolver.
+     * @type {string}
+     * @memberof KeyResolver
+     */
+    resolverId: string;
+    /**
+     * List of identifier methods supported by this resolver.
+     * @type {Array<IdentifierMethod>}
+     * @memberof KeyResolver
+     */
+    supportedIdentifierMethods?: Array<IdentifierMethod>;
+    /**
+     * List of key types supported by this resolver.
+     * @type {Array<KeyType>}
+     * @memberof KeyResolver
+     */
+    supportedKeyTypes?: Array<KeyType>;
+}
+
+/**
+ * Check if a given object implements the KeyResolver interface.
+ */
+export function instanceOfKeyResolver(value: object): value is KeyResolver {
+    if (!('resolverId' in value) || value['resolverId'] === undefined) return false;
+    return true;
+}
+
+export function KeyResolverFromJSON(json: any): KeyResolver {
+    return KeyResolverFromJSONTyped(json, false);
+}
+
+export function KeyResolverFromJSONTyped(json: any, ignoreDiscriminator: boolean): KeyResolver {
+    if (json == null) {
+        return json;
+    }
+    return {
+
+        'resolverId': json['resolverId'],
+        'supportedIdentifierMethods': json['supportedIdentifierMethods'] == null ? undefined : ((json['supportedIdentifierMethods'] as Array<any>).map(IdentifierMethodFromJSON)),
+        'supportedKeyTypes': json['supportedKeyTypes'] == null ? undefined : ((json['supportedKeyTypes'] as Array<any>).map(KeyTypeFromJSON)),
+    };
+}
+
+export function KeyResolverToJSON(json: any): KeyResolver {
+    return KeyResolverToJSONTyped(json, false);
+}
+
+export function KeyResolverToJSONTyped(value?: KeyResolver | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+
+        'resolverId': value['resolverId'],
+        'supportedIdentifierMethods': value['supportedIdentifierMethods'] == null ? undefined : ((value['supportedIdentifierMethods'] as Array<any>).map(IdentifierMethodToJSON)),
+        'supportedKeyTypes': value['supportedKeyTypes'] == null ? undefined : ((value['supportedKeyTypes'] as Array<any>).map(KeyTypeToJSON)),
+    };
+}
+

package/src/models/KeyType.ts

@@ -0,0 +1,54 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KMS REST Server API
+ * A REST API for managing cryptographic keys and performing signing and verification operations. 
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * Contact: support@sphereon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * Cryptographic key type identifier.
+ * @export
+ */
+export const KeyType = {
+    Okp: 'OKP',
+    Ec: 'EC',
+    Rsa: 'RSA'
+} as const;
+export type KeyType = typeof KeyType[keyof typeof KeyType];
+
+
+export function instanceOfKeyType(value: any): boolean {
+    for (const key in KeyType) {
+        if (Object.prototype.hasOwnProperty.call(KeyType, key)) {
+            if (KeyType[key as keyof typeof KeyType] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function KeyTypeFromJSON(json: any): KeyType {
+    return KeyTypeFromJSONTyped(json, false);
+}
+
+export function KeyTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): KeyType {
+    return json as KeyType;
+}
+
+export function KeyTypeToJSON(value?: KeyType | null): any {
+    return value as any;
+}
+
+export function KeyTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): KeyType {
+    return value as KeyType;
+}
+

package/src/models/KeyVisibility.ts

@@ -0,0 +1,53 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KMS REST Server API
+ * A REST API for managing cryptographic keys and performing signing and verification operations. 
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * Contact: support@sphereon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * Indicates the visibility status of a cryptographic key.
+ * @export
+ */
+export const KeyVisibility = {
+    Public: 'PUBLIC',
+    Private: 'PRIVATE'
+} as const;
+export type KeyVisibility = typeof KeyVisibility[keyof typeof KeyVisibility];
+
+
+export function instanceOfKeyVisibility(value: any): boolean {
+    for (const key in KeyVisibility) {
+        if (Object.prototype.hasOwnProperty.call(KeyVisibility, key)) {
+            if (KeyVisibility[key as keyof typeof KeyVisibility] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function KeyVisibilityFromJSON(json: any): KeyVisibility {
+    return KeyVisibilityFromJSONTyped(json, false);
+}
+
+export function KeyVisibilityFromJSONTyped(json: any, ignoreDiscriminator: boolean): KeyVisibility {
+    return json as KeyVisibility;
+}
+
+export function KeyVisibilityToJSON(value?: KeyVisibility | null): any {
+    return value as any;
+}
+
+export function KeyVisibilityToJSONTyped(value: any, ignoreDiscriminator: boolean): KeyVisibility {
+    return value as KeyVisibility;
+}
+

package/src/models/ListKeyProvidersResponse.ts

@@ -0,0 +1,71 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KMS REST Server API
+ * A REST API for managing cryptographic keys and performing signing and verification operations.
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * Contact: support@sphereon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import type { KeyProvider } from './KeyProvider';
+import {
+    KeyProviderFromJSON,
+    KeyProviderToJSON,
+} from './KeyProvider';
+
+/**
+ * Response body containing the details of a Key Provider instance.
+ * @export
+ * @interface ListKeyProvidersResponse
+ */
+export interface ListKeyProvidersResponse {
+    /**
+     *
+     * @type {Array<KeyProvider>}
+     * @memberof ListKeyProvidersResponse
+     */
+    providers: Array<KeyProvider>;
+}
+
+/**
+ * Check if a given object implements the ListKeyProvidersResponse interface.
+ */
+export function instanceOfListKeyProvidersResponse(value: object): value is ListKeyProvidersResponse {
+    if (!('providers' in value) || value['providers'] === undefined) return false;
+    return true;
+}
+
+export function ListKeyProvidersResponseFromJSON(json: any): ListKeyProvidersResponse {
+    return ListKeyProvidersResponseFromJSONTyped(json, false);
+}
+
+export function ListKeyProvidersResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListKeyProvidersResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+
+        'providers': ((json['providers'] as Array<any>).map(KeyProviderFromJSON)),
+    };
+}
+
+export function ListKeyProvidersResponseToJSON(json: any): ListKeyProvidersResponse {
+    return ListKeyProvidersResponseToJSONTyped(json, false);
+}
+
+export function ListKeyProvidersResponseToJSONTyped(value?: ListKeyProvidersResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+
+        'providers': ((value['providers'] as Array<any>).map(KeyProviderToJSON)),
+    };
+}
+

package/src/models/ListKeysResponse.ts

@@ -0,0 +1,71 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KMS REST Server API
+ * A REST API for managing cryptographic keys and performing signing and verification operations.
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * Contact: support@sphereon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import type { ManagedKeyInfo } from './ManagedKeyInfo';
+import {
+    ManagedKeyInfoFromJSON,
+    ManagedKeyInfoToJSON,
+} from './ManagedKeyInfo';
+
+/**
+ * Response body containing all the managed keys.
+ * @export
+ * @interface ListKeysResponse
+ */
+export interface ListKeysResponse {
+    /**
+     *
+     * @type {Array<ManagedKeyInfo>}
+     * @memberof ListKeysResponse
+     */
+    keyInfos: Array<ManagedKeyInfo>;
+}
+
+/**
+ * Check if a given object implements the ListKeysResponse interface.
+ */
+export function instanceOfListKeysResponse(value: object): value is ListKeysResponse {
+    if (!('keyInfos' in value) || value['keyInfos'] === undefined) return false;
+    return true;
+}
+
+export function ListKeysResponseFromJSON(json: any): ListKeysResponse {
+    return ListKeysResponseFromJSONTyped(json, false);
+}
+
+export function ListKeysResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListKeysResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+
+        'keyInfos': ((json['keyInfos'] as Array<any>).map(ManagedKeyInfoFromJSON)),
+    };
+}
+
+export function ListKeysResponseToJSON(json: any): ListKeysResponse {
+    return ListKeysResponseToJSONTyped(json, false);
+}
+
+export function ListKeysResponseToJSONTyped(value?: ListKeysResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+
+        'keyInfos': ((value['keyInfos'] as Array<any>).map(ManagedKeyInfoToJSON)),
+    };
+}
+

package/src/models/ListResolversResponse.ts

@@ -0,0 +1,71 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KMS REST Server API
+ * A REST API for managing cryptographic keys and performing signing and verification operations.
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * Contact: support@sphereon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import type { Resolver } from './Resolver';
+import {
+    ResolverFromJSON,
+    ResolverToJSON,
+} from './Resolver';
+
+/**
+ * Response body containing all the resolvers.
+ * @export
+ * @interface ListResolversResponse
+ */
+export interface ListResolversResponse {
+    /**
+     *
+     * @type {Array<Resolver>}
+     * @memberof ListResolversResponse
+     */
+    resolvers: Array<Resolver>;
+}
+
+/**
+ * Check if a given object implements the ListResolversResponse interface.
+ */
+export function instanceOfListResolversResponse(value: object): value is ListResolversResponse {
+    if (!('resolvers' in value) || value['resolvers'] === undefined) return false;
+    return true;
+}
+
+export function ListResolversResponseFromJSON(json: any): ListResolversResponse {
+    return ListResolversResponseFromJSONTyped(json, false);
+}
+
+export function ListResolversResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListResolversResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+
+        'resolvers': ((json['resolvers'] as Array<any>).map(ResolverFromJSON)),
+    };
+}
+
+export function ListResolversResponseToJSON(json: any): ListResolversResponse {
+    return ListResolversResponseToJSONTyped(json, false);
+}
+
+export function ListResolversResponseToJSONTyped(value?: ListResolversResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+
+        'resolvers': ((value['resolvers'] as Array<any>).map(ResolverToJSON)),
+    };
+}
+

package/src/models/LookupMode.ts

@@ -0,0 +1,54 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KMS REST Server API
+ * A REST API for managing cryptographic keys and performing signing and verification operations. 
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * Contact: support@sphereon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * Determines how configuration values are looked up. - VALUE: The actual configuration values are provided directly. - CONFIG_SERVICE: Configuration values are looked up from a configuration service using keys. - SECRET_SERVICE: Configuration values are looked up from a secret service using keys.
+ * @export
+ */
+export const LookupMode = {
+    Value: 'VALUE',
+    ConfigService: 'CONFIG_SERVICE',
+    SecretService: 'SECRET_SERVICE'
+} as const;
+export type LookupMode = typeof LookupMode[keyof typeof LookupMode];
+
+
+export function instanceOfLookupMode(value: any): boolean {
+    for (const key in LookupMode) {
+        if (Object.prototype.hasOwnProperty.call(LookupMode, key)) {
+            if (LookupMode[key as keyof typeof LookupMode] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function LookupModeFromJSON(json: any): LookupMode {
+    return LookupModeFromJSONTyped(json, false);
+}
+
+export function LookupModeFromJSONTyped(json: any, ignoreDiscriminator: boolean): LookupMode {
+    return json as LookupMode;
+}
+
+export function LookupModeToJSON(value?: LookupMode | null): any {
+    return value as any;
+}
+
+export function LookupModeToJSONTyped(value: any, ignoreDiscriminator: boolean): LookupMode {
+    return value as LookupMode;
+}
+