@vouched-id/sdk

v0.1.0-alpha.8

Published

6 months ago

OpenAPI client for @vouched/kya-sdk

0High
0Medium
0Low

h0bb5

axios typescript openapi-client openapi-generator @vouched/kya-sdk

@vouched/[email protected]

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

Node.js
Webpack
Browserify

Language level

ES5 - you must have a Promises/A+ library installed
ES6

Module system

CommonJS
ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @vouched/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to http://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AccountsApi | addMemberToAccountApiAccountsAccountIdMembersPost | POST /api/accounts/{account_id}/members | Add a member to a business account. @alias addAccountMember AccountsApi | createAccountEndpointApiAccountsCreatePost | POST /api/accounts/create | Create a new account for the authenticated user. @alias createAccount AccountsApi | getAccountEndpointApiAccountsAccountIdGet | GET /api/accounts/{account_id} | Get account details by ID. @alias getAccountByID AccountsApi | listAccountsApiAccountsListGet | GET /api/accounts/list | List accounts for the authenticated user. @alias listUserAccounts AccountsApi | removeMemberFromAccountApiAccountsAccountIdMembersMemberIdDelete | DELETE /api/accounts/{account_id}/members/{member_id} | Remove a member from a business account. @alias removeAccountMember AgentApi | authenticateAgentApiAgentAuthenticatePost | POST /api/agent/authenticate | Authenticate Agent AgentApi | createAgentDelegationApiAgentDelegatePost | POST /api/agent/delegate | Create Agent Delegation AgentApi | getDelegationsByOwnerIdApiAgentDelegationsOwnerIdGet | GET /api/agent/delegations/{owner_id} | Get Delegations By Owner Id AgentApi | getDelegationsForAgentApiAgentAgentDelegationsAgentIdGet | GET /api/agent/agent-delegations/{agent_id} | Get Delegations For Agent AgentApi | revokeAgentDelegationApiAgentDelegationDelegationIdDelete | DELETE /api/agent/delegation/{delegation_id} | Revoke Agent Delegation AgentApi | verifyAgentAuthorityApiAgentVerifyPost | POST /api/agent/verify | Verify Agent Authority ApiKeysApi | adminListAllUsersApiApiKeysAdminListUsersGet | GET /api/api-keys/admin/list-users | Admin List All Users ApiKeysApi | createApiKeyApiApiKeysCreatePost | POST /api/api-keys/create | Create Api Key ApiKeysApi | deleteApiKeyApiApiKeysKeyIdDelete | DELETE /api/api-keys/{key_id} | Delete Api Key ApiKeysApi | listApiKeysApiApiKeysListGet | GET /api/api-keys/list | List Api Keys AuthApi | authHealthCheckApiAuthHealthGet | GET /api/auth/health | Auth Health Check AuthApi | bypassAuthApiAuthUtilsBypassAuthGet | GET /api/auth-utils/bypass-auth | Bypass Auth AuthApi | checkLoginStatusApiAuthLoginStatusGet | GET /api/auth/login-status | Check Login Status AuthApi | createApiKeyApiAuthApiKeysPost | POST /api/auth/api-keys | Create Api Key AuthApi | deleteApiKeyApiAuthApiKeysKeyIdDelete | DELETE /api/auth/api-keys/{key_id} | Delete Api Key AuthApi | getCurrentUserInfoApiAuthMeGet | GET /api/auth/me | Get Current User Info AuthApi | listApiKeysApiAuthApiKeysGet | GET /api/auth/api-keys | List Api Keys AuthApi | logoutApiAuthLogoutPost | POST /api/auth/logout | Logout AuthUtilsApi | authSetupGuideApiAuthUtilsSetupGuideGet | GET /api/auth-utils/setup-guide | Auth Setup Guide AuthUtilsApi | checkAuthStatusApiAuthUtilsAuthStatusGet | GET /api/auth-utils/auth-status | Check Auth Status CredentialsApi | getCredentialByIdEndpointApiCredentialsCredentialIdGet | GET /api/credentials/{credential_id} | Get a specific credential by its ID. @alias getCredentialByID CredentialsApi | getCredentialsBatchEndpointApiCredentialsBatchGet | GET /api/credentials/batch | Batch get credentials by IDs (comma-separated string). @alias getCredentialsBatchGET CredentialsApi | getCredentialsBatchPostEndpointApiCredentialsBatchPost | POST /api/credentials/batch | Batch get credentials by IDs (JSON list). @alias getCredentialsBatchPOST CredentialsApi | issueCredentialEndpointApiCredentialsIssuePost | POST /api/credentials/issue | Issue a verifiable credential. @alias issueCredential CredentialsApi | issueCredentialFromVerificationEndpointApiCredentialsIssueFromVerificationPost | POST /api/credentials/issue-from-verification | Issue a credential from a prior verification (Placeholder). @alias issueCredentialFromVerification CredentialsApi | listCredentialsEndpointApiCredentialsListGet | GET /api/credentials/list | List stored credentials, optionally by subject ID. @alias listCredentials CredentialsApi | verifyCredentialEndpointApiCredentialsVerifyPost | POST /api/credentials/verify | Verify a credential by ID or presented VC/VP. @alias verifyCredential CredentialsApi | verifyCredentialForLlmEndpointApiCredentialsVerifyForLlmPost | POST /api/credentials/verify-for-llm | Verify credential with LLM-specific context. @alias verifyCredentialForLLM CustomerMappingApi | customerMappingCreate | POST /api/did/customer-mapping | Create a customer ID to DID mapping. @alias createCustomerDIDMapping CustomerMappingApi | customerMappingDelete | DELETE /api/did/customer-mapping | Delete a customer ID to DID mapping. @alias deleteCustomerDIDMapping CustomerMappingApi | customerMappingDeriveDidFromCustomerId | POST /api/did/customer-mapping/derive | Deterministically derive a DID from a customer ID. @alias deriveDIDFromCustomerID CustomerMappingApi | customerMappingGetCustomerIdByDid | GET /api/did/customer-mapping/by-did | Get customer ID by DID. @alias getCustomerIDByDID CustomerMappingApi | customerMappingGetDidByCustomerId | GET /api/did/customer-mapping/by-customer-id | Get DID by customer ID. @alias getDIDByCustomerID CustomerMappingApi | customerMappingGetOrCreateDid | GET /api/did/customer-mapping/get-or-create-did | Get existing DID or create a new one for a customer. @alias getOrCreateCustomerDID CustomerMappingApi | customerMappingListAll | GET /api/did/customer-mapping/list | List all customer ID to DID mappings. @alias listCustomerDIDMappings DefaultApi | getOauthDocumentationApiOauthDocsGet | GET /api/oauth-docs/ | Get Oauth Documentation DelegationsApi | authenticateAgentApiDelegationsAuthenticateAgentPost | POST /api/delegations/authenticate-agent | Authenticate an agent using a delegation. @alias authenticateAgentWithDelegation DelegationsApi | createDelegationApiDelegationsCreatePost | POST /api/delegations/create | Create a new delegation. @alias createDelegation DelegationsApi | delegateCredentialApiDelegationsDelegatePost | POST /api/delegations/delegate | Delegate permissions/credentials to an agent. @alias delegateToAgent DelegationsApi | getDelegationApiDelegationsDelegationIdGet | GET /api/delegations/{delegation_id} | Get a delegation by its ID. @alias getDelegationByID DelegationsApi | listAgentDelegationsApiDelegationsAgentAgentDidGet | GET /api/delegations/agent/{agent_did} | List all delegations for a specific agent (delegatee). @alias listAgentDelegations DelegationsApi | listDelegationsApiDelegationsListGet | GET /api/delegations/list | List delegations with optional filters. @alias listDelegations DelegationsApi | listDelegationsDevApiDelegationsDevListGet | GET /api/delegations/dev/list | List all delegations for auth user (dev only). @alias listAllUserDelegationsDev DelegationsApi | listOwnerDelegationsApiDelegationsOwnerOwnerDidGet | GET /api/delegations/owner/{owner_did} | List all delegations made by a specific owner (delegator). @alias listOwnerDelegations DelegationsApi | repairRegistryEndpointApiDelegationsMaintenanceRepairRegistryGet | GET /api/delegations/maintenance/repair-registry | Repair delegations registry (maintenance). @alias repairDelegationRegistry DelegationsApi | revokeDelegationByIdApiDelegationsDelegationIdRevokePost | POST /api/delegations/{delegation_id}/revoke | Revoke a delegation by its ID. @alias revokeDelegationByID DelegationsApi | verifyDelegationChainApiDelegationsVerifyPost | POST /api/delegations/verify | Verify a delegation chain between a delegator and delegatee. @alias verifyDelegationChain DidApi | customerMappingCreate | POST /api/did/customer-mapping | Create a customer ID to DID mapping. @alias createCustomerDIDMapping DidApi | customerMappingDelete | DELETE /api/did/customer-mapping | Delete a customer ID to DID mapping. @alias deleteCustomerDIDMapping DidApi | customerMappingDeriveDidFromCustomerId | POST /api/did/customer-mapping/derive | Deterministically derive a DID from a customer ID. @alias deriveDIDFromCustomerID DidApi | customerMappingGetCustomerIdByDid | GET /api/did/customer-mapping/by-did | Get customer ID by DID. @alias getCustomerIDByDID DidApi | customerMappingGetDidByCustomerId | GET /api/did/customer-mapping/by-customer-id | Get DID by customer ID. @alias getDIDByCustomerID DidApi | customerMappingGetOrCreateDid | GET /api/did/customer-mapping/get-or-create-did | Get existing DID or create a new one for a customer. @alias getOrCreateCustomerDID DidApi | customerMappingListAll | GET /api/did/customer-mapping/list | List all customer ID to DID mappings. @alias listCustomerDIDMappings DidApi | didCreate | POST /api/did/create | Create a new DID and its DID Document. @alias createDID DidApi | didGetOrCreateUserDid | GET /api/did/get-or-create | Get existing DID for the user or create a new one. @alias getOrCreateUserDID DidApi | didListPlatformStored | GET /api/did/list | List platform-stored DIDs for a user or account. @alias listPlatformDIDs DidApi | didListPublic | GET /api/did/public/list | List all public DIDs in the system. @alias listPublicDIDs DidApi | didResolve | POST /api/did/resolve | Resolve a DID to its DID Document. @alias resolveDID DidApi | didSimpleResolveForTest | POST /api/did/simple-resolve | Simple DID resolution without didkit (testing). @alias simpleResolveDIDForTest DidWebResolverApi | resolvePathBasedDidWebFullPathDidJsonGet | GET /{full_path}/did.json | Resolve a did:web DID hosted at a specific path. DidWebResolverApi | resolveWellKnownDidWebWellKnownDidJsonGet | GET /.well-known/did.json | Resolve a did:web DID hosted at the root well-known path. DocumentationApi | localDevelopmentGuideApiDocsLocalDevelopmentGuideGet | GET /api/docs/local-development-guide | Local Development Guide EnhancedStorageApi | getStatusApiEnhancedStorageStatusGet | GET /api/enhanced-storage/status | Get Status EnhancedStorageApi | initializeTablesApiEnhancedStorageInitializePost | POST /api/enhanced-storage/initialize | Initialize Tables EnhancedStorageApi | migrateDataApiEnhancedStorageMigratePost | POST /api/enhanced-storage/migrate | Migrate Data ExampleApi | exampleCreateItem | POST /api/portable/example/items | Create Example Item ExampleApi | exampleDeleteItemById | DELETE /api/portable/example/items/{item_id} | Delete Example Item ExampleApi | exampleGetEnvironmentInfo | GET /api/portable/example/environment | Get Environment Info ExampleApi | exampleGetItemById | GET /api/portable/example/items/{item_id} | Get Example Item ExampleApi | exampleGetStorageBasicInfo | GET /api/portable/example/storage/info | Get Storage Basic Info ExampleApi | exampleGetStorageDetailedInfo | GET /api/portable/example/storage/detailed-info | Get Storage Info ExampleApi | exampleListItems | GET /api/portable/example/items | List Example Items ExampleApi | exampleSendNotification | POST /api/portable/example/notify | Send Example Notification HealthApi | databaseHealthApiHealthDatabaseGet | GET /api/health/database | Database Health HealthApi | databaseHealthHealthDatabaseGet | GET /health/database | Database Health HealthApi | healthCheckHealthGet | GET /health | Health Check HealthApi | kubernetesHealthCheckApiPrefixedApiHealthzGet | GET /api/_healthz | Kubernetes Health Check Api Prefixed HealthApi | kubernetesHealthCheckHealthzGet | GET /_healthz | Kubernetes Health Check HealthApi | mainApiHealthCheck | GET /api/health | Health Check HealthApi | pingApiHealthPingGet | GET /api/health/ping | Ping HealthApi | pingHealthPingGet | GET /health/ping | Ping HealthApi | systemInfoApiHealthSystemGet | GET /api/health/system | System Info HealthApi | systemInfoHealthSystemGet | GET /health/system | System Info McpApi | authenticateApiMcpAuthPost | POST /api/mcp/auth | Authenticate McpApi | checkMcpHealthApiMcpConfigHealthGet | GET /api/mcp-config/health | Check Mcp Health McpApi | executeToolApiMcpExecutePost | POST /api/mcp/execute | Execute Tool McpApi | getManifestApiMcpManifestGet | GET /api/mcp/manifest | Get Manifest McpApi | getMcpConfigApiMcpConfigGet | GET /api/mcp-config/ | Get Mcp Config McpApi | oauthExecuteToolApiMcpOauthExecutePost | POST /api/mcp/oauth/execute | Oauth Execute Tool MigrationApi | getMigrationStatusApiMigrationStatusGet | GET /api/migration/status | Get Migration Status MigrationApi | migrateDataToSupabaseApiMigrationToSupabasePost | POST /api/migration/to-supabase | Migrate Data To Supabase OauthApi | actualAuthorizeEndpointApiOauthAuthorizeGet | GET /api/oauth/authorize | Actual Authorize Endpoint OauthApi | getTokenApiOauthUserDidServiceGet | GET /api/oauth/{user_did}/{service} | Get Token OauthApi | introspectTokenApiOauthIntrospectPost | POST /api/oauth/introspect | Introspect Token OauthApi | listTokensApiOauthListGet | GET /api/oauth/list | List Tokens OauthApi | oauthServerMetadataApiOauthWellKnownOauthAuthorizationServerGet | GET /api/oauth/.well-known/oauth-authorization-server | Oauth Server Metadata OauthApi | registerClientApiOauthRegisterPost | POST /api/oauth/register | Register Client OauthApi | revokeTokenEndpointApiOauthRevokePost | POST /api/oauth/revoke | Revoke Token Endpoint OauthApi | simulateAuthorizationApiOauthSimulateAuthorizePost | POST /api/oauth/simulate-authorize | Simulate Authorization OauthApi | storeOauthTokenEndpointApiOauthStorePost | POST /api/oauth/store | Store Oauth Token Endpoint OauthApi | tokenEndpointApiOauthTokenPost | POST /api/oauth/token | Token Endpoint PortableApi | exampleCreateItem | POST /api/portable/example/items | Create Example Item PortableApi | exampleDeleteItemById | DELETE /api/portable/example/items/{item_id} | Delete Example Item PortableApi | exampleGetEnvironmentInfo | GET /api/portable/example/environment | Get Environment Info PortableApi | exampleGetItemById | GET /api/portable/example/items/{item_id} | Get Example Item PortableApi | exampleGetStorageBasicInfo | GET /api/portable/example/storage/info | Get Storage Basic Info PortableApi | exampleGetStorageDetailedInfo | GET /api/portable/example/storage/detailed-info | Get Storage Info PortableApi | exampleListItems | GET /api/portable/example/items | List Example Items PortableApi | exampleSendNotification | POST /api/portable/example/notify | Send Example Notification PortableApi | portableCheckTablesStatus | GET /api/portable/check-tables-status | Check Tables Status PortableApi | portableGetStatus | GET /api/portable/status | Get Portable Status PortableApi | portableMigrateStorage | GET /api/portable/migrate-storage | Migrate Storage PortableApi | portableSetupStorageTables | GET /api/portable/setup-storage-tables | Setup Storage Tables SDKApi | sdkDocumentationApiSdkDocGet | GET /api/sdk-doc | Sdk Documentation SdksApi | downloadSdkApiSdksDownloadSdkNameGet | GET /api/sdks/download/{sdk_name} | Download Sdk SdksApi | getSdkConfigApiSdksConfigSdkNameGet | GET /api/sdks/config/{sdk_name} | Get Sdk Config SdksApi | getSdkDocsIndexApiSdksDocsIndexGet | GET /api/sdks/docs-index | Get Sdk Docs Index SdksApi | getSdkInfoApiSdksSdkNameGet | GET /api/sdks/{sdk_name} | Get Sdk Info SdksApi | getSdkVersionsApiSdksVersionsSdkNameGet | GET /api/sdks/versions/{sdk_name} | Get Sdk Versions SdksApi | listSdksApiSdksGet | GET /api/sdks | List Sdks StorageApi | createBackupApiStorageBackupsPost | POST /api/storage/backups | Create Backup StorageApi | deleteBackupApiStorageBackupsBackupIdDelete | DELETE /api/storage/backups/{backup_id} | Delete Backup StorageApi | deleteRawStorageApiStorageRawKeyDelete | DELETE /api/storage/raw/{key} | Delete Raw Storage StorageApi | getBackupApiStorageBackupsBackupIdGet | GET /api/storage/backups/{backup_id} | Get Backup StorageApi | getRawStorageApiStorageRawStorageTypeKeyGet | GET /api/storage/raw/{storage_type}/{key} | Get Raw Storage StorageApi | getStorageConfigApiStorageManagementConfigGet | GET /api/storage/management-config | Get Storage Config StorageApi | getStorageInfoApiStorageInfoGet | GET /api/storage/info | Get Storage Info StorageApi | getStorageStatusApiStorageStatusGet | GET /api/storage/status | Get Storage Status StorageApi | listBackupsApiStorageBackupsGet | GET /api/storage/backups | List Backups StorageApi | listRawStorageApiStorageRawListPrefixGet | GET /api/storage/raw/list/{prefix} | List Raw Storage StorageApi | putRawStorageApiStorageRawStorageTypeKeyPut | PUT /api/storage/raw/{storage_type}/{key} | Put Raw Storage StorageApi | restoreBackupApiStorageBackupsBackupIdRestorePost | POST /api/storage/backups/{backup_id}/restore | Restore Backup StorageApi | updateStorageConfigApiStorageManagementConfigPut | PUT /api/storage/management-config | Update Storage Config StreamApi | streamEventsApiSseEventsGet | GET /api/sse/events | Stream Events StreamApi | streamEventsApiSseEventsGet_0 | GET /api/sse/events | Stream Events StreamApi | streamEventsPostApiSseEventsPost | POST /api/sse/events | Stream Events Post StreamApi | streamEventsPostApiSseEventsPost_0 | POST /api/sse/events | Stream Events Post SupabaseApi | checkSupabaseStatusApiSupabaseStatusGet | GET /api/supabase/status | Check Supabase Status SupabaseApi | setupStorageTablesApiSupabaseSetupTablesPost | POST /api/supabase/setup-tables | Setup Storage Tables TrustRegistryApi | createTrustRelationshipApiTrustRegistryRelationshipsPost | POST /api/trust-registry/relationships | Create Trust Relationship TrustRegistryApi | createTrustedEntityApiTrustRegistryEntitiesPost | POST /api/trust-registry/entities | Create Trusted Entity TrustRegistryApi | deleteTrustRelationshipApiTrustRegistryRelationshipsRelationshipIdDelete | DELETE /api/trust-registry/relationships/{relationship_id} | Delete Trust Relationship TrustRegistryApi | deleteTrustedEntityApiTrustRegistryEntitiesEntityIdDelete | DELETE /api/trust-registry/entities/{entity_id} | Delete Trusted Entity TrustRegistryApi | getTrustRelationshipApiTrustRegistryRelationshipsRelationshipIdGet | GET /api/trust-registry/relationships/{relationship_id} | Get Trust Relationship TrustRegistryApi | getTrustedEntityApiTrustRegistryEntitiesEntityIdGet | GET /api/trust-registry/entities/{entity_id} | Get Trusted Entity TrustRegistryApi | listTrustRelationshipsApiTrustRegistryRelationshipsGet | GET /api/trust-registry/relationships | List Trust Relationships TrustRegistryApi | listTrustedEntitiesApiTrustRegistryEntitiesGet | GET /api/trust-registry/entities | List Trusted Entities WalletApi | deleteCredentialEndpointApiWalletDeletePost | POST /api/wallet/delete | Delete Credential Endpoint WalletApi | demoLlmAccessEndpointApiWalletDemoLlmAccessPost | POST /api/wallet/demo/llm-access | Demo Llm Access Endpoint WalletApi | llmAccessEndpointApiWalletLlmAccessPost | POST /api/wallet/llm-access | Llm Access Endpoint WalletApi | queryWalletEndpointApiWalletQueryPost | POST /api/wallet/query | Query Wallet Endpoint WalletApi | retrieveCredentialEndpointApiWalletRetrievePost | POST /api/wallet/retrieve | Retrieve Credential Endpoint WalletApi | storeCredentialEndpointApiWalletStorePost | POST /api/wallet/store | Store Credential Endpoint

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

@vouched/[email protected]

Building

Publishing

Consuming

Documentation for API Endpoints

Documentation For Models

Documentation For Authorization

APIKeyHeader