fds.sdk.IRNConfiguration 1.0.10

IRN Configuration client library for Python

IRN Configuration client library for Python

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

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1
• SDK version: 1.0.10
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements

• Python >= 3.7

Installation

Poetry

poetry add fds.sdk.utils fds.sdk.IRNConfiguration==1.0.10

pip

pip install fds.sdk.utils fds.sdk.IRNConfiguration==1.0.10

Usage

1. Generate authentication credentials.
2. Setup Python environment.

   1. Install and activate python 3.7+. If you're using pyenv:

      pyenv install 3.9.7
      pyenv shell 3.9.7
      

   2. (optional) Install poetry.

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

from fds.sdk.utils.authentication import ConfidentialClient

import fds.sdk.IRNConfiguration
from fds.sdk.IRNConfiguration.api import contacts___custom_fields_api
from fds.sdk.IRNConfiguration.models import *
from dateutil.parser import parse as dateutil_parser
from pprint import pprint

# See configuration.py for a list of all supported configuration parameters.

# 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-python#authentication
# for more information on using the ConfidentialClient class
configuration = fds.sdk.IRNConfiguration.Configuration(
    fds_oauth_client=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
# configuration = fds.sdk.IRNConfiguration.Configuration(
#     username='USERNAME-SERIAL',
#     password='API-KEY'
# )

# Enter a context with an instance of the API client
with fds.sdk.IRNConfiguration.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = contacts___custom_fields_api.ContactsCustomFieldsApi(api_client)
    contact_custom_field_save_dto = ContactCustomFieldSaveDto(
        code="code_example",
        name="name_example",
        type=ContactCustomFieldType(0),
        is_hidden=False,
        is_mandatory=False,
        field_formula=ContactCustomFieldFormulaDto(
            formula="formula_example",
            is_screening=False,
            symbol="symbol_example",
        ),
        contact_custom_field_options=[
            ContactCustomFieldOptionSaveDto(
                name="name_example",
            ),
        ],
    ) # ContactCustomFieldSaveDto | ContactCustomFieldSaveDto object to save (optional)

    try:
        # Create a contact custom field
        # example passing only required values which don't have defaults set
        # and optional values
        api_response = api_instance.create_contact_custom_field(contact_custom_field_save_dto=contact_custom_field_save_dto)

        pprint(api_response)
    except fds.sdk.IRNConfiguration.ApiException as e:
        print("Exception when calling ContactsCustomFieldsApi->create_contact_custom_field: %s\n" % e)

    # # Get response, http status code and response headers
    # try:
    #     # Create a contact custom field
    #     api_response, http_status_code, response_headers = api_instance.create_contact_custom_field_with_http_info(contact_custom_field_save_dto=contact_custom_field_save_dto)


    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.IRNConfiguration.ApiException as e:
    #     print("Exception when calling ContactsCustomFieldsApi->create_contact_custom_field: %s\n" % e)

    # # Get response asynchronous
    # try:
    #     # Create a contact custom field
    #     async_result = api_instance.create_contact_custom_field_async(contact_custom_field_save_dto=contact_custom_field_save_dto)
    #     api_response = async_result.get()


    #     pprint(api_response)
    # except fds.sdk.IRNConfiguration.ApiException as e:
    #     print("Exception when calling ContactsCustomFieldsApi->create_contact_custom_field: %s\n" % e)

    # # Get response, http status code and response headers asynchronous
    # try:
    #     # Create a contact custom field
    #     async_result = api_instance.create_contact_custom_field_with_http_info_async(contact_custom_field_save_dto=contact_custom_field_save_dto)
    #     api_response, http_status_code, response_headers = async_result.get()


    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.IRNConfiguration.ApiException as e:
    #     print("Exception when calling ContactsCustomFieldsApi->create_contact_custom_field: %s\n" % e)

Using Pandas

To convert an API response to a Pandas DataFrame, it is necessary to transform it first to a dictionary.

import pandas as pd

response_dict = api_response.to_dict()['data']

simple_json_response = pd.DataFrame(response_dict)
nested_json_response = pd.json_normalize(response_dict)

Debugging

The SDK uses the standard library logging module.

Setting debug to True on an instance of the Configuration class sets the log-level of related packages to DEBUG and enables additional logging in Pythons HTTP Client.

Note: This prints out sensitive information (e.g. the full request and response). Use with care.

import logging
import fds.sdk.IRNConfiguration

logging.basicConfig(level=logging.DEBUG)

configuration = fds.sdk.IRNConfiguration.Configuration(...)
configuration.debug = True

Configure a Proxy

You can pass proxy settings to the Configuration class:

• proxy: The URL of the proxy to use.
• proxy_headers: a dictionary to pass additional headers to the proxy (e.g. Proxy-Authorization).

import fds.sdk.IRNConfiguration

configuration = fds.sdk.IRNConfiguration.Configuration(
    # ...
    proxy="http://secret:password@localhost:5050",
    proxy_headers={
        "Custom-Proxy-Header": "Custom-Proxy-Header-Value"
    }
)

Custom SSL Certificate

TLS/SSL certificate verification can be configured with the following Configuration parameters:

• ssl_ca_cert: a path to the certificate to use for verification in PEM format.
• verify_ssl: setting this to False disables the verification of certificates. Disabling the verification is not recommended, but it might be useful during local development or testing.

import fds.sdk.IRNConfiguration

configuration = fds.sdk.IRNConfiguration.Configuration(
    # ...
    ssl_ca_cert='/path/to/ca.pem'
)

Request Retries

In case the request retry behaviour should be customized, it is possible to pass a urllib3.Retry object to the retry property of the Configuration.

from urllib3 import Retry
import fds.sdk.IRNConfiguration

configuration = fds.sdk.IRNConfiguration.Configuration(
    # ...
)

configuration.retries = Retry(total=3, status_forcelist=[500, 502, 503, 504])

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
ContactsCustomFieldsApi	create_contact_custom_field	POST /v1/contact-custom-fields	Create a contact custom field
ContactsCustomFieldsApi	delete_contact_custom_field	DELETE /v1/contact-custom-fields/{contactCustomFieldId}	Delete a contact custom field
ContactsCustomFieldsApi	get_contact_custom_field	GET /v1/contact-custom-fields/{contactCustomFieldId}	Get a specific Contact custom field's details
ContactsCustomFieldsApi	get_contact_custom_fields	GET /v1/contact-custom-fields	Get all the contact custom fields
ContactsCustomFieldsApi	patch_contact_custom_field	PATCH /v1/contact-custom-fields/{contactCustomFieldId}	Edit a contact custom field
ContactsPhoneNumberTypesApi	create_phone_number_type	POST /v1/phone-number-types	Create a phone type
ContactsPhoneNumberTypesApi	delete_phone_number_type	DELETE /v1/phone-number-types/{phoneNumberTypeId}	Delete a phone type
ContactsPhoneNumberTypesApi	get_phone_number_types	GET /v1/phone-number-types	Get list of the phone types configured in your group
ContactsPhoneNumberTypesApi	update_phone_number_type	PUT /v1/phone-number-types/{phoneNumberTypeId}	Edit a phone type
ContactsRelationshipCategoryApi	create_relationship_category	POST /v1/relationship-categories	Create a relationship category
ContactsRelationshipCategoryApi	delete_relationship_category	DELETE /v1/relationship-categories/{relationshipCategoryId}	Delete a relationship category
ContactsRelationshipCategoryApi	edit_relationship_category	PUT /v1/relationship-categories/{relationshipCategoryId}	Edit a relationship category
ContactsRelationshipCategoryApi	get_relationship_categories	GET /v1/relationship-categories	Get list of the relationship categories configured in your group
ContactsRelationshipCategoryApi	update_relationship_category_order	POST /v1/relationship-categories/reorder	Reorder relationship categories
ContactsRelationshipsApi	create_contact_relationship_type	POST /v1/relationships	Create a relationship type
ContactsRelationshipsApi	delete_relationship	DELETE /v1/relationships/{relationshipId}	Delete a relationship type
ContactsRelationshipsApi	edit_relationship	PUT /v1/relationships/{relationshipId}	Edit a relationship type
ContactsRelationshipsApi	get_relationships	GET /v1/relationships	Get list of the relationships configured in your group
ContactsRolesApi	create_contact_role	POST /v1/contact-roles	Create contact roles
ContactsRolesApi	delete_contact_role	DELETE /v1/contact-roles/{contactRoleId}	Delete a contact role
ContactsRolesApi	get_contact_roles	GET /v1/contact-roles	Get list of the contact roles configured in your group
ContactsRolesApi	update_contact_role	PUT /v1/contact-roles/{contactRoleId}	Edit a contact role
ContactsTypesApi	create_contact_type	POST /v1/contact-types	Create contact types
ContactsTypesApi	delete_contact_type	DELETE /v1/contact-types/{contactTypeId}	Delete a contact type
ContactsTypesApi	get_contact_types	GET /v1/contact-types	Get list of the contact types configured in your group
ContactsTypesApi	update_contact_type	PUT /v1/contact-types/{contactTypeId}	Edit a contact type
CustomSymbolsCustomFieldsApi	create_custom_symbol_custom_field	POST /v1/custom-symbol-custom-fields	Create a Custom symbol custom field
CustomSymbolsCustomFieldsApi	delete_custom_symbol_custom_field	DELETE /v1/custom-symbol-custom-fields/{customSymbolCustomFieldId}	Delete a Custom symbol custom field
CustomSymbolsCustomFieldsApi	get_custom_symbol_custom_field	GET /v1/custom-symbol-custom-fields/{customSymbolCustomFieldId}	Get a specific Custom symbol custom field's details
CustomSymbolsCustomFieldsApi	get_custom_symbol_custom_fields	GET /v1/custom-symbol-custom-fields	Get all the Custom symbol custom fields
CustomSymbolsCustomFieldsApi	patch_custom_symbol_custom_field	PATCH /v1/custom-symbol-custom-fields/{customSymbolCustomFieldId}	Edit a Custom symbol custom field
CustomSymbolsRelationshipsApi	create_symbol_relationship_type	POST /v1/symbols-relationships	Create a symbol relationship
CustomSymbolsRelationshipsApi	delete_symbols_relationship	DELETE /v1/symbols-relationships/{symbolsRelationshipId}	Delete a symbol relationship
CustomSymbolsRelationshipsApi	edit_symbols_relationship	PUT /v1/symbols-relationships/{symbolsRelationshipId}	Edit a symbol relationship
CustomSymbolsRelationshipsApi	get_symbols_relationships	GET /v1/symbols-relationships	Get all the Symbols Relationships
CustomSymbolsTypesApi	create_custom_symbol_type	POST /v1/custom-symbol-types	Create a Custom symbol type
CustomSymbolsTypesApi	delete_custom_symbol_type_async	DELETE /v1/custom-symbol-types/{customSymbolTypeId}	Delete a Custom symbol type
CustomSymbolsTypesApi	get_custom_symbol_type	GET /v1/custom-symbol-types/{customSymbolTypeId}	Get a specific Custom symbol type's details
CustomSymbolsTypesApi	get_custom_symbol_types	GET /v1/custom-symbol-types	Get all the custom symbol types
CustomSymbolsTypesApi	get_symbol_custom_fields_for_custom_symbol_type	GET /v1/custom-symbol-types/{customSymbolTypeId}/custom-fields	Get Custom fields for Custom Symbol type
CustomSymbolsTypesApi	update_custom_symbol_type	PUT /v1/custom-symbol-types/{customSymbolTypeId}	Edit a Custom symbol type
CustomSymbolsTypesApi	update_custom_symbol_type_order	POST /v1/custom-symbol-types/reorder
NotesConfigurationApi	get_assigned_fact_set_users	GET /v1/users	Get all assigned FactSet users
NotesConfigurationApi	get_authors	GET /v1/authors	Get all Authors
NotesConfigurationApi	get_clients_sales_representative	GET /v1/group/client-sales-representative
NotesConfigurationApi	get_custom_fields	GET /v1/custom-fields	Get all Custom Fields
NotesConfigurationApi	get_group	GET /v1/group	Get Group details
NotesConfigurationApi	get_recommendations	GET /v1/recommendations	Get all Recommendations
NotesConfigurationApi	get_sentiments	GET /v1/sentiments	Get all Sentiments
NotesConfigurationApi	get_subject	GET /v1/subjects/{subjectId}	Get Subject details for the given Id provided
NotesConfigurationApi	get_subjects	GET /v1/subjects	Get all Subjects
NotesConfigurationApi	get_team	GET /v1/teams/{teamId}	Get Team details for the given Id provided
NotesConfigurationApi	get_teams	GET /v1/teams	Get all Teams

Documentation For Models

• ApprovalLevelConfigDto
• ApprovalProcessConfigDto
• AuthorConfigDto
• ClientSalesRepresentativeDto
• CommentaryConfigDto
• ContactCustomFieldDto
• ContactCustomFieldFormulaDto
• ContactCustomFieldOptionDto
• ContactCustomFieldOptionSaveDto
• ContactCustomFieldSaveDto
• ContactCustomFieldType
• ContactRoleDto
• ContactTypeDto
• CreateCustomSymbolCustomFieldDto
• CustomFieldConfigDto
• CustomSymbolCustomFieldConfigDto
• CustomSymbolCustomFieldFormulaConfigDto
• CustomSymbolSubTypeDto
• CustomSymbolTypeDetailDto
• CustomSymbolTypeDto
• CustomSymbolTypeSummaryDto
• DateSettingsDto
• EntityType
• ExtendedTextConfigDto
• FormulaConfigDto
• GroupConfigDto
• GroupFieldsDto
• HeadlineFormatConfigDto
• IdentifierSettingsDto
• IntegerConfigDto
• LinkSettingsDto
• NewItemDto
• NoteSettingsDto
• NumericConfigDto
• Operation
• OperationType
• OptionsConfigDto
• OrganizerSettingsDto
• PhoneNumberTypeDto
• ProblemDetails
• RatingConfigDto
• RecommendationConfigDto
• RecommendationSettingsDto
• RelatedContactsSettingsDto
• RelatedResearchSettingsDto
• RelatedSymbolsSettingsDto
• RelationshipCategoryDto
• RelationshipCategoryListDto
• RelationshipCategorySaveDto
• RelationshipDto
• RelationshipSaveDto
• RelationshipType
• ReorderCustomSymbolTypeDto
• SaveCustomSymbolTypeDto
• SentimentConfigDto
• SentimentSettingsDto
• SourceSettingsDto
• SubjectConfigDto
• SubjectSettingsDto
• SubjectSummaryDto
• SymbolsRelationShipSaveDto
• SymbolsRelationshipDto
• TeamConfigDto
• TeamSettingsDto
• TeamSummaryDto
• TitleSettingsDto
• UpdateCustomSymbolTypeDto
• UserConfigDto

Documentation For Authorization

FactSetApiKey

• Type: HTTP basic authentication

FactSetOAuth2

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes: N/A

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in fds.sdk.IRNConfiguration.apis and fds.sdk.IRNConfiguration.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

• from fds.sdk.IRNConfiguration.api.default_api import DefaultApi
• from fds.sdk.IRNConfiguration.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import fds.sdk.IRNConfiguration
from fds.sdk.IRNConfiguration.apis import *
from fds.sdk.IRNConfiguration.models import *

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.