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/blocks_api.py
CHANGED
@@ -70,7 +70,7 @@ class BlocksApi:
|
|
70
70
|
def delete_block(self, scope : Annotated[StrictStr, Field(..., description="The block scope.")], code : Annotated[StrictStr, Field(..., description="The block's code. This, together with the scope uniquely identifies the block to delete.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
71
71
|
"""[EARLY ACCESS] DeleteBlock: Delete block # noqa: E501
|
72
72
|
|
73
|
-
Delete an block. Deletion will be valid from the block's creation datetime.
|
73
|
+
Delete an block. Deletion will be valid from the block's creation datetime. This means that the block will no longer exist at any effective datetime from the asAt datetime of deletion. # 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
|
|
@@ -103,7 +103,7 @@ class BlocksApi:
|
|
103
103
|
def delete_block_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The block scope.")], code : Annotated[StrictStr, Field(..., description="The block's code. This, together with the scope uniquely identifies the block to delete.")], **kwargs) -> ApiResponse: # noqa: E501
|
104
104
|
"""[EARLY ACCESS] DeleteBlock: Delete block # noqa: E501
|
105
105
|
|
106
|
-
Delete an block. Deletion will be valid from the block's creation datetime.
|
106
|
+
Delete an block. Deletion will be valid from the block's creation datetime. This means that the block will no longer exist at any effective datetime from the asAt datetime of deletion. # 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
|
|
@@ -219,15 +219,15 @@ class BlocksApi:
|
|
219
219
|
|
220
220
|
|
221
221
|
@overload
|
222
|
-
async def get_block(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the block belongs.")], code : Annotated[StrictStr, Field(..., description="The block's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Block\" domain to decorate onto the block.
|
222
|
+
async def get_block(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the block belongs.")], code : Annotated[StrictStr, Field(..., description="The block's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Block\" domain to decorate onto the block. These take the format {domain}/{scope}/{code} e.g. \"Block/system/Name\".")] = None, **kwargs) -> Block: # noqa: E501
|
223
223
|
...
|
224
224
|
|
225
225
|
@overload
|
226
|
-
def get_block(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the block belongs.")], code : Annotated[StrictStr, Field(..., description="The block's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Block\" domain to decorate onto the block.
|
226
|
+
def get_block(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the block belongs.")], code : Annotated[StrictStr, Field(..., description="The block's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Block\" domain to decorate onto the block. These take the format {domain}/{scope}/{code} e.g. \"Block/system/Name\".")] = None, async_req: Optional[bool]=True, **kwargs) -> Block: # noqa: E501
|
227
227
|
...
|
228
228
|
|
229
229
|
@validate_arguments
|
230
|
-
def get_block(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the block belongs.")], code : Annotated[StrictStr, Field(..., description="The block's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Block\" domain to decorate onto the block.
|
230
|
+
def get_block(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the block belongs.")], code : Annotated[StrictStr, Field(..., description="The block's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Block\" domain to decorate onto the block. These take the format {domain}/{scope}/{code} e.g. \"Block/system/Name\".")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Block, Awaitable[Block]]: # noqa: E501
|
231
231
|
"""[EARLY ACCESS] GetBlock: Get Block # noqa: E501
|
232
232
|
|
233
233
|
Fetch a Block that matches the specified identifier # noqa: E501
|
@@ -243,7 +243,7 @@ class BlocksApi:
|
|
243
243
|
:type code: str
|
244
244
|
:param as_at: The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified.
|
245
245
|
:type as_at: datetime
|
246
|
-
:param property_keys: A list of property keys from the \"Block\" domain to decorate onto the block.
|
246
|
+
:param property_keys: A list of property keys from the \"Block\" domain to decorate onto the block. These take the format {domain}/{scope}/{code} e.g. \"Block/system/Name\".
|
247
247
|
:type property_keys: List[str]
|
248
248
|
:param async_req: Whether to execute the request asynchronously.
|
249
249
|
:type async_req: bool, optional
|
@@ -264,7 +264,7 @@ class BlocksApi:
|
|
264
264
|
return self.get_block_with_http_info(scope, code, as_at, property_keys, **kwargs) # noqa: E501
|
265
265
|
|
266
266
|
@validate_arguments
|
267
|
-
def get_block_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the block belongs.")], code : Annotated[StrictStr, Field(..., description="The block's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Block\" domain to decorate onto the block.
|
267
|
+
def get_block_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the block belongs.")], code : Annotated[StrictStr, Field(..., description="The block's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Block\" domain to decorate onto the block. These take the format {domain}/{scope}/{code} e.g. \"Block/system/Name\".")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
268
268
|
"""[EARLY ACCESS] GetBlock: Get Block # noqa: E501
|
269
269
|
|
270
270
|
Fetch a Block that matches the specified identifier # noqa: E501
|
@@ -280,7 +280,7 @@ class BlocksApi:
|
|
280
280
|
:type code: str
|
281
281
|
:param as_at: The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified.
|
282
282
|
:type as_at: datetime
|
283
|
-
:param property_keys: A list of property keys from the \"Block\" domain to decorate onto the block.
|
283
|
+
:param property_keys: A list of property keys from the \"Block\" domain to decorate onto the block. These take the format {domain}/{scope}/{code} e.g. \"Block/system/Name\".
|
284
284
|
:type property_keys: List[str]
|
285
285
|
:param async_req: Whether to execute the request asynchronously.
|
286
286
|
:type async_req: bool, optional
|
@@ -399,15 +399,15 @@ class BlocksApi:
|
|
399
399
|
|
400
400
|
|
401
401
|
@overload
|
402
|
-
async def list_blocks(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing blocks from a previous call to list blocks.
|
402
|
+
async def list_blocks(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing blocks from a previous call to list blocks. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = 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, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = 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, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Block\" domain to decorate onto each block. These take the format {domain}/{scope}/{code} e.g. \"Block/system/Name\". All properties, except derived properties, are returned by default, without specifying here.")] = None, **kwargs) -> PagedResourceListOfBlock: # noqa: E501
|
403
403
|
...
|
404
404
|
|
405
405
|
@overload
|
406
|
-
def list_blocks(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing blocks from a previous call to list blocks.
|
406
|
+
def list_blocks(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing blocks from a previous call to list blocks. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = 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, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = 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, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Block\" domain to decorate onto each block. These take the format {domain}/{scope}/{code} e.g. \"Block/system/Name\". All properties, except derived properties, are returned by default, without specifying here.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfBlock: # noqa: E501
|
407
407
|
...
|
408
408
|
|
409
409
|
@validate_arguments
|
410
|
-
def list_blocks(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing blocks from a previous call to list blocks.
|
410
|
+
def list_blocks(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing blocks from a previous call to list blocks. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = 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, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = 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, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Block\" domain to decorate onto each block. These take the format {domain}/{scope}/{code} e.g. \"Block/system/Name\". All properties, except derived properties, are returned by default, without specifying here.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfBlock, Awaitable[PagedResourceListOfBlock]]: # noqa: E501
|
411
411
|
"""[EARLY ACCESS] ListBlocks: List Blocks # noqa: E501
|
412
412
|
|
413
413
|
Fetch the last pre-AsAt date version of each block in scope (does not fetch the entire history). # noqa: E501
|
@@ -419,15 +419,15 @@ class BlocksApi:
|
|
419
419
|
|
420
420
|
:param as_at: The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified.
|
421
421
|
:type as_at: datetime
|
422
|
-
:param page: The pagination token to use to continue listing blocks from a previous call to list blocks.
|
422
|
+
:param page: The pagination token to use to continue listing blocks from a previous call to list blocks. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
423
423
|
:type page: str
|
424
424
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
425
425
|
:type sort_by: List[str]
|
426
426
|
:param limit: When paginating, limit the number of returned results to this many.
|
427
427
|
:type limit: int
|
428
|
-
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here:
|
428
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
429
429
|
:type filter: str
|
430
|
-
:param property_keys: A list of property keys from the \"Block\" domain to decorate onto each block.
|
430
|
+
:param property_keys: A list of property keys from the \"Block\" domain to decorate onto each block. These take the format {domain}/{scope}/{code} e.g. \"Block/system/Name\". All properties, except derived properties, are returned by default, without specifying here.
|
431
431
|
:type property_keys: List[str]
|
432
432
|
:param async_req: Whether to execute the request asynchronously.
|
433
433
|
:type async_req: bool, optional
|
@@ -448,7 +448,7 @@ class BlocksApi:
|
|
448
448
|
return self.list_blocks_with_http_info(as_at, page, sort_by, limit, filter, property_keys, **kwargs) # noqa: E501
|
449
449
|
|
450
450
|
@validate_arguments
|
451
|
-
def list_blocks_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing blocks from a previous call to list blocks.
|
451
|
+
def list_blocks_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing blocks from a previous call to list blocks. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = 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, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = 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, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Block\" domain to decorate onto each block. These take the format {domain}/{scope}/{code} e.g. \"Block/system/Name\". All properties, except derived properties, are returned by default, without specifying here.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
452
452
|
"""[EARLY ACCESS] ListBlocks: List Blocks # noqa: E501
|
453
453
|
|
454
454
|
Fetch the last pre-AsAt date version of each block in scope (does not fetch the entire history). # noqa: E501
|
@@ -460,15 +460,15 @@ class BlocksApi:
|
|
460
460
|
|
461
461
|
:param as_at: The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified.
|
462
462
|
:type as_at: datetime
|
463
|
-
:param page: The pagination token to use to continue listing blocks from a previous call to list blocks.
|
463
|
+
:param page: The pagination token to use to continue listing blocks from a previous call to list blocks. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
464
464
|
:type page: str
|
465
465
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
466
466
|
:type sort_by: List[str]
|
467
467
|
:param limit: When paginating, limit the number of returned results to this many.
|
468
468
|
:type limit: int
|
469
|
-
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here:
|
469
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
470
470
|
:type filter: str
|
471
|
-
:param property_keys: A list of property keys from the \"Block\" domain to decorate onto each block.
|
471
|
+
:param property_keys: A list of property keys from the \"Block\" domain to decorate onto each block. These take the format {domain}/{scope}/{code} e.g. \"Block/system/Name\". All properties, except derived properties, are returned by default, without specifying here.
|
472
472
|
:type property_keys: List[str]
|
473
473
|
:param async_req: Whether to execute the request asynchronously.
|
474
474
|
:type async_req: bool, optional
|
lusid/api/calendars_api.py
CHANGED
@@ -77,7 +77,7 @@ class CalendarsApi:
|
|
77
77
|
def add_business_days_to_date(self, scope : Annotated[StrictStr, Field(..., description="Scope within which to search for the calendars")], add_business_days_to_date_request : Annotated[AddBusinessDaysToDateRequest, Field(..., description="Request Details: start date, number of days to add (which can be negative, but not zero), calendar codes and optionally an AsAt date for searching the calendar store")], async_req: Optional[bool]=None, **kwargs) -> Union[AddBusinessDaysToDateResponse, Awaitable[AddBusinessDaysToDateResponse]]: # noqa: E501
|
78
78
|
"""[EARLY ACCESS] AddBusinessDaysToDate: Adds the requested number of Business Days to the provided date. # noqa: E501
|
79
79
|
|
80
|
-
A Business day is defined as a point in time that:
|
80
|
+
A Business day is defined as a point in time that: * Does not represent a day in the calendar's weekend * Does not represent a day in the calendar's list of holidays (e.g. Christmas Day in the UK) All dates specified must be UTC and the upper bound of a calendar is not inclusive e.g. From: 2020-12-24-00-00-00: Adding 3 business days returns 2020-12-30, assuming Saturday and Sunday are weekends, and the 25th and 28th are holidays. Adding -2 business days returns 2020-12-22 under the same assumptions. If the provided number of days to add is zero, returns a failure. # noqa: E501
|
81
81
|
This method makes a synchronous HTTP request by default. To make an
|
82
82
|
asynchronous HTTP request, please pass async_req=True
|
83
83
|
|
@@ -110,7 +110,7 @@ class CalendarsApi:
|
|
110
110
|
def add_business_days_to_date_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="Scope within which to search for the calendars")], add_business_days_to_date_request : Annotated[AddBusinessDaysToDateRequest, Field(..., description="Request Details: start date, number of days to add (which can be negative, but not zero), calendar codes and optionally an AsAt date for searching the calendar store")], **kwargs) -> ApiResponse: # noqa: E501
|
111
111
|
"""[EARLY ACCESS] AddBusinessDaysToDate: Adds the requested number of Business Days to the provided date. # noqa: E501
|
112
112
|
|
113
|
-
A Business day is defined as a point in time that:
|
113
|
+
A Business day is defined as a point in time that: * Does not represent a day in the calendar's weekend * Does not represent a day in the calendar's list of holidays (e.g. Christmas Day in the UK) All dates specified must be UTC and the upper bound of a calendar is not inclusive e.g. From: 2020-12-24-00-00-00: Adding 3 business days returns 2020-12-30, assuming Saturday and Sunday are weekends, and the 25th and 28th are holidays. Adding -2 business days returns 2020-12-22 under the same assumptions. If the provided number of days to add is zero, returns a failure. # noqa: E501
|
114
114
|
This method makes a synchronous HTTP request by default. To make an
|
115
115
|
asynchronous HTTP request, please pass async_req=True
|
116
116
|
|
@@ -244,7 +244,7 @@ class CalendarsApi:
|
|
244
244
|
def add_date_to_calendar(self, scope : Annotated[StrictStr, Field(..., description="Scope of the calendar")], code : Annotated[StrictStr, Field(..., description="Code of the calendar")], create_date_request : Annotated[CreateDateRequest, Field(..., description="Add date to calendar request")], async_req: Optional[bool]=None, **kwargs) -> Union[CalendarDate, Awaitable[CalendarDate]]: # noqa: E501
|
245
245
|
"""AddDateToCalendar: Add a date to a calendar # noqa: E501
|
246
246
|
|
247
|
-
Add an event to the calendar. These Events can be a maximum of 24 hours and must be specified in UTC.
|
247
|
+
Add an event to the calendar. These Events can be a maximum of 24 hours and must be specified in UTC. A local date will be calculated by the system and applied to the calendar before processing. # noqa: E501
|
248
248
|
This method makes a synchronous HTTP request by default. To make an
|
249
249
|
asynchronous HTTP request, please pass async_req=True
|
250
250
|
|
@@ -279,7 +279,7 @@ class CalendarsApi:
|
|
279
279
|
def add_date_to_calendar_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="Scope of the calendar")], code : Annotated[StrictStr, Field(..., description="Code of the calendar")], create_date_request : Annotated[CreateDateRequest, Field(..., description="Add date to calendar request")], **kwargs) -> ApiResponse: # noqa: E501
|
280
280
|
"""AddDateToCalendar: Add a date to a calendar # noqa: E501
|
281
281
|
|
282
|
-
Add an event to the calendar. These Events can be a maximum of 24 hours and must be specified in UTC.
|
282
|
+
Add an event to the calendar. These Events can be a maximum of 24 hours and must be specified in UTC. A local date will be calculated by the system and applied to the calendar before processing. # noqa: E501
|
283
283
|
This method makes a synchronous HTTP request by default. To make an
|
284
284
|
asynchronous HTTP request, please pass async_req=True
|
285
285
|
|
@@ -419,7 +419,7 @@ class CalendarsApi:
|
|
419
419
|
def batch_upsert_dates_for_calendar(self, scope : Annotated[StrictStr, Field(..., description="Scope of the calendar")], code : Annotated[StrictStr, Field(..., description="Code of the calendar")], 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, CreateDateRequest], Field(..., description="Create Date Requests of dates to upsert")], async_req: Optional[bool]=None, **kwargs) -> Union[BatchUpsertDatesForCalendarResponse, Awaitable[BatchUpsertDatesForCalendarResponse]]: # noqa: E501
|
420
420
|
"""BatchUpsertDatesForCalendar: Batch upsert dates to a calendar # noqa: E501
|
421
421
|
|
422
|
-
Create or update events in the calendar. These Events can be a maximum of 24 hours and must be specified in UTC.
|
422
|
+
Create or update events in the calendar. These Events can be a maximum of 24 hours and must be specified in UTC. A local date will be calculated by the system and applied to the calendar before processing. # noqa: E501
|
423
423
|
This method makes a synchronous HTTP request by default. To make an
|
424
424
|
asynchronous HTTP request, please pass async_req=True
|
425
425
|
|
@@ -456,7 +456,7 @@ class CalendarsApi:
|
|
456
456
|
def batch_upsert_dates_for_calendar_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="Scope of the calendar")], code : Annotated[StrictStr, Field(..., description="Code of the calendar")], 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, CreateDateRequest], Field(..., description="Create Date Requests of dates to upsert")], **kwargs) -> ApiResponse: # noqa: E501
|
457
457
|
"""BatchUpsertDatesForCalendar: Batch upsert dates to a calendar # noqa: E501
|
458
458
|
|
459
|
-
Create or update events in the calendar. These Events can be a maximum of 24 hours and must be specified in UTC.
|
459
|
+
Create or update events in the calendar. These Events can be a maximum of 24 hours and must be specified in UTC. A local date will be calculated by the system and applied to the calendar before processing. # noqa: E501
|
460
460
|
This method makes a synchronous HTTP request by default. To make an
|
461
461
|
asynchronous HTTP request, please pass async_req=True
|
462
462
|
|
@@ -1264,7 +1264,7 @@ class CalendarsApi:
|
|
1264
1264
|
def generate_schedule(self, scope : Annotated[StrictStr, Field(..., description="Scope of the calendars to use")], valuation_schedule : Annotated[ValuationSchedule, Field(..., description="The ValuationSchedule to generate schedule dates from")], as_at : Annotated[Optional[datetime], Field(description="Optional AsAt for searching the calendar store. Defaults to Latest.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[List[datetime], Awaitable[List[datetime]]]: # noqa: E501
|
1265
1265
|
"""[EARLY ACCESS] GenerateSchedule: Generate an ordered schedule of dates. # noqa: E501
|
1266
1266
|
|
1267
|
-
Returns an ordered array of dates. The dates will only fall on business
|
1267
|
+
Returns an ordered array of dates. The dates will only fall on business days as defined by the scope and calendar codes in the valuation schedule. Valuations are made at a frequency defined by the valuation schedule's tenor, e.g. every day (\"1D\"), every other week (\"2W\") etc. These dates will be adjusted onto business days as defined by the schedule's rollConvention. # noqa: E501
|
1268
1268
|
This method makes a synchronous HTTP request by default. To make an
|
1269
1269
|
asynchronous HTTP request, please pass async_req=True
|
1270
1270
|
|
@@ -1299,7 +1299,7 @@ class CalendarsApi:
|
|
1299
1299
|
def generate_schedule_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="Scope of the calendars to use")], valuation_schedule : Annotated[ValuationSchedule, Field(..., description="The ValuationSchedule to generate schedule dates from")], as_at : Annotated[Optional[datetime], Field(description="Optional AsAt for searching the calendar store. Defaults to Latest.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1300
1300
|
"""[EARLY ACCESS] GenerateSchedule: Generate an ordered schedule of dates. # noqa: E501
|
1301
1301
|
|
1302
|
-
Returns an ordered array of dates. The dates will only fall on business
|
1302
|
+
Returns an ordered array of dates. The dates will only fall on business days as defined by the scope and calendar codes in the valuation schedule. Valuations are made at a frequency defined by the valuation schedule's tenor, e.g. every day (\"1D\"), every other week (\"2W\") etc. These dates will be adjusted onto business days as defined by the schedule's rollConvention. # noqa: E501
|
1303
1303
|
This method makes a synchronous HTTP request by default. To make an
|
1304
1304
|
asynchronous HTTP request, please pass async_req=True
|
1305
1305
|
|
@@ -1431,15 +1431,15 @@ class CalendarsApi:
|
|
1431
1431
|
|
1432
1432
|
|
1433
1433
|
@overload
|
1434
|
-
async def get_calendar(self, scope : Annotated[StrictStr, Field(..., description="Scope of the calendar identifier")], code : Annotated[StrictStr, Field(..., description="Code of the calendar identifier")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Calendar\" domain to decorate onto the calendar,
|
1434
|
+
async def get_calendar(self, scope : Annotated[StrictStr, Field(..., description="Scope of the calendar identifier")], code : Annotated[StrictStr, Field(..., description="Code of the calendar identifier")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Calendar\" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. \"Calendar/System/Name\".")] = None, as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the calendar")] = None, **kwargs) -> Calendar: # noqa: E501
|
1435
1435
|
...
|
1436
1436
|
|
1437
1437
|
@overload
|
1438
|
-
def get_calendar(self, scope : Annotated[StrictStr, Field(..., description="Scope of the calendar identifier")], code : Annotated[StrictStr, Field(..., description="Code of the calendar identifier")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Calendar\" domain to decorate onto the calendar,
|
1438
|
+
def get_calendar(self, scope : Annotated[StrictStr, Field(..., description="Scope of the calendar identifier")], code : Annotated[StrictStr, Field(..., description="Code of the calendar identifier")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Calendar\" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. \"Calendar/System/Name\".")] = None, as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the calendar")] = None, async_req: Optional[bool]=True, **kwargs) -> Calendar: # noqa: E501
|
1439
1439
|
...
|
1440
1440
|
|
1441
1441
|
@validate_arguments
|
1442
|
-
def get_calendar(self, scope : Annotated[StrictStr, Field(..., description="Scope of the calendar identifier")], code : Annotated[StrictStr, Field(..., description="Code of the calendar identifier")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Calendar\" domain to decorate onto the calendar,
|
1442
|
+
def get_calendar(self, scope : Annotated[StrictStr, Field(..., description="Scope of the calendar identifier")], code : Annotated[StrictStr, Field(..., description="Code of the calendar identifier")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Calendar\" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. \"Calendar/System/Name\".")] = None, as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the calendar")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Calendar, Awaitable[Calendar]]: # noqa: E501
|
1443
1443
|
"""GetCalendar: Get a calendar in its generic form # noqa: E501
|
1444
1444
|
|
1445
1445
|
Retrieve a generic calendar by a specific ID at a point in AsAt time # noqa: E501
|
@@ -1453,7 +1453,7 @@ class CalendarsApi:
|
|
1453
1453
|
:type scope: str
|
1454
1454
|
:param code: Code of the calendar identifier (required)
|
1455
1455
|
:type code: str
|
1456
|
-
:param property_keys: A list of property keys from the \"Calendar\" domain to decorate onto the calendar,
|
1456
|
+
:param property_keys: A list of property keys from the \"Calendar\" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. \"Calendar/System/Name\".
|
1457
1457
|
:type property_keys: List[str]
|
1458
1458
|
:param as_at: The AsAt datetime at which to retrieve the calendar
|
1459
1459
|
:type as_at: datetime
|
@@ -1476,7 +1476,7 @@ class CalendarsApi:
|
|
1476
1476
|
return self.get_calendar_with_http_info(scope, code, property_keys, as_at, **kwargs) # noqa: E501
|
1477
1477
|
|
1478
1478
|
@validate_arguments
|
1479
|
-
def get_calendar_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="Scope of the calendar identifier")], code : Annotated[StrictStr, Field(..., description="Code of the calendar identifier")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Calendar\" domain to decorate onto the calendar,
|
1479
|
+
def get_calendar_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="Scope of the calendar identifier")], code : Annotated[StrictStr, Field(..., description="Code of the calendar identifier")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Calendar\" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. \"Calendar/System/Name\".")] = None, as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the calendar")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1480
1480
|
"""GetCalendar: Get a calendar in its generic form # noqa: E501
|
1481
1481
|
|
1482
1482
|
Retrieve a generic calendar by a specific ID at a point in AsAt time # noqa: E501
|
@@ -1490,7 +1490,7 @@ class CalendarsApi:
|
|
1490
1490
|
:type scope: str
|
1491
1491
|
:param code: Code of the calendar identifier (required)
|
1492
1492
|
:type code: str
|
1493
|
-
:param property_keys: A list of property keys from the \"Calendar\" domain to decorate onto the calendar,
|
1493
|
+
:param property_keys: A list of property keys from the \"Calendar\" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. \"Calendar/System/Name\".
|
1494
1494
|
:type property_keys: List[str]
|
1495
1495
|
:param as_at: The AsAt datetime at which to retrieve the calendar
|
1496
1496
|
:type as_at: datetime
|
@@ -1622,7 +1622,7 @@ class CalendarsApi:
|
|
1622
1622
|
def get_dates(self, scope : Annotated[StrictStr, Field(..., description="Scope of the calendar")], code : Annotated[StrictStr, Field(..., description="Code of the calendar")], from_effective_at : Annotated[Optional[StrictStr], Field( description="Where the effective window of dates should begin from")] = None, to_effective_at : Annotated[Optional[StrictStr], Field( description="Where the effective window of dates should end")] = None, as_at : Annotated[Optional[datetime], Field(description="AsAt the dates should be retrieved at")] = None, id_filter : Annotated[Optional[conlist(StrictStr)], Field(description="An additional filter that will filter dates based on their identifer")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfCalendarDate, Awaitable[ResourceListOfCalendarDate]]: # noqa: E501
|
1623
1623
|
"""[EARLY ACCESS] GetDates: Get dates for a specific calendar # noqa: E501
|
1624
1624
|
|
1625
|
-
Get dates from a specific calendar within a specific window of effective time, at a point in AsAt time.
|
1625
|
+
Get dates from a specific calendar within a specific window of effective time, at a point in AsAt time. Providing an id filter can further refine the results. # noqa: E501
|
1626
1626
|
This method makes a synchronous HTTP request by default. To make an
|
1627
1627
|
asynchronous HTTP request, please pass async_req=True
|
1628
1628
|
|
@@ -1663,7 +1663,7 @@ class CalendarsApi:
|
|
1663
1663
|
def get_dates_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="Scope of the calendar")], code : Annotated[StrictStr, Field(..., description="Code of the calendar")], from_effective_at : Annotated[Optional[StrictStr], Field( description="Where the effective window of dates should begin from")] = None, to_effective_at : Annotated[Optional[StrictStr], Field( description="Where the effective window of dates should end")] = None, as_at : Annotated[Optional[datetime], Field(description="AsAt the dates should be retrieved at")] = None, id_filter : Annotated[Optional[conlist(StrictStr)], Field(description="An additional filter that will filter dates based on their identifer")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1664
1664
|
"""[EARLY ACCESS] GetDates: Get dates for a specific calendar # noqa: E501
|
1665
1665
|
|
1666
|
-
Get dates from a specific calendar within a specific window of effective time, at a point in AsAt time.
|
1666
|
+
Get dates from a specific calendar within a specific window of effective time, at a point in AsAt time. Providing an id filter can further refine the results. # noqa: E501
|
1667
1667
|
This method makes a synchronous HTTP request by default. To make an
|
1668
1668
|
asynchronous HTTP request, please pass async_req=True
|
1669
1669
|
|
@@ -1818,7 +1818,7 @@ class CalendarsApi:
|
|
1818
1818
|
def is_business_date_time(self, date_time : Annotated[datetime, Field(..., description="DateTime to check - This DateTime must be UTC")], scope : Annotated[StrictStr, Field(..., description="Scope of the calendar")], code : Annotated[StrictStr, Field(..., description="Code of the calendar")], as_at : Annotated[Optional[datetime], Field(description="AsAt for the request")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[IsBusinessDayResponse, Awaitable[IsBusinessDayResponse]]: # noqa: E501
|
1819
1819
|
"""[EARLY ACCESS] IsBusinessDateTime: Check whether a DateTime is a \"Business DateTime\" # noqa: E501
|
1820
1820
|
|
1821
|
-
A Business DateTime is defined as a point in time that:
|
1821
|
+
A Business DateTime is defined as a point in time that: * Does not represent a day that overlaps with the calendars WeekendMask * If the calendar is a \"Holiday Calendar\" Does not overlap with any dates in the calendar * If the calendar is a \"TradingHours Calendar\" Does overlap with a date in the calendar All dates specified must be UTC and the upper bound of a calendar is not inclusive e.g. From: 2020-12-25-00-00-00 To: 2020-12-26-00-00-00 IsBusinessDay(2020-12-26-00-00-00) == false # noqa: E501
|
1822
1822
|
This method makes a synchronous HTTP request by default. To make an
|
1823
1823
|
asynchronous HTTP request, please pass async_req=True
|
1824
1824
|
|
@@ -1855,7 +1855,7 @@ class CalendarsApi:
|
|
1855
1855
|
def is_business_date_time_with_http_info(self, date_time : Annotated[datetime, Field(..., description="DateTime to check - This DateTime must be UTC")], scope : Annotated[StrictStr, Field(..., description="Scope of the calendar")], code : Annotated[StrictStr, Field(..., description="Code of the calendar")], as_at : Annotated[Optional[datetime], Field(description="AsAt for the request")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1856
1856
|
"""[EARLY ACCESS] IsBusinessDateTime: Check whether a DateTime is a \"Business DateTime\" # noqa: E501
|
1857
1857
|
|
1858
|
-
A Business DateTime is defined as a point in time that:
|
1858
|
+
A Business DateTime is defined as a point in time that: * Does not represent a day that overlaps with the calendars WeekendMask * If the calendar is a \"Holiday Calendar\" Does not overlap with any dates in the calendar * If the calendar is a \"TradingHours Calendar\" Does overlap with a date in the calendar All dates specified must be UTC and the upper bound of a calendar is not inclusive e.g. From: 2020-12-25-00-00-00 To: 2020-12-26-00-00-00 IsBusinessDay(2020-12-26-00-00-00) == false # noqa: E501
|
1859
1859
|
This method makes a synchronous HTTP request by default. To make an
|
1860
1860
|
asynchronous HTTP request, please pass async_req=True
|
1861
1861
|
|
@@ -1989,15 +1989,15 @@ class CalendarsApi:
|
|
1989
1989
|
|
1990
1990
|
|
1991
1991
|
@overload
|
1992
|
-
async def list_calendars(self, as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the calendars")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing calendars from a previous call to list calendars.
|
1992
|
+
async def list_calendars(self, as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the calendars")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing calendars from a previous call to list calendars. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Calendar\" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. \"Calendar/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) -> PagedResourceListOfCalendar: # noqa: E501
|
1993
1993
|
...
|
1994
1994
|
|
1995
1995
|
@overload
|
1996
|
-
def list_calendars(self, as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the calendars")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing calendars from a previous call to list calendars.
|
1996
|
+
def list_calendars(self, as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the calendars")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing calendars from a previous call to list calendars. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Calendar\" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. \"Calendar/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) -> PagedResourceListOfCalendar: # noqa: E501
|
1997
1997
|
...
|
1998
1998
|
|
1999
1999
|
@validate_arguments
|
2000
|
-
def list_calendars(self, as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the calendars")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing calendars from a previous call to list calendars.
|
2000
|
+
def list_calendars(self, as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the calendars")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing calendars from a previous call to list calendars. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Calendar\" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. \"Calendar/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[PagedResourceListOfCalendar, Awaitable[PagedResourceListOfCalendar]]: # noqa: E501
|
2001
2001
|
"""[EARLY ACCESS] ListCalendars: List Calendars # noqa: E501
|
2002
2002
|
|
2003
2003
|
List calendars at a point in AsAt time. # noqa: E501
|
@@ -2009,11 +2009,11 @@ class CalendarsApi:
|
|
2009
2009
|
|
2010
2010
|
:param as_at: The AsAt datetime at which to retrieve the calendars
|
2011
2011
|
:type as_at: datetime
|
2012
|
-
:param page: The pagination token to use to continue listing calendars from a previous call to list calendars.
|
2012
|
+
:param page: The pagination token to use to continue listing calendars from a previous call to list calendars. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request.
|
2013
2013
|
:type page: str
|
2014
2014
|
:param limit: When paginating, limit the number of returned results to this many.
|
2015
2015
|
:type limit: int
|
2016
|
-
:param property_keys: A list of property keys from the \"Calendar\" domain to decorate onto the calendar,
|
2016
|
+
:param property_keys: A list of property keys from the \"Calendar\" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. \"Calendar/System/Name\".
|
2017
2017
|
:type property_keys: List[str]
|
2018
2018
|
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
2019
2019
|
:type filter: str
|
@@ -2036,7 +2036,7 @@ class CalendarsApi:
|
|
2036
2036
|
return self.list_calendars_with_http_info(as_at, page, limit, property_keys, filter, **kwargs) # noqa: E501
|
2037
2037
|
|
2038
2038
|
@validate_arguments
|
2039
|
-
def list_calendars_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the calendars")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing calendars from a previous call to list calendars.
|
2039
|
+
def list_calendars_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the calendars")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing calendars from a previous call to list calendars. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Calendar\" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. \"Calendar/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
|
2040
2040
|
"""[EARLY ACCESS] ListCalendars: List Calendars # noqa: E501
|
2041
2041
|
|
2042
2042
|
List calendars at a point in AsAt time. # noqa: E501
|
@@ -2048,11 +2048,11 @@ class CalendarsApi:
|
|
2048
2048
|
|
2049
2049
|
:param as_at: The AsAt datetime at which to retrieve the calendars
|
2050
2050
|
:type as_at: datetime
|
2051
|
-
:param page: The pagination token to use to continue listing calendars from a previous call to list calendars.
|
2051
|
+
:param page: The pagination token to use to continue listing calendars from a previous call to list calendars. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request.
|
2052
2052
|
:type page: str
|
2053
2053
|
:param limit: When paginating, limit the number of returned results to this many.
|
2054
2054
|
:type limit: int
|
2055
|
-
:param property_keys: A list of property keys from the \"Calendar\" domain to decorate onto the calendar,
|
2055
|
+
:param property_keys: A list of property keys from the \"Calendar\" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. \"Calendar/System/Name\".
|
2056
2056
|
:type property_keys: List[str]
|
2057
2057
|
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
2058
2058
|
:type filter: str
|
@@ -2177,15 +2177,15 @@ class CalendarsApi:
|
|
2177
2177
|
|
2178
2178
|
|
2179
2179
|
@overload
|
2180
|
-
async def list_calendars_in_scope(self, scope : Annotated[StrictStr, Field(..., description="Scope of the calendars")], as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the calendars")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing calendars from a previous call to list calendars.
|
2180
|
+
async def list_calendars_in_scope(self, scope : Annotated[StrictStr, Field(..., description="Scope of the calendars")], as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the calendars")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing calendars from a previous call to list calendars. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Calendar\" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. \"Calendar/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) -> PagedResourceListOfCalendar: # noqa: E501
|
2181
2181
|
...
|
2182
2182
|
|
2183
2183
|
@overload
|
2184
|
-
def list_calendars_in_scope(self, scope : Annotated[StrictStr, Field(..., description="Scope of the calendars")], as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the calendars")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing calendars from a previous call to list calendars.
|
2184
|
+
def list_calendars_in_scope(self, scope : Annotated[StrictStr, Field(..., description="Scope of the calendars")], as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the calendars")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing calendars from a previous call to list calendars. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Calendar\" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. \"Calendar/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) -> PagedResourceListOfCalendar: # noqa: E501
|
2185
2185
|
...
|
2186
2186
|
|
2187
2187
|
@validate_arguments
|
2188
|
-
def list_calendars_in_scope(self, scope : Annotated[StrictStr, Field(..., description="Scope of the calendars")], as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the calendars")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing calendars from a previous call to list calendars.
|
2188
|
+
def list_calendars_in_scope(self, scope : Annotated[StrictStr, Field(..., description="Scope of the calendars")], as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the calendars")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing calendars from a previous call to list calendars. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Calendar\" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. \"Calendar/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[PagedResourceListOfCalendar, Awaitable[PagedResourceListOfCalendar]]: # noqa: E501
|
2189
2189
|
"""ListCalendarsInScope: List all calenders in a specified scope # noqa: E501
|
2190
2190
|
|
2191
2191
|
List calendars in a Scope at a point in AsAt time. # noqa: E501
|
@@ -2199,11 +2199,11 @@ class CalendarsApi:
|
|
2199
2199
|
:type scope: str
|
2200
2200
|
:param as_at: The AsAt datetime at which to retrieve the calendars
|
2201
2201
|
:type as_at: datetime
|
2202
|
-
:param page: The pagination token to use to continue listing calendars from a previous call to list calendars.
|
2202
|
+
:param page: The pagination token to use to continue listing calendars from a previous call to list calendars. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request.
|
2203
2203
|
:type page: str
|
2204
2204
|
:param limit: When paginating, limit the number of returned results to this many.
|
2205
2205
|
:type limit: int
|
2206
|
-
:param property_keys: A list of property keys from the \"Calendar\" domain to decorate onto the calendar,
|
2206
|
+
:param property_keys: A list of property keys from the \"Calendar\" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. \"Calendar/System/Name\".
|
2207
2207
|
:type property_keys: List[str]
|
2208
2208
|
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
2209
2209
|
:type filter: str
|
@@ -2226,7 +2226,7 @@ class CalendarsApi:
|
|
2226
2226
|
return self.list_calendars_in_scope_with_http_info(scope, as_at, page, limit, property_keys, filter, **kwargs) # noqa: E501
|
2227
2227
|
|
2228
2228
|
@validate_arguments
|
2229
|
-
def list_calendars_in_scope_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="Scope of the calendars")], as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the calendars")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing calendars from a previous call to list calendars.
|
2229
|
+
def list_calendars_in_scope_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="Scope of the calendars")], as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the calendars")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing calendars from a previous call to list calendars. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Calendar\" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. \"Calendar/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
|
2230
2230
|
"""ListCalendarsInScope: List all calenders in a specified scope # noqa: E501
|
2231
2231
|
|
2232
2232
|
List calendars in a Scope at a point in AsAt time. # noqa: E501
|
@@ -2240,11 +2240,11 @@ class CalendarsApi:
|
|
2240
2240
|
:type scope: str
|
2241
2241
|
:param as_at: The AsAt datetime at which to retrieve the calendars
|
2242
2242
|
:type as_at: datetime
|
2243
|
-
:param page: The pagination token to use to continue listing calendars from a previous call to list calendars.
|
2243
|
+
:param page: The pagination token to use to continue listing calendars from a previous call to list calendars. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request.
|
2244
2244
|
:type page: str
|
2245
2245
|
:param limit: When paginating, limit the number of returned results to this many.
|
2246
2246
|
:type limit: int
|
2247
|
-
:param property_keys: A list of property keys from the \"Calendar\" domain to decorate onto the calendar,
|
2247
|
+
:param property_keys: A list of property keys from the \"Calendar\" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. \"Calendar/System/Name\".
|
2248
2248
|
:type property_keys: List[str]
|
2249
2249
|
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
2250
2250
|
:type filter: str
|