Portfolio Reporting Batcher client library for JavaScript

The Portfolio Reporting Batcher (PRB) API allows clients to systematically leverage functionalities of the PRB application.

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

• API version: 0.6.0
• SDK version: 0.24.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/[email protected]

yarn

yarn add @factset/sdk-utils @factset/[email protected]

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, JobsApi } = require('@factset/sdk-portfolioreportingbatcher');
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 JobsApi();
const type = new portfolioreportingbatcher.JobTypes(); // JobTypes | The jobs type
const name = "name_example"; // String | The jobs name
const opts = {
  'attribute': ["null"] // [String] | The attribute parameter accepts a list of the given enums, separated by commas. Each of them returns the respective data associated with the job. Runs returns the run history of the job.
};

// Call api endpoint
apiInstance.getDetailsForJob(type, name, opts).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-portfolioreportingbatcher');

const apiClient = ApiClient.instance;
apiClient.setProxyUrl('http://username:[email protected]:8080');

Documentation for API Endpoints

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

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- portfolioreportingbatcher.JobsApi | getDetailsForJob | GET /jobs/{type}/{name} | Get details for the given PRB job portfolioreportingbatcher.JobsApi | getPrbJobs | GET /jobs | Get a list of existing jobs portfolioreportingbatcher.RunsApi | cancelRunId | DELETE /runs/{id} | cancel runs portfolioreportingbatcher.RunsApi | checkRunStatus | GET /runs/{id}/status | check the status for a particular run ID portfolioreportingbatcher.RunsApi | startJobRun | POST /runs | trigger PRB jobs

Documentation for Models

• portfolioreportingbatcher.AccountsForJobAddProp
• portfolioreportingbatcher.Calendar
• portfolioreportingbatcher.ClientErrorResponse
• portfolioreportingbatcher.Error
• portfolioreportingbatcher.ErrorSource
• portfolioreportingbatcher.Frequency
• portfolioreportingbatcher.IdStatus
• portfolioreportingbatcher.IdStatusData
• portfolioreportingbatcher.JobDetailsResponse
• portfolioreportingbatcher.JobDetailsResponseData
• portfolioreportingbatcher.JobListResponse
• portfolioreportingbatcher.JobListResponseMeta
• portfolioreportingbatcher.JobListResponseMetaPagination
• portfolioreportingbatcher.JobListResponseRoot
• portfolioreportingbatcher.JobOverrides
• portfolioreportingbatcher.JobOverridesCombinationsRoot
• portfolioreportingbatcher.JobOverridesCombinationsRootDateRange
• portfolioreportingbatcher.JobTypes
• portfolioreportingbatcher.PrbStatus
• portfolioreportingbatcher.RunsForJob
• portfolioreportingbatcher.StartJob
• portfolioreportingbatcher.StartJobRoot
• portfolioreportingbatcher.StartJobRunResponse
• portfolioreportingbatcher.StartJobRunResponseData
• portfolioreportingbatcher.Status

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.