FactSet.SDK.IRNConfiguration 2.0.8

Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
dotnet add package FactSet.SDK.IRNConfiguration --version 2.0.8                
NuGet\Install-Package FactSet.SDK.IRNConfiguration -Version 2.0.8                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="FactSet.SDK.IRNConfiguration" Version="2.0.8" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add FactSet.SDK.IRNConfiguration --version 2.0.8                
#r "nuget: FactSet.SDK.IRNConfiguration, 2.0.8"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install FactSet.SDK.IRNConfiguration as a Cake Addin
#addin nuget:?package=FactSet.SDK.IRNConfiguration&version=2.0.8

// Install FactSet.SDK.IRNConfiguration as a Cake Tool
#tool nuget:?package=FactSet.SDK.IRNConfiguration&version=2.0.8                

FactSet

IRN Configuration client library for .NET

Nuget Apache-2 license

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

This .NET package is automatically generated by the OpenAPI Generator project:

  • API version: 1
  • Package version: 2.0.8
  • Build package: com.factset.sdk.codegen.FactSetCSharpNetCoreClientCodegen

Requirements

  • .NET Standard >= 2.0

Installation

.NET CLI

dotnet add package FactSet.SDK.Utils
dotnet add package FactSet.SDK.IRNConfiguration -v 2.0.8

NuGet

nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.IRNConfiguration -Version 2.0.8

Usage

  1. Generate authentication credentials.
  2. Setup .NET Standard 2.0 compatible environment.
  3. Install dependencies.
  4. Run the following:
using System;
using System.Threading.Tasks;
using FactSet.SDK.Utils.Authentication;
using FactSet.SDK.IRNConfiguration.Api;
using FactSet.SDK.IRNConfiguration.Client;
using FactSet.SDK.IRNConfiguration.Model;

namespace Example
{
    public static class CreateContactCustomFieldExample
    {
        public static async Task Main()
        {
            var config = new FactSet.SDK.IRNConfiguration.Client.Configuration();

            // 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-dotnet#authentication
            // for more information on using the ConfidentialClient class
            ConfidentialClient confidentialClient = await ConfidentialClient.CreateAsync("/path/to/app-config.json");
            config.OAuth2Client = confidentialClient;

            /* Basic authentication: FactSetApiKey */
            // See https://github.com/FactSet/enterprise-sdk#api-key
            // for information how to create an API key
            // config.Username = "USERNAME-SERIAL";
            // config.Password = "API-KEY";

            var apiInstance = new ContactsCustomFieldsApi(config);
            var contactCustomFieldSaveDto = new ContactCustomFieldSaveDto(); // ContactCustomFieldSaveDto | ContactCustomFieldSaveDto object to save (optional) 

            try
            {
                // Create a contact custom field
                NewItemDto result = apiInstance.CreateContactCustomField(contactCustomFieldSaveDto);
                Console.WriteLine(result.ToJson());
            }
            catch (ApiException e)
            {
                Console.WriteLine("Exception when calling ContactsCustomFieldsApi.CreateContactCustomField: " + e.Message );
                Console.WriteLine("Status Code: "+ e.ErrorCode);
                Console.WriteLine(e.StackTrace);
            }
        }
    }
}

Using a Proxy

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

Documentation for API Endpoints

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

Class Method HTTP request Description
ContactsCustomFieldsApi CreateContactCustomField POST /v1/contact-custom-fields Create a contact custom field
ContactsCustomFieldsApi DeleteContactCustomField DELETE /v1/contact-custom-fields/{contactCustomFieldId} Delete a contact custom field
ContactsCustomFieldsApi GetContactCustomField GET /v1/contact-custom-fields/{contactCustomFieldId} Get a specific Contact custom field's details
ContactsCustomFieldsApi GetContactCustomFields GET /v1/contact-custom-fields Get all the contact custom fields
ContactsCustomFieldsApi PatchContactCustomField PATCH /v1/contact-custom-fields/{contactCustomFieldId} Edit a contact custom field
ContactsPhoneNumberTypesApi CreatePhoneNumberType POST /v1/phone-number-types Create a phone type
ContactsPhoneNumberTypesApi DeletePhoneNumberType DELETE /v1/phone-number-types/{phoneNumberTypeId} Delete a phone type
ContactsPhoneNumberTypesApi GetPhoneNumberTypes GET /v1/phone-number-types Get list of the phone types configured in your group
ContactsPhoneNumberTypesApi UpdatePhoneNumberType PUT /v1/phone-number-types/{phoneNumberTypeId} Edit a phone type
ContactsRelationshipCategoryApi CreateRelationshipCategory POST /v1/relationship-categories Create a relationship category
ContactsRelationshipCategoryApi DeleteRelationshipCategory DELETE /v1/relationship-categories/{relationshipCategoryId} Delete a relationship category
ContactsRelationshipCategoryApi EditRelationshipCategory PUT /v1/relationship-categories/{relationshipCategoryId} Edit a relationship category
ContactsRelationshipCategoryApi GetRelationshipCategories GET /v1/relationship-categories Get list of the relationship categories configured in your group
ContactsRelationshipCategoryApi UpdateRelationshipCategoryOrder POST /v1/relationship-categories/reorder Reorder relationship categories
ContactsRelationshipsApi CreateContactRelationshipType POST /v1/relationships Create a relationship type
ContactsRelationshipsApi DeleteRelationship DELETE /v1/relationships/{relationshipId} Delete a relationship type
ContactsRelationshipsApi EditRelationship PUT /v1/relationships/{relationshipId} Edit a relationship type
ContactsRelationshipsApi GetRelationships GET /v1/relationships Get list of the relationships configured in your group
ContactsRolesApi CreateContactRole POST /v1/contact-roles Create contact roles
ContactsRolesApi DeleteContactRole DELETE /v1/contact-roles/{contactRoleId} Delete a contact role
ContactsRolesApi GetContactRoles GET /v1/contact-roles Get list of the contact roles configured in your group
ContactsRolesApi UpdateContactRole PUT /v1/contact-roles/{contactRoleId} Edit a contact role
ContactsTypesApi CreateContactType POST /v1/contact-types Create contact types
ContactsTypesApi DeleteContactType DELETE /v1/contact-types/{contactTypeId} Delete a contact type
ContactsTypesApi GetContactTypes GET /v1/contact-types Get list of the contact types configured in your group
ContactsTypesApi UpdateContactType PUT /v1/contact-types/{contactTypeId} Edit a contact type
CustomSymbolsCustomFieldsApi CreateCustomSymbolCustomField POST /v1/custom-symbol-custom-fields Create a Custom symbol custom field
CustomSymbolsCustomFieldsApi DeleteCustomSymbolCustomField DELETE /v1/custom-symbol-custom-fields/{customSymbolCustomFieldId} Delete a Custom symbol custom field
CustomSymbolsCustomFieldsApi GetCustomSymbolCustomField GET /v1/custom-symbol-custom-fields/{customSymbolCustomFieldId} Get a specific Custom symbol custom field's details
CustomSymbolsCustomFieldsApi GetCustomSymbolCustomFields GET /v1/custom-symbol-custom-fields Get all the Custom symbol custom fields
CustomSymbolsCustomFieldsApi PatchCustomSymbolCustomField PATCH /v1/custom-symbol-custom-fields/{customSymbolCustomFieldId} Edit a Custom symbol custom field
CustomSymbolsRelationshipsApi CreateSymbolRelationshipType POST /v1/symbols-relationships Create a symbol relationship
CustomSymbolsRelationshipsApi DeleteSymbolsRelationship DELETE /v1/symbols-relationships/{symbolsRelationshipId} Delete a symbol relationship
CustomSymbolsRelationshipsApi EditSymbolsRelationship PUT /v1/symbols-relationships/{symbolsRelationshipId} Edit a symbol relationship
CustomSymbolsRelationshipsApi GetSymbolsRelationships GET /v1/symbols-relationships Get all the Symbols Relationships
CustomSymbolsTypesApi CreateCustomSymbolType POST /v1/custom-symbol-types Create a Custom symbol type
CustomSymbolsTypesApi DeleteCustomSymbolTypeAsync DELETE /v1/custom-symbol-types/{customSymbolTypeId} Delete a Custom symbol type
CustomSymbolsTypesApi GetCustomSymbolType GET /v1/custom-symbol-types/{customSymbolTypeId} Get a specific Custom symbol type's details
CustomSymbolsTypesApi GetCustomSymbolTypes GET /v1/custom-symbol-types Get all the custom symbol types
CustomSymbolsTypesApi GetSymbolCustomFieldsForCustomSymbolType GET /v1/custom-symbol-types/{customSymbolTypeId}/custom-fields Get Custom fields for Custom Symbol type
CustomSymbolsTypesApi UpdateCustomSymbolType PUT /v1/custom-symbol-types/{customSymbolTypeId} Edit a Custom symbol type
CustomSymbolsTypesApi UpdateCustomSymbolTypeOrder POST /v1/custom-symbol-types/reorder
NotesConfigurationApi GetAssignedFactSetUsers GET /v1/users Get all assigned FactSet users
NotesConfigurationApi GetAuthors GET /v1/authors Get all Authors
NotesConfigurationApi GetClientsSalesRepresentative GET /v1/group/client-sales-representative
NotesConfigurationApi GetCustomFields GET /v1/custom-fields Get all Custom Fields
NotesConfigurationApi GetGroup GET /v1/group Get Group details
NotesConfigurationApi GetRecommendations GET /v1/recommendations Get all Recommendations
NotesConfigurationApi GetSentiments GET /v1/sentiments Get all Sentiments
NotesConfigurationApi GetSubject GET /v1/subjects/{subjectId} Get Subject details for the given Id provided
NotesConfigurationApi GetSubjects GET /v1/subjects Get all Subjects
NotesConfigurationApi GetTeam GET /v1/teams/{teamId} Get Team details for the given Id provided
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 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.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.1.0 95 8/30/2024
2.0.10 91 7/11/2024
2.0.9 132 4/10/2024
2.0.8 290 10/25/2023
2.0.7 201 8/30/2023
2.0.6 171 8/11/2023
2.0.5 187 6/13/2023
2.0.4 177 6/6/2023
2.0.3 179 5/11/2023
2.0.2 250 3/1/2023
2.0.1 263 2/24/2023
2.0.0 308 1/26/2023
1.0.0 412 8/31/2022
0.21.0 430 7/21/2022
0.20.0 429 5/24/2022
0.9.1 454 2/14/2022
0.9.0 464 2/2/2022

Refer to Changelog on GitHub source repository