@factset/sdk-irncustomsymbols
v1.0.3
Published
IRN Custom Symbols client library for JavaScript
Downloads
10
Readme
IRN Custom Symbols 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.3
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
Requirements
- Node.js >= 14
Installation
npm
npm install @factset/sdk-utils @factset/[email protected]
yarn
yarn add @factset/sdk-utils @factset/[email protected]
Usage
- Generate authentication credentials.
- Setup Node.js environment
Install and activate Node.js >=14. If you're using nvm:
nvm install 16 nvm use 16
(optional) Install yarn.
- Install dependencies.
- Run the following:
const { ApiClient, CustomSymbolsApi } = require('@factset/sdk-irncustomsymbols');
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 CustomSymbolsApi();
const opts = {
'createCustomSymbolDto': new irncustomsymbols.CreateCustomSymbolDto() // CreateCustomSymbolDto | createCustomSymbolDto object to save
};
// Call api endpoint
apiInstance.createCustomSymbol(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 ------------ | ------------- | ------------- | ------------- irncustomsymbols.CustomSymbolsApi | createCustomSymbol | POST /v1/custom-symbols | Create a custom symbol irncustomsymbols.CustomSymbolsApi | deleteCustomSymbol | DELETE /v1/custom-symbols/{customSymbolId} | Delete a custom symbol irncustomsymbols.CustomSymbolsApi | getCustomSymbol | GET /v1/custom-symbols/{customSymbolId} | Get all custom field and standard field details on a specific custom symbol irncustomsymbols.CustomSymbolsApi | getCustomSymbolRecords | GET /v1/custom-symbols/{customSymbolId}/records | Get all notes and meetings where a specific customSymbol was tagged as primary or related identifier irncustomsymbols.CustomSymbolsApi | getCustomSymbols | GET /v1/custom-symbols | Get list of all custom symbols in your group along with some of their standard field and custom fields data irncustomsymbols.CustomSymbolsApi | linkCustomSymbolToStandardSymbol | POST /v1/custom-symbols/{customSymbolId}/link-standard-symbol | Link custom symbol to standard symbol irncustomsymbols.CustomSymbolsApi | patchCustomSymbol | PATCH /v1/custom-symbols/{customSymbolId} | Edit a custom symbol’s standard field and custom field data irncustomsymbols.CustomSymbolsRelationshipsApi | createSymbolRelationship | POST /v1/symbol-relationships | Create a symbol relationship irncustomsymbols.CustomSymbolsRelationshipsApi | deleteSymbolRelationship | DELETE /v1/symbol-relationships/{symbolRelationshipId} | Delete a symbol relationship irncustomsymbols.CustomSymbolsRelationshipsApi | editAndAddSymbolRelationship | PUT /v1/symbol-relationships/{symbol} | Edit a symbol relationship irncustomsymbols.CustomSymbolsRelationshipsApi | getSymbolRelationship | GET /v1/symbol-relationships/{symbolRelationshipId} | Get details on a specific symbol relationship irncustomsymbols.CustomSymbolsRelationshipsApi | getSymbolRelationships | GET /v1/symbol-relationships/{symbolId}/relationships | Returns a list of a symbol’s relationships irncustomsymbols.HybridSymbolsApi | createStandardSymbolMetadata | POST /v1/custom-symbols/standard-symbol-metadata | Create standard symbol metadata irncustomsymbols.HybridSymbolsApi | getStandardSymbolMetadataGuid | GET /v1/custom-symbols/standard-symbol-metadata/{standardSymbol} | Get all custom field and standard field details on a specific standard symbol irncustomsymbols.HybridSymbolsApi | patchStandardSymbol | PATCH /v1/custom-symbols/standard-symbol-metadata/{standardSymbolId} | Edit a standard symbol’s standard field and custom field data
Documentation for Models
- irncustomsymbols.CreateCustomSymbolCustomFieldValueDto
- irncustomsymbols.CreateCustomSymbolDto
- irncustomsymbols.CreateStandardSymbolMetadataDto
- irncustomsymbols.CustomSymbolAddressDto
- irncustomsymbols.CustomSymbolContact
- irncustomsymbols.CustomSymbolCustomFieldValueDto
- irncustomsymbols.CustomSymbolDto
- irncustomsymbols.CustomSymbolSubTypeSummaryDto
- irncustomsymbols.CustomSymbolTypeSummaryDto
- irncustomsymbols.InstrumentDto
- irncustomsymbols.NewItemDto
- irncustomsymbols.Operation
- irncustomsymbols.OperationType
- irncustomsymbols.ProblemDetails
- irncustomsymbols.RecordPreviewDto
- irncustomsymbols.StandardSymbolDto
- irncustomsymbols.SymbolIdNameDto
- irncustomsymbols.SymbolRelationshipDto
- irncustomsymbols.SymbolRelationshipSaveDto
- irncustomsymbols.SymbolRelationshipUpdateDto
- irncustomsymbols.SymbolsRelationshipIdNameDto
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.