@factset/sdk-openfactsetpartnersdocuments v3.0.4

Open:FactSet Partners - Documents client library for JavaScript

This service provides the capability to search and download unstructured content provided by <a href=\"https://open.factset.com/catalog/en-us\">Open:FactSet Partners.

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

• API version: 2.0.0
• Package version: 3.0.4
• Build package: com.factset.sdk.codegen.FactSetJavascriptClientCodegen

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

Requirements

• Node.js >= 14

Installation

npm

npm install @factset/sdk-utils @factset/sdk-openfactsetpartnersdocuments@3.0.4

yarn

yarn add @factset/sdk-utils @factset/sdk-openfactsetpartnersdocuments@3.0.4

Usage

1. Generate authentication credentials.

2. Setup Node.js environment

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

      nvm install 16
      nvm use 16

   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, LinkUpApi } = require('@factset/sdk-openfactsetpartnersdocuments');
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 LinkUpApi();
const opts = {
  'sort': "'-startDate'", // String | Enables to get the data in ascending or descending order based on startTime. Results are in reverse chronological order if this parameter is not used.
  'paginationLimit': 20, // Number | Specifies the maximum number of results to return per result.
  'paginationOffset': 0, // Number | Specifies the starting point for pagination. This parameter is used to identify the beginning of next set of results. Using this parameter can fetch maximum of first 10000 records.
  'startDate': 2020-01-01, // Date | The earliest date of the LinkUp file the API should fetching for based on fileTimestamp.
  'endDate': 2021-08-01, // Date | The latest date of the LinkUp file the API should fetching for based on fileTimestamp.
  'type': "'delta'" // String | Used to provide the full job descriptions when value \"full\" is used for this parameter.
};

// Call api endpoint
apiInstance.getLinkUpJobListings(opts).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/bulk-documents/ofm/v2

Documentation for Models

• openfactsetpartnersdocuments.AuthStatus
• openfactsetpartnersdocuments.BeamEndpointsFiles
• openfactsetpartnersdocuments.BeamEndpointsResponse
• openfactsetpartnersdocuments.BiomarkersFiles
• openfactsetpartnersdocuments.BiomarkersResponse
• openfactsetpartnersdocuments.Bonds
• openfactsetpartnersdocuments.CollaboratorsFiles
• openfactsetpartnersdocuments.CollaboratorsResponse
• openfactsetpartnersdocuments.DataFiles
• openfactsetpartnersdocuments.DataResponse
• openfactsetpartnersdocuments.DiseasesFiles
• openfactsetpartnersdocuments.DiseasesResponse
• openfactsetpartnersdocuments.ErrorExample
• openfactsetpartnersdocuments.FullHistoryFiles
• openfactsetpartnersdocuments.FullHistoryResponse
• openfactsetpartnersdocuments.InterventionFiles
• openfactsetpartnersdocuments.InterventionResponse
• openfactsetpartnersdocuments.LinkUpResponse
• openfactsetpartnersdocuments.LinkupFiles
• openfactsetpartnersdocuments.LuxResponse
• openfactsetpartnersdocuments.Meta
• openfactsetpartnersdocuments.OrangePurpleFiles
• openfactsetpartnersdocuments.OrangePurpleResponse
• openfactsetpartnersdocuments.OrbitFiles
• openfactsetpartnersdocuments.OrbitHistoryFiles
• openfactsetpartnersdocuments.OrbitResponse
• openfactsetpartnersdocuments.OrbithistoryResponse
• openfactsetpartnersdocuments.Pagination
• openfactsetpartnersdocuments.PrimaryOutcomeFiles
• openfactsetpartnersdocuments.PrimaryOutcomeResponse
• openfactsetpartnersdocuments.ScriptsAsiaResponse
• openfactsetpartnersdocuments.SponsorsFiles
• openfactsetpartnersdocuments.SponsorsResponse
• openfactsetpartnersdocuments.Transcripts

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.