lusid-sdk 2.1.242__py3-none-any.whl → 2.1.320__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (104) hide show
  1. lusid/__init__.py +66 -0
  2. lusid/api/__init__.py +2 -0
  3. lusid/api/compliance_api.py +191 -0
  4. lusid/api/entities_api.py +360 -0
  5. lusid/api/fee_types_api.py +143 -0
  6. lusid/api/fund_configurations_api.py +944 -0
  7. lusid/api/funds_api.py +1 -1
  8. lusid/api/order_management_api.py +479 -1
  9. lusid/api/scopes_api.py +38 -9
  10. lusid/configuration.py +1 -1
  11. lusid/extensions/configuration_loaders.py +9 -1
  12. lusid/models/__init__.py +64 -0
  13. lusid/models/accounting_method.py +3 -0
  14. lusid/models/accumulation_event.py +3 -3
  15. lusid/models/amortisation_event.py +3 -3
  16. lusid/models/bond_coupon_event.py +3 -3
  17. lusid/models/bond_default_event.py +3 -3
  18. lusid/models/bond_principal_event.py +3 -3
  19. lusid/models/cancel_orders_response.py +153 -0
  20. lusid/models/cancel_placements_response.py +153 -0
  21. lusid/models/cancelled_order_result.py +73 -0
  22. lusid/models/cancelled_placement_result.py +83 -0
  23. lusid/models/capital_distribution_event.py +3 -3
  24. lusid/models/cash.py +93 -0
  25. lusid/models/cash_dividend_event.py +3 -3
  26. lusid/models/cash_flow_event.py +3 -3
  27. lusid/models/close_event.py +3 -3
  28. lusid/models/compliance_run_configuration.py +73 -0
  29. lusid/models/component_filter.py +85 -0
  30. lusid/models/component_rule.py +77 -0
  31. lusid/models/contract_for_difference.py +4 -2
  32. lusid/models/create_derived_transaction_portfolio_request.py +3 -3
  33. lusid/models/create_transaction_portfolio_request.py +3 -3
  34. lusid/models/dependency_source_filter.py +9 -2
  35. lusid/models/dividend_option_event.py +3 -3
  36. lusid/models/dividend_reinvestment_event.py +3 -3
  37. lusid/models/exercise_event.py +3 -3
  38. lusid/models/expiry_event.py +3 -3
  39. lusid/models/fee_transaction_template_specification.py +79 -0
  40. lusid/models/fund.py +6 -1
  41. lusid/models/fund_amount.py +69 -0
  42. lusid/models/fund_configuration.py +151 -0
  43. lusid/models/fund_configuration_properties.py +115 -0
  44. lusid/models/fund_configuration_request.py +136 -0
  45. lusid/models/fund_pnl_breakdown.py +110 -0
  46. lusid/models/fund_previous_nav.py +69 -0
  47. lusid/models/fund_request.py +6 -1
  48. lusid/models/fund_valuation_point_data.py +152 -0
  49. lusid/models/future_expiry_event.py +100 -0
  50. lusid/models/futures_contract_details.py +9 -2
  51. lusid/models/fx_forward_settlement_event.py +3 -3
  52. lusid/models/informational_error_event.py +3 -3
  53. lusid/models/informational_event.py +3 -3
  54. lusid/models/instrument_entity.py +146 -0
  55. lusid/models/instrument_event.py +6 -5
  56. lusid/models/instrument_event_type.py +1 -0
  57. lusid/models/lusid_instrument.py +3 -2
  58. lusid/models/market_data_key_rule.py +3 -3
  59. lusid/models/market_data_specific_rule.py +3 -3
  60. lusid/models/market_quote.py +3 -3
  61. lusid/models/maturity_event.py +3 -3
  62. lusid/models/merger_event.py +3 -3
  63. lusid/models/model_selection.py +3 -3
  64. lusid/models/open_event.py +3 -3
  65. lusid/models/paged_resource_list_of_fund_configuration.py +113 -0
  66. lusid/models/placement_update_request.py +116 -0
  67. lusid/models/portfolio.py +3 -3
  68. lusid/models/portfolio_details.py +3 -3
  69. lusid/models/portfolio_without_href.py +3 -3
  70. lusid/models/pre_trade_configuration.py +69 -0
  71. lusid/models/previous_fund_valuation_point_data.py +79 -0
  72. lusid/models/previous_nav.py +73 -0
  73. lusid/models/previous_share_class_breakdown.py +81 -0
  74. lusid/models/pricing_model.py +1 -0
  75. lusid/models/property_definition.py +7 -1
  76. lusid/models/property_definition_entity.py +146 -0
  77. lusid/models/quote_series_id.py +4 -20
  78. lusid/models/quote_type.py +3 -0
  79. lusid/models/raw_vendor_event.py +3 -3
  80. lusid/models/reset_event.py +3 -3
  81. lusid/models/reverse_stock_split_event.py +3 -3
  82. lusid/models/scrip_dividend_event.py +3 -3
  83. lusid/models/share_class_amount.py +73 -0
  84. lusid/models/share_class_breakdown.py +163 -0
  85. lusid/models/share_class_data.py +79 -0
  86. lusid/models/share_class_details.py +108 -0
  87. lusid/models/share_class_pnl_breakdown.py +110 -0
  88. lusid/models/spin_off_event.py +3 -3
  89. lusid/models/staged_modification.py +8 -1
  90. lusid/models/stock_dividend_event.py +3 -3
  91. lusid/models/stock_split_event.py +3 -3
  92. lusid/models/template_field.py +3 -1
  93. lusid/models/transaction_configuration_movement_data.py +2 -2
  94. lusid/models/transaction_configuration_movement_data_request.py +1 -1
  95. lusid/models/transaction_field_map.py +8 -3
  96. lusid/models/transaction_type_movement.py +2 -2
  97. lusid/models/transition_event.py +3 -3
  98. lusid/models/trigger_event.py +3 -3
  99. lusid/models/unitisation_data.py +73 -0
  100. lusid/models/update_placements_response.py +153 -0
  101. lusid/models/valuation_point_data_response.py +30 -9
  102. {lusid_sdk-2.1.242.dist-info → lusid_sdk-2.1.320.dist-info}/METADATA +53 -215
  103. {lusid_sdk-2.1.242.dist-info → lusid_sdk-2.1.320.dist-info}/RECORD +104 -71
  104. {lusid_sdk-2.1.242.dist-info → lusid_sdk-2.1.320.dist-info}/WHEEL +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: lusid-sdk
3
- Version: 2.1.242
3
+ Version: 2.1.320
4
4
  Summary: LUSID API
5
5
  Home-page: https://github.com/finbourne/lusid-sdk-python
6
6
  License: MIT
@@ -24,194 +24,7 @@ Requires-Dist: urllib3 (>=1.25.3,<2.0.0)
24
24
  Project-URL: Repository, https://github.com/finbourne/lusid-sdk-python
25
25
  Description-Content-Type: text/markdown
26
26
 
27
- # lusid-sdk
28
- FINBOURNE Technology
29
-
30
- This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
31
-
32
- - API version: 0.11.6675
33
- - Package version: 2.1.242
34
- - Build package: org.openapitools.codegen.languages.PythonClientCodegen
35
- For more information, please visit [https://www.finbourne.com](https://www.finbourne.com)
36
-
37
- ## Requirements.
38
-
39
- Python 3.7+
40
-
41
- ## Installation & Usage
42
- ### pip install
43
-
44
- If the python package is hosted on a repository, you can install directly using:
45
-
46
- ```sh
47
- pip install git+https://github.com/finbourne/lusid-sdk-python.git
48
- ```
49
- (you may need to run `pip` with root permission: `sudo pip install git+https://github.com/finbourne/lusid-sdk-python.git`)
50
-
51
- Then import the package:
52
- ```python
53
- import lusid
54
- ```
55
-
56
- ### Setuptools
57
-
58
- Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
59
-
60
- ```sh
61
- python setup.py install --user
62
- ```
63
- (or `sudo python setup.py install` to install the package for all users)
64
-
65
- Then import the package:
66
- ```python
67
- import lusid
68
- ```
69
-
70
- ### Tests
71
-
72
- Execute `pytest` to run the tests.
73
-
74
- ## Getting Started
75
-
76
- You'll need to provide some configuration to connect to the lusid application.
77
- These can be provided using a secrets file or environment variables.
78
-
79
- ### Environment variables
80
-
81
- 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:
82
-
83
- ```
84
- FBN_TOKEN_URL,
85
- FBN_LUSID_API_URL,
86
- FBN_USERNAME,
87
- FBN_PASSWORD,
88
- FBN_CLIENT_ID,
89
- FBN_CLIENT_SECRET
90
- ```
91
-
92
- To use a long lived Personal Access Token, you must provide the following environment variables:
93
- ```
94
- FBN_LUSID_API_URL,
95
- FBN_ACCESS_TOKEN
96
- ```
97
-
98
- You can send your requests to lusid via a proxy, by setting `FBN_PROXY_ADDRESS`.
99
- If your proxy has basic auth enabled, you must akso supply `FBN_PROXY_USERNAME` and `FBN_PROXY_PASSWORD`
100
-
101
- ### Secrets file
102
-
103
- 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.
104
-
105
- ```
106
- {
107
- "api":
108
- {
109
- "tokenUrl":"<your-token-url>",
110
- "lusidUrl":"<FINBOURNE-application-url>",
111
- "username":"<your-username>",
112
- "password":"<your-password>",
113
- "clientId":"<your-client-id>",
114
- "clientSecret":"<your-client-secret>",
115
- }
116
- }
117
- ```
118
-
119
- To use a long lived Personal Access Token, you must provide a `secrets.json` with the following variables:
120
- ```
121
- {
122
- "api":
123
- {
124
- "lusidUrl":"<FINBOURNE-application-url>",
125
- "accessToken":"<your-access-token>"
126
- }
127
- }
128
- ```
129
-
130
- You can send your requests to lusid via a proxy, by adding a proxy section to your `secrets.json`.
131
- If your proxy has basic auth enabled, you must also supply a `username` and `password` in this section.
132
-
133
- ```
134
- {
135
- "api":
136
- {
137
- "lusidUrl":"<FINBOURNE-application-url>",
138
- "accessToken":"<your-access-token>"
139
- },
140
- "proxy":
141
- {
142
- "address":"<your-proxy-address>",
143
- "username":"<your-proxy-username>",
144
- "password":"<your-proxy-password>"
145
- }
146
- }
147
- ```
148
-
149
- ### Using the SDK
150
-
151
- Please follow the [installation procedure](#installation--usage) and then run the following:
152
-
153
- ```python
154
-
155
- import time
156
- import lusid
157
- from lusid.exceptions import ApiException
158
- from pprint import pprint
159
-
160
- import os
161
- from lusid import (
162
- ApiClientFactory,
163
- AborApi,
164
- EnvironmentVariablesConfigurationLoader,
165
- SecretsFileConfigurationLoader,
166
- ArgsConfigurationLoader
167
- )
168
-
169
- # Use the lusid ApiClientFactory to build Api instances with a configured api client
170
- # By default this will read config from environment variables
171
- # Then from a secrets.json file found in the current working directory
172
- api_client_factory = ApiClientFactory()
173
-
174
- # The ApiClientFactory can be passed an iterable of configuration loaders to read configuration from
175
-
176
- api_url = "https://www.lusid.com/api"
177
- # Path to a secrets.json file containing authentication credentials
178
- # See https://support.lusid.com/knowledgebase/article/KA-01667/en-us
179
- # for a detailed guide to setting up the SDK make authenticated calls to LUSID APIs
180
- secrets_path = os.getenv("FBN_SECRETS_PATH")
181
- app_name="LusidJupyterNotebook"
182
-
183
- config_loaders = [
184
- EnvironmentVariablesConfigurationLoader(),
185
- SecretsFileConfigurationLoader(api_secrets_file=secrets_path),
186
- ArgsConfigurationLoader(api_url=api_url, app_name=app_name)
187
- ]
188
- api_client_factory = ApiClientFactory(config_loaders=config_loaders)
189
-
190
-
191
- # The client must configure the authentication and authorization parameters
192
- # in accordance with the API server security policy.
193
-
194
-
195
-
196
- # Enter a context with an instance of the ApiClientFactory to ensure the connection pool is closed after use
197
- async with api_client_factory:
198
- # Create an instance of the API class
199
- api_instance = api_client_factory.build(AborApi)
200
- scope = 'scope_example' # str | The scope of the Abor.
201
- code = 'code_example' # str | The code of the Abor.
202
- diary_entry_code = 'diary_entry_code_example' # str | Diary entry code
203
- 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.
204
-
205
- try:
206
- # [EXPERIMENTAL] AddDiaryEntry: Add a diary entry to the specified Abor.
207
- api_response = await api_instance.add_diary_entry(scope, code, diary_entry_code, diary_entry_request)
208
- print("The response of AborApi->add_diary_entry:\n")
209
- pprint(api_response)
210
- except ApiException as e:
211
- print("Exception when calling AborApi->add_diary_entry: %s\n" % e)
212
-
213
- ```
214
-
27
+ <a id="documentation-for-api-endpoints"></a>
215
28
  ## Documentation for API Endpoints
216
29
 
217
30
  All URIs are relative to *https://www.lusid.com/api*
@@ -240,7 +53,7 @@ Class | Method | HTTP request | Description
240
53
  *AddressKeyDefinitionApi* | [**get_address_key_definition**](docs/AddressKeyDefinitionApi.md#get_address_key_definition) | **GET** /api/addresskeydefinitions/{key} | [EARLY ACCESS] GetAddressKeyDefinition: Get an AddressKeyDefinition.
241
54
  *AddressKeyDefinitionApi* | [**list_address_key_definitions**](docs/AddressKeyDefinitionApi.md#list_address_key_definitions) | **GET** /api/addresskeydefinitions | [EARLY ACCESS] ListAddressKeyDefinitions: List AddressKeyDefinitions.
242
55
  *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.
243
- *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.
56
+ *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.
244
57
  *AggregationApi* | [**get_valuation**](docs/AggregationApi.md#get_valuation) | **POST** /api/aggregation/$valuation | GetValuation: Perform valuation for a list of portfolios and/or portfolio groups
245
58
  *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
246
59
  *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
268
81
  *CalendarsApi* | [**generate_schedule**](docs/CalendarsApi.md#generate_schedule) | **POST** /api/calendars/schedule/{scope} | [EARLY ACCESS] GenerateSchedule: Generate an ordered schedule of dates.
269
82
  *CalendarsApi* | [**get_calendar**](docs/CalendarsApi.md#get_calendar) | **GET** /api/calendars/generic/{scope}/{code} | GetCalendar: Get a calendar in its generic form
270
83
  *CalendarsApi* | [**get_dates**](docs/CalendarsApi.md#get_dates) | **GET** /api/calendars/generic/{scope}/{code}/dates | [EARLY ACCESS] GetDates: Get dates for a specific calendar
271
- *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;
84
+ *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\"
272
85
  *CalendarsApi* | [**list_calendars**](docs/CalendarsApi.md#list_calendars) | **GET** /api/calendars/generic | [EARLY ACCESS] ListCalendars: List Calendars
273
86
  *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
274
87
  *CalendarsApi* | [**update_calendar**](docs/CalendarsApi.md#update_calendar) | **POST** /api/calendars/generic/{scope}/{code} | [EARLY ACCESS] UpdateCalendar: Update a calendar
@@ -318,6 +131,7 @@ Class | Method | HTTP request | Description
318
131
  *ComplianceApi* | [**list_compliance_runs**](docs/ComplianceApi.md#list_compliance_runs) | **GET** /api/compliance/runs | [EARLY ACCESS] ListComplianceRuns: List historical compliance run identifiers.
319
132
  *ComplianceApi* | [**list_compliance_templates**](docs/ComplianceApi.md#list_compliance_templates) | **GET** /api/compliance/templates | [EARLY ACCESS] ListComplianceTemplates: List compliance templates.
320
133
  *ComplianceApi* | [**run_compliance**](docs/ComplianceApi.md#run_compliance) | **POST** /api/compliance/runs | [EARLY ACCESS] RunCompliance: Run a compliance check.
134
+ *ComplianceApi* | [**run_compliance_preview**](docs/ComplianceApi.md#run_compliance_preview) | **POST** /api/compliance/preview/runs | [EARLY ACCESS] RunCompliancePreview: Run a compliance check.
321
135
  *ComplianceApi* | [**update_compliance_template**](docs/ComplianceApi.md#update_compliance_template) | **PUT** /api/compliance/templates/{scope}/{code} | [EARLY ACCESS] UpdateComplianceTemplate: Update a ComplianceRuleTemplate
322
136
  *ComplianceApi* | [**upsert_compliance_rule**](docs/ComplianceApi.md#upsert_compliance_rule) | **POST** /api/compliance/rules | [EARLY ACCESS] UpsertComplianceRule: Upsert a compliance rule.
323
137
  *ComplianceApi* | [**upsert_compliance_run_summary**](docs/ComplianceApi.md#upsert_compliance_run_summary) | **POST** /api/compliance/runs/summary | [EARLY ACCESS] UpsertComplianceRunSummary: Upsert a compliance run summary.
@@ -394,17 +208,25 @@ Class | Method | HTTP request | Description
394
208
  *DataTypesApi* | [**update_reference_values**](docs/DataTypesApi.md#update_reference_values) | **PUT** /api/datatypes/{scope}/{code}/referencedatavalues | [EARLY ACCESS] UpdateReferenceValues: Update reference data on a data type
395
209
  *DerivedTransactionPortfoliosApi* | [**create_derived_portfolio**](docs/DerivedTransactionPortfoliosApi.md#create_derived_portfolio) | **POST** /api/derivedtransactionportfolios/{scope} | CreateDerivedPortfolio: Create derived portfolio
396
210
  *DerivedTransactionPortfoliosApi* | [**delete_derived_portfolio_details**](docs/DerivedTransactionPortfoliosApi.md#delete_derived_portfolio_details) | **DELETE** /api/derivedtransactionportfolios/{scope}/{code}/details | [EARLY ACCESS] DeleteDerivedPortfolioDetails: Delete derived portfolio details
211
+ *EntitiesApi* | [**get_instrument_by_entity_unique_id**](docs/EntitiesApi.md#get_instrument_by_entity_unique_id) | **GET** /api/entities/instruments/{entityUniqueId} | [EXPERIMENTAL] GetInstrumentByEntityUniqueId: Get instrument by EntityUniqueId
397
212
  *EntitiesApi* | [**get_portfolio_by_entity_unique_id**](docs/EntitiesApi.md#get_portfolio_by_entity_unique_id) | **GET** /api/entities/portfolios/{entityUniqueId} | [EXPERIMENTAL] GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId
398
213
  *EntitiesApi* | [**get_portfolio_changes**](docs/EntitiesApi.md#get_portfolio_changes) | **GET** /api/entities/changes/portfolios | GetPortfolioChanges: Get the next change to each portfolio in a scope.
214
+ *EntitiesApi* | [**get_property_definition_by_entity_unique_id**](docs/EntitiesApi.md#get_property_definition_by_entity_unique_id) | **GET** /api/entities/propertydefinitions/{entityUniqueId} | [EXPERIMENTAL] GetPropertyDefinitionByEntityUniqueId: Get property definition by EntityUniqueId
399
215
  *ExecutionsApi* | [**delete_execution**](docs/ExecutionsApi.md#delete_execution) | **DELETE** /api/executions/{scope}/{code} | [EARLY ACCESS] DeleteExecution: Delete execution
400
216
  *ExecutionsApi* | [**get_execution**](docs/ExecutionsApi.md#get_execution) | **GET** /api/executions/{scope}/{code} | [EARLY ACCESS] GetExecution: Get Execution
401
217
  *ExecutionsApi* | [**list_executions**](docs/ExecutionsApi.md#list_executions) | **GET** /api/executions | ListExecutions: List Executions
402
218
  *ExecutionsApi* | [**upsert_executions**](docs/ExecutionsApi.md#upsert_executions) | **POST** /api/executions | UpsertExecutions: Upsert Execution
403
219
  *FeeTypesApi* | [**create_fee_type**](docs/FeeTypesApi.md#create_fee_type) | **POST** /api/feetypes/{scope} | [EXPERIMENTAL] CreateFeeType: Create a FeeType.
404
220
  *FeeTypesApi* | [**delete_fee_type**](docs/FeeTypesApi.md#delete_fee_type) | **DELETE** /api/feetypes/{scope}/{code} | [EXPERIMENTAL] DeleteFeeType: Delete a FeeType.
221
+ *FeeTypesApi* | [**get_fee_template_specifications**](docs/FeeTypesApi.md#get_fee_template_specifications) | **GET** /api/feetypes/feetransactiontemplatespecification | [EXPERIMENTAL] GetFeeTemplateSpecifications: Get FeeTemplateSpecifications used in the FeeType.
405
222
  *FeeTypesApi* | [**get_fee_type**](docs/FeeTypesApi.md#get_fee_type) | **GET** /api/feetypes/{scope}/{code} | [EXPERIMENTAL] GetFeeType: Get a FeeType
406
223
  *FeeTypesApi* | [**list_fee_types**](docs/FeeTypesApi.md#list_fee_types) | **GET** /api/feetypes | [EXPERIMENTAL] ListFeeTypes: List FeeTypes
407
224
  *FeeTypesApi* | [**update_fee_type**](docs/FeeTypesApi.md#update_fee_type) | **PUT** /api/feetypes/{scope}/{code} | [EXPERIMENTAL] UpdateFeeType: Update a FeeType.
225
+ *FundConfigurationsApi* | [**create_fund_configuration**](docs/FundConfigurationsApi.md#create_fund_configuration) | **POST** /api/fundconfigurations/{scope} | [EXPERIMENTAL] CreateFundConfiguration: Create a FundConfiguration.
226
+ *FundConfigurationsApi* | [**delete_fund_configuration**](docs/FundConfigurationsApi.md#delete_fund_configuration) | **DELETE** /api/fundconfigurations/{scope}/{code} | [EXPERIMENTAL] DeleteFundConfiguration: Delete a FundConfiguration.
227
+ *FundConfigurationsApi* | [**get_fund_configuration**](docs/FundConfigurationsApi.md#get_fund_configuration) | **GET** /api/fundconfigurations/{scope}/{code} | [EXPERIMENTAL] GetFundConfiguration: Get FundConfiguration.
228
+ *FundConfigurationsApi* | [**list_fund_configurations**](docs/FundConfigurationsApi.md#list_fund_configurations) | **GET** /api/fundconfigurations | [EXPERIMENTAL] ListFundConfigurations: List FundConfiguration.
229
+ *FundConfigurationsApi* | [**upsert_fund_configuration_properties**](docs/FundConfigurationsApi.md#upsert_fund_configuration_properties) | **POST** /api/fundconfigurations/{scope}/{code}/properties/$upsert | [EXPERIMENTAL] UpsertFundConfigurationProperties: Upsert FundConfiguration properties
408
230
  *FundsApi* | [**accept_estimate_valuation_point**](docs/FundsApi.md#accept_estimate_valuation_point) | **POST** /api/funds/{scope}/{code}/valuationpoints/$acceptestimate | [EXPERIMENTAL] AcceptEstimateValuationPoint: Accepts an Estimate Valuation Point.
409
231
  *FundsApi* | [**create_fee**](docs/FundsApi.md#create_fee) | **POST** /api/funds/{scope}/{code}/fees | [EXPERIMENTAL] CreateFee: Create a Fee.
410
232
  *FundsApi* | [**create_fund**](docs/FundsApi.md#create_fund) | **POST** /api/funds/{scope} | [EXPERIMENTAL] CreateFund: Create a Fund.
@@ -419,7 +241,7 @@ Class | Method | HTTP request | Description
419
241
  *FundsApi* | [**list_funds**](docs/FundsApi.md#list_funds) | **GET** /api/funds | [EXPERIMENTAL] ListFunds: List Funds.
420
242
  *FundsApi* | [**patch_fee**](docs/FundsApi.md#patch_fee) | **PATCH** /api/funds/{scope}/{code}/fees/{feeCode} | [EXPERIMENTAL] PatchFee: Patch Fee.
421
243
  *FundsApi* | [**set_share_class_instruments**](docs/FundsApi.md#set_share_class_instruments) | **PUT** /api/funds/{scope}/{code}/shareclasses | [EXPERIMENTAL] SetShareClassInstruments: Set the ShareClass Instruments on a fund.
422
- *FundsApi* | [**upsert_diary_entry_type_valuation_point**](docs/FundsApi.md#upsert_diary_entry_type_valuation_point) | **POST** /api/funds/{scope}/{code}/valuationpoints/$upsert | [EXPERIMENTAL] UpsertDiaryEntryTypeValuationPoint: Upsert Valuation Point.
244
+ *FundsApi* | [**upsert_diary_entry_type_valuation_point**](docs/FundsApi.md#upsert_diary_entry_type_valuation_point) | **POST** /api/funds/{scope}/{code}/valuationpoints | [EXPERIMENTAL] UpsertDiaryEntryTypeValuationPoint: Upsert Valuation Point.
423
245
  *FundsApi* | [**upsert_fee_properties**](docs/FundsApi.md#upsert_fee_properties) | **POST** /api/funds/{scope}/{code}/fees/{feeCode}/properties/$upsert | [EXPERIMENTAL] UpsertFeeProperties: Upsert Fee properties.
424
246
  *FundsApi* | [**upsert_fund_properties**](docs/FundsApi.md#upsert_fund_properties) | **POST** /api/funds/{scope}/{code}/properties/$upsert | [EXPERIMENTAL] UpsertFundProperties: Upsert Fund properties.
425
247
  *InstrumentEventTypesApi* | [**create_transaction_template**](docs/InstrumentEventTypesApi.md#create_transaction_template) | **POST** /api/instrumenteventtypes/{instrumentEventType}/transactiontemplates/{instrumentType}/{scope} | [EXPERIMENTAL] CreateTransactionTemplate: Create Transaction Template
@@ -488,10 +310,13 @@ Class | Method | HTTP request | Description
488
310
  *OrderInstructionsApi* | [**list_order_instructions**](docs/OrderInstructionsApi.md#list_order_instructions) | **GET** /api/orderinstructions | [EXPERIMENTAL] ListOrderInstructions: List OrderInstructions
489
311
  *OrderInstructionsApi* | [**upsert_order_instructions**](docs/OrderInstructionsApi.md#upsert_order_instructions) | **POST** /api/orderinstructions | [EXPERIMENTAL] UpsertOrderInstructions: Upsert OrderInstruction
490
312
  *OrderManagementApi* | [**book_transactions**](docs/OrderManagementApi.md#book_transactions) | **POST** /api/ordermanagement/booktransactions | [EXPERIMENTAL] BookTransactions: Books transactions using specific allocations as a source.
313
+ *OrderManagementApi* | [**cancel_orders**](docs/OrderManagementApi.md#cancel_orders) | **POST** /api/ordermanagement/cancelorders | [EARLY ACCESS] CancelOrders: Cancel existing orders
314
+ *OrderManagementApi* | [**cancel_placements**](docs/OrderManagementApi.md#cancel_placements) | **POST** /api/ordermanagement/$cancelplacements | [EARLY ACCESS] CancelPlacements: Cancel existing placements
491
315
  *OrderManagementApi* | [**create_orders**](docs/OrderManagementApi.md#create_orders) | **POST** /api/ordermanagement/createorders | [EARLY ACCESS] CreateOrders: Upsert a Block and associated orders
492
316
  *OrderManagementApi* | [**move_orders**](docs/OrderManagementApi.md#move_orders) | **POST** /api/ordermanagement/moveorders | [EARLY ACCESS] MoveOrders: Move orders to new or existing block
493
317
  *OrderManagementApi* | [**place_blocks**](docs/OrderManagementApi.md#place_blocks) | **POST** /api/ordermanagement/placeblocks | [EARLY ACCESS] PlaceBlocks: Places blocks for a given list of placement requests.
494
318
  *OrderManagementApi* | [**run_allocation_service**](docs/OrderManagementApi.md#run_allocation_service) | **POST** /api/ordermanagement/allocate | [EXPERIMENTAL] RunAllocationService: Runs the Allocation Service
319
+ *OrderManagementApi* | [**update_placements**](docs/OrderManagementApi.md#update_placements) | **POST** /api/ordermanagement/$updateplacements | [EARLY ACCESS] UpdatePlacements: Update existing placements
495
320
  *OrdersApi* | [**delete_order**](docs/OrdersApi.md#delete_order) | **DELETE** /api/orders/{scope}/{code} | [EARLY ACCESS] DeleteOrder: Delete order
496
321
  *OrdersApi* | [**get_order**](docs/OrdersApi.md#get_order) | **GET** /api/orders/{scope}/{code} | [EARLY ACCESS] GetOrder: Get Order
497
322
  *OrdersApi* | [**list_orders**](docs/OrdersApi.md#list_orders) | **GET** /api/orders | ListOrders: List Orders
@@ -593,7 +418,7 @@ Class | Method | HTTP request | Description
593
418
  *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
594
419
  *PropertyDefinitionsApi* | [**update_property_definition**](docs/PropertyDefinitionsApi.md#update_property_definition) | **PUT** /api/propertydefinitions/{domain}/{scope}/{code} | UpdatePropertyDefinition: Update property definition
595
420
  *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
596
- *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.
421
+ *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.
597
422
  *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
598
423
  *QuotesApi* | [**delete_quotes**](docs/QuotesApi.md#delete_quotes) | **POST** /api/quotes/{scope}/$delete | DeleteQuotes: Delete quotes
599
424
  *QuotesApi* | [**get_quotes**](docs/QuotesApi.md#get_quotes) | **POST** /api/quotes/{scope}/$get | GetQuotes: Get quotes
@@ -610,7 +435,7 @@ Class | Method | HTTP request | Description
610
435
  *ReconciliationsApi* | [**get_reconciliation_mapping**](docs/ReconciliationsApi.md#get_reconciliation_mapping) | **GET** /api/portfolios/mapping/{scope}/{code} | [EARLY ACCESS] GetReconciliationMapping: Get a mapping
611
436
  *ReconciliationsApi* | [**list_reconciliation_mappings**](docs/ReconciliationsApi.md#list_reconciliation_mappings) | **GET** /api/portfolios/mapping | [EARLY ACCESS] ListReconciliationMappings: List the reconciliation mappings
612
437
  *ReconciliationsApi* | [**list_reconciliations**](docs/ReconciliationsApi.md#list_reconciliations) | **GET** /api/portfolios/$scheduledReconciliations | [EXPERIMENTAL] ListReconciliations: List scheduled reconciliations
613
- *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.
438
+ *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.
614
439
  *ReconciliationsApi* | [**reconcile_holdings**](docs/ReconciliationsApi.md#reconcile_holdings) | **POST** /api/portfolios/$reconcileholdings | [EARLY ACCESS] ReconcileHoldings: Reconcile portfolio holdings
615
440
  *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.
616
441
  *ReconciliationsApi* | [**reconcile_transactions**](docs/ReconciliationsApi.md#reconcile_transactions) | **POST** /api/portfolios/$reconcileTransactions | [EARLY ACCESS] ReconcileTransactions: Perform a Transactions Reconciliation.
@@ -746,7 +571,8 @@ Class | Method | HTTP request | Description
746
571
  *TranslationApi* | [**translate_trade_tickets**](docs/TranslationApi.md#translate_trade_tickets) | **POST** /api/translation/tradetickets | [EXPERIMENTAL] TranslateTradeTickets: Translate trade ticket
747
572
 
748
573
 
749
- ## Documentation For Models
574
+ <a id="documentation-for-models"></a>
575
+ ## Documentation for Models
750
576
 
751
577
  - [A2BBreakdown](docs/A2BBreakdown.md)
752
578
  - [A2BCategory](docs/A2BCategory.md)
@@ -840,8 +666,13 @@ Class | Method | HTTP request | Description
840
666
  - [Calendar](docs/Calendar.md)
841
667
  - [CalendarDate](docs/CalendarDate.md)
842
668
  - [CalendarDependency](docs/CalendarDependency.md)
669
+ - [CancelOrdersResponse](docs/CancelOrdersResponse.md)
670
+ - [CancelPlacementsResponse](docs/CancelPlacementsResponse.md)
671
+ - [CancelledOrderResult](docs/CancelledOrderResult.md)
672
+ - [CancelledPlacementResult](docs/CancelledPlacementResult.md)
843
673
  - [CapFloor](docs/CapFloor.md)
844
674
  - [CapitalDistributionEvent](docs/CapitalDistributionEvent.md)
675
+ - [Cash](docs/Cash.md)
845
676
  - [CashAndSecurityOfferElection](docs/CashAndSecurityOfferElection.md)
846
677
  - [CashDependency](docs/CashDependency.md)
847
678
  - [CashDividendEvent](docs/CashDividendEvent.md)
@@ -893,6 +724,7 @@ Class | Method | HTTP request | Description
893
724
  - [ComplianceRuleTemplate](docs/ComplianceRuleTemplate.md)
894
725
  - [ComplianceRuleUpsertRequest](docs/ComplianceRuleUpsertRequest.md)
895
726
  - [ComplianceRuleUpsertResponse](docs/ComplianceRuleUpsertResponse.md)
727
+ - [ComplianceRunConfiguration](docs/ComplianceRunConfiguration.md)
896
728
  - [ComplianceRunInfo](docs/ComplianceRunInfo.md)
897
729
  - [ComplianceRunInfoV2](docs/ComplianceRunInfoV2.md)
898
730
  - [ComplianceStep](docs/ComplianceStep.md)
@@ -906,6 +738,8 @@ Class | Method | HTTP request | Description
906
738
  - [ComplianceTemplateVariation](docs/ComplianceTemplateVariation.md)
907
739
  - [ComplianceTemplateVariationDto](docs/ComplianceTemplateVariationDto.md)
908
740
  - [ComplianceTemplateVariationRequest](docs/ComplianceTemplateVariationRequest.md)
741
+ - [ComponentFilter](docs/ComponentFilter.md)
742
+ - [ComponentRule](docs/ComponentRule.md)
909
743
  - [ComponentTransaction](docs/ComponentTransaction.md)
910
744
  - [CompositeBreakdown](docs/CompositeBreakdown.md)
911
745
  - [CompositeBreakdownRequest](docs/CompositeBreakdownRequest.md)
@@ -1051,6 +885,7 @@ Class | Method | HTTP request | Description
1051
885
  - [FeeRule](docs/FeeRule.md)
1052
886
  - [FeeRuleUpsertRequest](docs/FeeRuleUpsertRequest.md)
1053
887
  - [FeeRuleUpsertResponse](docs/FeeRuleUpsertResponse.md)
888
+ - [FeeTransactionTemplateSpecification](docs/FeeTransactionTemplateSpecification.md)
1054
889
  - [FeeType](docs/FeeType.md)
1055
890
  - [FeeTypeRequest](docs/FeeTypeRequest.md)
1056
891
  - [FieldDefinition](docs/FieldDefinition.md)
@@ -1071,12 +906,20 @@ Class | Method | HTTP request | Description
1071
906
  - [ForwardRateAgreement](docs/ForwardRateAgreement.md)
1072
907
  - [FromRecipe](docs/FromRecipe.md)
1073
908
  - [Fund](docs/Fund.md)
909
+ - [FundAmount](docs/FundAmount.md)
910
+ - [FundConfiguration](docs/FundConfiguration.md)
911
+ - [FundConfigurationProperties](docs/FundConfigurationProperties.md)
912
+ - [FundConfigurationRequest](docs/FundConfigurationRequest.md)
913
+ - [FundPnlBreakdown](docs/FundPnlBreakdown.md)
914
+ - [FundPreviousNAV](docs/FundPreviousNAV.md)
1074
915
  - [FundProperties](docs/FundProperties.md)
1075
916
  - [FundRequest](docs/FundRequest.md)
1076
917
  - [FundShareClass](docs/FundShareClass.md)
918
+ - [FundValuationPointData](docs/FundValuationPointData.md)
1077
919
  - [FundingLeg](docs/FundingLeg.md)
1078
920
  - [FundingLegOptions](docs/FundingLegOptions.md)
1079
921
  - [Future](docs/Future.md)
922
+ - [FutureExpiryEvent](docs/FutureExpiryEvent.md)
1080
923
  - [FuturesContractDetails](docs/FuturesContractDetails.md)
1081
924
  - [FxConventions](docs/FxConventions.md)
1082
925
  - [FxDependency](docs/FxDependency.md)
@@ -1151,6 +994,7 @@ Class | Method | HTTP request | Description
1151
994
  - [InstrumentDefinition](docs/InstrumentDefinition.md)
1152
995
  - [InstrumentDefinitionFormat](docs/InstrumentDefinitionFormat.md)
1153
996
  - [InstrumentDeleteModes](docs/InstrumentDeleteModes.md)
997
+ - [InstrumentEntity](docs/InstrumentEntity.md)
1154
998
  - [InstrumentEvent](docs/InstrumentEvent.md)
1155
999
  - [InstrumentEventConfiguration](docs/InstrumentEventConfiguration.md)
1156
1000
  - [InstrumentEventHolder](docs/InstrumentEventHolder.md)
@@ -1300,6 +1144,7 @@ Class | Method | HTTP request | Description
1300
1144
  - [PagedResourceListOfFee](docs/PagedResourceListOfFee.md)
1301
1145
  - [PagedResourceListOfFeeType](docs/PagedResourceListOfFeeType.md)
1302
1146
  - [PagedResourceListOfFund](docs/PagedResourceListOfFund.md)
1147
+ - [PagedResourceListOfFundConfiguration](docs/PagedResourceListOfFundConfiguration.md)
1303
1148
  - [PagedResourceListOfGeneralLedgerProfileResponse](docs/PagedResourceListOfGeneralLedgerProfileResponse.md)
1304
1149
  - [PagedResourceListOfInstrument](docs/PagedResourceListOfInstrument.md)
1305
1150
  - [PagedResourceListOfInstrumentEventHolder](docs/PagedResourceListOfInstrumentEventHolder.md)
@@ -1347,6 +1192,7 @@ Class | Method | HTTP request | Description
1347
1192
  - [Placement](docs/Placement.md)
1348
1193
  - [PlacementRequest](docs/PlacementRequest.md)
1349
1194
  - [PlacementSetRequest](docs/PlacementSetRequest.md)
1195
+ - [PlacementUpdateRequest](docs/PlacementUpdateRequest.md)
1350
1196
  - [Portfolio](docs/Portfolio.md)
1351
1197
  - [PortfolioCashFlow](docs/PortfolioCashFlow.md)
1352
1198
  - [PortfolioCashLadder](docs/PortfolioCashLadder.md)
@@ -1377,12 +1223,17 @@ Class | Method | HTTP request | Description
1377
1223
  - [PostingModuleResponse](docs/PostingModuleResponse.md)
1378
1224
  - [PostingModuleRule](docs/PostingModuleRule.md)
1379
1225
  - [PostingModuleRulesUpdatedResponse](docs/PostingModuleRulesUpdatedResponse.md)
1226
+ - [PreTradeConfiguration](docs/PreTradeConfiguration.md)
1380
1227
  - [Premium](docs/Premium.md)
1228
+ - [PreviousFundValuationPointData](docs/PreviousFundValuationPointData.md)
1229
+ - [PreviousNAV](docs/PreviousNAV.md)
1230
+ - [PreviousShareClassBreakdown](docs/PreviousShareClassBreakdown.md)
1381
1231
  - [PricingContext](docs/PricingContext.md)
1382
1232
  - [PricingModel](docs/PricingModel.md)
1383
1233
  - [PricingOptions](docs/PricingOptions.md)
1384
1234
  - [ProcessedCommand](docs/ProcessedCommand.md)
1385
1235
  - [PropertyDefinition](docs/PropertyDefinition.md)
1236
+ - [PropertyDefinitionEntity](docs/PropertyDefinitionEntity.md)
1386
1237
  - [PropertyDefinitionSearchResult](docs/PropertyDefinitionSearchResult.md)
1387
1238
  - [PropertyDefinitionType](docs/PropertyDefinitionType.md)
1388
1239
  - [PropertyDomain](docs/PropertyDomain.md)
@@ -1557,6 +1408,11 @@ Class | Method | HTTP request | Description
1557
1408
  - [SetTransactionConfigurationAlias](docs/SetTransactionConfigurationAlias.md)
1558
1409
  - [SetTransactionConfigurationSourceRequest](docs/SetTransactionConfigurationSourceRequest.md)
1559
1410
  - [SettlementSchedule](docs/SettlementSchedule.md)
1411
+ - [ShareClassAmount](docs/ShareClassAmount.md)
1412
+ - [ShareClassBreakdown](docs/ShareClassBreakdown.md)
1413
+ - [ShareClassData](docs/ShareClassData.md)
1414
+ - [ShareClassDetails](docs/ShareClassDetails.md)
1415
+ - [ShareClassPnlBreakdown](docs/ShareClassPnlBreakdown.md)
1560
1416
  - [SideConfigurationData](docs/SideConfigurationData.md)
1561
1417
  - [SideConfigurationDataRequest](docs/SideConfigurationDataRequest.md)
1562
1418
  - [SideDefinition](docs/SideDefinition.md)
@@ -1650,6 +1506,7 @@ Class | Method | HTTP request | Description
1650
1506
  - [TriggerEvent](docs/TriggerEvent.md)
1651
1507
  - [TypedResourceId](docs/TypedResourceId.md)
1652
1508
  - [UnitSchema](docs/UnitSchema.md)
1509
+ - [UnitisationData](docs/UnitisationData.md)
1653
1510
  - [UnitsRatio](docs/UnitsRatio.md)
1654
1511
  - [UnmatchedHoldingMethod](docs/UnmatchedHoldingMethod.md)
1655
1512
  - [UpdateAmortisationRuleSetDetailsRequest](docs/UpdateAmortisationRuleSetDetailsRequest.md)
@@ -1662,6 +1519,7 @@ Class | Method | HTTP request | Description
1662
1519
  - [UpdateDerivedPropertyDefinitionRequest](docs/UpdateDerivedPropertyDefinitionRequest.md)
1663
1520
  - [UpdateFeeTypeRequest](docs/UpdateFeeTypeRequest.md)
1664
1521
  - [UpdateInstrumentIdentifierRequest](docs/UpdateInstrumentIdentifierRequest.md)
1522
+ - [UpdatePlacementsResponse](docs/UpdatePlacementsResponse.md)
1665
1523
  - [UpdatePortfolioGroupRequest](docs/UpdatePortfolioGroupRequest.md)
1666
1524
  - [UpdatePortfolioRequest](docs/UpdatePortfolioRequest.md)
1667
1525
  - [UpdatePropertyDefinitionRequest](docs/UpdatePropertyDefinitionRequest.md)
@@ -1746,23 +1604,3 @@ Class | Method | HTTP request | Description
1746
1604
  - [YieldCurveData](docs/YieldCurveData.md)
1747
1605
 
1748
1606
 
1749
- <a id="documentation-for-authorization"></a>
1750
- ## Documentation For Authorization
1751
-
1752
-
1753
- Authentication schemes defined for the API:
1754
- <a id="oauth2"></a>
1755
- ### oauth2
1756
-
1757
- - **Type**: OAuth
1758
- - **Flow**: implicit
1759
- - **Authorization URL**: https://lusid.okta.com/oauth2/default/v1/authorize
1760
- - **Scopes**: N/A
1761
-
1762
-
1763
- ## Author
1764
-
1765
- info@finbourne.com
1766
-
1767
-
1768
-