IRN Notes client library for JavaScript

Allows users to extract, create, update and configure IRN data.

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

• API version: 1
• SDK version: 4.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/[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, AttachmentsApi } = require('@factset/sdk-irnnotes');
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 AttachmentsApi();
const noteId = "noteId_example"; // String | Note Id
const file = "/path/to/file"; // File | 

// Call api endpoint
apiInstance.createAttachment(noteId, file).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-irnnotes');

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

Documentation for API Endpoints

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

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- irnnotes.AttachmentsApi | createAttachment | POST /notes/{noteId}/attachments | Create an attachment for an existing note irnnotes.AttachmentsApi | downloadAttachment | GET /notes/{noteId}/attachments/{attachmentId}/download | Download an attachment from a Note irnnotes.AttachmentsApi | getAttachments | GET /notes/{noteId}/attachments | Get all the attachments belonging to a note irnnotes.AttachmentsApi | softDeleteNoteAttachment | DELETE /notes/{noteId}/attachments/{attachmentId} | Delete attachment from note irnnotes.CommentsApi | createComment | POST /notes/{noteId}/comments | Create a comment to a Note irnnotes.CommentsApi | createCommentAttachment | POST /notes/{noteId}/comments/{commentId}/attachments | Create a comment attachment to a Note irnnotes.CommentsApi | deleteComment | DELETE /notes/{noteId}/comments/{commentId} | Delete a Comment from a Note irnnotes.CommentsApi | downloadCommentAttachmentForComment | GET /notes/{noteId}/comments/{commentId}/attachments/{attachmentId}/download | Download single attachment detail of a comment belonging to a note irnnotes.CommentsApi | getComment | GET /notes/{noteId}/comments/{commentId} | Get details of a comment belonging to a note irnnotes.CommentsApi | getCommentAttachments | GET /notes/{noteId}/comments/{commentId}/attachments | Get attachments summary of a comment belonging to a note irnnotes.CommentsApi | getComments | GET /notes/{noteId}/comments | Get all comments for a note irnnotes.CommentsApi | patchComment | PATCH /notes/{noteId}/comments/{commentId} | Edit a comment for a note irnnotes.EventsApi | getAllEvents | GET /events | Get all the record events in the specified date range filtered on the given types irnnotes.EventsApi | getEvents | GET /notes/{noteId}/events | Get all the record events that belong to a note irnnotes.EventsApi | getRecordEvent | GET /notes/{noteId}/events/{recordEventId} | Get details of a record event of a note irnnotes.IdentifiersApi | getIdentifiers | GET /identifiers | Get all the identifier details for given identifiers irnnotes.NotesApi | createNote | POST /notes | Create a note irnnotes.NotesApi | deleteNote | DELETE /notes/{noteId} | Delete a Note irnnotes.NotesApi | getNote | GET /notes/{noteId} | Get details of a note irnnotes.NotesApi | getNotes | GET /notes | Get all the notes in the specified date range filtered on the given identifiers irnnotes.NotesApi | updateNote | PUT /notes/{noteId} | Updates a note by replacing existing note with new data

Documentation for Models

• irnnotes.AttachmentSummaryDto
• irnnotes.CommentDto
• irnnotes.CommentSummaryDto
• irnnotes.CreateBodyDto
• irnnotes.CreateCommentDto
• irnnotes.CreateCustomFieldValueDto
• irnnotes.CreateNoteDto
• irnnotes.CustomFieldValueDto
• irnnotes.EventSnippetDto
• irnnotes.NewItemDto
• irnnotes.NoteDto
• irnnotes.NoteEventDto
• irnnotes.NoteSummaryDto
• irnnotes.Operation
• irnnotes.OperationType
• irnnotes.ProblemDetails
• irnnotes.RecordChangeDto
• irnnotes.RecordEventSummaryDto
• irnnotes.RelatedRecordsDto
• irnnotes.SubcommentSummaryDto
• irnnotes.UpdateNoteDto
• irnnotes.UserSerialDto
• irnnotes.UserTeamLookupDto

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.