# finbourne-horizon-sdk
FINBOURNE Technology
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 0.1.455
- Package version: 2.1.17
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://www.finbourne.com](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:
```sh
pip install git+https://github.com/finbourne/horizon-sdk-python.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/finbourne/horizon-sdk-python.git`)
Then import the package:
```python
import finbourne_horizon
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import finbourne_horizon
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
You'll need to provide some configuration to connect to the finbourne_horizon application.
These can be provided using a secrets file or environment variables.
### Environment variables
In order to use [short lived access tokens](https://support.lusid.com/knowledgebase/article/KA-01654/en-us) you will need to have appropriate values set for the following environment variables:
```
FBN_TOKEN_URL,
FBN_FINBOURNE_HORIZON_API_URL,
FBN_USERNAME,
FBN_PASSWORD,
FBN_CLIENT_ID,
FBN_CLIENT_SECRET
```
To use a long lived Personal Access Token, you must provide the following environment variables:
```
FBN_FINBOURNE_HORIZON_API_URL,
FBN_ACCESS_TOKEN
```
You can send your requests to finbourne_horizon via a proxy, by setting `FBN_PROXY_ADDRESS`.
If your proxy has basic auth enabled, you must akso supply `FBN_PROXY_USERNAME` and `FBN_PROXY_PASSWORD`
### Secrets file
In order to use [short lived access tokens](https://support.lusid.com/knowledgebase/article/KA-01654/en-us) you will need to have appropriate values set in a `secrets.json` file in the same folder as your script.
```
{
"api":
{
"tokenUrl":"<your-token-url>",
"finbourne_horizonUrl":"<FINBOURNE-application-url>",
"username":"<your-username>",
"password":"<your-password>",
"clientId":"<your-client-id>",
"clientSecret":"<your-client-secret>",
}
}
```
To use a long lived Personal Access Token, you must provide a `secrets.json` with the following variables:
```
{
"api":
{
"finbourne_horizonUrl":"<FINBOURNE-application-url>",
"accessToken":"<your-access-token>"
}
}
```
You can send your requests to finbourne_horizon via a proxy, by adding a proxy section to your `secrets.json`.
If your proxy has basic auth enabled, you must also supply a `username` and `password` in this section.
```
{
"api":
{
"finbourne_horizonUrl":"<FINBOURNE-application-url>",
"accessToken":"<your-access-token>"
},
"proxy":
{
"address":"<your-proxy-address>",
"username":"<your-proxy-username>",
"password":"<your-proxy-password>"
}
}
```
### Using the SDK
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import time
import finbourne_horizon
from finbourne_horizon.exceptions import ApiException
from pprint import pprint
import os
from finbourne_horizon import (
ApiClientFactory,
InstrumentApi,
EnvironmentVariablesConfigurationLoader,
SecretsFileConfigurationLoader,
ArgsConfigurationLoader
)
# Use the finbourne_horizon 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/horizon"
# 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 = api_client_factory.build(InstrumentApi)
onboard_instrument_request = finbourne_horizon.OnboardInstrumentRequest() # OnboardInstrumentRequest |
try:
# [EARLY ACCESS] CreateInstrument: Creates and masters instruments with third party vendors.
api_response = await api_instance.create_instrument(onboard_instrument_request)
print("The response of InstrumentApi->create_instrument:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling InstrumentApi->create_instrument: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://fbn-prd.lusid.com/horizon*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*InstrumentApi* | [**create_instrument**](docs/InstrumentApi.md#create_instrument) | **POST** /api/instrument/onboarding/create | [EARLY ACCESS] CreateInstrument: Creates and masters instruments with third party vendors.
*InstrumentApi* | [**enrich_instrument**](docs/InstrumentApi.md#enrich_instrument) | **POST** /api/instrument/onboarding/enrich | [EARLY ACCESS] EnrichInstrument: Enriches an existing LUSID instrument using vendor data. Enrichment included identifiers, properties and market data.
*InstrumentApi* | [**get_open_figi_parameter_option**](docs/InstrumentApi.md#get_open_figi_parameter_option) | **GET** /api/instrument/onboarding/search/openfigi/parameterOptions | [EARLY ACCESS] GetOpenFigiParameterOption: Get all supported market sector values for OpenFigi search
*InstrumentApi* | [**retrieve_perm_id_result**](docs/InstrumentApi.md#retrieve_perm_id_result) | **GET** /api/instrument/onboarding/search/permid/{id} | [EARLY ACCESS] RetrievePermIdResult: Retrieve PermId results from a previous query.
*InstrumentApi* | [**search_open_figi**](docs/InstrumentApi.md#search_open_figi) | **GET** /api/instrument/onboarding/search/openfigi | [EARLY ACCESS] SearchOpenFigi: Search OpenFigi for instruments that match the specified terms.
*InstrumentApi* | [**vendors**](docs/InstrumentApi.md#vendors) | **GET** /api/instrument/onboarding/vendors | [EARLY ACCESS] Vendors: Gets the VendorProducts of any supported and licenced integrations for a given market sector and security type.
*IntegrationsApi* | [**create_instance**](docs/IntegrationsApi.md#create_instance) | **POST** /api/integrations/instances | [EXPERIMENTAL] CreateInstance: Create a single integration instance.
*IntegrationsApi* | [**delete_instance**](docs/IntegrationsApi.md#delete_instance) | **DELETE** /api/integrations/instances/{instanceId} | [EXPERIMENTAL] DeleteInstance: Delete a single integration instance.
*IntegrationsApi* | [**execute_instance**](docs/IntegrationsApi.md#execute_instance) | **POST** /api/integrations/instances/{instanceId}/execute | [EXPERIMENTAL] ExecuteInstance: Execute an integration instance.
*IntegrationsApi* | [**get_execution_ids_for_instance**](docs/IntegrationsApi.md#get_execution_ids_for_instance) | **GET** /api/integrations/instances/{instanceId}/executions | [EXPERIMENTAL] GetExecutionIdsForInstance: Get integration instance execution ids.
*IntegrationsApi* | [**get_schema**](docs/IntegrationsApi.md#get_schema) | **GET** /api/integrations/schema/{integration} | [EXPERIMENTAL] GetSchema: Get the JSON schema for the details section of an integration instance.
*IntegrationsApi* | [**list_instances**](docs/IntegrationsApi.md#list_instances) | **GET** /api/integrations/instances | [EXPERIMENTAL] ListInstances: List instances across all integrations.
*IntegrationsApi* | [**list_integrations**](docs/IntegrationsApi.md#list_integrations) | **GET** /api/integrations | [EXPERIMENTAL] ListIntegrations: List available integrations.
*IntegrationsApi* | [**update_instance**](docs/IntegrationsApi.md#update_instance) | **PUT** /api/integrations/instances/{instanceId} | [EXPERIMENTAL] UpdateInstance: Update a single integration instance.
*ProcessHistoryApi* | [**create_complete_event**](docs/ProcessHistoryApi.md#create_complete_event) | **POST** /api/process-history/event/complete | [EARLY ACCESS] CreateCompleteEvent: Write a completed event to the Horizon Dashboard
*ProcessHistoryApi* | [**create_update_event**](docs/ProcessHistoryApi.md#create_update_event) | **POST** /api/process-history/event/update | [EARLY ACCESS] CreateUpdateEvent: Write an update event to the Horizon Dashboard
*ProcessHistoryApi* | [**get_latest_runs**](docs/ProcessHistoryApi.md#get_latest_runs) | **GET** /api/process-history/$latestRuns | [EARLY ACCESS] GetLatestRuns: Get latest run for each process
*ProcessHistoryApi* | [**process_entry_updates**](docs/ProcessHistoryApi.md#process_entry_updates) | **POST** /api/process-history/entries/$query | [EARLY ACCESS] ProcessEntryUpdates: Get process entry updates for a query
*ProcessHistoryApi* | [**process_history_entries**](docs/ProcessHistoryApi.md#process_history_entries) | **POST** /api/process-history/$query | [EARLY ACCESS] ProcessHistoryEntries: Get process history entries
*VendorApi* | [**get_core_field_mappings_for_product_entity**](docs/VendorApi.md#get_core_field_mappings_for_product_entity) | **GET** /api/vendor/mappings/fields | [EARLY ACCESS] GetCoreFieldMappingsForProductEntity: Get core field mappings for a given vendor product's entity.
*VendorApi* | [**get_optional_mappings_for_product_entity**](docs/VendorApi.md#get_optional_mappings_for_product_entity) | **GET** /api/vendor/mappings/optional | [EARLY ACCESS] GetOptionalMappingsForProductEntity: Get a user defined LUSID property mappings for the specified vendor / LUSID entity.
*VendorApi* | [**get_property_mappings_for_product_entity**](docs/VendorApi.md#get_property_mappings_for_product_entity) | **GET** /api/vendor/mappings/properties | [EARLY ACCESS] GetPropertyMappingsForProductEntity: Gets the property mappings for a given vendor product's entity
*VendorApi* | [**query_vendors**](docs/VendorApi.md#query_vendors) | **POST** /api/vendor/$query | [EARLY ACCESS] QueryVendors: Query for vendors and their packages with entities and sub-entities.
*VendorApi* | [**set_optional_mappings_for_product_entity**](docs/VendorApi.md#set_optional_mappings_for_product_entity) | **POST** /api/vendor/mappings/optional | [EARLY ACCESS] SetOptionalMappingsForProductEntity: Create a user defined LUSID property mappings for the specified vendor / LUSID entity.
## Documentation For Models
- [AllowedParameterValue](docs/AllowedParameterValue.md)
- [AuditCompleteRequest](docs/AuditCompleteRequest.md)
- [AuditCompleteResponse](docs/AuditCompleteResponse.md)
- [AuditCompleteStatus](docs/AuditCompleteStatus.md)
- [AuditFileDetails](docs/AuditFileDetails.md)
- [AuditFileType](docs/AuditFileType.md)
- [AuditUpdateRequest](docs/AuditUpdateRequest.md)
- [AuditUpdateResponse](docs/AuditUpdateResponse.md)
- [CreateInstanceRequest](docs/CreateInstanceRequest.md)
- [EnrichmentResponse](docs/EnrichmentResponse.md)
- [ExecuteInstanceResponse](docs/ExecuteInstanceResponse.md)
- [FileDetails](docs/FileDetails.md)
- [Identifiers](docs/Identifiers.md)
- [InstanceIdentifier](docs/InstanceIdentifier.md)
- [IntegrationDescription](docs/IntegrationDescription.md)
- [IntegrationInstance](docs/IntegrationInstance.md)
- [Link](docs/Link.md)
- [LusidEntity](docs/LusidEntity.md)
- [LusidField](docs/LusidField.md)
- [LusidProblemDetails](docs/LusidProblemDetails.md)
- [LusidPropertyDefinition](docs/LusidPropertyDefinition.md)
- [LusidPropertyDefinitionOverrides](docs/LusidPropertyDefinitionOverrides.md)
- [LusidPropertyDefinitionOverridesResponse](docs/LusidPropertyDefinitionOverridesResponse.md)
- [LusidPropertyToVendorFieldMapping](docs/LusidPropertyToVendorFieldMapping.md)
- [LusidValidationProblemDetails](docs/LusidValidationProblemDetails.md)
- [OnboardInstrumentRequest](docs/OnboardInstrumentRequest.md)
- [OnboardInstrumentResponse](docs/OnboardInstrumentResponse.md)
- [OpenFigiData](docs/OpenFigiData.md)
- [OpenFigiParameterOptionName](docs/OpenFigiParameterOptionName.md)
- [OpenFigiPermIdResult](docs/OpenFigiPermIdResult.md)
- [OpenFigiSearchResult](docs/OpenFigiSearchResult.md)
- [Optionality](docs/Optionality.md)
- [PagedResourceListOfProcessInformation](docs/PagedResourceListOfProcessInformation.md)
- [PagedResourceListOfProcessUpdateResult](docs/PagedResourceListOfProcessUpdateResult.md)
- [PagedResourceListOfVendorProduct](docs/PagedResourceListOfVendorProduct.md)
- [PermIdData](docs/PermIdData.md)
- [ProcessInformation](docs/ProcessInformation.md)
- [ProcessSummary](docs/ProcessSummary.md)
- [ProcessUpdateResult](docs/ProcessUpdateResult.md)
- [QueryRequest](docs/QueryRequest.md)
- [QuerySpecification](docs/QuerySpecification.md)
- [ResourceId](docs/ResourceId.md)
- [RowDetails](docs/RowDetails.md)
- [Trigger](docs/Trigger.md)
- [UpdateInstanceRequest](docs/UpdateInstanceRequest.md)
- [VendorProduct](docs/VendorProduct.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="oauth2"></a>
### oauth2
- **Type**: OAuth
- **Flow**: implicit
- **Authorization URL**: https://lusid.okta.com/oauth2/default/v1/authorize
- **Scopes**: N/A
## Author
info@finbourne.com
Raw data
{
"_id": null,
"home_page": "https://github.com/finbourne/horizon-sdk-python",
"name": "finbourne-horizon-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, FINBOURNE Horizon API, finbourne-horizon-sdk",
"author": "FINBOURNE Technology",
"author_email": "info@finbourne.com",
"download_url": "https://files.pythonhosted.org/packages/53/33/f1772c481c5c5df5c2b36df74c0b5e9ec6290bd828e6fec34f5678359028/finbourne_horizon_sdk-2.1.17.tar.gz",
"platform": null,
"description": "# finbourne-horizon-sdk\nFINBOURNE Technology\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 0.1.455\n- Package version: 2.1.17\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\nFor more information, please visit [https://www.finbourne.com](https://www.finbourne.com)\n\n## Requirements.\n\nPython 3.7+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/finbourne/horizon-sdk-python.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/finbourne/horizon-sdk-python.git`)\n\nThen import the package:\n```python\nimport finbourne_horizon\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport finbourne_horizon\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nYou'll need to provide some configuration to connect to the finbourne_horizon application.\nThese can be provided using a secrets file or environment variables.\n\n### Environment variables\n\nIn order to use [short lived access tokens](https://support.lusid.com/knowledgebase/article/KA-01654/en-us) you will need to have appropriate values set for the following environment variables:\n\n``` \nFBN_TOKEN_URL,\nFBN_FINBOURNE_HORIZON_API_URL,\nFBN_USERNAME,\nFBN_PASSWORD,\nFBN_CLIENT_ID,\nFBN_CLIENT_SECRET\n```\n\nTo use a long lived Personal Access Token, you must provide the following environment variables:\n``` \nFBN_FINBOURNE_HORIZON_API_URL,\nFBN_ACCESS_TOKEN\n```\n\nYou can send your requests to finbourne_horizon via a proxy, by setting `FBN_PROXY_ADDRESS`. \nIf your proxy has basic auth enabled, you must akso supply `FBN_PROXY_USERNAME` and `FBN_PROXY_PASSWORD`\n\n### Secrets file\n\nIn order to use [short lived access tokens](https://support.lusid.com/knowledgebase/article/KA-01654/en-us) you will need to have appropriate values set in a `secrets.json` file in the same folder as your script.\n\n``` \n{\n \"api\":\n {\n \"tokenUrl\":\"<your-token-url>\",\n \"finbourne_horizonUrl\":\"<FINBOURNE-application-url>\",\n \"username\":\"<your-username>\",\n \"password\":\"<your-password>\",\n \"clientId\":\"<your-client-id>\",\n \"clientSecret\":\"<your-client-secret>\",\n }\n}\n```\n\nTo use a long lived Personal Access Token, you must provide a `secrets.json` with the following variables:\n``` \n{\n \"api\":\n {\n \"finbourne_horizonUrl\":\"<FINBOURNE-application-url>\",\n \"accessToken\":\"<your-access-token>\"\n }\n}\n```\n\nYou can send your requests to finbourne_horizon via a proxy, by adding a proxy section to your `secrets.json`. \nIf your proxy has basic auth enabled, you must also supply a `username` and `password` in this section.\n\n``` \n{\n \"api\":\n {\n \"finbourne_horizonUrl\":\"<FINBOURNE-application-url>\",\n \"accessToken\":\"<your-access-token>\"\n },\n \"proxy\":\n {\n \"address\":\"<your-proxy-address>\",\n \"username\":\"<your-proxy-username>\",\n \"password\":\"<your-proxy-password>\"\n }\n}\n```\n\n### Using the SDK\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport time\nimport finbourne_horizon\nfrom finbourne_horizon.exceptions import ApiException\nfrom pprint import pprint\n\nimport os\nfrom finbourne_horizon import (\n ApiClientFactory,\n InstrumentApi,\n EnvironmentVariablesConfigurationLoader,\n SecretsFileConfigurationLoader,\n ArgsConfigurationLoader\n)\n\n# Use the finbourne_horizon ApiClientFactory to build Api instances with a configured api client\n# By default this will read config from environment variables\n# Then from a secrets.json file found in the current working directory\napi_client_factory = ApiClientFactory()\n\n# The ApiClientFactory can be passed an iterable of configuration loaders to read configuration from\n\napi_url = \"https://fbn-prd.lusid.com/horizon\"\n# Path to a secrets.json file containing authentication credentials\n# See https://support.lusid.com/knowledgebase/article/KA-01667/en-us\n# for a detailed guide to setting up the SDK make authenticated calls to LUSID APIs\nsecrets_path = os.getenv(\"FBN_SECRETS_PATH\")\napp_name=\"LusidJupyterNotebook\"\n\nconfig_loaders = [\n\tEnvironmentVariablesConfigurationLoader(),\n\tSecretsFileConfigurationLoader(api_secrets_file=secrets_path),\n\tArgsConfigurationLoader(api_url=api_url, app_name=app_name)\n]\napi_client_factory = ApiClientFactory(config_loaders=config_loaders)\n\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n\n\n\n# Enter a context with an instance of the ApiClientFactory to ensure the connection pool is closed after use\nasync with api_client_factory:\n # Create an instance of the API class\n api_instance = api_client_factory.build(InstrumentApi)\n onboard_instrument_request = finbourne_horizon.OnboardInstrumentRequest() # OnboardInstrumentRequest | \n\n try:\n # [EARLY ACCESS] CreateInstrument: Creates and masters instruments with third party vendors.\n api_response = await api_instance.create_instrument(onboard_instrument_request)\n print(\"The response of InstrumentApi->create_instrument:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling InstrumentApi->create_instrument: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://fbn-prd.lusid.com/horizon*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*InstrumentApi* | [**create_instrument**](docs/InstrumentApi.md#create_instrument) | **POST** /api/instrument/onboarding/create | [EARLY ACCESS] CreateInstrument: Creates and masters instruments with third party vendors.\n*InstrumentApi* | [**enrich_instrument**](docs/InstrumentApi.md#enrich_instrument) | **POST** /api/instrument/onboarding/enrich | [EARLY ACCESS] EnrichInstrument: Enriches an existing LUSID instrument using vendor data. Enrichment included identifiers, properties and market data.\n*InstrumentApi* | [**get_open_figi_parameter_option**](docs/InstrumentApi.md#get_open_figi_parameter_option) | **GET** /api/instrument/onboarding/search/openfigi/parameterOptions | [EARLY ACCESS] GetOpenFigiParameterOption: Get all supported market sector values for OpenFigi search\n*InstrumentApi* | [**retrieve_perm_id_result**](docs/InstrumentApi.md#retrieve_perm_id_result) | **GET** /api/instrument/onboarding/search/permid/{id} | [EARLY ACCESS] RetrievePermIdResult: Retrieve PermId results from a previous query.\n*InstrumentApi* | [**search_open_figi**](docs/InstrumentApi.md#search_open_figi) | **GET** /api/instrument/onboarding/search/openfigi | [EARLY ACCESS] SearchOpenFigi: Search OpenFigi for instruments that match the specified terms.\n*InstrumentApi* | [**vendors**](docs/InstrumentApi.md#vendors) | **GET** /api/instrument/onboarding/vendors | [EARLY ACCESS] Vendors: Gets the VendorProducts of any supported and licenced integrations for a given market sector and security type.\n*IntegrationsApi* | [**create_instance**](docs/IntegrationsApi.md#create_instance) | **POST** /api/integrations/instances | [EXPERIMENTAL] CreateInstance: Create a single integration instance.\n*IntegrationsApi* | [**delete_instance**](docs/IntegrationsApi.md#delete_instance) | **DELETE** /api/integrations/instances/{instanceId} | [EXPERIMENTAL] DeleteInstance: Delete a single integration instance.\n*IntegrationsApi* | [**execute_instance**](docs/IntegrationsApi.md#execute_instance) | **POST** /api/integrations/instances/{instanceId}/execute | [EXPERIMENTAL] ExecuteInstance: Execute an integration instance.\n*IntegrationsApi* | [**get_execution_ids_for_instance**](docs/IntegrationsApi.md#get_execution_ids_for_instance) | **GET** /api/integrations/instances/{instanceId}/executions | [EXPERIMENTAL] GetExecutionIdsForInstance: Get integration instance execution ids.\n*IntegrationsApi* | [**get_schema**](docs/IntegrationsApi.md#get_schema) | **GET** /api/integrations/schema/{integration} | [EXPERIMENTAL] GetSchema: Get the JSON schema for the details section of an integration instance.\n*IntegrationsApi* | [**list_instances**](docs/IntegrationsApi.md#list_instances) | **GET** /api/integrations/instances | [EXPERIMENTAL] ListInstances: List instances across all integrations.\n*IntegrationsApi* | [**list_integrations**](docs/IntegrationsApi.md#list_integrations) | **GET** /api/integrations | [EXPERIMENTAL] ListIntegrations: List available integrations.\n*IntegrationsApi* | [**update_instance**](docs/IntegrationsApi.md#update_instance) | **PUT** /api/integrations/instances/{instanceId} | [EXPERIMENTAL] UpdateInstance: Update a single integration instance.\n*ProcessHistoryApi* | [**create_complete_event**](docs/ProcessHistoryApi.md#create_complete_event) | **POST** /api/process-history/event/complete | [EARLY ACCESS] CreateCompleteEvent: Write a completed event to the Horizon Dashboard\n*ProcessHistoryApi* | [**create_update_event**](docs/ProcessHistoryApi.md#create_update_event) | **POST** /api/process-history/event/update | [EARLY ACCESS] CreateUpdateEvent: Write an update event to the Horizon Dashboard\n*ProcessHistoryApi* | [**get_latest_runs**](docs/ProcessHistoryApi.md#get_latest_runs) | **GET** /api/process-history/$latestRuns | [EARLY ACCESS] GetLatestRuns: Get latest run for each process\n*ProcessHistoryApi* | [**process_entry_updates**](docs/ProcessHistoryApi.md#process_entry_updates) | **POST** /api/process-history/entries/$query | [EARLY ACCESS] ProcessEntryUpdates: Get process entry updates for a query\n*ProcessHistoryApi* | [**process_history_entries**](docs/ProcessHistoryApi.md#process_history_entries) | **POST** /api/process-history/$query | [EARLY ACCESS] ProcessHistoryEntries: Get process history entries\n*VendorApi* | [**get_core_field_mappings_for_product_entity**](docs/VendorApi.md#get_core_field_mappings_for_product_entity) | **GET** /api/vendor/mappings/fields | [EARLY ACCESS] GetCoreFieldMappingsForProductEntity: Get core field mappings for a given vendor product's entity.\n*VendorApi* | [**get_optional_mappings_for_product_entity**](docs/VendorApi.md#get_optional_mappings_for_product_entity) | **GET** /api/vendor/mappings/optional | [EARLY ACCESS] GetOptionalMappingsForProductEntity: Get a user defined LUSID property mappings for the specified vendor / LUSID entity.\n*VendorApi* | [**get_property_mappings_for_product_entity**](docs/VendorApi.md#get_property_mappings_for_product_entity) | **GET** /api/vendor/mappings/properties | [EARLY ACCESS] GetPropertyMappingsForProductEntity: Gets the property mappings for a given vendor product's entity\n*VendorApi* | [**query_vendors**](docs/VendorApi.md#query_vendors) | **POST** /api/vendor/$query | [EARLY ACCESS] QueryVendors: Query for vendors and their packages with entities and sub-entities.\n*VendorApi* | [**set_optional_mappings_for_product_entity**](docs/VendorApi.md#set_optional_mappings_for_product_entity) | **POST** /api/vendor/mappings/optional | [EARLY ACCESS] SetOptionalMappingsForProductEntity: Create a user defined LUSID property mappings for the specified vendor / LUSID entity.\n\n\n## Documentation For Models\n\n - [AllowedParameterValue](docs/AllowedParameterValue.md)\n - [AuditCompleteRequest](docs/AuditCompleteRequest.md)\n - [AuditCompleteResponse](docs/AuditCompleteResponse.md)\n - [AuditCompleteStatus](docs/AuditCompleteStatus.md)\n - [AuditFileDetails](docs/AuditFileDetails.md)\n - [AuditFileType](docs/AuditFileType.md)\n - [AuditUpdateRequest](docs/AuditUpdateRequest.md)\n - [AuditUpdateResponse](docs/AuditUpdateResponse.md)\n - [CreateInstanceRequest](docs/CreateInstanceRequest.md)\n - [EnrichmentResponse](docs/EnrichmentResponse.md)\n - [ExecuteInstanceResponse](docs/ExecuteInstanceResponse.md)\n - [FileDetails](docs/FileDetails.md)\n - [Identifiers](docs/Identifiers.md)\n - [InstanceIdentifier](docs/InstanceIdentifier.md)\n - [IntegrationDescription](docs/IntegrationDescription.md)\n - [IntegrationInstance](docs/IntegrationInstance.md)\n - [Link](docs/Link.md)\n - [LusidEntity](docs/LusidEntity.md)\n - [LusidField](docs/LusidField.md)\n - [LusidProblemDetails](docs/LusidProblemDetails.md)\n - [LusidPropertyDefinition](docs/LusidPropertyDefinition.md)\n - [LusidPropertyDefinitionOverrides](docs/LusidPropertyDefinitionOverrides.md)\n - [LusidPropertyDefinitionOverridesResponse](docs/LusidPropertyDefinitionOverridesResponse.md)\n - [LusidPropertyToVendorFieldMapping](docs/LusidPropertyToVendorFieldMapping.md)\n - [LusidValidationProblemDetails](docs/LusidValidationProblemDetails.md)\n - [OnboardInstrumentRequest](docs/OnboardInstrumentRequest.md)\n - [OnboardInstrumentResponse](docs/OnboardInstrumentResponse.md)\n - [OpenFigiData](docs/OpenFigiData.md)\n - [OpenFigiParameterOptionName](docs/OpenFigiParameterOptionName.md)\n - [OpenFigiPermIdResult](docs/OpenFigiPermIdResult.md)\n - [OpenFigiSearchResult](docs/OpenFigiSearchResult.md)\n - [Optionality](docs/Optionality.md)\n - [PagedResourceListOfProcessInformation](docs/PagedResourceListOfProcessInformation.md)\n - [PagedResourceListOfProcessUpdateResult](docs/PagedResourceListOfProcessUpdateResult.md)\n - [PagedResourceListOfVendorProduct](docs/PagedResourceListOfVendorProduct.md)\n - [PermIdData](docs/PermIdData.md)\n - [ProcessInformation](docs/ProcessInformation.md)\n - [ProcessSummary](docs/ProcessSummary.md)\n - [ProcessUpdateResult](docs/ProcessUpdateResult.md)\n - [QueryRequest](docs/QueryRequest.md)\n - [QuerySpecification](docs/QuerySpecification.md)\n - [ResourceId](docs/ResourceId.md)\n - [RowDetails](docs/RowDetails.md)\n - [Trigger](docs/Trigger.md)\n - [UpdateInstanceRequest](docs/UpdateInstanceRequest.md)\n - [VendorProduct](docs/VendorProduct.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n<a id=\"oauth2\"></a>\n### oauth2\n\n- **Type**: OAuth\n- **Flow**: implicit\n- **Authorization URL**: https://lusid.okta.com/oauth2/default/v1/authorize\n- **Scopes**: N/A\n\n\n## Author\n\ninfo@finbourne.com\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "FINBOURNE Horizon API",
"version": "2.1.17",
"project_urls": {
"Homepage": "https://github.com/finbourne/horizon-sdk-python",
"Repository": "https://github.com/finbourne/horizon-sdk-python"
},
"split_keywords": [
"openapi",
" openapi-generator",
" finbourne horizon api",
" finbourne-horizon-sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e2526df3f6566d88917f4074788b61ba02d42bc0b2ddb8673e6488cfcdda79ae",
"md5": "ddc29df05b9211ce94749f06f8b1fa6d",
"sha256": "fcca115f3a9363b1decca8534a3d36ae58f9e21d23ad0734e6d79a618e36c8bf"
},
"downloads": -1,
"filename": "finbourne_horizon_sdk-2.1.17-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ddc29df05b9211ce94749f06f8b1fa6d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 118346,
"upload_time": "2024-05-02T16:56:50",
"upload_time_iso_8601": "2024-05-02T16:56:50.595342Z",
"url": "https://files.pythonhosted.org/packages/e2/52/6df3f6566d88917f4074788b61ba02d42bc0b2ddb8673e6488cfcdda79ae/finbourne_horizon_sdk-2.1.17-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5333f1772c481c5c5df5c2b36df74c0b5e9ec6290bd828e6fec34f5678359028",
"md5": "4220c01b95125b3e4a322acd91ec0e8b",
"sha256": "4187284ce454d8ca4f189370d894a8e5e677e4f0659bc4a0c60544ba592d77b8"
},
"downloads": -1,
"filename": "finbourne_horizon_sdk-2.1.17.tar.gz",
"has_sig": false,
"md5_digest": "4220c01b95125b3e4a322acd91ec0e8b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 66038,
"upload_time": "2024-05-02T16:56:52",
"upload_time_iso_8601": "2024-05-02T16:56:52.954672Z",
"url": "https://files.pythonhosted.org/packages/53/33/f1772c481c5c5df5c2b36df74c0b5e9ec6290bd828e6fec34f5678359028/finbourne_horizon_sdk-2.1.17.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-02 16:56:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "finbourne",
"github_project": "horizon-sdk-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "finbourne-horizon-sdk"
}
JSON
