@factset/sdk-barraportfoliooptimizer

@factset/sdk-barraportfoliooptimizer

barraportfoliooptimizer - JavaScript client for @factset/sdk-barraportfoliooptimizer Allow clients to fetch Analytics through APIs. This SDK is automatically generated by the OpenAPI Generator project:

• API version: 3
• Package version: 0.9.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://developer.factset.com/contact

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install @factset/sdk-barraportfoliooptimizer --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your @factset/sdk-barraportfoliooptimizer from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

Getting Started

Please follow the installation instruction and execute the following JS code:

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

const apiClient = ApiClient.instance;

// Configure HTTP basic authorization: FactSetApiKey
const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
FactSetApiKey.username = 'YOUR USERNAME';
FactSetApiKey.password = 'YOUR PASSWORD';

// Configure OAuth2 access token for authorization: FactSetOAuth2
const FactSetOAuth2 = apiClient.authentications['FactSetOAuth2'];
FactSetOAuth2.accessToken = 'YOUR ACCESS TOKEN';

// Configure OAuth2 access with ConfidentialClient
apiClient.factsetOauth2Client = new ConfidentialClient('./config.json');

const apiInstance = new AccountsApi();
const path = "'Client:Foo/Bar'"; // 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);
  },
);

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
barraportfoliooptimizer.AccountsApi	getAccounts	GET /analytics/lookups/v3/accounts/{path}	Get accounts and sub-directories in a directory
barraportfoliooptimizer.BPMOptimizerApi	cancelOptimizationById	DELETE /analytics/engines/bpm/v3/optimizations/{id}	Cancel BPM optimization by id
barraportfoliooptimizer.BPMOptimizerApi	getOptimizationParameters	GET /analytics/engines/bpm/v3/optimizations/{id}	Get BPM optimization parameters by id
barraportfoliooptimizer.BPMOptimizerApi	getOptimizationResult	GET /analytics/engines/bpm/v3/optimizations/{id}/result	Get BPM optimization result by id
barraportfoliooptimizer.BPMOptimizerApi	getOptimizationStatusById	GET /analytics/engines/bpm/v3/optimizations/{id}/status	Get BPM optimization status by id
barraportfoliooptimizer.BPMOptimizerApi	postAndOptimize	POST /analytics/engines/bpm/v3/optimizations	Create and Run BPM optimization
barraportfoliooptimizer.BPMOptimizerApi	putAndOptimize	PUT /analytics/engines/bpm/v3/optimizations/{id}	Create or Update BPM optimization and run it.
barraportfoliooptimizer.CurrenciesApi	getCurrencies	GET /analytics/lookups/v3/currencies	Get currencies
barraportfoliooptimizer.StrategyDocumentsApi	getBarraStrategyDocuments	GET /analytics/engines/bpm/v3/strategies/{path}	Get Barra strategy documents and sub-directories in a directory

Documentation for Models

• barraportfoliooptimizer.AccountDirectories
• barraportfoliooptimizer.AccountDirectoriesRoot
• barraportfoliooptimizer.BPMOptimization
• barraportfoliooptimizer.BPMOptimizationParameters
• barraportfoliooptimizer.BPMOptimizationParametersRoot
• barraportfoliooptimizer.BPMOptimizerStrategy
• barraportfoliooptimizer.BPMOptimizerStrategyAlphaOverride
• barraportfoliooptimizer.BPMOptimizerStrategyOverrides
• barraportfoliooptimizer.CalculationInfo
• barraportfoliooptimizer.CalculationInfoRoot
• barraportfoliooptimizer.ClientErrorResponse
• barraportfoliooptimizer.ConstraintAction
• barraportfoliooptimizer.Currency
• barraportfoliooptimizer.CurrencyRoot
• barraportfoliooptimizer.DocumentDirectories
• barraportfoliooptimizer.DocumentDirectoriesRoot
• barraportfoliooptimizer.Error
• barraportfoliooptimizer.ErrorSource
• barraportfoliooptimizer.ObjectRoot
• barraportfoliooptimizer.OptimalPortfolio
• barraportfoliooptimizer.OptimizerAccount
• barraportfoliooptimizer.OptimizerAccountOverrides
• barraportfoliooptimizer.OptimizerOptimalHoldings
• barraportfoliooptimizer.OptimizerOutputTypes
• barraportfoliooptimizer.OptimizerTradesList

Documentation for Authorization

FactSetApiKey

• Type: HTTP basic authentication

FactSetOAuth2

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