npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@factset/sdk-documentsdistributorcallstreetevents

v0.21.10

Published

Documents Distributor - CallStreet Events client library for JavaScript

Downloads

4

Readme

FactSet

Documents Distributor - CallStreet Events client library for JavaScript

npm Apache-2 license

CallStreet Events contains all the Documents Distributor APIs that offer events data such as Events Audio and Near Real-Time Transcripts.

The Events Audio API provides access to historical as well as the latest audio recordings of various company events covered by FactSet. The events include, but are not limited to: earnings calls, conferences, and investor days.

This API also provides relevant metadata such as timestamps and identifiers around each audio file.

The Documents Distributor - Near Real-time Transcripts API enables access to Near Real-time Transcripts provided by CallStreet to time-sensitive clients. This API also provides the relevant speaker metadata along with their confidence scores. This data caters to quant clients interested in building machine learning models.

Clients can leverage this API to perform sentiment analysis through natural language processing or machine learning. It can also be used to complement analysis using FactSet's transcripts service.

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

  • API version: 1.8.3
  • Package version: 0.21.10
  • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

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

Requirements

  • Node.js >= 14

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 >=14. If you're using nvm:

      nvm install 16
      nvm use 16
    2. (optional) Install yarn.

  3. Install dependencies.
  4. Run the following:
const { ApiClient, EventsAudioApi } = require('@factset/sdk-documentsdistributorcallstreetevents');
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 EventsAudioApi();
const opts = {
  'paginationLimit': 25, // Number | Specifies the number of results to return per page. [ Min=0 ; Max=500 ]
  'paginationOffset': 0, // Number | Specifies the starting point for pagination. This parameter is used to identify the beginning of next set of results.
  'year': 2021, // Number | Specifies the year for which the historical audio recordings and related metadata are to be retrieved.
  'trimmed': true // Boolean | Specifies if trimmed/untrimmed historical audio recordings should be returned.
};

// Call api endpoint
apiInstance.getDocsDistributorAudioV1HistoryFiles(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

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- documentsdistributorcallstreetevents.EventsAudioApi | getDocsDistributorAudioV1HistoryFiles | GET /docs-distributor/audio/v1/history-files | Retrieve historical audio recordings and related metadata within FactSet coverage. documentsdistributorcallstreetevents.EventsAudioApi | getDocsDistributorAudioV1ListFiles | GET /docs-distributor/audio/v1/list-files | Retrieve latest audio recordings and related metadata within FactSet coverage. documentsdistributorcallstreetevents.NearRealTimeTranscriptsApi | getBulkDocumentsNrtV1Calls | GET /bulk-documents/nrt/v1/calls | Returns the active calls happening at the moment. documentsdistributorcallstreetevents.NearRealTimeTranscriptsApi | getBulkDocumentsNrtV1IndexedNrt | GET /bulk-documents/nrt/v1/indexed-nrt | Returns the indexed transcript data in small increments throughout the duration of an active call. documentsdistributorcallstreetevents.NearRealTimeTranscriptsApi | getBulkDocumentsNrtV1ListSnippets | GET /bulk-documents/nrt/v1/list-snippets | Returns the latest transcript snippets from an active call. documentsdistributorcallstreetevents.NearRealTimeTranscriptsApi | getBulkDocumentsNrtV1Speakerids | GET /bulk-documents/nrt/v1/speakerids | Returns the latest speakerIds with the confidence scores generated for an active call.

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.