Events and Transcripts client library for JavaScript

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

• API version: 1.1.0
• SDK version: 0.22.1
• 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, CalendarEventsApi } = require('@factset/sdk-eventsandtranscripts');
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 CalendarEventsApi();
const companyEventRequest = new eventsandtranscripts.CompanyEventRequest(); // CompanyEventRequest | Company Event request body

// Call api endpoint
apiInstance.getCompanyEvent(companyEventRequest).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-eventsandtranscripts');

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

Documentation for API Endpoints

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

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- eventsandtranscripts.CalendarEventsApi | getCompanyEvent | POST /calendar/events | Retrieve Company Event data eventsandtranscripts.EventsAudioApi | getDocsDistributorAudioV1HistoryFiles | GET /audio/history | Retrieve historical audio recordings and related metadata within FactSet coverage. eventsandtranscripts.EventsAudioApi | getDocsDistributorAudioV1ListFilesDate | GET /audio/by-date | Retrieve latest audio recordings and related metadata within FactSet coverage based on a specific date ranges. eventsandtranscripts.EventsAudioApi | getDocsDistributorAudioV1ListFilesFileName | GET /audio/by-file-name | Retrieve latest audio recordings and related metadata within FactSet coverage based on file name. eventsandtranscripts.EventsAudioApi | getDocsDistributorAudioV1ListFilesIds | GET /audio/by-ids | Retrieve the latest audio recordings along with their corresponding metadata from the FactSet coverage based on specific IDs. eventsandtranscripts.EventsAudioApi | getDocsDistributorAudioV1ListFilesUploadTime | GET /audio/by-upload-time | Retrieve latest audio recordings and related metadata within FactSet coverage based on upload time. eventsandtranscripts.NearRealTimeTranscriptsApi | getBulkDocumentsNrtV1Calls | GET /nrt/by-ticker | Returns the active calls happening at the moment based on ticker,call status and entity ID. eventsandtranscripts.NearRealTimeTranscriptsApi | getBulkDocumentsNrtV1CallsByAudioSourceId | GET /nrt/by-ids | Returns the active calls happening at the moment based on audio source ID and report ID. eventsandtranscripts.NearRealTimeTranscriptsApi | getBulkDocumentsNrtV1Indexedrt | GET /nrt/indexed | Returns the indexed transcript data in small increments throughout the duration of an active call. eventsandtranscripts.NearRealTimeTranscriptsApi | getBulkDocumentsNrtV1SpeakerIds | GET /nrt/speakerids | Returns the latest speakerIds with the confidence scores generated for an active call. eventsandtranscripts.TranscriptsApi | getTimezone | GET /reference/time-zones | Returns the time zones. eventsandtranscripts.TranscriptsApi | getTranscripts | GET /transcripts/search | Returns the transcript documents in XML format and related metadata within FactSet coverage based on search text. eventsandtranscripts.TranscriptsApi | getTranscriptsDates | GET /transcripts/dates | Returns the transcript documents in XML format and related metadata within FactSet coverage based on specific date range and time zones. eventsandtranscripts.TranscriptsApi | getTranscriptsEvents | GET /transcripts/events | Returns the transcript documents in XML format and related metadata within FactSet coverage based on eventIds and eventType. eventsandtranscripts.TranscriptsApi | getTranscriptsIds | GET /transcripts/ids | Returns the transcript documents in XML format and related metadata within FactSet coverage based on specific IDs. eventsandtranscripts.TranscriptsApi | getTranscriptsTime | GET /transcripts/times | Returns the transcript documents in XML format and related metadata within FactSet coverage based on specific time. eventsandtranscripts.TranscriptsApi | getcategories | GET /reference/categories | Returns the categories.

Documentation for Models

• eventsandtranscripts.CompanyEventRequest
• eventsandtranscripts.CompanyEventRequestData
• eventsandtranscripts.CompanyEventRequestDataDateTime
• eventsandtranscripts.CompanyEventRequestDataUniverse
• eventsandtranscripts.CompanyEventResponse
• eventsandtranscripts.CompanyEventResponseObject
• eventsandtranscripts.Error
• eventsandtranscripts.ErrorExample
• eventsandtranscripts.EventsAudioDaily
• eventsandtranscripts.EventsAudioDailyFileName
• eventsandtranscripts.EventsAudioDailyIds
• eventsandtranscripts.EventsAudioDailyMeta
• eventsandtranscripts.EventsAudioDailyMetaPagination
• eventsandtranscripts.EventsAudioDailyObject
• eventsandtranscripts.EventsAudioDailyObjectOne
• eventsandtranscripts.EventsAudioHistory
• eventsandtranscripts.EventsAudioIdsObject
• eventsandtranscripts.IndexedNrt
• eventsandtranscripts.IndexedObject
• eventsandtranscripts.ListFileObject
• eventsandtranscripts.NrtCalls
• eventsandtranscripts.NrtCallsMeta
• eventsandtranscripts.NrtCallsMetaPagination
• eventsandtranscripts.NrtCallsObject
• eventsandtranscripts.NrtSpeakerIdObject
• eventsandtranscripts.NrtSpeakerIds
• eventsandtranscripts.NrtSpeakerIdsMeta
• eventsandtranscripts.NrtSpeakerIdsMetaPagination
• eventsandtranscripts.ResponseCategories
• eventsandtranscripts.ResponseCategoriesObject
• eventsandtranscripts.ResponseTime
• eventsandtranscripts.ResponseTimeObject
• eventsandtranscripts.TranscriptObject
• eventsandtranscripts.TranscriptObjectOne
• eventsandtranscripts.TranscriptObjectTimes
• eventsandtranscripts.Transcripts
• eventsandtranscripts.TranscriptsMeta
• eventsandtranscripts.TranscriptsMetaPagination
• eventsandtranscripts.TranscriptsOne
• eventsandtranscripts.TranscriptsOneMeta
• eventsandtranscripts.TranscriptsOneMetaPagination
• eventsandtranscripts.TranscriptsTimes

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.