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
lusid/api/tax_rule_sets_api.py
CHANGED
@@ -59,18 +59,18 @@ class TaxRuleSetsApi:
|
|
59
59
|
|
60
60
|
|
61
61
|
@overload
|
62
|
-
async def create_tax_rule_set(self, create_tax_rule_set_request : Annotated[CreateTaxRuleSetRequest, Field(..., description="The contents of the rule set.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which the rule set will take effect.
|
62
|
+
async def create_tax_rule_set(self, create_tax_rule_set_request : Annotated[CreateTaxRuleSetRequest, Field(..., description="The contents of the rule set.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which the rule set will take effect. Defaults to the current LUSID system datetime if not specified.")] = None, **kwargs) -> TaxRuleSet: # noqa: E501
|
63
63
|
...
|
64
64
|
|
65
65
|
@overload
|
66
|
-
def create_tax_rule_set(self, create_tax_rule_set_request : Annotated[CreateTaxRuleSetRequest, Field(..., description="The contents of the rule set.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which the rule set will take effect.
|
66
|
+
def create_tax_rule_set(self, create_tax_rule_set_request : Annotated[CreateTaxRuleSetRequest, Field(..., description="The contents of the rule set.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which the rule set will take effect. Defaults to the current LUSID system datetime if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> TaxRuleSet: # noqa: E501
|
67
67
|
...
|
68
68
|
|
69
69
|
@validate_arguments
|
70
|
-
def create_tax_rule_set(self, create_tax_rule_set_request : Annotated[CreateTaxRuleSetRequest, Field(..., description="The contents of the rule set.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which the rule set will take effect.
|
70
|
+
def create_tax_rule_set(self, create_tax_rule_set_request : Annotated[CreateTaxRuleSetRequest, Field(..., description="The contents of the rule set.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which the rule set will take effect. Defaults to the current LUSID system datetime if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[TaxRuleSet, Awaitable[TaxRuleSet]]: # noqa: E501
|
71
71
|
"""[EXPERIMENTAL] CreateTaxRuleSet: Create a tax rule set. # noqa: E501
|
72
72
|
|
73
|
-
Creates a tax rule set definition at the given effective time.
|
73
|
+
Creates a tax rule set definition at the given effective time. The user must be entitled to read any properties specified in each rule. # noqa: E501
|
74
74
|
This method makes a synchronous HTTP request by default. To make an
|
75
75
|
asynchronous HTTP request, please pass async_req=True
|
76
76
|
|
@@ -79,7 +79,7 @@ class TaxRuleSetsApi:
|
|
79
79
|
|
80
80
|
:param create_tax_rule_set_request: The contents of the rule set. (required)
|
81
81
|
:type create_tax_rule_set_request: CreateTaxRuleSetRequest
|
82
|
-
:param effective_at: The effective datetime or cut label at which the rule set will take effect.
|
82
|
+
:param effective_at: The effective datetime or cut label at which the rule set will take effect. Defaults to the current LUSID system datetime if not specified.
|
83
83
|
:type effective_at: str
|
84
84
|
:param async_req: Whether to execute the request asynchronously.
|
85
85
|
:type async_req: bool, optional
|
@@ -100,10 +100,10 @@ class TaxRuleSetsApi:
|
|
100
100
|
return self.create_tax_rule_set_with_http_info(create_tax_rule_set_request, effective_at, **kwargs) # noqa: E501
|
101
101
|
|
102
102
|
@validate_arguments
|
103
|
-
def create_tax_rule_set_with_http_info(self, create_tax_rule_set_request : Annotated[CreateTaxRuleSetRequest, Field(..., description="The contents of the rule set.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which the rule set will take effect.
|
103
|
+
def create_tax_rule_set_with_http_info(self, create_tax_rule_set_request : Annotated[CreateTaxRuleSetRequest, Field(..., description="The contents of the rule set.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which the rule set will take effect. Defaults to the current LUSID system datetime if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
104
104
|
"""[EXPERIMENTAL] CreateTaxRuleSet: Create a tax rule set. # noqa: E501
|
105
105
|
|
106
|
-
Creates a tax rule set definition at the given effective time.
|
106
|
+
Creates a tax rule set definition at the given effective time. The user must be entitled to read any properties specified in each rule. # noqa: E501
|
107
107
|
This method makes a synchronous HTTP request by default. To make an
|
108
108
|
asynchronous HTTP request, please pass async_req=True
|
109
109
|
|
@@ -112,7 +112,7 @@ class TaxRuleSetsApi:
|
|
112
112
|
|
113
113
|
:param create_tax_rule_set_request: The contents of the rule set. (required)
|
114
114
|
:type create_tax_rule_set_request: CreateTaxRuleSetRequest
|
115
|
-
:param effective_at: The effective datetime or cut label at which the rule set will take effect.
|
115
|
+
:param effective_at: The effective datetime or cut label at which the rule set will take effect. Defaults to the current LUSID system datetime if not specified.
|
116
116
|
:type effective_at: str
|
117
117
|
:param async_req: Whether to execute the request asynchronously.
|
118
118
|
:type async_req: bool, optional
|
@@ -237,7 +237,7 @@ class TaxRuleSetsApi:
|
|
237
237
|
def delete_tax_rule_set(self, scope : Annotated[StrictStr, Field(..., description="The rule set scope.")], code : Annotated[StrictStr, Field(..., description="The rule set code.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
238
238
|
"""[EXPERIMENTAL] DeleteTaxRuleSet: Delete a tax rule set. # noqa: E501
|
239
239
|
|
240
|
-
Deletes the rule set for all effective time.
|
240
|
+
Deletes the rule set for all effective time. The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. This cannot be undone. # noqa: E501
|
241
241
|
This method makes a synchronous HTTP request by default. To make an
|
242
242
|
asynchronous HTTP request, please pass async_req=True
|
243
243
|
|
@@ -270,7 +270,7 @@ class TaxRuleSetsApi:
|
|
270
270
|
def delete_tax_rule_set_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The rule set scope.")], code : Annotated[StrictStr, Field(..., description="The rule set code.")], **kwargs) -> ApiResponse: # noqa: E501
|
271
271
|
"""[EXPERIMENTAL] DeleteTaxRuleSet: Delete a tax rule set. # noqa: E501
|
272
272
|
|
273
|
-
Deletes the rule set for all effective time.
|
273
|
+
Deletes the rule set for all effective time. The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. This cannot be undone. # noqa: E501
|
274
274
|
This method makes a synchronous HTTP request by default. To make an
|
275
275
|
asynchronous HTTP request, please pass async_req=True
|
276
276
|
|
@@ -386,15 +386,15 @@ class TaxRuleSetsApi:
|
|
386
386
|
|
387
387
|
|
388
388
|
@overload
|
389
|
-
async def get_tax_rule_set(self, scope : Annotated[StrictStr, Field(..., description="The rule set scope.")], code : Annotated[StrictStr, Field(..., description="The rule set code.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definition.
|
389
|
+
async def get_tax_rule_set(self, scope : Annotated[StrictStr, Field(..., description="The rule set scope.")], code : Annotated[StrictStr, Field(..., description="The rule set code.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified.")] = None, **kwargs) -> TaxRuleSet: # noqa: E501
|
390
390
|
...
|
391
391
|
|
392
392
|
@overload
|
393
|
-
def get_tax_rule_set(self, scope : Annotated[StrictStr, Field(..., description="The rule set scope.")], code : Annotated[StrictStr, Field(..., description="The rule set code.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definition.
|
393
|
+
def get_tax_rule_set(self, scope : Annotated[StrictStr, Field(..., description="The rule set scope.")], code : Annotated[StrictStr, Field(..., description="The rule set code.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> TaxRuleSet: # noqa: E501
|
394
394
|
...
|
395
395
|
|
396
396
|
@validate_arguments
|
397
|
-
def get_tax_rule_set(self, scope : Annotated[StrictStr, Field(..., description="The rule set scope.")], code : Annotated[StrictStr, Field(..., description="The rule set code.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definition.
|
397
|
+
def get_tax_rule_set(self, scope : Annotated[StrictStr, Field(..., description="The rule set scope.")], code : Annotated[StrictStr, Field(..., description="The rule set code.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[TaxRuleSet, Awaitable[TaxRuleSet]]: # noqa: E501
|
398
398
|
"""[EXPERIMENTAL] GetTaxRuleSet: Retrieve the definition of single tax rule set. # noqa: E501
|
399
399
|
|
400
400
|
Retrieves the tax rule set definition at the given effective and as at times. # noqa: E501
|
@@ -408,9 +408,9 @@ class TaxRuleSetsApi:
|
|
408
408
|
:type scope: str
|
409
409
|
:param code: The rule set code. (required)
|
410
410
|
:type code: str
|
411
|
-
:param effective_at: The effective datetime or cut label at which to retrieve the rule definition.
|
411
|
+
:param effective_at: The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified.
|
412
412
|
:type effective_at: str
|
413
|
-
:param as_at: The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not
|
413
|
+
:param as_at: The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified.
|
414
414
|
:type as_at: datetime
|
415
415
|
:param async_req: Whether to execute the request asynchronously.
|
416
416
|
:type async_req: bool, optional
|
@@ -431,7 +431,7 @@ class TaxRuleSetsApi:
|
|
431
431
|
return self.get_tax_rule_set_with_http_info(scope, code, effective_at, as_at, **kwargs) # noqa: E501
|
432
432
|
|
433
433
|
@validate_arguments
|
434
|
-
def get_tax_rule_set_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The rule set scope.")], code : Annotated[StrictStr, Field(..., description="The rule set code.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definition.
|
434
|
+
def get_tax_rule_set_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The rule set scope.")], code : Annotated[StrictStr, Field(..., description="The rule set code.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
435
435
|
"""[EXPERIMENTAL] GetTaxRuleSet: Retrieve the definition of single tax rule set. # noqa: E501
|
436
436
|
|
437
437
|
Retrieves the tax rule set definition at the given effective and as at times. # noqa: E501
|
@@ -445,9 +445,9 @@ class TaxRuleSetsApi:
|
|
445
445
|
:type scope: str
|
446
446
|
:param code: The rule set code. (required)
|
447
447
|
:type code: str
|
448
|
-
:param effective_at: The effective datetime or cut label at which to retrieve the rule definition.
|
448
|
+
:param effective_at: The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified.
|
449
449
|
:type effective_at: str
|
450
|
-
:param as_at: The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not
|
450
|
+
:param as_at: The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified.
|
451
451
|
:type as_at: datetime
|
452
452
|
:param async_req: Whether to execute the request asynchronously.
|
453
453
|
:type async_req: bool, optional
|
@@ -565,15 +565,15 @@ class TaxRuleSetsApi:
|
|
565
565
|
|
566
566
|
|
567
567
|
@overload
|
568
|
-
async def list_tax_rule_sets(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definitions.
|
568
|
+
async def list_tax_rule_sets(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified.")] = None, **kwargs) -> ResourceListOfTaxRuleSet: # noqa: E501
|
569
569
|
...
|
570
570
|
|
571
571
|
@overload
|
572
|
-
def list_tax_rule_sets(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definitions.
|
572
|
+
def list_tax_rule_sets(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfTaxRuleSet: # noqa: E501
|
573
573
|
...
|
574
574
|
|
575
575
|
@validate_arguments
|
576
|
-
def list_tax_rule_sets(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definitions.
|
576
|
+
def list_tax_rule_sets(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfTaxRuleSet, Awaitable[ResourceListOfTaxRuleSet]]: # noqa: E501
|
577
577
|
"""[EXPERIMENTAL] ListTaxRuleSets: List tax rule sets. # noqa: E501
|
578
578
|
|
579
579
|
Retrieves all tax rule set definitions at the given effective and as at times # noqa: E501
|
@@ -583,9 +583,9 @@ class TaxRuleSetsApi:
|
|
583
583
|
>>> thread = api.list_tax_rule_sets(effective_at, as_at, async_req=True)
|
584
584
|
>>> result = thread.get()
|
585
585
|
|
586
|
-
:param effective_at: The effective datetime or cut label at which to retrieve the rule definitions.
|
586
|
+
:param effective_at: The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified.
|
587
587
|
:type effective_at: str
|
588
|
-
:param as_at: The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not
|
588
|
+
:param as_at: The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified.
|
589
589
|
:type as_at: datetime
|
590
590
|
:param async_req: Whether to execute the request asynchronously.
|
591
591
|
:type async_req: bool, optional
|
@@ -606,7 +606,7 @@ class TaxRuleSetsApi:
|
|
606
606
|
return self.list_tax_rule_sets_with_http_info(effective_at, as_at, **kwargs) # noqa: E501
|
607
607
|
|
608
608
|
@validate_arguments
|
609
|
-
def list_tax_rule_sets_with_http_info(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definitions.
|
609
|
+
def list_tax_rule_sets_with_http_info(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
610
610
|
"""[EXPERIMENTAL] ListTaxRuleSets: List tax rule sets. # noqa: E501
|
611
611
|
|
612
612
|
Retrieves all tax rule set definitions at the given effective and as at times # noqa: E501
|
@@ -616,9 +616,9 @@ class TaxRuleSetsApi:
|
|
616
616
|
>>> thread = api.list_tax_rule_sets_with_http_info(effective_at, as_at, async_req=True)
|
617
617
|
>>> result = thread.get()
|
618
618
|
|
619
|
-
:param effective_at: The effective datetime or cut label at which to retrieve the rule definitions.
|
619
|
+
:param effective_at: The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified.
|
620
620
|
:type effective_at: str
|
621
|
-
:param as_at: The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not
|
621
|
+
:param as_at: The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified.
|
622
622
|
:type as_at: datetime
|
623
623
|
:param async_req: Whether to execute the request asynchronously.
|
624
624
|
:type async_req: bool, optional
|
@@ -728,18 +728,18 @@ class TaxRuleSetsApi:
|
|
728
728
|
|
729
729
|
|
730
730
|
@overload
|
731
|
-
async def update_tax_rule_set(self, scope : Annotated[StrictStr, Field(..., description="The rule set scope.")], code : Annotated[StrictStr, Field(..., description="The rule set code.")], update_tax_rule_set_request : Annotated[UpdateTaxRuleSetRequest, Field(..., description="The contents of the rule set.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which the rule set will take effect.
|
731
|
+
async def update_tax_rule_set(self, scope : Annotated[StrictStr, Field(..., description="The rule set scope.")], code : Annotated[StrictStr, Field(..., description="The rule set code.")], update_tax_rule_set_request : Annotated[UpdateTaxRuleSetRequest, Field(..., description="The contents of the rule set.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which the rule set will take effect. Defaults to the current LUSID system datetime if not specified.")] = None, **kwargs) -> TaxRuleSet: # noqa: E501
|
732
732
|
...
|
733
733
|
|
734
734
|
@overload
|
735
|
-
def update_tax_rule_set(self, scope : Annotated[StrictStr, Field(..., description="The rule set scope.")], code : Annotated[StrictStr, Field(..., description="The rule set code.")], update_tax_rule_set_request : Annotated[UpdateTaxRuleSetRequest, Field(..., description="The contents of the rule set.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which the rule set will take effect.
|
735
|
+
def update_tax_rule_set(self, scope : Annotated[StrictStr, Field(..., description="The rule set scope.")], code : Annotated[StrictStr, Field(..., description="The rule set code.")], update_tax_rule_set_request : Annotated[UpdateTaxRuleSetRequest, Field(..., description="The contents of the rule set.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which the rule set will take effect. Defaults to the current LUSID system datetime if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> TaxRuleSet: # noqa: E501
|
736
736
|
...
|
737
737
|
|
738
738
|
@validate_arguments
|
739
|
-
def update_tax_rule_set(self, scope : Annotated[StrictStr, Field(..., description="The rule set scope.")], code : Annotated[StrictStr, Field(..., description="The rule set code.")], update_tax_rule_set_request : Annotated[UpdateTaxRuleSetRequest, Field(..., description="The contents of the rule set.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which the rule set will take effect.
|
739
|
+
def update_tax_rule_set(self, scope : Annotated[StrictStr, Field(..., description="The rule set scope.")], code : Annotated[StrictStr, Field(..., description="The rule set code.")], update_tax_rule_set_request : Annotated[UpdateTaxRuleSetRequest, Field(..., description="The contents of the rule set.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which the rule set will take effect. Defaults to the current LUSID system datetime if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[TaxRuleSet, Awaitable[TaxRuleSet]]: # noqa: E501
|
740
740
|
"""[EXPERIMENTAL] UpdateTaxRuleSet: Update a tax rule set. # noqa: E501
|
741
741
|
|
742
|
-
Updates the tax rule set definition at the given effective time.
|
742
|
+
Updates the tax rule set definition at the given effective time. The changes will take place from this effective time until the next effective time that the rule has been updated at. For example, consider a rule that has been created or updated effective at the first day of the coming month. An upsert effective from the current day will only change the definition until that day. An additional upsert at the same time (first day of the month) is required if the newly-updated definition is to supersede the future definition. The user must be entitled to read any properties specified in each rule. # noqa: E501
|
743
743
|
This method makes a synchronous HTTP request by default. To make an
|
744
744
|
asynchronous HTTP request, please pass async_req=True
|
745
745
|
|
@@ -752,7 +752,7 @@ class TaxRuleSetsApi:
|
|
752
752
|
:type code: str
|
753
753
|
:param update_tax_rule_set_request: The contents of the rule set. (required)
|
754
754
|
:type update_tax_rule_set_request: UpdateTaxRuleSetRequest
|
755
|
-
:param effective_at: The effective datetime or cut label at which the rule set will take effect.
|
755
|
+
:param effective_at: The effective datetime or cut label at which the rule set will take effect. Defaults to the current LUSID system datetime if not specified.
|
756
756
|
:type effective_at: str
|
757
757
|
:param async_req: Whether to execute the request asynchronously.
|
758
758
|
:type async_req: bool, optional
|
@@ -773,10 +773,10 @@ class TaxRuleSetsApi:
|
|
773
773
|
return self.update_tax_rule_set_with_http_info(scope, code, update_tax_rule_set_request, effective_at, **kwargs) # noqa: E501
|
774
774
|
|
775
775
|
@validate_arguments
|
776
|
-
def update_tax_rule_set_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The rule set scope.")], code : Annotated[StrictStr, Field(..., description="The rule set code.")], update_tax_rule_set_request : Annotated[UpdateTaxRuleSetRequest, Field(..., description="The contents of the rule set.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which the rule set will take effect.
|
776
|
+
def update_tax_rule_set_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The rule set scope.")], code : Annotated[StrictStr, Field(..., description="The rule set code.")], update_tax_rule_set_request : Annotated[UpdateTaxRuleSetRequest, Field(..., description="The contents of the rule set.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which the rule set will take effect. Defaults to the current LUSID system datetime if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
777
777
|
"""[EXPERIMENTAL] UpdateTaxRuleSet: Update a tax rule set. # noqa: E501
|
778
778
|
|
779
|
-
Updates the tax rule set definition at the given effective time.
|
779
|
+
Updates the tax rule set definition at the given effective time. The changes will take place from this effective time until the next effective time that the rule has been updated at. For example, consider a rule that has been created or updated effective at the first day of the coming month. An upsert effective from the current day will only change the definition until that day. An additional upsert at the same time (first day of the month) is required if the newly-updated definition is to supersede the future definition. The user must be entitled to read any properties specified in each rule. # noqa: E501
|
780
780
|
This method makes a synchronous HTTP request by default. To make an
|
781
781
|
asynchronous HTTP request, please pass async_req=True
|
782
782
|
|
@@ -789,7 +789,7 @@ class TaxRuleSetsApi:
|
|
789
789
|
:type code: str
|
790
790
|
:param update_tax_rule_set_request: The contents of the rule set. (required)
|
791
791
|
:type update_tax_rule_set_request: UpdateTaxRuleSetRequest
|
792
|
-
:param effective_at: The effective datetime or cut label at which the rule set will take effect.
|
792
|
+
:param effective_at: The effective datetime or cut label at which the rule set will take effect. Defaults to the current LUSID system datetime if not specified.
|
793
793
|
:type effective_at: str
|
794
794
|
:param async_req: Whether to execute the request asynchronously.
|
795
795
|
:type async_req: bool, optional
|