Skip to main content

IRN Meetings client library for Python

Project description

FactSet

IRN Meetings client library for Python

API Version PyPi Apache-2 license

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

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

  • API version: 1.4.0
  • SDK version: 3.0.0
  • 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.IRNMeetings==3.0.0

pip

pip install fds.sdk.utils fds.sdk.IRNMeetings==3.0.0

Usage

  1. Generate authentication credentials.
  2. Setup Python environment.
    1. Install and activate python 3.10+. If you're using pyenv:

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

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

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

        pprint(api_response)
    except fds.sdk.IRNMeetings.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 a existing meeting
    #     api_response, http_status_code, response_headers = api_instance.create_attachment_with_http_info(meeting_id, file)


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

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


    #     pprint(api_response)
    # except fds.sdk.IRNMeetings.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 a existing meeting
    #     async_result = api_instance.create_attachment_with_http_info_async(meeting_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.IRNMeetings.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.IRNMeetings

logging.basicConfig(level=logging.DEBUG)

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

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

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

configuration = fds.sdk.IRNMeetings.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 /meetings/{meetingId}/attachments Create an attachment for a existing meeting
AttachmentsApi download_attachment GET /meetings/{meetingId}/attachments/{attachmentId}/download Download an attachment from a Meeting
AttachmentsApi get_attachments GET /meetings/{meetingId}/attachments Get all the attachments belonging to a meeting
AttachmentsApi soft_delete_meeting_attachment DELETE /meetings/{meetingId}/attachments/{attachmentId} Delete attachment from meeting
CommentsApi create_comment POST /meetings/{meetingId}/comments Create a comment to a Meeting
CommentsApi create_comment_attachment POST /meetings/{meetingId}/comments/{commentId}/attachments Create a comment attachment to a Meeting
CommentsApi delete_comment DELETE /meetings/{meetingId}/comments/{commentId} Delete a Comment from a Meeting
CommentsApi download_comment_attachment_for_comment GET /meetings/{meetingId}/comments/{commentId}/attachments/{attachmentId}/download Download single attachment detail of a comment belonging to a meeting
CommentsApi get_comment GET /meetings/{meetingId}/comments/{commentId} Get details of a comment belonging to a meeting
CommentsApi get_comment_attachments GET /meetings/{meetingId}/comments/{commentId}/attachments Get attachments summary of a comment belonging to a meeting
CommentsApi get_comments GET /meetings/{meetingId}/comments Get all comments for a meeting
CommentsApi patch_comment PATCH /meetings/{meetingId}/comments/{commentId} Edit a comment for a meeting
EventsApi get_events GET /meetings/{meetingId}/events Get all the record events that belong to a meeting
EventsApi get_record_event GET /meetings/{meetingId}/events/{recordEventId} Get details of a record event of a meeting
MeetingsApi create_meeting POST /meetings Create a meeting
MeetingsApi delete_meeting DELETE /meetings/{meetingId} Delete a Meeting
MeetingsApi get_meeting GET /meetings/{meetingId} Get details of a meeting
MeetingsApi get_meetings GET /meetings Get all the meetings in the specified date range filtered on the given identifiers
MeetingsApi update_meeting PUT /meetings/{meetingId} Update meeting

Documentation For Models

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

Contributing

Please refer to the contributing guide.

Copyright

Copyright 2026 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fds_sdk_irnmeetings-3.0.0.tar.gz (67.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fds_sdk_irnmeetings-3.0.0-py3-none-any.whl (127.3 kB view details)

Uploaded Python 3

File details

Details for the file fds_sdk_irnmeetings-3.0.0.tar.gz.

File metadata

  • Download URL: fds_sdk_irnmeetings-3.0.0.tar.gz
  • Upload date:
  • Size: 67.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.5

File hashes

Hashes for fds_sdk_irnmeetings-3.0.0.tar.gz
Algorithm Hash digest
SHA256 965c1c2ac1bcb1467f83a0708858ccb5c58cd934ecff00c7718affbbd5ea189b
MD5 20b9d4858fa1c9bf2587faf9133a1dfa
BLAKE2b-256 67ff8a09f3dfd7ef8bb59ed4dbc4a1402dd8a0d2dae2ccf7191ade4ffe20008d

See more details on using hashes here.

File details

Details for the file fds_sdk_irnmeetings-3.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for fds_sdk_irnmeetings-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 75da5ab9593da7889fb97d268af4d0483c9ce1452adfb8188f7e9dcbb4098ff5
MD5 cfdddea30d5e7f7d8ef6da03181be3a7
BLAKE2b-256 684b1a797bc3aef8d4bb049b53f7051bbfbdb7a511523719cb7b852afac23214

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page