2.0.0 • Published 9 months ago

@factset/sdk-vermilion v2.0.0

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
9 months ago

FactSet

Vermilion client library for JavaScript

API Version npm Apache-2 license

Documentation on all available end points in the VRSAPI

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

  • API version: 1.0.0
  • SDK version: 2.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-vermilion@2.0.0

yarn

yarn add @factset/sdk-utils @factset/sdk-vermilion@2.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, DatasourceApi } = require('@factset/sdk-vermilion');
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 DatasourceApi();
const tenant = TENANT; // String | The code of the tenancy
const opts = {
  'sort': ["name"], // [String] | The column to sort on. Append - to sort in descending order. If parameter is not given, no sorting will be done
  'paginationLimit': 10, // Number | Non-negative maximum number of entries to return. Default is 25
  'paginationOffset': 0 // Number | Non-negative number of entries to skip. Default is 0
};

// Call api endpoint
apiInstance.getAllDataSources(tenant, 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-vermilion');

const apiClient = ApiClient.instance;
apiClient.setProxyUrl('http://username:password@proxy.example.com:8080');

Documentation for API Endpoints

All URIs are relative to http://localhost

ClassMethodHTTP requestDescription
vermilion.DatasourceApigetAllDataSourcesGET /v1/{tenant}/data-sourcesLists all datasources
vermilion.DatasourceApigetDataSourceByCodeGET /v1/{tenant}/data-sources/{dataSourceCode}Gets a datasource
vermilion.DatasourceApigetDataSourceDataGET /v1/{tenant}/data-sources/{dataSourceCode}/dataGets the data for the datasource
vermilion.EntityApigetEntityValuesByCodeGET /v1/{tenant}/entities/{entityCode}/valuesGets the entity values
vermilion.ReportApigetAllReportDefinitionsGET /v1/{tenant}/reportsGets all report definitions
vermilion.ReportApigetReportDefinitionByCodeGET /v1/{tenant}/reports/{reportDefinitionCode}Gets a report definition
vermilion.ReportInstanceApicancelReportGenerationDELETE /v1/{tenant}/report-instances/{reportInstanceId}Cancels a report generation
vermilion.ReportInstanceApidownloadReportFileGET /v1/{tenant}/report-instances/{reportInstanceId}/results/{reportFileName}Gets the generated file
vermilion.ReportInstanceApigetAllReportInstancesGET /v1/{tenant}/report-instancesGets a list of report instances
vermilion.ReportInstanceApigetReportGenerationLogsGET /v1/{tenant}/report-instances/{reportInstanceId}/logsGets a list of logs for the report instance generation
vermilion.ReportInstanceApigetReportInstanceByIdGET /v1/{tenant}/report-instances/{reportInstanceId}Gets a report instance based on the ID
vermilion.ReportInstanceApistartReportGenerationPOST /v1/report-instances/generateGenerates a report
vermilion.SCIMApicreateGroupPOST /scim/v2/GroupsCreates a role
vermilion.SCIMApicreateUserPOST /scim/v2/UsersCreates a user
vermilion.SCIMApideleteGroupByIdDELETE /scim/v2/Groups/{groupId}Deletes a VRS role
vermilion.SCIMApideleteUserByIdDELETE /scim/v2/Users/{userId}Deletes a VRS user
vermilion.SCIMApigetAllGroupsGET /scim/v2/GroupsRetrieves a list of VRS role
vermilion.SCIMApigetAllUsersGET /scim/v2/UsersRetrieves a list of VRS users
vermilion.SCIMApigetGroupByIdGET /scim/v2/Groups/{groupId}Retrieves a VRS role
vermilion.SCIMApigetUserByIdGET /scim/v2/Users/{userId}Retrieves a VRS User
vermilion.SCIMApipatchGroupByIdPATCH /scim/v2/Groups/{groupId}Add or remove a user to/from a group
vermilion.SCIMApipatchUserByIdPATCH /scim/v2/Users/{userId}Add or remove VRS user attributes
vermilion.SCIMApiupdateGroupByIdPUT /scim/v2/Groups/{groupId}Updates a VRS Group
vermilion.SCIMApiupdateUserByIdPUT /scim/v2/Users/{userId}Updates a VRS user
vermilion.VersionApigetVersionGET /v1/versionGets the version of VRS,WRS and DBServer
vermilion.WorkflowApigenerateSchedulePOST /v1/{tenant}/schedules/{scheduleDefinitionCode}Creates schedule for the specified schedule definition
vermilion.WorkflowApigetScheduleDefinitionsGET /v1/{tenant}/schedule-definitionsRetrieves a list of all schedule definitions
vermilion.WorkflowApigetScheduleGenerationLogsGET /v1/{tenant}/schedules/{scheduleId}/logsGets the generation logs for a specific schedule
vermilion.WorkflowApigetSchedulesGET /v1/{tenant}/schedulesRetrieves a list of all schedules
vermilion.WorkflowApiupdateScheduleStatusPATCH /v1/{tenant}/schedules/{scheduleId}/{status}Update schedule status for specified schedule

Documentation for Models

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.

2.0.0

9 months ago

1.2.0

10 months ago

1.1.0

12 months ago

1.0.0

1 year ago

0.1.0

1 year ago