affinidi_tdk_vault_data_manager_client 1.11.0 copy "affinidi_tdk_vault_data_manager_client: ^1.11.0" to clipboard
affinidi_tdk_vault_data_manager_client: ^1.11.0 copied to clipboard

Affinidi TDK dart client for Affinidi VAULT DATA MANAGER

affinidi_tdk_vault_data_manager_client (EXPERIMENTAL) #

Affinidi TDK dart client for Affinidi VAULT DATA MANAGER

Requirements #

Installation & Usage #

pub.dev #

To use the package from pub.dev, please include the following in pubspec.yaml

dependencies:
  affinidi_tdk_vault_data_manager_client: ^1.0.0

Github #

This Dart package is published to Github, please include the following in pubspec.yaml

dependencies:
  affinidi_tdk_vault_data_manager_client:
    git:
      url: https://github.com/affinidi/affinidi-tdk.git
      ref: main
      path: clients/dart/vault_data_manager_client

Local development #

To use the package from your local drive, please include the following in pubspec.yaml

dependencies:
  affinidi_tdk_vault_data_manager_client:
    path: /path/to/affinidi_tdk_vault_data_manager_client

Install dependencies #

dart pub get

Getting Started #

Please follow the installation procedure and then run the following:

import 'package:affinidi_tdk_vault_data_manager_client/affinidi_tdk_vault_data_manager_client.dart';


final api = AffinidiTdkVaultDataManagerClient().getAccountsApi();
final CreateAccountInput createAccountInput = ; // CreateAccountInput | CreateAccount

try {
    final response = await api.createAccount(createAccountInput);
    print(response);
} catch on DioException (e) {
    print("Exception when calling AccountsApi->createAccount: $e\n");
}

Documentation for API Endpoints #

All URIs are relative to https://api.vault.affinidi.com/vfs

Class Method HTTP request Description
AccountsApi createAccount POST /v1/accounts
AccountsApi deleteAccount DELETE /v1/accounts/{accountIndex}
AccountsApi listAccounts GET /v1/accounts
AccountsApi updateAccount PUT /v1/accounts/{accountIndex}
ConfigApi getConfig GET /v1/config
FilesApi getScannedFileInfo GET /v1/scanned-files/{scannedFileJobId}
FilesApi listScannedFiles GET /v1/scanned-files/
FilesApi startFileScan POST /v1/nodes/{nodeId}/file/scan
NodesApi createNode POST /v1/nodes
NodesApi deleteNode DELETE /v1/nodes/{nodeId}
NodesApi getDetailedNodeInfo GET /v1/nodes/{nodeId}
NodesApi initNodes POST /v1/nodes/init
NodesApi listNodeChildren GET /v1/nodes/{nodeId}/children
NodesApi listRootNodeChildren GET /v1/nodes
NodesApi moveNode POST /v1/nodes/{nodeId}/move
NodesApi permanentlyDeleteNode DELETE /v1/nodes/{nodeId}/remove/{nodeIdToRemove}
NodesApi restoreNodeFromTrashbin POST /v1/nodes/{nodeId}/restore/{nodeIdToRestore}
NodesApi updateNode PATCH /v1/nodes/{nodeId}
ProfileDataApi queryProfileData GET /v1/nodes/{nodeId}/profile-data
ProfileDataApi updateProfileData PATCH /v1/nodes/{nodeId}/profile-data
WellKnownApi getWellKnownJwks GET /.well-known/jwks.json

Documentation For Models #

  • AccountDto
  • AwsCredentialExchangeOperationOK
  • ConsumerMetadataDto
  • CorsAwsCredentialExchangeOK
  • CorsDeleteAccountOK
  • CorsDeleteNodeOK
  • CorsGetConfigOK
  • CorsGetScannedFileInfoOK
  • CorsGetWellKnownJwksOK
  • CorsInitNodesOK
  • CorsListAccountsOK
  • CorsListNodeChildrenOK
  • CorsListRootNodeChildrenOK
  • CorsListScannedFilesOK
  • CorsMoveNodeOK
  • CorsPermanentlyDeleteNodeOK
  • CorsRestoreNodeFromTrashbinOK
  • CorsStartFileScanOK
  • CorsUpdateProfileDataOK
  • CreateAccountInput
  • CreateAccountOK
  • CreateNodeInput
  • CreateNodeOK
  • DeleteAccountDto
  • DeleteNodeDto
  • EdekInfo
  • GetConfigOK
  • GetDetailedNodeInfoOK
  • GetScannedFileInfoOK
  • InitNodesOK
  • InvalidParameterError
  • InvalidParameterErrorDetailsInner
  • JsonWebKeyDto
  • JsonWebKeySetDto
  • ListAccountsDto
  • ListNodeChildrenOK
  • ListRootNodeChildrenOK
  • ListScannedFilesOK
  • ListScannedFilesOKScannedFilesInner
  • MoveNodeDto
  • MoveNodeInput
  • NodeDto
  • NodeStatus
  • NodeType
  • NotFoundError
  • QueryProfileDataOK
  • RestoreNodeFromTrashbin
  • StartFileScanInput
  • StartFileScanOK
  • UnexpectedError
  • UpdateAccountDto
  • UpdateAccountInput
  • UpdateNodeInput
  • UpdateProfileDataInput
  • UpdateProfileDataOK

Documentation For Authorization #

Authentication schemes defined for the API:

AwsSigV4 #

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

ApiKey #

  • Type: API key
  • API key parameter name: x-api-key
  • Location: HTTP header

bearerAuth #

  • Type: HTTP Bearer Token authentication (JWT)

ConsumerTokenAuth #

  • Type: API key
  • API key parameter name: authorization
  • Location: HTTP header

UserTokenAuth #

  • Type: API key
  • API key parameter name: authorization
  • Location: HTTP header

ProjectTokenAuth #

  • Type: API key
  • API key parameter name: authorization
  • Location: HTTP header

Author #

[email protected]