fds.sdk.IRNNotes 4.0.1

IRN Notes client library for Python

IRN Notes 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: 4.0.1
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

For more information, please visit https://developer.factset.com/contact

Requirements

• Python >= 3.7

Installation

Poetry

poetry add fds.sdk.utils fds.sdk.IRNNotes==4.0.1

pip

pip install fds.sdk.utils fds.sdk.IRNNotes==4.0.1

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.IRNNotes
from fds.sdk.IRNNotes.api import attachments_api
from fds.sdk.IRNNotes.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.IRNNotes.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.IRNNotes.Configuration(
#     username='USERNAME-SERIAL',
#     password='API-KEY'
# )

# Enter a context with an instance of the API client
with fds.sdk.IRNNotes.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = attachments_api.AttachmentsApi(api_client)
    note_id = "noteId_example" # str | Note Id
    file = open('/path/to/file', 'rb') # file_type | 

    try:
        # Create an attachment for an existing note
        # example passing only required values which don't have defaults set
        api_response = api_instance.create_attachment(note_id, file)

        pprint(api_response)
    except fds.sdk.IRNNotes.ApiException as e:
        print("Exception when calling AttachmentsApi->create_attachment: %s\n" % e)

    # # Get response, http status code and response headers
    # try:
    #     # Create an attachment for an existing note
    #     api_response, http_status_code, response_headers = api_instance.create_attachment_with_http_info(note_id, file)


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

    # # Get response asynchronous
    # try:
    #     # Create an attachment for an existing note
    #     async_result = api_instance.create_attachment_async(note_id, file)
    #     api_response = async_result.get()


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

    # # Get response, http status code and response headers asynchronous
    # try:
    #     # Create an attachment for an existing note
    #     async_result = api_instance.create_attachment_with_http_info_async(note_id, file)
    #     api_response, http_status_code, response_headers = async_result.get()


    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.IRNNotes.ApiException as e:
    #     print("Exception when calling AttachmentsApi->create_attachment: %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.IRNNotes

logging.basicConfig(level=logging.DEBUG)

configuration = fds.sdk.IRNNotes.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.IRNNotes

configuration = fds.sdk.IRNNotes.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.IRNNotes

configuration = fds.sdk.IRNNotes.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.IRNNotes

configuration = fds.sdk.IRNNotes.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/v1

Class	Method	HTTP request	Description
AttachmentsApi	create_attachment	POST /notes/{noteId}/attachments	Create an attachment for an existing note
AttachmentsApi	download_attachment	GET /notes/{noteId}/attachments/{attachmentId}/download	Download an attachment from a Note
AttachmentsApi	get_attachments	GET /notes/{noteId}/attachments	Get all the attachments belonging to a note
AttachmentsApi	soft_delete_note_attachment	DELETE /notes/{noteId}/attachments/{attachmentId}	Delete attachment from note
CommentsApi	create_comment	POST /notes/{noteId}/comments	Create a comment to a Note
CommentsApi	create_comment_attachment	POST /notes/{noteId}/comments/{commentId}/attachments	Create a comment attachment to a Note
CommentsApi	delete_comment	DELETE /notes/{noteId}/comments/{commentId}	Delete a Comment from a Note
CommentsApi	download_comment_attachment_for_comment	GET /notes/{noteId}/comments/{commentId}/attachments/{attachmentId}/download	Download single attachment detail of a comment belonging to a note
CommentsApi	get_comment	GET /notes/{noteId}/comments/{commentId}	Get details of a comment belonging to a note
CommentsApi	get_comment_attachments	GET /notes/{noteId}/comments/{commentId}/attachments	Get attachments summary of a comment belonging to a note
CommentsApi	get_comments	GET /notes/{noteId}/comments	Get all comments for a note
CommentsApi	patch_comment	PATCH /notes/{noteId}/comments/{commentId}	Edit a comment for a note
EventsApi	get_all_events	GET /events	Get all the record events in the specified date range filtered on the given types
EventsApi	get_events	GET /notes/{noteId}/events	Get all the record events that belong to a note
EventsApi	get_record_event	GET /notes/{noteId}/events/{recordEventId}	Get details of a record event of a note
IdentifiersApi	get_identifiers	GET /identifiers	Get all the identifier details for given identifiers
NotesApi	create_note	POST /notes	Create a note
NotesApi	delete_note	DELETE /notes/{noteId}	Delete a Note
NotesApi	get_note	GET /notes/{noteId}	Get details of a note
NotesApi	get_notes	GET /notes	Get all the notes in the specified date range filtered on the given identifiers
NotesApi	update_note	PUT /notes/{noteId}	Updates a note by replacing existing note with new data

Documentation For Models

• AttachmentSummaryDto
• CommentDto
• CommentSummaryDto
• CreateBodyDto
• CreateCommentDto
• CreateCustomFieldValueDto
• CreateNoteDto
• CustomFieldValueDto
• EventSnippetDto
• NewItemDto
• NoteDto
• NoteEventDto
• NoteSummaryDto
• Operation
• OperationType
• ProblemDetails
• RecordChangeDto
• RecordEventSummaryDto
• RelatedRecordsDto
• SubcommentSummaryDto
• UpdateNoteDto
• UserSerialDto
• UserTeamLookupDto

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.IRNNotes.apis and fds.sdk.IRNNotes.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.IRNNotes.api.default_api import DefaultApi
• from fds.sdk.IRNNotes.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.IRNNotes
from fds.sdk.IRNNotes.apis import *
from fds.sdk.IRNNotes.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.