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
@@ -218,15 +218,15 @@ class RelationshipDefinitionsApi:
|
|
218
218
|
|
219
219
|
|
220
220
|
@overload
|
221
|
-
async def delete_relationship_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the relationship definition to be deleted.")], code : Annotated[StrictStr, Field(..., description="The code of the relationship definition to be deleted. Together with the domain and scope this uniquely
|
221
|
+
async def delete_relationship_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the relationship definition to be deleted.")], code : Annotated[StrictStr, Field(..., description="The code of the relationship definition to be deleted. Together with the domain and scope this uniquely identifies the relationship.")], **kwargs) -> DeletedEntityResponse: # noqa: E501
|
222
222
|
...
|
223
223
|
|
224
224
|
@overload
|
225
|
-
def delete_relationship_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the relationship definition to be deleted.")], code : Annotated[StrictStr, Field(..., description="The code of the relationship definition to be deleted. Together with the domain and scope this uniquely
|
225
|
+
def delete_relationship_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the relationship definition to be deleted.")], code : Annotated[StrictStr, Field(..., description="The code of the relationship definition to be deleted. Together with the domain and scope this uniquely identifies the relationship.")], async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
|
226
226
|
...
|
227
227
|
|
228
228
|
@validate_arguments
|
229
|
-
def delete_relationship_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the relationship definition to be deleted.")], code : Annotated[StrictStr, Field(..., description="The code of the relationship definition to be deleted. Together with the domain and scope this uniquely
|
229
|
+
def delete_relationship_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the relationship definition to be deleted.")], code : Annotated[StrictStr, Field(..., description="The code of the relationship definition to be deleted. Together with the domain and scope this uniquely identifies the relationship.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
230
230
|
"""[EARLY ACCESS] DeleteRelationshipDefinition: Delete Relationship Definition # noqa: E501
|
231
231
|
|
232
232
|
Delete the definition of the specified relationship. # noqa: E501
|
@@ -238,7 +238,7 @@ class RelationshipDefinitionsApi:
|
|
238
238
|
|
239
239
|
:param scope: The scope of the relationship definition to be deleted. (required)
|
240
240
|
:type scope: str
|
241
|
-
:param code: The code of the relationship definition to be deleted. Together with the domain and scope this uniquely
|
241
|
+
:param code: The code of the relationship definition to be deleted. Together with the domain and scope this uniquely identifies the relationship. (required)
|
242
242
|
:type code: str
|
243
243
|
:param async_req: Whether to execute the request asynchronously.
|
244
244
|
:type async_req: bool, optional
|
@@ -259,7 +259,7 @@ class RelationshipDefinitionsApi:
|
|
259
259
|
return self.delete_relationship_definition_with_http_info(scope, code, **kwargs) # noqa: E501
|
260
260
|
|
261
261
|
@validate_arguments
|
262
|
-
def delete_relationship_definition_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the relationship definition to be deleted.")], code : Annotated[StrictStr, Field(..., description="The code of the relationship definition to be deleted. Together with the domain and scope this uniquely
|
262
|
+
def delete_relationship_definition_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the relationship definition to be deleted.")], code : Annotated[StrictStr, Field(..., description="The code of the relationship definition to be deleted. Together with the domain and scope this uniquely identifies the relationship.")], **kwargs) -> ApiResponse: # noqa: E501
|
263
263
|
"""[EARLY ACCESS] DeleteRelationshipDefinition: Delete Relationship Definition # noqa: E501
|
264
264
|
|
265
265
|
Delete the definition of the specified relationship. # noqa: E501
|
@@ -271,7 +271,7 @@ class RelationshipDefinitionsApi:
|
|
271
271
|
|
272
272
|
:param scope: The scope of the relationship definition to be deleted. (required)
|
273
273
|
:type scope: str
|
274
|
-
:param code: The code of the relationship definition to be deleted. Together with the domain and scope this uniquely
|
274
|
+
:param code: The code of the relationship definition to be deleted. Together with the domain and scope this uniquely identifies the relationship. (required)
|
275
275
|
:type code: str
|
276
276
|
:param async_req: Whether to execute the request asynchronously.
|
277
277
|
:type async_req: bool, optional
|
@@ -378,15 +378,15 @@ class RelationshipDefinitionsApi:
|
|
378
378
|
|
379
379
|
|
380
380
|
@overload
|
381
|
-
async def get_relationship_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified relationship definition.")], code : Annotated[StrictStr, Field(..., description="The code of the specified relationship definition. Together with the domain and scope this uniquely
|
381
|
+
async def get_relationship_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified relationship definition.")], code : Annotated[StrictStr, Field(..., description="The code of the specified relationship definition. Together with the domain and scope this uniquely identifies the relationship definition.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the relationship definition. Defaults to return the latest version of the definition if not specified.")] = None, **kwargs) -> RelationshipDefinition: # noqa: E501
|
382
382
|
...
|
383
383
|
|
384
384
|
@overload
|
385
|
-
def get_relationship_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified relationship definition.")], code : Annotated[StrictStr, Field(..., description="The code of the specified relationship definition. Together with the domain and scope this uniquely
|
385
|
+
def get_relationship_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified relationship definition.")], code : Annotated[StrictStr, Field(..., description="The code of the specified relationship definition. Together with the domain and scope this uniquely identifies the relationship definition.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the relationship definition. Defaults to return the latest version of the definition if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> RelationshipDefinition: # noqa: E501
|
386
386
|
...
|
387
387
|
|
388
388
|
@validate_arguments
|
389
|
-
def get_relationship_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified relationship definition.")], code : Annotated[StrictStr, Field(..., description="The code of the specified relationship definition. Together with the domain and scope this uniquely
|
389
|
+
def get_relationship_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified relationship definition.")], code : Annotated[StrictStr, Field(..., description="The code of the specified relationship definition. Together with the domain and scope this uniquely identifies the relationship definition.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the relationship definition. Defaults to return the latest version of the definition if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[RelationshipDefinition, Awaitable[RelationshipDefinition]]: # noqa: E501
|
390
390
|
"""[EARLY ACCESS] GetRelationshipDefinition: Get relationship definition # noqa: E501
|
391
391
|
|
392
392
|
Retrieve the specified relationship definition # noqa: E501
|
@@ -398,9 +398,9 @@ class RelationshipDefinitionsApi:
|
|
398
398
|
|
399
399
|
:param scope: The scope of the specified relationship definition. (required)
|
400
400
|
:type scope: str
|
401
|
-
:param code: The code of the specified relationship definition. Together with the domain and scope this uniquely
|
401
|
+
:param code: The code of the specified relationship definition. Together with the domain and scope this uniquely identifies the relationship definition. (required)
|
402
402
|
:type code: str
|
403
|
-
:param as_at: The asAt datetime at which to retrieve the relationship definition. Defaults to return
|
403
|
+
:param as_at: The asAt datetime at which to retrieve the relationship definition. Defaults to return the latest version of the definition if not specified.
|
404
404
|
:type as_at: datetime
|
405
405
|
:param async_req: Whether to execute the request asynchronously.
|
406
406
|
:type async_req: bool, optional
|
@@ -421,7 +421,7 @@ class RelationshipDefinitionsApi:
|
|
421
421
|
return self.get_relationship_definition_with_http_info(scope, code, as_at, **kwargs) # noqa: E501
|
422
422
|
|
423
423
|
@validate_arguments
|
424
|
-
def get_relationship_definition_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified relationship definition.")], code : Annotated[StrictStr, Field(..., description="The code of the specified relationship definition. Together with the domain and scope this uniquely
|
424
|
+
def get_relationship_definition_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified relationship definition.")], code : Annotated[StrictStr, Field(..., description="The code of the specified relationship definition. Together with the domain and scope this uniquely identifies the relationship definition.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the relationship definition. Defaults to return the latest version of the definition if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
425
425
|
"""[EARLY ACCESS] GetRelationshipDefinition: Get relationship definition # noqa: E501
|
426
426
|
|
427
427
|
Retrieve the specified relationship definition # noqa: E501
|
@@ -433,9 +433,9 @@ class RelationshipDefinitionsApi:
|
|
433
433
|
|
434
434
|
:param scope: The scope of the specified relationship definition. (required)
|
435
435
|
:type scope: str
|
436
|
-
:param code: The code of the specified relationship definition. Together with the domain and scope this uniquely
|
436
|
+
:param code: The code of the specified relationship definition. Together with the domain and scope this uniquely identifies the relationship definition. (required)
|
437
437
|
:type code: str
|
438
|
-
:param as_at: The asAt datetime at which to retrieve the relationship definition. Defaults to return
|
438
|
+
:param as_at: The asAt datetime at which to retrieve the relationship definition. Defaults to return the latest version of the definition if not specified.
|
439
439
|
:type as_at: datetime
|
440
440
|
:param async_req: Whether to execute the request asynchronously.
|
441
441
|
:type async_req: bool, optional
|
@@ -549,15 +549,15 @@ class RelationshipDefinitionsApi:
|
|
549
549
|
|
550
550
|
|
551
551
|
@overload
|
552
|
-
async def list_relationship_definitions(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the relationship definitions. Defaults to return
|
552
|
+
async def list_relationship_definitions(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the relationship definitions. Defaults to return the latest version of each definition if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing relationship definitions from a previous call to list relationship definitions. This value is returned from the previous call. If a pagination token is provided the filter, sortBy and asAt field must not have changed since the original request.")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Scope, use \"scope eq 'ExampleScope'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, **kwargs) -> PagedResourceListOfRelationshipDefinition: # noqa: E501
|
553
553
|
...
|
554
554
|
|
555
555
|
@overload
|
556
|
-
def list_relationship_definitions(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the relationship definitions. Defaults to return
|
556
|
+
def list_relationship_definitions(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the relationship definitions. Defaults to return the latest version of each definition if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing relationship definitions from a previous call to list relationship definitions. This value is returned from the previous call. If a pagination token is provided the filter, sortBy and asAt field must not have changed since the original request.")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Scope, use \"scope eq 'ExampleScope'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfRelationshipDefinition: # noqa: E501
|
557
557
|
...
|
558
558
|
|
559
559
|
@validate_arguments
|
560
|
-
def list_relationship_definitions(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the relationship definitions. Defaults to return
|
560
|
+
def list_relationship_definitions(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the relationship definitions. Defaults to return the latest version of each definition if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing relationship definitions from a previous call to list relationship definitions. This value is returned from the previous call. If a pagination token is provided the filter, sortBy and asAt field must not have changed since the original request.")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Scope, use \"scope eq 'ExampleScope'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfRelationshipDefinition, Awaitable[PagedResourceListOfRelationshipDefinition]]: # noqa: E501
|
561
561
|
"""[EARLY ACCESS] ListRelationshipDefinitions: List relationship definitions # noqa: E501
|
562
562
|
|
563
563
|
Retrieve one or more specified relationship definitions. # noqa: E501
|
@@ -567,13 +567,13 @@ class RelationshipDefinitionsApi:
|
|
567
567
|
>>> thread = api.list_relationship_definitions(as_at, page, limit, filter, sort_by, async_req=True)
|
568
568
|
>>> result = thread.get()
|
569
569
|
|
570
|
-
:param as_at: The asAt datetime at which to retrieve the relationship definitions. Defaults to return
|
570
|
+
:param as_at: The asAt datetime at which to retrieve the relationship definitions. Defaults to return the latest version of each definition if not specified.
|
571
571
|
:type as_at: datetime
|
572
|
-
:param page: The pagination token to use to continue listing relationship definitions from a previous call to list relationship definitions. This
|
572
|
+
:param page: The pagination token to use to continue listing relationship definitions from a previous call to list relationship definitions. This value is returned from the previous call. If a pagination token is provided the filter, sortBy and asAt field must not have changed since the original request.
|
573
573
|
:type page: str
|
574
574
|
:param limit: When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
|
575
575
|
:type limit: int
|
576
|
-
:param filter: Expression to filter the result set.
|
576
|
+
:param filter: Expression to filter the result set. For example, to filter on the Scope, use \"scope eq 'ExampleScope'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
577
577
|
:type filter: str
|
578
578
|
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"
|
579
579
|
:type sort_by: List[str]
|
@@ -596,7 +596,7 @@ class RelationshipDefinitionsApi:
|
|
596
596
|
return self.list_relationship_definitions_with_http_info(as_at, page, limit, filter, sort_by, **kwargs) # noqa: E501
|
597
597
|
|
598
598
|
@validate_arguments
|
599
|
-
def list_relationship_definitions_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the relationship definitions. Defaults to return
|
599
|
+
def list_relationship_definitions_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the relationship definitions. Defaults to return the latest version of each definition if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing relationship definitions from a previous call to list relationship definitions. This value is returned from the previous call. If a pagination token is provided the filter, sortBy and asAt field must not have changed since the original request.")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Scope, use \"scope eq 'ExampleScope'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
600
600
|
"""[EARLY ACCESS] ListRelationshipDefinitions: List relationship definitions # noqa: E501
|
601
601
|
|
602
602
|
Retrieve one or more specified relationship definitions. # noqa: E501
|
@@ -606,13 +606,13 @@ class RelationshipDefinitionsApi:
|
|
606
606
|
>>> thread = api.list_relationship_definitions_with_http_info(as_at, page, limit, filter, sort_by, async_req=True)
|
607
607
|
>>> result = thread.get()
|
608
608
|
|
609
|
-
:param as_at: The asAt datetime at which to retrieve the relationship definitions. Defaults to return
|
609
|
+
:param as_at: The asAt datetime at which to retrieve the relationship definitions. Defaults to return the latest version of each definition if not specified.
|
610
610
|
:type as_at: datetime
|
611
|
-
:param page: The pagination token to use to continue listing relationship definitions from a previous call to list relationship definitions. This
|
611
|
+
:param page: The pagination token to use to continue listing relationship definitions from a previous call to list relationship definitions. This value is returned from the previous call. If a pagination token is provided the filter, sortBy and asAt field must not have changed since the original request.
|
612
612
|
:type page: str
|
613
613
|
:param limit: When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
|
614
614
|
:type limit: int
|
615
|
-
:param filter: Expression to filter the result set.
|
615
|
+
:param filter: Expression to filter the result set. For example, to filter on the Scope, use \"scope eq 'ExampleScope'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
616
616
|
:type filter: str
|
617
617
|
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"
|
618
618
|
:type sort_by: List[str]
|
@@ -737,18 +737,18 @@ class RelationshipDefinitionsApi:
|
|
737
737
|
|
738
738
|
|
739
739
|
@overload
|
740
|
-
async def update_relationship_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the relationship definition being updated.")], code : Annotated[StrictStr, Field(..., description="The code of the relationship definition being updated. Together with the scope this uniquely
|
740
|
+
async def update_relationship_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the relationship definition being updated.")], code : Annotated[StrictStr, Field(..., description="The code of the relationship definition being updated. Together with the scope this uniquely identifies the relationship definition.")], update_relationship_definition_request : Annotated[UpdateRelationshipDefinitionRequest, Field(..., description="The details of relationship definition to update.")], **kwargs) -> RelationshipDefinition: # noqa: E501
|
741
741
|
...
|
742
742
|
|
743
743
|
@overload
|
744
|
-
def update_relationship_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the relationship definition being updated.")], code : Annotated[StrictStr, Field(..., description="The code of the relationship definition being updated. Together with the scope this uniquely
|
744
|
+
def update_relationship_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the relationship definition being updated.")], code : Annotated[StrictStr, Field(..., description="The code of the relationship definition being updated. Together with the scope this uniquely identifies the relationship definition.")], update_relationship_definition_request : Annotated[UpdateRelationshipDefinitionRequest, Field(..., description="The details of relationship definition to update.")], async_req: Optional[bool]=True, **kwargs) -> RelationshipDefinition: # noqa: E501
|
745
745
|
...
|
746
746
|
|
747
747
|
@validate_arguments
|
748
|
-
def update_relationship_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the relationship definition being updated.")], code : Annotated[StrictStr, Field(..., description="The code of the relationship definition being updated. Together with the scope this uniquely
|
748
|
+
def update_relationship_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the relationship definition being updated.")], code : Annotated[StrictStr, Field(..., description="The code of the relationship definition being updated. Together with the scope this uniquely identifies the relationship definition.")], update_relationship_definition_request : Annotated[UpdateRelationshipDefinitionRequest, Field(..., description="The details of relationship definition to update.")], async_req: Optional[bool]=None, **kwargs) -> Union[RelationshipDefinition, Awaitable[RelationshipDefinition]]: # noqa: E501
|
749
749
|
"""[EARLY ACCESS] UpdateRelationshipDefinition: Update Relationship Definition # noqa: E501
|
750
750
|
|
751
|
-
Update the definition of a specified existing relationship. Not all elements within a relationship definition
|
751
|
+
Update the definition of a specified existing relationship. Not all elements within a relationship definition are modifiable due to the potential implications for values already stored against the relationship. # noqa: E501
|
752
752
|
This method makes a synchronous HTTP request by default. To make an
|
753
753
|
asynchronous HTTP request, please pass async_req=True
|
754
754
|
|
@@ -757,7 +757,7 @@ class RelationshipDefinitionsApi:
|
|
757
757
|
|
758
758
|
:param scope: The scope of the relationship definition being updated. (required)
|
759
759
|
:type scope: str
|
760
|
-
:param code: The code of the relationship definition being updated. Together with the scope this uniquely
|
760
|
+
:param code: The code of the relationship definition being updated. Together with the scope this uniquely identifies the relationship definition. (required)
|
761
761
|
:type code: str
|
762
762
|
:param update_relationship_definition_request: The details of relationship definition to update. (required)
|
763
763
|
:type update_relationship_definition_request: UpdateRelationshipDefinitionRequest
|
@@ -780,10 +780,10 @@ class RelationshipDefinitionsApi:
|
|
780
780
|
return self.update_relationship_definition_with_http_info(scope, code, update_relationship_definition_request, **kwargs) # noqa: E501
|
781
781
|
|
782
782
|
@validate_arguments
|
783
|
-
def update_relationship_definition_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the relationship definition being updated.")], code : Annotated[StrictStr, Field(..., description="The code of the relationship definition being updated. Together with the scope this uniquely
|
783
|
+
def update_relationship_definition_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the relationship definition being updated.")], code : Annotated[StrictStr, Field(..., description="The code of the relationship definition being updated. Together with the scope this uniquely identifies the relationship definition.")], update_relationship_definition_request : Annotated[UpdateRelationshipDefinitionRequest, Field(..., description="The details of relationship definition to update.")], **kwargs) -> ApiResponse: # noqa: E501
|
784
784
|
"""[EARLY ACCESS] UpdateRelationshipDefinition: Update Relationship Definition # noqa: E501
|
785
785
|
|
786
|
-
Update the definition of a specified existing relationship. Not all elements within a relationship definition
|
786
|
+
Update the definition of a specified existing relationship. Not all elements within a relationship definition are modifiable due to the potential implications for values already stored against the relationship. # noqa: E501
|
787
787
|
This method makes a synchronous HTTP request by default. To make an
|
788
788
|
asynchronous HTTP request, please pass async_req=True
|
789
789
|
|
@@ -792,7 +792,7 @@ class RelationshipDefinitionsApi:
|
|
792
792
|
|
793
793
|
:param scope: The scope of the relationship definition being updated. (required)
|
794
794
|
:type scope: str
|
795
|
-
:param code: The code of the relationship definition being updated. Together with the scope this uniquely
|
795
|
+
:param code: The code of the relationship definition being updated. Together with the scope this uniquely identifies the relationship definition. (required)
|
796
796
|
:type code: str
|
797
797
|
:param update_relationship_definition_request: The details of relationship definition to update. (required)
|
798
798
|
:type update_relationship_definition_request: UpdateRelationshipDefinitionRequest
|
lusid/api/scopes_api.py
CHANGED
@@ -55,15 +55,15 @@ class ScopesApi:
|
|
55
55
|
|
56
56
|
|
57
57
|
@overload
|
58
|
-
async def list_entity_scopes(self, entity_type : Annotated[StrictStr, Field(..., description="The entity type to list scopes for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve scopes. Defaults to latest datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing scopes from a previous call to list scopes.
|
58
|
+
async def list_entity_scopes(self, entity_type : Annotated[StrictStr, Field(..., description="The entity type to list scopes for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve scopes. Defaults to latest datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing scopes from a previous call to list scopes. This value is returned from the previous call. If a pagination token is provided, the limit 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 number. Defaults to 100 if not specified.")] = None, **kwargs) -> ResourceListOfScopeDefinition: # noqa: E501
|
59
59
|
...
|
60
60
|
|
61
61
|
@overload
|
62
|
-
def list_entity_scopes(self, entity_type : Annotated[StrictStr, Field(..., description="The entity type to list scopes for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve scopes. Defaults to latest datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing scopes from a previous call to list scopes.
|
62
|
+
def list_entity_scopes(self, entity_type : Annotated[StrictStr, Field(..., description="The entity type to list scopes for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve scopes. Defaults to latest datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing scopes from a previous call to list scopes. This value is returned from the previous call. If a pagination token is provided, the limit 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 number. Defaults to 100 if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfScopeDefinition: # noqa: E501
|
63
63
|
...
|
64
64
|
|
65
65
|
@validate_arguments
|
66
|
-
def list_entity_scopes(self, entity_type : Annotated[StrictStr, Field(..., description="The entity type to list scopes for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve scopes. Defaults to latest datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing scopes from a previous call to list scopes.
|
66
|
+
def list_entity_scopes(self, entity_type : Annotated[StrictStr, Field(..., description="The entity type to list scopes for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve scopes. Defaults to latest datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing scopes from a previous call to list scopes. This value is returned from the previous call. If a pagination token is provided, the limit 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 number. Defaults to 100 if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfScopeDefinition, Awaitable[ResourceListOfScopeDefinition]]: # noqa: E501
|
67
67
|
"""ListEntityScopes: List Entity Scopes # noqa: E501
|
68
68
|
|
69
69
|
List all the scopes for a given entity type that contain data. # noqa: E501
|
@@ -77,7 +77,7 @@ class ScopesApi:
|
|
77
77
|
:type entity_type: str
|
78
78
|
:param as_at: The asAt datetime at which to retrieve scopes. Defaults to latest datetime if not specified.
|
79
79
|
:type as_at: datetime
|
80
|
-
:param page: The pagination token to use to continue listing scopes from a previous call to list scopes.
|
80
|
+
:param page: The pagination token to use to continue listing scopes from a previous call to list scopes. This value is returned from the previous call. If a pagination token is provided, the limit and asAt fields must not have changed since the original request.
|
81
81
|
:type page: str
|
82
82
|
:param limit: When paginating, limit the number of returned results to this number. Defaults to 100 if not specified.
|
83
83
|
:type limit: int
|
@@ -100,7 +100,7 @@ class ScopesApi:
|
|
100
100
|
return self.list_entity_scopes_with_http_info(entity_type, as_at, page, limit, **kwargs) # noqa: E501
|
101
101
|
|
102
102
|
@validate_arguments
|
103
|
-
def list_entity_scopes_with_http_info(self, entity_type : Annotated[StrictStr, Field(..., description="The entity type to list scopes for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve scopes. Defaults to latest datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing scopes from a previous call to list scopes.
|
103
|
+
def list_entity_scopes_with_http_info(self, entity_type : Annotated[StrictStr, Field(..., description="The entity type to list scopes for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve scopes. Defaults to latest datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing scopes from a previous call to list scopes. This value is returned from the previous call. If a pagination token is provided, the limit 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 number. Defaults to 100 if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
104
104
|
"""ListEntityScopes: List Entity Scopes # noqa: E501
|
105
105
|
|
106
106
|
List all the scopes for a given entity type that contain data. # noqa: E501
|
@@ -114,7 +114,7 @@ class ScopesApi:
|
|
114
114
|
:type entity_type: str
|
115
115
|
:param as_at: The asAt datetime at which to retrieve scopes. Defaults to latest datetime if not specified.
|
116
116
|
:type as_at: datetime
|
117
|
-
:param page: The pagination token to use to continue listing scopes from a previous call to list scopes.
|
117
|
+
:param page: The pagination token to use to continue listing scopes from a previous call to list scopes. This value is returned from the previous call. If a pagination token is provided, the limit and asAt fields must not have changed since the original request.
|
118
118
|
:type page: str
|
119
119
|
:param limit: When paginating, limit the number of returned results to this number. Defaults to 100 if not specified.
|
120
120
|
:type limit: int
|
@@ -234,15 +234,15 @@ class ScopesApi:
|
|
234
234
|
|
235
235
|
|
236
236
|
@overload
|
237
|
-
async def list_scopes(self, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set.
|
237
|
+
async def list_scopes(self, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Scope, use \"scope eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> ResourceListOfScopeDefinition: # noqa: E501
|
238
238
|
...
|
239
239
|
|
240
240
|
@overload
|
241
|
-
def list_scopes(self, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set.
|
241
|
+
def list_scopes(self, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Scope, use \"scope eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfScopeDefinition: # noqa: E501
|
242
242
|
...
|
243
243
|
|
244
244
|
@validate_arguments
|
245
|
-
def list_scopes(self, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set.
|
245
|
+
def list_scopes(self, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Scope, use \"scope eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfScopeDefinition, Awaitable[ResourceListOfScopeDefinition]]: # noqa: E501
|
246
246
|
"""ListScopes: List Scopes # noqa: E501
|
247
247
|
|
248
248
|
List all the scopes that contain data. # noqa: E501
|
@@ -252,7 +252,7 @@ class ScopesApi:
|
|
252
252
|
>>> thread = api.list_scopes(filter, async_req=True)
|
253
253
|
>>> result = thread.get()
|
254
254
|
|
255
|
-
:param filter: Expression to filter the result set.
|
255
|
+
:param filter: Expression to filter the result set. For example, to filter on the Scope, use \"scope eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
256
256
|
:type filter: str
|
257
257
|
:param async_req: Whether to execute the request asynchronously.
|
258
258
|
:type async_req: bool, optional
|
@@ -273,7 +273,7 @@ class ScopesApi:
|
|
273
273
|
return self.list_scopes_with_http_info(filter, **kwargs) # noqa: E501
|
274
274
|
|
275
275
|
@validate_arguments
|
276
|
-
def list_scopes_with_http_info(self, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set.
|
276
|
+
def list_scopes_with_http_info(self, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Scope, use \"scope eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
277
277
|
"""ListScopes: List Scopes # noqa: E501
|
278
278
|
|
279
279
|
List all the scopes that contain data. # noqa: E501
|
@@ -283,7 +283,7 @@ class ScopesApi:
|
|
283
283
|
>>> thread = api.list_scopes_with_http_info(filter, async_req=True)
|
284
284
|
>>> result = thread.get()
|
285
285
|
|
286
|
-
:param filter: Expression to filter the result set.
|
286
|
+
:param filter: Expression to filter the result set. For example, to filter on the Scope, use \"scope eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
287
287
|
:type filter: str
|
288
288
|
:param async_req: Whether to execute the request asynchronously.
|
289
289
|
:type async_req: bool, optional
|
@@ -445,15 +445,15 @@ class ScriptedTranslationApi:
|
|
445
445
|
|
446
446
|
|
447
447
|
@overload
|
448
|
-
async def list_dialect_ids(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the dialects.
|
448
|
+
async def list_dialect_ids(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the dialects. Defaults to return the latest version of the dialect if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing dialect IDs from a previous call to list dialect IDs. This value is returned from the previous call. If a pagination token is provided the 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, 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) -> PagedResourceListOfDialectId: # noqa: E501
|
449
449
|
...
|
450
450
|
|
451
451
|
@overload
|
452
|
-
def list_dialect_ids(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the dialects.
|
452
|
+
def list_dialect_ids(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the dialects. Defaults to return the latest version of the dialect if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing dialect IDs from a previous call to list dialect IDs. This value is returned from the previous call. If a pagination token is provided the 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, 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) -> PagedResourceListOfDialectId: # noqa: E501
|
453
453
|
...
|
454
454
|
|
455
455
|
@validate_arguments
|
456
|
-
def list_dialect_ids(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the dialects.
|
456
|
+
def list_dialect_ids(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the dialects. Defaults to return the latest version of the dialect if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing dialect IDs from a previous call to list dialect IDs. This value is returned from the previous call. If a pagination token is provided the 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, 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[PagedResourceListOfDialectId, Awaitable[PagedResourceListOfDialectId]]: # noqa: E501
|
457
457
|
"""[EARLY ACCESS] ListDialectIds: List dialect identifiers matching an optional filter. # noqa: E501
|
458
458
|
|
459
459
|
List the stored dialects' identifiers with pagination and filtering at the specified asAt time. # noqa: E501
|
@@ -463,13 +463,13 @@ class ScriptedTranslationApi:
|
|
463
463
|
>>> thread = api.list_dialect_ids(as_at, page, limit, filter, async_req=True)
|
464
464
|
>>> result = thread.get()
|
465
465
|
|
466
|
-
:param as_at: The asAt datetime at which to retrieve the dialects.
|
466
|
+
:param as_at: The asAt datetime at which to retrieve the dialects. Defaults to return the latest version of the dialect if not specified.
|
467
467
|
:type as_at: datetime
|
468
|
-
:param page: The pagination token to use to continue listing dialect IDs from a previous call to list dialect IDs.
|
468
|
+
:param page: The pagination token to use to continue listing dialect IDs from a previous call to list dialect IDs. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request.
|
469
469
|
:type page: str
|
470
470
|
:param limit: When paginating, limit the number of returned results to this many.
|
471
471
|
:type limit: int
|
472
|
-
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here:
|
472
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
473
473
|
:type filter: str
|
474
474
|
:param async_req: Whether to execute the request asynchronously.
|
475
475
|
:type async_req: bool, optional
|
@@ -490,7 +490,7 @@ class ScriptedTranslationApi:
|
|
490
490
|
return self.list_dialect_ids_with_http_info(as_at, page, limit, filter, **kwargs) # noqa: E501
|
491
491
|
|
492
492
|
@validate_arguments
|
493
|
-
def list_dialect_ids_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the dialects.
|
493
|
+
def list_dialect_ids_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the dialects. Defaults to return the latest version of the dialect if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing dialect IDs from a previous call to list dialect IDs. This value is returned from the previous call. If a pagination token is provided the 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, 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
|
494
494
|
"""[EARLY ACCESS] ListDialectIds: List dialect identifiers matching an optional filter. # noqa: E501
|
495
495
|
|
496
496
|
List the stored dialects' identifiers with pagination and filtering at the specified asAt time. # noqa: E501
|
@@ -500,13 +500,13 @@ class ScriptedTranslationApi:
|
|
500
500
|
>>> thread = api.list_dialect_ids_with_http_info(as_at, page, limit, filter, async_req=True)
|
501
501
|
>>> result = thread.get()
|
502
502
|
|
503
|
-
:param as_at: The asAt datetime at which to retrieve the dialects.
|
503
|
+
:param as_at: The asAt datetime at which to retrieve the dialects. Defaults to return the latest version of the dialect if not specified.
|
504
504
|
:type as_at: datetime
|
505
|
-
:param page: The pagination token to use to continue listing dialect IDs from a previous call to list dialect IDs.
|
505
|
+
:param page: The pagination token to use to continue listing dialect IDs from a previous call to list dialect IDs. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request.
|
506
506
|
:type page: str
|
507
507
|
:param limit: When paginating, limit the number of returned results to this many.
|
508
508
|
:type limit: int
|
509
|
-
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here:
|
509
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
510
510
|
:type filter: str
|
511
511
|
:param async_req: Whether to execute the request asynchronously.
|
512
512
|
:type async_req: bool, optional
|
@@ -624,15 +624,15 @@ class ScriptedTranslationApi:
|
|
624
624
|
|
625
625
|
|
626
626
|
@overload
|
627
|
-
async def list_translation_script_ids(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the script identifiers. Defaults to latest.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, Id.Version.Major eq 1 to list IDs with major version 1
|
627
|
+
async def list_translation_script_ids(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the script identifiers. Defaults to latest.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, Id.Version.Major eq 1 to list IDs with major version 1 or Id.Scope eq 'my-scripts' to list result only for a particular scope.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing translation script IDs; this value is returned from the previous call. If a pagination token is provided, the filter field must not have changed since the original request.")] = None, **kwargs) -> PagedResourceListOfTranslationScriptId: # noqa: E501
|
628
628
|
...
|
629
629
|
|
630
630
|
@overload
|
631
|
-
def list_translation_script_ids(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the script identifiers. Defaults to latest.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, Id.Version.Major eq 1 to list IDs with major version 1
|
631
|
+
def list_translation_script_ids(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the script identifiers. Defaults to latest.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, Id.Version.Major eq 1 to list IDs with major version 1 or Id.Scope eq 'my-scripts' to list result only for a particular scope.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing translation script IDs; this value is returned from the previous call. If a pagination token is provided, the filter field must not have changed since the original request.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfTranslationScriptId: # noqa: E501
|
632
632
|
...
|
633
633
|
|
634
634
|
@validate_arguments
|
635
|
-
def list_translation_script_ids(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the script identifiers. Defaults to latest.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, Id.Version.Major eq 1 to list IDs with major version 1
|
635
|
+
def list_translation_script_ids(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the script identifiers. Defaults to latest.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, Id.Version.Major eq 1 to list IDs with major version 1 or Id.Scope eq 'my-scripts' to list result only for a particular scope.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing translation script IDs; this value is returned from the previous call. If a pagination token is provided, the filter field must not have changed since the original request.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfTranslationScriptId, Awaitable[PagedResourceListOfTranslationScriptId]]: # noqa: E501
|
636
636
|
"""[EARLY ACCESS] ListTranslationScriptIds: List translation script identifiers. # noqa: E501
|
637
637
|
|
638
638
|
List translation script ids. # noqa: E501
|
@@ -646,9 +646,9 @@ class ScriptedTranslationApi:
|
|
646
646
|
:type as_at: datetime
|
647
647
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
648
648
|
:type limit: int
|
649
|
-
:param filter: Expression to filter the results. For example, Id.Version.Major eq 1 to list IDs with major version 1
|
649
|
+
:param filter: Expression to filter the results. For example, Id.Version.Major eq 1 to list IDs with major version 1 or Id.Scope eq 'my-scripts' to list result only for a particular scope.
|
650
650
|
:type filter: str
|
651
|
-
:param page: The pagination token to use to continue listing translation script IDs; this
|
651
|
+
:param page: The pagination token to use to continue listing translation script IDs; this value is returned from the previous call. If a pagination token is provided, the filter field must not have changed since the original request.
|
652
652
|
:type page: str
|
653
653
|
:param async_req: Whether to execute the request asynchronously.
|
654
654
|
:type async_req: bool, optional
|
@@ -669,7 +669,7 @@ class ScriptedTranslationApi:
|
|
669
669
|
return self.list_translation_script_ids_with_http_info(as_at, limit, filter, page, **kwargs) # noqa: E501
|
670
670
|
|
671
671
|
@validate_arguments
|
672
|
-
def list_translation_script_ids_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the script identifiers. Defaults to latest.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, Id.Version.Major eq 1 to list IDs with major version 1
|
672
|
+
def list_translation_script_ids_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the script identifiers. Defaults to latest.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, Id.Version.Major eq 1 to list IDs with major version 1 or Id.Scope eq 'my-scripts' to list result only for a particular scope.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing translation script IDs; this value is returned from the previous call. If a pagination token is provided, the filter field must not have changed since the original request.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
673
673
|
"""[EARLY ACCESS] ListTranslationScriptIds: List translation script identifiers. # noqa: E501
|
674
674
|
|
675
675
|
List translation script ids. # noqa: E501
|
@@ -683,9 +683,9 @@ class ScriptedTranslationApi:
|
|
683
683
|
:type as_at: datetime
|
684
684
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
685
685
|
:type limit: int
|
686
|
-
:param filter: Expression to filter the results. For example, Id.Version.Major eq 1 to list IDs with major version 1
|
686
|
+
:param filter: Expression to filter the results. For example, Id.Version.Major eq 1 to list IDs with major version 1 or Id.Scope eq 'my-scripts' to list result only for a particular scope.
|
687
687
|
:type filter: str
|
688
|
-
:param page: The pagination token to use to continue listing translation script IDs; this
|
688
|
+
:param page: The pagination token to use to continue listing translation script IDs; this value is returned from the previous call. If a pagination token is provided, the filter field must not have changed since the original request.
|
689
689
|
:type page: str
|
690
690
|
:param async_req: Whether to execute the request asynchronously.
|
691
691
|
:type async_req: bool, optional
|
@@ -814,7 +814,7 @@ class ScriptedTranslationApi:
|
|
814
814
|
def translate_entities(self, translate_entities_request : Annotated[TranslateEntitiesRequest, Field(..., description="The entities to translate, along with identifiers for the script and (optional) dialect to use.")], async_req: Optional[bool]=None, **kwargs) -> Union[TranslateEntitiesResponse, Awaitable[TranslateEntitiesResponse]]: # noqa: E501
|
815
815
|
"""[EARLY ACCESS] TranslateEntities: Translate a collection of entities with a specified translation script. # noqa: E501
|
816
816
|
|
817
|
-
Run the provided translation request. The entities to translate are specified in the request body as a
|
817
|
+
Run the provided translation request. The entities to translate are specified in the request body as a dictionary with (ephemeral) unique correlation IDs. The script to use and optional dialect to validate results against are sourced from the database. # noqa: E501
|
818
818
|
This method makes a synchronous HTTP request by default. To make an
|
819
819
|
asynchronous HTTP request, please pass async_req=True
|
820
820
|
|
@@ -845,7 +845,7 @@ class ScriptedTranslationApi:
|
|
845
845
|
def translate_entities_with_http_info(self, translate_entities_request : Annotated[TranslateEntitiesRequest, Field(..., description="The entities to translate, along with identifiers for the script and (optional) dialect to use.")], **kwargs) -> ApiResponse: # noqa: E501
|
846
846
|
"""[EARLY ACCESS] TranslateEntities: Translate a collection of entities with a specified translation script. # noqa: E501
|
847
847
|
|
848
|
-
Run the provided translation request. The entities to translate are specified in the request body as a
|
848
|
+
Run the provided translation request. The entities to translate are specified in the request body as a dictionary with (ephemeral) unique correlation IDs. The script to use and optional dialect to validate results against are sourced from the database. # noqa: E501
|
849
849
|
This method makes a synchronous HTTP request by default. To make an
|
850
850
|
asynchronous HTTP request, please pass async_req=True
|
851
851
|
|
@@ -973,7 +973,7 @@ class ScriptedTranslationApi:
|
|
973
973
|
def translate_entities_inlined(self, translate_entities_inlined_request : Annotated[TranslateEntitiesInlinedRequest, Field(..., description="The entities to translate, along with the script to use and an optional schema for validation.")], async_req: Optional[bool]=None, **kwargs) -> Union[TranslateEntitiesResponse, Awaitable[TranslateEntitiesResponse]]: # noqa: E501
|
974
974
|
"""[EARLY ACCESS] TranslateEntitiesInlined: Translate a collection of entities, inlining the body of the translation script. # noqa: E501
|
975
975
|
|
976
|
-
Run the provided translation request. The entities to translate, script to use and dialect to validate results against
|
976
|
+
Run the provided translation request. The entities to translate, script to use and dialect to validate results against are all specified in the request body. The entities are given as a dictionary with (ephemeral) unique correlation IDs. # noqa: E501
|
977
977
|
This method makes a synchronous HTTP request by default. To make an
|
978
978
|
asynchronous HTTP request, please pass async_req=True
|
979
979
|
|
@@ -1004,7 +1004,7 @@ class ScriptedTranslationApi:
|
|
1004
1004
|
def translate_entities_inlined_with_http_info(self, translate_entities_inlined_request : Annotated[TranslateEntitiesInlinedRequest, Field(..., description="The entities to translate, along with the script to use and an optional schema for validation.")], **kwargs) -> ApiResponse: # noqa: E501
|
1005
1005
|
"""[EARLY ACCESS] TranslateEntitiesInlined: Translate a collection of entities, inlining the body of the translation script. # noqa: E501
|
1006
1006
|
|
1007
|
-
Run the provided translation request. The entities to translate, script to use and dialect to validate results against
|
1007
|
+
Run the provided translation request. The entities to translate, script to use and dialect to validate results against are all specified in the request body. The entities are given as a dictionary with (ephemeral) unique correlation IDs. # noqa: E501
|
1008
1008
|
This method makes a synchronous HTTP request by default. To make an
|
1009
1009
|
asynchronous HTTP request, please pass async_req=True
|
1010
1010
|
|