lusid-sdk 2.1.310__tar.gz → 2.1.318__tar.gz

{lusid_sdk-2.1.310 → lusid_sdk-2.1.318}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lusid-sdk
-Version: 2.1.310
+Version: 2.1.318
 Summary: LUSID API
 Home-page: https://github.com/finbourne/lusid-sdk-python
 License: MIT
@@ -24,194 +24,7 @@ Requires-Dist: urllib3 (>=1.25.3,<2.0.0)
 Project-URL: Repository, https://github.com/finbourne/lusid-sdk-python
 Description-Content-Type: text/markdown
 
-# lusid-sdk
-FINBOURNE Technology
-
-This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
-
-- API version: 0.11.6741
-- Package version: 2.1.310
-- 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/lusid-sdk-python.git
-```
-(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/finbourne/lusid-sdk-python.git`)
-
-Then import the package:
-```python
-import lusid
-```
-
-### 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 lusid
-```
-
-### Tests
-
-Execute `pytest` to run the tests.
-
-## Getting Started
-
-You'll need to provide some configuration to connect to the lusid 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_LUSID_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_LUSID_API_URL,
-FBN_ACCESS_TOKEN
-```
-
-You can send your requests to lusid 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>",
-        "lusidUrl":"<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":
-    {
-        "lusidUrl":"<FINBOURNE-application-url>",
-        "accessToken":"<your-access-token>"
-    }
-}
-```
-
-You can send your requests to lusid 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":
-    {
-        "lusidUrl":"<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 lusid
-from lusid.exceptions import ApiException
-from pprint import pprint
-
-import os
-from lusid import (
-    ApiClientFactory,
-    AborApi,
-    EnvironmentVariablesConfigurationLoader,
-    SecretsFileConfigurationLoader,
-    ArgsConfigurationLoader
-)
-
-# Use the lusid 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://www.lusid.com/api"
-# 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(AborApi)
-    scope = 'scope_example' # str | The scope of the Abor.
-    code = 'code_example' # str | The code of the Abor.
-    diary_entry_code = 'diary_entry_code_example' # str | Diary entry code
-    diary_entry_request = {"name":"2023_Q1","status":"Estimate","effectiveAt":"2023-04-02T15:10:10.0000000+00:00","queryAsAt":"2023-04-15T15:10:10.0000000+00:00","properties":{"DiaryEntry/AccountingDiary/Reports":{"key":"DiaryEntry/AccountingDiary/Reports","value":{"labelValue":"Some comments"}}}} # DiaryEntryRequest | The diary entry to add.
-
-    try:
-        # [EXPERIMENTAL] AddDiaryEntry: Add a diary entry to the specified Abor.
-        api_response = await api_instance.add_diary_entry(scope, code, diary_entry_code, diary_entry_request)
-        print("The response of AborApi->add_diary_entry:\n")
-        pprint(api_response)
-    except ApiException as e:
-        print("Exception when calling AborApi->add_diary_entry: %s\n" % e)
-
-```
-
+<a id="documentation-for-api-endpoints"></a>
 ## Documentation for API Endpoints
 
 All URIs are relative to *https://www.lusid.com/api*
@@ -240,7 +53,7 @@ Class | Method | HTTP request | Description
 *AddressKeyDefinitionApi* | [**get_address_key_definition**](docs/AddressKeyDefinitionApi.md#get_address_key_definition) | **GET** /api/addresskeydefinitions/{key} | [EARLY ACCESS] GetAddressKeyDefinition: Get an AddressKeyDefinition.
 *AddressKeyDefinitionApi* | [**list_address_key_definitions**](docs/AddressKeyDefinitionApi.md#list_address_key_definitions) | **GET** /api/addresskeydefinitions | [EARLY ACCESS] ListAddressKeyDefinitions: List AddressKeyDefinitions.
 *AggregationApi* | [**generate_configuration_recipe**](docs/AggregationApi.md#generate_configuration_recipe) | **POST** /api/aggregation/{scope}/{code}/$generateconfigurationrecipe | [EXPERIMENTAL] GenerateConfigurationRecipe: Generates a recipe sufficient to perform valuations for the given portfolio.
-*AggregationApi* | [**get_queryable_keys**](docs/AggregationApi.md#get_queryable_keys) | **GET** /api/results/queryable/keys | GetQueryableKeys: Query the set of supported \&quot;addresses\&quot; that can be queried from the aggregation endpoint.
+*AggregationApi* | [**get_queryable_keys**](docs/AggregationApi.md#get_queryable_keys) | **GET** /api/results/queryable/keys | GetQueryableKeys: Query the set of supported \"addresses\" that can be queried from the aggregation endpoint.
 *AggregationApi* | [**get_valuation**](docs/AggregationApi.md#get_valuation) | **POST** /api/aggregation/$valuation | GetValuation: Perform valuation for a list of portfolios and/or portfolio groups
 *AggregationApi* | [**get_valuation_of_weighted_instruments**](docs/AggregationApi.md#get_valuation_of_weighted_instruments) | **POST** /api/aggregation/$valuationinlined | GetValuationOfWeightedInstruments: Perform valuation for an inlined portfolio
 *AllocationsApi* | [**delete_allocation**](docs/AllocationsApi.md#delete_allocation) | **DELETE** /api/allocations/{scope}/{code} | [EARLY ACCESS] DeleteAllocation: Delete allocation
@@ -268,7 +81,7 @@ Class | Method | HTTP request | Description
 *CalendarsApi* | [**generate_schedule**](docs/CalendarsApi.md#generate_schedule) | **POST** /api/calendars/schedule/{scope} | [EARLY ACCESS] GenerateSchedule: Generate an ordered schedule of dates.
 *CalendarsApi* | [**get_calendar**](docs/CalendarsApi.md#get_calendar) | **GET** /api/calendars/generic/{scope}/{code} | GetCalendar: Get a calendar in its generic form
 *CalendarsApi* | [**get_dates**](docs/CalendarsApi.md#get_dates) | **GET** /api/calendars/generic/{scope}/{code}/dates | [EARLY ACCESS] GetDates: Get dates for a specific calendar
-*CalendarsApi* | [**is_business_date_time**](docs/CalendarsApi.md#is_business_date_time) | **GET** /api/calendars/businessday/{scope}/{code} | [EARLY ACCESS] IsBusinessDateTime: Check whether a DateTime is a \&quot;Business DateTime\&quot;
+*CalendarsApi* | [**is_business_date_time**](docs/CalendarsApi.md#is_business_date_time) | **GET** /api/calendars/businessday/{scope}/{code} | [EARLY ACCESS] IsBusinessDateTime: Check whether a DateTime is a \"Business DateTime\"
 *CalendarsApi* | [**list_calendars**](docs/CalendarsApi.md#list_calendars) | **GET** /api/calendars/generic | [EARLY ACCESS] ListCalendars: List Calendars
 *CalendarsApi* | [**list_calendars_in_scope**](docs/CalendarsApi.md#list_calendars_in_scope) | **GET** /api/calendars/generic/{scope} | ListCalendarsInScope: List all calenders in a specified scope
 *CalendarsApi* | [**update_calendar**](docs/CalendarsApi.md#update_calendar) | **POST** /api/calendars/generic/{scope}/{code} | [EARLY ACCESS] UpdateCalendar: Update a calendar
@@ -604,7 +417,7 @@ Class | Method | HTTP request | Description
 *PropertyDefinitionsApi* | [**update_derived_property_definition**](docs/PropertyDefinitionsApi.md#update_derived_property_definition) | **PUT** /api/propertydefinitions/derived/{domain}/{scope}/{code} | [EARLY ACCESS] UpdateDerivedPropertyDefinition: Update a pre-existing derived property definition
 *PropertyDefinitionsApi* | [**update_property_definition**](docs/PropertyDefinitionsApi.md#update_property_definition) | **PUT** /api/propertydefinitions/{domain}/{scope}/{code} | UpdatePropertyDefinition: Update property definition
 *PropertyDefinitionsApi* | [**upsert_property_definition_properties**](docs/PropertyDefinitionsApi.md#upsert_property_definition_properties) | **POST** /api/propertydefinitions/{domain}/{scope}/{code}/properties | UpsertPropertyDefinitionProperties: Upsert properties to a property definition
-*QueryableKeysApi* | [**get_all_queryable_keys**](docs/QueryableKeysApi.md#get_all_queryable_keys) | **GET** /api/queryablekeys | [EARLY ACCESS] GetAllQueryableKeys: Query the set of supported \&quot;addresses\&quot; that can be queried from all endpoints.
+*QueryableKeysApi* | [**get_all_queryable_keys**](docs/QueryableKeysApi.md#get_all_queryable_keys) | **GET** /api/queryablekeys | [EARLY ACCESS] GetAllQueryableKeys: Query the set of supported \"addresses\" that can be queried from all endpoints.
 *QuotesApi* | [**delete_quote_access_metadata_rule**](docs/QuotesApi.md#delete_quote_access_metadata_rule) | **DELETE** /api/metadata/quotes/rules/{scope} | [EXPERIMENTAL] DeleteQuoteAccessMetadataRule: Delete a Quote Access Metadata Rule
 *QuotesApi* | [**delete_quotes**](docs/QuotesApi.md#delete_quotes) | **POST** /api/quotes/{scope}/$delete | DeleteQuotes: Delete quotes
 *QuotesApi* | [**get_quotes**](docs/QuotesApi.md#get_quotes) | **POST** /api/quotes/{scope}/$get | GetQuotes: Get quotes
@@ -621,7 +434,7 @@ Class | Method | HTTP request | Description
 *ReconciliationsApi* | [**get_reconciliation_mapping**](docs/ReconciliationsApi.md#get_reconciliation_mapping) | **GET** /api/portfolios/mapping/{scope}/{code} | [EARLY ACCESS] GetReconciliationMapping: Get a mapping
 *ReconciliationsApi* | [**list_reconciliation_mappings**](docs/ReconciliationsApi.md#list_reconciliation_mappings) | **GET** /api/portfolios/mapping | [EARLY ACCESS] ListReconciliationMappings: List the reconciliation mappings
 *ReconciliationsApi* | [**list_reconciliations**](docs/ReconciliationsApi.md#list_reconciliations) | **GET** /api/portfolios/$scheduledReconciliations | [EXPERIMENTAL] ListReconciliations: List scheduled reconciliations
-*ReconciliationsApi* | [**reconcile_generic**](docs/ReconciliationsApi.md#reconcile_generic) | **POST** /api/portfolios/$reconcileGeneric | ReconcileGeneric: Reconcile either holdings or valuations performed on one or two sets of holdings using one or two configuration recipes.                The output is configurable for various types of comparisons, to allow tolerances on numerical and date-time data or case-insensitivity on strings,  and elision of resulting differences where they are &#39;empty&#39; or null or zero.
+*ReconciliationsApi* | [**reconcile_generic**](docs/ReconciliationsApi.md#reconcile_generic) | **POST** /api/portfolios/$reconcileGeneric | ReconcileGeneric: Reconcile either holdings or valuations performed on one or two sets of holdings using one or two configuration recipes.                The output is configurable for various types of comparisons, to allow tolerances on numerical and date-time data or case-insensitivity on strings,  and elision of resulting differences where they are 'empty' or null or zero.
 *ReconciliationsApi* | [**reconcile_holdings**](docs/ReconciliationsApi.md#reconcile_holdings) | **POST** /api/portfolios/$reconcileholdings | [EARLY ACCESS] ReconcileHoldings: Reconcile portfolio holdings
 *ReconciliationsApi* | [**reconcile_inline**](docs/ReconciliationsApi.md#reconcile_inline) | **POST** /api/portfolios/$reconcileInline | ReconcileInline: Reconcile valuations performed on one or two sets of inline instruments using one or two configuration recipes.
 *ReconciliationsApi* | [**reconcile_transactions**](docs/ReconciliationsApi.md#reconcile_transactions) | **POST** /api/portfolios/$reconcileTransactions | [EARLY ACCESS] ReconcileTransactions: Perform a Transactions Reconciliation.
@@ -757,7 +570,8 @@ Class | Method | HTTP request | Description
 *TranslationApi* | [**translate_trade_tickets**](docs/TranslationApi.md#translate_trade_tickets) | **POST** /api/translation/tradetickets | [EXPERIMENTAL] TranslateTradeTickets: Translate trade ticket
 
 
-## Documentation For Models
+<a id="documentation-for-models"></a>
+## Documentation for Models
 
  - [A2BBreakdown](docs/A2BBreakdown.md)
  - [A2BCategory](docs/A2BCategory.md)
@@ -1093,6 +907,7 @@ Class | Method | HTTP request | Description
  - [FundConfiguration](docs/FundConfiguration.md)
  - [FundConfigurationProperties](docs/FundConfigurationProperties.md)
  - [FundConfigurationRequest](docs/FundConfigurationRequest.md)
+ - [FundPnlBreakdown](docs/FundPnlBreakdown.md)
  - [FundPreviousNAV](docs/FundPreviousNAV.md)
  - [FundProperties](docs/FundProperties.md)
  - [FundRequest](docs/FundRequest.md)
@@ -1594,6 +1409,7 @@ Class | Method | HTTP request | Description
  - [ShareClassBreakdown](docs/ShareClassBreakdown.md)
  - [ShareClassData](docs/ShareClassData.md)
  - [ShareClassDetails](docs/ShareClassDetails.md)
+ - [ShareClassPnlBreakdown](docs/ShareClassPnlBreakdown.md)
  - [SideConfigurationData](docs/SideConfigurationData.md)
  - [SideConfigurationDataRequest](docs/SideConfigurationDataRequest.md)
  - [SideDefinition](docs/SideDefinition.md)
@@ -1785,23 +1601,3 @@ Class | Method | HTTP request | Description
  - [YieldCurveData](docs/YieldCurveData.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
-
-
-

{lusid_sdk-2.1.310 → lusid_sdk-2.1.318}/README.md

@@ -1,191 +1,4 @@
-# lusid-sdk
-FINBOURNE Technology
-
-This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
-
-- API version: 0.11.6741
-- Package version: 2.1.310
-- 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/lusid-sdk-python.git
-```
-(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/finbourne/lusid-sdk-python.git`)
-
-Then import the package:
-```python
-import lusid
-```
-
-### 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 lusid
-```
-
-### Tests
-
-Execute `pytest` to run the tests.
-
-## Getting Started
-
-You'll need to provide some configuration to connect to the lusid 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_LUSID_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_LUSID_API_URL,
-FBN_ACCESS_TOKEN
-```
-
-You can send your requests to lusid 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>",
-        "lusidUrl":"<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":
-    {
-        "lusidUrl":"<FINBOURNE-application-url>",
-        "accessToken":"<your-access-token>"
-    }
-}
-```
-
-You can send your requests to lusid 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":
-    {
-        "lusidUrl":"<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 lusid
-from lusid.exceptions import ApiException
-from pprint import pprint
-
-import os
-from lusid import (
-    ApiClientFactory,
-    AborApi,
-    EnvironmentVariablesConfigurationLoader,
-    SecretsFileConfigurationLoader,
-    ArgsConfigurationLoader
-)
-
-# Use the lusid 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://www.lusid.com/api"
-# 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(AborApi)
-    scope = 'scope_example' # str | The scope of the Abor.
-    code = 'code_example' # str | The code of the Abor.
-    diary_entry_code = 'diary_entry_code_example' # str | Diary entry code
-    diary_entry_request = {"name":"2023_Q1","status":"Estimate","effectiveAt":"2023-04-02T15:10:10.0000000+00:00","queryAsAt":"2023-04-15T15:10:10.0000000+00:00","properties":{"DiaryEntry/AccountingDiary/Reports":{"key":"DiaryEntry/AccountingDiary/Reports","value":{"labelValue":"Some comments"}}}} # DiaryEntryRequest | The diary entry to add.
-
-    try:
-        # [EXPERIMENTAL] AddDiaryEntry: Add a diary entry to the specified Abor.
-        api_response = await api_instance.add_diary_entry(scope, code, diary_entry_code, diary_entry_request)
-        print("The response of AborApi->add_diary_entry:\n")
-        pprint(api_response)
-    except ApiException as e:
-        print("Exception when calling AborApi->add_diary_entry: %s\n" % e)
-
-```
-
+<a id="documentation-for-api-endpoints"></a>
 ## Documentation for API Endpoints
 
 All URIs are relative to *https://www.lusid.com/api*
@@ -214,7 +27,7 @@ Class | Method | HTTP request | Description
 *AddressKeyDefinitionApi* | [**get_address_key_definition**](docs/AddressKeyDefinitionApi.md#get_address_key_definition) | **GET** /api/addresskeydefinitions/{key} | [EARLY ACCESS] GetAddressKeyDefinition: Get an AddressKeyDefinition.
 *AddressKeyDefinitionApi* | [**list_address_key_definitions**](docs/AddressKeyDefinitionApi.md#list_address_key_definitions) | **GET** /api/addresskeydefinitions | [EARLY ACCESS] ListAddressKeyDefinitions: List AddressKeyDefinitions.
 *AggregationApi* | [**generate_configuration_recipe**](docs/AggregationApi.md#generate_configuration_recipe) | **POST** /api/aggregation/{scope}/{code}/$generateconfigurationrecipe | [EXPERIMENTAL] GenerateConfigurationRecipe: Generates a recipe sufficient to perform valuations for the given portfolio.
-*AggregationApi* | [**get_queryable_keys**](docs/AggregationApi.md#get_queryable_keys) | **GET** /api/results/queryable/keys | GetQueryableKeys: Query the set of supported \&quot;addresses\&quot; that can be queried from the aggregation endpoint.
+*AggregationApi* | [**get_queryable_keys**](docs/AggregationApi.md#get_queryable_keys) | **GET** /api/results/queryable/keys | GetQueryableKeys: Query the set of supported \"addresses\" that can be queried from the aggregation endpoint.
 *AggregationApi* | [**get_valuation**](docs/AggregationApi.md#get_valuation) | **POST** /api/aggregation/$valuation | GetValuation: Perform valuation for a list of portfolios and/or portfolio groups
 *AggregationApi* | [**get_valuation_of_weighted_instruments**](docs/AggregationApi.md#get_valuation_of_weighted_instruments) | **POST** /api/aggregation/$valuationinlined | GetValuationOfWeightedInstruments: Perform valuation for an inlined portfolio
 *AllocationsApi* | [**delete_allocation**](docs/AllocationsApi.md#delete_allocation) | **DELETE** /api/allocations/{scope}/{code} | [EARLY ACCESS] DeleteAllocation: Delete allocation
@@ -242,7 +55,7 @@ Class | Method | HTTP request | Description
 *CalendarsApi* | [**generate_schedule**](docs/CalendarsApi.md#generate_schedule) | **POST** /api/calendars/schedule/{scope} | [EARLY ACCESS] GenerateSchedule: Generate an ordered schedule of dates.
 *CalendarsApi* | [**get_calendar**](docs/CalendarsApi.md#get_calendar) | **GET** /api/calendars/generic/{scope}/{code} | GetCalendar: Get a calendar in its generic form
 *CalendarsApi* | [**get_dates**](docs/CalendarsApi.md#get_dates) | **GET** /api/calendars/generic/{scope}/{code}/dates | [EARLY ACCESS] GetDates: Get dates for a specific calendar
-*CalendarsApi* | [**is_business_date_time**](docs/CalendarsApi.md#is_business_date_time) | **GET** /api/calendars/businessday/{scope}/{code} | [EARLY ACCESS] IsBusinessDateTime: Check whether a DateTime is a \&quot;Business DateTime\&quot;
+*CalendarsApi* | [**is_business_date_time**](docs/CalendarsApi.md#is_business_date_time) | **GET** /api/calendars/businessday/{scope}/{code} | [EARLY ACCESS] IsBusinessDateTime: Check whether a DateTime is a \"Business DateTime\"
 *CalendarsApi* | [**list_calendars**](docs/CalendarsApi.md#list_calendars) | **GET** /api/calendars/generic | [EARLY ACCESS] ListCalendars: List Calendars
 *CalendarsApi* | [**list_calendars_in_scope**](docs/CalendarsApi.md#list_calendars_in_scope) | **GET** /api/calendars/generic/{scope} | ListCalendarsInScope: List all calenders in a specified scope
 *CalendarsApi* | [**update_calendar**](docs/CalendarsApi.md#update_calendar) | **POST** /api/calendars/generic/{scope}/{code} | [EARLY ACCESS] UpdateCalendar: Update a calendar
@@ -578,7 +391,7 @@ Class | Method | HTTP request | Description
 *PropertyDefinitionsApi* | [**update_derived_property_definition**](docs/PropertyDefinitionsApi.md#update_derived_property_definition) | **PUT** /api/propertydefinitions/derived/{domain}/{scope}/{code} | [EARLY ACCESS] UpdateDerivedPropertyDefinition: Update a pre-existing derived property definition
 *PropertyDefinitionsApi* | [**update_property_definition**](docs/PropertyDefinitionsApi.md#update_property_definition) | **PUT** /api/propertydefinitions/{domain}/{scope}/{code} | UpdatePropertyDefinition: Update property definition
 *PropertyDefinitionsApi* | [**upsert_property_definition_properties**](docs/PropertyDefinitionsApi.md#upsert_property_definition_properties) | **POST** /api/propertydefinitions/{domain}/{scope}/{code}/properties | UpsertPropertyDefinitionProperties: Upsert properties to a property definition
-*QueryableKeysApi* | [**get_all_queryable_keys**](docs/QueryableKeysApi.md#get_all_queryable_keys) | **GET** /api/queryablekeys | [EARLY ACCESS] GetAllQueryableKeys: Query the set of supported \&quot;addresses\&quot; that can be queried from all endpoints.
+*QueryableKeysApi* | [**get_all_queryable_keys**](docs/QueryableKeysApi.md#get_all_queryable_keys) | **GET** /api/queryablekeys | [EARLY ACCESS] GetAllQueryableKeys: Query the set of supported \"addresses\" that can be queried from all endpoints.
 *QuotesApi* | [**delete_quote_access_metadata_rule**](docs/QuotesApi.md#delete_quote_access_metadata_rule) | **DELETE** /api/metadata/quotes/rules/{scope} | [EXPERIMENTAL] DeleteQuoteAccessMetadataRule: Delete a Quote Access Metadata Rule
 *QuotesApi* | [**delete_quotes**](docs/QuotesApi.md#delete_quotes) | **POST** /api/quotes/{scope}/$delete | DeleteQuotes: Delete quotes
 *QuotesApi* | [**get_quotes**](docs/QuotesApi.md#get_quotes) | **POST** /api/quotes/{scope}/$get | GetQuotes: Get quotes
@@ -595,7 +408,7 @@ Class | Method | HTTP request | Description
 *ReconciliationsApi* | [**get_reconciliation_mapping**](docs/ReconciliationsApi.md#get_reconciliation_mapping) | **GET** /api/portfolios/mapping/{scope}/{code} | [EARLY ACCESS] GetReconciliationMapping: Get a mapping
 *ReconciliationsApi* | [**list_reconciliation_mappings**](docs/ReconciliationsApi.md#list_reconciliation_mappings) | **GET** /api/portfolios/mapping | [EARLY ACCESS] ListReconciliationMappings: List the reconciliation mappings
 *ReconciliationsApi* | [**list_reconciliations**](docs/ReconciliationsApi.md#list_reconciliations) | **GET** /api/portfolios/$scheduledReconciliations | [EXPERIMENTAL] ListReconciliations: List scheduled reconciliations
-*ReconciliationsApi* | [**reconcile_generic**](docs/ReconciliationsApi.md#reconcile_generic) | **POST** /api/portfolios/$reconcileGeneric | ReconcileGeneric: Reconcile either holdings or valuations performed on one or two sets of holdings using one or two configuration recipes.                The output is configurable for various types of comparisons, to allow tolerances on numerical and date-time data or case-insensitivity on strings,  and elision of resulting differences where they are &#39;empty&#39; or null or zero.
+*ReconciliationsApi* | [**reconcile_generic**](docs/ReconciliationsApi.md#reconcile_generic) | **POST** /api/portfolios/$reconcileGeneric | ReconcileGeneric: Reconcile either holdings or valuations performed on one or two sets of holdings using one or two configuration recipes.                The output is configurable for various types of comparisons, to allow tolerances on numerical and date-time data or case-insensitivity on strings,  and elision of resulting differences where they are 'empty' or null or zero.
 *ReconciliationsApi* | [**reconcile_holdings**](docs/ReconciliationsApi.md#reconcile_holdings) | **POST** /api/portfolios/$reconcileholdings | [EARLY ACCESS] ReconcileHoldings: Reconcile portfolio holdings
 *ReconciliationsApi* | [**reconcile_inline**](docs/ReconciliationsApi.md#reconcile_inline) | **POST** /api/portfolios/$reconcileInline | ReconcileInline: Reconcile valuations performed on one or two sets of inline instruments using one or two configuration recipes.
 *ReconciliationsApi* | [**reconcile_transactions**](docs/ReconciliationsApi.md#reconcile_transactions) | **POST** /api/portfolios/$reconcileTransactions | [EARLY ACCESS] ReconcileTransactions: Perform a Transactions Reconciliation.
@@ -731,7 +544,8 @@ Class | Method | HTTP request | Description
 *TranslationApi* | [**translate_trade_tickets**](docs/TranslationApi.md#translate_trade_tickets) | **POST** /api/translation/tradetickets | [EXPERIMENTAL] TranslateTradeTickets: Translate trade ticket
 
 
-## Documentation For Models
+<a id="documentation-for-models"></a>
+## Documentation for Models
 
  - [A2BBreakdown](docs/A2BBreakdown.md)
  - [A2BCategory](docs/A2BCategory.md)
@@ -1067,6 +881,7 @@ Class | Method | HTTP request | Description
  - [FundConfiguration](docs/FundConfiguration.md)
  - [FundConfigurationProperties](docs/FundConfigurationProperties.md)
  - [FundConfigurationRequest](docs/FundConfigurationRequest.md)
+ - [FundPnlBreakdown](docs/FundPnlBreakdown.md)
  - [FundPreviousNAV](docs/FundPreviousNAV.md)
  - [FundProperties](docs/FundProperties.md)
  - [FundRequest](docs/FundRequest.md)
@@ -1568,6 +1383,7 @@ Class | Method | HTTP request | Description
  - [ShareClassBreakdown](docs/ShareClassBreakdown.md)
  - [ShareClassData](docs/ShareClassData.md)
  - [ShareClassDetails](docs/ShareClassDetails.md)
+ - [ShareClassPnlBreakdown](docs/ShareClassPnlBreakdown.md)
  - [SideConfigurationData](docs/SideConfigurationData.md)
  - [SideConfigurationDataRequest](docs/SideConfigurationDataRequest.md)
  - [SideDefinition](docs/SideDefinition.md)
@@ -1758,23 +1574,3 @@ Class | Method | HTTP request | Description
  - [WeightedInstruments](docs/WeightedInstruments.md)
  - [YieldCurveData](docs/YieldCurveData.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
-
-

{lusid_sdk-2.1.310 → lusid_sdk-2.1.318}/lusid/__init__.py

@@ -427,6 +427,7 @@ from lusid.models.fund_amount import FundAmount
 from lusid.models.fund_configuration import FundConfiguration
 from lusid.models.fund_configuration_properties import FundConfigurationProperties
 from lusid.models.fund_configuration_request import FundConfigurationRequest
+from lusid.models.fund_pnl_breakdown import FundPnlBreakdown
 from lusid.models.fund_previous_nav import FundPreviousNAV
 from lusid.models.fund_properties import FundProperties
 from lusid.models.fund_request import FundRequest
@@ -928,6 +929,7 @@ from lusid.models.share_class_amount import ShareClassAmount
 from lusid.models.share_class_breakdown import ShareClassBreakdown
 from lusid.models.share_class_data import ShareClassData
 from lusid.models.share_class_details import ShareClassDetails
+from lusid.models.share_class_pnl_breakdown import ShareClassPnlBreakdown
 from lusid.models.side_configuration_data import SideConfigurationData
 from lusid.models.side_configuration_data_request import SideConfigurationDataRequest
 from lusid.models.side_definition import SideDefinition
@@ -1532,6 +1534,7 @@ __all__ = [
     "FundConfiguration",
     "FundConfigurationProperties",
     "FundConfigurationRequest",
+    "FundPnlBreakdown",
     "FundPreviousNAV",
     "FundProperties",
     "FundRequest",
@@ -2033,6 +2036,7 @@ __all__ = [
     "ShareClassBreakdown",
     "ShareClassData",
     "ShareClassDetails",
+    "ShareClassPnlBreakdown",
     "SideConfigurationData",
     "SideConfigurationDataRequest",
     "SideDefinition",

{lusid_sdk-2.1.310 → lusid_sdk-2.1.318}/lusid/configuration.py

@@ -373,7 +373,7 @@ class Configuration:
         return "Python SDK Debug Report:\n"\
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
-               "Version of the API: 0.11.6741\n"\
+               "Version of the API: 0.11.6749\n"\
                "SDK Package Version: {package_version}".\
                format(env=sys.platform, pyversion=sys.version, package_version=package_version)
 

{lusid_sdk-2.1.310 → lusid_sdk-2.1.318}/lusid/extensions/configuration_loaders.py

@@ -10,7 +10,8 @@ logger = logging.getLogger(__name__)
 
 ENVIRONMENT_CONFIG_KEYS = {
     "token_url": "FBN_TOKEN_URL",
-    "api_url": "FBN_LUSID_API_URL",
+    "api_url": "FBN_LUSID_URL",
+    "previous_api_url": "FBN_LUSID_API_URL",
     "username": "FBN_USERNAME",
     "password": "FBN_PASSWORD",
     "client_id": "FBN_CLIENT_ID",
@@ -26,6 +27,7 @@ ENVIRONMENT_CONFIG_KEYS = {
 SECRETS_FILE_CONFIG_KEYS = {
     "token_url": "tokenUrl",
     "api_url": "lusidUrl",
+    "previous_api_url": "lusidUrl",
     "username": "username",
     "password": "password",
     "client_id": "clientId",
@@ -96,6 +98,9 @@ class SecretsFileConfigurationLoader:
             for key, value in SECRETS_FILE_CONFIG_KEYS.items()
             if "proxy" not in key
         }
+        if not populated_api_config_values["api_url"]:
+            populated_api_config_values["api_url"] = populated_api_config_values["previous_api_url"]
+        del(populated_api_config_values["previous_api_url"])
         proxy_config_section = config.get(proxy_config_key, {})
         populated_proxy_values = {
             key: proxy_config_section.get(value)
@@ -127,6 +132,9 @@ class EnvironmentVariablesConfigurationLoader:
             for key, value in ENVIRONMENT_CONFIG_KEYS.items()
             if "proxy" not in key
         }
+        if not populated_api_config_values["api_url"]:
+            populated_api_config_values["api_url"] = populated_api_config_values["previous_api_url"]
+        del(populated_api_config_values["previous_api_url"])
         populated_proxy_values = {
             key: os.environ.get(value)
             for key, value in ENVIRONMENT_CONFIG_KEYS.items()