@factset/sdk-irnconfiguration NPM

IRN Configuration 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
Package version: 1.0.4
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Requirements

Node.js >= 14

Installation

npm

npm install @factset/sdk-utils @factset/sdk-irnconfiguration@1.0.4

yarn

yarn add @factset/sdk-utils @factset/sdk-irnconfiguration@1.0.4

Usage

Generate authentication credentials.
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.
Install dependencies.
Run the following:

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);
  },
);

Documentation for API Endpoints

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

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

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.

FactSet API SDK

@factset/sdk-utils superagent

@everything-registry/sub-chunk-312

7 months ago

8 months ago

11 months ago

11 months ago