lusid-sdk 2.1.913__py3-none-any.whl → 2.1.915__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.915.dist-info}/METADATA +3 -3
- {lusid_sdk-2.1.913.dist-info → lusid_sdk-2.1.915.dist-info}/RECORD +332 -332
- {lusid_sdk-2.1.913.dist-info → lusid_sdk-2.1.915.dist-info}/WHEEL +0 -0
@@ -229,15 +229,15 @@ class ReferencePortfolioApi:
|
|
229
229
|
|
230
230
|
|
231
231
|
@overload
|
232
|
-
async def get_reference_portfolio_constituents(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies
|
232
|
+
async def get_reference_portfolio_constituents(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective date of the constituents to retrieve. 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 constituents. Defaults to return the latest version of each constituent if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' or 'ReferenceHolding' domain to decorate onto constituents. These take the format {domain}/{scope}/{code} e.g. 'Instrument/system/Name' or 'ReferenceHolding/strategy/quantsignal'. Defaults to return all available instrument and reference holding properties if not specified.")] = None, **kwargs) -> GetReferencePortfolioConstituentsResponse: # noqa: E501
|
233
233
|
...
|
234
234
|
|
235
235
|
@overload
|
236
|
-
def get_reference_portfolio_constituents(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies
|
236
|
+
def get_reference_portfolio_constituents(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective date of the constituents to retrieve. 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 constituents. Defaults to return the latest version of each constituent if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' or 'ReferenceHolding' domain to decorate onto constituents. These take the format {domain}/{scope}/{code} e.g. 'Instrument/system/Name' or 'ReferenceHolding/strategy/quantsignal'. Defaults to return all available instrument and reference holding properties if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> GetReferencePortfolioConstituentsResponse: # noqa: E501
|
237
237
|
...
|
238
238
|
|
239
239
|
@validate_arguments
|
240
|
-
def get_reference_portfolio_constituents(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies
|
240
|
+
def get_reference_portfolio_constituents(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective date of the constituents to retrieve. 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 constituents. Defaults to return the latest version of each constituent if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' or 'ReferenceHolding' domain to decorate onto constituents. These take the format {domain}/{scope}/{code} e.g. 'Instrument/system/Name' or 'ReferenceHolding/strategy/quantsignal'. Defaults to return all available instrument and reference holding properties if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[GetReferencePortfolioConstituentsResponse, Awaitable[GetReferencePortfolioConstituentsResponse]]: # noqa: E501
|
241
241
|
"""GetReferencePortfolioConstituents: Get reference portfolio constituents # noqa: E501
|
242
242
|
|
243
243
|
Get constituents from a reference portfolio at a particular effective time. # noqa: E501
|
@@ -249,13 +249,13 @@ class ReferencePortfolioApi:
|
|
249
249
|
|
250
250
|
:param scope: The scope of the reference portfolio. (required)
|
251
251
|
:type scope: str
|
252
|
-
:param code: The code of the reference portfolio. Together with the scope this uniquely identifies
|
252
|
+
:param code: The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio. (required)
|
253
253
|
:type code: str
|
254
254
|
:param effective_at: The effective date of the constituents to retrieve. Defaults to the current LUSID system datetime if not specified.
|
255
255
|
:type effective_at: str
|
256
|
-
:param as_at: The asAt datetime at which to retrieve constituents. Defaults to return the latest version
|
256
|
+
:param as_at: The asAt datetime at which to retrieve constituents. Defaults to return the latest version of each constituent if not specified.
|
257
257
|
:type as_at: datetime
|
258
|
-
:param property_keys: A list of property keys from the 'Instrument' or 'ReferenceHolding' domain to decorate onto
|
258
|
+
:param property_keys: A list of property keys from the 'Instrument' or 'ReferenceHolding' domain to decorate onto constituents. These take the format {domain}/{scope}/{code} e.g. 'Instrument/system/Name' or 'ReferenceHolding/strategy/quantsignal'. Defaults to return all available instrument and reference holding properties if not specified.
|
259
259
|
:type property_keys: List[str]
|
260
260
|
:param async_req: Whether to execute the request asynchronously.
|
261
261
|
:type async_req: bool, optional
|
@@ -276,7 +276,7 @@ class ReferencePortfolioApi:
|
|
276
276
|
return self.get_reference_portfolio_constituents_with_http_info(scope, code, effective_at, as_at, property_keys, **kwargs) # noqa: E501
|
277
277
|
|
278
278
|
@validate_arguments
|
279
|
-
def get_reference_portfolio_constituents_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies
|
279
|
+
def get_reference_portfolio_constituents_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective date of the constituents to retrieve. 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 constituents. Defaults to return the latest version of each constituent if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' or 'ReferenceHolding' domain to decorate onto constituents. These take the format {domain}/{scope}/{code} e.g. 'Instrument/system/Name' or 'ReferenceHolding/strategy/quantsignal'. Defaults to return all available instrument and reference holding properties if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
280
280
|
"""GetReferencePortfolioConstituents: Get reference portfolio constituents # noqa: E501
|
281
281
|
|
282
282
|
Get constituents from a reference portfolio at a particular effective time. # noqa: E501
|
@@ -288,13 +288,13 @@ class ReferencePortfolioApi:
|
|
288
288
|
|
289
289
|
:param scope: The scope of the reference portfolio. (required)
|
290
290
|
:type scope: str
|
291
|
-
:param code: The code of the reference portfolio. Together with the scope this uniquely identifies
|
291
|
+
:param code: The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio. (required)
|
292
292
|
:type code: str
|
293
293
|
:param effective_at: The effective date of the constituents to retrieve. Defaults to the current LUSID system datetime if not specified.
|
294
294
|
:type effective_at: str
|
295
|
-
:param as_at: The asAt datetime at which to retrieve constituents. Defaults to return the latest version
|
295
|
+
:param as_at: The asAt datetime at which to retrieve constituents. Defaults to return the latest version of each constituent if not specified.
|
296
296
|
:type as_at: datetime
|
297
|
-
:param property_keys: A list of property keys from the 'Instrument' or 'ReferenceHolding' domain to decorate onto
|
297
|
+
:param property_keys: A list of property keys from the 'Instrument' or 'ReferenceHolding' domain to decorate onto constituents. These take the format {domain}/{scope}/{code} e.g. 'Instrument/system/Name' or 'ReferenceHolding/strategy/quantsignal'. Defaults to return all available instrument and reference holding properties if not specified.
|
298
298
|
:type property_keys: List[str]
|
299
299
|
:param async_req: Whether to execute the request asynchronously.
|
300
300
|
:type async_req: bool, optional
|
@@ -417,15 +417,15 @@ class ReferencePortfolioApi:
|
|
417
417
|
|
418
418
|
|
419
419
|
@overload
|
420
|
-
async def list_constituents_adjustments(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies
|
420
|
+
async def list_constituents_adjustments(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.")], from_effective_at : Annotated[StrictStr, Field(..., description="Events between this time (inclusive) and the toEffectiveAt are returned.")], to_effective_at : Annotated[StrictStr, Field(..., description="Events between this time (inclusive) and the fromEffectiveAt are returned.")], as_at_time : Annotated[Optional[datetime], Field(description="The asAt time for which the result is valid.")] = None, **kwargs) -> ResourceListOfConstituentsAdjustmentHeader: # noqa: E501
|
421
421
|
...
|
422
422
|
|
423
423
|
@overload
|
424
|
-
def list_constituents_adjustments(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies
|
424
|
+
def list_constituents_adjustments(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.")], from_effective_at : Annotated[StrictStr, Field(..., description="Events between this time (inclusive) and the toEffectiveAt are returned.")], to_effective_at : Annotated[StrictStr, Field(..., description="Events between this time (inclusive) and the fromEffectiveAt are returned.")], as_at_time : Annotated[Optional[datetime], Field(description="The asAt time for which the result is valid.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfConstituentsAdjustmentHeader: # noqa: E501
|
425
425
|
...
|
426
426
|
|
427
427
|
@validate_arguments
|
428
|
-
def list_constituents_adjustments(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies
|
428
|
+
def list_constituents_adjustments(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.")], from_effective_at : Annotated[StrictStr, Field(..., description="Events between this time (inclusive) and the toEffectiveAt are returned.")], to_effective_at : Annotated[StrictStr, Field(..., description="Events between this time (inclusive) and the fromEffectiveAt are returned.")], as_at_time : Annotated[Optional[datetime], Field(description="The asAt time for which the result is valid.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfConstituentsAdjustmentHeader, Awaitable[ResourceListOfConstituentsAdjustmentHeader]]: # noqa: E501
|
429
429
|
"""ListConstituentsAdjustments: List constituents adjustments # noqa: E501
|
430
430
|
|
431
431
|
List adjustments made to constituents in a reference portfolio. # noqa: E501
|
@@ -437,7 +437,7 @@ class ReferencePortfolioApi:
|
|
437
437
|
|
438
438
|
:param scope: The scope of the reference portfolio. (required)
|
439
439
|
:type scope: str
|
440
|
-
:param code: The code of the reference portfolio. Together with the scope this uniquely identifies
|
440
|
+
:param code: The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio. (required)
|
441
441
|
:type code: str
|
442
442
|
:param from_effective_at: Events between this time (inclusive) and the toEffectiveAt are returned. (required)
|
443
443
|
:type from_effective_at: str
|
@@ -464,7 +464,7 @@ class ReferencePortfolioApi:
|
|
464
464
|
return self.list_constituents_adjustments_with_http_info(scope, code, from_effective_at, to_effective_at, as_at_time, **kwargs) # noqa: E501
|
465
465
|
|
466
466
|
@validate_arguments
|
467
|
-
def list_constituents_adjustments_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies
|
467
|
+
def list_constituents_adjustments_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.")], from_effective_at : Annotated[StrictStr, Field(..., description="Events between this time (inclusive) and the toEffectiveAt are returned.")], to_effective_at : Annotated[StrictStr, Field(..., description="Events between this time (inclusive) and the fromEffectiveAt are returned.")], as_at_time : Annotated[Optional[datetime], Field(description="The asAt time for which the result is valid.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
468
468
|
"""ListConstituentsAdjustments: List constituents adjustments # noqa: E501
|
469
469
|
|
470
470
|
List adjustments made to constituents in a reference portfolio. # noqa: E501
|
@@ -476,7 +476,7 @@ class ReferencePortfolioApi:
|
|
476
476
|
|
477
477
|
:param scope: The scope of the reference portfolio. (required)
|
478
478
|
:type scope: str
|
479
|
-
:param code: The code of the reference portfolio. Together with the scope this uniquely identifies
|
479
|
+
:param code: The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio. (required)
|
480
480
|
:type code: str
|
481
481
|
:param from_effective_at: Events between this time (inclusive) and the toEffectiveAt are returned. (required)
|
482
482
|
:type from_effective_at: str
|
@@ -604,18 +604,18 @@ class ReferencePortfolioApi:
|
|
604
604
|
|
605
605
|
|
606
606
|
@overload
|
607
|
-
async def upsert_reference_portfolio_constituent_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies
|
607
|
+
async def upsert_reference_portfolio_constituent_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.")], upsert_reference_portfolio_constituent_properties_request : Annotated[UpsertReferencePortfolioConstituentPropertiesRequest, Field(..., description="The request to modify properties for the constituent.")], **kwargs) -> UpsertReferencePortfolioConstituentPropertiesResponse: # noqa: E501
|
608
608
|
...
|
609
609
|
|
610
610
|
@overload
|
611
|
-
def upsert_reference_portfolio_constituent_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies
|
611
|
+
def upsert_reference_portfolio_constituent_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.")], upsert_reference_portfolio_constituent_properties_request : Annotated[UpsertReferencePortfolioConstituentPropertiesRequest, Field(..., description="The request to modify properties for the constituent.")], async_req: Optional[bool]=True, **kwargs) -> UpsertReferencePortfolioConstituentPropertiesResponse: # noqa: E501
|
612
612
|
...
|
613
613
|
|
614
614
|
@validate_arguments
|
615
|
-
def upsert_reference_portfolio_constituent_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies
|
615
|
+
def upsert_reference_portfolio_constituent_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.")], upsert_reference_portfolio_constituent_properties_request : Annotated[UpsertReferencePortfolioConstituentPropertiesRequest, Field(..., description="The request to modify properties for the constituent.")], async_req: Optional[bool]=None, **kwargs) -> Union[UpsertReferencePortfolioConstituentPropertiesResponse, Awaitable[UpsertReferencePortfolioConstituentPropertiesResponse]]: # noqa: E501
|
616
616
|
"""[EARLY ACCESS] UpsertReferencePortfolioConstituentProperties: Upsert constituent properties # noqa: E501
|
617
617
|
|
618
|
-
Create or update one or more constituent properties for a single constituent in the reference portfolio.
|
618
|
+
Create or update one or more constituent properties for a single constituent in the reference portfolio. Each property will be updated if it already exists, created if it does not and deleted if value is null. Both constituent and portfolio must exist at the time when properties are created or updated. # noqa: E501
|
619
619
|
This method makes a synchronous HTTP request by default. To make an
|
620
620
|
asynchronous HTTP request, please pass async_req=True
|
621
621
|
|
@@ -624,7 +624,7 @@ class ReferencePortfolioApi:
|
|
624
624
|
|
625
625
|
:param scope: The scope of the reference portfolio. (required)
|
626
626
|
:type scope: str
|
627
|
-
:param code: The code of the reference portfolio. Together with the scope this uniquely identifies
|
627
|
+
:param code: The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio. (required)
|
628
628
|
:type code: str
|
629
629
|
:param upsert_reference_portfolio_constituent_properties_request: The request to modify properties for the constituent. (required)
|
630
630
|
:type upsert_reference_portfolio_constituent_properties_request: UpsertReferencePortfolioConstituentPropertiesRequest
|
@@ -647,10 +647,10 @@ class ReferencePortfolioApi:
|
|
647
647
|
return self.upsert_reference_portfolio_constituent_properties_with_http_info(scope, code, upsert_reference_portfolio_constituent_properties_request, **kwargs) # noqa: E501
|
648
648
|
|
649
649
|
@validate_arguments
|
650
|
-
def upsert_reference_portfolio_constituent_properties_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies
|
650
|
+
def upsert_reference_portfolio_constituent_properties_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.")], upsert_reference_portfolio_constituent_properties_request : Annotated[UpsertReferencePortfolioConstituentPropertiesRequest, Field(..., description="The request to modify properties for the constituent.")], **kwargs) -> ApiResponse: # noqa: E501
|
651
651
|
"""[EARLY ACCESS] UpsertReferencePortfolioConstituentProperties: Upsert constituent properties # noqa: E501
|
652
652
|
|
653
|
-
Create or update one or more constituent properties for a single constituent in the reference portfolio.
|
653
|
+
Create or update one or more constituent properties for a single constituent in the reference portfolio. Each property will be updated if it already exists, created if it does not and deleted if value is null. Both constituent and portfolio must exist at the time when properties are created or updated. # noqa: E501
|
654
654
|
This method makes a synchronous HTTP request by default. To make an
|
655
655
|
asynchronous HTTP request, please pass async_req=True
|
656
656
|
|
@@ -659,7 +659,7 @@ class ReferencePortfolioApi:
|
|
659
659
|
|
660
660
|
:param scope: The scope of the reference portfolio. (required)
|
661
661
|
:type scope: str
|
662
|
-
:param code: The code of the reference portfolio. Together with the scope this uniquely identifies
|
662
|
+
:param code: The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio. (required)
|
663
663
|
:type code: str
|
664
664
|
:param upsert_reference_portfolio_constituent_properties_request: The request to modify properties for the constituent. (required)
|
665
665
|
:type upsert_reference_portfolio_constituent_properties_request: UpsertReferencePortfolioConstituentPropertiesRequest
|
@@ -779,15 +779,15 @@ class ReferencePortfolioApi:
|
|
779
779
|
|
780
780
|
|
781
781
|
@overload
|
782
|
-
async def upsert_reference_portfolio_constituents(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies
|
782
|
+
async def upsert_reference_portfolio_constituents(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.")], upsert_reference_portfolio_constituents_request : Annotated[UpsertReferencePortfolioConstituentsRequest, Field(..., description="The constituents to upload to the reference portfolio.")], **kwargs) -> UpsertReferencePortfolioConstituentsResponse: # noqa: E501
|
783
783
|
...
|
784
784
|
|
785
785
|
@overload
|
786
|
-
def upsert_reference_portfolio_constituents(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies
|
786
|
+
def upsert_reference_portfolio_constituents(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.")], upsert_reference_portfolio_constituents_request : Annotated[UpsertReferencePortfolioConstituentsRequest, Field(..., description="The constituents to upload to the reference portfolio.")], async_req: Optional[bool]=True, **kwargs) -> UpsertReferencePortfolioConstituentsResponse: # noqa: E501
|
787
787
|
...
|
788
788
|
|
789
789
|
@validate_arguments
|
790
|
-
def upsert_reference_portfolio_constituents(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies
|
790
|
+
def upsert_reference_portfolio_constituents(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.")], upsert_reference_portfolio_constituents_request : Annotated[UpsertReferencePortfolioConstituentsRequest, Field(..., description="The constituents to upload to the reference portfolio.")], async_req: Optional[bool]=None, **kwargs) -> Union[UpsertReferencePortfolioConstituentsResponse, Awaitable[UpsertReferencePortfolioConstituentsResponse]]: # noqa: E501
|
791
791
|
"""UpsertReferencePortfolioConstituents: Upsert reference portfolio constituents # noqa: E501
|
792
792
|
|
793
793
|
Add constituents to a reference portfolio. # noqa: E501
|
@@ -799,7 +799,7 @@ class ReferencePortfolioApi:
|
|
799
799
|
|
800
800
|
:param scope: The scope of the reference portfolio. (required)
|
801
801
|
:type scope: str
|
802
|
-
:param code: The code of the reference portfolio. Together with the scope this uniquely identifies
|
802
|
+
:param code: The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio. (required)
|
803
803
|
:type code: str
|
804
804
|
:param upsert_reference_portfolio_constituents_request: The constituents to upload to the reference portfolio. (required)
|
805
805
|
:type upsert_reference_portfolio_constituents_request: UpsertReferencePortfolioConstituentsRequest
|
@@ -822,7 +822,7 @@ class ReferencePortfolioApi:
|
|
822
822
|
return self.upsert_reference_portfolio_constituents_with_http_info(scope, code, upsert_reference_portfolio_constituents_request, **kwargs) # noqa: E501
|
823
823
|
|
824
824
|
@validate_arguments
|
825
|
-
def upsert_reference_portfolio_constituents_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies
|
825
|
+
def upsert_reference_portfolio_constituents_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the reference portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.")], upsert_reference_portfolio_constituents_request : Annotated[UpsertReferencePortfolioConstituentsRequest, Field(..., description="The constituents to upload to the reference portfolio.")], **kwargs) -> ApiResponse: # noqa: E501
|
826
826
|
"""UpsertReferencePortfolioConstituents: Upsert reference portfolio constituents # noqa: E501
|
827
827
|
|
828
828
|
Add constituents to a reference portfolio. # noqa: E501
|
@@ -834,7 +834,7 @@ class ReferencePortfolioApi:
|
|
834
834
|
|
835
835
|
:param scope: The scope of the reference portfolio. (required)
|
836
836
|
:type scope: str
|
837
|
-
:param code: The code of the reference portfolio. Together with the scope this uniquely identifies
|
837
|
+
:param code: The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio. (required)
|
838
838
|
:type code: str
|
839
839
|
:param upsert_reference_portfolio_constituents_request: The constituents to upload to the reference portfolio. (required)
|
840
840
|
:type upsert_reference_portfolio_constituents_request: UpsertReferencePortfolioConstituentsRequest
|
@@ -216,15 +216,15 @@ class RelationDefinitionsApi:
|
|
216
216
|
|
217
217
|
|
218
218
|
@overload
|
219
|
-
async def delete_relation_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the relation to be deleted.")], code : Annotated[StrictStr, Field(..., description="The code of the relation to be deleted. Together with the domain and scope this uniquely
|
219
|
+
async def delete_relation_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the relation to be deleted.")], code : Annotated[StrictStr, Field(..., description="The code of the relation to be deleted. Together with the domain and scope this uniquely identifies the relation.")], **kwargs) -> DeletedEntityResponse: # noqa: E501
|
220
220
|
...
|
221
221
|
|
222
222
|
@overload
|
223
|
-
def delete_relation_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the relation to be deleted.")], code : Annotated[StrictStr, Field(..., description="The code of the relation to be deleted. Together with the domain and scope this uniquely
|
223
|
+
def delete_relation_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the relation to be deleted.")], code : Annotated[StrictStr, Field(..., description="The code of the relation to be deleted. Together with the domain and scope this uniquely identifies the relation.")], async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
|
224
224
|
...
|
225
225
|
|
226
226
|
@validate_arguments
|
227
|
-
def delete_relation_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the relation to be deleted.")], code : Annotated[StrictStr, Field(..., description="The code of the relation to be deleted. Together with the domain and scope this uniquely
|
227
|
+
def delete_relation_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the relation to be deleted.")], code : Annotated[StrictStr, Field(..., description="The code of the relation to be deleted. Together with the domain and scope this uniquely identifies the relation.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
228
228
|
"""[EXPERIMENTAL] DeleteRelationDefinition: Delete relation definition # noqa: E501
|
229
229
|
|
230
230
|
Delete the definition of the specified relation. # noqa: E501
|
@@ -236,7 +236,7 @@ class RelationDefinitionsApi:
|
|
236
236
|
|
237
237
|
:param scope: The scope of the relation to be deleted. (required)
|
238
238
|
:type scope: str
|
239
|
-
:param code: The code of the relation to be deleted. Together with the domain and scope this uniquely
|
239
|
+
:param code: The code of the relation to be deleted. Together with the domain and scope this uniquely identifies the relation. (required)
|
240
240
|
:type code: str
|
241
241
|
:param async_req: Whether to execute the request asynchronously.
|
242
242
|
:type async_req: bool, optional
|
@@ -257,7 +257,7 @@ class RelationDefinitionsApi:
|
|
257
257
|
return self.delete_relation_definition_with_http_info(scope, code, **kwargs) # noqa: E501
|
258
258
|
|
259
259
|
@validate_arguments
|
260
|
-
def delete_relation_definition_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the relation to be deleted.")], code : Annotated[StrictStr, Field(..., description="The code of the relation to be deleted. Together with the domain and scope this uniquely
|
260
|
+
def delete_relation_definition_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the relation to be deleted.")], code : Annotated[StrictStr, Field(..., description="The code of the relation to be deleted. Together with the domain and scope this uniquely identifies the relation.")], **kwargs) -> ApiResponse: # noqa: E501
|
261
261
|
"""[EXPERIMENTAL] DeleteRelationDefinition: Delete relation definition # noqa: E501
|
262
262
|
|
263
263
|
Delete the definition of the specified relation. # noqa: E501
|
@@ -269,7 +269,7 @@ class RelationDefinitionsApi:
|
|
269
269
|
|
270
270
|
:param scope: The scope of the relation to be deleted. (required)
|
271
271
|
:type scope: str
|
272
|
-
:param code: The code of the relation to be deleted. Together with the domain and scope this uniquely
|
272
|
+
:param code: The code of the relation to be deleted. Together with the domain and scope this uniquely identifies the relation. (required)
|
273
273
|
:type code: str
|
274
274
|
:param async_req: Whether to execute the request asynchronously.
|
275
275
|
:type async_req: bool, optional
|
@@ -376,15 +376,15 @@ class RelationDefinitionsApi:
|
|
376
376
|
|
377
377
|
|
378
378
|
@overload
|
379
|
-
async def get_relation_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified relation.")], code : Annotated[StrictStr, Field(..., description="The code of the specified relation. Together with the domain and scope this uniquely
|
379
|
+
async def get_relation_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified relation.")], code : Annotated[StrictStr, Field(..., description="The code of the specified relation. Together with the domain and scope this uniquely identifies the relation.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the relation definition. Defaults to return the latest version of the definition if not specified.")] = None, **kwargs) -> RelationDefinition: # noqa: E501
|
380
380
|
...
|
381
381
|
|
382
382
|
@overload
|
383
|
-
def get_relation_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified relation.")], code : Annotated[StrictStr, Field(..., description="The code of the specified relation. Together with the domain and scope this uniquely
|
383
|
+
def get_relation_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified relation.")], code : Annotated[StrictStr, Field(..., description="The code of the specified relation. Together with the domain and scope this uniquely identifies the relation.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the relation definition. Defaults to return the latest version of the definition if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> RelationDefinition: # noqa: E501
|
384
384
|
...
|
385
385
|
|
386
386
|
@validate_arguments
|
387
|
-
def get_relation_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified relation.")], code : Annotated[StrictStr, Field(..., description="The code of the specified relation. Together with the domain and scope this uniquely
|
387
|
+
def get_relation_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified relation.")], code : Annotated[StrictStr, Field(..., description="The code of the specified relation. Together with the domain and scope this uniquely identifies the relation.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the relation definition. Defaults to return the latest version of the definition if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[RelationDefinition, Awaitable[RelationDefinition]]: # noqa: E501
|
388
388
|
"""[EXPERIMENTAL] GetRelationDefinition: Get relation definition # noqa: E501
|
389
389
|
|
390
390
|
Retrieve the definition of a specified relation. # noqa: E501
|
@@ -396,9 +396,9 @@ class RelationDefinitionsApi:
|
|
396
396
|
|
397
397
|
:param scope: The scope of the specified relation. (required)
|
398
398
|
:type scope: str
|
399
|
-
:param code: The code of the specified relation. Together with the domain and scope this uniquely
|
399
|
+
:param code: The code of the specified relation. Together with the domain and scope this uniquely identifies the relation. (required)
|
400
400
|
:type code: str
|
401
|
-
:param as_at: The asAt datetime at which to retrieve the relation definition. Defaults to return
|
401
|
+
:param as_at: The asAt datetime at which to retrieve the relation definition. Defaults to return the latest version of the definition if not specified.
|
402
402
|
:type as_at: datetime
|
403
403
|
:param async_req: Whether to execute the request asynchronously.
|
404
404
|
:type async_req: bool, optional
|
@@ -419,7 +419,7 @@ class RelationDefinitionsApi:
|
|
419
419
|
return self.get_relation_definition_with_http_info(scope, code, as_at, **kwargs) # noqa: E501
|
420
420
|
|
421
421
|
@validate_arguments
|
422
|
-
def get_relation_definition_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified relation.")], code : Annotated[StrictStr, Field(..., description="The code of the specified relation. Together with the domain and scope this uniquely
|
422
|
+
def get_relation_definition_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified relation.")], code : Annotated[StrictStr, Field(..., description="The code of the specified relation. Together with the domain and scope this uniquely identifies the relation.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the relation definition. Defaults to return the latest version of the definition if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
423
423
|
"""[EXPERIMENTAL] GetRelationDefinition: Get relation definition # noqa: E501
|
424
424
|
|
425
425
|
Retrieve the definition of a specified relation. # noqa: E501
|
@@ -431,9 +431,9 @@ class RelationDefinitionsApi:
|
|
431
431
|
|
432
432
|
:param scope: The scope of the specified relation. (required)
|
433
433
|
:type scope: str
|
434
|
-
:param code: The code of the specified relation. Together with the domain and scope this uniquely
|
434
|
+
:param code: The code of the specified relation. Together with the domain and scope this uniquely identifies the relation. (required)
|
435
435
|
:type code: str
|
436
|
-
:param as_at: The asAt datetime at which to retrieve the relation definition. Defaults to return
|
436
|
+
:param as_at: The asAt datetime at which to retrieve the relation definition. Defaults to return the latest version of the definition if not specified.
|
437
437
|
:type as_at: datetime
|
438
438
|
:param async_req: Whether to execute the request asynchronously.
|
439
439
|
:type async_req: bool, optional
|