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
@@ -101,18 +101,18 @@ class TransactionPortfoliosApi:
|
|
101
101
|
|
102
102
|
|
103
103
|
@overload
|
104
|
-
async def adjust_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
104
|
+
async def adjust_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[StrictStr, Field(..., description="The effective datetime or cut label at which the holdings should be set to the provided targets.")], adjust_holding_request : Annotated[conlist(AdjustHoldingRequest), Field(..., description="The selected set of holdings to adjust to the provided targets for the transaction portfolio.")], reconciliation_methods : Annotated[Optional[conlist(StrictStr)], Field(description="Optional parameter for specifying a reconciliation method: e.g. FxForward.")] = None, override_movement_name : Annotated[Optional[StrictStr], Field( description="Optional parameter to override movement name for the set holdings.")] = None, override_offset_movement_name : Annotated[Optional[StrictStr], Field( description="Optional parameter will create an additional offset movement for the set holdings with this new name and transaction type: CarryAsPnl")] = None, **kwargs) -> AdjustHolding: # noqa: E501
|
105
105
|
...
|
106
106
|
|
107
107
|
@overload
|
108
|
-
def adjust_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
108
|
+
def adjust_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[StrictStr, Field(..., description="The effective datetime or cut label at which the holdings should be set to the provided targets.")], adjust_holding_request : Annotated[conlist(AdjustHoldingRequest), Field(..., description="The selected set of holdings to adjust to the provided targets for the transaction portfolio.")], reconciliation_methods : Annotated[Optional[conlist(StrictStr)], Field(description="Optional parameter for specifying a reconciliation method: e.g. FxForward.")] = None, override_movement_name : Annotated[Optional[StrictStr], Field( description="Optional parameter to override movement name for the set holdings.")] = None, override_offset_movement_name : Annotated[Optional[StrictStr], Field( description="Optional parameter will create an additional offset movement for the set holdings with this new name and transaction type: CarryAsPnl")] = None, async_req: Optional[bool]=True, **kwargs) -> AdjustHolding: # noqa: E501
|
109
109
|
...
|
110
110
|
|
111
111
|
@validate_arguments
|
112
|
-
def adjust_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
112
|
+
def adjust_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[StrictStr, Field(..., description="The effective datetime or cut label at which the holdings should be set to the provided targets.")], adjust_holding_request : Annotated[conlist(AdjustHoldingRequest), Field(..., description="The selected set of holdings to adjust to the provided targets for the transaction portfolio.")], reconciliation_methods : Annotated[Optional[conlist(StrictStr)], Field(description="Optional parameter for specifying a reconciliation method: e.g. FxForward.")] = None, override_movement_name : Annotated[Optional[StrictStr], Field( description="Optional parameter to override movement name for the set holdings.")] = None, override_offset_movement_name : Annotated[Optional[StrictStr], Field( description="Optional parameter will create an additional offset movement for the set holdings with this new name and transaction type: CarryAsPnl")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[AdjustHolding, Awaitable[AdjustHolding]]: # noqa: E501
|
113
113
|
"""AdjustHoldings: Adjust holdings # noqa: E501
|
114
114
|
|
115
|
-
Adjust one or more holdings of the specified transaction portfolio to the provided targets. LUSID will
|
115
|
+
Adjust one or more holdings of the specified transaction portfolio to the provided targets. LUSID will automatically construct adjustment transactions to ensure that the holdings which have been adjusted are always set to the provided targets for the specified effective datetime. Read more about the difference between adjusting and setting holdings here https://support.lusid.com/docs/how-do-i-manually-adjust-or-set-holdings. # noqa: E501
|
116
116
|
This method makes a synchronous HTTP request by default. To make an
|
117
117
|
asynchronous HTTP request, please pass async_req=True
|
118
118
|
|
@@ -121,11 +121,11 @@ class TransactionPortfoliosApi:
|
|
121
121
|
|
122
122
|
:param scope: The scope of the transaction portfolio. (required)
|
123
123
|
:type scope: str
|
124
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
124
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
125
125
|
:type code: str
|
126
126
|
:param effective_at: The effective datetime or cut label at which the holdings should be set to the provided targets. (required)
|
127
127
|
:type effective_at: str
|
128
|
-
:param adjust_holding_request: The selected set of holdings to adjust to the provided targets for the
|
128
|
+
:param adjust_holding_request: The selected set of holdings to adjust to the provided targets for the transaction portfolio. (required)
|
129
129
|
:type adjust_holding_request: List[AdjustHoldingRequest]
|
130
130
|
:param reconciliation_methods: Optional parameter for specifying a reconciliation method: e.g. FxForward.
|
131
131
|
:type reconciliation_methods: List[str]
|
@@ -152,10 +152,10 @@ class TransactionPortfoliosApi:
|
|
152
152
|
return self.adjust_holdings_with_http_info(scope, code, effective_at, adjust_holding_request, reconciliation_methods, override_movement_name, override_offset_movement_name, **kwargs) # noqa: E501
|
153
153
|
|
154
154
|
@validate_arguments
|
155
|
-
def adjust_holdings_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
155
|
+
def adjust_holdings_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[StrictStr, Field(..., description="The effective datetime or cut label at which the holdings should be set to the provided targets.")], adjust_holding_request : Annotated[conlist(AdjustHoldingRequest), Field(..., description="The selected set of holdings to adjust to the provided targets for the transaction portfolio.")], reconciliation_methods : Annotated[Optional[conlist(StrictStr)], Field(description="Optional parameter for specifying a reconciliation method: e.g. FxForward.")] = None, override_movement_name : Annotated[Optional[StrictStr], Field( description="Optional parameter to override movement name for the set holdings.")] = None, override_offset_movement_name : Annotated[Optional[StrictStr], Field( description="Optional parameter will create an additional offset movement for the set holdings with this new name and transaction type: CarryAsPnl")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
156
156
|
"""AdjustHoldings: Adjust holdings # noqa: E501
|
157
157
|
|
158
|
-
Adjust one or more holdings of the specified transaction portfolio to the provided targets. LUSID will
|
158
|
+
Adjust one or more holdings of the specified transaction portfolio to the provided targets. LUSID will automatically construct adjustment transactions to ensure that the holdings which have been adjusted are always set to the provided targets for the specified effective datetime. Read more about the difference between adjusting and setting holdings here https://support.lusid.com/docs/how-do-i-manually-adjust-or-set-holdings. # noqa: E501
|
159
159
|
This method makes a synchronous HTTP request by default. To make an
|
160
160
|
asynchronous HTTP request, please pass async_req=True
|
161
161
|
|
@@ -164,11 +164,11 @@ class TransactionPortfoliosApi:
|
|
164
164
|
|
165
165
|
:param scope: The scope of the transaction portfolio. (required)
|
166
166
|
:type scope: str
|
167
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
167
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
168
168
|
:type code: str
|
169
169
|
:param effective_at: The effective datetime or cut label at which the holdings should be set to the provided targets. (required)
|
170
170
|
:type effective_at: str
|
171
|
-
:param adjust_holding_request: The selected set of holdings to adjust to the provided targets for the
|
171
|
+
:param adjust_holding_request: The selected set of holdings to adjust to the provided targets for the transaction portfolio. (required)
|
172
172
|
:type adjust_holding_request: List[AdjustHoldingRequest]
|
173
173
|
:param reconciliation_methods: Optional parameter for specifying a reconciliation method: e.g. FxForward.
|
174
174
|
:type reconciliation_methods: List[str]
|
@@ -309,18 +309,18 @@ class TransactionPortfoliosApi:
|
|
309
309
|
|
310
310
|
|
311
311
|
@overload
|
312
|
-
async def batch_adjust_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
312
|
+
async def batch_adjust_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], success_mode : Annotated[StrictStr, Field(..., description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial")], request_body : Annotated[Dict[str, AdjustHoldingForDateRequest], Field(..., description="The selected set of holdings to adjust to the provided targets for the transaction portfolio.")], reconciliation_methods : Annotated[Optional[conlist(StrictStr)], Field(description="Optional parameter for specifying a reconciliation method: e.g. FxForward.")] = None, **kwargs) -> BatchAdjustHoldingsResponse: # noqa: E501
|
313
313
|
...
|
314
314
|
|
315
315
|
@overload
|
316
|
-
def batch_adjust_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
316
|
+
def batch_adjust_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], success_mode : Annotated[StrictStr, Field(..., description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial")], request_body : Annotated[Dict[str, AdjustHoldingForDateRequest], Field(..., description="The selected set of holdings to adjust to the provided targets for the transaction portfolio.")], reconciliation_methods : Annotated[Optional[conlist(StrictStr)], Field(description="Optional parameter for specifying a reconciliation method: e.g. FxForward.")] = None, async_req: Optional[bool]=True, **kwargs) -> BatchAdjustHoldingsResponse: # noqa: E501
|
317
317
|
...
|
318
318
|
|
319
319
|
@validate_arguments
|
320
|
-
def batch_adjust_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
320
|
+
def batch_adjust_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], success_mode : Annotated[StrictStr, Field(..., description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial")], request_body : Annotated[Dict[str, AdjustHoldingForDateRequest], Field(..., description="The selected set of holdings to adjust to the provided targets for the transaction portfolio.")], reconciliation_methods : Annotated[Optional[conlist(StrictStr)], Field(description="Optional parameter for specifying a reconciliation method: e.g. FxForward.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[BatchAdjustHoldingsResponse, Awaitable[BatchAdjustHoldingsResponse]]: # noqa: E501
|
321
321
|
"""BatchAdjustHoldings: Batch adjust holdings # noqa: E501
|
322
322
|
|
323
|
-
Adjust one or more holdings of the specified transaction portfolio to the provided targets. LUSID will
|
323
|
+
Adjust one or more holdings of the specified transaction portfolio to the provided targets. LUSID will automatically construct adjustment transactions to ensure that the holdings which have been adjusted are always set to the provided targets for the specified effective datetime in each request. Each request must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each adjustment in the response. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code # noqa: E501
|
324
324
|
This method makes a synchronous HTTP request by default. To make an
|
325
325
|
asynchronous HTTP request, please pass async_req=True
|
326
326
|
|
@@ -329,11 +329,11 @@ class TransactionPortfoliosApi:
|
|
329
329
|
|
330
330
|
:param scope: The scope of the transaction portfolio. (required)
|
331
331
|
:type scope: str
|
332
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
332
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
333
333
|
:type code: str
|
334
334
|
:param success_mode: Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial (required)
|
335
335
|
:type success_mode: str
|
336
|
-
:param request_body: The selected set of holdings to adjust to the provided targets for the
|
336
|
+
:param request_body: The selected set of holdings to adjust to the provided targets for the transaction portfolio. (required)
|
337
337
|
:type request_body: Dict[str, AdjustHoldingForDateRequest]
|
338
338
|
:param reconciliation_methods: Optional parameter for specifying a reconciliation method: e.g. FxForward.
|
339
339
|
:type reconciliation_methods: List[str]
|
@@ -356,10 +356,10 @@ class TransactionPortfoliosApi:
|
|
356
356
|
return self.batch_adjust_holdings_with_http_info(scope, code, success_mode, request_body, reconciliation_methods, **kwargs) # noqa: E501
|
357
357
|
|
358
358
|
@validate_arguments
|
359
|
-
def batch_adjust_holdings_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
359
|
+
def batch_adjust_holdings_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], success_mode : Annotated[StrictStr, Field(..., description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial")], request_body : Annotated[Dict[str, AdjustHoldingForDateRequest], Field(..., description="The selected set of holdings to adjust to the provided targets for the transaction portfolio.")], reconciliation_methods : Annotated[Optional[conlist(StrictStr)], Field(description="Optional parameter for specifying a reconciliation method: e.g. FxForward.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
360
360
|
"""BatchAdjustHoldings: Batch adjust holdings # noqa: E501
|
361
361
|
|
362
|
-
Adjust one or more holdings of the specified transaction portfolio to the provided targets. LUSID will
|
362
|
+
Adjust one or more holdings of the specified transaction portfolio to the provided targets. LUSID will automatically construct adjustment transactions to ensure that the holdings which have been adjusted are always set to the provided targets for the specified effective datetime in each request. Each request must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each adjustment in the response. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code # noqa: E501
|
363
363
|
This method makes a synchronous HTTP request by default. To make an
|
364
364
|
asynchronous HTTP request, please pass async_req=True
|
365
365
|
|
@@ -368,11 +368,11 @@ class TransactionPortfoliosApi:
|
|
368
368
|
|
369
369
|
:param scope: The scope of the transaction portfolio. (required)
|
370
370
|
:type scope: str
|
371
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
371
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
372
372
|
:type code: str
|
373
373
|
:param success_mode: Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial (required)
|
374
374
|
:type success_mode: str
|
375
|
-
:param request_body: The selected set of holdings to adjust to the provided targets for the
|
375
|
+
:param request_body: The selected set of holdings to adjust to the provided targets for the transaction portfolio. (required)
|
376
376
|
:type request_body: Dict[str, AdjustHoldingForDateRequest]
|
377
377
|
:param reconciliation_methods: Optional parameter for specifying a reconciliation method: e.g. FxForward.
|
378
378
|
:type reconciliation_methods: List[str]
|
@@ -501,18 +501,18 @@ class TransactionPortfoliosApi:
|
|
501
501
|
|
502
502
|
|
503
503
|
@overload
|
504
|
-
async def batch_create_trade_tickets(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
504
|
+
async def batch_create_trade_tickets(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], lusid_trade_ticket : Annotated[conlist(LusidTradeTicket), Field(..., description="the trade tickets to create")], **kwargs) -> CreateTradeTicketsResponse: # noqa: E501
|
505
505
|
...
|
506
506
|
|
507
507
|
@overload
|
508
|
-
def batch_create_trade_tickets(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
508
|
+
def batch_create_trade_tickets(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], lusid_trade_ticket : Annotated[conlist(LusidTradeTicket), Field(..., description="the trade tickets to create")], async_req: Optional[bool]=True, **kwargs) -> CreateTradeTicketsResponse: # noqa: E501
|
509
509
|
...
|
510
510
|
|
511
511
|
@validate_arguments
|
512
|
-
def batch_create_trade_tickets(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
512
|
+
def batch_create_trade_tickets(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], lusid_trade_ticket : Annotated[conlist(LusidTradeTicket), Field(..., description="the trade tickets to create")], async_req: Optional[bool]=None, **kwargs) -> Union[CreateTradeTicketsResponse, Awaitable[CreateTradeTicketsResponse]]: # noqa: E501
|
513
513
|
"""BatchCreateTradeTickets: Batch Create Trade Tickets # noqa: E501
|
514
514
|
|
515
|
-
Batch create trade tickets. Each ticket is broadly equivalent to a singular call to upsert an instrument, then a counterparty and finally
|
515
|
+
Batch create trade tickets. Each ticket is broadly equivalent to a singular call to upsert an instrument, then a counterparty and finally a transaction that makes use of the two. # noqa: E501
|
516
516
|
This method makes a synchronous HTTP request by default. To make an
|
517
517
|
asynchronous HTTP request, please pass async_req=True
|
518
518
|
|
@@ -521,7 +521,7 @@ class TransactionPortfoliosApi:
|
|
521
521
|
|
522
522
|
:param scope: The scope of the transaction portfolio. (required)
|
523
523
|
:type scope: str
|
524
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
524
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
525
525
|
:type code: str
|
526
526
|
:param lusid_trade_ticket: the trade tickets to create (required)
|
527
527
|
:type lusid_trade_ticket: List[LusidTradeTicket]
|
@@ -544,10 +544,10 @@ class TransactionPortfoliosApi:
|
|
544
544
|
return self.batch_create_trade_tickets_with_http_info(scope, code, lusid_trade_ticket, **kwargs) # noqa: E501
|
545
545
|
|
546
546
|
@validate_arguments
|
547
|
-
def batch_create_trade_tickets_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
547
|
+
def batch_create_trade_tickets_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], lusid_trade_ticket : Annotated[conlist(LusidTradeTicket), Field(..., description="the trade tickets to create")], **kwargs) -> ApiResponse: # noqa: E501
|
548
548
|
"""BatchCreateTradeTickets: Batch Create Trade Tickets # noqa: E501
|
549
549
|
|
550
|
-
Batch create trade tickets. Each ticket is broadly equivalent to a singular call to upsert an instrument, then a counterparty and finally
|
550
|
+
Batch create trade tickets. Each ticket is broadly equivalent to a singular call to upsert an instrument, then a counterparty and finally a transaction that makes use of the two. # noqa: E501
|
551
551
|
This method makes a synchronous HTTP request by default. To make an
|
552
552
|
asynchronous HTTP request, please pass async_req=True
|
553
553
|
|
@@ -556,7 +556,7 @@ class TransactionPortfoliosApi:
|
|
556
556
|
|
557
557
|
:param scope: The scope of the transaction portfolio. (required)
|
558
558
|
:type scope: str
|
559
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
559
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
560
560
|
:type code: str
|
561
561
|
:param lusid_trade_ticket: the trade tickets to create (required)
|
562
562
|
:type lusid_trade_ticket: List[LusidTradeTicket]
|
@@ -676,18 +676,18 @@ class TransactionPortfoliosApi:
|
|
676
676
|
|
677
677
|
|
678
678
|
@overload
|
679
|
-
async def batch_set_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
679
|
+
async def batch_set_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], success_mode : Annotated[StrictStr, Field(..., description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial")], request_body : Annotated[Dict[str, AdjustHoldingForDateRequest], Field(..., description="The selected set of holdings to adjust to the provided targets for the transaction portfolio.")], reconciliation_methods : Annotated[Optional[conlist(StrictStr)], Field(description="Optional parameter for specifying a reconciliation method: e.g. FxForward.")] = None, **kwargs) -> BatchAdjustHoldingsResponse: # noqa: E501
|
680
680
|
...
|
681
681
|
|
682
682
|
@overload
|
683
|
-
def batch_set_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
683
|
+
def batch_set_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], success_mode : Annotated[StrictStr, Field(..., description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial")], request_body : Annotated[Dict[str, AdjustHoldingForDateRequest], Field(..., description="The selected set of holdings to adjust to the provided targets for the transaction portfolio.")], reconciliation_methods : Annotated[Optional[conlist(StrictStr)], Field(description="Optional parameter for specifying a reconciliation method: e.g. FxForward.")] = None, async_req: Optional[bool]=True, **kwargs) -> BatchAdjustHoldingsResponse: # noqa: E501
|
684
684
|
...
|
685
685
|
|
686
686
|
@validate_arguments
|
687
|
-
def batch_set_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
687
|
+
def batch_set_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], success_mode : Annotated[StrictStr, Field(..., description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial")], request_body : Annotated[Dict[str, AdjustHoldingForDateRequest], Field(..., description="The selected set of holdings to adjust to the provided targets for the transaction portfolio.")], reconciliation_methods : Annotated[Optional[conlist(StrictStr)], Field(description="Optional parameter for specifying a reconciliation method: e.g. FxForward.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[BatchAdjustHoldingsResponse, Awaitable[BatchAdjustHoldingsResponse]]: # noqa: E501
|
688
688
|
"""BatchSetHoldings: Batch set holdings # noqa: E501
|
689
689
|
|
690
|
-
Set the holdings of the specified transaction portfolio to the provided targets. LUSID will automatically
|
690
|
+
Set the holdings of the specified transaction portfolio to the provided targets. LUSID will automatically construct adjustment transactions to ensure that the entire set of holdings for the transaction portfolio are always set to the provided targets for the specified effective datetime. Read more about the difference between adjusting and setting holdings here https://support.lusid.com/docs/how-do-i-manually-adjust-or-set-holdings. Each request must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each adjustment in the response. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code # noqa: E501
|
691
691
|
This method makes a synchronous HTTP request by default. To make an
|
692
692
|
asynchronous HTTP request, please pass async_req=True
|
693
693
|
|
@@ -696,11 +696,11 @@ class TransactionPortfoliosApi:
|
|
696
696
|
|
697
697
|
:param scope: The scope of the transaction portfolio. (required)
|
698
698
|
:type scope: str
|
699
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
699
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
700
700
|
:type code: str
|
701
701
|
:param success_mode: Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial (required)
|
702
702
|
:type success_mode: str
|
703
|
-
:param request_body: The selected set of holdings to adjust to the provided targets for the
|
703
|
+
:param request_body: The selected set of holdings to adjust to the provided targets for the transaction portfolio. (required)
|
704
704
|
:type request_body: Dict[str, AdjustHoldingForDateRequest]
|
705
705
|
:param reconciliation_methods: Optional parameter for specifying a reconciliation method: e.g. FxForward.
|
706
706
|
:type reconciliation_methods: List[str]
|
@@ -723,10 +723,10 @@ class TransactionPortfoliosApi:
|
|
723
723
|
return self.batch_set_holdings_with_http_info(scope, code, success_mode, request_body, reconciliation_methods, **kwargs) # noqa: E501
|
724
724
|
|
725
725
|
@validate_arguments
|
726
|
-
def batch_set_holdings_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
726
|
+
def batch_set_holdings_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], success_mode : Annotated[StrictStr, Field(..., description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial")], request_body : Annotated[Dict[str, AdjustHoldingForDateRequest], Field(..., description="The selected set of holdings to adjust to the provided targets for the transaction portfolio.")], reconciliation_methods : Annotated[Optional[conlist(StrictStr)], Field(description="Optional parameter for specifying a reconciliation method: e.g. FxForward.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
727
727
|
"""BatchSetHoldings: Batch set holdings # noqa: E501
|
728
728
|
|
729
|
-
Set the holdings of the specified transaction portfolio to the provided targets. LUSID will automatically
|
729
|
+
Set the holdings of the specified transaction portfolio to the provided targets. LUSID will automatically construct adjustment transactions to ensure that the entire set of holdings for the transaction portfolio are always set to the provided targets for the specified effective datetime. Read more about the difference between adjusting and setting holdings here https://support.lusid.com/docs/how-do-i-manually-adjust-or-set-holdings. Each request must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each adjustment in the response. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code # noqa: E501
|
730
730
|
This method makes a synchronous HTTP request by default. To make an
|
731
731
|
asynchronous HTTP request, please pass async_req=True
|
732
732
|
|
@@ -735,11 +735,11 @@ class TransactionPortfoliosApi:
|
|
735
735
|
|
736
736
|
:param scope: The scope of the transaction portfolio. (required)
|
737
737
|
:type scope: str
|
738
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
738
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
739
739
|
:type code: str
|
740
740
|
:param success_mode: Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial (required)
|
741
741
|
:type success_mode: str
|
742
|
-
:param request_body: The selected set of holdings to adjust to the provided targets for the
|
742
|
+
:param request_body: The selected set of holdings to adjust to the provided targets for the transaction portfolio. (required)
|
743
743
|
:type request_body: Dict[str, AdjustHoldingForDateRequest]
|
744
744
|
:param reconciliation_methods: Optional parameter for specifying a reconciliation method: e.g. FxForward.
|
745
745
|
:type reconciliation_methods: List[str]
|
@@ -868,18 +868,18 @@ class TransactionPortfoliosApi:
|
|
868
868
|
|
869
869
|
|
870
870
|
@overload
|
871
|
-
async def batch_upsert_transactions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
871
|
+
async def batch_upsert_transactions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], success_mode : Annotated[StrictStr, Field(..., description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.")], request_body : Annotated[Dict[str, TransactionRequest], Field(..., description="The payload describing the transactions to be created or updated.")], preserve_properties : Annotated[Optional[StrictBool], Field(description="If set to false, the entire property set will be overwritten by the provided properties. If not specified or set to true, only the properties provided will be updated.")] = None, **kwargs) -> BatchUpsertPortfolioTransactionsResponse: # noqa: E501
|
872
872
|
...
|
873
873
|
|
874
874
|
@overload
|
875
|
-
def batch_upsert_transactions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
875
|
+
def batch_upsert_transactions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], success_mode : Annotated[StrictStr, Field(..., description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.")], request_body : Annotated[Dict[str, TransactionRequest], Field(..., description="The payload describing the transactions to be created or updated.")], preserve_properties : Annotated[Optional[StrictBool], Field(description="If set to false, the entire property set will be overwritten by the provided properties. If not specified or set to true, only the properties provided will be updated.")] = None, async_req: Optional[bool]=True, **kwargs) -> BatchUpsertPortfolioTransactionsResponse: # noqa: E501
|
876
876
|
...
|
877
877
|
|
878
878
|
@validate_arguments
|
879
|
-
def batch_upsert_transactions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
879
|
+
def batch_upsert_transactions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], success_mode : Annotated[StrictStr, Field(..., description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.")], request_body : Annotated[Dict[str, TransactionRequest], Field(..., description="The payload describing the transactions to be created or updated.")], preserve_properties : Annotated[Optional[StrictBool], Field(description="If set to false, the entire property set will be overwritten by the provided properties. If not specified or set to true, only the properties provided will be updated.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[BatchUpsertPortfolioTransactionsResponse, Awaitable[BatchUpsertPortfolioTransactionsResponse]]: # noqa: E501
|
880
880
|
"""BatchUpsertTransactions: Batch upsert transactions # noqa: E501
|
881
881
|
|
882
|
-
Create or update transactions in the transaction portfolio. A transaction will be updated
|
882
|
+
Create or update transactions in the transaction portfolio. A transaction will be updated if it already exists and created if it does not. Each request must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each transaction in the response. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code # noqa: E501
|
883
883
|
This method makes a synchronous HTTP request by default. To make an
|
884
884
|
asynchronous HTTP request, please pass async_req=True
|
885
885
|
|
@@ -888,7 +888,7 @@ class TransactionPortfoliosApi:
|
|
888
888
|
|
889
889
|
:param scope: The scope of the transaction portfolio. (required)
|
890
890
|
:type scope: str
|
891
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
891
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
892
892
|
:type code: str
|
893
893
|
:param success_mode: Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial. (required)
|
894
894
|
:type success_mode: str
|
@@ -915,10 +915,10 @@ class TransactionPortfoliosApi:
|
|
915
915
|
return self.batch_upsert_transactions_with_http_info(scope, code, success_mode, request_body, preserve_properties, **kwargs) # noqa: E501
|
916
916
|
|
917
917
|
@validate_arguments
|
918
|
-
def batch_upsert_transactions_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
918
|
+
def batch_upsert_transactions_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], success_mode : Annotated[StrictStr, Field(..., description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.")], request_body : Annotated[Dict[str, TransactionRequest], Field(..., description="The payload describing the transactions to be created or updated.")], preserve_properties : Annotated[Optional[StrictBool], Field(description="If set to false, the entire property set will be overwritten by the provided properties. If not specified or set to true, only the properties provided will be updated.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
919
919
|
"""BatchUpsertTransactions: Batch upsert transactions # noqa: E501
|
920
920
|
|
921
|
-
Create or update transactions in the transaction portfolio. A transaction will be updated
|
921
|
+
Create or update transactions in the transaction portfolio. A transaction will be updated if it already exists and created if it does not. Each request must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each transaction in the response. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code # noqa: E501
|
922
922
|
This method makes a synchronous HTTP request by default. To make an
|
923
923
|
asynchronous HTTP request, please pass async_req=True
|
924
924
|
|
@@ -927,7 +927,7 @@ class TransactionPortfoliosApi:
|
|
927
927
|
|
928
928
|
:param scope: The scope of the transaction portfolio. (required)
|
929
929
|
:type scope: str
|
930
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
930
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
931
931
|
:type code: str
|
932
932
|
:param success_mode: Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial. (required)
|
933
933
|
:type success_mode: str
|
@@ -1059,18 +1059,18 @@ class TransactionPortfoliosApi:
|
|
1059
1059
|
|
1060
1060
|
|
1061
1061
|
@overload
|
1062
|
-
async def build_transactions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
1062
|
+
async def build_transactions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], transaction_query_parameters : Annotated[TransactionQueryParameters, Field(..., description="The query queryParameters which control how the output transactions are built.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Transaction/strategy/quantsignal\".")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing transactions from a previous call to BuildTransactions.")] = None, **kwargs) -> VersionedResourceListOfOutputTransaction: # noqa: E501
|
1063
1063
|
...
|
1064
1064
|
|
1065
1065
|
@overload
|
1066
|
-
def build_transactions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
1066
|
+
def build_transactions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], transaction_query_parameters : Annotated[TransactionQueryParameters, Field(..., description="The query queryParameters which control how the output transactions are built.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Transaction/strategy/quantsignal\".")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing transactions from a previous call to BuildTransactions.")] = None, async_req: Optional[bool]=True, **kwargs) -> VersionedResourceListOfOutputTransaction: # noqa: E501
|
1067
1067
|
...
|
1068
1068
|
|
1069
1069
|
@validate_arguments
|
1070
|
-
def build_transactions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
1070
|
+
def build_transactions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], transaction_query_parameters : Annotated[TransactionQueryParameters, Field(..., description="The query queryParameters which control how the output transactions are built.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Transaction/strategy/quantsignal\".")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing transactions from a previous call to BuildTransactions.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[VersionedResourceListOfOutputTransaction, Awaitable[VersionedResourceListOfOutputTransaction]]: # noqa: E501
|
1071
1071
|
"""BuildTransactions: Build transactions # noqa: E501
|
1072
1072
|
|
1073
|
-
Builds and returns all transactions that affect the holdings of a portfolio over a given interval of
|
1073
|
+
Builds and returns all transactions that affect the holdings of a portfolio over a given interval of effective time into a set of output transactions. This includes transactions automatically generated by LUSID such as holding adjustments. # noqa: E501
|
1074
1074
|
This method makes a synchronous HTTP request by default. To make an
|
1075
1075
|
asynchronous HTTP request, please pass async_req=True
|
1076
1076
|
|
@@ -1079,15 +1079,15 @@ class TransactionPortfoliosApi:
|
|
1079
1079
|
|
1080
1080
|
:param scope: The scope of the transaction portfolio. (required)
|
1081
1081
|
:type scope: str
|
1082
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
1082
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
1083
1083
|
:type code: str
|
1084
1084
|
:param transaction_query_parameters: The query queryParameters which control how the output transactions are built. (required)
|
1085
1085
|
:type transaction_query_parameters: TransactionQueryParameters
|
1086
|
-
:param as_at: The asAt datetime at which to build the transactions. Defaults to return the latest
|
1086
|
+
:param as_at: The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified.
|
1087
1087
|
:type as_at: datetime
|
1088
|
-
:param filter: Expression to filter the result set.
|
1088
|
+
:param filter: Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
1089
1089
|
:type filter: str
|
1090
|
-
:param property_keys: A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto
|
1090
|
+
:param property_keys: A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Transaction/strategy/quantsignal\".
|
1091
1091
|
:type property_keys: List[str]
|
1092
1092
|
:param limit: When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
|
1093
1093
|
:type limit: int
|
@@ -1112,10 +1112,10 @@ class TransactionPortfoliosApi:
|
|
1112
1112
|
return self.build_transactions_with_http_info(scope, code, transaction_query_parameters, as_at, filter, property_keys, limit, page, **kwargs) # noqa: E501
|
1113
1113
|
|
1114
1114
|
@validate_arguments
|
1115
|
-
def build_transactions_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
1115
|
+
def build_transactions_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], transaction_query_parameters : Annotated[TransactionQueryParameters, Field(..., description="The query queryParameters which control how the output transactions are built.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Transaction/strategy/quantsignal\".")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing transactions from a previous call to BuildTransactions.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1116
1116
|
"""BuildTransactions: Build transactions # noqa: E501
|
1117
1117
|
|
1118
|
-
Builds and returns all transactions that affect the holdings of a portfolio over a given interval of
|
1118
|
+
Builds and returns all transactions that affect the holdings of a portfolio over a given interval of effective time into a set of output transactions. This includes transactions automatically generated by LUSID such as holding adjustments. # noqa: E501
|
1119
1119
|
This method makes a synchronous HTTP request by default. To make an
|
1120
1120
|
asynchronous HTTP request, please pass async_req=True
|
1121
1121
|
|
@@ -1124,15 +1124,15 @@ class TransactionPortfoliosApi:
|
|
1124
1124
|
|
1125
1125
|
:param scope: The scope of the transaction portfolio. (required)
|
1126
1126
|
:type scope: str
|
1127
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
1127
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
1128
1128
|
:type code: str
|
1129
1129
|
:param transaction_query_parameters: The query queryParameters which control how the output transactions are built. (required)
|
1130
1130
|
:type transaction_query_parameters: TransactionQueryParameters
|
1131
|
-
:param as_at: The asAt datetime at which to build the transactions. Defaults to return the latest
|
1131
|
+
:param as_at: The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified.
|
1132
1132
|
:type as_at: datetime
|
1133
|
-
:param filter: Expression to filter the result set.
|
1133
|
+
:param filter: Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
1134
1134
|
:type filter: str
|
1135
|
-
:param property_keys: A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto
|
1135
|
+
:param property_keys: A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Transaction/strategy/quantsignal\".
|
1136
1136
|
:type property_keys: List[str]
|
1137
1137
|
:param limit: When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
|
1138
1138
|
:type limit: int
|
@@ -1278,18 +1278,18 @@ class TransactionPortfoliosApi:
|
|
1278
1278
|
|
1279
1279
|
|
1280
1280
|
@overload
|
1281
|
-
async def cancel_adjust_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
1281
|
+
async def cancel_adjust_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[StrictStr, Field(..., description="The effective datetime or cut label at which the holding adjustments should be undone.")], **kwargs) -> DeletedEntityResponse: # noqa: E501
|
1282
1282
|
...
|
1283
1283
|
|
1284
1284
|
@overload
|
1285
|
-
def cancel_adjust_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
1285
|
+
def cancel_adjust_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[StrictStr, Field(..., description="The effective datetime or cut label at which the holding adjustments should be undone.")], async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
|
1286
1286
|
...
|
1287
1287
|
|
1288
1288
|
@validate_arguments
|
1289
|
-
def cancel_adjust_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
1289
|
+
def cancel_adjust_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[StrictStr, Field(..., description="The effective datetime or cut label at which the holding adjustments should be undone.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
1290
1290
|
"""CancelAdjustHoldings: Cancel adjust holdings # noqa: E501
|
1291
1291
|
|
1292
|
-
Cancel all previous holding adjustments made on the specified transaction portfolio for a specified effective
|
1292
|
+
Cancel all previous holding adjustments made on the specified transaction portfolio for a specified effective datetime. This should be used to undo holding adjustments made via set holdings or adjust holdings. # noqa: E501
|
1293
1293
|
This method makes a synchronous HTTP request by default. To make an
|
1294
1294
|
asynchronous HTTP request, please pass async_req=True
|
1295
1295
|
|
@@ -1298,7 +1298,7 @@ class TransactionPortfoliosApi:
|
|
1298
1298
|
|
1299
1299
|
:param scope: The scope of the transaction portfolio. (required)
|
1300
1300
|
:type scope: str
|
1301
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
1301
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
1302
1302
|
:type code: str
|
1303
1303
|
:param effective_at: The effective datetime or cut label at which the holding adjustments should be undone. (required)
|
1304
1304
|
:type effective_at: str
|
@@ -1321,10 +1321,10 @@ class TransactionPortfoliosApi:
|
|
1321
1321
|
return self.cancel_adjust_holdings_with_http_info(scope, code, effective_at, **kwargs) # noqa: E501
|
1322
1322
|
|
1323
1323
|
@validate_arguments
|
1324
|
-
def cancel_adjust_holdings_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
1324
|
+
def cancel_adjust_holdings_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[StrictStr, Field(..., description="The effective datetime or cut label at which the holding adjustments should be undone.")], **kwargs) -> ApiResponse: # noqa: E501
|
1325
1325
|
"""CancelAdjustHoldings: Cancel adjust holdings # noqa: E501
|
1326
1326
|
|
1327
|
-
Cancel all previous holding adjustments made on the specified transaction portfolio for a specified effective
|
1327
|
+
Cancel all previous holding adjustments made on the specified transaction portfolio for a specified effective datetime. This should be used to undo holding adjustments made via set holdings or adjust holdings. # noqa: E501
|
1328
1328
|
This method makes a synchronous HTTP request by default. To make an
|
1329
1329
|
asynchronous HTTP request, please pass async_req=True
|
1330
1330
|
|
@@ -1333,7 +1333,7 @@ class TransactionPortfoliosApi:
|
|
1333
1333
|
|
1334
1334
|
:param scope: The scope of the transaction portfolio. (required)
|
1335
1335
|
:type scope: str
|
1336
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
1336
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
1337
1337
|
:type code: str
|
1338
1338
|
:param effective_at: The effective datetime or cut label at which the holding adjustments should be undone. (required)
|
1339
1339
|
:type effective_at: str
|
@@ -1446,15 +1446,15 @@ class TransactionPortfoliosApi:
|
|
1446
1446
|
|
1447
1447
|
|
1448
1448
|
@overload
|
1449
|
-
async def cancel_single_adjust_holding(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
1449
|
+
async def cancel_single_adjust_holding(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[StrictStr, Field(..., description="The effective datetime or cut label at which the previous adjustment was made.")], cancel_single_holding_adjustment_request : Annotated[CancelSingleHoldingAdjustmentRequest, Field(..., description="The selected holding adjustment to be canceled.")], **kwargs) -> DeletedEntityResponse: # noqa: E501
|
1450
1450
|
...
|
1451
1451
|
|
1452
1452
|
@overload
|
1453
|
-
def cancel_single_adjust_holding(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
1453
|
+
def cancel_single_adjust_holding(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[StrictStr, Field(..., description="The effective datetime or cut label at which the previous adjustment was made.")], cancel_single_holding_adjustment_request : Annotated[CancelSingleHoldingAdjustmentRequest, Field(..., description="The selected holding adjustment to be canceled.")], async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
|
1454
1454
|
...
|
1455
1455
|
|
1456
1456
|
@validate_arguments
|
1457
|
-
def cancel_single_adjust_holding(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
1457
|
+
def cancel_single_adjust_holding(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[StrictStr, Field(..., description="The effective datetime or cut label at which the previous adjustment was made.")], cancel_single_holding_adjustment_request : Annotated[CancelSingleHoldingAdjustmentRequest, Field(..., description="The selected holding adjustment to be canceled.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
1458
1458
|
"""CancelSingleAdjustHolding: Cancel single holding adjustment. # noqa: E501
|
1459
1459
|
|
1460
1460
|
Cancel one previously sent holding adjustment without affecting the rest of the adjustment in the previous request on the specified effective datetime. # noqa: E501
|
@@ -1466,7 +1466,7 @@ class TransactionPortfoliosApi:
|
|
1466
1466
|
|
1467
1467
|
:param scope: The scope of the transaction portfolio. (required)
|
1468
1468
|
:type scope: str
|
1469
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
1469
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
1470
1470
|
:type code: str
|
1471
1471
|
:param effective_at: The effective datetime or cut label at which the previous adjustment was made. (required)
|
1472
1472
|
:type effective_at: str
|
@@ -1491,7 +1491,7 @@ class TransactionPortfoliosApi:
|
|
1491
1491
|
return self.cancel_single_adjust_holding_with_http_info(scope, code, effective_at, cancel_single_holding_adjustment_request, **kwargs) # noqa: E501
|
1492
1492
|
|
1493
1493
|
@validate_arguments
|
1494
|
-
def cancel_single_adjust_holding_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
1494
|
+
def cancel_single_adjust_holding_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[StrictStr, Field(..., description="The effective datetime or cut label at which the previous adjustment was made.")], cancel_single_holding_adjustment_request : Annotated[CancelSingleHoldingAdjustmentRequest, Field(..., description="The selected holding adjustment to be canceled.")], **kwargs) -> ApiResponse: # noqa: E501
|
1495
1495
|
"""CancelSingleAdjustHolding: Cancel single holding adjustment. # noqa: E501
|
1496
1496
|
|
1497
1497
|
Cancel one previously sent holding adjustment without affecting the rest of the adjustment in the previous request on the specified effective datetime. # noqa: E501
|
@@ -1503,7 +1503,7 @@ class TransactionPortfoliosApi:
|
|
1503
1503
|
|
1504
1504
|
:param scope: The scope of the transaction portfolio. (required)
|
1505
1505
|
:type scope: str
|
1506
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
1506
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
1507
1507
|
:type code: str
|
1508
1508
|
:param effective_at: The effective datetime or cut label at which the previous adjustment was made. (required)
|
1509
1509
|
:type effective_at: str
|
@@ -1629,15 +1629,15 @@ class TransactionPortfoliosApi:
|
|
1629
1629
|
|
1630
1630
|
|
1631
1631
|
@overload
|
1632
|
-
async def cancel_transactions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
1632
|
+
async def cancel_transactions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], transaction_ids : Annotated[conlist(StrictStr), Field(..., description="The IDs of the transactions to cancel.")], **kwargs) -> DeletedEntityResponse: # noqa: E501
|
1633
1633
|
...
|
1634
1634
|
|
1635
1635
|
@overload
|
1636
|
-
def cancel_transactions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
1636
|
+
def cancel_transactions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], transaction_ids : Annotated[conlist(StrictStr), Field(..., description="The IDs of the transactions to cancel.")], async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
|
1637
1637
|
...
|
1638
1638
|
|
1639
1639
|
@validate_arguments
|
1640
|
-
def cancel_transactions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
1640
|
+
def cancel_transactions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], transaction_ids : Annotated[conlist(StrictStr), Field(..., description="The IDs of the transactions to cancel.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
1641
1641
|
"""CancelTransactions: Cancel transactions # noqa: E501
|
1642
1642
|
|
1643
1643
|
Cancel one or more transactions from the transaction portfolio. # noqa: E501
|
@@ -1649,7 +1649,7 @@ class TransactionPortfoliosApi:
|
|
1649
1649
|
|
1650
1650
|
:param scope: The scope of the transaction portfolio. (required)
|
1651
1651
|
:type scope: str
|
1652
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
1652
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
1653
1653
|
:type code: str
|
1654
1654
|
:param transaction_ids: The IDs of the transactions to cancel. (required)
|
1655
1655
|
:type transaction_ids: List[str]
|
@@ -1672,7 +1672,7 @@ class TransactionPortfoliosApi:
|
|
1672
1672
|
return self.cancel_transactions_with_http_info(scope, code, transaction_ids, **kwargs) # noqa: E501
|
1673
1673
|
|
1674
1674
|
@validate_arguments
|
1675
|
-
def cancel_transactions_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
1675
|
+
def cancel_transactions_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], transaction_ids : Annotated[conlist(StrictStr), Field(..., description="The IDs of the transactions to cancel.")], **kwargs) -> ApiResponse: # noqa: E501
|
1676
1676
|
"""CancelTransactions: Cancel transactions # noqa: E501
|
1677
1677
|
|
1678
1678
|
Cancel one or more transactions from the transaction portfolio. # noqa: E501
|
@@ -1684,7 +1684,7 @@ class TransactionPortfoliosApi:
|
|
1684
1684
|
|
1685
1685
|
:param scope: The scope of the transaction portfolio. (required)
|
1686
1686
|
:type scope: str
|
1687
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
1687
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
1688
1688
|
:type code: str
|
1689
1689
|
:param transaction_ids: The IDs of the transactions to cancel. (required)
|
1690
1690
|
:type transaction_ids: List[str]
|
@@ -1965,18 +1965,18 @@ class TransactionPortfoliosApi:
|
|
1965
1965
|
|
1966
1966
|
|
1967
1967
|
@overload
|
1968
|
-
async def create_trade_ticket(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
1968
|
+
async def create_trade_ticket(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], lusid_trade_ticket : Annotated[Optional[LusidTradeTicket], Field(description="the trade ticket to upsert")] = None, **kwargs) -> LusidTradeTicket: # noqa: E501
|
1969
1969
|
...
|
1970
1970
|
|
1971
1971
|
@overload
|
1972
|
-
def create_trade_ticket(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
1972
|
+
def create_trade_ticket(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], lusid_trade_ticket : Annotated[Optional[LusidTradeTicket], Field(description="the trade ticket to upsert")] = None, async_req: Optional[bool]=True, **kwargs) -> LusidTradeTicket: # noqa: E501
|
1973
1973
|
...
|
1974
1974
|
|
1975
1975
|
@validate_arguments
|
1976
|
-
def create_trade_ticket(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
1976
|
+
def create_trade_ticket(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], lusid_trade_ticket : Annotated[Optional[LusidTradeTicket], Field(description="the trade ticket to upsert")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[LusidTradeTicket, Awaitable[LusidTradeTicket]]: # noqa: E501
|
1977
1977
|
"""CreateTradeTicket: Create Trade Ticket # noqa: E501
|
1978
1978
|
|
1979
|
-
Upsert a trade ticket. Broadly equivalent to a singular call to upsert an instrument, then a counterparty and finally
|
1979
|
+
Upsert a trade ticket. Broadly equivalent to a singular call to upsert an instrument, then a counterparty and finally a transaction that makes use of the two. It can be viewed as a utility function or part of a workflow more familiar to users with OTC systems than flow and equity trading ones. # noqa: E501
|
1980
1980
|
This method makes a synchronous HTTP request by default. To make an
|
1981
1981
|
asynchronous HTTP request, please pass async_req=True
|
1982
1982
|
|
@@ -1985,7 +1985,7 @@ class TransactionPortfoliosApi:
|
|
1985
1985
|
|
1986
1986
|
:param scope: The scope of the transaction portfolio. (required)
|
1987
1987
|
:type scope: str
|
1988
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
1988
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
1989
1989
|
:type code: str
|
1990
1990
|
:param lusid_trade_ticket: the trade ticket to upsert
|
1991
1991
|
:type lusid_trade_ticket: LusidTradeTicket
|
@@ -2008,10 +2008,10 @@ class TransactionPortfoliosApi:
|
|
2008
2008
|
return self.create_trade_ticket_with_http_info(scope, code, lusid_trade_ticket, **kwargs) # noqa: E501
|
2009
2009
|
|
2010
2010
|
@validate_arguments
|
2011
|
-
def create_trade_ticket_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
2011
|
+
def create_trade_ticket_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], lusid_trade_ticket : Annotated[Optional[LusidTradeTicket], Field(description="the trade ticket to upsert")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
2012
2012
|
"""CreateTradeTicket: Create Trade Ticket # noqa: E501
|
2013
2013
|
|
2014
|
-
Upsert a trade ticket. Broadly equivalent to a singular call to upsert an instrument, then a counterparty and finally
|
2014
|
+
Upsert a trade ticket. Broadly equivalent to a singular call to upsert an instrument, then a counterparty and finally a transaction that makes use of the two. It can be viewed as a utility function or part of a workflow more familiar to users with OTC systems than flow and equity trading ones. # noqa: E501
|
2015
2015
|
This method makes a synchronous HTTP request by default. To make an
|
2016
2016
|
asynchronous HTTP request, please pass async_req=True
|
2017
2017
|
|
@@ -2020,7 +2020,7 @@ class TransactionPortfoliosApi:
|
|
2020
2020
|
|
2021
2021
|
:param scope: The scope of the transaction portfolio. (required)
|
2022
2022
|
:type scope: str
|
2023
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
2023
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
2024
2024
|
:type code: str
|
2025
2025
|
:param lusid_trade_ticket: the trade ticket to upsert
|
2026
2026
|
:type lusid_trade_ticket: LusidTradeTicket
|
@@ -2140,18 +2140,18 @@ class TransactionPortfoliosApi:
|
|
2140
2140
|
|
2141
2141
|
|
2142
2142
|
@overload
|
2143
|
-
async def delete_custodian_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolios.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolios. Together with the scope this uniquely identifies
|
2143
|
+
async def delete_custodian_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolios.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolios. Together with the scope this uniquely identifies the Transaction Portfolios.")], resource_id : Annotated[conlist(ResourceId), Field(..., description="The scope and codes of the custodian accounts to delete.")], delete_mode : Annotated[Optional[StrictStr], Field( description="The delete mode to use (defaults to 'Soft').")] = None, **kwargs) -> DeleteCustodianAccountsResponse: # noqa: E501
|
2144
2144
|
...
|
2145
2145
|
|
2146
2146
|
@overload
|
2147
|
-
def delete_custodian_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolios.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolios. Together with the scope this uniquely identifies
|
2147
|
+
def delete_custodian_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolios.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolios. Together with the scope this uniquely identifies the Transaction Portfolios.")], resource_id : Annotated[conlist(ResourceId), Field(..., description="The scope and codes of the custodian accounts to delete.")], delete_mode : Annotated[Optional[StrictStr], Field( description="The delete mode to use (defaults to 'Soft').")] = None, async_req: Optional[bool]=True, **kwargs) -> DeleteCustodianAccountsResponse: # noqa: E501
|
2148
2148
|
...
|
2149
2149
|
|
2150
2150
|
@validate_arguments
|
2151
|
-
def delete_custodian_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolios.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolios. Together with the scope this uniquely identifies
|
2151
|
+
def delete_custodian_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolios.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolios. Together with the scope this uniquely identifies the Transaction Portfolios.")], resource_id : Annotated[conlist(ResourceId), Field(..., description="The scope and codes of the custodian accounts to delete.")], delete_mode : Annotated[Optional[StrictStr], Field( description="The delete mode to use (defaults to 'Soft').")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[DeleteCustodianAccountsResponse, Awaitable[DeleteCustodianAccountsResponse]]: # noqa: E501
|
2152
2152
|
"""DeleteCustodianAccounts: Soft or hard delete multiple custodian accounts # noqa: E501
|
2153
2153
|
|
2154
|
-
Delete one or more custodian accounts from the Transaction Portfolios. Soft deletion marks the custodian account as inactive
|
2154
|
+
Delete one or more custodian accounts from the Transaction Portfolios. Soft deletion marks the custodian account as inactive While the Hard deletion is deleting the custodian account. The batch limit per request is 2,000. # noqa: E501
|
2155
2155
|
This method makes a synchronous HTTP request by default. To make an
|
2156
2156
|
asynchronous HTTP request, please pass async_req=True
|
2157
2157
|
|
@@ -2160,7 +2160,7 @@ class TransactionPortfoliosApi:
|
|
2160
2160
|
|
2161
2161
|
:param scope: The scope of the Transaction Portfolios. (required)
|
2162
2162
|
:type scope: str
|
2163
|
-
:param code: The code of the Transaction Portfolios. Together with the scope this uniquely identifies
|
2163
|
+
:param code: The code of the Transaction Portfolios. Together with the scope this uniquely identifies the Transaction Portfolios. (required)
|
2164
2164
|
:type code: str
|
2165
2165
|
:param resource_id: The scope and codes of the custodian accounts to delete. (required)
|
2166
2166
|
:type resource_id: List[ResourceId]
|
@@ -2185,10 +2185,10 @@ class TransactionPortfoliosApi:
|
|
2185
2185
|
return self.delete_custodian_accounts_with_http_info(scope, code, resource_id, delete_mode, **kwargs) # noqa: E501
|
2186
2186
|
|
2187
2187
|
@validate_arguments
|
2188
|
-
def delete_custodian_accounts_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolios.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolios. Together with the scope this uniquely identifies
|
2188
|
+
def delete_custodian_accounts_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolios.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolios. Together with the scope this uniquely identifies the Transaction Portfolios.")], resource_id : Annotated[conlist(ResourceId), Field(..., description="The scope and codes of the custodian accounts to delete.")], delete_mode : Annotated[Optional[StrictStr], Field( description="The delete mode to use (defaults to 'Soft').")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
2189
2189
|
"""DeleteCustodianAccounts: Soft or hard delete multiple custodian accounts # noqa: E501
|
2190
2190
|
|
2191
|
-
Delete one or more custodian accounts from the Transaction Portfolios. Soft deletion marks the custodian account as inactive
|
2191
|
+
Delete one or more custodian accounts from the Transaction Portfolios. Soft deletion marks the custodian account as inactive While the Hard deletion is deleting the custodian account. The batch limit per request is 2,000. # noqa: E501
|
2192
2192
|
This method makes a synchronous HTTP request by default. To make an
|
2193
2193
|
asynchronous HTTP request, please pass async_req=True
|
2194
2194
|
|
@@ -2197,7 +2197,7 @@ class TransactionPortfoliosApi:
|
|
2197
2197
|
|
2198
2198
|
:param scope: The scope of the Transaction Portfolios. (required)
|
2199
2199
|
:type scope: str
|
2200
|
-
:param code: The code of the Transaction Portfolios. Together with the scope this uniquely identifies
|
2200
|
+
:param code: The code of the Transaction Portfolios. Together with the scope this uniquely identifies the Transaction Portfolios. (required)
|
2201
2201
|
:type code: str
|
2202
2202
|
:param resource_id: The scope and codes of the custodian accounts to delete. (required)
|
2203
2203
|
:type resource_id: List[ResourceId]
|
@@ -2323,15 +2323,15 @@ class TransactionPortfoliosApi:
|
|
2323
2323
|
|
2324
2324
|
|
2325
2325
|
@overload
|
2326
|
-
async def delete_properties_from_transaction(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
2326
|
+
async def delete_properties_from_transaction(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], transaction_id : Annotated[StrictStr, Field(..., description="The unique ID of the transaction from which to delete properties.")], property_keys : Annotated[conlist(StrictStr), Field(..., description="The property keys of the properties to delete. These must be from the \"Transaction\" domain and have the format {domain}/{scope}/{code}, for example \"Transaction/strategy/quantsignal\".")], **kwargs) -> DeletedEntityResponse: # noqa: E501
|
2327
2327
|
...
|
2328
2328
|
|
2329
2329
|
@overload
|
2330
|
-
def delete_properties_from_transaction(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
2330
|
+
def delete_properties_from_transaction(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], transaction_id : Annotated[StrictStr, Field(..., description="The unique ID of the transaction from which to delete properties.")], property_keys : Annotated[conlist(StrictStr), Field(..., description="The property keys of the properties to delete. These must be from the \"Transaction\" domain and have the format {domain}/{scope}/{code}, for example \"Transaction/strategy/quantsignal\".")], async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
|
2331
2331
|
...
|
2332
2332
|
|
2333
2333
|
@validate_arguments
|
2334
|
-
def delete_properties_from_transaction(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
2334
|
+
def delete_properties_from_transaction(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], transaction_id : Annotated[StrictStr, Field(..., description="The unique ID of the transaction from which to delete properties.")], property_keys : Annotated[conlist(StrictStr), Field(..., description="The property keys of the properties to delete. These must be from the \"Transaction\" domain and have the format {domain}/{scope}/{code}, for example \"Transaction/strategy/quantsignal\".")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
2335
2335
|
"""DeletePropertiesFromTransaction: Delete properties from transaction # noqa: E501
|
2336
2336
|
|
2337
2337
|
Delete one or more properties from a single transaction in a transaction portfolio. # noqa: E501
|
@@ -2343,11 +2343,11 @@ class TransactionPortfoliosApi:
|
|
2343
2343
|
|
2344
2344
|
:param scope: The scope of the transaction portfolio. (required)
|
2345
2345
|
:type scope: str
|
2346
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
2346
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
2347
2347
|
:type code: str
|
2348
2348
|
:param transaction_id: The unique ID of the transaction from which to delete properties. (required)
|
2349
2349
|
:type transaction_id: str
|
2350
|
-
:param property_keys: The property keys of the properties to delete.
|
2350
|
+
:param property_keys: The property keys of the properties to delete. These must be from the \"Transaction\" domain and have the format {domain}/{scope}/{code}, for example \"Transaction/strategy/quantsignal\". (required)
|
2351
2351
|
:type property_keys: List[str]
|
2352
2352
|
:param async_req: Whether to execute the request asynchronously.
|
2353
2353
|
:type async_req: bool, optional
|
@@ -2368,7 +2368,7 @@ class TransactionPortfoliosApi:
|
|
2368
2368
|
return self.delete_properties_from_transaction_with_http_info(scope, code, transaction_id, property_keys, **kwargs) # noqa: E501
|
2369
2369
|
|
2370
2370
|
@validate_arguments
|
2371
|
-
def delete_properties_from_transaction_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
2371
|
+
def delete_properties_from_transaction_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], transaction_id : Annotated[StrictStr, Field(..., description="The unique ID of the transaction from which to delete properties.")], property_keys : Annotated[conlist(StrictStr), Field(..., description="The property keys of the properties to delete. These must be from the \"Transaction\" domain and have the format {domain}/{scope}/{code}, for example \"Transaction/strategy/quantsignal\".")], **kwargs) -> ApiResponse: # noqa: E501
|
2372
2372
|
"""DeletePropertiesFromTransaction: Delete properties from transaction # noqa: E501
|
2373
2373
|
|
2374
2374
|
Delete one or more properties from a single transaction in a transaction portfolio. # noqa: E501
|
@@ -2380,11 +2380,11 @@ class TransactionPortfoliosApi:
|
|
2380
2380
|
|
2381
2381
|
:param scope: The scope of the transaction portfolio. (required)
|
2382
2382
|
:type scope: str
|
2383
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
2383
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
2384
2384
|
:type code: str
|
2385
2385
|
:param transaction_id: The unique ID of the transaction from which to delete properties. (required)
|
2386
2386
|
:type transaction_id: str
|
2387
|
-
:param property_keys: The property keys of the properties to delete.
|
2387
|
+
:param property_keys: The property keys of the properties to delete. These must be from the \"Transaction\" domain and have the format {domain}/{scope}/{code}, for example \"Transaction/strategy/quantsignal\". (required)
|
2388
2388
|
:type property_keys: List[str]
|
2389
2389
|
:param async_req: Whether to execute the request asynchronously.
|
2390
2390
|
:type async_req: bool, optional
|
@@ -2500,15 +2500,15 @@ class TransactionPortfoliosApi:
|
|
2500
2500
|
|
2501
2501
|
|
2502
2502
|
@overload
|
2503
|
-
async def delete_settlement_instructions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies
|
2503
|
+
async def delete_settlement_instructions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], settlement_instruction_ids : Annotated[conlist(StrictStr), Field(..., description="A list of Ids of settlement instructions to be deleted.")], **kwargs) -> DeletedEntityResponse: # noqa: E501
|
2504
2504
|
...
|
2505
2505
|
|
2506
2506
|
@overload
|
2507
|
-
def delete_settlement_instructions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies
|
2507
|
+
def delete_settlement_instructions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], settlement_instruction_ids : Annotated[conlist(StrictStr), Field(..., description="A list of Ids of settlement instructions to be deleted.")], async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
|
2508
2508
|
...
|
2509
2509
|
|
2510
2510
|
@validate_arguments
|
2511
|
-
def delete_settlement_instructions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies
|
2511
|
+
def delete_settlement_instructions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], settlement_instruction_ids : Annotated[conlist(StrictStr), Field(..., description="A list of Ids of settlement instructions to be deleted.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
2512
2512
|
"""[EARLY ACCESS] DeleteSettlementInstructions: Delete Settlement Instructions. # noqa: E501
|
2513
2513
|
|
2514
2514
|
Delete the specified settlement instructions # noqa: E501
|
@@ -2520,7 +2520,7 @@ class TransactionPortfoliosApi:
|
|
2520
2520
|
|
2521
2521
|
:param scope: The scope of the portfolio. (required)
|
2522
2522
|
:type scope: str
|
2523
|
-
:param code: The code of the portfolio. Together with the scope this uniquely identifies
|
2523
|
+
:param code: The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)
|
2524
2524
|
:type code: str
|
2525
2525
|
:param settlement_instruction_ids: A list of Ids of settlement instructions to be deleted. (required)
|
2526
2526
|
:type settlement_instruction_ids: List[str]
|
@@ -2543,7 +2543,7 @@ class TransactionPortfoliosApi:
|
|
2543
2543
|
return self.delete_settlement_instructions_with_http_info(scope, code, settlement_instruction_ids, **kwargs) # noqa: E501
|
2544
2544
|
|
2545
2545
|
@validate_arguments
|
2546
|
-
def delete_settlement_instructions_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies
|
2546
|
+
def delete_settlement_instructions_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], settlement_instruction_ids : Annotated[conlist(StrictStr), Field(..., description="A list of Ids of settlement instructions to be deleted.")], **kwargs) -> ApiResponse: # noqa: E501
|
2547
2547
|
"""[EARLY ACCESS] DeleteSettlementInstructions: Delete Settlement Instructions. # noqa: E501
|
2548
2548
|
|
2549
2549
|
Delete the specified settlement instructions # noqa: E501
|
@@ -2555,7 +2555,7 @@ class TransactionPortfoliosApi:
|
|
2555
2555
|
|
2556
2556
|
:param scope: The scope of the portfolio. (required)
|
2557
2557
|
:type scope: str
|
2558
|
-
:param code: The code of the portfolio. Together with the scope this uniquely identifies
|
2558
|
+
:param code: The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)
|
2559
2559
|
:type code: str
|
2560
2560
|
:param settlement_instruction_ids: A list of Ids of settlement instructions to be deleted. (required)
|
2561
2561
|
:type settlement_instruction_ids: List[str]
|
@@ -2669,15 +2669,15 @@ class TransactionPortfoliosApi:
|
|
2669
2669
|
|
2670
2670
|
|
2671
2671
|
@overload
|
2672
|
-
async def get_a2_b_data(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio to retrieve the A2B report for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio to retrieve the A2B report for. Together with the scope this
|
2672
|
+
async def get_a2_b_data(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio to retrieve the A2B report for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio to retrieve the A2B report for. Together with the scope this uniquely identifies the portfolio.")], from_effective_at : Annotated[StrictStr, Field(..., description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.")], to_effective_at : Annotated[StrictStr, Field(..., description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeId")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\" domain to decorate onto the results. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\".")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> VersionedResourceListOfA2BDataRecord: # noqa: E501
|
2673
2673
|
...
|
2674
2674
|
|
2675
2675
|
@overload
|
2676
|
-
def get_a2_b_data(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio to retrieve the A2B report for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio to retrieve the A2B report for. Together with the scope this
|
2676
|
+
def get_a2_b_data(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio to retrieve the A2B report for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio to retrieve the A2B report for. Together with the scope this uniquely identifies the portfolio.")], from_effective_at : Annotated[StrictStr, Field(..., description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.")], to_effective_at : Annotated[StrictStr, Field(..., description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeId")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\" domain to decorate onto the results. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\".")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=True, **kwargs) -> VersionedResourceListOfA2BDataRecord: # noqa: E501
|
2677
2677
|
...
|
2678
2678
|
|
2679
2679
|
@validate_arguments
|
2680
|
-
def get_a2_b_data(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio to retrieve the A2B report for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio to retrieve the A2B report for. Together with the scope this
|
2680
|
+
def get_a2_b_data(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio to retrieve the A2B report for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio to retrieve the A2B report for. Together with the scope this uniquely identifies the portfolio.")], from_effective_at : Annotated[StrictStr, Field(..., description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.")], to_effective_at : Annotated[StrictStr, Field(..., description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeId")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\" domain to decorate onto the results. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\".")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[VersionedResourceListOfA2BDataRecord, Awaitable[VersionedResourceListOfA2BDataRecord]]: # noqa: E501
|
2681
2681
|
"""GetA2BData: Get A2B data # noqa: E501
|
2682
2682
|
|
2683
2683
|
Get an A2B report for the given portfolio. # noqa: E501
|
@@ -2689,21 +2689,21 @@ class TransactionPortfoliosApi:
|
|
2689
2689
|
|
2690
2690
|
:param scope: The scope of the portfolio to retrieve the A2B report for. (required)
|
2691
2691
|
:type scope: str
|
2692
|
-
:param code: The code of the portfolio to retrieve the A2B report for. Together with the scope this
|
2692
|
+
:param code: The code of the portfolio to retrieve the A2B report for. Together with the scope this uniquely identifies the portfolio. (required)
|
2693
2693
|
:type code: str
|
2694
|
-
:param from_effective_at: The lower bound effective datetime or cut label (inclusive) from which to retrieve the data.
|
2694
|
+
:param from_effective_at: The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified. (required)
|
2695
2695
|
:type from_effective_at: str
|
2696
|
-
:param to_effective_at: The upper bound effective datetime or cut label (inclusive) from which to retrieve the data.
|
2696
|
+
:param to_effective_at: The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified. (required)
|
2697
2697
|
:type to_effective_at: str
|
2698
|
-
:param as_at: The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version
|
2698
|
+
:param as_at: The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified.
|
2699
2699
|
:type as_at: datetime
|
2700
2700
|
:param recipe_id_scope: The scope of the given recipeId
|
2701
2701
|
:type recipe_id_scope: str
|
2702
2702
|
:param recipe_id_code: The code of the given recipeId
|
2703
2703
|
:type recipe_id_code: str
|
2704
|
-
:param property_keys: A list of property keys from the \"Instrument\" domain to decorate onto
|
2704
|
+
:param property_keys: A list of property keys from the \"Instrument\" domain to decorate onto the results. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\".
|
2705
2705
|
:type property_keys: List[str]
|
2706
|
-
:param filter: Expression to filter the result set.
|
2706
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
2707
2707
|
:type filter: str
|
2708
2708
|
:param async_req: Whether to execute the request asynchronously.
|
2709
2709
|
:type async_req: bool, optional
|
@@ -2724,7 +2724,7 @@ class TransactionPortfoliosApi:
|
|
2724
2724
|
return self.get_a2_b_data_with_http_info(scope, code, from_effective_at, to_effective_at, as_at, recipe_id_scope, recipe_id_code, property_keys, filter, **kwargs) # noqa: E501
|
2725
2725
|
|
2726
2726
|
@validate_arguments
|
2727
|
-
def get_a2_b_data_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio to retrieve the A2B report for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio to retrieve the A2B report for. Together with the scope this
|
2727
|
+
def get_a2_b_data_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio to retrieve the A2B report for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio to retrieve the A2B report for. Together with the scope this uniquely identifies the portfolio.")], from_effective_at : Annotated[StrictStr, Field(..., description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.")], to_effective_at : Annotated[StrictStr, Field(..., description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeId")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\" domain to decorate onto the results. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\".")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
2728
2728
|
"""GetA2BData: Get A2B data # noqa: E501
|
2729
2729
|
|
2730
2730
|
Get an A2B report for the given portfolio. # noqa: E501
|
@@ -2736,21 +2736,21 @@ class TransactionPortfoliosApi:
|
|
2736
2736
|
|
2737
2737
|
:param scope: The scope of the portfolio to retrieve the A2B report for. (required)
|
2738
2738
|
:type scope: str
|
2739
|
-
:param code: The code of the portfolio to retrieve the A2B report for. Together with the scope this
|
2739
|
+
:param code: The code of the portfolio to retrieve the A2B report for. Together with the scope this uniquely identifies the portfolio. (required)
|
2740
2740
|
:type code: str
|
2741
|
-
:param from_effective_at: The lower bound effective datetime or cut label (inclusive) from which to retrieve the data.
|
2741
|
+
:param from_effective_at: The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified. (required)
|
2742
2742
|
:type from_effective_at: str
|
2743
|
-
:param to_effective_at: The upper bound effective datetime or cut label (inclusive) from which to retrieve the data.
|
2743
|
+
:param to_effective_at: The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified. (required)
|
2744
2744
|
:type to_effective_at: str
|
2745
|
-
:param as_at: The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version
|
2745
|
+
:param as_at: The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified.
|
2746
2746
|
:type as_at: datetime
|
2747
2747
|
:param recipe_id_scope: The scope of the given recipeId
|
2748
2748
|
:type recipe_id_scope: str
|
2749
2749
|
:param recipe_id_code: The code of the given recipeId
|
2750
2750
|
:type recipe_id_code: str
|
2751
|
-
:param property_keys: A list of property keys from the \"Instrument\" domain to decorate onto
|
2751
|
+
:param property_keys: A list of property keys from the \"Instrument\" domain to decorate onto the results. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\".
|
2752
2752
|
:type property_keys: List[str]
|
2753
|
-
:param filter: Expression to filter the result set.
|
2753
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
2754
2754
|
:type filter: str
|
2755
2755
|
:param async_req: Whether to execute the request asynchronously.
|
2756
2756
|
:type async_req: bool, optional
|
@@ -2889,15 +2889,15 @@ class TransactionPortfoliosApi:
|
|
2889
2889
|
|
2890
2890
|
|
2891
2891
|
@overload
|
2892
|
-
async def get_a2_b_movements(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio to retrieve the A2B movement report for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio to retrieve the A2B movement report for. Together with the scope this
|
2892
|
+
async def get_a2_b_movements(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio to retrieve the A2B movement report for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio to retrieve the A2B movement report for. Together with the scope this uniquely identifies the portfolio.")], from_effective_at : Annotated[StrictStr, Field(..., description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.")], to_effective_at : Annotated[StrictStr, Field(..., description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeId")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\" domain to decorate onto the results. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\".")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> VersionedResourceListOfA2BMovementRecord: # noqa: E501
|
2893
2893
|
...
|
2894
2894
|
|
2895
2895
|
@overload
|
2896
|
-
def get_a2_b_movements(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio to retrieve the A2B movement report for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio to retrieve the A2B movement report for. Together with the scope this
|
2896
|
+
def get_a2_b_movements(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio to retrieve the A2B movement report for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio to retrieve the A2B movement report for. Together with the scope this uniquely identifies the portfolio.")], from_effective_at : Annotated[StrictStr, Field(..., description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.")], to_effective_at : Annotated[StrictStr, Field(..., description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeId")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\" domain to decorate onto the results. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\".")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=True, **kwargs) -> VersionedResourceListOfA2BMovementRecord: # noqa: E501
|
2897
2897
|
...
|
2898
2898
|
|
2899
2899
|
@validate_arguments
|
2900
|
-
def get_a2_b_movements(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio to retrieve the A2B movement report for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio to retrieve the A2B movement report for. Together with the scope this
|
2900
|
+
def get_a2_b_movements(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio to retrieve the A2B movement report for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio to retrieve the A2B movement report for. Together with the scope this uniquely identifies the portfolio.")], from_effective_at : Annotated[StrictStr, Field(..., description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.")], to_effective_at : Annotated[StrictStr, Field(..., description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeId")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\" domain to decorate onto the results. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\".")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[VersionedResourceListOfA2BMovementRecord, Awaitable[VersionedResourceListOfA2BMovementRecord]]: # noqa: E501
|
2901
2901
|
"""GetA2BMovements: Get an A2B report at the movement level for the given portfolio. # noqa: E501
|
2902
2902
|
|
2903
2903
|
Get an A2B report at the movement level for the given portfolio. # noqa: E501
|
@@ -2909,21 +2909,21 @@ class TransactionPortfoliosApi:
|
|
2909
2909
|
|
2910
2910
|
:param scope: The scope of the portfolio to retrieve the A2B movement report for. (required)
|
2911
2911
|
:type scope: str
|
2912
|
-
:param code: The code of the portfolio to retrieve the A2B movement report for. Together with the scope this
|
2912
|
+
:param code: The code of the portfolio to retrieve the A2B movement report for. Together with the scope this uniquely identifies the portfolio. (required)
|
2913
2913
|
:type code: str
|
2914
|
-
:param from_effective_at: The lower bound effective datetime or cut label (inclusive) from which to retrieve the data.
|
2914
|
+
:param from_effective_at: The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified. (required)
|
2915
2915
|
:type from_effective_at: str
|
2916
|
-
:param to_effective_at: The upper bound effective datetime or cut label (inclusive) from which to retrieve the data.
|
2916
|
+
:param to_effective_at: The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified. (required)
|
2917
2917
|
:type to_effective_at: str
|
2918
|
-
:param as_at: The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version
|
2918
|
+
:param as_at: The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified.
|
2919
2919
|
:type as_at: datetime
|
2920
2920
|
:param recipe_id_scope: The scope of the given recipeId
|
2921
2921
|
:type recipe_id_scope: str
|
2922
2922
|
:param recipe_id_code: The code of the given recipeId
|
2923
2923
|
:type recipe_id_code: str
|
2924
|
-
:param property_keys: A list of property keys from the \"Instrument\" domain to decorate onto
|
2924
|
+
:param property_keys: A list of property keys from the \"Instrument\" domain to decorate onto the results. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\".
|
2925
2925
|
:type property_keys: List[str]
|
2926
|
-
:param filter: Expression to filter the result set.
|
2926
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
2927
2927
|
:type filter: str
|
2928
2928
|
:param async_req: Whether to execute the request asynchronously.
|
2929
2929
|
:type async_req: bool, optional
|
@@ -2944,7 +2944,7 @@ class TransactionPortfoliosApi:
|
|
2944
2944
|
return self.get_a2_b_movements_with_http_info(scope, code, from_effective_at, to_effective_at, as_at, recipe_id_scope, recipe_id_code, property_keys, filter, **kwargs) # noqa: E501
|
2945
2945
|
|
2946
2946
|
@validate_arguments
|
2947
|
-
def get_a2_b_movements_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio to retrieve the A2B movement report for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio to retrieve the A2B movement report for. Together with the scope this
|
2947
|
+
def get_a2_b_movements_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio to retrieve the A2B movement report for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio to retrieve the A2B movement report for. Together with the scope this uniquely identifies the portfolio.")], from_effective_at : Annotated[StrictStr, Field(..., description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.")], to_effective_at : Annotated[StrictStr, Field(..., description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeId")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\" domain to decorate onto the results. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\".")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
2948
2948
|
"""GetA2BMovements: Get an A2B report at the movement level for the given portfolio. # noqa: E501
|
2949
2949
|
|
2950
2950
|
Get an A2B report at the movement level for the given portfolio. # noqa: E501
|
@@ -2956,21 +2956,21 @@ class TransactionPortfoliosApi:
|
|
2956
2956
|
|
2957
2957
|
:param scope: The scope of the portfolio to retrieve the A2B movement report for. (required)
|
2958
2958
|
:type scope: str
|
2959
|
-
:param code: The code of the portfolio to retrieve the A2B movement report for. Together with the scope this
|
2959
|
+
:param code: The code of the portfolio to retrieve the A2B movement report for. Together with the scope this uniquely identifies the portfolio. (required)
|
2960
2960
|
:type code: str
|
2961
|
-
:param from_effective_at: The lower bound effective datetime or cut label (inclusive) from which to retrieve the data.
|
2961
|
+
:param from_effective_at: The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified. (required)
|
2962
2962
|
:type from_effective_at: str
|
2963
|
-
:param to_effective_at: The upper bound effective datetime or cut label (inclusive) from which to retrieve the data.
|
2963
|
+
:param to_effective_at: The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified. (required)
|
2964
2964
|
:type to_effective_at: str
|
2965
|
-
:param as_at: The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version
|
2965
|
+
:param as_at: The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified.
|
2966
2966
|
:type as_at: datetime
|
2967
2967
|
:param recipe_id_scope: The scope of the given recipeId
|
2968
2968
|
:type recipe_id_scope: str
|
2969
2969
|
:param recipe_id_code: The code of the given recipeId
|
2970
2970
|
:type recipe_id_code: str
|
2971
|
-
:param property_keys: A list of property keys from the \"Instrument\" domain to decorate onto
|
2971
|
+
:param property_keys: A list of property keys from the \"Instrument\" domain to decorate onto the results. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\".
|
2972
2972
|
:type property_keys: List[str]
|
2973
|
-
:param filter: Expression to filter the result set.
|
2973
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
2974
2974
|
:type filter: str
|
2975
2975
|
:param async_req: Whether to execute the request asynchronously.
|
2976
2976
|
:type async_req: bool, optional
|
@@ -3120,7 +3120,7 @@ class TransactionPortfoliosApi:
|
|
3120
3120
|
def get_bucketed_cash_flows(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.")], bucketed_cash_flow_request : Annotated[Optional[BucketedCashFlowRequest], Field(description="Request specifying the bucketing of cashflows")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[BucketedCashFlowResponse, Awaitable[BucketedCashFlowResponse]]: # noqa: E501
|
3121
3121
|
"""GetBucketedCashFlows: Get bucketed cash flows from a list of portfolios # noqa: E501
|
3122
3122
|
|
3123
|
-
We bucket/aggregate a transaction portfolio's instruments by date or tenor specified in the request.
|
3123
|
+
We bucket/aggregate a transaction portfolio's instruments by date or tenor specified in the request. The cashflows are grouped by both instrumentId and currency. If you want transactional level cashflow, please use the 'GetUpsertableCashFlows' endpoint. If you want instrument cashflow, please use the 'GetPortfolioCashFlows' endpoint. Note that these endpoints do not apply bucketing. # noqa: E501
|
3124
3124
|
This method makes a synchronous HTTP request by default. To make an
|
3125
3125
|
asynchronous HTTP request, please pass async_req=True
|
3126
3126
|
|
@@ -3155,7 +3155,7 @@ class TransactionPortfoliosApi:
|
|
3155
3155
|
def get_bucketed_cash_flows_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.")], bucketed_cash_flow_request : Annotated[Optional[BucketedCashFlowRequest], Field(description="Request specifying the bucketing of cashflows")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
3156
3156
|
"""GetBucketedCashFlows: Get bucketed cash flows from a list of portfolios # noqa: E501
|
3157
3157
|
|
3158
|
-
We bucket/aggregate a transaction portfolio's instruments by date or tenor specified in the request.
|
3158
|
+
We bucket/aggregate a transaction portfolio's instruments by date or tenor specified in the request. The cashflows are grouped by both instrumentId and currency. If you want transactional level cashflow, please use the 'GetUpsertableCashFlows' endpoint. If you want instrument cashflow, please use the 'GetPortfolioCashFlows' endpoint. Note that these endpoints do not apply bucketing. # noqa: E501
|
3159
3159
|
This method makes a synchronous HTTP request by default. To make an
|
3160
3160
|
asynchronous HTTP request, please pass async_req=True
|
3161
3161
|
|
@@ -3284,15 +3284,15 @@ class TransactionPortfoliosApi:
|
|
3284
3284
|
|
3285
3285
|
|
3286
3286
|
@overload
|
3287
|
-
async def get_custodian_account(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolio. Together with the scope this uniquely identifies the Transaction Portfolio.")], custodian_account_scope : Annotated[StrictStr, Field(..., description="The scope of the Custodian Account.")], custodian_account_code : Annotated[StrictStr, Field(..., description="The code of the Custodian Account.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the Custodian Account properties. 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 Custodian Account definition. Defaults to returning the latest version of the Custodian Account definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'CustodianAccount' domain to decorate onto the Custodian Account.
|
3287
|
+
async def get_custodian_account(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolio. Together with the scope this uniquely identifies the Transaction Portfolio.")], custodian_account_scope : Annotated[StrictStr, Field(..., description="The scope of the Custodian Account.")], custodian_account_code : Annotated[StrictStr, Field(..., description="The code of the Custodian Account.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the Custodian Account properties. 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 Custodian Account definition. Defaults to returning the latest version of the Custodian Account definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'CustodianAccount' domain to decorate onto the Custodian Account. These must take the format {domain}/{scope}/{code}, for example 'CustodianAccount/Manager/Id'. If no properties are specified, then no properties will be returned.")] = None, **kwargs) -> CustodianAccount: # noqa: E501
|
3288
3288
|
...
|
3289
3289
|
|
3290
3290
|
@overload
|
3291
|
-
def get_custodian_account(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolio. Together with the scope this uniquely identifies the Transaction Portfolio.")], custodian_account_scope : Annotated[StrictStr, Field(..., description="The scope of the Custodian Account.")], custodian_account_code : Annotated[StrictStr, Field(..., description="The code of the Custodian Account.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the Custodian Account properties. 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 Custodian Account definition. Defaults to returning the latest version of the Custodian Account definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'CustodianAccount' domain to decorate onto the Custodian Account.
|
3291
|
+
def get_custodian_account(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolio. Together with the scope this uniquely identifies the Transaction Portfolio.")], custodian_account_scope : Annotated[StrictStr, Field(..., description="The scope of the Custodian Account.")], custodian_account_code : Annotated[StrictStr, Field(..., description="The code of the Custodian Account.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the Custodian Account properties. 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 Custodian Account definition. Defaults to returning the latest version of the Custodian Account definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'CustodianAccount' domain to decorate onto the Custodian Account. These must take the format {domain}/{scope}/{code}, for example 'CustodianAccount/Manager/Id'. If no properties are specified, then no properties will be returned.")] = None, async_req: Optional[bool]=True, **kwargs) -> CustodianAccount: # noqa: E501
|
3292
3292
|
...
|
3293
3293
|
|
3294
3294
|
@validate_arguments
|
3295
|
-
def get_custodian_account(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolio. Together with the scope this uniquely identifies the Transaction Portfolio.")], custodian_account_scope : Annotated[StrictStr, Field(..., description="The scope of the Custodian Account.")], custodian_account_code : Annotated[StrictStr, Field(..., description="The code of the Custodian Account.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the Custodian Account properties. 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 Custodian Account definition. Defaults to returning the latest version of the Custodian Account definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'CustodianAccount' domain to decorate onto the Custodian Account.
|
3295
|
+
def get_custodian_account(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolio. Together with the scope this uniquely identifies the Transaction Portfolio.")], custodian_account_scope : Annotated[StrictStr, Field(..., description="The scope of the Custodian Account.")], custodian_account_code : Annotated[StrictStr, Field(..., description="The code of the Custodian Account.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the Custodian Account properties. 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 Custodian Account definition. Defaults to returning the latest version of the Custodian Account definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'CustodianAccount' domain to decorate onto the Custodian Account. These must take the format {domain}/{scope}/{code}, for example 'CustodianAccount/Manager/Id'. If no properties are specified, then no properties will be returned.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[CustodianAccount, Awaitable[CustodianAccount]]: # noqa: E501
|
3296
3296
|
"""GetCustodianAccount: Get Custodian Account # noqa: E501
|
3297
3297
|
|
3298
3298
|
Retrieve the definition of a particular Custodian Account which is part of a Transaction Portfolios. # noqa: E501
|
@@ -3314,7 +3314,7 @@ class TransactionPortfoliosApi:
|
|
3314
3314
|
:type effective_at: str
|
3315
3315
|
:param as_at: The asAt datetime at which to retrieve the Custodian Account definition. Defaults to returning the latest version of the Custodian Account definition if not specified.
|
3316
3316
|
:type as_at: datetime
|
3317
|
-
:param property_keys: A list of property keys from the 'CustodianAccount' domain to decorate onto the Custodian Account.
|
3317
|
+
:param property_keys: A list of property keys from the 'CustodianAccount' domain to decorate onto the Custodian Account. These must take the format {domain}/{scope}/{code}, for example 'CustodianAccount/Manager/Id'. If no properties are specified, then no properties will be returned.
|
3318
3318
|
:type property_keys: List[str]
|
3319
3319
|
:param async_req: Whether to execute the request asynchronously.
|
3320
3320
|
:type async_req: bool, optional
|
@@ -3335,7 +3335,7 @@ class TransactionPortfoliosApi:
|
|
3335
3335
|
return self.get_custodian_account_with_http_info(scope, code, custodian_account_scope, custodian_account_code, effective_at, as_at, property_keys, **kwargs) # noqa: E501
|
3336
3336
|
|
3337
3337
|
@validate_arguments
|
3338
|
-
def get_custodian_account_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolio. Together with the scope this uniquely identifies the Transaction Portfolio.")], custodian_account_scope : Annotated[StrictStr, Field(..., description="The scope of the Custodian Account.")], custodian_account_code : Annotated[StrictStr, Field(..., description="The code of the Custodian Account.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the Custodian Account properties. 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 Custodian Account definition. Defaults to returning the latest version of the Custodian Account definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'CustodianAccount' domain to decorate onto the Custodian Account.
|
3338
|
+
def get_custodian_account_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolio. Together with the scope this uniquely identifies the Transaction Portfolio.")], custodian_account_scope : Annotated[StrictStr, Field(..., description="The scope of the Custodian Account.")], custodian_account_code : Annotated[StrictStr, Field(..., description="The code of the Custodian Account.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the Custodian Account properties. 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 Custodian Account definition. Defaults to returning the latest version of the Custodian Account definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'CustodianAccount' domain to decorate onto the Custodian Account. These must take the format {domain}/{scope}/{code}, for example 'CustodianAccount/Manager/Id'. If no properties are specified, then no properties will be returned.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
3339
3339
|
"""GetCustodianAccount: Get Custodian Account # noqa: E501
|
3340
3340
|
|
3341
3341
|
Retrieve the definition of a particular Custodian Account which is part of a Transaction Portfolios. # noqa: E501
|
@@ -3357,7 +3357,7 @@ class TransactionPortfoliosApi:
|
|
3357
3357
|
:type effective_at: str
|
3358
3358
|
:param as_at: The asAt datetime at which to retrieve the Custodian Account definition. Defaults to returning the latest version of the Custodian Account definition if not specified.
|
3359
3359
|
:type as_at: datetime
|
3360
|
-
:param property_keys: A list of property keys from the 'CustodianAccount' domain to decorate onto the Custodian Account.
|
3360
|
+
:param property_keys: A list of property keys from the 'CustodianAccount' domain to decorate onto the Custodian Account. These must take the format {domain}/{scope}/{code}, for example 'CustodianAccount/Manager/Id'. If no properties are specified, then no properties will be returned.
|
3361
3361
|
:type property_keys: List[str]
|
3362
3362
|
:param async_req: Whether to execute the request asynchronously.
|
3363
3363
|
:type async_req: bool, optional
|
@@ -3488,15 +3488,15 @@ class TransactionPortfoliosApi:
|
|
3488
3488
|
|
3489
3489
|
|
3490
3490
|
@overload
|
3491
|
-
async def get_details(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the
|
3491
|
+
async def get_details(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the details of the transaction portfolio. 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 details of the transaction portfolio. Defaults to returning the latest version of the details if not specified.")] = None, **kwargs) -> PortfolioDetails: # noqa: E501
|
3492
3492
|
...
|
3493
3493
|
|
3494
3494
|
@overload
|
3495
|
-
def get_details(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the
|
3495
|
+
def get_details(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the details of the transaction portfolio. 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 details of the transaction portfolio. Defaults to returning the latest version of the details if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> PortfolioDetails: # noqa: E501
|
3496
3496
|
...
|
3497
3497
|
|
3498
3498
|
@validate_arguments
|
3499
|
-
def get_details(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the
|
3499
|
+
def get_details(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the details of the transaction portfolio. 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 details of the transaction portfolio. Defaults to returning the latest version of the details if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PortfolioDetails, Awaitable[PortfolioDetails]]: # noqa: E501
|
3500
3500
|
"""GetDetails: Get details # noqa: E501
|
3501
3501
|
|
3502
3502
|
Get certain details associated with a transaction portfolio. # noqa: E501
|
@@ -3508,11 +3508,11 @@ class TransactionPortfoliosApi:
|
|
3508
3508
|
|
3509
3509
|
:param scope: The scope of the transaction portfolio. (required)
|
3510
3510
|
:type scope: str
|
3511
|
-
:param code: The code of the transaction portfolio. Together with the
|
3511
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
3512
3512
|
:type code: str
|
3513
|
-
:param effective_at: The effective datetime or cut label at which to retrieve the details of the transaction
|
3513
|
+
:param effective_at: The effective datetime or cut label at which to retrieve the details of the transaction portfolio. Defaults to the current LUSID system datetime if not specified.
|
3514
3514
|
:type effective_at: str
|
3515
|
-
:param as_at: The asAt datetime at which to retrieve the details of the transaction portfolio. Defaults
|
3515
|
+
:param as_at: The asAt datetime at which to retrieve the details of the transaction portfolio. Defaults to returning the latest version of the details if not specified.
|
3516
3516
|
:type as_at: datetime
|
3517
3517
|
:param async_req: Whether to execute the request asynchronously.
|
3518
3518
|
:type async_req: bool, optional
|
@@ -3533,7 +3533,7 @@ class TransactionPortfoliosApi:
|
|
3533
3533
|
return self.get_details_with_http_info(scope, code, effective_at, as_at, **kwargs) # noqa: E501
|
3534
3534
|
|
3535
3535
|
@validate_arguments
|
3536
|
-
def get_details_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the
|
3536
|
+
def get_details_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the details of the transaction portfolio. 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 details of the transaction portfolio. Defaults to returning the latest version of the details if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
3537
3537
|
"""GetDetails: Get details # noqa: E501
|
3538
3538
|
|
3539
3539
|
Get certain details associated with a transaction portfolio. # noqa: E501
|
@@ -3545,11 +3545,11 @@ class TransactionPortfoliosApi:
|
|
3545
3545
|
|
3546
3546
|
:param scope: The scope of the transaction portfolio. (required)
|
3547
3547
|
:type scope: str
|
3548
|
-
:param code: The code of the transaction portfolio. Together with the
|
3548
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
3549
3549
|
:type code: str
|
3550
|
-
:param effective_at: The effective datetime or cut label at which to retrieve the details of the transaction
|
3550
|
+
:param effective_at: The effective datetime or cut label at which to retrieve the details of the transaction portfolio. Defaults to the current LUSID system datetime if not specified.
|
3551
3551
|
:type effective_at: str
|
3552
|
-
:param as_at: The asAt datetime at which to retrieve the details of the transaction portfolio. Defaults
|
3552
|
+
:param as_at: The asAt datetime at which to retrieve the details of the transaction portfolio. Defaults to returning the latest version of the details if not specified.
|
3553
3553
|
:type as_at: datetime
|
3554
3554
|
:param async_req: Whether to execute the request asynchronously.
|
3555
3555
|
:type async_req: bool, optional
|
@@ -3667,18 +3667,18 @@ class TransactionPortfoliosApi:
|
|
3667
3667
|
|
3668
3668
|
|
3669
3669
|
@overload
|
3670
|
-
async def get_holding_contributors(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
3670
|
+
async def get_holding_contributors(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], holding_id : Annotated[conint(strict=True), Field(..., description="The unique holding identifier")], effective_date : Annotated[Optional[StrictStr], Field( description="Effective date")] = None, from_trade_date : Annotated[Optional[StrictStr], Field( description="The from trade date, defaults to first time this holding is opened, lower bound for transactions")] = None, to_trade_date : Annotated[Optional[StrictStr], Field( description="The to trade date upper bound date, defaults to effectiveDate. upper bound for transactions")] = None, include_historic : Annotated[Optional[StrictBool], Field(description="If true, transactions from previously closed holdings are returned. If false, only transactions from last time position is opened.")] = None, tax_lot_id : Annotated[Optional[StrictStr], Field( description="Constrains the Holding Contributors to those which contributed to the specified tax lot.")] = None, include_unsettled_movements : Annotated[Optional[StrictBool], Field(description="If true, contributing transaction which have not settled yet will also be returned. False by default")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing transactions from a previous call to GetHoldingContributors.")] = None, **kwargs) -> VersionedResourceListOfHoldingContributor: # noqa: E501
|
3671
3671
|
...
|
3672
3672
|
|
3673
3673
|
@overload
|
3674
|
-
def get_holding_contributors(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
3674
|
+
def get_holding_contributors(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], holding_id : Annotated[conint(strict=True), Field(..., description="The unique holding identifier")], effective_date : Annotated[Optional[StrictStr], Field( description="Effective date")] = None, from_trade_date : Annotated[Optional[StrictStr], Field( description="The from trade date, defaults to first time this holding is opened, lower bound for transactions")] = None, to_trade_date : Annotated[Optional[StrictStr], Field( description="The to trade date upper bound date, defaults to effectiveDate. upper bound for transactions")] = None, include_historic : Annotated[Optional[StrictBool], Field(description="If true, transactions from previously closed holdings are returned. If false, only transactions from last time position is opened.")] = None, tax_lot_id : Annotated[Optional[StrictStr], Field( description="Constrains the Holding Contributors to those which contributed to the specified tax lot.")] = None, include_unsettled_movements : Annotated[Optional[StrictBool], Field(description="If true, contributing transaction which have not settled yet will also be returned. False by default")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing transactions from a previous call to GetHoldingContributors.")] = None, async_req: Optional[bool]=True, **kwargs) -> VersionedResourceListOfHoldingContributor: # noqa: E501
|
3675
3675
|
...
|
3676
3676
|
|
3677
3677
|
@validate_arguments
|
3678
|
-
def get_holding_contributors(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
3678
|
+
def get_holding_contributors(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], holding_id : Annotated[conint(strict=True), Field(..., description="The unique holding identifier")], effective_date : Annotated[Optional[StrictStr], Field( description="Effective date")] = None, from_trade_date : Annotated[Optional[StrictStr], Field( description="The from trade date, defaults to first time this holding is opened, lower bound for transactions")] = None, to_trade_date : Annotated[Optional[StrictStr], Field( description="The to trade date upper bound date, defaults to effectiveDate. upper bound for transactions")] = None, include_historic : Annotated[Optional[StrictBool], Field(description="If true, transactions from previously closed holdings are returned. If false, only transactions from last time position is opened.")] = None, tax_lot_id : Annotated[Optional[StrictStr], Field( description="Constrains the Holding Contributors to those which contributed to the specified tax lot.")] = None, include_unsettled_movements : Annotated[Optional[StrictBool], Field(description="If true, contributing transaction which have not settled yet will also be returned. False by default")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing transactions from a previous call to GetHoldingContributors.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[VersionedResourceListOfHoldingContributor, Awaitable[VersionedResourceListOfHoldingContributor]]: # noqa: E501
|
3679
3679
|
"""GetHoldingContributors: Get Holdings Contributors # noqa: E501
|
3680
3680
|
|
3681
|
-
Lists all transactions that affect the holdings of a portfolio over a given effective interval. This includes
|
3681
|
+
Lists all transactions that affect the holdings of a portfolio over a given effective interval. This includes transactions automatically generated by LUSID such as holding adjustments. # noqa: E501
|
3682
3682
|
This method makes a synchronous HTTP request by default. To make an
|
3683
3683
|
asynchronous HTTP request, please pass async_req=True
|
3684
3684
|
|
@@ -3687,7 +3687,7 @@ class TransactionPortfoliosApi:
|
|
3687
3687
|
|
3688
3688
|
:param scope: The scope of the transaction portfolio. (required)
|
3689
3689
|
:type scope: str
|
3690
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
3690
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
3691
3691
|
:type code: str
|
3692
3692
|
:param holding_id: The unique holding identifier (required)
|
3693
3693
|
:type holding_id: int
|
@@ -3697,7 +3697,7 @@ class TransactionPortfoliosApi:
|
|
3697
3697
|
:type from_trade_date: str
|
3698
3698
|
:param to_trade_date: The to trade date upper bound date, defaults to effectiveDate. upper bound for transactions
|
3699
3699
|
:type to_trade_date: str
|
3700
|
-
:param include_historic: If true, transactions from previously closed holdings are returned.
|
3700
|
+
:param include_historic: If true, transactions from previously closed holdings are returned. If false, only transactions from last time position is opened.
|
3701
3701
|
:type include_historic: bool
|
3702
3702
|
:param tax_lot_id: Constrains the Holding Contributors to those which contributed to the specified tax lot.
|
3703
3703
|
:type tax_lot_id: str
|
@@ -3705,7 +3705,7 @@ class TransactionPortfoliosApi:
|
|
3705
3705
|
:type include_unsettled_movements: bool
|
3706
3706
|
:param limit: When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
|
3707
3707
|
:type limit: int
|
3708
|
-
:param as_at: The asAt datetime at which to build the transactions. Defaults to return the latest
|
3708
|
+
:param as_at: The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified.
|
3709
3709
|
:type as_at: datetime
|
3710
3710
|
:param page: The pagination token to use to continue listing transactions from a previous call to GetHoldingContributors.
|
3711
3711
|
:type page: str
|
@@ -3728,10 +3728,10 @@ class TransactionPortfoliosApi:
|
|
3728
3728
|
return self.get_holding_contributors_with_http_info(scope, code, holding_id, effective_date, from_trade_date, to_trade_date, include_historic, tax_lot_id, include_unsettled_movements, limit, as_at, page, **kwargs) # noqa: E501
|
3729
3729
|
|
3730
3730
|
@validate_arguments
|
3731
|
-
def get_holding_contributors_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
3731
|
+
def get_holding_contributors_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], holding_id : Annotated[conint(strict=True), Field(..., description="The unique holding identifier")], effective_date : Annotated[Optional[StrictStr], Field( description="Effective date")] = None, from_trade_date : Annotated[Optional[StrictStr], Field( description="The from trade date, defaults to first time this holding is opened, lower bound for transactions")] = None, to_trade_date : Annotated[Optional[StrictStr], Field( description="The to trade date upper bound date, defaults to effectiveDate. upper bound for transactions")] = None, include_historic : Annotated[Optional[StrictBool], Field(description="If true, transactions from previously closed holdings are returned. If false, only transactions from last time position is opened.")] = None, tax_lot_id : Annotated[Optional[StrictStr], Field( description="Constrains the Holding Contributors to those which contributed to the specified tax lot.")] = None, include_unsettled_movements : Annotated[Optional[StrictBool], Field(description="If true, contributing transaction which have not settled yet will also be returned. False by default")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing transactions from a previous call to GetHoldingContributors.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
3732
3732
|
"""GetHoldingContributors: Get Holdings Contributors # noqa: E501
|
3733
3733
|
|
3734
|
-
Lists all transactions that affect the holdings of a portfolio over a given effective interval. This includes
|
3734
|
+
Lists all transactions that affect the holdings of a portfolio over a given effective interval. This includes transactions automatically generated by LUSID such as holding adjustments. # noqa: E501
|
3735
3735
|
This method makes a synchronous HTTP request by default. To make an
|
3736
3736
|
asynchronous HTTP request, please pass async_req=True
|
3737
3737
|
|
@@ -3740,7 +3740,7 @@ class TransactionPortfoliosApi:
|
|
3740
3740
|
|
3741
3741
|
:param scope: The scope of the transaction portfolio. (required)
|
3742
3742
|
:type scope: str
|
3743
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
3743
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
3744
3744
|
:type code: str
|
3745
3745
|
:param holding_id: The unique holding identifier (required)
|
3746
3746
|
:type holding_id: int
|
@@ -3750,7 +3750,7 @@ class TransactionPortfoliosApi:
|
|
3750
3750
|
:type from_trade_date: str
|
3751
3751
|
:param to_trade_date: The to trade date upper bound date, defaults to effectiveDate. upper bound for transactions
|
3752
3752
|
:type to_trade_date: str
|
3753
|
-
:param include_historic: If true, transactions from previously closed holdings are returned.
|
3753
|
+
:param include_historic: If true, transactions from previously closed holdings are returned. If false, only transactions from last time position is opened.
|
3754
3754
|
:type include_historic: bool
|
3755
3755
|
:param tax_lot_id: Constrains the Holding Contributors to those which contributed to the specified tax lot.
|
3756
3756
|
:type tax_lot_id: str
|
@@ -3758,7 +3758,7 @@ class TransactionPortfoliosApi:
|
|
3758
3758
|
:type include_unsettled_movements: bool
|
3759
3759
|
:param limit: When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
|
3760
3760
|
:type limit: int
|
3761
|
-
:param as_at: The asAt datetime at which to build the transactions. Defaults to return the latest
|
3761
|
+
:param as_at: The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified.
|
3762
3762
|
:type as_at: datetime
|
3763
3763
|
:param page: The pagination token to use to continue listing transactions from a previous call to GetHoldingContributors.
|
3764
3764
|
:type page: str
|
@@ -3910,15 +3910,15 @@ class TransactionPortfoliosApi:
|
|
3910
3910
|
|
3911
3911
|
|
3912
3912
|
@overload
|
3913
|
-
async def get_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
3913
|
+
async def get_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the holdings of the transaction portfolio. 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 holdings of the transaction portfolio. Defaults to return the latest version if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Holding Type, use \"holdingType eq 'p'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\", \"Holding\", \"Custodian Account\", \"Legal Entity\" or \"Portfolio\" domain to decorate onto holdings. These must have the format {domain}/{scope}/{code}, for example \"Instrument/system/Name\" or \"Holding/system/Cost\".")] = None, by_taxlots : Annotated[Optional[StrictBool], Field(description="Whether or not to expand the holdings to return the underlying tax-lots. Defaults to False.")] = None, include_settlement_events_after_days : Annotated[Optional[StrictInt], Field(description="Number of days ahead to bring back settlements from, in relation to the specified effectiveAt")] = None, timeline_scope : Annotated[Optional[StrictStr], Field( description="The scope of the Timeline.")] = None, timeline_code : Annotated[Optional[StrictStr], Field( description="The code of the Timeline.")] = None, closed_period_id : Annotated[Optional[StrictStr], Field( description="The closed period ID. If this is specified, both timelineScope and timelineCode must be specified. Either closedPeriodId or effectiveAt can be used with a Timeline.")] = None, **kwargs) -> VersionedResourceListOfPortfolioHolding: # noqa: E501
|
3914
3914
|
...
|
3915
3915
|
|
3916
3916
|
@overload
|
3917
|
-
def get_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
3917
|
+
def get_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the holdings of the transaction portfolio. 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 holdings of the transaction portfolio. Defaults to return the latest version if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Holding Type, use \"holdingType eq 'p'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\", \"Holding\", \"Custodian Account\", \"Legal Entity\" or \"Portfolio\" domain to decorate onto holdings. These must have the format {domain}/{scope}/{code}, for example \"Instrument/system/Name\" or \"Holding/system/Cost\".")] = None, by_taxlots : Annotated[Optional[StrictBool], Field(description="Whether or not to expand the holdings to return the underlying tax-lots. Defaults to False.")] = None, include_settlement_events_after_days : Annotated[Optional[StrictInt], Field(description="Number of days ahead to bring back settlements from, in relation to the specified effectiveAt")] = None, timeline_scope : Annotated[Optional[StrictStr], Field( description="The scope of the Timeline.")] = None, timeline_code : Annotated[Optional[StrictStr], Field( description="The code of the Timeline.")] = None, closed_period_id : Annotated[Optional[StrictStr], Field( description="The closed period ID. If this is specified, both timelineScope and timelineCode must be specified. Either closedPeriodId or effectiveAt can be used with a Timeline.")] = None, async_req: Optional[bool]=True, **kwargs) -> VersionedResourceListOfPortfolioHolding: # noqa: E501
|
3918
3918
|
...
|
3919
3919
|
|
3920
3920
|
@validate_arguments
|
3921
|
-
def get_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
3921
|
+
def get_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the holdings of the transaction portfolio. 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 holdings of the transaction portfolio. Defaults to return the latest version if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Holding Type, use \"holdingType eq 'p'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\", \"Holding\", \"Custodian Account\", \"Legal Entity\" or \"Portfolio\" domain to decorate onto holdings. These must have the format {domain}/{scope}/{code}, for example \"Instrument/system/Name\" or \"Holding/system/Cost\".")] = None, by_taxlots : Annotated[Optional[StrictBool], Field(description="Whether or not to expand the holdings to return the underlying tax-lots. Defaults to False.")] = None, include_settlement_events_after_days : Annotated[Optional[StrictInt], Field(description="Number of days ahead to bring back settlements from, in relation to the specified effectiveAt")] = None, timeline_scope : Annotated[Optional[StrictStr], Field( description="The scope of the Timeline.")] = None, timeline_code : Annotated[Optional[StrictStr], Field( description="The code of the Timeline.")] = None, closed_period_id : Annotated[Optional[StrictStr], Field( description="The closed period ID. If this is specified, both timelineScope and timelineCode must be specified. Either closedPeriodId or effectiveAt can be used with a Timeline.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[VersionedResourceListOfPortfolioHolding, Awaitable[VersionedResourceListOfPortfolioHolding]]: # noqa: E501
|
3922
3922
|
"""GetHoldings: Get holdings # noqa: E501
|
3923
3923
|
|
3924
3924
|
Calculate holdings for a transaction portfolio. # noqa: E501
|
@@ -3930,17 +3930,17 @@ class TransactionPortfoliosApi:
|
|
3930
3930
|
|
3931
3931
|
:param scope: The scope of the transaction portfolio. (required)
|
3932
3932
|
:type scope: str
|
3933
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
3933
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
3934
3934
|
:type code: str
|
3935
|
-
:param effective_at: The effective datetime or cut label at which to retrieve the holdings of the transaction
|
3935
|
+
:param effective_at: The effective datetime or cut label at which to retrieve the holdings of the transaction portfolio. Defaults to the current LUSID system datetime if not specified.
|
3936
3936
|
:type effective_at: str
|
3937
|
-
:param as_at: The asAt datetime at which to retrieve the holdings of the transaction portfolio. Defaults
|
3937
|
+
:param as_at: The asAt datetime at which to retrieve the holdings of the transaction portfolio. Defaults to return the latest version if not specified.
|
3938
3938
|
:type as_at: datetime
|
3939
|
-
:param filter: Expression to filter the result set.
|
3939
|
+
:param filter: Expression to filter the result set. For example, to filter on the Holding Type, use \"holdingType eq 'p'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
3940
3940
|
:type filter: str
|
3941
|
-
:param property_keys: A list of property keys from the \"Instrument\", \"Holding\", \"Custodian Account\", \"Legal Entity\" or \"Portfolio\" domain to decorate onto
|
3941
|
+
:param property_keys: A list of property keys from the \"Instrument\", \"Holding\", \"Custodian Account\", \"Legal Entity\" or \"Portfolio\" domain to decorate onto holdings. These must have the format {domain}/{scope}/{code}, for example \"Instrument/system/Name\" or \"Holding/system/Cost\".
|
3942
3942
|
:type property_keys: List[str]
|
3943
|
-
:param by_taxlots: Whether or not to expand the holdings to return the underlying tax-lots. Defaults to
|
3943
|
+
:param by_taxlots: Whether or not to expand the holdings to return the underlying tax-lots. Defaults to False.
|
3944
3944
|
:type by_taxlots: bool
|
3945
3945
|
:param include_settlement_events_after_days: Number of days ahead to bring back settlements from, in relation to the specified effectiveAt
|
3946
3946
|
:type include_settlement_events_after_days: int
|
@@ -3969,7 +3969,7 @@ class TransactionPortfoliosApi:
|
|
3969
3969
|
return self.get_holdings_with_http_info(scope, code, effective_at, as_at, filter, property_keys, by_taxlots, include_settlement_events_after_days, timeline_scope, timeline_code, closed_period_id, **kwargs) # noqa: E501
|
3970
3970
|
|
3971
3971
|
@validate_arguments
|
3972
|
-
def get_holdings_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
3972
|
+
def get_holdings_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the holdings of the transaction portfolio. 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 holdings of the transaction portfolio. Defaults to return the latest version if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Holding Type, use \"holdingType eq 'p'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\", \"Holding\", \"Custodian Account\", \"Legal Entity\" or \"Portfolio\" domain to decorate onto holdings. These must have the format {domain}/{scope}/{code}, for example \"Instrument/system/Name\" or \"Holding/system/Cost\".")] = None, by_taxlots : Annotated[Optional[StrictBool], Field(description="Whether or not to expand the holdings to return the underlying tax-lots. Defaults to False.")] = None, include_settlement_events_after_days : Annotated[Optional[StrictInt], Field(description="Number of days ahead to bring back settlements from, in relation to the specified effectiveAt")] = None, timeline_scope : Annotated[Optional[StrictStr], Field( description="The scope of the Timeline.")] = None, timeline_code : Annotated[Optional[StrictStr], Field( description="The code of the Timeline.")] = None, closed_period_id : Annotated[Optional[StrictStr], Field( description="The closed period ID. If this is specified, both timelineScope and timelineCode must be specified. Either closedPeriodId or effectiveAt can be used with a Timeline.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
3973
3973
|
"""GetHoldings: Get holdings # noqa: E501
|
3974
3974
|
|
3975
3975
|
Calculate holdings for a transaction portfolio. # noqa: E501
|
@@ -3981,17 +3981,17 @@ class TransactionPortfoliosApi:
|
|
3981
3981
|
|
3982
3982
|
:param scope: The scope of the transaction portfolio. (required)
|
3983
3983
|
:type scope: str
|
3984
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
3984
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
3985
3985
|
:type code: str
|
3986
|
-
:param effective_at: The effective datetime or cut label at which to retrieve the holdings of the transaction
|
3986
|
+
:param effective_at: The effective datetime or cut label at which to retrieve the holdings of the transaction portfolio. Defaults to the current LUSID system datetime if not specified.
|
3987
3987
|
:type effective_at: str
|
3988
|
-
:param as_at: The asAt datetime at which to retrieve the holdings of the transaction portfolio. Defaults
|
3988
|
+
:param as_at: The asAt datetime at which to retrieve the holdings of the transaction portfolio. Defaults to return the latest version if not specified.
|
3989
3989
|
:type as_at: datetime
|
3990
|
-
:param filter: Expression to filter the result set.
|
3990
|
+
:param filter: Expression to filter the result set. For example, to filter on the Holding Type, use \"holdingType eq 'p'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
3991
3991
|
:type filter: str
|
3992
|
-
:param property_keys: A list of property keys from the \"Instrument\", \"Holding\", \"Custodian Account\", \"Legal Entity\" or \"Portfolio\" domain to decorate onto
|
3992
|
+
:param property_keys: A list of property keys from the \"Instrument\", \"Holding\", \"Custodian Account\", \"Legal Entity\" or \"Portfolio\" domain to decorate onto holdings. These must have the format {domain}/{scope}/{code}, for example \"Instrument/system/Name\" or \"Holding/system/Cost\".
|
3993
3993
|
:type property_keys: List[str]
|
3994
|
-
:param by_taxlots: Whether or not to expand the holdings to return the underlying tax-lots. Defaults to
|
3994
|
+
:param by_taxlots: Whether or not to expand the holdings to return the underlying tax-lots. Defaults to False.
|
3995
3995
|
:type by_taxlots: bool
|
3996
3996
|
:param include_settlement_events_after_days: Number of days ahead to bring back settlements from, in relation to the specified effectiveAt
|
3997
3997
|
:type include_settlement_events_after_days: int
|
@@ -4146,18 +4146,18 @@ class TransactionPortfoliosApi:
|
|
4146
4146
|
|
4147
4147
|
|
4148
4148
|
@overload
|
4149
|
-
async def get_holdings_adjustment(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
4149
|
+
async def get_holdings_adjustment(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[StrictStr, Field(..., description="The effective datetime or cut label of the holdings adjustment.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the holdings adjustment. Defaults to the return the latest version of the holdings adjustment if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the ‘Instrument' domain to decorate onto holdings adjustments. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. Note that properties from the 'Holding’ domain are automatically returned.")] = None, **kwargs) -> HoldingsAdjustment: # noqa: E501
|
4150
4150
|
...
|
4151
4151
|
|
4152
4152
|
@overload
|
4153
|
-
def get_holdings_adjustment(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
4153
|
+
def get_holdings_adjustment(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[StrictStr, Field(..., description="The effective datetime or cut label of the holdings adjustment.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the holdings adjustment. Defaults to the return the latest version of the holdings adjustment if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the ‘Instrument' domain to decorate onto holdings adjustments. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. Note that properties from the 'Holding’ domain are automatically returned.")] = None, async_req: Optional[bool]=True, **kwargs) -> HoldingsAdjustment: # noqa: E501
|
4154
4154
|
...
|
4155
4155
|
|
4156
4156
|
@validate_arguments
|
4157
|
-
def get_holdings_adjustment(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
4157
|
+
def get_holdings_adjustment(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[StrictStr, Field(..., description="The effective datetime or cut label of the holdings adjustment.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the holdings adjustment. Defaults to the return the latest version of the holdings adjustment if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the ‘Instrument' domain to decorate onto holdings adjustments. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. Note that properties from the 'Holding’ domain are automatically returned.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[HoldingsAdjustment, Awaitable[HoldingsAdjustment]]: # noqa: E501
|
4158
4158
|
"""GetHoldingsAdjustment: Get holdings adjustment # noqa: E501
|
4159
4159
|
|
4160
|
-
Get a holdings adjustment made to a transaction portfolio at a specific effective datetime. Note that a
|
4160
|
+
Get a holdings adjustment made to a transaction portfolio at a specific effective datetime. Note that a holdings adjustment will only be returned if one exists for the specified effective datetime. # noqa: E501
|
4161
4161
|
This method makes a synchronous HTTP request by default. To make an
|
4162
4162
|
asynchronous HTTP request, please pass async_req=True
|
4163
4163
|
|
@@ -4166,13 +4166,13 @@ class TransactionPortfoliosApi:
|
|
4166
4166
|
|
4167
4167
|
:param scope: The scope of the transaction portfolio. (required)
|
4168
4168
|
:type scope: str
|
4169
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
4169
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
4170
4170
|
:type code: str
|
4171
4171
|
:param effective_at: The effective datetime or cut label of the holdings adjustment. (required)
|
4172
4172
|
:type effective_at: str
|
4173
|
-
:param as_at: The asAt datetime at which to retrieve the holdings adjustment. Defaults to the return the latest
|
4173
|
+
:param as_at: The asAt datetime at which to retrieve the holdings adjustment. Defaults to the return the latest version of the holdings adjustment if not specified.
|
4174
4174
|
:type as_at: datetime
|
4175
|
-
:param property_keys: A list of property keys from the ‘Instrument' domain to decorate onto holdings adjustments.
|
4175
|
+
:param property_keys: A list of property keys from the ‘Instrument' domain to decorate onto holdings adjustments. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. Note that properties from the 'Holding’ domain are automatically returned.
|
4176
4176
|
:type property_keys: List[str]
|
4177
4177
|
:param async_req: Whether to execute the request asynchronously.
|
4178
4178
|
:type async_req: bool, optional
|
@@ -4193,10 +4193,10 @@ class TransactionPortfoliosApi:
|
|
4193
4193
|
return self.get_holdings_adjustment_with_http_info(scope, code, effective_at, as_at, property_keys, **kwargs) # noqa: E501
|
4194
4194
|
|
4195
4195
|
@validate_arguments
|
4196
|
-
def get_holdings_adjustment_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
4196
|
+
def get_holdings_adjustment_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[StrictStr, Field(..., description="The effective datetime or cut label of the holdings adjustment.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the holdings adjustment. Defaults to the return the latest version of the holdings adjustment if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the ‘Instrument' domain to decorate onto holdings adjustments. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. Note that properties from the 'Holding’ domain are automatically returned.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
4197
4197
|
"""GetHoldingsAdjustment: Get holdings adjustment # noqa: E501
|
4198
4198
|
|
4199
|
-
Get a holdings adjustment made to a transaction portfolio at a specific effective datetime. Note that a
|
4199
|
+
Get a holdings adjustment made to a transaction portfolio at a specific effective datetime. Note that a holdings adjustment will only be returned if one exists for the specified effective datetime. # noqa: E501
|
4200
4200
|
This method makes a synchronous HTTP request by default. To make an
|
4201
4201
|
asynchronous HTTP request, please pass async_req=True
|
4202
4202
|
|
@@ -4205,13 +4205,13 @@ class TransactionPortfoliosApi:
|
|
4205
4205
|
|
4206
4206
|
:param scope: The scope of the transaction portfolio. (required)
|
4207
4207
|
:type scope: str
|
4208
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
4208
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
4209
4209
|
:type code: str
|
4210
4210
|
:param effective_at: The effective datetime or cut label of the holdings adjustment. (required)
|
4211
4211
|
:type effective_at: str
|
4212
|
-
:param as_at: The asAt datetime at which to retrieve the holdings adjustment. Defaults to the return the latest
|
4212
|
+
:param as_at: The asAt datetime at which to retrieve the holdings adjustment. Defaults to the return the latest version of the holdings adjustment if not specified.
|
4213
4213
|
:type as_at: datetime
|
4214
|
-
:param property_keys: A list of property keys from the ‘Instrument' domain to decorate onto holdings adjustments.
|
4214
|
+
:param property_keys: A list of property keys from the ‘Instrument' domain to decorate onto holdings adjustments. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. Note that properties from the 'Holding’ domain are automatically returned.
|
4215
4215
|
:type property_keys: List[str]
|
4216
4216
|
:param async_req: Whether to execute the request asynchronously.
|
4217
4217
|
:type async_req: bool, optional
|
@@ -4334,18 +4334,18 @@ class TransactionPortfoliosApi:
|
|
4334
4334
|
|
4335
4335
|
|
4336
4336
|
@overload
|
4337
|
-
async def get_holdings_with_orders(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
4337
|
+
async def get_holdings_with_orders(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the holdings of the transaction portfolio. 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 holdings of the transaction portfolio. Defaults to return the latest version of the holdings if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Holding Type, use \"holdingType eq 'p'\" For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\", \"Holding\" or \"Portfolio\" domain to decorate onto the holdings. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Holding/system/Cost\".")] = None, by_taxlots : Annotated[Optional[StrictBool], Field(description="Whether or not to expand the holdings to return the underlying tax-lots. Defaults to False.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeId")] = None, include_settlement_events_after_days : Annotated[Optional[StrictInt], Field(description="Number of days ahead to bring back settlements from, in relation to the specified effectiveAt")] = None, **kwargs) -> VersionedResourceListWithWarningsOfPortfolioHolding: # noqa: E501
|
4338
4338
|
...
|
4339
4339
|
|
4340
4340
|
@overload
|
4341
|
-
def get_holdings_with_orders(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
4341
|
+
def get_holdings_with_orders(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the holdings of the transaction portfolio. 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 holdings of the transaction portfolio. Defaults to return the latest version of the holdings if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Holding Type, use \"holdingType eq 'p'\" For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\", \"Holding\" or \"Portfolio\" domain to decorate onto the holdings. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Holding/system/Cost\".")] = None, by_taxlots : Annotated[Optional[StrictBool], Field(description="Whether or not to expand the holdings to return the underlying tax-lots. Defaults to False.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeId")] = None, include_settlement_events_after_days : Annotated[Optional[StrictInt], Field(description="Number of days ahead to bring back settlements from, in relation to the specified effectiveAt")] = None, async_req: Optional[bool]=True, **kwargs) -> VersionedResourceListWithWarningsOfPortfolioHolding: # noqa: E501
|
4342
4342
|
...
|
4343
4343
|
|
4344
4344
|
@validate_arguments
|
4345
|
-
def get_holdings_with_orders(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
4345
|
+
def get_holdings_with_orders(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the holdings of the transaction portfolio. 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 holdings of the transaction portfolio. Defaults to return the latest version of the holdings if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Holding Type, use \"holdingType eq 'p'\" For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\", \"Holding\" or \"Portfolio\" domain to decorate onto the holdings. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Holding/system/Cost\".")] = None, by_taxlots : Annotated[Optional[StrictBool], Field(description="Whether or not to expand the holdings to return the underlying tax-lots. Defaults to False.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeId")] = None, include_settlement_events_after_days : Annotated[Optional[StrictInt], Field(description="Number of days ahead to bring back settlements from, in relation to the specified effectiveAt")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[VersionedResourceListWithWarningsOfPortfolioHolding, Awaitable[VersionedResourceListWithWarningsOfPortfolioHolding]]: # noqa: E501
|
4346
4346
|
"""GetHoldingsWithOrders: Get holdings with orders # noqa: E501
|
4347
4347
|
|
4348
|
-
Get the holdings of a transaction portfolio. Create virtual holdings for any outstanding orders,
|
4348
|
+
Get the holdings of a transaction portfolio. Create virtual holdings for any outstanding orders, and account for order state/fulfillment; that is, treat outstanding orders (and related records) as if they had been realised at moment of query. # noqa: E501
|
4349
4349
|
This method makes a synchronous HTTP request by default. To make an
|
4350
4350
|
asynchronous HTTP request, please pass async_req=True
|
4351
4351
|
|
@@ -4354,17 +4354,17 @@ class TransactionPortfoliosApi:
|
|
4354
4354
|
|
4355
4355
|
:param scope: The scope of the transaction portfolio. (required)
|
4356
4356
|
:type scope: str
|
4357
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
4357
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
4358
4358
|
:type code: str
|
4359
|
-
:param effective_at: The effective datetime or cut label at which to retrieve the holdings of the transaction
|
4359
|
+
:param effective_at: The effective datetime or cut label at which to retrieve the holdings of the transaction portfolio. Defaults to the current LUSID system datetime if not specified.
|
4360
4360
|
:type effective_at: str
|
4361
|
-
:param as_at: The asAt datetime at which to retrieve the holdings of the transaction portfolio. Defaults
|
4361
|
+
:param as_at: The asAt datetime at which to retrieve the holdings of the transaction portfolio. Defaults to return the latest version of the holdings if not specified.
|
4362
4362
|
:type as_at: datetime
|
4363
|
-
:param filter: Expression to filter the result set.
|
4363
|
+
:param filter: Expression to filter the result set. For example, to filter on the Holding Type, use \"holdingType eq 'p'\" For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
4364
4364
|
:type filter: str
|
4365
|
-
:param property_keys: A list of property keys from the \"Instrument\", \"Holding\" or \"Portfolio\" domain to decorate onto
|
4365
|
+
:param property_keys: A list of property keys from the \"Instrument\", \"Holding\" or \"Portfolio\" domain to decorate onto the holdings. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Holding/system/Cost\".
|
4366
4366
|
:type property_keys: List[str]
|
4367
|
-
:param by_taxlots: Whether or not to expand the holdings to return the underlying tax-lots. Defaults to
|
4367
|
+
:param by_taxlots: Whether or not to expand the holdings to return the underlying tax-lots. Defaults to False.
|
4368
4368
|
:type by_taxlots: bool
|
4369
4369
|
:param recipe_id_scope: The scope of the given recipeId
|
4370
4370
|
:type recipe_id_scope: str
|
@@ -4391,10 +4391,10 @@ class TransactionPortfoliosApi:
|
|
4391
4391
|
return self.get_holdings_with_orders_with_http_info(scope, code, effective_at, as_at, filter, property_keys, by_taxlots, recipe_id_scope, recipe_id_code, include_settlement_events_after_days, **kwargs) # noqa: E501
|
4392
4392
|
|
4393
4393
|
@validate_arguments
|
4394
|
-
def get_holdings_with_orders_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
4394
|
+
def get_holdings_with_orders_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the holdings of the transaction portfolio. 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 holdings of the transaction portfolio. Defaults to return the latest version of the holdings if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Holding Type, use \"holdingType eq 'p'\" For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\", \"Holding\" or \"Portfolio\" domain to decorate onto the holdings. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Holding/system/Cost\".")] = None, by_taxlots : Annotated[Optional[StrictBool], Field(description="Whether or not to expand the holdings to return the underlying tax-lots. Defaults to False.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeId")] = None, include_settlement_events_after_days : Annotated[Optional[StrictInt], Field(description="Number of days ahead to bring back settlements from, in relation to the specified effectiveAt")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
4395
4395
|
"""GetHoldingsWithOrders: Get holdings with orders # noqa: E501
|
4396
4396
|
|
4397
|
-
Get the holdings of a transaction portfolio. Create virtual holdings for any outstanding orders,
|
4397
|
+
Get the holdings of a transaction portfolio. Create virtual holdings for any outstanding orders, and account for order state/fulfillment; that is, treat outstanding orders (and related records) as if they had been realised at moment of query. # noqa: E501
|
4398
4398
|
This method makes a synchronous HTTP request by default. To make an
|
4399
4399
|
asynchronous HTTP request, please pass async_req=True
|
4400
4400
|
|
@@ -4403,17 +4403,17 @@ class TransactionPortfoliosApi:
|
|
4403
4403
|
|
4404
4404
|
:param scope: The scope of the transaction portfolio. (required)
|
4405
4405
|
:type scope: str
|
4406
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
4406
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
4407
4407
|
:type code: str
|
4408
|
-
:param effective_at: The effective datetime or cut label at which to retrieve the holdings of the transaction
|
4408
|
+
:param effective_at: The effective datetime or cut label at which to retrieve the holdings of the transaction portfolio. Defaults to the current LUSID system datetime if not specified.
|
4409
4409
|
:type effective_at: str
|
4410
|
-
:param as_at: The asAt datetime at which to retrieve the holdings of the transaction portfolio. Defaults
|
4410
|
+
:param as_at: The asAt datetime at which to retrieve the holdings of the transaction portfolio. Defaults to return the latest version of the holdings if not specified.
|
4411
4411
|
:type as_at: datetime
|
4412
|
-
:param filter: Expression to filter the result set.
|
4412
|
+
:param filter: Expression to filter the result set. For example, to filter on the Holding Type, use \"holdingType eq 'p'\" For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
4413
4413
|
:type filter: str
|
4414
|
-
:param property_keys: A list of property keys from the \"Instrument\", \"Holding\" or \"Portfolio\" domain to decorate onto
|
4414
|
+
:param property_keys: A list of property keys from the \"Instrument\", \"Holding\" or \"Portfolio\" domain to decorate onto the holdings. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Holding/system/Cost\".
|
4415
4415
|
:type property_keys: List[str]
|
4416
|
-
:param by_taxlots: Whether or not to expand the holdings to return the underlying tax-lots. Defaults to
|
4416
|
+
:param by_taxlots: Whether or not to expand the holdings to return the underlying tax-lots. Defaults to False.
|
4417
4417
|
:type by_taxlots: bool
|
4418
4418
|
:param recipe_id_scope: The scope of the given recipeId
|
4419
4419
|
:type recipe_id_scope: str
|
@@ -4562,18 +4562,18 @@ class TransactionPortfoliosApi:
|
|
4562
4562
|
|
4563
4563
|
|
4564
4564
|
@overload
|
4565
|
-
async def get_multiple_holding_contributors(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
4565
|
+
async def get_multiple_holding_contributors(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], holding_ids_request : Annotated[HoldingIdsRequest, Field(..., description="The array of unique holding identifiers")], effective_date : Annotated[Optional[StrictStr], Field( description="Effective date")] = None, from_transaction_date : Annotated[Optional[StrictStr], Field( description="The from trade date, defaults to first time this holding is opened, lower bound for transactions")] = None, to_transaction_date : Annotated[Optional[StrictStr], Field( description="The to trade date upper bound date, defaults to effectiveDate. upper bound for transactions")] = None, include_historic : Annotated[Optional[StrictBool], Field(description="If true, transactions from previously closed holdings are returned. If false, only transactions from last time position is opened.")] = None, tax_lot_id : Annotated[Optional[StrictStr], Field( description="Constrains the Holding Contributors to those which contributed to the specified tax lot.")] = None, include_unsettled_movements : Annotated[Optional[StrictBool], Field(description="If true, contributing transaction which have not settled yet will also be returned. False by default")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing transactions from a previous call to GetHoldingContributors.")] = None, **kwargs) -> VersionedResourceListOfHoldingContributor: # noqa: E501
|
4566
4566
|
...
|
4567
4567
|
|
4568
4568
|
@overload
|
4569
|
-
def get_multiple_holding_contributors(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
4569
|
+
def get_multiple_holding_contributors(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], holding_ids_request : Annotated[HoldingIdsRequest, Field(..., description="The array of unique holding identifiers")], effective_date : Annotated[Optional[StrictStr], Field( description="Effective date")] = None, from_transaction_date : Annotated[Optional[StrictStr], Field( description="The from trade date, defaults to first time this holding is opened, lower bound for transactions")] = None, to_transaction_date : Annotated[Optional[StrictStr], Field( description="The to trade date upper bound date, defaults to effectiveDate. upper bound for transactions")] = None, include_historic : Annotated[Optional[StrictBool], Field(description="If true, transactions from previously closed holdings are returned. If false, only transactions from last time position is opened.")] = None, tax_lot_id : Annotated[Optional[StrictStr], Field( description="Constrains the Holding Contributors to those which contributed to the specified tax lot.")] = None, include_unsettled_movements : Annotated[Optional[StrictBool], Field(description="If true, contributing transaction which have not settled yet will also be returned. False by default")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing transactions from a previous call to GetHoldingContributors.")] = None, async_req: Optional[bool]=True, **kwargs) -> VersionedResourceListOfHoldingContributor: # noqa: E501
|
4570
4570
|
...
|
4571
4571
|
|
4572
4572
|
@validate_arguments
|
4573
|
-
def get_multiple_holding_contributors(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
4573
|
+
def get_multiple_holding_contributors(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], holding_ids_request : Annotated[HoldingIdsRequest, Field(..., description="The array of unique holding identifiers")], effective_date : Annotated[Optional[StrictStr], Field( description="Effective date")] = None, from_transaction_date : Annotated[Optional[StrictStr], Field( description="The from trade date, defaults to first time this holding is opened, lower bound for transactions")] = None, to_transaction_date : Annotated[Optional[StrictStr], Field( description="The to trade date upper bound date, defaults to effectiveDate. upper bound for transactions")] = None, include_historic : Annotated[Optional[StrictBool], Field(description="If true, transactions from previously closed holdings are returned. If false, only transactions from last time position is opened.")] = None, tax_lot_id : Annotated[Optional[StrictStr], Field( description="Constrains the Holding Contributors to those which contributed to the specified tax lot.")] = None, include_unsettled_movements : Annotated[Optional[StrictBool], Field(description="If true, contributing transaction which have not settled yet will also be returned. False by default")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing transactions from a previous call to GetHoldingContributors.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[VersionedResourceListOfHoldingContributor, Awaitable[VersionedResourceListOfHoldingContributor]]: # noqa: E501
|
4574
4574
|
"""GetMultipleHoldingContributors: Get Multiple Holding Contributors # noqa: E501
|
4575
4575
|
|
4576
|
-
Lists all transactions that affect multiple specified holdings of a portfolio over a given effective interval. This includes
|
4576
|
+
Lists all transactions that affect multiple specified holdings of a portfolio over a given effective interval. This includes transactions automatically generated by LUSID such as holding adjustments. # noqa: E501
|
4577
4577
|
This method makes a synchronous HTTP request by default. To make an
|
4578
4578
|
asynchronous HTTP request, please pass async_req=True
|
4579
4579
|
|
@@ -4582,7 +4582,7 @@ class TransactionPortfoliosApi:
|
|
4582
4582
|
|
4583
4583
|
:param scope: The scope of the transaction portfolio. (required)
|
4584
4584
|
:type scope: str
|
4585
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
4585
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
4586
4586
|
:type code: str
|
4587
4587
|
:param holding_ids_request: The array of unique holding identifiers (required)
|
4588
4588
|
:type holding_ids_request: HoldingIdsRequest
|
@@ -4592,7 +4592,7 @@ class TransactionPortfoliosApi:
|
|
4592
4592
|
:type from_transaction_date: str
|
4593
4593
|
:param to_transaction_date: The to trade date upper bound date, defaults to effectiveDate. upper bound for transactions
|
4594
4594
|
:type to_transaction_date: str
|
4595
|
-
:param include_historic: If true, transactions from previously closed holdings are returned.
|
4595
|
+
:param include_historic: If true, transactions from previously closed holdings are returned. If false, only transactions from last time position is opened.
|
4596
4596
|
:type include_historic: bool
|
4597
4597
|
:param tax_lot_id: Constrains the Holding Contributors to those which contributed to the specified tax lot.
|
4598
4598
|
:type tax_lot_id: str
|
@@ -4600,7 +4600,7 @@ class TransactionPortfoliosApi:
|
|
4600
4600
|
:type include_unsettled_movements: bool
|
4601
4601
|
:param limit: When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
|
4602
4602
|
:type limit: int
|
4603
|
-
:param as_at: The asAt datetime at which to build the transactions. Defaults to return the latest
|
4603
|
+
:param as_at: The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified.
|
4604
4604
|
:type as_at: datetime
|
4605
4605
|
:param page: The pagination token to use to continue listing transactions from a previous call to GetHoldingContributors.
|
4606
4606
|
:type page: str
|
@@ -4623,10 +4623,10 @@ class TransactionPortfoliosApi:
|
|
4623
4623
|
return self.get_multiple_holding_contributors_with_http_info(scope, code, holding_ids_request, effective_date, from_transaction_date, to_transaction_date, include_historic, tax_lot_id, include_unsettled_movements, limit, as_at, page, **kwargs) # noqa: E501
|
4624
4624
|
|
4625
4625
|
@validate_arguments
|
4626
|
-
def get_multiple_holding_contributors_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
4626
|
+
def get_multiple_holding_contributors_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], holding_ids_request : Annotated[HoldingIdsRequest, Field(..., description="The array of unique holding identifiers")], effective_date : Annotated[Optional[StrictStr], Field( description="Effective date")] = None, from_transaction_date : Annotated[Optional[StrictStr], Field( description="The from trade date, defaults to first time this holding is opened, lower bound for transactions")] = None, to_transaction_date : Annotated[Optional[StrictStr], Field( description="The to trade date upper bound date, defaults to effectiveDate. upper bound for transactions")] = None, include_historic : Annotated[Optional[StrictBool], Field(description="If true, transactions from previously closed holdings are returned. If false, only transactions from last time position is opened.")] = None, tax_lot_id : Annotated[Optional[StrictStr], Field( description="Constrains the Holding Contributors to those which contributed to the specified tax lot.")] = None, include_unsettled_movements : Annotated[Optional[StrictBool], Field(description="If true, contributing transaction which have not settled yet will also be returned. False by default")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing transactions from a previous call to GetHoldingContributors.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
4627
4627
|
"""GetMultipleHoldingContributors: Get Multiple Holding Contributors # noqa: E501
|
4628
4628
|
|
4629
|
-
Lists all transactions that affect multiple specified holdings of a portfolio over a given effective interval. This includes
|
4629
|
+
Lists all transactions that affect multiple specified holdings of a portfolio over a given effective interval. This includes transactions automatically generated by LUSID such as holding adjustments. # noqa: E501
|
4630
4630
|
This method makes a synchronous HTTP request by default. To make an
|
4631
4631
|
asynchronous HTTP request, please pass async_req=True
|
4632
4632
|
|
@@ -4635,7 +4635,7 @@ class TransactionPortfoliosApi:
|
|
4635
4635
|
|
4636
4636
|
:param scope: The scope of the transaction portfolio. (required)
|
4637
4637
|
:type scope: str
|
4638
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
4638
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
4639
4639
|
:type code: str
|
4640
4640
|
:param holding_ids_request: The array of unique holding identifiers (required)
|
4641
4641
|
:type holding_ids_request: HoldingIdsRequest
|
@@ -4645,7 +4645,7 @@ class TransactionPortfoliosApi:
|
|
4645
4645
|
:type from_transaction_date: str
|
4646
4646
|
:param to_transaction_date: The to trade date upper bound date, defaults to effectiveDate. upper bound for transactions
|
4647
4647
|
:type to_transaction_date: str
|
4648
|
-
:param include_historic: If true, transactions from previously closed holdings are returned.
|
4648
|
+
:param include_historic: If true, transactions from previously closed holdings are returned. If false, only transactions from last time position is opened.
|
4649
4649
|
:type include_historic: bool
|
4650
4650
|
:param tax_lot_id: Constrains the Holding Contributors to those which contributed to the specified tax lot.
|
4651
4651
|
:type tax_lot_id: str
|
@@ -4653,7 +4653,7 @@ class TransactionPortfoliosApi:
|
|
4653
4653
|
:type include_unsettled_movements: bool
|
4654
4654
|
:param limit: When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
|
4655
4655
|
:type limit: int
|
4656
|
-
:param as_at: The asAt datetime at which to build the transactions. Defaults to return the latest
|
4656
|
+
:param as_at: The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified.
|
4657
4657
|
:type as_at: datetime
|
4658
4658
|
:param page: The pagination token to use to continue listing transactions from a previous call to GetHoldingContributors.
|
4659
4659
|
:type page: str
|
@@ -4812,18 +4812,18 @@ class TransactionPortfoliosApi:
|
|
4812
4812
|
|
4813
4813
|
|
4814
4814
|
@overload
|
4815
|
-
async def get_portfolio_cash_flows(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this
|
4815
|
+
async def get_portfolio_cash_flows(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows. This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up. For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt is before the start of the range they are forward looking and will be expectations assuming the model supports that. There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today.")] = None, window_start : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. There is no lower bound if this is not specified. i.e. it is the minimum date.")] = None, window_end : Annotated[Optional[StrictStr], Field( description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. The upper bound defaults to 'max date' if it is not specified")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the data. Defaults to returning the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeID")] = None, exclude_unsettled_trades : Annotated[Optional[StrictBool], Field(description="If absent or set to false, cashflows will returned based on trade date - more specifically, cashflows from any unsettled trades will be included in the results. If set to true, unsettled trades will be excluded from the result set.")] = None, **kwargs) -> ResourceListOfInstrumentCashFlow: # noqa: E501
|
4816
4816
|
...
|
4817
4817
|
|
4818
4818
|
@overload
|
4819
|
-
def get_portfolio_cash_flows(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this
|
4819
|
+
def get_portfolio_cash_flows(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows. This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up. For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt is before the start of the range they are forward looking and will be expectations assuming the model supports that. There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today.")] = None, window_start : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. There is no lower bound if this is not specified. i.e. it is the minimum date.")] = None, window_end : Annotated[Optional[StrictStr], Field( description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. The upper bound defaults to 'max date' if it is not specified")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the data. Defaults to returning the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeID")] = None, exclude_unsettled_trades : Annotated[Optional[StrictBool], Field(description="If absent or set to false, cashflows will returned based on trade date - more specifically, cashflows from any unsettled trades will be included in the results. If set to true, unsettled trades will be excluded from the result set.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfInstrumentCashFlow: # noqa: E501
|
4820
4820
|
...
|
4821
4821
|
|
4822
4822
|
@validate_arguments
|
4823
|
-
def get_portfolio_cash_flows(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this
|
4823
|
+
def get_portfolio_cash_flows(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows. This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up. For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt is before the start of the range they are forward looking and will be expectations assuming the model supports that. There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today.")] = None, window_start : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. There is no lower bound if this is not specified. i.e. it is the minimum date.")] = None, window_end : Annotated[Optional[StrictStr], Field( description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. The upper bound defaults to 'max date' if it is not specified")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the data. Defaults to returning the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeID")] = None, exclude_unsettled_trades : Annotated[Optional[StrictBool], Field(description="If absent or set to false, cashflows will returned based on trade date - more specifically, cashflows from any unsettled trades will be included in the results. If set to true, unsettled trades will be excluded from the result set.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfInstrumentCashFlow, Awaitable[ResourceListOfInstrumentCashFlow]]: # noqa: E501
|
4824
4824
|
"""GetPortfolioCashFlows: Get portfolio cash flows # noqa: E501
|
4825
4825
|
|
4826
|
-
Get the set of cash flows that occur in a window for the transaction portfolio's instruments.
|
4826
|
+
Get the set of cash flows that occur in a window for the transaction portfolio's instruments. Note that grouping can affect the quantity of information returned; where a holding is an amalgamation of one or more (e.g. cash) instruments, a unique transaction identifier will not be available. The same may go for diagnostic information (e.g. multiple sources of an aggregate cash amount on a date that is not split out. Grouping at the transaction and instrument level is recommended for those seeking to attribute individual flows. # noqa: E501
|
4827
4827
|
This method makes a synchronous HTTP request by default. To make an
|
4828
4828
|
asynchronous HTTP request, please pass async_req=True
|
4829
4829
|
|
@@ -4832,17 +4832,17 @@ class TransactionPortfoliosApi:
|
|
4832
4832
|
|
4833
4833
|
:param scope: The scope of the transaction portfolio. (required)
|
4834
4834
|
:type scope: str
|
4835
|
-
:param code: The code of the transaction portfolio. Together with the scope this
|
4835
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio. (required)
|
4836
4836
|
:type code: str
|
4837
|
-
:param effective_at: The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows.
|
4837
|
+
:param effective_at: The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows. This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up. For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt is before the start of the range they are forward looking and will be expectations assuming the model supports that. There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today.
|
4838
4838
|
:type effective_at: str
|
4839
|
-
:param window_start: The lower bound effective datetime or cut label (inclusive) from which to retrieve the cashflows.
|
4839
|
+
:param window_start: The lower bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. There is no lower bound if this is not specified. i.e. it is the minimum date.
|
4840
4840
|
:type window_start: str
|
4841
|
-
:param window_end: The upper bound effective datetime or cut label (inclusive) from which to retrieve the cashflows.
|
4841
|
+
:param window_end: The upper bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. The upper bound defaults to 'max date' if it is not specified
|
4842
4842
|
:type window_end: str
|
4843
|
-
:param as_at: The asAt datetime at which to retrieve the data. Defaults to returning the latest version
|
4843
|
+
:param as_at: The asAt datetime at which to retrieve the data. Defaults to returning the latest version of each transaction if not specified.
|
4844
4844
|
:type as_at: datetime
|
4845
|
-
:param filter: Expression to filter the result set.
|
4845
|
+
:param filter: Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
4846
4846
|
:type filter: str
|
4847
4847
|
:param recipe_id_scope: The scope of the given recipeId
|
4848
4848
|
:type recipe_id_scope: str
|
@@ -4869,10 +4869,10 @@ class TransactionPortfoliosApi:
|
|
4869
4869
|
return self.get_portfolio_cash_flows_with_http_info(scope, code, effective_at, window_start, window_end, as_at, filter, recipe_id_scope, recipe_id_code, exclude_unsettled_trades, **kwargs) # noqa: E501
|
4870
4870
|
|
4871
4871
|
@validate_arguments
|
4872
|
-
def get_portfolio_cash_flows_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this
|
4872
|
+
def get_portfolio_cash_flows_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows. This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up. For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt is before the start of the range they are forward looking and will be expectations assuming the model supports that. There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today.")] = None, window_start : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. There is no lower bound if this is not specified. i.e. it is the minimum date.")] = None, window_end : Annotated[Optional[StrictStr], Field( description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. The upper bound defaults to 'max date' if it is not specified")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the data. Defaults to returning the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeID")] = None, exclude_unsettled_trades : Annotated[Optional[StrictBool], Field(description="If absent or set to false, cashflows will returned based on trade date - more specifically, cashflows from any unsettled trades will be included in the results. If set to true, unsettled trades will be excluded from the result set.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
4873
4873
|
"""GetPortfolioCashFlows: Get portfolio cash flows # noqa: E501
|
4874
4874
|
|
4875
|
-
Get the set of cash flows that occur in a window for the transaction portfolio's instruments.
|
4875
|
+
Get the set of cash flows that occur in a window for the transaction portfolio's instruments. Note that grouping can affect the quantity of information returned; where a holding is an amalgamation of one or more (e.g. cash) instruments, a unique transaction identifier will not be available. The same may go for diagnostic information (e.g. multiple sources of an aggregate cash amount on a date that is not split out. Grouping at the transaction and instrument level is recommended for those seeking to attribute individual flows. # noqa: E501
|
4876
4876
|
This method makes a synchronous HTTP request by default. To make an
|
4877
4877
|
asynchronous HTTP request, please pass async_req=True
|
4878
4878
|
|
@@ -4881,17 +4881,17 @@ class TransactionPortfoliosApi:
|
|
4881
4881
|
|
4882
4882
|
:param scope: The scope of the transaction portfolio. (required)
|
4883
4883
|
:type scope: str
|
4884
|
-
:param code: The code of the transaction portfolio. Together with the scope this
|
4884
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio. (required)
|
4885
4885
|
:type code: str
|
4886
|
-
:param effective_at: The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows.
|
4886
|
+
:param effective_at: The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows. This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up. For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt is before the start of the range they are forward looking and will be expectations assuming the model supports that. There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today.
|
4887
4887
|
:type effective_at: str
|
4888
|
-
:param window_start: The lower bound effective datetime or cut label (inclusive) from which to retrieve the cashflows.
|
4888
|
+
:param window_start: The lower bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. There is no lower bound if this is not specified. i.e. it is the minimum date.
|
4889
4889
|
:type window_start: str
|
4890
|
-
:param window_end: The upper bound effective datetime or cut label (inclusive) from which to retrieve the cashflows.
|
4890
|
+
:param window_end: The upper bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. The upper bound defaults to 'max date' if it is not specified
|
4891
4891
|
:type window_end: str
|
4892
|
-
:param as_at: The asAt datetime at which to retrieve the data. Defaults to returning the latest version
|
4892
|
+
:param as_at: The asAt datetime at which to retrieve the data. Defaults to returning the latest version of each transaction if not specified.
|
4893
4893
|
:type as_at: datetime
|
4894
|
-
:param filter: Expression to filter the result set.
|
4894
|
+
:param filter: Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
4895
4895
|
:type filter: str
|
4896
4896
|
:param recipe_id_scope: The scope of the given recipeId
|
4897
4897
|
:type recipe_id_scope: str
|
@@ -5039,15 +5039,15 @@ class TransactionPortfoliosApi:
|
|
5039
5039
|
|
5040
5040
|
|
5041
5041
|
@overload
|
5042
|
-
async def get_portfolio_cash_ladder(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this
|
5042
|
+
async def get_portfolio_cash_ladder(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.")], from_effective_at : Annotated[StrictStr, Field(..., description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.")], to_effective_at : Annotated[StrictStr, Field(..., description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.")], effective_at : Annotated[StrictStr, Field(..., description="The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows. This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up. For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt is before the start of the range they are forward looking and will be expectations assuming the model supports that. There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio. Defaults to returning the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeID")] = None, exclude_unsettled_trades : Annotated[Optional[StrictBool], Field(description="If absent or set to false, cashflows will returned based on trade date - more specifically, cashflows from any unsettled trades will be included in the results. If set to true, unsettled trades will be excluded from the result set.")] = None, **kwargs) -> ResourceListOfPortfolioCashLadder: # noqa: E501
|
5043
5043
|
...
|
5044
5044
|
|
5045
5045
|
@overload
|
5046
|
-
def get_portfolio_cash_ladder(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this
|
5046
|
+
def get_portfolio_cash_ladder(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.")], from_effective_at : Annotated[StrictStr, Field(..., description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.")], to_effective_at : Annotated[StrictStr, Field(..., description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.")], effective_at : Annotated[StrictStr, Field(..., description="The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows. This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up. For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt is before the start of the range they are forward looking and will be expectations assuming the model supports that. There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio. Defaults to returning the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeID")] = None, exclude_unsettled_trades : Annotated[Optional[StrictBool], Field(description="If absent or set to false, cashflows will returned based on trade date - more specifically, cashflows from any unsettled trades will be included in the results. If set to true, unsettled trades will be excluded from the result set.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfPortfolioCashLadder: # noqa: E501
|
5047
5047
|
...
|
5048
5048
|
|
5049
5049
|
@validate_arguments
|
5050
|
-
def get_portfolio_cash_ladder(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this
|
5050
|
+
def get_portfolio_cash_ladder(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.")], from_effective_at : Annotated[StrictStr, Field(..., description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.")], to_effective_at : Annotated[StrictStr, Field(..., description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.")], effective_at : Annotated[StrictStr, Field(..., description="The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows. This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up. For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt is before the start of the range they are forward looking and will be expectations assuming the model supports that. There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio. Defaults to returning the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeID")] = None, exclude_unsettled_trades : Annotated[Optional[StrictBool], Field(description="If absent or set to false, cashflows will returned based on trade date - more specifically, cashflows from any unsettled trades will be included in the results. If set to true, unsettled trades will be excluded from the result set.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfPortfolioCashLadder, Awaitable[ResourceListOfPortfolioCashLadder]]: # noqa: E501
|
5051
5051
|
"""GetPortfolioCashLadder: Get portfolio cash ladder # noqa: E501
|
5052
5052
|
|
5053
5053
|
Get a cash ladder for a transaction portfolio. # noqa: E501
|
@@ -5059,17 +5059,17 @@ class TransactionPortfoliosApi:
|
|
5059
5059
|
|
5060
5060
|
:param scope: The scope of the transaction portfolio. (required)
|
5061
5061
|
:type scope: str
|
5062
|
-
:param code: The code of the transaction portfolio. Together with the scope this
|
5062
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio. (required)
|
5063
5063
|
:type code: str
|
5064
|
-
:param from_effective_at: The lower bound effective datetime or cut label (inclusive) from which to retrieve the data.
|
5064
|
+
:param from_effective_at: The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified. (required)
|
5065
5065
|
:type from_effective_at: str
|
5066
|
-
:param to_effective_at: The upper bound effective datetime or cut label (inclusive) from which to retrieve the data.
|
5066
|
+
:param to_effective_at: The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified. (required)
|
5067
5067
|
:type to_effective_at: str
|
5068
|
-
:param effective_at: The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows.
|
5068
|
+
:param effective_at: The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows. This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up. For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt is before the start of the range they are forward looking and will be expectations assuming the model supports that. There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today. (required)
|
5069
5069
|
:type effective_at: str
|
5070
|
-
:param as_at: The asAt datetime at which to retrieve the portfolio. Defaults to returning the latest version
|
5070
|
+
:param as_at: The asAt datetime at which to retrieve the portfolio. Defaults to returning the latest version of each transaction if not specified.
|
5071
5071
|
:type as_at: datetime
|
5072
|
-
:param filter: Expression to filter the result set.
|
5072
|
+
:param filter: Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
5073
5073
|
:type filter: str
|
5074
5074
|
:param recipe_id_scope: The scope of the given recipeId
|
5075
5075
|
:type recipe_id_scope: str
|
@@ -5096,7 +5096,7 @@ class TransactionPortfoliosApi:
|
|
5096
5096
|
return self.get_portfolio_cash_ladder_with_http_info(scope, code, from_effective_at, to_effective_at, effective_at, as_at, filter, recipe_id_scope, recipe_id_code, exclude_unsettled_trades, **kwargs) # noqa: E501
|
5097
5097
|
|
5098
5098
|
@validate_arguments
|
5099
|
-
def get_portfolio_cash_ladder_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this
|
5099
|
+
def get_portfolio_cash_ladder_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.")], from_effective_at : Annotated[StrictStr, Field(..., description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.")], to_effective_at : Annotated[StrictStr, Field(..., description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.")], effective_at : Annotated[StrictStr, Field(..., description="The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows. This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up. For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt is before the start of the range they are forward looking and will be expectations assuming the model supports that. There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio. Defaults to returning the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeID")] = None, exclude_unsettled_trades : Annotated[Optional[StrictBool], Field(description="If absent or set to false, cashflows will returned based on trade date - more specifically, cashflows from any unsettled trades will be included in the results. If set to true, unsettled trades will be excluded from the result set.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
5100
5100
|
"""GetPortfolioCashLadder: Get portfolio cash ladder # noqa: E501
|
5101
5101
|
|
5102
5102
|
Get a cash ladder for a transaction portfolio. # noqa: E501
|
@@ -5108,17 +5108,17 @@ class TransactionPortfoliosApi:
|
|
5108
5108
|
|
5109
5109
|
:param scope: The scope of the transaction portfolio. (required)
|
5110
5110
|
:type scope: str
|
5111
|
-
:param code: The code of the transaction portfolio. Together with the scope this
|
5111
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio. (required)
|
5112
5112
|
:type code: str
|
5113
|
-
:param from_effective_at: The lower bound effective datetime or cut label (inclusive) from which to retrieve the data.
|
5113
|
+
:param from_effective_at: The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified. (required)
|
5114
5114
|
:type from_effective_at: str
|
5115
|
-
:param to_effective_at: The upper bound effective datetime or cut label (inclusive) from which to retrieve the data.
|
5115
|
+
:param to_effective_at: The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified. (required)
|
5116
5116
|
:type to_effective_at: str
|
5117
|
-
:param effective_at: The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows.
|
5117
|
+
:param effective_at: The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows. This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up. For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt is before the start of the range they are forward looking and will be expectations assuming the model supports that. There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today. (required)
|
5118
5118
|
:type effective_at: str
|
5119
|
-
:param as_at: The asAt datetime at which to retrieve the portfolio. Defaults to returning the latest version
|
5119
|
+
:param as_at: The asAt datetime at which to retrieve the portfolio. Defaults to returning the latest version of each transaction if not specified.
|
5120
5120
|
:type as_at: datetime
|
5121
|
-
:param filter: Expression to filter the result set.
|
5121
|
+
:param filter: Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
5122
5122
|
:type filter: str
|
5123
5123
|
:param recipe_id_scope: The scope of the given recipeId
|
5124
5124
|
:type recipe_id_scope: str
|
@@ -5266,15 +5266,15 @@ class TransactionPortfoliosApi:
|
|
5266
5266
|
|
5267
5267
|
|
5268
5268
|
@overload
|
5269
|
-
async def get_portfolio_cash_statement(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this
|
5269
|
+
async def get_portfolio_cash_statement(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.")], from_effective_at : Annotated[StrictStr, Field(..., description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.")], to_effective_at : Annotated[StrictStr, Field(..., description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio. Defaults to returning the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeID")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto the cash flows' transactions. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Transaction/strategy/quantsignal\".")] = None, **kwargs) -> ResourceListOfPortfolioCashFlow: # noqa: E501
|
5270
5270
|
...
|
5271
5271
|
|
5272
5272
|
@overload
|
5273
|
-
def get_portfolio_cash_statement(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this
|
5273
|
+
def get_portfolio_cash_statement(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.")], from_effective_at : Annotated[StrictStr, Field(..., description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.")], to_effective_at : Annotated[StrictStr, Field(..., description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio. Defaults to returning the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeID")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto the cash flows' transactions. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Transaction/strategy/quantsignal\".")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfPortfolioCashFlow: # noqa: E501
|
5274
5274
|
...
|
5275
5275
|
|
5276
5276
|
@validate_arguments
|
5277
|
-
def get_portfolio_cash_statement(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this
|
5277
|
+
def get_portfolio_cash_statement(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.")], from_effective_at : Annotated[StrictStr, Field(..., description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.")], to_effective_at : Annotated[StrictStr, Field(..., description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio. Defaults to returning the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeID")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto the cash flows' transactions. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Transaction/strategy/quantsignal\".")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfPortfolioCashFlow, Awaitable[ResourceListOfPortfolioCashFlow]]: # noqa: E501
|
5278
5278
|
"""GetPortfolioCashStatement: Get portfolio cash statement # noqa: E501
|
5279
5279
|
|
5280
5280
|
Get a cash statement for a transaction portfolio. # noqa: E501
|
@@ -5286,21 +5286,21 @@ class TransactionPortfoliosApi:
|
|
5286
5286
|
|
5287
5287
|
:param scope: The scope of the transaction portfolio. (required)
|
5288
5288
|
:type scope: str
|
5289
|
-
:param code: The code of the transaction portfolio. Together with the scope this
|
5289
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio. (required)
|
5290
5290
|
:type code: str
|
5291
|
-
:param from_effective_at: The lower bound effective datetime or cut label (inclusive) from which to retrieve the data.
|
5291
|
+
:param from_effective_at: The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified. (required)
|
5292
5292
|
:type from_effective_at: str
|
5293
|
-
:param to_effective_at: The upper bound effective datetime or cut label (inclusive) from which to retrieve the data.
|
5293
|
+
:param to_effective_at: The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified. (required)
|
5294
5294
|
:type to_effective_at: str
|
5295
|
-
:param as_at: The asAt datetime at which to retrieve the portfolio. Defaults to returning the latest version
|
5295
|
+
:param as_at: The asAt datetime at which to retrieve the portfolio. Defaults to returning the latest version of each transaction if not specified.
|
5296
5296
|
:type as_at: datetime
|
5297
|
-
:param filter: Expression to filter the result set.
|
5297
|
+
:param filter: Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
5298
5298
|
:type filter: str
|
5299
5299
|
:param recipe_id_scope: The scope of the given recipeId
|
5300
5300
|
:type recipe_id_scope: str
|
5301
5301
|
:param recipe_id_code: The code of the given recipeID
|
5302
5302
|
:type recipe_id_code: str
|
5303
|
-
:param property_keys: A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto
|
5303
|
+
:param property_keys: A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto the cash flows' transactions. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Transaction/strategy/quantsignal\".
|
5304
5304
|
:type property_keys: List[str]
|
5305
5305
|
:param async_req: Whether to execute the request asynchronously.
|
5306
5306
|
:type async_req: bool, optional
|
@@ -5321,7 +5321,7 @@ class TransactionPortfoliosApi:
|
|
5321
5321
|
return self.get_portfolio_cash_statement_with_http_info(scope, code, from_effective_at, to_effective_at, as_at, filter, recipe_id_scope, recipe_id_code, property_keys, **kwargs) # noqa: E501
|
5322
5322
|
|
5323
5323
|
@validate_arguments
|
5324
|
-
def get_portfolio_cash_statement_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this
|
5324
|
+
def get_portfolio_cash_statement_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.")], from_effective_at : Annotated[StrictStr, Field(..., description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.")], to_effective_at : Annotated[StrictStr, Field(..., description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio. Defaults to returning the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeID")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto the cash flows' transactions. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Transaction/strategy/quantsignal\".")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
5325
5325
|
"""GetPortfolioCashStatement: Get portfolio cash statement # noqa: E501
|
5326
5326
|
|
5327
5327
|
Get a cash statement for a transaction portfolio. # noqa: E501
|
@@ -5333,21 +5333,21 @@ class TransactionPortfoliosApi:
|
|
5333
5333
|
|
5334
5334
|
:param scope: The scope of the transaction portfolio. (required)
|
5335
5335
|
:type scope: str
|
5336
|
-
:param code: The code of the transaction portfolio. Together with the scope this
|
5336
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio. (required)
|
5337
5337
|
:type code: str
|
5338
|
-
:param from_effective_at: The lower bound effective datetime or cut label (inclusive) from which to retrieve the data.
|
5338
|
+
:param from_effective_at: The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified. (required)
|
5339
5339
|
:type from_effective_at: str
|
5340
|
-
:param to_effective_at: The upper bound effective datetime or cut label (inclusive) from which to retrieve the data.
|
5340
|
+
:param to_effective_at: The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified. (required)
|
5341
5341
|
:type to_effective_at: str
|
5342
|
-
:param as_at: The asAt datetime at which to retrieve the portfolio. Defaults to returning the latest version
|
5342
|
+
:param as_at: The asAt datetime at which to retrieve the portfolio. Defaults to returning the latest version of each transaction if not specified.
|
5343
5343
|
:type as_at: datetime
|
5344
|
-
:param filter: Expression to filter the result set.
|
5344
|
+
:param filter: Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
5345
5345
|
:type filter: str
|
5346
5346
|
:param recipe_id_scope: The scope of the given recipeId
|
5347
5347
|
:type recipe_id_scope: str
|
5348
5348
|
:param recipe_id_code: The code of the given recipeID
|
5349
5349
|
:type recipe_id_code: str
|
5350
|
-
:param property_keys: A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto
|
5350
|
+
:param property_keys: A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto the cash flows' transactions. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Transaction/strategy/quantsignal\".
|
5351
5351
|
:type property_keys: List[str]
|
5352
5352
|
:param async_req: Whether to execute the request asynchronously.
|
5353
5353
|
:type async_req: bool, optional
|
@@ -5486,15 +5486,15 @@ class TransactionPortfoliosApi:
|
|
5486
5486
|
|
5487
5487
|
|
5488
5488
|
@overload
|
5489
|
-
async def get_transaction_history(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
5489
|
+
async def get_transaction_history(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], transaction_id : Annotated[StrictStr, Field(..., description="The unique ID of the transaction to create or update.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the history of the transaction. Defaults to return the latest version if not specified.")] = None, **kwargs) -> ResourceListOfChangeHistory: # noqa: E501
|
5490
5490
|
...
|
5491
5491
|
|
5492
5492
|
@overload
|
5493
|
-
def get_transaction_history(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
5493
|
+
def get_transaction_history(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], transaction_id : Annotated[StrictStr, Field(..., description="The unique ID of the transaction to create or update.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the history of the transaction. Defaults to return the latest version if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfChangeHistory: # noqa: E501
|
5494
5494
|
...
|
5495
5495
|
|
5496
5496
|
@validate_arguments
|
5497
|
-
def get_transaction_history(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
5497
|
+
def get_transaction_history(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], transaction_id : Annotated[StrictStr, Field(..., description="The unique ID of the transaction to create or update.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the history of the transaction. Defaults to return the latest version if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfChangeHistory, Awaitable[ResourceListOfChangeHistory]]: # noqa: E501
|
5498
5498
|
"""GetTransactionHistory: Get the history of a transaction # noqa: E501
|
5499
5499
|
|
5500
5500
|
Get all of the changes that have happened to a transaction. # noqa: E501
|
@@ -5506,11 +5506,11 @@ class TransactionPortfoliosApi:
|
|
5506
5506
|
|
5507
5507
|
:param scope: The scope of the transaction portfolio. (required)
|
5508
5508
|
:type scope: str
|
5509
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
5509
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
5510
5510
|
:type code: str
|
5511
5511
|
:param transaction_id: The unique ID of the transaction to create or update. (required)
|
5512
5512
|
:type transaction_id: str
|
5513
|
-
:param as_at: The asAt datetime at which to retrieve the history of the transaction. Defaults
|
5513
|
+
:param as_at: The asAt datetime at which to retrieve the history of the transaction. Defaults to return the latest version if not specified.
|
5514
5514
|
:type as_at: datetime
|
5515
5515
|
:param async_req: Whether to execute the request asynchronously.
|
5516
5516
|
:type async_req: bool, optional
|
@@ -5531,7 +5531,7 @@ class TransactionPortfoliosApi:
|
|
5531
5531
|
return self.get_transaction_history_with_http_info(scope, code, transaction_id, as_at, **kwargs) # noqa: E501
|
5532
5532
|
|
5533
5533
|
@validate_arguments
|
5534
|
-
def get_transaction_history_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
5534
|
+
def get_transaction_history_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], transaction_id : Annotated[StrictStr, Field(..., description="The unique ID of the transaction to create or update.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the history of the transaction. Defaults to return the latest version if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
5535
5535
|
"""GetTransactionHistory: Get the history of a transaction # noqa: E501
|
5536
5536
|
|
5537
5537
|
Get all of the changes that have happened to a transaction. # noqa: E501
|
@@ -5543,11 +5543,11 @@ class TransactionPortfoliosApi:
|
|
5543
5543
|
|
5544
5544
|
:param scope: The scope of the transaction portfolio. (required)
|
5545
5545
|
:type scope: str
|
5546
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
5546
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
5547
5547
|
:type code: str
|
5548
5548
|
:param transaction_id: The unique ID of the transaction to create or update. (required)
|
5549
5549
|
:type transaction_id: str
|
5550
|
-
:param as_at: The asAt datetime at which to retrieve the history of the transaction. Defaults
|
5550
|
+
:param as_at: The asAt datetime at which to retrieve the history of the transaction. Defaults to return the latest version if not specified.
|
5551
5551
|
:type as_at: datetime
|
5552
5552
|
:param async_req: Whether to execute the request asynchronously.
|
5553
5553
|
:type async_req: bool, optional
|
@@ -5665,18 +5665,18 @@ class TransactionPortfoliosApi:
|
|
5665
5665
|
|
5666
5666
|
|
5667
5667
|
@overload
|
5668
|
-
async def get_transactions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
5668
|
+
async def get_transactions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], from_transaction_date : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no lower bound if this is not specified.")] = None, to_transaction_date : Annotated[Optional[StrictStr], Field( description="The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no upper bound if this is not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve transactions. Defaults to returning the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression with which to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\" For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument', 'Transaction', \"LegalEntity\" or \"CustodianAccount\" domain to decorate onto transactions. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name' or 'Transaction/strategy/quantsignal'.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing transactions from a previous call to GetTransactions.")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. The current behaviour is to return all transactions if possible, but this will change to defaulting to 1000 if not specified in the future. It is recommended to populate this field to enable pagination.")] = None, show_cancelled_transactions : Annotated[Optional[StrictBool], Field(description="Option to specify whether or not to include cancelled transactions, including previous versions of transactions which have since been amended. Defaults to False if not specified.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, data_model_scope : Annotated[Optional[StrictStr], Field( description="The optional scope of a Custom Data Model to use")] = None, data_model_code : Annotated[Optional[StrictStr], Field( description="The optional code of a Custom Data Model to use")] = None, **kwargs) -> VersionedResourceListOfTransaction: # noqa: E501
|
5669
5669
|
...
|
5670
5670
|
|
5671
5671
|
@overload
|
5672
|
-
def get_transactions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
5672
|
+
def get_transactions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], from_transaction_date : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no lower bound if this is not specified.")] = None, to_transaction_date : Annotated[Optional[StrictStr], Field( description="The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no upper bound if this is not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve transactions. Defaults to returning the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression with which to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\" For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument', 'Transaction', \"LegalEntity\" or \"CustodianAccount\" domain to decorate onto transactions. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name' or 'Transaction/strategy/quantsignal'.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing transactions from a previous call to GetTransactions.")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. The current behaviour is to return all transactions if possible, but this will change to defaulting to 1000 if not specified in the future. It is recommended to populate this field to enable pagination.")] = None, show_cancelled_transactions : Annotated[Optional[StrictBool], Field(description="Option to specify whether or not to include cancelled transactions, including previous versions of transactions which have since been amended. Defaults to False if not specified.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, data_model_scope : Annotated[Optional[StrictStr], Field( description="The optional scope of a Custom Data Model to use")] = None, data_model_code : Annotated[Optional[StrictStr], Field( description="The optional code of a Custom Data Model to use")] = None, async_req: Optional[bool]=True, **kwargs) -> VersionedResourceListOfTransaction: # noqa: E501
|
5673
5673
|
...
|
5674
5674
|
|
5675
5675
|
@validate_arguments
|
5676
|
-
def get_transactions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
5676
|
+
def get_transactions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], from_transaction_date : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no lower bound if this is not specified.")] = None, to_transaction_date : Annotated[Optional[StrictStr], Field( description="The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no upper bound if this is not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve transactions. Defaults to returning the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression with which to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\" For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument', 'Transaction', \"LegalEntity\" or \"CustodianAccount\" domain to decorate onto transactions. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name' or 'Transaction/strategy/quantsignal'.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing transactions from a previous call to GetTransactions.")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. The current behaviour is to return all transactions if possible, but this will change to defaulting to 1000 if not specified in the future. It is recommended to populate this field to enable pagination.")] = None, show_cancelled_transactions : Annotated[Optional[StrictBool], Field(description="Option to specify whether or not to include cancelled transactions, including previous versions of transactions which have since been amended. Defaults to False if not specified.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, data_model_scope : Annotated[Optional[StrictStr], Field( description="The optional scope of a Custom Data Model to use")] = None, data_model_code : Annotated[Optional[StrictStr], Field( description="The optional code of a Custom Data Model to use")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[VersionedResourceListOfTransaction, Awaitable[VersionedResourceListOfTransaction]]: # noqa: E501
|
5677
5677
|
"""GetTransactions: Get transactions # noqa: E501
|
5678
5678
|
|
5679
|
-
Retrieve all the transactions that occurred during a particular time interval.
|
5679
|
+
Retrieve all the transactions that occurred during a particular time interval. If the portfolio is a derived transaction portfolio, the transactions returned are the union set of all transactions of the parent (and any grandparents, etc.) as well as those of the derived transaction portfolio itself. # noqa: E501
|
5680
5680
|
This method makes a synchronous HTTP request by default. To make an
|
5681
5681
|
asynchronous HTTP request, please pass async_req=True
|
5682
5682
|
|
@@ -5685,23 +5685,23 @@ class TransactionPortfoliosApi:
|
|
5685
5685
|
|
5686
5686
|
:param scope: The scope of the transaction portfolio. (required)
|
5687
5687
|
:type scope: str
|
5688
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
5688
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
5689
5689
|
:type code: str
|
5690
|
-
:param from_transaction_date: The lower bound effective datetime or cut label (inclusive) from which to retrieve transactions.
|
5690
|
+
:param from_transaction_date: The lower bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no lower bound if this is not specified.
|
5691
5691
|
:type from_transaction_date: str
|
5692
|
-
:param to_transaction_date: The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions.
|
5692
|
+
:param to_transaction_date: The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no upper bound if this is not specified.
|
5693
5693
|
:type to_transaction_date: str
|
5694
|
-
:param as_at: The asAt datetime at which to retrieve transactions. Defaults to returning the latest version
|
5694
|
+
:param as_at: The asAt datetime at which to retrieve transactions. Defaults to returning the latest version of each transaction if not specified.
|
5695
5695
|
:type as_at: datetime
|
5696
|
-
:param filter: Expression with which to filter the result set.
|
5696
|
+
:param filter: Expression with which to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\" For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
5697
5697
|
:type filter: str
|
5698
|
-
:param property_keys: A list of property keys from the 'Instrument', 'Transaction', \"LegalEntity\" or \"CustodianAccount\" domain to decorate onto
|
5698
|
+
:param property_keys: A list of property keys from the 'Instrument', 'Transaction', \"LegalEntity\" or \"CustodianAccount\" domain to decorate onto transactions. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name' or 'Transaction/strategy/quantsignal'.
|
5699
5699
|
:type property_keys: List[str]
|
5700
5700
|
:param page: The pagination token to use to continue listing transactions from a previous call to GetTransactions.
|
5701
5701
|
:type page: str
|
5702
|
-
:param limit: When paginating, limit the number of returned results to this many. The current behaviour is
|
5702
|
+
:param limit: When paginating, limit the number of returned results to this many. The current behaviour is to return all transactions if possible, but this will change to defaulting to 1000 if not specified in the future. It is recommended to populate this field to enable pagination.
|
5703
5703
|
:type limit: int
|
5704
|
-
:param show_cancelled_transactions: Option to specify whether or not to include cancelled transactions,
|
5704
|
+
:param show_cancelled_transactions: Option to specify whether or not to include cancelled transactions, including previous versions of transactions which have since been amended. Defaults to False if not specified.
|
5705
5705
|
:type show_cancelled_transactions: bool
|
5706
5706
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
5707
5707
|
:type sort_by: List[str]
|
@@ -5728,10 +5728,10 @@ class TransactionPortfoliosApi:
|
|
5728
5728
|
return self.get_transactions_with_http_info(scope, code, from_transaction_date, to_transaction_date, as_at, filter, property_keys, page, limit, show_cancelled_transactions, sort_by, data_model_scope, data_model_code, **kwargs) # noqa: E501
|
5729
5729
|
|
5730
5730
|
@validate_arguments
|
5731
|
-
def get_transactions_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
5731
|
+
def get_transactions_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], from_transaction_date : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no lower bound if this is not specified.")] = None, to_transaction_date : Annotated[Optional[StrictStr], Field( description="The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no upper bound if this is not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve transactions. Defaults to returning the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression with which to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\" For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument', 'Transaction', \"LegalEntity\" or \"CustodianAccount\" domain to decorate onto transactions. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name' or 'Transaction/strategy/quantsignal'.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing transactions from a previous call to GetTransactions.")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. The current behaviour is to return all transactions if possible, but this will change to defaulting to 1000 if not specified in the future. It is recommended to populate this field to enable pagination.")] = None, show_cancelled_transactions : Annotated[Optional[StrictBool], Field(description="Option to specify whether or not to include cancelled transactions, including previous versions of transactions which have since been amended. Defaults to False if not specified.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, data_model_scope : Annotated[Optional[StrictStr], Field( description="The optional scope of a Custom Data Model to use")] = None, data_model_code : Annotated[Optional[StrictStr], Field( description="The optional code of a Custom Data Model to use")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
5732
5732
|
"""GetTransactions: Get transactions # noqa: E501
|
5733
5733
|
|
5734
|
-
Retrieve all the transactions that occurred during a particular time interval.
|
5734
|
+
Retrieve all the transactions that occurred during a particular time interval. If the portfolio is a derived transaction portfolio, the transactions returned are the union set of all transactions of the parent (and any grandparents, etc.) as well as those of the derived transaction portfolio itself. # noqa: E501
|
5735
5735
|
This method makes a synchronous HTTP request by default. To make an
|
5736
5736
|
asynchronous HTTP request, please pass async_req=True
|
5737
5737
|
|
@@ -5740,23 +5740,23 @@ class TransactionPortfoliosApi:
|
|
5740
5740
|
|
5741
5741
|
:param scope: The scope of the transaction portfolio. (required)
|
5742
5742
|
:type scope: str
|
5743
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
5743
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
5744
5744
|
:type code: str
|
5745
|
-
:param from_transaction_date: The lower bound effective datetime or cut label (inclusive) from which to retrieve transactions.
|
5745
|
+
:param from_transaction_date: The lower bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no lower bound if this is not specified.
|
5746
5746
|
:type from_transaction_date: str
|
5747
|
-
:param to_transaction_date: The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions.
|
5747
|
+
:param to_transaction_date: The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no upper bound if this is not specified.
|
5748
5748
|
:type to_transaction_date: str
|
5749
|
-
:param as_at: The asAt datetime at which to retrieve transactions. Defaults to returning the latest version
|
5749
|
+
:param as_at: The asAt datetime at which to retrieve transactions. Defaults to returning the latest version of each transaction if not specified.
|
5750
5750
|
:type as_at: datetime
|
5751
|
-
:param filter: Expression with which to filter the result set.
|
5751
|
+
:param filter: Expression with which to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\" For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
5752
5752
|
:type filter: str
|
5753
|
-
:param property_keys: A list of property keys from the 'Instrument', 'Transaction', \"LegalEntity\" or \"CustodianAccount\" domain to decorate onto
|
5753
|
+
:param property_keys: A list of property keys from the 'Instrument', 'Transaction', \"LegalEntity\" or \"CustodianAccount\" domain to decorate onto transactions. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name' or 'Transaction/strategy/quantsignal'.
|
5754
5754
|
:type property_keys: List[str]
|
5755
5755
|
:param page: The pagination token to use to continue listing transactions from a previous call to GetTransactions.
|
5756
5756
|
:type page: str
|
5757
|
-
:param limit: When paginating, limit the number of returned results to this many. The current behaviour is
|
5757
|
+
:param limit: When paginating, limit the number of returned results to this many. The current behaviour is to return all transactions if possible, but this will change to defaulting to 1000 if not specified in the future. It is recommended to populate this field to enable pagination.
|
5758
5758
|
:type limit: int
|
5759
|
-
:param show_cancelled_transactions: Option to specify whether or not to include cancelled transactions,
|
5759
|
+
:param show_cancelled_transactions: Option to specify whether or not to include cancelled transactions, including previous versions of transactions which have since been amended. Defaults to False if not specified.
|
5760
5760
|
:type show_cancelled_transactions: bool
|
5761
5761
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
5762
5762
|
:type sort_by: List[str]
|
@@ -5918,18 +5918,18 @@ class TransactionPortfoliosApi:
|
|
5918
5918
|
|
5919
5919
|
|
5920
5920
|
@overload
|
5921
|
-
async def get_upsertable_portfolio_cash_flows(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this
|
5921
|
+
async def get_upsertable_portfolio_cash_flows(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows. This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up. For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt is before the start of the range they are forward looking and will be expectations assuming the model supports that. There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today.")] = None, window_start : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. There is no lower bound if this is not specified. i.e. uses minimum date-time")] = None, window_end : Annotated[Optional[StrictStr], Field( description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. The upper bound defaults to 'max date' if it is not specified")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeID")] = None, exclude_unsettled_trades : Annotated[Optional[StrictBool], Field(description="If absent or set to true, unsettled trades will be excluded from the result set. If set to false, cashflows will returned based on trade date - more specifically, cashflows from any unsettled trades will be included in the results.")] = None, **kwargs) -> ResourceListOfTransaction: # noqa: E501
|
5922
5922
|
...
|
5923
5923
|
|
5924
5924
|
@overload
|
5925
|
-
def get_upsertable_portfolio_cash_flows(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this
|
5925
|
+
def get_upsertable_portfolio_cash_flows(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows. This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up. For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt is before the start of the range they are forward looking and will be expectations assuming the model supports that. There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today.")] = None, window_start : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. There is no lower bound if this is not specified. i.e. uses minimum date-time")] = None, window_end : Annotated[Optional[StrictStr], Field( description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. The upper bound defaults to 'max date' if it is not specified")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeID")] = None, exclude_unsettled_trades : Annotated[Optional[StrictBool], Field(description="If absent or set to true, unsettled trades will be excluded from the result set. If set to false, cashflows will returned based on trade date - more specifically, cashflows from any unsettled trades will be included in the results.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfTransaction: # noqa: E501
|
5926
5926
|
...
|
5927
5927
|
|
5928
5928
|
@validate_arguments
|
5929
|
-
def get_upsertable_portfolio_cash_flows(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this
|
5929
|
+
def get_upsertable_portfolio_cash_flows(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows. This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up. For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt is before the start of the range they are forward looking and will be expectations assuming the model supports that. There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today.")] = None, window_start : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. There is no lower bound if this is not specified. i.e. uses minimum date-time")] = None, window_end : Annotated[Optional[StrictStr], Field( description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. The upper bound defaults to 'max date' if it is not specified")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeID")] = None, exclude_unsettled_trades : Annotated[Optional[StrictBool], Field(description="If absent or set to true, unsettled trades will be excluded from the result set. If set to false, cashflows will returned based on trade date - more specifically, cashflows from any unsettled trades will be included in the results.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfTransaction, Awaitable[ResourceListOfTransaction]]: # noqa: E501
|
5930
5930
|
"""GetUpsertablePortfolioCashFlows: Get upsertable portfolio cash flows. # noqa: E501
|
5931
5931
|
|
5932
|
-
Get the set of cash flows that occur in a window for the given portfolio instruments as a set of upsertable transactions (DTOs).
|
5932
|
+
Get the set of cash flows that occur in a window for the given portfolio instruments as a set of upsertable transactions (DTOs). Note that grouping can affect the quantity of information returned; where a holding is an amalgamation of one or more (e.g. cash) instruments, a unique transaction identifier will not be available. The same may go for diagnostic information (e.g. multiple sources of an aggregate cash amount on a date that is not split out. Grouping at the transaction and instrument level is recommended for those seeking to attribute individual flows. In essence this is identical to the 'GetCashFlows' endpoint but returns the cash flows as a set of transactions suitable for directly putting back into LUSID. There are a couple of important points: (1) Internally it can not be fully known where the user wishes to insert these transactions, e.g. portfolio and movement type. These are therefore defaulted to a sensible option; the user will likely need to change these. (2) Similarly, knowledge of any properties the user might wish to add to a transaction are unknown and consequently left empty. (3) The transaction id that is added is simply a concatenation of the original transaction id, instrument id and payment date and direction. The user can happily override this. # noqa: E501
|
5933
5933
|
This method makes a synchronous HTTP request by default. To make an
|
5934
5934
|
asynchronous HTTP request, please pass async_req=True
|
5935
5935
|
|
@@ -5938,17 +5938,17 @@ class TransactionPortfoliosApi:
|
|
5938
5938
|
|
5939
5939
|
:param scope: The scope of the transaction portfolio. (required)
|
5940
5940
|
:type scope: str
|
5941
|
-
:param code: The code of the transaction portfolio. Together with the scope this
|
5941
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio. (required)
|
5942
5942
|
:type code: str
|
5943
|
-
:param effective_at: The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows.
|
5943
|
+
:param effective_at: The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows. This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up. For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt is before the start of the range they are forward looking and will be expectations assuming the model supports that. There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today.
|
5944
5944
|
:type effective_at: str
|
5945
|
-
:param window_start: The lower bound effective datetime or cut label (inclusive) from which to retrieve the cashflows.
|
5945
|
+
:param window_start: The lower bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. There is no lower bound if this is not specified. i.e. uses minimum date-time
|
5946
5946
|
:type window_start: str
|
5947
|
-
:param window_end: The upper bound effective datetime or cut label (inclusive) from which to retrieve the cashflows.
|
5947
|
+
:param window_end: The upper bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. The upper bound defaults to 'max date' if it is not specified
|
5948
5948
|
:type window_end: str
|
5949
|
-
:param as_at: The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version
|
5949
|
+
:param as_at: The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified.
|
5950
5950
|
:type as_at: datetime
|
5951
|
-
:param filter: Expression to filter the result set.
|
5951
|
+
:param filter: Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
5952
5952
|
:type filter: str
|
5953
5953
|
:param recipe_id_scope: The scope of the given recipeId
|
5954
5954
|
:type recipe_id_scope: str
|
@@ -5975,10 +5975,10 @@ class TransactionPortfoliosApi:
|
|
5975
5975
|
return self.get_upsertable_portfolio_cash_flows_with_http_info(scope, code, effective_at, window_start, window_end, as_at, filter, recipe_id_scope, recipe_id_code, exclude_unsettled_trades, **kwargs) # noqa: E501
|
5976
5976
|
|
5977
5977
|
@validate_arguments
|
5978
|
-
def get_upsertable_portfolio_cash_flows_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this
|
5978
|
+
def get_upsertable_portfolio_cash_flows_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows. This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up. For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt is before the start of the range they are forward looking and will be expectations assuming the model supports that. There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today.")] = None, window_start : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. There is no lower bound if this is not specified. i.e. uses minimum date-time")] = None, window_end : Annotated[Optional[StrictStr], Field( description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. The upper bound defaults to 'max date' if it is not specified")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeID")] = None, exclude_unsettled_trades : Annotated[Optional[StrictBool], Field(description="If absent or set to true, unsettled trades will be excluded from the result set. If set to false, cashflows will returned based on trade date - more specifically, cashflows from any unsettled trades will be included in the results.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
5979
5979
|
"""GetUpsertablePortfolioCashFlows: Get upsertable portfolio cash flows. # noqa: E501
|
5980
5980
|
|
5981
|
-
Get the set of cash flows that occur in a window for the given portfolio instruments as a set of upsertable transactions (DTOs).
|
5981
|
+
Get the set of cash flows that occur in a window for the given portfolio instruments as a set of upsertable transactions (DTOs). Note that grouping can affect the quantity of information returned; where a holding is an amalgamation of one or more (e.g. cash) instruments, a unique transaction identifier will not be available. The same may go for diagnostic information (e.g. multiple sources of an aggregate cash amount on a date that is not split out. Grouping at the transaction and instrument level is recommended for those seeking to attribute individual flows. In essence this is identical to the 'GetCashFlows' endpoint but returns the cash flows as a set of transactions suitable for directly putting back into LUSID. There are a couple of important points: (1) Internally it can not be fully known where the user wishes to insert these transactions, e.g. portfolio and movement type. These are therefore defaulted to a sensible option; the user will likely need to change these. (2) Similarly, knowledge of any properties the user might wish to add to a transaction are unknown and consequently left empty. (3) The transaction id that is added is simply a concatenation of the original transaction id, instrument id and payment date and direction. The user can happily override this. # noqa: E501
|
5982
5982
|
This method makes a synchronous HTTP request by default. To make an
|
5983
5983
|
asynchronous HTTP request, please pass async_req=True
|
5984
5984
|
|
@@ -5987,17 +5987,17 @@ class TransactionPortfoliosApi:
|
|
5987
5987
|
|
5988
5988
|
:param scope: The scope of the transaction portfolio. (required)
|
5989
5989
|
:type scope: str
|
5990
|
-
:param code: The code of the transaction portfolio. Together with the scope this
|
5990
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio. (required)
|
5991
5991
|
:type code: str
|
5992
|
-
:param effective_at: The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows.
|
5992
|
+
:param effective_at: The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows. This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up. For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt is before the start of the range they are forward looking and will be expectations assuming the model supports that. There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today.
|
5993
5993
|
:type effective_at: str
|
5994
|
-
:param window_start: The lower bound effective datetime or cut label (inclusive) from which to retrieve the cashflows.
|
5994
|
+
:param window_start: The lower bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. There is no lower bound if this is not specified. i.e. uses minimum date-time
|
5995
5995
|
:type window_start: str
|
5996
|
-
:param window_end: The upper bound effective datetime or cut label (inclusive) from which to retrieve the cashflows.
|
5996
|
+
:param window_end: The upper bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. The upper bound defaults to 'max date' if it is not specified
|
5997
5997
|
:type window_end: str
|
5998
|
-
:param as_at: The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version
|
5998
|
+
:param as_at: The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified.
|
5999
5999
|
:type as_at: datetime
|
6000
|
-
:param filter: Expression to filter the result set.
|
6000
|
+
:param filter: Expression to filter the result set. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
6001
6001
|
:type filter: str
|
6002
6002
|
:param recipe_id_scope: The scope of the given recipeId
|
6003
6003
|
:type recipe_id_scope: str
|
@@ -6145,15 +6145,15 @@ class TransactionPortfoliosApi:
|
|
6145
6145
|
|
6146
6146
|
|
6147
6147
|
@overload
|
6148
|
-
async def list_custodian_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolio. Together with the scope this uniquely identifies
|
6148
|
+
async def list_custodian_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolio. Together with the scope this uniquely identifies the Transaction Portfolios.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the TimeVariant properties decorated on Custodian Accounts. 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 instrument. Defaults to returning the latest version if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing custodian accounts; 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, 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. For example, to filter on the Custodian Account type, specify \"code eq '001'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'CustodianAccount' domain to decorate onto the Custodian Account. These must have the format {domain}/{scope}/{code}, for example 'CustodianAccount/system/Name'.")] = None, **kwargs) -> PagedResourceListOfCustodianAccount: # noqa: E501
|
6149
6149
|
...
|
6150
6150
|
|
6151
6151
|
@overload
|
6152
|
-
def list_custodian_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolio. Together with the scope this uniquely identifies
|
6152
|
+
def list_custodian_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolio. Together with the scope this uniquely identifies the Transaction Portfolios.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the TimeVariant properties decorated on Custodian Accounts. 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 instrument. Defaults to returning the latest version if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing custodian accounts; 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, 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. For example, to filter on the Custodian Account type, specify \"code eq '001'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'CustodianAccount' domain to decorate onto the Custodian Account. These must have the format {domain}/{scope}/{code}, for example 'CustodianAccount/system/Name'.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfCustodianAccount: # noqa: E501
|
6153
6153
|
...
|
6154
6154
|
|
6155
6155
|
@validate_arguments
|
6156
|
-
def list_custodian_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolio. Together with the scope this uniquely identifies
|
6156
|
+
def list_custodian_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolio. Together with the scope this uniquely identifies the Transaction Portfolios.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the TimeVariant properties decorated on Custodian Accounts. 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 instrument. Defaults to returning the latest version if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing custodian accounts; 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, 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. For example, to filter on the Custodian Account type, specify \"code eq '001'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'CustodianAccount' domain to decorate onto the Custodian Account. These must have the format {domain}/{scope}/{code}, for example 'CustodianAccount/system/Name'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfCustodianAccount, Awaitable[PagedResourceListOfCustodianAccount]]: # noqa: E501
|
6157
6157
|
"""ListCustodianAccounts: List Custodian Accounts # noqa: E501
|
6158
6158
|
|
6159
6159
|
List the custodian accounts in a Transaction Portfolios # noqa: E501
|
@@ -6165,19 +6165,19 @@ class TransactionPortfoliosApi:
|
|
6165
6165
|
|
6166
6166
|
:param scope: The scope of the Transaction Portfolio. (required)
|
6167
6167
|
:type scope: str
|
6168
|
-
:param code: The code of the Transaction Portfolio. Together with the scope this uniquely identifies
|
6168
|
+
:param code: The code of the Transaction Portfolio. Together with the scope this uniquely identifies the Transaction Portfolios. (required)
|
6169
6169
|
:type code: str
|
6170
|
-
:param effective_at: The effective datetime or cut label at which to list the TimeVariant properties decorated on Custodian Accounts. Defaults to the current LUSID
|
6170
|
+
:param effective_at: The effective datetime or cut label at which to list the TimeVariant properties decorated on Custodian Accounts. Defaults to the current LUSID system datetime if not specified.
|
6171
6171
|
:type effective_at: str
|
6172
|
-
:param as_at: The asAt datetime at which to retrieve the instrument. Defaults to
|
6172
|
+
:param as_at: The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.
|
6173
6173
|
:type as_at: datetime
|
6174
|
-
:param page: The pagination token to use to continue listing custodian accounts; this
|
6174
|
+
:param page: The pagination token to use to continue listing custodian accounts; 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.
|
6175
6175
|
:type page: str
|
6176
6176
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
6177
6177
|
:type limit: int
|
6178
|
-
:param filter: Expression to filter the results.
|
6178
|
+
:param filter: Expression to filter the results. For example, to filter on the Custodian Account type, specify \"code eq '001'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
6179
6179
|
:type filter: str
|
6180
|
-
:param property_keys: A list of property keys from the 'CustodianAccount' domain to decorate onto the Custodian Account.
|
6180
|
+
:param property_keys: A list of property keys from the 'CustodianAccount' domain to decorate onto the Custodian Account. These must have the format {domain}/{scope}/{code}, for example 'CustodianAccount/system/Name'.
|
6181
6181
|
:type property_keys: List[str]
|
6182
6182
|
:param async_req: Whether to execute the request asynchronously.
|
6183
6183
|
:type async_req: bool, optional
|
@@ -6198,7 +6198,7 @@ class TransactionPortfoliosApi:
|
|
6198
6198
|
return self.list_custodian_accounts_with_http_info(scope, code, effective_at, as_at, page, limit, filter, property_keys, **kwargs) # noqa: E501
|
6199
6199
|
|
6200
6200
|
@validate_arguments
|
6201
|
-
def list_custodian_accounts_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolio. Together with the scope this uniquely identifies
|
6201
|
+
def list_custodian_accounts_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolio. Together with the scope this uniquely identifies the Transaction Portfolios.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the TimeVariant properties decorated on Custodian Accounts. 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 instrument. Defaults to returning the latest version if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing custodian accounts; 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, 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. For example, to filter on the Custodian Account type, specify \"code eq '001'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'CustodianAccount' domain to decorate onto the Custodian Account. These must have the format {domain}/{scope}/{code}, for example 'CustodianAccount/system/Name'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
6202
6202
|
"""ListCustodianAccounts: List Custodian Accounts # noqa: E501
|
6203
6203
|
|
6204
6204
|
List the custodian accounts in a Transaction Portfolios # noqa: E501
|
@@ -6210,19 +6210,19 @@ class TransactionPortfoliosApi:
|
|
6210
6210
|
|
6211
6211
|
:param scope: The scope of the Transaction Portfolio. (required)
|
6212
6212
|
:type scope: str
|
6213
|
-
:param code: The code of the Transaction Portfolio. Together with the scope this uniquely identifies
|
6213
|
+
:param code: The code of the Transaction Portfolio. Together with the scope this uniquely identifies the Transaction Portfolios. (required)
|
6214
6214
|
:type code: str
|
6215
|
-
:param effective_at: The effective datetime or cut label at which to list the TimeVariant properties decorated on Custodian Accounts. Defaults to the current LUSID
|
6215
|
+
:param effective_at: The effective datetime or cut label at which to list the TimeVariant properties decorated on Custodian Accounts. Defaults to the current LUSID system datetime if not specified.
|
6216
6216
|
:type effective_at: str
|
6217
|
-
:param as_at: The asAt datetime at which to retrieve the instrument. Defaults to
|
6217
|
+
:param as_at: The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.
|
6218
6218
|
:type as_at: datetime
|
6219
|
-
:param page: The pagination token to use to continue listing custodian accounts; this
|
6219
|
+
:param page: The pagination token to use to continue listing custodian accounts; 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.
|
6220
6220
|
:type page: str
|
6221
6221
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
6222
6222
|
:type limit: int
|
6223
|
-
:param filter: Expression to filter the results.
|
6223
|
+
:param filter: Expression to filter the results. For example, to filter on the Custodian Account type, specify \"code eq '001'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
6224
6224
|
:type filter: str
|
6225
|
-
:param property_keys: A list of property keys from the 'CustodianAccount' domain to decorate onto the Custodian Account.
|
6225
|
+
:param property_keys: A list of property keys from the 'CustodianAccount' domain to decorate onto the Custodian Account. These must have the format {domain}/{scope}/{code}, for example 'CustodianAccount/system/Name'.
|
6226
6226
|
:type property_keys: List[str]
|
6227
6227
|
:param async_req: Whether to execute the request asynchronously.
|
6228
6228
|
:type async_req: bool, optional
|
@@ -6357,15 +6357,15 @@ class TransactionPortfoliosApi:
|
|
6357
6357
|
|
6358
6358
|
|
6359
6359
|
@overload
|
6360
|
-
async def list_holdings_adjustments(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
6360
|
+
async def list_holdings_adjustments(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], from_effective_at : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the holdings adjustments. There is no lower bound if this is not specified.")] = None, to_effective_at : Annotated[Optional[StrictStr], Field( description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the holdings adjustments. There is no upper bound if this is not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the holdings adjustments. Defaults to return the latest version of each holding adjustment if not specified.")] = None, **kwargs) -> ResourceListOfHoldingsAdjustmentHeader: # noqa: E501
|
6361
6361
|
...
|
6362
6362
|
|
6363
6363
|
@overload
|
6364
|
-
def list_holdings_adjustments(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
6364
|
+
def list_holdings_adjustments(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], from_effective_at : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the holdings adjustments. There is no lower bound if this is not specified.")] = None, to_effective_at : Annotated[Optional[StrictStr], Field( description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the holdings adjustments. There is no upper bound if this is not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the holdings adjustments. Defaults to return the latest version of each holding adjustment if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfHoldingsAdjustmentHeader: # noqa: E501
|
6365
6365
|
...
|
6366
6366
|
|
6367
6367
|
@validate_arguments
|
6368
|
-
def list_holdings_adjustments(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
6368
|
+
def list_holdings_adjustments(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], from_effective_at : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the holdings adjustments. There is no lower bound if this is not specified.")] = None, to_effective_at : Annotated[Optional[StrictStr], Field( description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the holdings adjustments. There is no upper bound if this is not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the holdings adjustments. Defaults to return the latest version of each holding adjustment if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfHoldingsAdjustmentHeader, Awaitable[ResourceListOfHoldingsAdjustmentHeader]]: # noqa: E501
|
6369
6369
|
"""ListHoldingsAdjustments: List holdings adjustments # noqa: E501
|
6370
6370
|
|
6371
6371
|
List the holdings adjustments made to the specified transaction portfolio over a specified interval of effective time. # noqa: E501
|
@@ -6377,13 +6377,13 @@ class TransactionPortfoliosApi:
|
|
6377
6377
|
|
6378
6378
|
:param scope: The scope of the transaction portfolio. (required)
|
6379
6379
|
:type scope: str
|
6380
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
6380
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
6381
6381
|
:type code: str
|
6382
|
-
:param from_effective_at: The lower bound effective datetime or cut label (inclusive) from which to retrieve the holdings
|
6382
|
+
:param from_effective_at: The lower bound effective datetime or cut label (inclusive) from which to retrieve the holdings adjustments. There is no lower bound if this is not specified.
|
6383
6383
|
:type from_effective_at: str
|
6384
|
-
:param to_effective_at: The upper bound effective datetime or cut label (inclusive) from which to retrieve the holdings
|
6384
|
+
:param to_effective_at: The upper bound effective datetime or cut label (inclusive) from which to retrieve the holdings adjustments. There is no upper bound if this is not specified.
|
6385
6385
|
:type to_effective_at: str
|
6386
|
-
:param as_at: The asAt datetime at which to retrieve the holdings adjustments. Defaults to return the
|
6386
|
+
:param as_at: The asAt datetime at which to retrieve the holdings adjustments. Defaults to return the latest version of each holding adjustment if not specified.
|
6387
6387
|
:type as_at: datetime
|
6388
6388
|
:param async_req: Whether to execute the request asynchronously.
|
6389
6389
|
:type async_req: bool, optional
|
@@ -6404,7 +6404,7 @@ class TransactionPortfoliosApi:
|
|
6404
6404
|
return self.list_holdings_adjustments_with_http_info(scope, code, from_effective_at, to_effective_at, as_at, **kwargs) # noqa: E501
|
6405
6405
|
|
6406
6406
|
@validate_arguments
|
6407
|
-
def list_holdings_adjustments_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
6407
|
+
def list_holdings_adjustments_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], from_effective_at : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the holdings adjustments. There is no lower bound if this is not specified.")] = None, to_effective_at : Annotated[Optional[StrictStr], Field( description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the holdings adjustments. There is no upper bound if this is not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the holdings adjustments. Defaults to return the latest version of each holding adjustment if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
6408
6408
|
"""ListHoldingsAdjustments: List holdings adjustments # noqa: E501
|
6409
6409
|
|
6410
6410
|
List the holdings adjustments made to the specified transaction portfolio over a specified interval of effective time. # noqa: E501
|
@@ -6416,13 +6416,13 @@ class TransactionPortfoliosApi:
|
|
6416
6416
|
|
6417
6417
|
:param scope: The scope of the transaction portfolio. (required)
|
6418
6418
|
:type scope: str
|
6419
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
6419
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
6420
6420
|
:type code: str
|
6421
|
-
:param from_effective_at: The lower bound effective datetime or cut label (inclusive) from which to retrieve the holdings
|
6421
|
+
:param from_effective_at: The lower bound effective datetime or cut label (inclusive) from which to retrieve the holdings adjustments. There is no lower bound if this is not specified.
|
6422
6422
|
:type from_effective_at: str
|
6423
|
-
:param to_effective_at: The upper bound effective datetime or cut label (inclusive) from which to retrieve the holdings
|
6423
|
+
:param to_effective_at: The upper bound effective datetime or cut label (inclusive) from which to retrieve the holdings adjustments. There is no upper bound if this is not specified.
|
6424
6424
|
:type to_effective_at: str
|
6425
|
-
:param as_at: The asAt datetime at which to retrieve the holdings adjustments. Defaults to return the
|
6425
|
+
:param as_at: The asAt datetime at which to retrieve the holdings adjustments. Defaults to return the latest version of each holding adjustment if not specified.
|
6426
6426
|
:type as_at: datetime
|
6427
6427
|
:param async_req: Whether to execute the request asynchronously.
|
6428
6428
|
:type async_req: bool, optional
|
@@ -6544,15 +6544,15 @@ class TransactionPortfoliosApi:
|
|
6544
6544
|
|
6545
6545
|
|
6546
6546
|
@overload
|
6547
|
-
async def list_settlement_instructions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio to retrieve settlement instructions for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio to retrieve settlement instructions for.")], from_date : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve instructions.
|
6547
|
+
async def list_settlement_instructions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio to retrieve settlement instructions for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio to retrieve settlement instructions for.")], from_date : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve instructions. There is no lower bound if this is not specified.")] = None, to_date : Annotated[Optional[StrictStr], Field( description="The upper bound effective datetime or cut label (inclusive) from which to retrieve instructions.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing instructions; 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, 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="The expression to filter out settlement instructions")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the settlement instructions. Defaults to return the latest if not specified.")] = None, **kwargs) -> ResourceListOfTransactionSettlementInstruction: # noqa: E501
|
6548
6548
|
...
|
6549
6549
|
|
6550
6550
|
@overload
|
6551
|
-
def list_settlement_instructions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio to retrieve settlement instructions for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio to retrieve settlement instructions for.")], from_date : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve instructions.
|
6551
|
+
def list_settlement_instructions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio to retrieve settlement instructions for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio to retrieve settlement instructions for.")], from_date : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve instructions. There is no lower bound if this is not specified.")] = None, to_date : Annotated[Optional[StrictStr], Field( description="The upper bound effective datetime or cut label (inclusive) from which to retrieve instructions.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing instructions; 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, 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="The expression to filter out settlement instructions")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the settlement instructions. Defaults to return the latest if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfTransactionSettlementInstruction: # noqa: E501
|
6552
6552
|
...
|
6553
6553
|
|
6554
6554
|
@validate_arguments
|
6555
|
-
def list_settlement_instructions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio to retrieve settlement instructions for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio to retrieve settlement instructions for.")], from_date : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve instructions.
|
6555
|
+
def list_settlement_instructions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio to retrieve settlement instructions for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio to retrieve settlement instructions for.")], from_date : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve instructions. There is no lower bound if this is not specified.")] = None, to_date : Annotated[Optional[StrictStr], Field( description="The upper bound effective datetime or cut label (inclusive) from which to retrieve instructions.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing instructions; 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, 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="The expression to filter out settlement instructions")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the settlement instructions. Defaults to return the latest if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfTransactionSettlementInstruction, Awaitable[ResourceListOfTransactionSettlementInstruction]]: # noqa: E501
|
6556
6556
|
"""[EARLY ACCESS] ListSettlementInstructions: List Settlement Instructions. # noqa: E501
|
6557
6557
|
|
6558
6558
|
Display all the Settlement Instructions for a given Portfolio. The transaction Id filter can be ued to return instructions for an individual transaction. # noqa: E501
|
@@ -6566,11 +6566,11 @@ class TransactionPortfoliosApi:
|
|
6566
6566
|
:type scope: str
|
6567
6567
|
:param code: The code of the portfolio to retrieve settlement instructions for. (required)
|
6568
6568
|
:type code: str
|
6569
|
-
:param from_date: The lower bound effective datetime or cut label (inclusive) from which to retrieve instructions.
|
6569
|
+
:param from_date: The lower bound effective datetime or cut label (inclusive) from which to retrieve instructions. There is no lower bound if this is not specified.
|
6570
6570
|
:type from_date: str
|
6571
6571
|
:param to_date: The upper bound effective datetime or cut label (inclusive) from which to retrieve instructions.
|
6572
6572
|
:type to_date: str
|
6573
|
-
:param page: The pagination token to use to continue listing instructions; this value is returned from the previous call.
|
6573
|
+
:param page: The pagination token to use to continue listing instructions; 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.
|
6574
6574
|
:type page: str
|
6575
6575
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
6576
6576
|
:type limit: int
|
@@ -6597,7 +6597,7 @@ class TransactionPortfoliosApi:
|
|
6597
6597
|
return self.list_settlement_instructions_with_http_info(scope, code, from_date, to_date, page, limit, filter, as_at, **kwargs) # noqa: E501
|
6598
6598
|
|
6599
6599
|
@validate_arguments
|
6600
|
-
def list_settlement_instructions_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio to retrieve settlement instructions for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio to retrieve settlement instructions for.")], from_date : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve instructions.
|
6600
|
+
def list_settlement_instructions_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio to retrieve settlement instructions for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio to retrieve settlement instructions for.")], from_date : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve instructions. There is no lower bound if this is not specified.")] = None, to_date : Annotated[Optional[StrictStr], Field( description="The upper bound effective datetime or cut label (inclusive) from which to retrieve instructions.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing instructions; 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, 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="The expression to filter out settlement instructions")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the settlement instructions. Defaults to return the latest if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
6601
6601
|
"""[EARLY ACCESS] ListSettlementInstructions: List Settlement Instructions. # noqa: E501
|
6602
6602
|
|
6603
6603
|
Display all the Settlement Instructions for a given Portfolio. The transaction Id filter can be ued to return instructions for an individual transaction. # noqa: E501
|
@@ -6611,11 +6611,11 @@ class TransactionPortfoliosApi:
|
|
6611
6611
|
:type scope: str
|
6612
6612
|
:param code: The code of the portfolio to retrieve settlement instructions for. (required)
|
6613
6613
|
:type code: str
|
6614
|
-
:param from_date: The lower bound effective datetime or cut label (inclusive) from which to retrieve instructions.
|
6614
|
+
:param from_date: The lower bound effective datetime or cut label (inclusive) from which to retrieve instructions. There is no lower bound if this is not specified.
|
6615
6615
|
:type from_date: str
|
6616
6616
|
:param to_date: The upper bound effective datetime or cut label (inclusive) from which to retrieve instructions.
|
6617
6617
|
:type to_date: str
|
6618
|
-
:param page: The pagination token to use to continue listing instructions; this value is returned from the previous call.
|
6618
|
+
:param page: The pagination token to use to continue listing instructions; 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.
|
6619
6619
|
:type page: str
|
6620
6620
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
6621
6621
|
:type limit: int
|
@@ -6755,18 +6755,18 @@ class TransactionPortfoliosApi:
|
|
6755
6755
|
|
6756
6756
|
|
6757
6757
|
@overload
|
6758
|
-
async def patch_portfolio_details(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the
|
6758
|
+
async def patch_portfolio_details(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], operation : Annotated[conlist(Operation), Field(..., description="The patch document.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which the updated or inserted details should become valid. Defaults to the current LUSID system datetime if not specified. Note that this will affect all bitemporal entities in the request, but will not be used for any perpetual entities.")] = None, **kwargs) -> PortfolioDetails: # noqa: E501
|
6759
6759
|
...
|
6760
6760
|
|
6761
6761
|
@overload
|
6762
|
-
def patch_portfolio_details(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the
|
6762
|
+
def patch_portfolio_details(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], operation : Annotated[conlist(Operation), Field(..., description="The patch document.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which the updated or inserted details should become valid. Defaults to the current LUSID system datetime if not specified. Note that this will affect all bitemporal entities in the request, but will not be used for any perpetual entities.")] = None, async_req: Optional[bool]=True, **kwargs) -> PortfolioDetails: # noqa: E501
|
6763
6763
|
...
|
6764
6764
|
|
6765
6765
|
@validate_arguments
|
6766
|
-
def patch_portfolio_details(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the
|
6766
|
+
def patch_portfolio_details(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], operation : Annotated[conlist(Operation), Field(..., description="The patch document.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which the updated or inserted details should become valid. Defaults to the current LUSID system datetime if not specified. Note that this will affect all bitemporal entities in the request, but will not be used for any perpetual entities.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PortfolioDetails, Awaitable[PortfolioDetails]]: # noqa: E501
|
6767
6767
|
"""PatchPortfolioDetails: Patch portfolio details # noqa: E501
|
6768
6768
|
|
6769
|
-
Create or update certain details for a particular transaction portfolio.
|
6769
|
+
Create or update certain details for a particular transaction portfolio. Note that not all elements of a transaction portfolio definition are modifiable once it has been created due to the potential implications for data already stored. The behaviour is defined by the JSON Patch specification. Currently supported fields are: BaseCurrency, AccountingMethod, SubHoldingKeys, AmortisationMethod, TransactionTypeScope, CashGainLossCalculationDate, InstrumentEventConfiguration, AmortisationRuleSetId, TaxRuleSetScope, SettlementConfiguration. # noqa: E501
|
6770
6770
|
This method makes a synchronous HTTP request by default. To make an
|
6771
6771
|
asynchronous HTTP request, please pass async_req=True
|
6772
6772
|
|
@@ -6775,11 +6775,11 @@ class TransactionPortfoliosApi:
|
|
6775
6775
|
|
6776
6776
|
:param scope: The scope of the transaction portfolio. (required)
|
6777
6777
|
:type scope: str
|
6778
|
-
:param code: The code of the transaction portfolio. Together with the
|
6778
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
6779
6779
|
:type code: str
|
6780
6780
|
:param operation: The patch document. (required)
|
6781
6781
|
:type operation: List[Operation]
|
6782
|
-
:param effective_at: The effective datetime or cut label at which the updated or inserted details should become valid.
|
6782
|
+
:param effective_at: The effective datetime or cut label at which the updated or inserted details should become valid. Defaults to the current LUSID system datetime if not specified. Note that this will affect all bitemporal entities in the request, but will not be used for any perpetual entities.
|
6783
6783
|
:type effective_at: str
|
6784
6784
|
:param async_req: Whether to execute the request asynchronously.
|
6785
6785
|
:type async_req: bool, optional
|
@@ -6800,10 +6800,10 @@ class TransactionPortfoliosApi:
|
|
6800
6800
|
return self.patch_portfolio_details_with_http_info(scope, code, operation, effective_at, **kwargs) # noqa: E501
|
6801
6801
|
|
6802
6802
|
@validate_arguments
|
6803
|
-
def patch_portfolio_details_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the
|
6803
|
+
def patch_portfolio_details_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], operation : Annotated[conlist(Operation), Field(..., description="The patch document.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which the updated or inserted details should become valid. Defaults to the current LUSID system datetime if not specified. Note that this will affect all bitemporal entities in the request, but will not be used for any perpetual entities.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
6804
6804
|
"""PatchPortfolioDetails: Patch portfolio details # noqa: E501
|
6805
6805
|
|
6806
|
-
Create or update certain details for a particular transaction portfolio.
|
6806
|
+
Create or update certain details for a particular transaction portfolio. Note that not all elements of a transaction portfolio definition are modifiable once it has been created due to the potential implications for data already stored. The behaviour is defined by the JSON Patch specification. Currently supported fields are: BaseCurrency, AccountingMethod, SubHoldingKeys, AmortisationMethod, TransactionTypeScope, CashGainLossCalculationDate, InstrumentEventConfiguration, AmortisationRuleSetId, TaxRuleSetScope, SettlementConfiguration. # noqa: E501
|
6807
6807
|
This method makes a synchronous HTTP request by default. To make an
|
6808
6808
|
asynchronous HTTP request, please pass async_req=True
|
6809
6809
|
|
@@ -6812,11 +6812,11 @@ class TransactionPortfoliosApi:
|
|
6812
6812
|
|
6813
6813
|
:param scope: The scope of the transaction portfolio. (required)
|
6814
6814
|
:type scope: str
|
6815
|
-
:param code: The code of the transaction portfolio. Together with the
|
6815
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
6816
6816
|
:type code: str
|
6817
6817
|
:param operation: The patch document. (required)
|
6818
6818
|
:type operation: List[Operation]
|
6819
|
-
:param effective_at: The effective datetime or cut label at which the updated or inserted details should become valid.
|
6819
|
+
:param effective_at: The effective datetime or cut label at which the updated or inserted details should become valid. Defaults to the current LUSID system datetime if not specified. Note that this will affect all bitemporal entities in the request, but will not be used for any perpetual entities.
|
6820
6820
|
:type effective_at: str
|
6821
6821
|
:param async_req: Whether to execute the request asynchronously.
|
6822
6822
|
:type async_req: bool, optional
|
@@ -6938,18 +6938,18 @@ class TransactionPortfoliosApi:
|
|
6938
6938
|
|
6939
6939
|
|
6940
6940
|
@overload
|
6941
|
-
async def preview_transaction(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
6941
|
+
async def preview_transaction(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], transaction_request : Annotated[TransactionRequest, Field(..., description="The transaction to be previewed.")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Transaction/strategy/quantsignal\".")] = None, show_cancelled_transactions : Annotated[Optional[StrictBool], Field(description="Option to specify whether to include previous versions of an amended transaction in the response. Defaults to False if not specified.")] = None, preserve_properties : Annotated[Optional[StrictBool], Field(description="If the preview transaction is an amendment to an existing transaction, then setting this to true will carry forward any unmodified properties from the earlier version.")] = None, **kwargs) -> ResourceListOfOutputTransaction: # noqa: E501
|
6942
6942
|
...
|
6943
6943
|
|
6944
6944
|
@overload
|
6945
|
-
def preview_transaction(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
6945
|
+
def preview_transaction(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], transaction_request : Annotated[TransactionRequest, Field(..., description="The transaction to be previewed.")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Transaction/strategy/quantsignal\".")] = None, show_cancelled_transactions : Annotated[Optional[StrictBool], Field(description="Option to specify whether to include previous versions of an amended transaction in the response. Defaults to False if not specified.")] = None, preserve_properties : Annotated[Optional[StrictBool], Field(description="If the preview transaction is an amendment to an existing transaction, then setting this to true will carry forward any unmodified properties from the earlier version.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfOutputTransaction: # noqa: E501
|
6946
6946
|
...
|
6947
6947
|
|
6948
6948
|
@validate_arguments
|
6949
|
-
def preview_transaction(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
6949
|
+
def preview_transaction(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], transaction_request : Annotated[TransactionRequest, Field(..., description="The transaction to be previewed.")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Transaction/strategy/quantsignal\".")] = None, show_cancelled_transactions : Annotated[Optional[StrictBool], Field(description="Option to specify whether to include previous versions of an amended transaction in the response. Defaults to False if not specified.")] = None, preserve_properties : Annotated[Optional[StrictBool], Field(description="If the preview transaction is an amendment to an existing transaction, then setting this to true will carry forward any unmodified properties from the earlier version.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfOutputTransaction, Awaitable[ResourceListOfOutputTransaction]]: # noqa: E501
|
6950
6950
|
"""PreviewTransaction: Preview a transaction # noqa: E501
|
6951
6951
|
|
6952
|
-
Returns the output-transaction(s) - e.g. as returned by BuildTransactions
|
6952
|
+
Returns the output-transaction(s) - e.g. as returned by BuildTransactions that would come out of LUSID if the provided TransactionRequest was booked. # noqa: E501
|
6953
6953
|
This method makes a synchronous HTTP request by default. To make an
|
6954
6954
|
asynchronous HTTP request, please pass async_req=True
|
6955
6955
|
|
@@ -6958,13 +6958,13 @@ class TransactionPortfoliosApi:
|
|
6958
6958
|
|
6959
6959
|
:param scope: The scope of the transaction portfolio. (required)
|
6960
6960
|
:type scope: str
|
6961
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
6961
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
6962
6962
|
:type code: str
|
6963
6963
|
:param transaction_request: The transaction to be previewed. (required)
|
6964
6964
|
:type transaction_request: TransactionRequest
|
6965
|
-
:param property_keys: A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto
|
6965
|
+
:param property_keys: A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Transaction/strategy/quantsignal\".
|
6966
6966
|
:type property_keys: List[str]
|
6967
|
-
:param show_cancelled_transactions: Option to specify whether to include previous versions of an amended transaction in the response.
|
6967
|
+
:param show_cancelled_transactions: Option to specify whether to include previous versions of an amended transaction in the response. Defaults to False if not specified.
|
6968
6968
|
:type show_cancelled_transactions: bool
|
6969
6969
|
:param preserve_properties: If the preview transaction is an amendment to an existing transaction, then setting this to true will carry forward any unmodified properties from the earlier version.
|
6970
6970
|
:type preserve_properties: bool
|
@@ -6987,10 +6987,10 @@ class TransactionPortfoliosApi:
|
|
6987
6987
|
return self.preview_transaction_with_http_info(scope, code, transaction_request, property_keys, show_cancelled_transactions, preserve_properties, **kwargs) # noqa: E501
|
6988
6988
|
|
6989
6989
|
@validate_arguments
|
6990
|
-
def preview_transaction_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
6990
|
+
def preview_transaction_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], transaction_request : Annotated[TransactionRequest, Field(..., description="The transaction to be previewed.")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Transaction/strategy/quantsignal\".")] = None, show_cancelled_transactions : Annotated[Optional[StrictBool], Field(description="Option to specify whether to include previous versions of an amended transaction in the response. Defaults to False if not specified.")] = None, preserve_properties : Annotated[Optional[StrictBool], Field(description="If the preview transaction is an amendment to an existing transaction, then setting this to true will carry forward any unmodified properties from the earlier version.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
6991
6991
|
"""PreviewTransaction: Preview a transaction # noqa: E501
|
6992
6992
|
|
6993
|
-
Returns the output-transaction(s) - e.g. as returned by BuildTransactions
|
6993
|
+
Returns the output-transaction(s) - e.g. as returned by BuildTransactions that would come out of LUSID if the provided TransactionRequest was booked. # noqa: E501
|
6994
6994
|
This method makes a synchronous HTTP request by default. To make an
|
6995
6995
|
asynchronous HTTP request, please pass async_req=True
|
6996
6996
|
|
@@ -6999,13 +6999,13 @@ class TransactionPortfoliosApi:
|
|
6999
6999
|
|
7000
7000
|
:param scope: The scope of the transaction portfolio. (required)
|
7001
7001
|
:type scope: str
|
7002
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
7002
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
7003
7003
|
:type code: str
|
7004
7004
|
:param transaction_request: The transaction to be previewed. (required)
|
7005
7005
|
:type transaction_request: TransactionRequest
|
7006
|
-
:param property_keys: A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto
|
7006
|
+
:param property_keys: A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Transaction/strategy/quantsignal\".
|
7007
7007
|
:type property_keys: List[str]
|
7008
|
-
:param show_cancelled_transactions: Option to specify whether to include previous versions of an amended transaction in the response.
|
7008
|
+
:param show_cancelled_transactions: Option to specify whether to include previous versions of an amended transaction in the response. Defaults to False if not specified.
|
7009
7009
|
:type show_cancelled_transactions: bool
|
7010
7010
|
:param preserve_properties: If the preview transaction is an amendment to an existing transaction, then setting this to true will carry forward any unmodified properties from the earlier version.
|
7011
7011
|
:type preserve_properties: bool
|
@@ -7138,18 +7138,18 @@ class TransactionPortfoliosApi:
|
|
7138
7138
|
|
7139
7139
|
|
7140
7140
|
@overload
|
7141
|
-
async def resolve_instrument(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
7141
|
+
async def resolve_instrument(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], instrument_identifier_type : Annotated[StrictStr, Field(..., description="The instrument identifier type.")], instrument_identifier_value : Annotated[StrictStr, Field(..., description="The value for the given instrument identifier.")], from_effective_at : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.")] = None, re_resolve : Annotated[Optional[StrictBool], Field(description="When set to true, instrument resolution will be attempted for all transactions and holdings for the given identifier and date range. When set to false (default behaviour), instrument resolution will only be attempted for those transactions and holdings that were previously unresolved.")] = None, request_body : Annotated[Optional[Dict[str, StrictStr]], Field(description="The dictionary with the instrument identifiers to be updated on the transaction and holdings.")] = None, **kwargs) -> UpsertPortfolioTransactionsResponse: # noqa: E501
|
7142
7142
|
...
|
7143
7143
|
|
7144
7144
|
@overload
|
7145
|
-
def resolve_instrument(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
7145
|
+
def resolve_instrument(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], instrument_identifier_type : Annotated[StrictStr, Field(..., description="The instrument identifier type.")], instrument_identifier_value : Annotated[StrictStr, Field(..., description="The value for the given instrument identifier.")], from_effective_at : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.")] = None, re_resolve : Annotated[Optional[StrictBool], Field(description="When set to true, instrument resolution will be attempted for all transactions and holdings for the given identifier and date range. When set to false (default behaviour), instrument resolution will only be attempted for those transactions and holdings that were previously unresolved.")] = None, request_body : Annotated[Optional[Dict[str, StrictStr]], Field(description="The dictionary with the instrument identifiers to be updated on the transaction and holdings.")] = None, async_req: Optional[bool]=True, **kwargs) -> UpsertPortfolioTransactionsResponse: # noqa: E501
|
7146
7146
|
...
|
7147
7147
|
|
7148
7148
|
@validate_arguments
|
7149
|
-
def resolve_instrument(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
7149
|
+
def resolve_instrument(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], instrument_identifier_type : Annotated[StrictStr, Field(..., description="The instrument identifier type.")], instrument_identifier_value : Annotated[StrictStr, Field(..., description="The value for the given instrument identifier.")], from_effective_at : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.")] = None, re_resolve : Annotated[Optional[StrictBool], Field(description="When set to true, instrument resolution will be attempted for all transactions and holdings for the given identifier and date range. When set to false (default behaviour), instrument resolution will only be attempted for those transactions and holdings that were previously unresolved.")] = None, request_body : Annotated[Optional[Dict[str, StrictStr]], Field(description="The dictionary with the instrument identifiers to be updated on the transaction and holdings.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[UpsertPortfolioTransactionsResponse, Awaitable[UpsertPortfolioTransactionsResponse]]: # noqa: E501
|
7150
7150
|
"""ResolveInstrument: Resolve instrument # noqa: E501
|
7151
7151
|
|
7152
|
-
Try to resolve the instrument for transaction and holdings for a given instrument identifier and a specified
|
7152
|
+
Try to resolve the instrument for transaction and holdings for a given instrument identifier and a specified period of time. Also update the instrument identifiers with the given instrument identifiers collection. # noqa: E501
|
7153
7153
|
This method makes a synchronous HTTP request by default. To make an
|
7154
7154
|
asynchronous HTTP request, please pass async_req=True
|
7155
7155
|
|
@@ -7158,17 +7158,17 @@ class TransactionPortfoliosApi:
|
|
7158
7158
|
|
7159
7159
|
:param scope: The scope of the transaction portfolio. (required)
|
7160
7160
|
:type scope: str
|
7161
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
7161
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
7162
7162
|
:type code: str
|
7163
7163
|
:param instrument_identifier_type: The instrument identifier type. (required)
|
7164
7164
|
:type instrument_identifier_type: str
|
7165
7165
|
:param instrument_identifier_value: The value for the given instrument identifier. (required)
|
7166
7166
|
:type instrument_identifier_value: str
|
7167
|
-
:param from_effective_at: The lower bound effective datetime or cut label (inclusive) from which to retrieve the data.
|
7167
|
+
:param from_effective_at: The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.
|
7168
7168
|
:type from_effective_at: str
|
7169
|
-
:param re_resolve: When set to true, instrument resolution will be attempted for all transactions and holdings for the given identifier and date range.
|
7169
|
+
:param re_resolve: When set to true, instrument resolution will be attempted for all transactions and holdings for the given identifier and date range. When set to false (default behaviour), instrument resolution will only be attempted for those transactions and holdings that were previously unresolved.
|
7170
7170
|
:type re_resolve: bool
|
7171
|
-
:param request_body: The dictionary with the instrument identifiers to be updated on the
|
7171
|
+
:param request_body: The dictionary with the instrument identifiers to be updated on the transaction and holdings.
|
7172
7172
|
:type request_body: Dict[str, str]
|
7173
7173
|
:param async_req: Whether to execute the request asynchronously.
|
7174
7174
|
:type async_req: bool, optional
|
@@ -7189,10 +7189,10 @@ class TransactionPortfoliosApi:
|
|
7189
7189
|
return self.resolve_instrument_with_http_info(scope, code, instrument_identifier_type, instrument_identifier_value, from_effective_at, re_resolve, request_body, **kwargs) # noqa: E501
|
7190
7190
|
|
7191
7191
|
@validate_arguments
|
7192
|
-
def resolve_instrument_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
7192
|
+
def resolve_instrument_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], instrument_identifier_type : Annotated[StrictStr, Field(..., description="The instrument identifier type.")], instrument_identifier_value : Annotated[StrictStr, Field(..., description="The value for the given instrument identifier.")], from_effective_at : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.")] = None, re_resolve : Annotated[Optional[StrictBool], Field(description="When set to true, instrument resolution will be attempted for all transactions and holdings for the given identifier and date range. When set to false (default behaviour), instrument resolution will only be attempted for those transactions and holdings that were previously unresolved.")] = None, request_body : Annotated[Optional[Dict[str, StrictStr]], Field(description="The dictionary with the instrument identifiers to be updated on the transaction and holdings.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
7193
7193
|
"""ResolveInstrument: Resolve instrument # noqa: E501
|
7194
7194
|
|
7195
|
-
Try to resolve the instrument for transaction and holdings for a given instrument identifier and a specified
|
7195
|
+
Try to resolve the instrument for transaction and holdings for a given instrument identifier and a specified period of time. Also update the instrument identifiers with the given instrument identifiers collection. # noqa: E501
|
7196
7196
|
This method makes a synchronous HTTP request by default. To make an
|
7197
7197
|
asynchronous HTTP request, please pass async_req=True
|
7198
7198
|
|
@@ -7201,17 +7201,17 @@ class TransactionPortfoliosApi:
|
|
7201
7201
|
|
7202
7202
|
:param scope: The scope of the transaction portfolio. (required)
|
7203
7203
|
:type scope: str
|
7204
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
7204
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
7205
7205
|
:type code: str
|
7206
7206
|
:param instrument_identifier_type: The instrument identifier type. (required)
|
7207
7207
|
:type instrument_identifier_type: str
|
7208
7208
|
:param instrument_identifier_value: The value for the given instrument identifier. (required)
|
7209
7209
|
:type instrument_identifier_value: str
|
7210
|
-
:param from_effective_at: The lower bound effective datetime or cut label (inclusive) from which to retrieve the data.
|
7210
|
+
:param from_effective_at: The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.
|
7211
7211
|
:type from_effective_at: str
|
7212
|
-
:param re_resolve: When set to true, instrument resolution will be attempted for all transactions and holdings for the given identifier and date range.
|
7212
|
+
:param re_resolve: When set to true, instrument resolution will be attempted for all transactions and holdings for the given identifier and date range. When set to false (default behaviour), instrument resolution will only be attempted for those transactions and holdings that were previously unresolved.
|
7213
7213
|
:type re_resolve: bool
|
7214
|
-
:param request_body: The dictionary with the instrument identifiers to be updated on the
|
7214
|
+
:param request_body: The dictionary with the instrument identifiers to be updated on the transaction and holdings.
|
7215
7215
|
:type request_body: Dict[str, str]
|
7216
7216
|
:param async_req: Whether to execute the request asynchronously.
|
7217
7217
|
:type async_req: bool, optional
|
@@ -7345,18 +7345,18 @@ class TransactionPortfoliosApi:
|
|
7345
7345
|
|
7346
7346
|
|
7347
7347
|
@overload
|
7348
|
-
async def set_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
7348
|
+
async def set_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[StrictStr, Field(..., description="The effective datetime or cut label at which the holdings should be set to the provided targets.")], adjust_holding_request : Annotated[conlist(AdjustHoldingRequest), Field(..., description="The complete set of target holdings for the transaction portfolio.")], reconciliation_methods : Annotated[Optional[conlist(StrictStr)], Field(description="Optional parameter for specifying a reconciliation method: e.g. FxForward.")] = None, override_movement_name : Annotated[Optional[StrictStr], Field( description="Optional parameter to override movement name for the set holdings.")] = None, override_offset_movement_name : Annotated[Optional[StrictStr], Field( description="Optional parameter will create an additional offset movement for the set holdings with this new name and transaction type: CarryAsPnl")] = None, **kwargs) -> AdjustHolding: # noqa: E501
|
7349
7349
|
...
|
7350
7350
|
|
7351
7351
|
@overload
|
7352
|
-
def set_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
7352
|
+
def set_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[StrictStr, Field(..., description="The effective datetime or cut label at which the holdings should be set to the provided targets.")], adjust_holding_request : Annotated[conlist(AdjustHoldingRequest), Field(..., description="The complete set of target holdings for the transaction portfolio.")], reconciliation_methods : Annotated[Optional[conlist(StrictStr)], Field(description="Optional parameter for specifying a reconciliation method: e.g. FxForward.")] = None, override_movement_name : Annotated[Optional[StrictStr], Field( description="Optional parameter to override movement name for the set holdings.")] = None, override_offset_movement_name : Annotated[Optional[StrictStr], Field( description="Optional parameter will create an additional offset movement for the set holdings with this new name and transaction type: CarryAsPnl")] = None, async_req: Optional[bool]=True, **kwargs) -> AdjustHolding: # noqa: E501
|
7353
7353
|
...
|
7354
7354
|
|
7355
7355
|
@validate_arguments
|
7356
|
-
def set_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
7356
|
+
def set_holdings(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[StrictStr, Field(..., description="The effective datetime or cut label at which the holdings should be set to the provided targets.")], adjust_holding_request : Annotated[conlist(AdjustHoldingRequest), Field(..., description="The complete set of target holdings for the transaction portfolio.")], reconciliation_methods : Annotated[Optional[conlist(StrictStr)], Field(description="Optional parameter for specifying a reconciliation method: e.g. FxForward.")] = None, override_movement_name : Annotated[Optional[StrictStr], Field( description="Optional parameter to override movement name for the set holdings.")] = None, override_offset_movement_name : Annotated[Optional[StrictStr], Field( description="Optional parameter will create an additional offset movement for the set holdings with this new name and transaction type: CarryAsPnl")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[AdjustHolding, Awaitable[AdjustHolding]]: # noqa: E501
|
7357
7357
|
"""SetHoldings: Set holdings # noqa: E501
|
7358
7358
|
|
7359
|
-
Set the holdings of the specified transaction portfolio to the provided targets. LUSID will automatically
|
7359
|
+
Set the holdings of the specified transaction portfolio to the provided targets. LUSID will automatically construct adjustment transactions to ensure that the entire set of holdings for the transaction portfolio are always set to the provided targets for the specified effective datetime. Read more about the difference between adjusting and setting holdings here https://support.lusid.com/docs/how-do-i-manually-adjust-or-set-holdings. # noqa: E501
|
7360
7360
|
This method makes a synchronous HTTP request by default. To make an
|
7361
7361
|
asynchronous HTTP request, please pass async_req=True
|
7362
7362
|
|
@@ -7365,7 +7365,7 @@ class TransactionPortfoliosApi:
|
|
7365
7365
|
|
7366
7366
|
:param scope: The scope of the transaction portfolio. (required)
|
7367
7367
|
:type scope: str
|
7368
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
7368
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
7369
7369
|
:type code: str
|
7370
7370
|
:param effective_at: The effective datetime or cut label at which the holdings should be set to the provided targets. (required)
|
7371
7371
|
:type effective_at: str
|
@@ -7396,10 +7396,10 @@ class TransactionPortfoliosApi:
|
|
7396
7396
|
return self.set_holdings_with_http_info(scope, code, effective_at, adjust_holding_request, reconciliation_methods, override_movement_name, override_offset_movement_name, **kwargs) # noqa: E501
|
7397
7397
|
|
7398
7398
|
@validate_arguments
|
7399
|
-
def set_holdings_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
7399
|
+
def set_holdings_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], effective_at : Annotated[StrictStr, Field(..., description="The effective datetime or cut label at which the holdings should be set to the provided targets.")], adjust_holding_request : Annotated[conlist(AdjustHoldingRequest), Field(..., description="The complete set of target holdings for the transaction portfolio.")], reconciliation_methods : Annotated[Optional[conlist(StrictStr)], Field(description="Optional parameter for specifying a reconciliation method: e.g. FxForward.")] = None, override_movement_name : Annotated[Optional[StrictStr], Field( description="Optional parameter to override movement name for the set holdings.")] = None, override_offset_movement_name : Annotated[Optional[StrictStr], Field( description="Optional parameter will create an additional offset movement for the set holdings with this new name and transaction type: CarryAsPnl")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
7400
7400
|
"""SetHoldings: Set holdings # noqa: E501
|
7401
7401
|
|
7402
|
-
Set the holdings of the specified transaction portfolio to the provided targets. LUSID will automatically
|
7402
|
+
Set the holdings of the specified transaction portfolio to the provided targets. LUSID will automatically construct adjustment transactions to ensure that the entire set of holdings for the transaction portfolio are always set to the provided targets for the specified effective datetime. Read more about the difference between adjusting and setting holdings here https://support.lusid.com/docs/how-do-i-manually-adjust-or-set-holdings. # noqa: E501
|
7403
7403
|
This method makes a synchronous HTTP request by default. To make an
|
7404
7404
|
asynchronous HTTP request, please pass async_req=True
|
7405
7405
|
|
@@ -7408,7 +7408,7 @@ class TransactionPortfoliosApi:
|
|
7408
7408
|
|
7409
7409
|
:param scope: The scope of the transaction portfolio. (required)
|
7410
7410
|
:type scope: str
|
7411
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
7411
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
7412
7412
|
:type code: str
|
7413
7413
|
:param effective_at: The effective datetime or cut label at which the holdings should be set to the provided targets. (required)
|
7414
7414
|
:type effective_at: str
|
@@ -7553,18 +7553,18 @@ class TransactionPortfoliosApi:
|
|
7553
7553
|
|
7554
7554
|
|
7555
7555
|
@overload
|
7556
|
-
async def upsert_custodian_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolio. Together with the scope this uniquely identifies
|
7556
|
+
async def upsert_custodian_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolio. Together with the scope this uniquely identifies the Transaction Portfolios.")], custodian_account_request : Annotated[conlist(CustodianAccountRequest), Field(..., description="A list of Custodian Accounts to be created or updated.")], **kwargs) -> CustodianAccountsUpsertResponse: # noqa: E501
|
7557
7557
|
...
|
7558
7558
|
|
7559
7559
|
@overload
|
7560
|
-
def upsert_custodian_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolio. Together with the scope this uniquely identifies
|
7560
|
+
def upsert_custodian_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolio. Together with the scope this uniquely identifies the Transaction Portfolios.")], custodian_account_request : Annotated[conlist(CustodianAccountRequest), Field(..., description="A list of Custodian Accounts to be created or updated.")], async_req: Optional[bool]=True, **kwargs) -> CustodianAccountsUpsertResponse: # noqa: E501
|
7561
7561
|
...
|
7562
7562
|
|
7563
7563
|
@validate_arguments
|
7564
|
-
def upsert_custodian_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolio. Together with the scope this uniquely identifies
|
7564
|
+
def upsert_custodian_accounts(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolio. Together with the scope this uniquely identifies the Transaction Portfolios.")], custodian_account_request : Annotated[conlist(CustodianAccountRequest), Field(..., description="A list of Custodian Accounts to be created or updated.")], async_req: Optional[bool]=None, **kwargs) -> Union[CustodianAccountsUpsertResponse, Awaitable[CustodianAccountsUpsertResponse]]: # noqa: E501
|
7565
7565
|
"""UpsertCustodianAccounts: Upsert Custodian Accounts # noqa: E501
|
7566
7566
|
|
7567
|
-
Create or update Custodian Accounts in the Transaction Portfolios. A Custodian Account will be updated
|
7567
|
+
Create or update Custodian Accounts in the Transaction Portfolios. A Custodian Account will be updated if it already exists and created if it does not. The batch limit per request is 2,000. # noqa: E501
|
7568
7568
|
This method makes a synchronous HTTP request by default. To make an
|
7569
7569
|
asynchronous HTTP request, please pass async_req=True
|
7570
7570
|
|
@@ -7573,7 +7573,7 @@ class TransactionPortfoliosApi:
|
|
7573
7573
|
|
7574
7574
|
:param scope: The scope of the Transaction Portfolio. (required)
|
7575
7575
|
:type scope: str
|
7576
|
-
:param code: The code of the Transaction Portfolio. Together with the scope this uniquely identifies
|
7576
|
+
:param code: The code of the Transaction Portfolio. Together with the scope this uniquely identifies the Transaction Portfolios. (required)
|
7577
7577
|
:type code: str
|
7578
7578
|
:param custodian_account_request: A list of Custodian Accounts to be created or updated. (required)
|
7579
7579
|
:type custodian_account_request: List[CustodianAccountRequest]
|
@@ -7596,10 +7596,10 @@ class TransactionPortfoliosApi:
|
|
7596
7596
|
return self.upsert_custodian_accounts_with_http_info(scope, code, custodian_account_request, **kwargs) # noqa: E501
|
7597
7597
|
|
7598
7598
|
@validate_arguments
|
7599
|
-
def upsert_custodian_accounts_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolio. Together with the scope this uniquely identifies
|
7599
|
+
def upsert_custodian_accounts_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolio. Together with the scope this uniquely identifies the Transaction Portfolios.")], custodian_account_request : Annotated[conlist(CustodianAccountRequest), Field(..., description="A list of Custodian Accounts to be created or updated.")], **kwargs) -> ApiResponse: # noqa: E501
|
7600
7600
|
"""UpsertCustodianAccounts: Upsert Custodian Accounts # noqa: E501
|
7601
7601
|
|
7602
|
-
Create or update Custodian Accounts in the Transaction Portfolios. A Custodian Account will be updated
|
7602
|
+
Create or update Custodian Accounts in the Transaction Portfolios. A Custodian Account will be updated if it already exists and created if it does not. The batch limit per request is 2,000. # noqa: E501
|
7603
7603
|
This method makes a synchronous HTTP request by default. To make an
|
7604
7604
|
asynchronous HTTP request, please pass async_req=True
|
7605
7605
|
|
@@ -7608,7 +7608,7 @@ class TransactionPortfoliosApi:
|
|
7608
7608
|
|
7609
7609
|
:param scope: The scope of the Transaction Portfolio. (required)
|
7610
7610
|
:type scope: str
|
7611
|
-
:param code: The code of the Transaction Portfolio. Together with the scope this uniquely identifies
|
7611
|
+
:param code: The code of the Transaction Portfolio. Together with the scope this uniquely identifies the Transaction Portfolios. (required)
|
7612
7612
|
:type code: str
|
7613
7613
|
:param custodian_account_request: A list of Custodian Accounts to be created or updated. (required)
|
7614
7614
|
:type custodian_account_request: List[CustodianAccountRequest]
|
@@ -7728,18 +7728,18 @@ class TransactionPortfoliosApi:
|
|
7728
7728
|
|
7729
7729
|
|
7730
7730
|
@overload
|
7731
|
-
async def upsert_custodian_accounts_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolios to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolios to update or insert the properties onto. Together with the scope this uniquely identifies the Transaction Portfolios.")], custodian_account_scope : Annotated[StrictStr, Field(..., description="The scope of the Custodian Account to update or insert the properties onto.")], custodian_account_code : Annotated[StrictStr, Field(..., description="The unique ID of the custodian account to create or update properties for.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the Transaction Portfolio. Each property in
|
7731
|
+
async def upsert_custodian_accounts_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolios to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolios to update or insert the properties onto. Together with the scope this uniquely identifies the Transaction Portfolios.")], custodian_account_scope : Annotated[StrictStr, Field(..., description="The scope of the Custodian Account to update or insert the properties onto.")], custodian_account_code : Annotated[StrictStr, Field(..., description="The unique ID of the custodian account to create or update properties for.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the Transaction Portfolio. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. \"CustodianAccount/Manager/Id\".")] = None, **kwargs) -> CustodianAccountProperties: # noqa: E501
|
7732
7732
|
...
|
7733
7733
|
|
7734
7734
|
@overload
|
7735
|
-
def upsert_custodian_accounts_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolios to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolios to update or insert the properties onto. Together with the scope this uniquely identifies the Transaction Portfolios.")], custodian_account_scope : Annotated[StrictStr, Field(..., description="The scope of the Custodian Account to update or insert the properties onto.")], custodian_account_code : Annotated[StrictStr, Field(..., description="The unique ID of the custodian account to create or update properties for.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the Transaction Portfolio. Each property in
|
7735
|
+
def upsert_custodian_accounts_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolios to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolios to update or insert the properties onto. Together with the scope this uniquely identifies the Transaction Portfolios.")], custodian_account_scope : Annotated[StrictStr, Field(..., description="The scope of the Custodian Account to update or insert the properties onto.")], custodian_account_code : Annotated[StrictStr, Field(..., description="The unique ID of the custodian account to create or update properties for.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the Transaction Portfolio. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. \"CustodianAccount/Manager/Id\".")] = None, async_req: Optional[bool]=True, **kwargs) -> CustodianAccountProperties: # noqa: E501
|
7736
7736
|
...
|
7737
7737
|
|
7738
7738
|
@validate_arguments
|
7739
|
-
def upsert_custodian_accounts_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolios to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolios to update or insert the properties onto. Together with the scope this uniquely identifies the Transaction Portfolios.")], custodian_account_scope : Annotated[StrictStr, Field(..., description="The scope of the Custodian Account to update or insert the properties onto.")], custodian_account_code : Annotated[StrictStr, Field(..., description="The unique ID of the custodian account to create or update properties for.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the Transaction Portfolio. Each property in
|
7739
|
+
def upsert_custodian_accounts_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolios to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolios to update or insert the properties onto. Together with the scope this uniquely identifies the Transaction Portfolios.")], custodian_account_scope : Annotated[StrictStr, Field(..., description="The scope of the Custodian Account to update or insert the properties onto.")], custodian_account_code : Annotated[StrictStr, Field(..., description="The unique ID of the custodian account to create or update properties for.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the Transaction Portfolio. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. \"CustodianAccount/Manager/Id\".")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[CustodianAccountProperties, Awaitable[CustodianAccountProperties]]: # noqa: E501
|
7740
7740
|
"""UpsertCustodianAccountsProperties: Upsert custodian accounts properties # noqa: E501
|
7741
7741
|
|
7742
|
-
Update or insert one or more properties onto a single custodian account. A property will be updated if it
|
7742
|
+
Update or insert one or more properties onto a single custodian account. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain 'CustodianAccount'. Upserting a property that exists for a Transaction Portfolios, with a null value, will delete the instance of the property for that group. Properties have an <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. # noqa: E501
|
7743
7743
|
This method makes a synchronous HTTP request by default. To make an
|
7744
7744
|
asynchronous HTTP request, please pass async_req=True
|
7745
7745
|
|
@@ -7754,7 +7754,7 @@ class TransactionPortfoliosApi:
|
|
7754
7754
|
:type custodian_account_scope: str
|
7755
7755
|
:param custodian_account_code: The unique ID of the custodian account to create or update properties for. (required)
|
7756
7756
|
:type custodian_account_code: str
|
7757
|
-
:param request_body: The properties to be updated or inserted onto the Transaction Portfolio. Each property in
|
7757
|
+
:param request_body: The properties to be updated or inserted onto the Transaction Portfolio. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. \"CustodianAccount/Manager/Id\".
|
7758
7758
|
:type request_body: Dict[str, ModelProperty]
|
7759
7759
|
:param async_req: Whether to execute the request asynchronously.
|
7760
7760
|
:type async_req: bool, optional
|
@@ -7775,10 +7775,10 @@ class TransactionPortfoliosApi:
|
|
7775
7775
|
return self.upsert_custodian_accounts_properties_with_http_info(scope, code, custodian_account_scope, custodian_account_code, request_body, **kwargs) # noqa: E501
|
7776
7776
|
|
7777
7777
|
@validate_arguments
|
7778
|
-
def upsert_custodian_accounts_properties_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolios to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolios to update or insert the properties onto. Together with the scope this uniquely identifies the Transaction Portfolios.")], custodian_account_scope : Annotated[StrictStr, Field(..., description="The scope of the Custodian Account to update or insert the properties onto.")], custodian_account_code : Annotated[StrictStr, Field(..., description="The unique ID of the custodian account to create or update properties for.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the Transaction Portfolio. Each property in
|
7778
|
+
def upsert_custodian_accounts_properties_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Transaction Portfolios to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="The code of the Transaction Portfolios to update or insert the properties onto. Together with the scope this uniquely identifies the Transaction Portfolios.")], custodian_account_scope : Annotated[StrictStr, Field(..., description="The scope of the Custodian Account to update or insert the properties onto.")], custodian_account_code : Annotated[StrictStr, Field(..., description="The unique ID of the custodian account to create or update properties for.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the Transaction Portfolio. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. \"CustodianAccount/Manager/Id\".")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
7779
7779
|
"""UpsertCustodianAccountsProperties: Upsert custodian accounts properties # noqa: E501
|
7780
7780
|
|
7781
|
-
Update or insert one or more properties onto a single custodian account. A property will be updated if it
|
7781
|
+
Update or insert one or more properties onto a single custodian account. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain 'CustodianAccount'. Upserting a property that exists for a Transaction Portfolios, with a null value, will delete the instance of the property for that group. Properties have an <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. # noqa: E501
|
7782
7782
|
This method makes a synchronous HTTP request by default. To make an
|
7783
7783
|
asynchronous HTTP request, please pass async_req=True
|
7784
7784
|
|
@@ -7793,7 +7793,7 @@ class TransactionPortfoliosApi:
|
|
7793
7793
|
:type custodian_account_scope: str
|
7794
7794
|
:param custodian_account_code: The unique ID of the custodian account to create or update properties for. (required)
|
7795
7795
|
:type custodian_account_code: str
|
7796
|
-
:param request_body: The properties to be updated or inserted onto the Transaction Portfolio. Each property in
|
7796
|
+
:param request_body: The properties to be updated or inserted onto the Transaction Portfolio. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. \"CustodianAccount/Manager/Id\".
|
7797
7797
|
:type request_body: Dict[str, ModelProperty]
|
7798
7798
|
:param async_req: Whether to execute the request asynchronously.
|
7799
7799
|
:type async_req: bool, optional
|
@@ -7919,18 +7919,18 @@ class TransactionPortfoliosApi:
|
|
7919
7919
|
|
7920
7920
|
|
7921
7921
|
@overload
|
7922
|
-
async def upsert_portfolio_details(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the
|
7922
|
+
async def upsert_portfolio_details(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], create_portfolio_details : Annotated[CreatePortfolioDetails, Field(..., description="The details to create or update for the specified transaction portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which the updated or inserted details should become valid. Defaults to the current LUSID system datetime if not specified.")] = None, **kwargs) -> PortfolioDetails: # noqa: E501
|
7923
7923
|
...
|
7924
7924
|
|
7925
7925
|
@overload
|
7926
|
-
def upsert_portfolio_details(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the
|
7926
|
+
def upsert_portfolio_details(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], create_portfolio_details : Annotated[CreatePortfolioDetails, Field(..., description="The details to create or update for the specified transaction portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which the updated or inserted details should become valid. Defaults to the current LUSID system datetime if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> PortfolioDetails: # noqa: E501
|
7927
7927
|
...
|
7928
7928
|
|
7929
7929
|
@validate_arguments
|
7930
|
-
def upsert_portfolio_details(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the
|
7930
|
+
def upsert_portfolio_details(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], create_portfolio_details : Annotated[CreatePortfolioDetails, Field(..., description="The details to create or update for the specified transaction portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which the updated or inserted details should become valid. Defaults to the current LUSID system datetime if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PortfolioDetails, Awaitable[PortfolioDetails]]: # noqa: E501
|
7931
7931
|
"""UpsertPortfolioDetails: Upsert portfolio details # noqa: E501
|
7932
7932
|
|
7933
|
-
Create or update certain details for a particular transaction portfolio. The details are updated if they already exist, and inserted if they do not.
|
7933
|
+
Create or update certain details for a particular transaction portfolio. The details are updated if they already exist, and inserted if they do not. Note that not all elements of a transaction portfolio definition are modifiable once it has been created due to the potential implications for data already stored. # noqa: E501
|
7934
7934
|
This method makes a synchronous HTTP request by default. To make an
|
7935
7935
|
asynchronous HTTP request, please pass async_req=True
|
7936
7936
|
|
@@ -7939,11 +7939,11 @@ class TransactionPortfoliosApi:
|
|
7939
7939
|
|
7940
7940
|
:param scope: The scope of the transaction portfolio. (required)
|
7941
7941
|
:type scope: str
|
7942
|
-
:param code: The code of the transaction portfolio. Together with the
|
7942
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
7943
7943
|
:type code: str
|
7944
7944
|
:param create_portfolio_details: The details to create or update for the specified transaction portfolio. (required)
|
7945
7945
|
:type create_portfolio_details: CreatePortfolioDetails
|
7946
|
-
:param effective_at: The effective datetime or cut label at which the updated or inserted details should become valid.
|
7946
|
+
:param effective_at: The effective datetime or cut label at which the updated or inserted details should become valid. Defaults to the current LUSID system datetime if not specified.
|
7947
7947
|
:type effective_at: str
|
7948
7948
|
:param async_req: Whether to execute the request asynchronously.
|
7949
7949
|
:type async_req: bool, optional
|
@@ -7964,10 +7964,10 @@ class TransactionPortfoliosApi:
|
|
7964
7964
|
return self.upsert_portfolio_details_with_http_info(scope, code, create_portfolio_details, effective_at, **kwargs) # noqa: E501
|
7965
7965
|
|
7966
7966
|
@validate_arguments
|
7967
|
-
def upsert_portfolio_details_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the
|
7967
|
+
def upsert_portfolio_details_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], create_portfolio_details : Annotated[CreatePortfolioDetails, Field(..., description="The details to create or update for the specified transaction portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which the updated or inserted details should become valid. Defaults to the current LUSID system datetime if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
7968
7968
|
"""UpsertPortfolioDetails: Upsert portfolio details # noqa: E501
|
7969
7969
|
|
7970
|
-
Create or update certain details for a particular transaction portfolio. The details are updated if they already exist, and inserted if they do not.
|
7970
|
+
Create or update certain details for a particular transaction portfolio. The details are updated if they already exist, and inserted if they do not. Note that not all elements of a transaction portfolio definition are modifiable once it has been created due to the potential implications for data already stored. # noqa: E501
|
7971
7971
|
This method makes a synchronous HTTP request by default. To make an
|
7972
7972
|
asynchronous HTTP request, please pass async_req=True
|
7973
7973
|
|
@@ -7976,11 +7976,11 @@ class TransactionPortfoliosApi:
|
|
7976
7976
|
|
7977
7977
|
:param scope: The scope of the transaction portfolio. (required)
|
7978
7978
|
:type scope: str
|
7979
|
-
:param code: The code of the transaction portfolio. Together with the
|
7979
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
7980
7980
|
:type code: str
|
7981
7981
|
:param create_portfolio_details: The details to create or update for the specified transaction portfolio. (required)
|
7982
7982
|
:type create_portfolio_details: CreatePortfolioDetails
|
7983
|
-
:param effective_at: The effective datetime or cut label at which the updated or inserted details should become valid.
|
7983
|
+
:param effective_at: The effective datetime or cut label at which the updated or inserted details should become valid. Defaults to the current LUSID system datetime if not specified.
|
7984
7984
|
:type effective_at: str
|
7985
7985
|
:param async_req: Whether to execute the request asynchronously.
|
7986
7986
|
:type async_req: bool, optional
|
@@ -8277,18 +8277,18 @@ class TransactionPortfoliosApi:
|
|
8277
8277
|
|
8278
8278
|
|
8279
8279
|
@overload
|
8280
|
-
async def upsert_transaction_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
8280
|
+
async def upsert_transaction_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], transaction_id : Annotated[StrictStr, Field(..., description="The unique ID of the transaction to create or update properties for.")], request_body : Annotated[Dict[str, PerpetualProperty], Field(..., description="The properties and their associated values to create or update.")], **kwargs) -> UpsertTransactionPropertiesResponse: # noqa: E501
|
8281
8281
|
...
|
8282
8282
|
|
8283
8283
|
@overload
|
8284
|
-
def upsert_transaction_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
8284
|
+
def upsert_transaction_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], transaction_id : Annotated[StrictStr, Field(..., description="The unique ID of the transaction to create or update properties for.")], request_body : Annotated[Dict[str, PerpetualProperty], Field(..., description="The properties and their associated values to create or update.")], async_req: Optional[bool]=True, **kwargs) -> UpsertTransactionPropertiesResponse: # noqa: E501
|
8285
8285
|
...
|
8286
8286
|
|
8287
8287
|
@validate_arguments
|
8288
|
-
def upsert_transaction_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
8288
|
+
def upsert_transaction_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], transaction_id : Annotated[StrictStr, Field(..., description="The unique ID of the transaction to create or update properties for.")], request_body : Annotated[Dict[str, PerpetualProperty], Field(..., description="The properties and their associated values to create or update.")], async_req: Optional[bool]=None, **kwargs) -> Union[UpsertTransactionPropertiesResponse, Awaitable[UpsertTransactionPropertiesResponse]]: # noqa: E501
|
8289
8289
|
"""UpsertTransactionProperties: Upsert transaction properties # noqa: E501
|
8290
8290
|
|
8291
|
-
Create or update one or more transaction properties for a single transaction in the transaction portfolio.
|
8291
|
+
Create or update one or more transaction properties for a single transaction in the transaction portfolio. Each property will be updated if it already exists and created if it does not. Both transaction and portfolio must exist at the time when properties are created or updated. # noqa: E501
|
8292
8292
|
This method makes a synchronous HTTP request by default. To make an
|
8293
8293
|
asynchronous HTTP request, please pass async_req=True
|
8294
8294
|
|
@@ -8297,7 +8297,7 @@ class TransactionPortfoliosApi:
|
|
8297
8297
|
|
8298
8298
|
:param scope: The scope of the transaction portfolio. (required)
|
8299
8299
|
:type scope: str
|
8300
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
8300
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
8301
8301
|
:type code: str
|
8302
8302
|
:param transaction_id: The unique ID of the transaction to create or update properties for. (required)
|
8303
8303
|
:type transaction_id: str
|
@@ -8322,10 +8322,10 @@ class TransactionPortfoliosApi:
|
|
8322
8322
|
return self.upsert_transaction_properties_with_http_info(scope, code, transaction_id, request_body, **kwargs) # noqa: E501
|
8323
8323
|
|
8324
8324
|
@validate_arguments
|
8325
|
-
def upsert_transaction_properties_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
8325
|
+
def upsert_transaction_properties_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], transaction_id : Annotated[StrictStr, Field(..., description="The unique ID of the transaction to create or update properties for.")], request_body : Annotated[Dict[str, PerpetualProperty], Field(..., description="The properties and their associated values to create or update.")], **kwargs) -> ApiResponse: # noqa: E501
|
8326
8326
|
"""UpsertTransactionProperties: Upsert transaction properties # noqa: E501
|
8327
8327
|
|
8328
|
-
Create or update one or more transaction properties for a single transaction in the transaction portfolio.
|
8328
|
+
Create or update one or more transaction properties for a single transaction in the transaction portfolio. Each property will be updated if it already exists and created if it does not. Both transaction and portfolio must exist at the time when properties are created or updated. # noqa: E501
|
8329
8329
|
This method makes a synchronous HTTP request by default. To make an
|
8330
8330
|
asynchronous HTTP request, please pass async_req=True
|
8331
8331
|
|
@@ -8334,7 +8334,7 @@ class TransactionPortfoliosApi:
|
|
8334
8334
|
|
8335
8335
|
:param scope: The scope of the transaction portfolio. (required)
|
8336
8336
|
:type scope: str
|
8337
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
8337
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
8338
8338
|
:type code: str
|
8339
8339
|
:param transaction_id: The unique ID of the transaction to create or update properties for. (required)
|
8340
8340
|
:type transaction_id: str
|
@@ -8460,18 +8460,18 @@ class TransactionPortfoliosApi:
|
|
8460
8460
|
|
8461
8461
|
|
8462
8462
|
@overload
|
8463
|
-
async def upsert_transactions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
8463
|
+
async def upsert_transactions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], transaction_request : Annotated[conlist(TransactionRequest), Field(..., description="A list of transactions to be created or updated.")], preserve_properties : Annotated[Optional[StrictBool], Field(description="If set to false, the entire property set will be overwritten by the provided properties. If not specified or set to true, only the properties provided will be updated.")] = None, data_model_scope : Annotated[Optional[StrictStr], Field( description="The optional scope of a Custom Data Model to use")] = None, data_model_code : Annotated[Optional[StrictStr], Field( description="The optional code of a Custom Data Model to use")] = None, **kwargs) -> UpsertPortfolioTransactionsResponse: # noqa: E501
|
8464
8464
|
...
|
8465
8465
|
|
8466
8466
|
@overload
|
8467
|
-
def upsert_transactions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
8467
|
+
def upsert_transactions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], transaction_request : Annotated[conlist(TransactionRequest), Field(..., description="A list of transactions to be created or updated.")], preserve_properties : Annotated[Optional[StrictBool], Field(description="If set to false, the entire property set will be overwritten by the provided properties. If not specified or set to true, only the properties provided will be updated.")] = None, data_model_scope : Annotated[Optional[StrictStr], Field( description="The optional scope of a Custom Data Model to use")] = None, data_model_code : Annotated[Optional[StrictStr], Field( description="The optional code of a Custom Data Model to use")] = None, async_req: Optional[bool]=True, **kwargs) -> UpsertPortfolioTransactionsResponse: # noqa: E501
|
8468
8468
|
...
|
8469
8469
|
|
8470
8470
|
@validate_arguments
|
8471
|
-
def upsert_transactions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
8471
|
+
def upsert_transactions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], transaction_request : Annotated[conlist(TransactionRequest), Field(..., description="A list of transactions to be created or updated.")], preserve_properties : Annotated[Optional[StrictBool], Field(description="If set to false, the entire property set will be overwritten by the provided properties. If not specified or set to true, only the properties provided will be updated.")] = None, data_model_scope : Annotated[Optional[StrictStr], Field( description="The optional scope of a Custom Data Model to use")] = None, data_model_code : Annotated[Optional[StrictStr], Field( description="The optional code of a Custom Data Model to use")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[UpsertPortfolioTransactionsResponse, Awaitable[UpsertPortfolioTransactionsResponse]]: # noqa: E501
|
8472
8472
|
"""UpsertTransactions: Upsert transactions # noqa: E501
|
8473
8473
|
|
8474
|
-
Create or update transactions in the transaction portfolio. A transaction will be updated
|
8474
|
+
Create or update transactions in the transaction portfolio. A transaction will be updated if it already exists and created if it does not. The maximum number of transactions that this method can upsert per request is 10,000. # noqa: E501
|
8475
8475
|
This method makes a synchronous HTTP request by default. To make an
|
8476
8476
|
asynchronous HTTP request, please pass async_req=True
|
8477
8477
|
|
@@ -8480,7 +8480,7 @@ class TransactionPortfoliosApi:
|
|
8480
8480
|
|
8481
8481
|
:param scope: The scope of the transaction portfolio. (required)
|
8482
8482
|
:type scope: str
|
8483
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
8483
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
8484
8484
|
:type code: str
|
8485
8485
|
:param transaction_request: A list of transactions to be created or updated. (required)
|
8486
8486
|
:type transaction_request: List[TransactionRequest]
|
@@ -8509,10 +8509,10 @@ class TransactionPortfoliosApi:
|
|
8509
8509
|
return self.upsert_transactions_with_http_info(scope, code, transaction_request, preserve_properties, data_model_scope, data_model_code, **kwargs) # noqa: E501
|
8510
8510
|
|
8511
8511
|
@validate_arguments
|
8512
|
-
def upsert_transactions_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies
|
8512
|
+
def upsert_transactions_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.")], transaction_request : Annotated[conlist(TransactionRequest), Field(..., description="A list of transactions to be created or updated.")], preserve_properties : Annotated[Optional[StrictBool], Field(description="If set to false, the entire property set will be overwritten by the provided properties. If not specified or set to true, only the properties provided will be updated.")] = None, data_model_scope : Annotated[Optional[StrictStr], Field( description="The optional scope of a Custom Data Model to use")] = None, data_model_code : Annotated[Optional[StrictStr], Field( description="The optional code of a Custom Data Model to use")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
8513
8513
|
"""UpsertTransactions: Upsert transactions # noqa: E501
|
8514
8514
|
|
8515
|
-
Create or update transactions in the transaction portfolio. A transaction will be updated
|
8515
|
+
Create or update transactions in the transaction portfolio. A transaction will be updated if it already exists and created if it does not. The maximum number of transactions that this method can upsert per request is 10,000. # noqa: E501
|
8516
8516
|
This method makes a synchronous HTTP request by default. To make an
|
8517
8517
|
asynchronous HTTP request, please pass async_req=True
|
8518
8518
|
|
@@ -8521,7 +8521,7 @@ class TransactionPortfoliosApi:
|
|
8521
8521
|
|
8522
8522
|
:param scope: The scope of the transaction portfolio. (required)
|
8523
8523
|
:type scope: str
|
8524
|
-
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies
|
8524
|
+
:param code: The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required)
|
8525
8525
|
:type code: str
|
8526
8526
|
:param transaction_request: A list of transactions to be created or updated. (required)
|
8527
8527
|
:type transaction_request: List[TransactionRequest]
|