@factset/sdk-vault

Vault client library for JavaScript

Allow clients to fetch Analytics through APIs.

This TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:

• API version: 3.14.6
• SDK version: 3.0.0
• Build package: com.factset.sdk.codegen.FactSetJavascriptClientCodegen

For more information, please visit https://developer.factset.com/contact

Requirements

• Node.js >= 18

Installation

npm

npm install @factset/sdk-utils @factset/sdk-vault@3.0.0

yarn

yarn add @factset/sdk-utils @factset/sdk-vault@3.0.0

Usage

1. Generate authentication credentials.
2. Setup Node.js environment

   1. Install and activate Node.js >=18. If you're using nvm:

      nvm install 18
      nvm use 18

   2. (optional) Install yarn.

3. Install dependencies.
4. Run the following:

[!IMPORTANT] The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, AccountsApi } = require('@factset/sdk-vault');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Examples for each supported authentication method are below,
// choose one that satisfies your use case.

// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new AccountsApi();
const path = Client:; // String | The directory to get the accounts and sub-directories in

// Call api endpoint
apiInstance.getAccounts(path).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Using a Proxy

To add a HTTP proxy for the API client, you can set the proxyUrl for the ApiClient instance:

const { ApiClient } = require('@factset/sdk-vault');

const apiClient = ApiClient.instance;
apiClient.setProxyUrl('http://username:[e-mail]:8080');

Documentation for API Endpoints

All URIs are relative to https://api.factset.com

Class	Method	HTTP request	Description
vault.AccountsApi	getAccounts	GET /analytics/lookups/v3/accounts/{path}	Get accounts and sub-directories in a directory
vault.ComponentsApi	getVaultComponentById	GET /analytics/engines/vault/v3/components/{id}	Get Vault component by id
vault.ComponentsApi	getVaultComponents	GET /analytics/engines/vault/v3/components	Get Vault components
vault.ConfigurationsApi	getVaultConfigurationById	GET /analytics/engines/vault/v3/configurations/{id}	Get Vault configuration by id
vault.ConfigurationsApi	getVaultConfigurations	GET /analytics/engines/vault/v3/configurations	Get Vault configurations
vault.DatesApi	convertVaultDatesToAbsoluteFormat	GET /analytics/engines/vault/v3/dates	Convert Vault dates to absolute format
vault.DocumentsApi	getVaultDocuments	GET /analytics/engines/vault/v3/documents/{path}	Get Vault documents and sub-directories in a directory
vault.FrequenciesApi	getVaultFrequencies	GET /analytics/engines/vault/v3/frequencies	Get Vault frequencies
vault.VaultCalculationsApi	cancelCalculationById	DELETE /analytics/engines/vault/v3/calculations/{id}	Cancel Vault calculation by id
vault.VaultCalculationsApi	getAllCalculations	GET /analytics/engines/vault/v3/calculations	Get all calculations
vault.VaultCalculationsApi	getCalculationParameters	GET /analytics/engines/vault/v3/calculations/{id}	Get Vault calculation parameters by id
vault.VaultCalculationsApi	getCalculationStatusById	GET /analytics/engines/vault/v3/calculations/{id}/status	Get Vault calculation status by id
vault.VaultCalculationsApi	getCalculationUnitResultById	GET /analytics/engines/vault/v3/calculations/{id}/units/{unitId}/result	Get Vault calculation result by id
vault.VaultCalculationsApi	postAndCalculate	POST /analytics/engines/vault/v3/calculations	Create and Run Vault calculation
vault.VaultCalculationsApi	putAndCalculate	PUT /analytics/engines/vault/v3/calculations/{id}	Create or Update Vault calculation and run it.

Documentation for Models

• vault.AccountDirectories
• vault.AccountDirectoriesRoot
• vault.CalculationMeta
• vault.CalculationStatus
• vault.CalculationStatusMeta
• vault.CalculationStatusRoot
• vault.CalculationUnitStatus
• vault.CalculationUnitStatusMeta
• vault.CalculationsSummary
• vault.CalculationsSummaryRoot
• vault.ClientErrorResponse
• vault.ComponentSummary
• vault.ComponentSummaryRoot
• vault.ConfigurationAccount
• vault.DateParametersSummary
• vault.DateParametersSummaryRoot
• vault.DocumentDirectories
• vault.DocumentDirectoriesRoot
• vault.Error
• vault.ErrorSource
• vault.Frequency
• vault.FrequencyRoot
• vault.ObjectRoot
• vault.PaginationInfo
• vault.PaginationMeta
• vault.VaultCalculationParameters
• vault.VaultCalculationParametersRoot
• vault.VaultComponent
• vault.VaultComponentRoot
• vault.VaultConfiguration
• vault.VaultConfigurationRoot
• vault.VaultConfigurationSummary
• vault.VaultConfigurationSummaryRoot
• vault.VaultDateParameters
• vault.VaultIdentifier

Documentation for Authorization

FactSetApiKey

• Type: HTTP basic authentication

FactSetOAuth2

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes: N/A

Contributing

Please refer to the contributing guide.

Copyright

Copyright 2022 FactSet Research Systems Inc

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.