1.0.4 • Published 7 months ago
@factset/sdk-irncontacts v1.0.4
IRN Contacts 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-irncontacts@1.0.4yarn
yarn add @factset/sdk-utils @factset/sdk-irncontacts@1.0.4Usage
- 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.
- Run the following:
const { ApiClient, ContactsApi } = require('@factset/sdk-irncontacts');
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 ContactsApi();
const opts = {
'contactSaveDto': new irncontacts.ContactSaveDto() // ContactSaveDto | contactSaveDto object to save
};
// Call api endpoint
apiInstance.createContact(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 |
|---|---|---|---|
| irncontacts.ContactsApi | createContact | POST /v1/contacts | Create a contact |
| irncontacts.ContactsApi | deleteContact | DELETE /v1/contacts/{contactId} | Delete a contact |
| irncontacts.ContactsApi | getContact | GET /v1/contacts/{contactId} | Get all custom field and standard field details on a specific contact |
| irncontacts.ContactsApi | getContactEvents | GET /v1/contacts/{contactId}/events | Get a contact’s audit history |
| irncontacts.ContactsApi | getContactNotes | GET /v1/contacts/{contactId}/about | Get the About field content for a specific contact |
| irncontacts.ContactsApi | getContactRecords | GET /v1/contacts/{contactId}/records | Get all notes and meetings where a specific contact was tagged |
| irncontacts.ContactsApi | getContactRelationships | GET /v1/contacts/{contactId}/relationships | Returns a list of a contact’s relationships |
| irncontacts.ContactsApi | getContacts | GET /v1/contacts | Get list of all contacts in your group along with some of their standard field data |
| irncontacts.ContactsApi | patchContact | PATCH /v1/contacts/{contactId} | Edit a contact’s standard field and custom field data |
| irncontacts.ContactsRelationshipsApi | createContactRelationship | POST /v1/contact-relationships | Create a contact relationship |
| irncontacts.ContactsRelationshipsApi | deleteContactRelationship | DELETE /v1/contact-relationships/{contactRelationshipId} | Delete a contact relationship |
| irncontacts.ContactsRelationshipsApi | getAllRelationshipsTaggingAContact | GET /v1/contact-relationships | Get all the relationships where the given symbol or contact identifier has been tagged in a relationship |
| irncontacts.ContactsRelationshipsApi | getContactRelationship | GET /v1/contact-relationships/{contactRelationshipId} | Get details on a specific contact relationship |
| irncontacts.ContactsRelationshipsApi | patchContactRelationship | PATCH /v1/contact-relationships/{contactRelationshipId} | Update a contact relationship |
Documentation for Models
- irncontacts.AlternativeEmailAddressDto
- irncontacts.ContactAddressDto
- irncontacts.ContactCustomFieldOptionValueDto
- irncontacts.ContactCustomFieldValueDto
- irncontacts.ContactCustomFieldValueSaveDto
- irncontacts.ContactDto
- irncontacts.ContactEventDto
- irncontacts.ContactEventUpdateDto
- irncontacts.ContactIdNameDto
- irncontacts.ContactPhoneDto
- irncontacts.ContactPhoneSaveDto
- irncontacts.ContactRelationshipDto
- irncontacts.ContactRelationshipSaveDto
- irncontacts.ContactRelationshipTwoSidedDto
- irncontacts.ContactRelationshipTwoSidedSaveDto
- irncontacts.ContactRoleDto
- irncontacts.ContactSaveDto
- irncontacts.ContactSummaryDto
- irncontacts.ContactTypeDto
- irncontacts.EmployerDto
- irncontacts.NewItemDto
- irncontacts.Operation
- irncontacts.OperationType
- irncontacts.PhoneNumberTypeDto
- irncontacts.ProblemDetails
- irncontacts.RecordPreviewDto
- irncontacts.RelationshipCategoryIdNameDto
- irncontacts.RelationshipIdNameDto
- irncontacts.RelationshipSymbolSummaryDto
- irncontacts.SymbolType
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.0Unless 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.