fds.sdk.IRNConfiguration 0.9.1

IRN Configuration client library for Python

IRN Configuration client library for Python

Allows users to create, update and configure IRN data.

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

• API version: 1
• Package version: 0.9.1
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements

• Python >= 3.6

Installation

Poetry

poetry add fds.sdk.utils fds.sdk.IRNConfiguration

pip

pip install fds.sdk.utils fds.sdk.IRNConfiguration

Usage

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

   1. Install and activate python 3.6+. 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:

from fds.sdk.utils.authentication import ConfidentialClient
import fds.sdk.IRNConfiguration
from fds.sdk.IRNConfiguration.api import authors_api
from fds.sdk.IRNConfiguration.model.problem_details import ProblemDetails
from fds.sdk.IRNConfiguration.model.user_config_dto import UserConfigDto
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
# 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 = authors_api.AuthorsApi(api_client)
    x_irn_ignore_permissions = False # bool |  (optional) (default to False)

    try:
        # Get all Authors
        api_response = api_instance.v1_authors_get(x_irn_ignore_permissions=x_irn_ignore_permissions)
        pprint(api_response)
    except fds.sdk.IRNConfiguration.ApiException as e:
        print("Exception when calling AuthorsApi->v1_authors_get: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AuthorsApi	v1_authors_get	GET /v1/authors	Get all Authors
CustomFieldsApi	v1_custom_fields_get	GET /v1/custom-fields	Get all Custom Fields
GroupApi	v1_group_client_sales_representative_get	GET /v1/group/client-sales-representative
GroupApi	v1_group_get	GET /v1/group	Get Group details
RecommendationsApi	v1_recommendations_get	GET /v1/recommendations	Get all Recommendations
SentimentsApi	v1_sentiments_get	GET /v1/sentiments	Get all Sentiments
SubjectsApi	v1_subjects_get	GET /v1/subjects	Get all Subjects
SubjectsApi	v1_subjects_subject_id_get	GET /v1/subjects/{subjectId}	Get Subject details for the given Id provided
TeamsApi	v1_teams_get	GET /v1/teams	Get all Teams
TeamsApi	v1_teams_team_id_get	GET /v1/teams/{teamId}	Get Team details for the given Id provided
UsersApi	v1_users_get	GET /v1/users	Get all assigned FactSet users

Documentation For Models

• ApprovalLevelConfigDto
• ApprovalProcessConfigDto
• ClientSalesRepresentativeDto
• CommentaryConfigDto
• CustomFieldConfigDto
• ExtendedTextConfigDto
• FormulaConfigDto
• GroupConfigDto
• GroupFieldsDto
• HeadlineFormatConfigDto
• IntegerConfigDto
• NumericConfigDto
• OptionsConfigDto
• ProblemDetails
• RatingConfigDto
• RecommendationConfigDto
• RecommendationSettingsDto
• SentimentConfigDto
• SentimentSettingsDto
• SubjectConfigDto
• SubjectSettingsDto
• SubjectSummaryDto
• TeamConfigDto
• TeamSummaryDto
• 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.