Package: fds.sdk.IRNNotes
IRN Notes client library for PythonAllows users to extract, create, update and configure IRN data.This Python package is automatically generated by theOpenAPI Generatorproject:API version: 1Package version: 1.1.0Build package: org.openapitools.codegen.languages.PythonClientCodegenRequirementsPython >= 3.7InstallationPoetrypoetryaddfds.sdk.utilsfds.sdk.IRNNotes==1.1.0pippipinstallfds.sdk.utilsfds.sdk.IRNNotes==1.1.0UsageGenerate authentication credentials.Setup Python environment.Install and activate python 3.7+. If you're usingpyenv:pyenvinstall3.9.7
pyenvshell3.9.7(optional)Install poetry.Install dependencies.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 Codefromfds.sdk.utils.authenticationimportConfidentialClientimportfds.sdk.IRNNotesfromfds.sdk.IRNNotes.apiimportattachments_apifromfds.sdk.IRNNotes.modelsimport*fromdateutil.parserimportparseasdateutil_parserfrompprintimportpprint# 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 classconfiguration=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 clientwithfds.sdk.IRNNotes.ApiClient(configuration)asapi_client:# Create an instance of the API classapi_instance=attachments_api.AttachmentsApi(api_client)note_id="noteId_example"# str |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 setapi_response=api_instance.create_attachment(note_id,file)pprint(api_response)exceptfds.sdk.IRNNotes.ApiExceptionase: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 PandasTo convert an API response to a Pandas DataFrame, it is necessary to transform it first to a dictionary.importpandasaspdresponse_dict=api_response.to_dict()['data']simple_json_response=pd.DataFrame(response_dict)nested_json_response=pd.json_normalize(response_dict)DebuggingThe SDK uses the standard libraryloggingmodule.SettingdebugtoTrueon an instance of theConfigurationclass sets the log-level of related packages toDEBUGand enables additional logging in PythonsHTTP Client.Note: This prints out sensitive information (e.g. the full request and response). Use with care.importloggingimportfds.sdk.IRNNoteslogging.basicConfig(level=logging.DEBUG)configuration=fds.sdk.IRNNotes.Configuration(...)configuration.debug=TrueConfigure a ProxyYou 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).importfds.sdk.IRNNotesconfiguration=fds.sdk.IRNNotes.Configuration(# ...proxy="http://secret:password@localhost:5050",proxy_headers={"Custom-Proxy-Header":"Custom-Proxy-Header-Value"})Custom SSL CertificateTLS/SSL certificate verification can be configured with the following Configuration parameters:ssl_ca_cert: a path to the certificate to use for verification inPEMformat.verify_ssl: setting this toFalsedisables the verification of certificates.
Disabling the verification is not recommended, but it might be useful during
local development or testing.importfds.sdk.IRNNotesconfiguration=fds.sdk.IRNNotes.Configuration(# ...ssl_ca_cert='/path/to/ca.pem')Documentation for API EndpointsAll URIs are relative tohttps://api.factset.com/research/irnClassMethodHTTP requestDescriptionAttachmentsApicreate_attachmentPOST/v1/notes/{noteId}/attachmentsCreate an attachment for an existing noteAttachmentsApidownload_attachmentGET/v1/notes/{noteId}/attachments/{attachmentId}/downloadDownload an attachment from a NoteAttachmentsApiget_attachmentsGET/v1/notes/{noteId}/attachmentsGet all the attachments belonging to a noteAttachmentsApisoft_delete_note_attachmentDELETE/v1/notes/{noteId}/attachments/{attachmentId}Delete attachment from noteCommentsApicreate_commentPOST/v1/notes/{noteId}/commentsCreate a comment to a NoteCommentsApicreate_comment_attachmentPOST/v1/notes/{noteId}/comments/{commentId}/attachmentsCreate a comment attachment to a NoteCommentsApidelete_commentDELETE/v1/notes/{noteId}/comments/{commentId}Delete a Comment from a NoteCommentsApidownload_comment_attachment_for_commentGET/v1/notes/{noteId}/comments/{commentId}/attachments/{attachmentId}/downloadDownload single attachment detail of a comment belonging to a noteCommentsApiget_commentGET/v1/notes/{noteId}/comments/{commentId}Get details of a comment belonging to a noteCommentsApiget_comment_attachmentsGET/v1/notes/{noteId}/comments/{commentId}/attachmentsGet attachments summary of a comment belonging to a noteCommentsApiget_commentsGET/v1/notes/{noteId}/commentsGet all comments for a noteCommentsApipatch_commentPATCH/v1/notes/{noteId}/comments/{commentId}Edit a comment for a noteEventsApiget_all_eventsGET/v1/eventsGet all the record events in the specified date range filtered on the given typesEventsApiget_eventsGET/v1/notes/{noteId}/eventsGet all the record events that belong to a noteEventsApiget_record_eventGET/v1/notes/{noteId}/events/{recordEventId}Get details of a record event of a noteIdentifiersApiget_identifiersGET/v1/identifiersGet all the identifier details for given identifiersNotesApicreate_notePOST/v1/notesCreate a noteNotesApidelete_noteDELETE/v1/notes/{noteId}Delete a NoteNotesApiget_noteGET/v1/notes/{noteId}Get details of a noteNotesApiget_notesGET/v1/notesGet all the notes in the specified date range filtered on the given identifiersNotesApiupdate_notePUT/v1/notes/{noteId}Update a noteDocumentation For ModelsAttachmentSummaryDtoCommentDtoCommentSummaryDtoCreateBodyDtoCreateCommentDtoCreateCustomFieldValueDtoCreateNoteDtoCustomFieldValueDtoEventSnippetDtoNewItemDtoNoteDtoNoteEventDtoNoteSummaryDtoOperationOperationTypeProblemDetailsRecordChangeDtoRecordEventSummaryDtoRelatedRecordsDtoSubcommentSummaryDtoUpdateNoteDtoUserSerialDtoDocumentation For AuthorizationFactSetApiKeyType: HTTP basic authenticationFactSetOAuth2Type: OAuthFlow: applicationAuthorization URL:Scopes: N/ANotes for Large OpenAPI documentsIf 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 DefaultApifrom fds.sdk.IRNNotes.model.pet import PetSolution 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 *ContributingPlease refer to thecontributing guide.CopyrightCopyright 2022 FactSet Research Systems IncLicensed 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 athttp://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.