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-irnconfiguration

v2.0.0

Published

IRN Configuration client library for JavaScript

Downloads

101

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

enterprisesdkenterprisesdkfdsfdstsouthmaydfdstsouthmaydfds

Keywords

FactSetAPISDK

Readme

FactSet

IRN Configuration client library for JavaScript

API Version npm Apache-2 license

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.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/[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, ContactsCustomFieldsApi } = require('@factset/sdk-irnconfiguration');
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 ContactsCustomFieldsApi();
const opts = {
  'contactCustomFieldSaveDto': new irnconfiguration.ContactCustomFieldSaveDto() // ContactCustomFieldSaveDto | ContactCustomFieldSaveDto object to save
};

// Call api endpoint
apiInstance.createContactCustomField(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-irnconfiguration');

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 ------------ | ------------- | ------------- | ------------- irnconfiguration.ContactsCustomFieldsApi | createContactCustomField | POST /contact-custom-fields | Create a contact custom field irnconfiguration.ContactsCustomFieldsApi | deleteContactCustomField | DELETE /contact-custom-fields/{contactCustomFieldId} | Delete a contact custom field irnconfiguration.ContactsCustomFieldsApi | getContactCustomField | GET /contact-custom-fields/{contactCustomFieldId} | Get a specific Contact custom field's details irnconfiguration.ContactsCustomFieldsApi | getContactCustomFields | GET /contact-custom-fields | Get all the contact custom fields irnconfiguration.ContactsCustomFieldsApi | patchContactCustomField | PATCH /contact-custom-fields/{contactCustomFieldId} | Edit a contact custom field irnconfiguration.ContactsPhoneNumberTypesApi | createPhoneNumberType | POST /phone-number-types | Create a phone type irnconfiguration.ContactsPhoneNumberTypesApi | deletePhoneNumberType | DELETE /phone-number-types/{phoneNumberTypeId} | Delete a phone type irnconfiguration.ContactsPhoneNumberTypesApi | getPhoneNumberTypes | GET /phone-number-types | Get list of the phone types configured in your group irnconfiguration.ContactsPhoneNumberTypesApi | updatePhoneNumberType | PUT /phone-number-types/{phoneNumberTypeId} | Edit a phone type irnconfiguration.ContactsRelationshipCategoryApi | createRelationshipCategory | POST /relationship-categories | Create a relationship category irnconfiguration.ContactsRelationshipCategoryApi | deleteRelationshipCategory | DELETE /relationship-categories/{relationshipCategoryId} | Delete a relationship category irnconfiguration.ContactsRelationshipCategoryApi | editRelationshipCategory | PUT /relationship-categories/{relationshipCategoryId} | Edit a relationship category irnconfiguration.ContactsRelationshipCategoryApi | getRelationshipCategories | GET /relationship-categories | Get list of the relationship categories configured in your group irnconfiguration.ContactsRelationshipCategoryApi | updateRelationshipCategoryOrder | POST /relationship-categories/reorder | Reorder relationship categories irnconfiguration.ContactsRelationshipsApi | createContactRelationshipType | POST /relationships | Create a relationship type irnconfiguration.ContactsRelationshipsApi | deleteRelationship | DELETE /relationships/{relationshipId} | Delete a relationship type irnconfiguration.ContactsRelationshipsApi | editRelationship | PUT /relationships/{relationshipId} | Edit a relationship type irnconfiguration.ContactsRelationshipsApi | getRelationships | GET /relationships | Get list of the relationships configured in your group irnconfiguration.ContactsRolesApi | createContactRole | POST /contact-roles | Create contact roles irnconfiguration.ContactsRolesApi | deleteContactRole | DELETE /contact-roles/{contactRoleId} | Delete a contact role irnconfiguration.ContactsRolesApi | getContactRoles | GET /contact-roles | Get list of the contact roles configured in your group irnconfiguration.ContactsRolesApi | updateContactRole | PUT /contact-roles/{contactRoleId} | Edit a contact role irnconfiguration.ContactsTypesApi | createContactType | POST /contact-types | Create contact types irnconfiguration.ContactsTypesApi | deleteContactType | DELETE /contact-types/{contactTypeId} | Delete a contact type irnconfiguration.ContactsTypesApi | getContactTypes | GET /contact-types | Get list of the contact types configured in your group irnconfiguration.ContactsTypesApi | updateContactType | PUT /contact-types/{contactTypeId} | Edit a contact type irnconfiguration.CustomSymbolsCustomFieldsApi | createCustomSymbolCustomField | POST /custom-symbol-custom-fields | Create a Custom symbol custom field irnconfiguration.CustomSymbolsCustomFieldsApi | deleteCustomSymbolCustomField | DELETE /custom-symbol-custom-fields/{customSymbolCustomFieldId} | Delete a Custom symbol custom field irnconfiguration.CustomSymbolsCustomFieldsApi | getCustomSymbolCustomField | GET /custom-symbol-custom-fields/{customSymbolCustomFieldId} | Get a specific Custom symbol custom field's details irnconfiguration.CustomSymbolsCustomFieldsApi | getCustomSymbolCustomFields | GET /custom-symbol-custom-fields | Get all the Custom symbol custom fields irnconfiguration.CustomSymbolsCustomFieldsApi | patchCustomSymbolCustomField | PATCH /custom-symbol-custom-fields/{customSymbolCustomFieldId} | Edit a Custom symbol custom field irnconfiguration.CustomSymbolsRelationshipsApi | createSymbolRelationshipType | POST /symbols-relationships | Create a symbol relationship irnconfiguration.CustomSymbolsRelationshipsApi | deleteSymbolsRelationship | DELETE /symbols-relationships/{symbolsRelationshipId} | Delete a symbol relationship irnconfiguration.CustomSymbolsRelationshipsApi | editSymbolsRelationship | PUT /symbols-relationships/{symbolsRelationshipId} | Edit a symbol relationship irnconfiguration.CustomSymbolsRelationshipsApi | getSymbolsRelationships | GET /symbols-relationships | Get all the Symbols Relationships irnconfiguration.CustomSymbolsTypesApi | createCustomSymbolType | POST /custom-symbol-types | Create a Custom symbol type irnconfiguration.CustomSymbolsTypesApi | deleteCustomSymbolTypeAsync | DELETE /custom-symbol-types/{customSymbolTypeId} | Delete a Custom symbol type irnconfiguration.CustomSymbolsTypesApi | getCustomSymbolType | GET /custom-symbol-types/{customSymbolTypeId} | Get a specific Custom symbol type's details irnconfiguration.CustomSymbolsTypesApi | getCustomSymbolTypes | GET /custom-symbol-types | Get all the custom symbol types irnconfiguration.CustomSymbolsTypesApi | getSymbolCustomFieldsForCustomSymbolType | GET /custom-symbol-types/{customSymbolTypeId}/custom-fields | Get Custom fields for Custom Symbol type irnconfiguration.CustomSymbolsTypesApi | updateCustomSymbolType | PUT /custom-symbol-types/{customSymbolTypeId} | Edit a Custom symbol type irnconfiguration.CustomSymbolsTypesApi | updateCustomSymbolTypeOrder | POST /custom-symbol-types/reorder | Reorder custom symbol types irnconfiguration.NotesConfigurationApi | getAssignedFactSetUsers | GET /users | Get all assigned FactSet users irnconfiguration.NotesConfigurationApi | getAuthors | GET /authors | Get all Authors irnconfiguration.NotesConfigurationApi | getClientsSalesRepresentative | GET /group/client-sales-representative | Get Client Sales Representative irnconfiguration.NotesConfigurationApi | getCustomFields | GET /custom-fields | Get all Custom Fields irnconfiguration.NotesConfigurationApi | getGroup | GET /group | Get Group details irnconfiguration.NotesConfigurationApi | getRecommendations | GET /recommendations | Get all Recommendations irnconfiguration.NotesConfigurationApi | getSentiments | GET /sentiments | Get all Sentiments irnconfiguration.NotesConfigurationApi | getSubject | GET /subjects/{subjectId} | Get Subject details for the given Id provided irnconfiguration.NotesConfigurationApi | getSubjects | GET /subjects | Get all Subjects irnconfiguration.NotesConfigurationApi | getTeam | GET /teams/{teamId} | Get Team details for the given Id provided irnconfiguration.NotesConfigurationApi | getTeams | GET /teams | Get all Teams

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.