FINBOURNE Insights API
Project description
finbourne-insights-sdk
FINBOURNE Technology
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 0.0.755
- Package version: 2.0.5
- Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.finbourne.com
Requirements.
Python 3.7+
Installation & Usage
pip install
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/finbourne/insights-sdk-python.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com/finbourne/insights-sdk-python.git
)
Then import the package:
import finbourne_insights
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import finbourne_insights
Tests
Execute pytest
to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
import time
import finbourne_insights
from finbourne_insights.rest import ApiException
from pprint import pprint
from finbourne_insights import (
ApiClientFactory,
ApplicationMetadataApi,
EnvironmentVariablesConfigurationLoader,
SecretsFileConfigurationLoader,
ArgsConfigurationLoader
)
# Use the finbourne_insights ApiClientFactory to build Api instances with a configured api client
# By default this will read config from environment variables
# Then from a secrets.json file found in the current working directory
api_client_factory = ApiClientFactory()
# The ApiClientFactory can be passed an iterable of configuration loaders to read configuration from
api_url = "https://fbn-prd.lusid.com/insights"
# Path to a secrets.json file containing authentication credentials
# See https://support.lusid.com/knowledgebase/article/KA-01667/en-us
# for a detailed guide to setting up the SDK make authenticated calls to LUSID APIs
secrets_path = os.getenv("FBN_SECRETS_PATH")
app_name="LusidJupyterNotebook"
config_loaders = [
EnvironmentVariablesConfigurationLoader(),
SecretsFileConfigurationLoader(api_secrets_file=secrets_path),
ArgsConfigurationLoader(api_url=api_url, app_name=app_name)
]
api_client_factory = ApiClientFactory(config_loaders=config_loaders)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Enter a context with an instance of the ApiClientFactory to ensure the connection pool is closed after use
async with api_client_factory:
# Create an instance of the API class
api_instance = finbourne_insights.AccessEvaluationsApi(api_client)
id = 'id_example' # str | The identifier of the access evaluation to obtain the log for.
try:
# [EARLY ACCESS] GetAccessEvaluationLog: Get the log for a specific access evaluation. This endpoint will be deprecated in the near future.
api_response = await api_instance.get_access_evaluation_log(id)
print("The response of AccessEvaluationsApi->get_access_evaluation_log:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling AccessEvaluationsApi->get_access_evaluation_log: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://fbn-prd.lusid.com/insights
Class | Method | HTTP request | Description |
---|---|---|---|
AccessEvaluationsApi | get_access_evaluation_log | GET /api/access/{id} | [EARLY ACCESS] GetAccessEvaluationLog: Get the log for a specific access evaluation. This endpoint will be deprecated in the near future. |
AccessEvaluationsApi | list_access_evaluation_logs | GET /api/access | [EARLY ACCESS] ListAccessEvaluationLogs: List the logs for access evaluations. |
ApplicationMetadataApi | list_access_controlled_resources | GET /api/metadata/access/resources | [EARLY ACCESS] ListAccessControlledResources: Get resources available for access control |
AuditingApi | create_entry | POST /api/auditing/entries | [EARLY ACCESS] CreateEntry: Create (persist) and audit entry.. |
AuditingApi | get_processes | GET /api/auditing/processes | [EARLY ACCESS] GetProcesses: Get the latest audit entry for each process. |
AuditingApi | list_entries | GET /api/auditing/entries | [EARLY ACCESS] ListEntries: Get the audit entries. |
RequestsApi | get_request | GET /api/requests/{id}/request | [EARLY ACCESS] GetRequest: Get the request content for a specific API request. |
RequestsApi | get_request_log | GET /api/requests/{id} | [EARLY ACCESS] GetRequestLog: Get the log for a specific API request. |
RequestsApi | get_response | GET /api/requests/{id}/response | [EARLY ACCESS] GetResponse: Get the response for a specific API request. |
RequestsApi | list_request_logs | GET /api/requests | [EARLY ACCESS] ListRequestLogs: Get the logs for API requests. |
VendorLogsApi | get_vendor_log | GET /api/vendor/{id} | [EXPERIMENTAL] GetVendorLog: Get the log for a specific vendor request. |
VendorLogsApi | get_vendor_request | GET /api/vendor/{id}/request | [EXPERIMENTAL] GetVendorRequest: Get the request body for a vendor request. |
VendorLogsApi | get_vendor_response | GET /api/vendor/{id}/response | [EXPERIMENTAL] GetVendorResponse: Get the response from a vendor request. |
VendorLogsApi | list_vendor_logs | GET /api/vendor | [EXPERIMENTAL] ListVendorLogs: List the logs for vendor requests. |
Documentation For Models
- AccessControlledAction
- AccessControlledResource
- AccessEvaluationLog
- ActionId
- AuditData
- AuditDataSummary
- AuditEntry
- AuditEntryNote
- AuditProcess
- AuditProcessSummary
- Bucket
- CreateAuditEntry
- Histogram
- IdSelectorDefinition
- IdentifierPartSchema
- Link
- LusidProblemDetails
- LusidValidationProblemDetails
- ProblemDetails
- Request
- RequestLog
- Resource
- ResourceListOfAccessControlledResource
- ResourceListOfAuditProcessSummary
- ResourceListWithHistogramOfAccessEvaluationLog
- ResourceListWithHistogramOfRequestLog
- ResourceListWithHistogramOfVendorLog
- Response
- ScrollableCollectionOfAuditEntry
- VendorLog
- VendorRequest
- VendorResponse
Documentation For Authorization
Authentication schemes defined for the API:
oauth2
- Type: OAuth
- Flow: implicit
- Authorization URL: https://lusid.okta.com/oauth2/default/v1/authorize
- Scopes: N/A
Author
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for finbourne_insights_sdk-2.0.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fec434061a7b5c6baded93e5bce5e6768fb8d2a7fbbfdfa9e0ecab7bfc17445e |
|
MD5 | d11dc2be633690e75140d22b451e5e86 |
|
BLAKE2b-256 | 815fe086e5c8a28ec80a72526dfba1e95603dd26f6ca522c004539816e2ace7d |
Hashes for finbourne_insights_sdk-2.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a941b0799f6dd323ed329911041c1ae642d0626920441beb4b945d5c4daed8be |
|
MD5 | c721cfbc9bd37030a4fecb760ce38682 |
|
BLAKE2b-256 | db7cc2d21a71326f5a204e4c0a95dd95b0f9fe69c93d5aebec544c16b90862ca |