lusid-sdk 2.1.913__py3-none-any.whl → 2.1.914__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.
- lusid/api/abor_api.py +66 -66
- lusid/api/abor_configuration_api.py +32 -32
- lusid/api/address_key_definition_api.py +10 -10
- lusid/api/aggregated_returns_api.py +12 -12
- lusid/api/aggregation_api.py +10 -10
- lusid/api/allocations_api.py +24 -24
- lusid/api/amortisation_rule_sets_api.py +24 -24
- lusid/api/application_metadata_api.py +6 -6
- lusid/api/blocks_api.py +18 -18
- lusid/api/calendars_api.py +34 -34
- lusid/api/chart_of_accounts_api.py +122 -122
- lusid/api/check_definitions_api.py +38 -38
- lusid/api/complex_market_data_api.py +36 -36
- lusid/api/compliance_api.py +34 -34
- lusid/api/configuration_recipe_api.py +20 -20
- lusid/api/conventions_api.py +18 -18
- lusid/api/corporate_action_sources_api.py +32 -32
- lusid/api/counterparties_api.py +12 -12
- lusid/api/custom_data_models_api.py +16 -16
- lusid/api/custom_entities_api.py +40 -40
- lusid/api/custom_entity_definitions_api.py +10 -10
- lusid/api/custom_entity_types_api.py +10 -10
- lusid/api/cut_label_definitions_api.py +8 -8
- lusid/api/data_types_api.py +34 -34
- lusid/api/derived_transaction_portfolios_api.py +6 -6
- lusid/api/entities_api.py +20 -20
- lusid/api/executions_api.py +18 -18
- lusid/api/fee_types_api.py +8 -8
- lusid/api/fund_configuration_api.py +38 -38
- lusid/api/funds_api.py +139 -130
- lusid/api/group_reconciliations_api.py +84 -84
- lusid/api/identifier_definitions_api.py +30 -30
- lusid/api/instrument_event_types_api.py +40 -40
- lusid/api/instrument_events_api.py +34 -34
- lusid/api/instruments_api.py +138 -138
- lusid/api/investment_accounts_api.py +24 -24
- lusid/api/investor_records_api.py +26 -26
- lusid/api/legacy_compliance_api.py +46 -46
- lusid/api/legal_entities_api.py +114 -114
- lusid/api/order_graph_api.py +6 -6
- lusid/api/order_instructions_api.py +18 -18
- lusid/api/order_management_api.py +28 -28
- lusid/api/orders_api.py +18 -18
- lusid/api/packages_api.py +18 -18
- lusid/api/participations_api.py +18 -18
- lusid/api/persons_api.py +114 -114
- lusid/api/placements_api.py +18 -18
- lusid/api/portfolio_groups_api.py +156 -156
- lusid/api/portfolios_api.py +128 -128
- lusid/api/property_definitions_api.py +74 -74
- lusid/api/queryable_keys_api.py +6 -6
- lusid/api/quotes_api.py +36 -36
- lusid/api/reconciliations_api.py +42 -42
- lusid/api/reference_lists_api.py +8 -8
- lusid/api/reference_portfolio_api.py +30 -30
- lusid/api/relation_definitions_api.py +14 -14
- lusid/api/relationship_definitions_api.py +32 -32
- lusid/api/scopes_api.py +12 -12
- lusid/api/scripted_translation_api.py +22 -22
- lusid/api/search_api.py +28 -28
- lusid/api/sequences_api.py +20 -20
- lusid/api/staged_modifications_api.py +20 -20
- lusid/api/staging_rule_set_api.py +18 -18
- lusid/api/structured_result_data_api.py +38 -38
- lusid/api/system_configuration_api.py +20 -20
- lusid/api/tax_rule_sets_api.py +34 -34
- lusid/api/timelines_api.py +68 -68
- lusid/api/transaction_configuration_api.py +18 -18
- lusid/api/transaction_fees_api.py +42 -42
- lusid/api/transaction_portfolios_api.py +450 -450
- lusid/api/transfer_agency_api.py +2 -2
- lusid/api/translation_api.py +4 -4
- lusid/api/workspace_api.py +24 -24
- lusid/configuration.py +1 -1
- lusid/models/access_metadata_value.py +1 -1
- lusid/models/accumulation_event.py +1 -1
- lusid/models/additional_payment.py +1 -1
- lusid/models/address_definition.py +2 -2
- lusid/models/adjust_global_commitment_event.py +2 -2
- lusid/models/adjust_holding_for_date_request.py +1 -1
- lusid/models/adjust_holding_request.py +1 -1
- lusid/models/aggregate_spec.py +1 -1
- lusid/models/aggregation_context.py +1 -1
- lusid/models/aggregation_options.py +3 -3
- lusid/models/allocation.py +1 -1
- lusid/models/amortisation_event.py +2 -2
- lusid/models/append_fx_forward_curve_by_quote_reference.py +1 -1
- lusid/models/asset_leg.py +2 -2
- lusid/models/basket.py +1 -1
- lusid/models/block.py +1 -1
- lusid/models/bond.py +5 -5
- lusid/models/bond_conversion_entry.py +3 -3
- lusid/models/bond_conversion_schedule.py +5 -5
- lusid/models/bond_coupon_event.py +1 -1
- lusid/models/bond_principal_event.py +1 -1
- lusid/models/bucketed_cash_flow_response.py +3 -3
- lusid/models/cancel_single_holding_adjustment_request.py +1 -1
- lusid/models/cap_floor.py +2 -2
- lusid/models/cash_and_security_offer_election.py +1 -1
- lusid/models/cash_dependency.py +2 -2
- lusid/models/cash_flow_event.py +1 -1
- lusid/models/cash_flow_lineage.py +2 -2
- lusid/models/cash_offer_election.py +1 -1
- lusid/models/cds_flow_conventions.py +5 -5
- lusid/models/cds_index.py +4 -4
- lusid/models/cds_protection_detail_specification.py +3 -3
- lusid/models/change_item.py +1 -1
- lusid/models/close_event.py +1 -1
- lusid/models/collateral.py +2 -2
- lusid/models/complex_bond.py +4 -4
- lusid/models/complex_market_data.py +1 -1
- lusid/models/complex_market_data_id.py +1 -1
- lusid/models/compounding.py +6 -6
- lusid/models/configuration_recipe.py +1 -1
- lusid/models/constant_volatility_surface.py +2 -2
- lusid/models/constituents_adjustment_header.py +1 -1
- lusid/models/contract_for_difference.py +6 -6
- lusid/models/conversion_event.py +9 -9
- lusid/models/corporate_action_transition_component_request.py +1 -1
- lusid/models/counterparty_agreement.py +1 -1
- lusid/models/counterparty_risk_information.py +1 -1
- lusid/models/counterparty_signatory.py +1 -1
- lusid/models/credit_default_swap.py +4 -4
- lusid/models/credit_premium_cash_flow_event.py +1 -1
- lusid/models/credit_rating.py +1 -1
- lusid/models/credit_spread_curve_data.py +3 -3
- lusid/models/credit_support_annex.py +6 -6
- lusid/models/curve_options.py +2 -2
- lusid/models/data_definition.py +3 -3
- lusid/models/data_map_key.py +1 -1
- lusid/models/data_mapping.py +1 -1
- lusid/models/dependency_source_filter.py +6 -6
- lusid/models/dialect.py +1 -1
- lusid/models/dialect_schema.py +1 -1
- lusid/models/discounting_dependency.py +2 -2
- lusid/models/dividend_option_event.py +1 -1
- lusid/models/dividend_reinvestment_event.py +1 -1
- lusid/models/early_redemption_election.py +1 -1
- lusid/models/early_redemption_event.py +2 -2
- lusid/models/economic_dependency.py +1 -1
- lusid/models/equity.py +1 -1
- lusid/models/equity_curve_by_prices_data.py +1 -1
- lusid/models/equity_curve_dependency.py +2 -2
- lusid/models/equity_model_options.py +1 -1
- lusid/models/equity_option.py +7 -7
- lusid/models/equity_swap.py +6 -6
- lusid/models/equity_vol_dependency.py +2 -2
- lusid/models/event_date_range.py +1 -1
- lusid/models/ex_dividend_configuration.py +3 -3
- lusid/models/exchange_traded_option.py +1 -1
- lusid/models/exchange_traded_option_contract_details.py +5 -5
- lusid/models/execution.py +1 -1
- lusid/models/exercise_event.py +1 -1
- lusid/models/exotic_instrument.py +1 -1
- lusid/models/expiry_event.py +1 -1
- lusid/models/fixed_leg.py +1 -1
- lusid/models/fixed_leg_all_of_overrides.py +1 -1
- lusid/models/fixed_schedule.py +3 -3
- lusid/models/flexible_deposit.py +2 -2
- lusid/models/flexible_loan.py +2 -2
- lusid/models/flexible_repo.py +10 -10
- lusid/models/flexible_repo_cash_flow_event.py +2 -2
- lusid/models/flexible_repo_collateral_event.py +2 -2
- lusid/models/flexible_repo_interest_payment_event.py +2 -2
- lusid/models/flexible_repo_partial_closure_event.py +5 -5
- lusid/models/float_schedule.py +5 -5
- lusid/models/floating_leg.py +1 -1
- lusid/models/flow_convention_name.py +1 -1
- lusid/models/flow_conventions.py +9 -9
- lusid/models/forward_rate_agreement.py +1 -1
- lusid/models/fund_calendar_entry.py +21 -1
- lusid/models/fund_share_class.py +4 -4
- lusid/models/fund_valuation_request.py +4 -4
- lusid/models/fund_valuation_schedule.py +4 -4
- lusid/models/funding_leg.py +3 -3
- lusid/models/future.py +4 -4
- lusid/models/future_expiry_event.py +1 -1
- lusid/models/future_mark_to_market_event.py +1 -1
- lusid/models/futures_contract_details.py +5 -5
- lusid/models/fx_conventions.py +1 -1
- lusid/models/fx_dependency.py +1 -1
- lusid/models/fx_forward.py +6 -6
- lusid/models/fx_forward_curve_by_quote_reference.py +3 -3
- lusid/models/fx_forward_model_options.py +1 -1
- lusid/models/fx_forward_settlement_event.py +6 -6
- lusid/models/fx_forward_tenor_curve_data.py +2 -2
- lusid/models/fx_forward_tenor_pips_curve_data.py +2 -2
- lusid/models/fx_forwards_dependency.py +3 -3
- lusid/models/fx_linked_notional_schedule.py +1 -1
- lusid/models/fx_option.py +8 -8
- lusid/models/fx_rate_schedule.py +1 -1
- lusid/models/fx_swap.py +2 -2
- lusid/models/fx_tenor_convention.py +1 -1
- lusid/models/fx_vol_dependency.py +2 -2
- lusid/models/get_reference_portfolio_constituents_response.py +1 -1
- lusid/models/group_of_market_data_key_rules.py +2 -2
- lusid/models/holding_context.py +1 -1
- lusid/models/holding_pricing_info.py +2 -2
- lusid/models/index_convention.py +4 -4
- lusid/models/index_projection_dependency.py +2 -2
- lusid/models/industry_classifier.py +1 -1
- lusid/models/inflation_index_conventions.py +4 -4
- lusid/models/inflation_leg.py +5 -5
- lusid/models/inflation_linked_bond.py +6 -6
- lusid/models/inflation_swap.py +3 -3
- lusid/models/informational_event.py +3 -3
- lusid/models/inline_valuation_request.py +6 -6
- lusid/models/inline_valuations_reconciliation_request.py +1 -1
- lusid/models/instrument_capabilities.py +1 -1
- lusid/models/instrument_definition_format.py +2 -2
- lusid/models/instrument_event.py +1 -1
- lusid/models/instrument_leg.py +1 -1
- lusid/models/interest_rate_swap.py +4 -4
- lusid/models/interest_rate_swaption.py +2 -2
- lusid/models/ir_vol_dependency.py +2 -2
- lusid/models/lapse_election.py +1 -1
- lusid/models/leg_definition.py +8 -8
- lusid/models/list_complex_market_data_with_meta_data_response.py +1 -1
- lusid/models/loan_facility.py +3 -3
- lusid/models/loan_facility_contract_rollover_event.py +2 -2
- lusid/models/loan_interest_repayment_event.py +2 -2
- lusid/models/loan_principal_repayment_event.py +3 -3
- lusid/models/lusid_instrument.py +1 -1
- lusid/models/lusid_trade_ticket.py +1 -1
- lusid/models/mark_to_market_conventions.py +1 -1
- lusid/models/market_context.py +4 -4
- lusid/models/market_context_suppliers.py +1 -1
- lusid/models/market_data_key_rule.py +7 -7
- lusid/models/market_data_options.py +1 -1
- lusid/models/market_data_specific_rule.py +6 -6
- lusid/models/market_data_type.py +1 -1
- lusid/models/market_options.py +1 -1
- lusid/models/market_quote.py +1 -1
- lusid/models/mastered_instrument.py +1 -1
- lusid/models/match_criterion.py +1 -1
- lusid/models/maturity_event.py +1 -1
- lusid/models/mbs_coupon_event.py +1 -1
- lusid/models/mbs_interest_deferral_event.py +1 -1
- lusid/models/mbs_interest_shortfall_event.py +1 -1
- lusid/models/mbs_principal_event.py +1 -1
- lusid/models/mbs_principal_write_off_event.py +1 -1
- lusid/models/model_options.py +1 -1
- lusid/models/model_selection.py +1 -1
- lusid/models/opaque_dependency.py +1 -1
- lusid/models/opaque_market_data.py +3 -3
- lusid/models/option_entry.py +1 -1
- lusid/models/option_exercise_cash_event.py +3 -3
- lusid/models/option_exercise_election.py +1 -1
- lusid/models/option_exercise_physical_event.py +3 -3
- lusid/models/optionality_schedule.py +2 -2
- lusid/models/order_flow_configuration.py +1 -1
- lusid/models/partial_closure_constituent.py +3 -3
- lusid/models/portfolio_result_data_key_rule.py +1 -1
- lusid/models/pre_trade_configuration.py +1 -1
- lusid/models/pricing_context.py +3 -3
- lusid/models/pricing_options.py +9 -9
- lusid/models/property_domain.py +1 -1
- lusid/models/property_reference_data_value.py +1 -1
- lusid/models/quote_dependency.py +1 -1
- lusid/models/quote_series_id.py +1 -1
- lusid/models/raw_vendor_event.py +1 -1
- lusid/models/recipe_value.py +1 -1
- lusid/models/reconcile_date_time_rule.py +1 -1
- lusid/models/reconcile_numeric_rule.py +1 -1
- lusid/models/reconcile_string_rule.py +1 -1
- lusid/models/reconciled_transaction.py +2 -2
- lusid/models/reconciliation_line.py +1 -1
- lusid/models/reconciliation_request.py +3 -3
- lusid/models/reconciliation_rule.py +1 -1
- lusid/models/relative_date_offset.py +2 -2
- lusid/models/repo.py +8 -8
- lusid/models/repo_cash_flow_event.py +4 -4
- lusid/models/repo_partial_closure_event.py +5 -5
- lusid/models/repurchase_offer_event.py +4 -4
- lusid/models/reset_event.py +1 -1
- lusid/models/result_data_key_rule.py +1 -1
- lusid/models/result_data_schema.py +1 -1
- lusid/models/result_key_rule.py +1 -1
- lusid/models/result_value.py +1 -1
- lusid/models/result_value0_d.py +1 -1
- lusid/models/result_value_date_time_offset.py +1 -1
- lusid/models/result_value_decimal.py +1 -1
- lusid/models/result_value_int.py +1 -1
- lusid/models/return_zero_pv_options.py +1 -1
- lusid/models/rounding_convention.py +4 -4
- lusid/models/schedule.py +1 -1
- lusid/models/scrip_dividend_event.py +1 -1
- lusid/models/security_election.py +2 -2
- lusid/models/security_offer_election.py +1 -1
- lusid/models/side_configuration_data.py +1 -1
- lusid/models/side_configuration_data_request.py +1 -1
- lusid/models/simple_cash_flow_loan.py +2 -2
- lusid/models/simple_instrument.py +2 -2
- lusid/models/simple_rounding_convention.py +2 -2
- lusid/models/step_schedule.py +3 -3
- lusid/models/stock_dividend_event.py +1 -1
- lusid/models/structured_result_data.py +1 -1
- lusid/models/swap_cash_flow_event.py +1 -1
- lusid/models/swap_principal_event.py +1 -1
- lusid/models/tender_offer_election.py +1 -1
- lusid/models/term_deposit.py +1 -1
- lusid/models/term_deposit_interest_event.py +1 -1
- lusid/models/term_deposit_principal_event.py +1 -1
- lusid/models/time_zone_conventions.py +1 -1
- lusid/models/total_return_swap.py +3 -3
- lusid/models/trading_conventions.py +3 -3
- lusid/models/transaction_reconciliation_request_v2.py +3 -3
- lusid/models/translate_entities_inlined_request.py +1 -1
- lusid/models/translate_entities_request.py +1 -1
- lusid/models/translate_instrument_definitions_request.py +1 -1
- lusid/models/translate_trade_ticket_request.py +1 -1
- lusid/models/translation_input.py +1 -1
- lusid/models/trigger_event.py +1 -1
- lusid/models/typed_resource_id.py +2 -2
- lusid/models/unmatched_holding_method.py +1 -1
- lusid/models/upsert_cds_flow_conventions_request.py +1 -1
- lusid/models/upsert_counterparty_agreement_request.py +1 -1
- lusid/models/upsert_flow_conventions_request.py +1 -1
- lusid/models/upsert_fund_bookmark_request.py +3 -3
- lusid/models/upsert_index_convention_request.py +1 -1
- lusid/models/upsert_quote_request.py +1 -1
- lusid/models/upsert_recipe_request.py +1 -1
- lusid/models/valuation_request.py +5 -5
- lusid/models/valuation_schedule.py +5 -5
- lusid/models/valuations_reconciliation_request.py +2 -2
- lusid/models/vendor_model_rule.py +3 -3
- lusid/models/virtual_document.py +1 -1
- lusid/models/weighted_instrument.py +2 -2
- lusid/models/weighted_instrument_in_line_lookup_identifiers.py +1 -1
- {lusid_sdk-2.1.913.dist-info → lusid_sdk-2.1.914.dist-info}/METADATA +3 -3
- {lusid_sdk-2.1.913.dist-info → lusid_sdk-2.1.914.dist-info}/RECORD +332 -332
- {lusid_sdk-2.1.913.dist-info → lusid_sdk-2.1.914.dist-info}/WHEEL +0 -0
@@ -233,7 +233,7 @@ class TransactionConfigurationApi:
|
|
233
233
|
def delete_transaction_type(self, source : Annotated[StrictStr, Field(..., description="The source that the type is in")], type : Annotated[StrictStr, Field(..., description="One of the type's aliases")], scope : Annotated[Optional[StrictStr], Field( description="The scope in which the transaction types exists. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
234
234
|
"""DeleteTransactionType: Delete a transaction type # noqa: E501
|
235
235
|
|
236
|
-
/// WARNING! Changing existing transaction types has a material impact on how data, new and old,
|
236
|
+
/// WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change. # noqa: E501
|
237
237
|
This method makes a synchronous HTTP request by default. To make an
|
238
238
|
asynchronous HTTP request, please pass async_req=True
|
239
239
|
|
@@ -268,7 +268,7 @@ class TransactionConfigurationApi:
|
|
268
268
|
def delete_transaction_type_with_http_info(self, source : Annotated[StrictStr, Field(..., description="The source that the type is in")], type : Annotated[StrictStr, Field(..., description="One of the type's aliases")], scope : Annotated[Optional[StrictStr], Field( description="The scope in which the transaction types exists. When not supplied the scope is 'default'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
269
269
|
"""DeleteTransactionType: Delete a transaction type # noqa: E501
|
270
270
|
|
271
|
-
/// WARNING! Changing existing transaction types has a material impact on how data, new and old,
|
271
|
+
/// WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change. # noqa: E501
|
272
272
|
This method makes a synchronous HTTP request by default. To make an
|
273
273
|
asynchronous HTTP request, please pass async_req=True
|
274
274
|
|
@@ -721,15 +721,15 @@ class TransactionConfigurationApi:
|
|
721
721
|
|
722
722
|
|
723
723
|
@overload
|
724
|
-
async def get_transaction_type(self, source : Annotated[StrictStr, Field(..., description="The source that the type is in")], type : Annotated[StrictStr, Field(..., description="One of the type's aliases")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction configuration.
|
724
|
+
async def get_transaction_type(self, source : Annotated[StrictStr, Field(..., description="The source that the type is in")], type : Annotated[StrictStr, Field(..., description="One of the type's aliases")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction configuration. Defaults to returning the latest version of the transaction configuration type if not specified")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the transaction types exists. When not supplied the scope is 'default'.")] = None, **kwargs) -> TransactionType: # noqa: E501
|
725
725
|
...
|
726
726
|
|
727
727
|
@overload
|
728
|
-
def get_transaction_type(self, source : Annotated[StrictStr, Field(..., description="The source that the type is in")], type : Annotated[StrictStr, Field(..., description="One of the type's aliases")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction configuration.
|
728
|
+
def get_transaction_type(self, source : Annotated[StrictStr, Field(..., description="The source that the type is in")], type : Annotated[StrictStr, Field(..., description="One of the type's aliases")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction configuration. Defaults to returning the latest version of the transaction configuration type if not specified")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the transaction types exists. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=True, **kwargs) -> TransactionType: # noqa: E501
|
729
729
|
...
|
730
730
|
|
731
731
|
@validate_arguments
|
732
|
-
def get_transaction_type(self, source : Annotated[StrictStr, Field(..., description="The source that the type is in")], type : Annotated[StrictStr, Field(..., description="One of the type's aliases")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction configuration.
|
732
|
+
def get_transaction_type(self, source : Annotated[StrictStr, Field(..., description="The source that the type is in")], type : Annotated[StrictStr, Field(..., description="One of the type's aliases")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction configuration. Defaults to returning the latest version of the transaction configuration type if not specified")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the transaction types exists. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[TransactionType, Awaitable[TransactionType]]: # noqa: E501
|
733
733
|
"""GetTransactionType: Get a single transaction configuration type # noqa: E501
|
734
734
|
|
735
735
|
Get a single transaction type. Returns failure if not found # noqa: E501
|
@@ -743,7 +743,7 @@ class TransactionConfigurationApi:
|
|
743
743
|
:type source: str
|
744
744
|
:param type: One of the type's aliases (required)
|
745
745
|
:type type: str
|
746
|
-
:param as_at: The asAt datetime at which to retrieve the transaction configuration.
|
746
|
+
:param as_at: The asAt datetime at which to retrieve the transaction configuration. Defaults to returning the latest version of the transaction configuration type if not specified
|
747
747
|
:type as_at: datetime
|
748
748
|
:param scope: The scope in which the transaction types exists. When not supplied the scope is 'default'.
|
749
749
|
:type scope: str
|
@@ -766,7 +766,7 @@ class TransactionConfigurationApi:
|
|
766
766
|
return self.get_transaction_type_with_http_info(source, type, as_at, scope, **kwargs) # noqa: E501
|
767
767
|
|
768
768
|
@validate_arguments
|
769
|
-
def get_transaction_type_with_http_info(self, source : Annotated[StrictStr, Field(..., description="The source that the type is in")], type : Annotated[StrictStr, Field(..., description="One of the type's aliases")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction configuration.
|
769
|
+
def get_transaction_type_with_http_info(self, source : Annotated[StrictStr, Field(..., description="The source that the type is in")], type : Annotated[StrictStr, Field(..., description="One of the type's aliases")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction configuration. Defaults to returning the latest version of the transaction configuration type if not specified")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the transaction types exists. When not supplied the scope is 'default'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
770
770
|
"""GetTransactionType: Get a single transaction configuration type # noqa: E501
|
771
771
|
|
772
772
|
Get a single transaction type. Returns failure if not found # noqa: E501
|
@@ -780,7 +780,7 @@ class TransactionConfigurationApi:
|
|
780
780
|
:type source: str
|
781
781
|
:param type: One of the type's aliases (required)
|
782
782
|
:type type: str
|
783
|
-
:param as_at: The asAt datetime at which to retrieve the transaction configuration.
|
783
|
+
:param as_at: The asAt datetime at which to retrieve the transaction configuration. Defaults to returning the latest version of the transaction configuration type if not specified
|
784
784
|
:type as_at: datetime
|
785
785
|
:param scope: The scope in which the transaction types exists. When not supplied the scope is 'default'.
|
786
786
|
:type scope: str
|
@@ -1063,25 +1063,25 @@ class TransactionConfigurationApi:
|
|
1063
1063
|
|
1064
1064
|
|
1065
1065
|
@overload
|
1066
|
-
async def list_transaction_types(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction types. Defaults
|
1066
|
+
async def list_transaction_types(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction types. Defaults to returning the latest versions if not specified.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the side exists. When not supplied the scope is 'default'.")] = None, **kwargs) -> Dict[str, List[TransactionType]]: # noqa: E501
|
1067
1067
|
...
|
1068
1068
|
|
1069
1069
|
@overload
|
1070
|
-
def list_transaction_types(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction types. Defaults
|
1070
|
+
def list_transaction_types(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction types. Defaults to returning the latest versions if not specified.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the side exists. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=True, **kwargs) -> Dict[str, List[TransactionType]]: # noqa: E501
|
1071
1071
|
...
|
1072
1072
|
|
1073
1073
|
@validate_arguments
|
1074
|
-
def list_transaction_types(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction types. Defaults
|
1074
|
+
def list_transaction_types(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction types. Defaults to returning the latest versions if not specified.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the side exists. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Dict[str, List[TransactionType]], Awaitable[Dict[str, List[TransactionType]]]]: # noqa: E501
|
1075
1075
|
"""ListTransactionTypes: List transaction types # noqa: E501
|
1076
1076
|
|
1077
|
-
Get the list of current transaction types. For information on the default transaction types provided with
|
1077
|
+
Get the list of current transaction types. For information on the default transaction types provided with LUSID, see https://support.lusid.com/knowledgebase/article/KA-01873/. # noqa: E501
|
1078
1078
|
This method makes a synchronous HTTP request by default. To make an
|
1079
1079
|
asynchronous HTTP request, please pass async_req=True
|
1080
1080
|
|
1081
1081
|
>>> thread = api.list_transaction_types(as_at, scope, async_req=True)
|
1082
1082
|
>>> result = thread.get()
|
1083
1083
|
|
1084
|
-
:param as_at: The asAt datetime at which to retrieve the transaction types. Defaults
|
1084
|
+
:param as_at: The asAt datetime at which to retrieve the transaction types. Defaults to returning the latest versions if not specified.
|
1085
1085
|
:type as_at: datetime
|
1086
1086
|
:param scope: The scope in which the side exists. When not supplied the scope is 'default'.
|
1087
1087
|
:type scope: str
|
@@ -1104,17 +1104,17 @@ class TransactionConfigurationApi:
|
|
1104
1104
|
return self.list_transaction_types_with_http_info(as_at, scope, **kwargs) # noqa: E501
|
1105
1105
|
|
1106
1106
|
@validate_arguments
|
1107
|
-
def list_transaction_types_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction types. Defaults
|
1107
|
+
def list_transaction_types_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction types. Defaults to returning the latest versions if not specified.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the side exists. When not supplied the scope is 'default'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1108
1108
|
"""ListTransactionTypes: List transaction types # noqa: E501
|
1109
1109
|
|
1110
|
-
Get the list of current transaction types. For information on the default transaction types provided with
|
1110
|
+
Get the list of current transaction types. For information on the default transaction types provided with LUSID, see https://support.lusid.com/knowledgebase/article/KA-01873/. # noqa: E501
|
1111
1111
|
This method makes a synchronous HTTP request by default. To make an
|
1112
1112
|
asynchronous HTTP request, please pass async_req=True
|
1113
1113
|
|
1114
1114
|
>>> thread = api.list_transaction_types_with_http_info(as_at, scope, async_req=True)
|
1115
1115
|
>>> result = thread.get()
|
1116
1116
|
|
1117
|
-
:param as_at: The asAt datetime at which to retrieve the transaction types. Defaults
|
1117
|
+
:param as_at: The asAt datetime at which to retrieve the transaction types. Defaults to returning the latest versions if not specified.
|
1118
1118
|
:type as_at: datetime
|
1119
1119
|
:param scope: The scope in which the side exists. When not supplied the scope is 'default'.
|
1120
1120
|
:type scope: str
|
@@ -1579,7 +1579,7 @@ class TransactionConfigurationApi:
|
|
1579
1579
|
def set_transaction_type(self, source : Annotated[StrictStr, Field(..., description="The source to set the transaction configuration for")], type : Annotated[StrictStr, Field(..., description="One of the transaction configuration alias types to uniquely identify the configuration. If this type does not exist, then a new transaction type is created using the body of the request in the given source, without including this type")], transaction_type_request : Annotated[TransactionTypeRequest, Field(..., description="The transaction configuration to set")], scope : Annotated[Optional[StrictStr], Field( description="The scope in which the transaction types exists. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[TransactionType, Awaitable[TransactionType]]: # noqa: E501
|
1580
1580
|
"""SetTransactionType: Set a specific transaction type # noqa: E501
|
1581
1581
|
|
1582
|
-
Set a transaction type for the given source and type. If the requested transaction type does not exist, it will be created
|
1582
|
+
Set a transaction type for the given source and type. If the requested transaction type does not exist, it will be created WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change. # noqa: E501
|
1583
1583
|
This method makes a synchronous HTTP request by default. To make an
|
1584
1584
|
asynchronous HTTP request, please pass async_req=True
|
1585
1585
|
|
@@ -1616,7 +1616,7 @@ class TransactionConfigurationApi:
|
|
1616
1616
|
def set_transaction_type_with_http_info(self, source : Annotated[StrictStr, Field(..., description="The source to set the transaction configuration for")], type : Annotated[StrictStr, Field(..., description="One of the transaction configuration alias types to uniquely identify the configuration. If this type does not exist, then a new transaction type is created using the body of the request in the given source, without including this type")], transaction_type_request : Annotated[TransactionTypeRequest, Field(..., description="The transaction configuration to set")], scope : Annotated[Optional[StrictStr], Field( description="The scope in which the transaction types exists. When not supplied the scope is 'default'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1617
1617
|
"""SetTransactionType: Set a specific transaction type # noqa: E501
|
1618
1618
|
|
1619
|
-
Set a transaction type for the given source and type. If the requested transaction type does not exist, it will be created
|
1619
|
+
Set a transaction type for the given source and type. If the requested transaction type does not exist, it will be created WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change. # noqa: E501
|
1620
1620
|
This method makes a synchronous HTTP request by default. To make an
|
1621
1621
|
asynchronous HTTP request, please pass async_req=True
|
1622
1622
|
|
@@ -70,7 +70,7 @@ class TransactionFeesApi:
|
|
70
70
|
def delete_transaction_fee_rule(self, code : Annotated[StrictStr, Field(..., description="The fee rule code.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
71
71
|
"""DeleteTransactionFeeRule: Deletes a fee rule. # noqa: E501
|
72
72
|
|
73
|
-
Deletes the rule for all effective time.
|
73
|
+
Deletes the rule for all effective time. The rule will remain viewable at previous as at times, but it will no longer be considered by GetApplicableFees. This cannot be undone. # noqa: E501
|
74
74
|
This method makes a synchronous HTTP request by default. To make an
|
75
75
|
asynchronous HTTP request, please pass async_req=True
|
76
76
|
|
@@ -101,7 +101,7 @@ class TransactionFeesApi:
|
|
101
101
|
def delete_transaction_fee_rule_with_http_info(self, code : Annotated[StrictStr, Field(..., description="The fee rule code.")], **kwargs) -> ApiResponse: # noqa: E501
|
102
102
|
"""DeleteTransactionFeeRule: Deletes a fee rule. # noqa: E501
|
103
103
|
|
104
|
-
Deletes the rule for all effective time.
|
104
|
+
Deletes the rule for all effective time. The rule will remain viewable at previous as at times, but it will no longer be considered by GetApplicableFees. This cannot be undone. # noqa: E501
|
105
105
|
This method makes a synchronous HTTP request by default. To make an
|
106
106
|
asynchronous HTTP request, please pass async_req=True
|
107
107
|
|
@@ -211,15 +211,15 @@ class TransactionFeesApi:
|
|
211
211
|
|
212
212
|
|
213
213
|
@overload
|
214
|
-
async def get_applicable_transaction_fees(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to match rule definitions. Defaults to the current LUSID
|
214
|
+
async def get_applicable_transaction_fees(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to match rule definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to match rule definitions. Defaults to returning the latest version if not specified.")] = None, instrument_identifier_type : Annotated[Optional[StrictStr], Field( description="Optional. The unique identifier type to use, eg 'Figi' or 'LusidInstrumentId'.")] = None, instrument_identifier : Annotated[Optional[StrictStr], Field( description="Optional. The Instrument Identifier to get properties for.")] = None, portfolio_scope : Annotated[Optional[StrictStr], Field( description="Optional. The scope of the portfolio to fetch properties from.")] = None, portfolio_code : Annotated[Optional[StrictStr], Field( description="Optional. The code of the portfolio to fetch properties from.")] = None, request_body : Annotated[Optional[Dict[str, StrictStr]], Field(description="Any other property keys or fields, including the top-level fields of the fee rule (e.g. \"ExecutionBroker\" and \"SettlementCurrency\" ) and those defined in AdditionalKeys, along with their corresponding values that should be matched for fees. Eg. \"Instrument/default/Name=exampleValue\" or \"AdditionalKey2=Value2\".")] = None, **kwargs) -> ResourceListOfFeeRule: # noqa: E501
|
215
215
|
...
|
216
216
|
|
217
217
|
@overload
|
218
|
-
def get_applicable_transaction_fees(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to match rule definitions. Defaults to the current LUSID
|
218
|
+
def get_applicable_transaction_fees(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to match rule definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to match rule definitions. Defaults to returning the latest version if not specified.")] = None, instrument_identifier_type : Annotated[Optional[StrictStr], Field( description="Optional. The unique identifier type to use, eg 'Figi' or 'LusidInstrumentId'.")] = None, instrument_identifier : Annotated[Optional[StrictStr], Field( description="Optional. The Instrument Identifier to get properties for.")] = None, portfolio_scope : Annotated[Optional[StrictStr], Field( description="Optional. The scope of the portfolio to fetch properties from.")] = None, portfolio_code : Annotated[Optional[StrictStr], Field( description="Optional. The code of the portfolio to fetch properties from.")] = None, request_body : Annotated[Optional[Dict[str, StrictStr]], Field(description="Any other property keys or fields, including the top-level fields of the fee rule (e.g. \"ExecutionBroker\" and \"SettlementCurrency\" ) and those defined in AdditionalKeys, along with their corresponding values that should be matched for fees. Eg. \"Instrument/default/Name=exampleValue\" or \"AdditionalKey2=Value2\".")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfFeeRule: # noqa: E501
|
219
219
|
...
|
220
220
|
|
221
221
|
@validate_arguments
|
222
|
-
def get_applicable_transaction_fees(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to match rule definitions. Defaults to the current LUSID
|
222
|
+
def get_applicable_transaction_fees(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to match rule definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to match rule definitions. Defaults to returning the latest version if not specified.")] = None, instrument_identifier_type : Annotated[Optional[StrictStr], Field( description="Optional. The unique identifier type to use, eg 'Figi' or 'LusidInstrumentId'.")] = None, instrument_identifier : Annotated[Optional[StrictStr], Field( description="Optional. The Instrument Identifier to get properties for.")] = None, portfolio_scope : Annotated[Optional[StrictStr], Field( description="Optional. The scope of the portfolio to fetch properties from.")] = None, portfolio_code : Annotated[Optional[StrictStr], Field( description="Optional. The code of the portfolio to fetch properties from.")] = None, request_body : Annotated[Optional[Dict[str, StrictStr]], Field(description="Any other property keys or fields, including the top-level fields of the fee rule (e.g. \"ExecutionBroker\" and \"SettlementCurrency\" ) and those defined in AdditionalKeys, along with their corresponding values that should be matched for fees. Eg. \"Instrument/default/Name=exampleValue\" or \"AdditionalKey2=Value2\".")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfFeeRule, Awaitable[ResourceListOfFeeRule]]: # noqa: E501
|
223
223
|
"""GetApplicableTransactionFees: Get the Fees and Commissions that may be applicable to a transaction. # noqa: E501
|
224
224
|
|
225
225
|
Additionally, matching can be based on the instrument's properties, its portfolio properties, and any additional property keys present in the data file. # noqa: E501
|
@@ -229,9 +229,9 @@ class TransactionFeesApi:
|
|
229
229
|
>>> thread = api.get_applicable_transaction_fees(effective_at, as_at, instrument_identifier_type, instrument_identifier, portfolio_scope, portfolio_code, request_body, async_req=True)
|
230
230
|
>>> result = thread.get()
|
231
231
|
|
232
|
-
:param effective_at: The effective datetime or cut label at which to match rule definitions. Defaults to the current LUSID
|
232
|
+
:param effective_at: The effective datetime or cut label at which to match rule definitions. Defaults to the current LUSID system datetime if not specified.
|
233
233
|
:type effective_at: str
|
234
|
-
:param as_at: The asAt datetime at which to match rule definitions. Defaults to returning the latest version if not
|
234
|
+
:param as_at: The asAt datetime at which to match rule definitions. Defaults to returning the latest version if not specified.
|
235
235
|
:type as_at: datetime
|
236
236
|
:param instrument_identifier_type: Optional. The unique identifier type to use, eg 'Figi' or 'LusidInstrumentId'.
|
237
237
|
:type instrument_identifier_type: str
|
@@ -241,7 +241,7 @@ class TransactionFeesApi:
|
|
241
241
|
:type portfolio_scope: str
|
242
242
|
:param portfolio_code: Optional. The code of the portfolio to fetch properties from.
|
243
243
|
:type portfolio_code: str
|
244
|
-
:param request_body: Any other property keys or fields, including the top-level fields of the
|
244
|
+
:param request_body: Any other property keys or fields, including the top-level fields of the fee rule (e.g. \"ExecutionBroker\" and \"SettlementCurrency\" ) and those defined in AdditionalKeys, along with their corresponding values that should be matched for fees. Eg. \"Instrument/default/Name=exampleValue\" or \"AdditionalKey2=Value2\".
|
245
245
|
:type request_body: Dict[str, str]
|
246
246
|
:param async_req: Whether to execute the request asynchronously.
|
247
247
|
:type async_req: bool, optional
|
@@ -262,7 +262,7 @@ class TransactionFeesApi:
|
|
262
262
|
return self.get_applicable_transaction_fees_with_http_info(effective_at, as_at, instrument_identifier_type, instrument_identifier, portfolio_scope, portfolio_code, request_body, **kwargs) # noqa: E501
|
263
263
|
|
264
264
|
@validate_arguments
|
265
|
-
def get_applicable_transaction_fees_with_http_info(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to match rule definitions. Defaults to the current LUSID
|
265
|
+
def get_applicable_transaction_fees_with_http_info(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to match rule definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to match rule definitions. Defaults to returning the latest version if not specified.")] = None, instrument_identifier_type : Annotated[Optional[StrictStr], Field( description="Optional. The unique identifier type to use, eg 'Figi' or 'LusidInstrumentId'.")] = None, instrument_identifier : Annotated[Optional[StrictStr], Field( description="Optional. The Instrument Identifier to get properties for.")] = None, portfolio_scope : Annotated[Optional[StrictStr], Field( description="Optional. The scope of the portfolio to fetch properties from.")] = None, portfolio_code : Annotated[Optional[StrictStr], Field( description="Optional. The code of the portfolio to fetch properties from.")] = None, request_body : Annotated[Optional[Dict[str, StrictStr]], Field(description="Any other property keys or fields, including the top-level fields of the fee rule (e.g. \"ExecutionBroker\" and \"SettlementCurrency\" ) and those defined in AdditionalKeys, along with their corresponding values that should be matched for fees. Eg. \"Instrument/default/Name=exampleValue\" or \"AdditionalKey2=Value2\".")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
266
266
|
"""GetApplicableTransactionFees: Get the Fees and Commissions that may be applicable to a transaction. # noqa: E501
|
267
267
|
|
268
268
|
Additionally, matching can be based on the instrument's properties, its portfolio properties, and any additional property keys present in the data file. # noqa: E501
|
@@ -272,9 +272,9 @@ class TransactionFeesApi:
|
|
272
272
|
>>> thread = api.get_applicable_transaction_fees_with_http_info(effective_at, as_at, instrument_identifier_type, instrument_identifier, portfolio_scope, portfolio_code, request_body, async_req=True)
|
273
273
|
>>> result = thread.get()
|
274
274
|
|
275
|
-
:param effective_at: The effective datetime or cut label at which to match rule definitions. Defaults to the current LUSID
|
275
|
+
:param effective_at: The effective datetime or cut label at which to match rule definitions. Defaults to the current LUSID system datetime if not specified.
|
276
276
|
:type effective_at: str
|
277
|
-
:param as_at: The asAt datetime at which to match rule definitions. Defaults to returning the latest version if not
|
277
|
+
:param as_at: The asAt datetime at which to match rule definitions. Defaults to returning the latest version if not specified.
|
278
278
|
:type as_at: datetime
|
279
279
|
:param instrument_identifier_type: Optional. The unique identifier type to use, eg 'Figi' or 'LusidInstrumentId'.
|
280
280
|
:type instrument_identifier_type: str
|
@@ -284,7 +284,7 @@ class TransactionFeesApi:
|
|
284
284
|
:type portfolio_scope: str
|
285
285
|
:param portfolio_code: Optional. The code of the portfolio to fetch properties from.
|
286
286
|
:type portfolio_code: str
|
287
|
-
:param request_body: Any other property keys or fields, including the top-level fields of the
|
287
|
+
:param request_body: Any other property keys or fields, including the top-level fields of the fee rule (e.g. \"ExecutionBroker\" and \"SettlementCurrency\" ) and those defined in AdditionalKeys, along with their corresponding values that should be matched for fees. Eg. \"Instrument/default/Name=exampleValue\" or \"AdditionalKey2=Value2\".
|
288
288
|
:type request_body: Dict[str, str]
|
289
289
|
:param async_req: Whether to execute the request asynchronously.
|
290
290
|
:type async_req: bool, optional
|
@@ -421,15 +421,15 @@ class TransactionFeesApi:
|
|
421
421
|
|
422
422
|
|
423
423
|
@overload
|
424
|
-
async def get_transaction_fee_rule(self, code : Annotated[StrictStr, Field(..., description="The fee rule code.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID
|
424
|
+
async def get_transaction_fee_rule(self, code : Annotated[StrictStr, Field(..., description="The fee rule code.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified.")] = None, **kwargs) -> FeeRule: # noqa: E501
|
425
425
|
...
|
426
426
|
|
427
427
|
@overload
|
428
|
-
def get_transaction_fee_rule(self, code : Annotated[StrictStr, Field(..., description="The fee rule code.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID
|
428
|
+
def get_transaction_fee_rule(self, code : Annotated[StrictStr, Field(..., description="The fee rule code.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> FeeRule: # noqa: E501
|
429
429
|
...
|
430
430
|
|
431
431
|
@validate_arguments
|
432
|
-
def get_transaction_fee_rule(self, code : Annotated[StrictStr, Field(..., description="The fee rule code.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID
|
432
|
+
def get_transaction_fee_rule(self, code : Annotated[StrictStr, Field(..., description="The fee rule code.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[FeeRule, Awaitable[FeeRule]]: # noqa: E501
|
433
433
|
"""GetTransactionFeeRule: Retrieve the definition of single fee rule. # noqa: E501
|
434
434
|
|
435
435
|
Retrieves the fee rule definition at the given effective and as at times. # noqa: E501
|
@@ -441,9 +441,9 @@ class TransactionFeesApi:
|
|
441
441
|
|
442
442
|
:param code: The fee rule code. (required)
|
443
443
|
:type code: str
|
444
|
-
:param effective_at: The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID
|
444
|
+
:param effective_at: The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified.
|
445
445
|
:type effective_at: str
|
446
|
-
:param as_at: The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not
|
446
|
+
:param as_at: The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified.
|
447
447
|
:type as_at: datetime
|
448
448
|
:param async_req: Whether to execute the request asynchronously.
|
449
449
|
:type async_req: bool, optional
|
@@ -464,7 +464,7 @@ class TransactionFeesApi:
|
|
464
464
|
return self.get_transaction_fee_rule_with_http_info(code, effective_at, as_at, **kwargs) # noqa: E501
|
465
465
|
|
466
466
|
@validate_arguments
|
467
|
-
def get_transaction_fee_rule_with_http_info(self, code : Annotated[StrictStr, Field(..., description="The fee rule code.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID
|
467
|
+
def get_transaction_fee_rule_with_http_info(self, code : Annotated[StrictStr, Field(..., description="The fee rule code.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
468
468
|
"""GetTransactionFeeRule: Retrieve the definition of single fee rule. # noqa: E501
|
469
469
|
|
470
470
|
Retrieves the fee rule definition at the given effective and as at times. # noqa: E501
|
@@ -476,9 +476,9 @@ class TransactionFeesApi:
|
|
476
476
|
|
477
477
|
:param code: The fee rule code. (required)
|
478
478
|
:type code: str
|
479
|
-
:param effective_at: The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID
|
479
|
+
:param effective_at: The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified.
|
480
480
|
:type effective_at: str
|
481
|
-
:param as_at: The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not
|
481
|
+
:param as_at: The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified.
|
482
482
|
:type as_at: datetime
|
483
483
|
:param async_req: Whether to execute the request asynchronously.
|
484
484
|
:type async_req: bool, optional
|
@@ -592,33 +592,33 @@ class TransactionFeesApi:
|
|
592
592
|
|
593
593
|
|
594
594
|
@overload
|
595
|
-
async def list_transaction_fee_rules(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID
|
595
|
+
async def list_transaction_fee_rules(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, **kwargs) -> ResourceListOfFeeRule: # noqa: E501
|
596
596
|
...
|
597
597
|
|
598
598
|
@overload
|
599
|
-
def list_transaction_fee_rules(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID
|
599
|
+
def list_transaction_fee_rules(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfFeeRule: # noqa: E501
|
600
600
|
...
|
601
601
|
|
602
602
|
@validate_arguments
|
603
|
-
def list_transaction_fee_rules(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID
|
603
|
+
def list_transaction_fee_rules(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfFeeRule, Awaitable[ResourceListOfFeeRule]]: # noqa: E501
|
604
604
|
"""ListTransactionFeeRules: List fee rules, with optional filtering. # noqa: E501
|
605
605
|
|
606
|
-
For more information about filtering results,
|
606
|
+
For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. # noqa: E501
|
607
607
|
This method makes a synchronous HTTP request by default. To make an
|
608
608
|
asynchronous HTTP request, please pass async_req=True
|
609
609
|
|
610
610
|
>>> thread = api.list_transaction_fee_rules(effective_at, as_at, limit, filter, page, async_req=True)
|
611
611
|
>>> result = thread.get()
|
612
612
|
|
613
|
-
:param effective_at: The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID
|
613
|
+
:param effective_at: The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified.
|
614
614
|
:type effective_at: str
|
615
|
-
:param as_at: The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not
|
615
|
+
:param as_at: The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified.
|
616
616
|
:type as_at: datetime
|
617
617
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
618
618
|
:type limit: int
|
619
619
|
:param filter: Expression to filter the results.
|
620
620
|
:type filter: str
|
621
|
-
:param page: The pagination token to use to continue listing entities; this value is returned from the previous call. If
|
621
|
+
:param page: The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
|
622
622
|
:type page: str
|
623
623
|
:param async_req: Whether to execute the request asynchronously.
|
624
624
|
:type async_req: bool, optional
|
@@ -639,25 +639,25 @@ class TransactionFeesApi:
|
|
639
639
|
return self.list_transaction_fee_rules_with_http_info(effective_at, as_at, limit, filter, page, **kwargs) # noqa: E501
|
640
640
|
|
641
641
|
@validate_arguments
|
642
|
-
def list_transaction_fee_rules_with_http_info(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID
|
642
|
+
def list_transaction_fee_rules_with_http_info(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
643
643
|
"""ListTransactionFeeRules: List fee rules, with optional filtering. # noqa: E501
|
644
644
|
|
645
|
-
For more information about filtering results,
|
645
|
+
For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. # noqa: E501
|
646
646
|
This method makes a synchronous HTTP request by default. To make an
|
647
647
|
asynchronous HTTP request, please pass async_req=True
|
648
648
|
|
649
649
|
>>> thread = api.list_transaction_fee_rules_with_http_info(effective_at, as_at, limit, filter, page, async_req=True)
|
650
650
|
>>> result = thread.get()
|
651
651
|
|
652
|
-
:param effective_at: The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID
|
652
|
+
:param effective_at: The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified.
|
653
653
|
:type effective_at: str
|
654
|
-
:param as_at: The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not
|
654
|
+
:param as_at: The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified.
|
655
655
|
:type as_at: datetime
|
656
656
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
657
657
|
:type limit: int
|
658
658
|
:param filter: Expression to filter the results.
|
659
659
|
:type filter: str
|
660
|
-
:param page: The pagination token to use to continue listing entities; this value is returned from the previous call. If
|
660
|
+
:param page: The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
|
661
661
|
:type page: str
|
662
662
|
:param async_req: Whether to execute the request asynchronously.
|
663
663
|
:type async_req: bool, optional
|
@@ -779,27 +779,27 @@ class TransactionFeesApi:
|
|
779
779
|
|
780
780
|
|
781
781
|
@overload
|
782
|
-
async def upsert_transaction_fee_rules(self, request_body : Annotated[Dict[str, FeeRuleUpsertRequest], Field(..., description="A dictionary of upsert request identifiers to rule upsert requests. The request
|
782
|
+
async def upsert_transaction_fee_rules(self, request_body : Annotated[Dict[str, FeeRuleUpsertRequest], Field(..., description="A dictionary of upsert request identifiers to rule upsert requests. The request identifiers are valid for the request only and can be used to link the upserted fee rule to the code of a created fee rule.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which the rule will take effect. Defaults to the current LUSID system datetime if not specified. In the case of an update, the changes will take place from this effective time until the next effective time that the rule as been upserted at. For example, consider a rule that already exists, and has previously had an update applied so that the definition will change on the first day of the coming month. An upsert effective from the current day will only change the definition until the first day of the coming month. An additional upsert at the same time (first day of the month) is required if the newly-updated definition is to supersede the future definition.")] = None, **kwargs) -> FeeRuleUpsertResponse: # noqa: E501
|
783
783
|
...
|
784
784
|
|
785
785
|
@overload
|
786
|
-
def upsert_transaction_fee_rules(self, request_body : Annotated[Dict[str, FeeRuleUpsertRequest], Field(..., description="A dictionary of upsert request identifiers to rule upsert requests. The request
|
786
|
+
def upsert_transaction_fee_rules(self, request_body : Annotated[Dict[str, FeeRuleUpsertRequest], Field(..., description="A dictionary of upsert request identifiers to rule upsert requests. The request identifiers are valid for the request only and can be used to link the upserted fee rule to the code of a created fee rule.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which the rule will take effect. Defaults to the current LUSID system datetime if not specified. In the case of an update, the changes will take place from this effective time until the next effective time that the rule as been upserted at. For example, consider a rule that already exists, and has previously had an update applied so that the definition will change on the first day of the coming month. An upsert effective from the current day will only change the definition until the first day of the coming month. An additional upsert at the same time (first day of the month) is required if the newly-updated definition is to supersede the future definition.")] = None, async_req: Optional[bool]=True, **kwargs) -> FeeRuleUpsertResponse: # noqa: E501
|
787
787
|
...
|
788
788
|
|
789
789
|
@validate_arguments
|
790
|
-
def upsert_transaction_fee_rules(self, request_body : Annotated[Dict[str, FeeRuleUpsertRequest], Field(..., description="A dictionary of upsert request identifiers to rule upsert requests. The request
|
790
|
+
def upsert_transaction_fee_rules(self, request_body : Annotated[Dict[str, FeeRuleUpsertRequest], Field(..., description="A dictionary of upsert request identifiers to rule upsert requests. The request identifiers are valid for the request only and can be used to link the upserted fee rule to the code of a created fee rule.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which the rule will take effect. Defaults to the current LUSID system datetime if not specified. In the case of an update, the changes will take place from this effective time until the next effective time that the rule as been upserted at. For example, consider a rule that already exists, and has previously had an update applied so that the definition will change on the first day of the coming month. An upsert effective from the current day will only change the definition until the first day of the coming month. An additional upsert at the same time (first day of the month) is required if the newly-updated definition is to supersede the future definition.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[FeeRuleUpsertResponse, Awaitable[FeeRuleUpsertResponse]]: # noqa: E501
|
791
791
|
"""UpsertTransactionFeeRules: Upsert fee rules. # noqa: E501
|
792
792
|
|
793
|
-
To upsert a new rule, the code field must be left empty, a code will then be assigned and returned as part
|
793
|
+
To upsert a new rule, the code field must be left empty, a code will then be assigned and returned as part of the response. To update an existing rule, include the fee code. It is possible to both create and update fee rules in the same request. The upsert is transactional - either all create/update operations will succeed or none of them will. # noqa: E501
|
794
794
|
This method makes a synchronous HTTP request by default. To make an
|
795
795
|
asynchronous HTTP request, please pass async_req=True
|
796
796
|
|
797
797
|
>>> thread = api.upsert_transaction_fee_rules(request_body, effective_at, async_req=True)
|
798
798
|
>>> result = thread.get()
|
799
799
|
|
800
|
-
:param request_body: A dictionary of upsert request identifiers to rule upsert requests. The request
|
800
|
+
:param request_body: A dictionary of upsert request identifiers to rule upsert requests. The request identifiers are valid for the request only and can be used to link the upserted fee rule to the code of a created fee rule. (required)
|
801
801
|
:type request_body: Dict[str, FeeRuleUpsertRequest]
|
802
|
-
:param effective_at: The effective datetime or cut label at which the rule will take effect. Defaults to the current LUSID
|
802
|
+
:param effective_at: The effective datetime or cut label at which the rule will take effect. Defaults to the current LUSID system datetime if not specified. In the case of an update, the changes will take place from this effective time until the next effective time that the rule as been upserted at. For example, consider a rule that already exists, and has previously had an update applied so that the definition will change on the first day of the coming month. An upsert effective from the current day will only change the definition until the first day of the coming month. An additional upsert at the same time (first day of the month) is required if the newly-updated definition is to supersede the future definition.
|
803
803
|
:type effective_at: str
|
804
804
|
:param async_req: Whether to execute the request asynchronously.
|
805
805
|
:type async_req: bool, optional
|
@@ -820,19 +820,19 @@ class TransactionFeesApi:
|
|
820
820
|
return self.upsert_transaction_fee_rules_with_http_info(request_body, effective_at, **kwargs) # noqa: E501
|
821
821
|
|
822
822
|
@validate_arguments
|
823
|
-
def upsert_transaction_fee_rules_with_http_info(self, request_body : Annotated[Dict[str, FeeRuleUpsertRequest], Field(..., description="A dictionary of upsert request identifiers to rule upsert requests. The request
|
823
|
+
def upsert_transaction_fee_rules_with_http_info(self, request_body : Annotated[Dict[str, FeeRuleUpsertRequest], Field(..., description="A dictionary of upsert request identifiers to rule upsert requests. The request identifiers are valid for the request only and can be used to link the upserted fee rule to the code of a created fee rule.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which the rule will take effect. Defaults to the current LUSID system datetime if not specified. In the case of an update, the changes will take place from this effective time until the next effective time that the rule as been upserted at. For example, consider a rule that already exists, and has previously had an update applied so that the definition will change on the first day of the coming month. An upsert effective from the current day will only change the definition until the first day of the coming month. An additional upsert at the same time (first day of the month) is required if the newly-updated definition is to supersede the future definition.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
824
824
|
"""UpsertTransactionFeeRules: Upsert fee rules. # noqa: E501
|
825
825
|
|
826
|
-
To upsert a new rule, the code field must be left empty, a code will then be assigned and returned as part
|
826
|
+
To upsert a new rule, the code field must be left empty, a code will then be assigned and returned as part of the response. To update an existing rule, include the fee code. It is possible to both create and update fee rules in the same request. The upsert is transactional - either all create/update operations will succeed or none of them will. # noqa: E501
|
827
827
|
This method makes a synchronous HTTP request by default. To make an
|
828
828
|
asynchronous HTTP request, please pass async_req=True
|
829
829
|
|
830
830
|
>>> thread = api.upsert_transaction_fee_rules_with_http_info(request_body, effective_at, async_req=True)
|
831
831
|
>>> result = thread.get()
|
832
832
|
|
833
|
-
:param request_body: A dictionary of upsert request identifiers to rule upsert requests. The request
|
833
|
+
:param request_body: A dictionary of upsert request identifiers to rule upsert requests. The request identifiers are valid for the request only and can be used to link the upserted fee rule to the code of a created fee rule. (required)
|
834
834
|
:type request_body: Dict[str, FeeRuleUpsertRequest]
|
835
|
-
:param effective_at: The effective datetime or cut label at which the rule will take effect. Defaults to the current LUSID
|
835
|
+
:param effective_at: The effective datetime or cut label at which the rule will take effect. Defaults to the current LUSID system datetime if not specified. In the case of an update, the changes will take place from this effective time until the next effective time that the rule as been upserted at. For example, consider a rule that already exists, and has previously had an update applied so that the definition will change on the first day of the coming month. An upsert effective from the current day will only change the definition until the first day of the coming month. An additional upsert at the same time (first day of the month) is required if the newly-updated definition is to supersede the future definition.
|
836
836
|
:type effective_at: str
|
837
837
|
:param async_req: Whether to execute the request asynchronously.
|
838
838
|
:type async_req: bool, optional
|