lusid-sdk 2.1.911__py3-none-any.whl → 2.1.912__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 +126 -126
- 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_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_holding.py +6 -2
- 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 +6 -4
- 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/settlement_schedule.py +20 -2
- 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_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.911.dist-info → lusid_sdk-2.1.912.dist-info}/METADATA +3 -3
- {lusid_sdk-2.1.911.dist-info → lusid_sdk-2.1.912.dist-info}/RECORD +332 -332
- {lusid_sdk-2.1.911.dist-info → lusid_sdk-2.1.912.dist-info}/WHEEL +0 -0
@@ -69,18 +69,18 @@ class GroupReconciliationsApi:
|
|
69
69
|
|
70
70
|
|
71
71
|
@overload
|
72
|
-
async def batch_update_comparison_results(self, scope : Annotated[StrictStr, Field(..., description="Shared Scope of the GroupReconciliationDefinition and GroupReconciliationComparisonResults.")], code : Annotated[StrictStr, Field(..., description="GroupReconciliationDefinitionId code.")], batch_update_user_review_for_comparison_result_request : Annotated[conlist(BatchUpdateUserReviewForComparisonResultRequest), Field(..., description="A collection of the comparison result Ids and their user review entries to be added or removed.
|
72
|
+
async def batch_update_comparison_results(self, scope : Annotated[StrictStr, Field(..., description="Shared Scope of the GroupReconciliationDefinition and GroupReconciliationComparisonResults.")], code : Annotated[StrictStr, Field(..., description="GroupReconciliationDefinitionId code.")], batch_update_user_review_for_comparison_result_request : Annotated[conlist(BatchUpdateUserReviewForComparisonResultRequest), Field(..., description="A collection of the comparison result Ids and their user review entries to be added or removed. Single request contains resultId, break code/match key/comment to add and break code/match key/comment to remove by added timestamp.")], success_mode : Annotated[Optional[StrictStr], Field( description="Defines whether the request should fail if at least one of the entries is failed to update or process all the entries regardless and return collections of successful and failed updates. \"Partial\" (default) | \"Atomic\".")] = None, **kwargs) -> BatchUpdateUserReviewForComparisonResultResponse: # noqa: E501
|
73
73
|
...
|
74
74
|
|
75
75
|
@overload
|
76
|
-
def batch_update_comparison_results(self, scope : Annotated[StrictStr, Field(..., description="Shared Scope of the GroupReconciliationDefinition and GroupReconciliationComparisonResults.")], code : Annotated[StrictStr, Field(..., description="GroupReconciliationDefinitionId code.")], batch_update_user_review_for_comparison_result_request : Annotated[conlist(BatchUpdateUserReviewForComparisonResultRequest), Field(..., description="A collection of the comparison result Ids and their user review entries to be added or removed.
|
76
|
+
def batch_update_comparison_results(self, scope : Annotated[StrictStr, Field(..., description="Shared Scope of the GroupReconciliationDefinition and GroupReconciliationComparisonResults.")], code : Annotated[StrictStr, Field(..., description="GroupReconciliationDefinitionId code.")], batch_update_user_review_for_comparison_result_request : Annotated[conlist(BatchUpdateUserReviewForComparisonResultRequest), Field(..., description="A collection of the comparison result Ids and their user review entries to be added or removed. Single request contains resultId, break code/match key/comment to add and break code/match key/comment to remove by added timestamp.")], success_mode : Annotated[Optional[StrictStr], Field( description="Defines whether the request should fail if at least one of the entries is failed to update or process all the entries regardless and return collections of successful and failed updates. \"Partial\" (default) | \"Atomic\".")] = None, async_req: Optional[bool]=True, **kwargs) -> BatchUpdateUserReviewForComparisonResultResponse: # noqa: E501
|
77
77
|
...
|
78
78
|
|
79
79
|
@validate_arguments
|
80
|
-
def batch_update_comparison_results(self, scope : Annotated[StrictStr, Field(..., description="Shared Scope of the GroupReconciliationDefinition and GroupReconciliationComparisonResults.")], code : Annotated[StrictStr, Field(..., description="GroupReconciliationDefinitionId code.")], batch_update_user_review_for_comparison_result_request : Annotated[conlist(BatchUpdateUserReviewForComparisonResultRequest), Field(..., description="A collection of the comparison result Ids and their user review entries to be added or removed.
|
80
|
+
def batch_update_comparison_results(self, scope : Annotated[StrictStr, Field(..., description="Shared Scope of the GroupReconciliationDefinition and GroupReconciliationComparisonResults.")], code : Annotated[StrictStr, Field(..., description="GroupReconciliationDefinitionId code.")], batch_update_user_review_for_comparison_result_request : Annotated[conlist(BatchUpdateUserReviewForComparisonResultRequest), Field(..., description="A collection of the comparison result Ids and their user review entries to be added or removed. Single request contains resultId, break code/match key/comment to add and break code/match key/comment to remove by added timestamp.")], success_mode : Annotated[Optional[StrictStr], Field( description="Defines whether the request should fail if at least one of the entries is failed to update or process all the entries regardless and return collections of successful and failed updates. \"Partial\" (default) | \"Atomic\".")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[BatchUpdateUserReviewForComparisonResultResponse, Awaitable[BatchUpdateUserReviewForComparisonResultResponse]]: # noqa: E501
|
81
81
|
"""[EXPERIMENTAL] BatchUpdateComparisonResults: Add User Review entries for a range of comparison results related to a specific GroupReconciliationDefinition. # noqa: E501
|
82
82
|
|
83
|
-
Allows to update multiple Group Reconciliation Comparison Results related to the same definition specified by the Finbourne.Identifiers.Abstractions.Scope and Finbourne.Identifiers.Abstractions.Code.
|
83
|
+
Allows to update multiple Group Reconciliation Comparison Results related to the same definition specified by the Finbourne.Identifiers.Abstractions.Scope and Finbourne.Identifiers.Abstractions.Code. Updates User Review with new entries and sets the relevant Review Status. Supports partial success when all the entries that haven't passed validation or are not related to the definition will be returned with respectful error details. # noqa: E501
|
84
84
|
This method makes a synchronous HTTP request by default. To make an
|
85
85
|
asynchronous HTTP request, please pass async_req=True
|
86
86
|
|
@@ -91,9 +91,9 @@ class GroupReconciliationsApi:
|
|
91
91
|
:type scope: str
|
92
92
|
:param code: GroupReconciliationDefinitionId code. (required)
|
93
93
|
:type code: str
|
94
|
-
:param batch_update_user_review_for_comparison_result_request: A collection of the comparison result Ids and their user review entries to be added or removed.
|
94
|
+
:param batch_update_user_review_for_comparison_result_request: A collection of the comparison result Ids and their user review entries to be added or removed. Single request contains resultId, break code/match key/comment to add and break code/match key/comment to remove by added timestamp. (required)
|
95
95
|
:type batch_update_user_review_for_comparison_result_request: List[BatchUpdateUserReviewForComparisonResultRequest]
|
96
|
-
:param success_mode: Defines whether the request should fail if at least one of the entries is failed to update
|
96
|
+
:param success_mode: Defines whether the request should fail if at least one of the entries is failed to update or process all the entries regardless and return collections of successful and failed updates. \"Partial\" (default) | \"Atomic\".
|
97
97
|
:type success_mode: str
|
98
98
|
:param async_req: Whether to execute the request asynchronously.
|
99
99
|
:type async_req: bool, optional
|
@@ -114,10 +114,10 @@ class GroupReconciliationsApi:
|
|
114
114
|
return self.batch_update_comparison_results_with_http_info(scope, code, batch_update_user_review_for_comparison_result_request, success_mode, **kwargs) # noqa: E501
|
115
115
|
|
116
116
|
@validate_arguments
|
117
|
-
def batch_update_comparison_results_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="Shared Scope of the GroupReconciliationDefinition and GroupReconciliationComparisonResults.")], code : Annotated[StrictStr, Field(..., description="GroupReconciliationDefinitionId code.")], batch_update_user_review_for_comparison_result_request : Annotated[conlist(BatchUpdateUserReviewForComparisonResultRequest), Field(..., description="A collection of the comparison result Ids and their user review entries to be added or removed.
|
117
|
+
def batch_update_comparison_results_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="Shared Scope of the GroupReconciliationDefinition and GroupReconciliationComparisonResults.")], code : Annotated[StrictStr, Field(..., description="GroupReconciliationDefinitionId code.")], batch_update_user_review_for_comparison_result_request : Annotated[conlist(BatchUpdateUserReviewForComparisonResultRequest), Field(..., description="A collection of the comparison result Ids and their user review entries to be added or removed. Single request contains resultId, break code/match key/comment to add and break code/match key/comment to remove by added timestamp.")], success_mode : Annotated[Optional[StrictStr], Field( description="Defines whether the request should fail if at least one of the entries is failed to update or process all the entries regardless and return collections of successful and failed updates. \"Partial\" (default) | \"Atomic\".")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
118
118
|
"""[EXPERIMENTAL] BatchUpdateComparisonResults: Add User Review entries for a range of comparison results related to a specific GroupReconciliationDefinition. # noqa: E501
|
119
119
|
|
120
|
-
Allows to update multiple Group Reconciliation Comparison Results related to the same definition specified by the Finbourne.Identifiers.Abstractions.Scope and Finbourne.Identifiers.Abstractions.Code.
|
120
|
+
Allows to update multiple Group Reconciliation Comparison Results related to the same definition specified by the Finbourne.Identifiers.Abstractions.Scope and Finbourne.Identifiers.Abstractions.Code. Updates User Review with new entries and sets the relevant Review Status. Supports partial success when all the entries that haven't passed validation or are not related to the definition will be returned with respectful error details. # noqa: E501
|
121
121
|
This method makes a synchronous HTTP request by default. To make an
|
122
122
|
asynchronous HTTP request, please pass async_req=True
|
123
123
|
|
@@ -128,9 +128,9 @@ class GroupReconciliationsApi:
|
|
128
128
|
:type scope: str
|
129
129
|
:param code: GroupReconciliationDefinitionId code. (required)
|
130
130
|
:type code: str
|
131
|
-
:param batch_update_user_review_for_comparison_result_request: A collection of the comparison result Ids and their user review entries to be added or removed.
|
131
|
+
:param batch_update_user_review_for_comparison_result_request: A collection of the comparison result Ids and their user review entries to be added or removed. Single request contains resultId, break code/match key/comment to add and break code/match key/comment to remove by added timestamp. (required)
|
132
132
|
:type batch_update_user_review_for_comparison_result_request: List[BatchUpdateUserReviewForComparisonResultRequest]
|
133
|
-
:param success_mode: Defines whether the request should fail if at least one of the entries is failed to update
|
133
|
+
:param success_mode: Defines whether the request should fail if at least one of the entries is failed to update or process all the entries regardless and return collections of successful and failed updates. \"Partial\" (default) | \"Atomic\".
|
134
134
|
:type success_mode: str
|
135
135
|
:param async_req: Whether to execute the request asynchronously.
|
136
136
|
:type async_req: bool, optional
|
@@ -570,18 +570,18 @@ class GroupReconciliationsApi:
|
|
570
570
|
|
571
571
|
|
572
572
|
@overload
|
573
|
-
async def delete_comparison_ruleset(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison ruleset.")], code : Annotated[StrictStr, Field(..., description="The code of the specified comparison ruleset. Together with the domain and scope this uniquely
|
573
|
+
async def delete_comparison_ruleset(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison ruleset.")], code : Annotated[StrictStr, Field(..., description="The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset.")], **kwargs) -> DeletedEntityResponse: # noqa: E501
|
574
574
|
...
|
575
575
|
|
576
576
|
@overload
|
577
|
-
def delete_comparison_ruleset(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison ruleset.")], code : Annotated[StrictStr, Field(..., description="The code of the specified comparison ruleset. Together with the domain and scope this uniquely
|
577
|
+
def delete_comparison_ruleset(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison ruleset.")], code : Annotated[StrictStr, Field(..., description="The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset.")], async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
|
578
578
|
...
|
579
579
|
|
580
580
|
@validate_arguments
|
581
|
-
def delete_comparison_ruleset(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison ruleset.")], code : Annotated[StrictStr, Field(..., description="The code of the specified comparison ruleset. Together with the domain and scope this uniquely
|
581
|
+
def delete_comparison_ruleset(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison ruleset.")], code : Annotated[StrictStr, Field(..., description="The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
582
582
|
"""[EXPERIMENTAL] DeleteComparisonRuleset: Deletes a particular Group Reconciliation Comparison Ruleset # noqa: E501
|
583
583
|
|
584
|
-
The deletion will take effect from the reconciliation comparison ruleset deletion datetime.
|
584
|
+
The deletion will take effect from the reconciliation comparison ruleset deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion. # noqa: E501
|
585
585
|
This method makes a synchronous HTTP request by default. To make an
|
586
586
|
asynchronous HTTP request, please pass async_req=True
|
587
587
|
|
@@ -590,7 +590,7 @@ class GroupReconciliationsApi:
|
|
590
590
|
|
591
591
|
:param scope: The scope of the specified comparison ruleset. (required)
|
592
592
|
:type scope: str
|
593
|
-
:param code: The code of the specified comparison ruleset. Together with the domain and scope this uniquely
|
593
|
+
:param code: The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset. (required)
|
594
594
|
:type code: str
|
595
595
|
:param async_req: Whether to execute the request asynchronously.
|
596
596
|
:type async_req: bool, optional
|
@@ -611,10 +611,10 @@ class GroupReconciliationsApi:
|
|
611
611
|
return self.delete_comparison_ruleset_with_http_info(scope, code, **kwargs) # noqa: E501
|
612
612
|
|
613
613
|
@validate_arguments
|
614
|
-
def delete_comparison_ruleset_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison ruleset.")], code : Annotated[StrictStr, Field(..., description="The code of the specified comparison ruleset. Together with the domain and scope this uniquely
|
614
|
+
def delete_comparison_ruleset_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison ruleset.")], code : Annotated[StrictStr, Field(..., description="The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset.")], **kwargs) -> ApiResponse: # noqa: E501
|
615
615
|
"""[EXPERIMENTAL] DeleteComparisonRuleset: Deletes a particular Group Reconciliation Comparison Ruleset # noqa: E501
|
616
616
|
|
617
|
-
The deletion will take effect from the reconciliation comparison ruleset deletion datetime.
|
617
|
+
The deletion will take effect from the reconciliation comparison ruleset deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion. # noqa: E501
|
618
618
|
This method makes a synchronous HTTP request by default. To make an
|
619
619
|
asynchronous HTTP request, please pass async_req=True
|
620
620
|
|
@@ -623,7 +623,7 @@ class GroupReconciliationsApi:
|
|
623
623
|
|
624
624
|
:param scope: The scope of the specified comparison ruleset. (required)
|
625
625
|
:type scope: str
|
626
|
-
:param code: The code of the specified comparison ruleset. Together with the domain and scope this uniquely
|
626
|
+
:param code: The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset. (required)
|
627
627
|
:type code: str
|
628
628
|
:param async_req: Whether to execute the request asynchronously.
|
629
629
|
:type async_req: bool, optional
|
@@ -890,18 +890,18 @@ class GroupReconciliationsApi:
|
|
890
890
|
|
891
891
|
|
892
892
|
@overload
|
893
|
-
async def get_comparison_result(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison result and its related reconciliation definition.")], code : Annotated[StrictStr, Field(..., description="The code of the reconciliation definition that was used to produce the reconciliation result.")], result_id : Annotated[StrictStr, Field(..., description="The code of the specified reconciliation result. Together with the domain and scope this uniquely
|
893
|
+
async def get_comparison_result(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison result and its related reconciliation definition.")], code : Annotated[StrictStr, Field(..., description="The code of the reconciliation definition that was used to produce the reconciliation result.")], result_id : Annotated[StrictStr, Field(..., description="The code of the specified reconciliation result. Together with the domain and scope this uniquely identifies the reconciliation comparison result. This value is also the same as the computed result hash based on property values.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison result definition. Defaults to return the latest version if not specified.")] = None, **kwargs) -> GroupReconciliationComparisonResult: # noqa: E501
|
894
894
|
...
|
895
895
|
|
896
896
|
@overload
|
897
|
-
def get_comparison_result(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison result and its related reconciliation definition.")], code : Annotated[StrictStr, Field(..., description="The code of the reconciliation definition that was used to produce the reconciliation result.")], result_id : Annotated[StrictStr, Field(..., description="The code of the specified reconciliation result. Together with the domain and scope this uniquely
|
897
|
+
def get_comparison_result(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison result and its related reconciliation definition.")], code : Annotated[StrictStr, Field(..., description="The code of the reconciliation definition that was used to produce the reconciliation result.")], result_id : Annotated[StrictStr, Field(..., description="The code of the specified reconciliation result. Together with the domain and scope this uniquely identifies the reconciliation comparison result. This value is also the same as the computed result hash based on property values.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison result definition. Defaults to return the latest version if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> GroupReconciliationComparisonResult: # noqa: E501
|
898
898
|
...
|
899
899
|
|
900
900
|
@validate_arguments
|
901
|
-
def get_comparison_result(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison result and its related reconciliation definition.")], code : Annotated[StrictStr, Field(..., description="The code of the reconciliation definition that was used to produce the reconciliation result.")], result_id : Annotated[StrictStr, Field(..., description="The code of the specified reconciliation result. Together with the domain and scope this uniquely
|
901
|
+
def get_comparison_result(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison result and its related reconciliation definition.")], code : Annotated[StrictStr, Field(..., description="The code of the reconciliation definition that was used to produce the reconciliation result.")], result_id : Annotated[StrictStr, Field(..., description="The code of the specified reconciliation result. Together with the domain and scope this uniquely identifies the reconciliation comparison result. This value is also the same as the computed result hash based on property values.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison result definition. Defaults to return the latest version if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[GroupReconciliationComparisonResult, Awaitable[GroupReconciliationComparisonResult]]: # noqa: E501
|
902
902
|
"""[EXPERIMENTAL] GetComparisonResult: Get a single Group Reconciliation Comparison Result by scope and code. # noqa: E501
|
903
903
|
|
904
|
-
Retrieves one Group Reconciliation Comparison Result by scope and code
|
904
|
+
Retrieves one Group Reconciliation Comparison Result by scope and code with the prior validation that its related reconciliation definition exists. # noqa: E501
|
905
905
|
This method makes a synchronous HTTP request by default. To make an
|
906
906
|
asynchronous HTTP request, please pass async_req=True
|
907
907
|
|
@@ -912,9 +912,9 @@ class GroupReconciliationsApi:
|
|
912
912
|
:type scope: str
|
913
913
|
:param code: The code of the reconciliation definition that was used to produce the reconciliation result. (required)
|
914
914
|
:type code: str
|
915
|
-
:param result_id: The code of the specified reconciliation result. Together with the domain and scope this uniquely
|
915
|
+
:param result_id: The code of the specified reconciliation result. Together with the domain and scope this uniquely identifies the reconciliation comparison result. This value is also the same as the computed result hash based on property values. (required)
|
916
916
|
:type result_id: str
|
917
|
-
:param as_at: The asAt datetime at which to retrieve the comparison result definition. Defaults to return
|
917
|
+
:param as_at: The asAt datetime at which to retrieve the comparison result definition. Defaults to return the latest version if not specified.
|
918
918
|
:type as_at: datetime
|
919
919
|
:param async_req: Whether to execute the request asynchronously.
|
920
920
|
:type async_req: bool, optional
|
@@ -935,10 +935,10 @@ class GroupReconciliationsApi:
|
|
935
935
|
return self.get_comparison_result_with_http_info(scope, code, result_id, as_at, **kwargs) # noqa: E501
|
936
936
|
|
937
937
|
@validate_arguments
|
938
|
-
def get_comparison_result_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison result and its related reconciliation definition.")], code : Annotated[StrictStr, Field(..., description="The code of the reconciliation definition that was used to produce the reconciliation result.")], result_id : Annotated[StrictStr, Field(..., description="The code of the specified reconciliation result. Together with the domain and scope this uniquely
|
938
|
+
def get_comparison_result_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison result and its related reconciliation definition.")], code : Annotated[StrictStr, Field(..., description="The code of the reconciliation definition that was used to produce the reconciliation result.")], result_id : Annotated[StrictStr, Field(..., description="The code of the specified reconciliation result. Together with the domain and scope this uniquely identifies the reconciliation comparison result. This value is also the same as the computed result hash based on property values.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison result definition. Defaults to return the latest version if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
939
939
|
"""[EXPERIMENTAL] GetComparisonResult: Get a single Group Reconciliation Comparison Result by scope and code. # noqa: E501
|
940
940
|
|
941
|
-
Retrieves one Group Reconciliation Comparison Result by scope and code
|
941
|
+
Retrieves one Group Reconciliation Comparison Result by scope and code with the prior validation that its related reconciliation definition exists. # noqa: E501
|
942
942
|
This method makes a synchronous HTTP request by default. To make an
|
943
943
|
asynchronous HTTP request, please pass async_req=True
|
944
944
|
|
@@ -949,9 +949,9 @@ class GroupReconciliationsApi:
|
|
949
949
|
:type scope: str
|
950
950
|
:param code: The code of the reconciliation definition that was used to produce the reconciliation result. (required)
|
951
951
|
:type code: str
|
952
|
-
:param result_id: The code of the specified reconciliation result. Together with the domain and scope this uniquely
|
952
|
+
:param result_id: The code of the specified reconciliation result. Together with the domain and scope this uniquely identifies the reconciliation comparison result. This value is also the same as the computed result hash based on property values. (required)
|
953
953
|
:type result_id: str
|
954
|
-
:param as_at: The asAt datetime at which to retrieve the comparison result definition. Defaults to return
|
954
|
+
:param as_at: The asAt datetime at which to retrieve the comparison result definition. Defaults to return the latest version if not specified.
|
955
955
|
:type as_at: datetime
|
956
956
|
:param async_req: Whether to execute the request asynchronously.
|
957
957
|
:type async_req: bool, optional
|
@@ -1069,15 +1069,15 @@ class GroupReconciliationsApi:
|
|
1069
1069
|
|
1070
1070
|
|
1071
1071
|
@overload
|
1072
|
-
async def get_comparison_ruleset(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison ruleset.")], code : Annotated[StrictStr, Field(..., description="The code of the specified comparison ruleset. Together with the domain and scope this uniquely
|
1072
|
+
async def get_comparison_ruleset(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison ruleset.")], code : Annotated[StrictStr, Field(..., description="The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison ruleset definition. Defaults to return the latest version of the definition if not specified.")] = None, **kwargs) -> GroupReconciliationComparisonRuleset: # noqa: E501
|
1073
1073
|
...
|
1074
1074
|
|
1075
1075
|
@overload
|
1076
|
-
def get_comparison_ruleset(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison ruleset.")], code : Annotated[StrictStr, Field(..., description="The code of the specified comparison ruleset. Together with the domain and scope this uniquely
|
1076
|
+
def get_comparison_ruleset(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison ruleset.")], code : Annotated[StrictStr, Field(..., description="The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison ruleset definition. Defaults to return the latest version of the definition if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> GroupReconciliationComparisonRuleset: # noqa: E501
|
1077
1077
|
...
|
1078
1078
|
|
1079
1079
|
@validate_arguments
|
1080
|
-
def get_comparison_ruleset(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison ruleset.")], code : Annotated[StrictStr, Field(..., description="The code of the specified comparison ruleset. Together with the domain and scope this uniquely
|
1080
|
+
def get_comparison_ruleset(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison ruleset.")], code : Annotated[StrictStr, Field(..., description="The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison ruleset definition. Defaults to return the latest version of the definition if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[GroupReconciliationComparisonRuleset, Awaitable[GroupReconciliationComparisonRuleset]]: # noqa: E501
|
1081
1081
|
"""[EXPERIMENTAL] GetComparisonRuleset: Get a single Group Reconciliation Comparison Ruleset by scope and code. # noqa: E501
|
1082
1082
|
|
1083
1083
|
Retrieves one Group Reconciliation Comparison Ruleset by scope and code. # noqa: E501
|
@@ -1089,9 +1089,9 @@ class GroupReconciliationsApi:
|
|
1089
1089
|
|
1090
1090
|
:param scope: The scope of the specified comparison ruleset. (required)
|
1091
1091
|
:type scope: str
|
1092
|
-
:param code: The code of the specified comparison ruleset. Together with the domain and scope this uniquely
|
1092
|
+
:param code: The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset. (required)
|
1093
1093
|
:type code: str
|
1094
|
-
:param as_at: The asAt datetime at which to retrieve the comparison ruleset definition. Defaults to return
|
1094
|
+
:param as_at: The asAt datetime at which to retrieve the comparison ruleset definition. Defaults to return the latest version of the definition if not specified.
|
1095
1095
|
:type as_at: datetime
|
1096
1096
|
:param async_req: Whether to execute the request asynchronously.
|
1097
1097
|
:type async_req: bool, optional
|
@@ -1112,7 +1112,7 @@ class GroupReconciliationsApi:
|
|
1112
1112
|
return self.get_comparison_ruleset_with_http_info(scope, code, as_at, **kwargs) # noqa: E501
|
1113
1113
|
|
1114
1114
|
@validate_arguments
|
1115
|
-
def get_comparison_ruleset_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison ruleset.")], code : Annotated[StrictStr, Field(..., description="The code of the specified comparison ruleset. Together with the domain and scope this uniquely
|
1115
|
+
def get_comparison_ruleset_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison ruleset.")], code : Annotated[StrictStr, Field(..., description="The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison ruleset definition. Defaults to return the latest version of the definition if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1116
1116
|
"""[EXPERIMENTAL] GetComparisonRuleset: Get a single Group Reconciliation Comparison Ruleset by scope and code. # noqa: E501
|
1117
1117
|
|
1118
1118
|
Retrieves one Group Reconciliation Comparison Ruleset by scope and code. # noqa: E501
|
@@ -1124,9 +1124,9 @@ class GroupReconciliationsApi:
|
|
1124
1124
|
|
1125
1125
|
:param scope: The scope of the specified comparison ruleset. (required)
|
1126
1126
|
:type scope: str
|
1127
|
-
:param code: The code of the specified comparison ruleset. Together with the domain and scope this uniquely
|
1127
|
+
:param code: The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset. (required)
|
1128
1128
|
:type code: str
|
1129
|
-
:param as_at: The asAt datetime at which to retrieve the comparison ruleset definition. Defaults to return
|
1129
|
+
:param as_at: The asAt datetime at which to retrieve the comparison ruleset definition. Defaults to return the latest version of the definition if not specified.
|
1130
1130
|
:type as_at: datetime
|
1131
1131
|
:param async_req: Whether to execute the request asynchronously.
|
1132
1132
|
:type async_req: bool, optional
|
@@ -1240,15 +1240,15 @@ class GroupReconciliationsApi:
|
|
1240
1240
|
|
1241
1241
|
|
1242
1242
|
@overload
|
1243
|
-
async def get_group_reconciliation_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group reconciliation definition to retrieve.")], code : Annotated[StrictStr, Field(..., description="The code of the group reconciliation definition to retrieve. Together with the scope
|
1243
|
+
async def get_group_reconciliation_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group reconciliation definition to retrieve.")], code : Annotated[StrictStr, Field(..., description="The code of the group reconciliation definition to retrieve. Together with the scope this uniquely identifies the group reconciliation definition.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the group reconciliation definition. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the group reconciliation definition. Defaults to return the latest version of the portfolio group definition if not specified.")] = None, **kwargs) -> GroupReconciliationDefinition: # noqa: E501
|
1244
1244
|
...
|
1245
1245
|
|
1246
1246
|
@overload
|
1247
|
-
def get_group_reconciliation_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group reconciliation definition to retrieve.")], code : Annotated[StrictStr, Field(..., description="The code of the group reconciliation definition to retrieve. Together with the scope
|
1247
|
+
def get_group_reconciliation_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group reconciliation definition to retrieve.")], code : Annotated[StrictStr, Field(..., description="The code of the group reconciliation definition to retrieve. Together with the scope this uniquely identifies the group reconciliation definition.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the group reconciliation definition. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the group reconciliation definition. Defaults to return the latest version of the portfolio group definition if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> GroupReconciliationDefinition: # noqa: E501
|
1248
1248
|
...
|
1249
1249
|
|
1250
1250
|
@validate_arguments
|
1251
|
-
def get_group_reconciliation_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group reconciliation definition to retrieve.")], code : Annotated[StrictStr, Field(..., description="The code of the group reconciliation definition to retrieve. Together with the scope
|
1251
|
+
def get_group_reconciliation_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group reconciliation definition to retrieve.")], code : Annotated[StrictStr, Field(..., description="The code of the group reconciliation definition to retrieve. Together with the scope this uniquely identifies the group reconciliation definition.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the group reconciliation definition. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the group reconciliation definition. Defaults to return the latest version of the portfolio group definition if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[GroupReconciliationDefinition, Awaitable[GroupReconciliationDefinition]]: # noqa: E501
|
1252
1252
|
"""[EXPERIMENTAL] GetGroupReconciliationDefinition: Get group reconciliation definition # noqa: E501
|
1253
1253
|
|
1254
1254
|
Retrieves a Group Reconciliation Definition by scope and code # noqa: E501
|
@@ -1260,7 +1260,7 @@ class GroupReconciliationsApi:
|
|
1260
1260
|
|
1261
1261
|
:param scope: The scope of the group reconciliation definition to retrieve. (required)
|
1262
1262
|
:type scope: str
|
1263
|
-
:param code: The code of the group reconciliation definition to retrieve. Together with the scope
|
1263
|
+
:param code: The code of the group reconciliation definition to retrieve. Together with the scope this uniquely identifies the group reconciliation definition. (required)
|
1264
1264
|
:type code: str
|
1265
1265
|
:param effective_at: The effective datetime or cut label at which to retrieve the group reconciliation definition. Defaults to the current LUSID system datetime if not specified.
|
1266
1266
|
:type effective_at: str
|
@@ -1285,7 +1285,7 @@ class GroupReconciliationsApi:
|
|
1285
1285
|
return self.get_group_reconciliation_definition_with_http_info(scope, code, effective_at, as_at, **kwargs) # noqa: E501
|
1286
1286
|
|
1287
1287
|
@validate_arguments
|
1288
|
-
def get_group_reconciliation_definition_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group reconciliation definition to retrieve.")], code : Annotated[StrictStr, Field(..., description="The code of the group reconciliation definition to retrieve. Together with the scope
|
1288
|
+
def get_group_reconciliation_definition_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group reconciliation definition to retrieve.")], code : Annotated[StrictStr, Field(..., description="The code of the group reconciliation definition to retrieve. Together with the scope this uniquely identifies the group reconciliation definition.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the group reconciliation definition. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the group reconciliation definition. Defaults to return the latest version of the portfolio group definition if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1289
1289
|
"""[EXPERIMENTAL] GetGroupReconciliationDefinition: Get group reconciliation definition # noqa: E501
|
1290
1290
|
|
1291
1291
|
Retrieves a Group Reconciliation Definition by scope and code # noqa: E501
|
@@ -1297,7 +1297,7 @@ class GroupReconciliationsApi:
|
|
1297
1297
|
|
1298
1298
|
:param scope: The scope of the group reconciliation definition to retrieve. (required)
|
1299
1299
|
:type scope: str
|
1300
|
-
:param code: The code of the group reconciliation definition to retrieve. Together with the scope
|
1300
|
+
:param code: The code of the group reconciliation definition to retrieve. Together with the scope this uniquely identifies the group reconciliation definition. (required)
|
1301
1301
|
:type code: str
|
1302
1302
|
:param effective_at: The effective datetime or cut label at which to retrieve the group reconciliation definition. Defaults to the current LUSID system datetime if not specified.
|
1303
1303
|
:type effective_at: str
|
@@ -1419,33 +1419,33 @@ class GroupReconciliationsApi:
|
|
1419
1419
|
|
1420
1420
|
|
1421
1421
|
@overload
|
1422
|
-
async def list_comparison_results(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison results. Defaults to return the latest
|
1422
|
+
async def list_comparison_results(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison results. Defaults to return the latest version of the comparison results if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing comparison results from a previous call to list comparison results. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many per page.")] = 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) -> PagedResourceListOfGroupReconciliationComparisonResult: # noqa: E501
|
1423
1423
|
...
|
1424
1424
|
|
1425
1425
|
@overload
|
1426
|
-
def list_comparison_results(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison results. Defaults to return the latest
|
1426
|
+
def list_comparison_results(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison results. Defaults to return the latest version of the comparison results if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing comparison results from a previous call to list comparison results. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many per page.")] = 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) -> PagedResourceListOfGroupReconciliationComparisonResult: # noqa: E501
|
1427
1427
|
...
|
1428
1428
|
|
1429
1429
|
@validate_arguments
|
1430
|
-
def list_comparison_results(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison results. Defaults to return the latest
|
1430
|
+
def list_comparison_results(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison results. Defaults to return the latest version of the comparison results if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing comparison results from a previous call to list comparison results. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many per page.")] = 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[PagedResourceListOfGroupReconciliationComparisonResult, Awaitable[PagedResourceListOfGroupReconciliationComparisonResult]]: # noqa: E501
|
1431
1431
|
"""[EXPERIMENTAL] ListComparisonResults: Get a set of Group Reconciliation Comparison Results. # noqa: E501
|
1432
1432
|
|
1433
|
-
Retrieves all Group Reconciliation Comparison Results that fit the filter, in a specific order if sortBy is provided.
|
1433
|
+
Retrieves all Group Reconciliation Comparison Results that fit the filter, in a specific order if sortBy is provided. Supports pagination. # noqa: E501
|
1434
1434
|
This method makes a synchronous HTTP request by default. To make an
|
1435
1435
|
asynchronous HTTP request, please pass async_req=True
|
1436
1436
|
|
1437
1437
|
>>> thread = api.list_comparison_results(as_at, page, sort_by, limit, filter, async_req=True)
|
1438
1438
|
>>> result = thread.get()
|
1439
1439
|
|
1440
|
-
:param as_at: The asAt datetime at which to retrieve the comparison results. Defaults to return the latest
|
1440
|
+
:param as_at: The asAt datetime at which to retrieve the comparison results. Defaults to return the latest version of the comparison results if not specified.
|
1441
1441
|
:type as_at: datetime
|
1442
|
-
:param page: The pagination token to use to continue listing comparison results from a previous call to list
|
1442
|
+
:param page: The pagination token to use to continue listing comparison results from a previous call to list comparison results. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
1443
1443
|
:type page: str
|
1444
1444
|
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".
|
1445
1445
|
:type sort_by: List[str]
|
1446
1446
|
:param limit: When paginating, limit the number of returned results to this many per page.
|
1447
1447
|
:type limit: int
|
1448
|
-
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here:
|
1448
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
1449
1449
|
:type filter: str
|
1450
1450
|
:param async_req: Whether to execute the request asynchronously.
|
1451
1451
|
:type async_req: bool, optional
|
@@ -1466,25 +1466,25 @@ class GroupReconciliationsApi:
|
|
1466
1466
|
return self.list_comparison_results_with_http_info(as_at, page, sort_by, limit, filter, **kwargs) # noqa: E501
|
1467
1467
|
|
1468
1468
|
@validate_arguments
|
1469
|
-
def list_comparison_results_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison results. Defaults to return the latest
|
1469
|
+
def list_comparison_results_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison results. Defaults to return the latest version of the comparison results if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing comparison results from a previous call to list comparison results. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many per page.")] = 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
|
1470
1470
|
"""[EXPERIMENTAL] ListComparisonResults: Get a set of Group Reconciliation Comparison Results. # noqa: E501
|
1471
1471
|
|
1472
|
-
Retrieves all Group Reconciliation Comparison Results that fit the filter, in a specific order if sortBy is provided.
|
1472
|
+
Retrieves all Group Reconciliation Comparison Results that fit the filter, in a specific order if sortBy is provided. Supports pagination. # noqa: E501
|
1473
1473
|
This method makes a synchronous HTTP request by default. To make an
|
1474
1474
|
asynchronous HTTP request, please pass async_req=True
|
1475
1475
|
|
1476
1476
|
>>> thread = api.list_comparison_results_with_http_info(as_at, page, sort_by, limit, filter, async_req=True)
|
1477
1477
|
>>> result = thread.get()
|
1478
1478
|
|
1479
|
-
:param as_at: The asAt datetime at which to retrieve the comparison results. Defaults to return the latest
|
1479
|
+
:param as_at: The asAt datetime at which to retrieve the comparison results. Defaults to return the latest version of the comparison results if not specified.
|
1480
1480
|
:type as_at: datetime
|
1481
|
-
:param page: The pagination token to use to continue listing comparison results from a previous call to list
|
1481
|
+
:param page: The pagination token to use to continue listing comparison results from a previous call to list comparison results. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
1482
1482
|
:type page: str
|
1483
1483
|
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".
|
1484
1484
|
:type sort_by: List[str]
|
1485
1485
|
:param limit: When paginating, limit the number of returned results to this many per page.
|
1486
1486
|
:type limit: int
|
1487
|
-
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here:
|
1487
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
1488
1488
|
:type filter: str
|
1489
1489
|
:param async_req: Whether to execute the request asynchronously.
|
1490
1490
|
:type async_req: bool, optional
|
@@ -1607,33 +1607,33 @@ class GroupReconciliationsApi:
|
|
1607
1607
|
|
1608
1608
|
|
1609
1609
|
@overload
|
1610
|
-
async def list_comparison_rulesets(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison rulesets. Defaults to return the latest
|
1610
|
+
async def list_comparison_rulesets(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison rulesets. Defaults to return the latest version of the comparison rulesets if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing comparison rulesets from a previous call to list comparison rulesets. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many per page.")] = 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) -> PagedResourceListOfGroupReconciliationComparisonRuleset: # noqa: E501
|
1611
1611
|
...
|
1612
1612
|
|
1613
1613
|
@overload
|
1614
|
-
def list_comparison_rulesets(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison rulesets. Defaults to return the latest
|
1614
|
+
def list_comparison_rulesets(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison rulesets. Defaults to return the latest version of the comparison rulesets if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing comparison rulesets from a previous call to list comparison rulesets. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many per page.")] = 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) -> PagedResourceListOfGroupReconciliationComparisonRuleset: # noqa: E501
|
1615
1615
|
...
|
1616
1616
|
|
1617
1617
|
@validate_arguments
|
1618
|
-
def list_comparison_rulesets(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison rulesets. Defaults to return the latest
|
1618
|
+
def list_comparison_rulesets(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison rulesets. Defaults to return the latest version of the comparison rulesets if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing comparison rulesets from a previous call to list comparison rulesets. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many per page.")] = 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[PagedResourceListOfGroupReconciliationComparisonRuleset, Awaitable[PagedResourceListOfGroupReconciliationComparisonRuleset]]: # noqa: E501
|
1619
1619
|
"""[EXPERIMENTAL] ListComparisonRulesets: Get a set of Group Reconciliation Comparison Rulesets # noqa: E501
|
1620
1620
|
|
1621
|
-
Retrieves all Group Reconciliation Comparison Ruleset that fit the filter, in a specific order if sortBy is provided
|
1621
|
+
Retrieves all Group Reconciliation Comparison Ruleset that fit the filter, in a specific order if sortBy is provided Supports pagination # noqa: E501
|
1622
1622
|
This method makes a synchronous HTTP request by default. To make an
|
1623
1623
|
asynchronous HTTP request, please pass async_req=True
|
1624
1624
|
|
1625
1625
|
>>> thread = api.list_comparison_rulesets(as_at, page, sort_by, limit, filter, async_req=True)
|
1626
1626
|
>>> result = thread.get()
|
1627
1627
|
|
1628
|
-
:param as_at: The asAt datetime at which to retrieve the comparison rulesets. Defaults to return the latest
|
1628
|
+
:param as_at: The asAt datetime at which to retrieve the comparison rulesets. Defaults to return the latest version of the comparison rulesets if not specified.
|
1629
1629
|
:type as_at: datetime
|
1630
|
-
:param page: The pagination token to use to continue listing comparison rulesets from a previous call to list
|
1630
|
+
:param page: The pagination token to use to continue listing comparison rulesets from a previous call to list comparison rulesets. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
1631
1631
|
:type page: str
|
1632
1632
|
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"
|
1633
1633
|
:type sort_by: List[str]
|
1634
1634
|
:param limit: When paginating, limit the number of returned results to this many per page.
|
1635
1635
|
:type limit: int
|
1636
|
-
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here:
|
1636
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
1637
1637
|
:type filter: str
|
1638
1638
|
:param async_req: Whether to execute the request asynchronously.
|
1639
1639
|
:type async_req: bool, optional
|
@@ -1654,25 +1654,25 @@ class GroupReconciliationsApi:
|
|
1654
1654
|
return self.list_comparison_rulesets_with_http_info(as_at, page, sort_by, limit, filter, **kwargs) # noqa: E501
|
1655
1655
|
|
1656
1656
|
@validate_arguments
|
1657
|
-
def list_comparison_rulesets_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison rulesets. Defaults to return the latest
|
1657
|
+
def list_comparison_rulesets_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison rulesets. Defaults to return the latest version of the comparison rulesets if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing comparison rulesets from a previous call to list comparison rulesets. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many per page.")] = 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
|
1658
1658
|
"""[EXPERIMENTAL] ListComparisonRulesets: Get a set of Group Reconciliation Comparison Rulesets # noqa: E501
|
1659
1659
|
|
1660
|
-
Retrieves all Group Reconciliation Comparison Ruleset that fit the filter, in a specific order if sortBy is provided
|
1660
|
+
Retrieves all Group Reconciliation Comparison Ruleset that fit the filter, in a specific order if sortBy is provided Supports pagination # noqa: E501
|
1661
1661
|
This method makes a synchronous HTTP request by default. To make an
|
1662
1662
|
asynchronous HTTP request, please pass async_req=True
|
1663
1663
|
|
1664
1664
|
>>> thread = api.list_comparison_rulesets_with_http_info(as_at, page, sort_by, limit, filter, async_req=True)
|
1665
1665
|
>>> result = thread.get()
|
1666
1666
|
|
1667
|
-
:param as_at: The asAt datetime at which to retrieve the comparison rulesets. Defaults to return the latest
|
1667
|
+
:param as_at: The asAt datetime at which to retrieve the comparison rulesets. Defaults to return the latest version of the comparison rulesets if not specified.
|
1668
1668
|
:type as_at: datetime
|
1669
|
-
:param page: The pagination token to use to continue listing comparison rulesets from a previous call to list
|
1669
|
+
:param page: The pagination token to use to continue listing comparison rulesets from a previous call to list comparison rulesets. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
1670
1670
|
:type page: str
|
1671
1671
|
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"
|
1672
1672
|
:type sort_by: List[str]
|
1673
1673
|
:param limit: When paginating, limit the number of returned results to this many per page.
|
1674
1674
|
:type limit: int
|
1675
|
-
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here:
|
1675
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
1676
1676
|
:type filter: str
|
1677
1677
|
:param async_req: Whether to execute the request asynchronously.
|
1678
1678
|
:type async_req: bool, optional
|
@@ -1795,15 +1795,15 @@ class GroupReconciliationsApi:
|
|
1795
1795
|
|
1796
1796
|
|
1797
1797
|
@overload
|
1798
|
-
async def list_group_reconciliation_definitions(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the group reconciliation definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the group reconciliation definitions. Defaults to return the latest version of each group reconciliation definition if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing group reconciliation definitions from a previous call to list group reconciliation definitions. This
|
1798
|
+
async def list_group_reconciliation_definitions(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the group reconciliation definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the group reconciliation definitions. Defaults to return the latest version of each group reconciliation definition if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing group reconciliation definitions from a previous call to list group reconciliation definitions. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy 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. Defaults to no limit if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" 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) -> PagedResourceListOfGroupReconciliationDefinition: # noqa: E501
|
1799
1799
|
...
|
1800
1800
|
|
1801
1801
|
@overload
|
1802
|
-
def list_group_reconciliation_definitions(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the group reconciliation definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the group reconciliation definitions. Defaults to return the latest version of each group reconciliation definition if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing group reconciliation definitions from a previous call to list group reconciliation definitions. This
|
1802
|
+
def list_group_reconciliation_definitions(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the group reconciliation definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the group reconciliation definitions. Defaults to return the latest version of each group reconciliation definition if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing group reconciliation definitions from a previous call to list group reconciliation definitions. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy 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. Defaults to no limit if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" 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) -> PagedResourceListOfGroupReconciliationDefinition: # noqa: E501
|
1803
1803
|
...
|
1804
1804
|
|
1805
1805
|
@validate_arguments
|
1806
|
-
def list_group_reconciliation_definitions(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the group reconciliation definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the group reconciliation definitions. Defaults to return the latest version of each group reconciliation definition if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing group reconciliation definitions from a previous call to list group reconciliation definitions. This
|
1806
|
+
def list_group_reconciliation_definitions(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the group reconciliation definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the group reconciliation definitions. Defaults to return the latest version of each group reconciliation definition if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing group reconciliation definitions from a previous call to list group reconciliation definitions. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy 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. Defaults to no limit if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" 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[PagedResourceListOfGroupReconciliationDefinition, Awaitable[PagedResourceListOfGroupReconciliationDefinition]]: # noqa: E501
|
1807
1807
|
"""[EXPERIMENTAL] ListGroupReconciliationDefinitions: List group reconciliation definitions # noqa: E501
|
1808
1808
|
|
1809
1809
|
Lists Group Reconciliation Definitions matching any provided filter, limit and sorting rules # noqa: E501
|
@@ -1817,11 +1817,11 @@ class GroupReconciliationsApi:
|
|
1817
1817
|
:type effective_at: str
|
1818
1818
|
:param as_at: The asAt datetime at which to list the group reconciliation definitions. Defaults to return the latest version of each group reconciliation definition if not specified.
|
1819
1819
|
:type as_at: datetime
|
1820
|
-
:param page: The pagination token to use to continue listing group reconciliation definitions from a previous call to list group reconciliation definitions. This
|
1820
|
+
:param page: The pagination token to use to continue listing group reconciliation definitions from a previous call to list group reconciliation definitions. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy and asAt fields must not have changed since the original request.
|
1821
1821
|
:type page: str
|
1822
1822
|
:param limit: When paginating, limit the number of returned results to this many. Defaults to no limit if not specified.
|
1823
1823
|
:type limit: int
|
1824
|
-
:param filter: Expression to filter the result set.
|
1824
|
+
:param filter: Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
1825
1825
|
:type filter: str
|
1826
1826
|
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"
|
1827
1827
|
:type sort_by: List[str]
|
@@ -1844,7 +1844,7 @@ class GroupReconciliationsApi:
|
|
1844
1844
|
return self.list_group_reconciliation_definitions_with_http_info(effective_at, as_at, page, limit, filter, sort_by, **kwargs) # noqa: E501
|
1845
1845
|
|
1846
1846
|
@validate_arguments
|
1847
|
-
def list_group_reconciliation_definitions_with_http_info(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the group reconciliation definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the group reconciliation definitions. Defaults to return the latest version of each group reconciliation definition if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing group reconciliation definitions from a previous call to list group reconciliation definitions. This
|
1847
|
+
def list_group_reconciliation_definitions_with_http_info(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the group reconciliation definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the group reconciliation definitions. Defaults to return the latest version of each group reconciliation definition if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing group reconciliation definitions from a previous call to list group reconciliation definitions. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy 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. Defaults to no limit if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" 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
|
1848
1848
|
"""[EXPERIMENTAL] ListGroupReconciliationDefinitions: List group reconciliation definitions # noqa: E501
|
1849
1849
|
|
1850
1850
|
Lists Group Reconciliation Definitions matching any provided filter, limit and sorting rules # noqa: E501
|
@@ -1858,11 +1858,11 @@ class GroupReconciliationsApi:
|
|
1858
1858
|
:type effective_at: str
|
1859
1859
|
:param as_at: The asAt datetime at which to list the group reconciliation definitions. Defaults to return the latest version of each group reconciliation definition if not specified.
|
1860
1860
|
:type as_at: datetime
|
1861
|
-
:param page: The pagination token to use to continue listing group reconciliation definitions from a previous call to list group reconciliation definitions. This
|
1861
|
+
:param page: The pagination token to use to continue listing group reconciliation definitions from a previous call to list group reconciliation definitions. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy and asAt fields must not have changed since the original request.
|
1862
1862
|
:type page: str
|
1863
1863
|
:param limit: When paginating, limit the number of returned results to this many. Defaults to no limit if not specified.
|
1864
1864
|
:type limit: int
|
1865
|
-
:param filter: Expression to filter the result set.
|
1865
|
+
:param filter: Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
1866
1866
|
:type filter: str
|
1867
1867
|
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"
|
1868
1868
|
:type sort_by: List[str]
|
@@ -2002,7 +2002,7 @@ class GroupReconciliationsApi:
|
|
2002
2002
|
def run_reconciliation(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group reconciliation definition to use for the reconciliation.")], code : Annotated[StrictStr, Field(..., description="The code of the group reconciliation definition to use for the reconciliation.")], group_reconciliation_run_request : Optional[GroupReconciliationRunRequest] = None, async_req: Optional[bool]=None, **kwargs) -> Union[GroupReconciliationRunResponse, Awaitable[GroupReconciliationRunResponse]]: # noqa: E501
|
2003
2003
|
"""[EXPERIMENTAL] RunReconciliation: Runs a Group Reconciliation # noqa: E501
|
2004
2004
|
|
2005
|
-
Runs a Group Reconciliation using the definition specified by the Finbourne.Identifiers.Abstractions.Scope and Finbourne.Identifiers.Abstractions.Code
|
2005
|
+
Runs a Group Reconciliation using the definition specified by the Finbourne.Identifiers.Abstractions.Scope and Finbourne.Identifiers.Abstractions.Code Supports pagination. # noqa: E501
|
2006
2006
|
This method makes a synchronous HTTP request by default. To make an
|
2007
2007
|
asynchronous HTTP request, please pass async_req=True
|
2008
2008
|
|
@@ -2037,7 +2037,7 @@ class GroupReconciliationsApi:
|
|
2037
2037
|
def run_reconciliation_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group reconciliation definition to use for the reconciliation.")], code : Annotated[StrictStr, Field(..., description="The code of the group reconciliation definition to use for the reconciliation.")], group_reconciliation_run_request : Optional[GroupReconciliationRunRequest] = None, **kwargs) -> ApiResponse: # noqa: E501
|
2038
2038
|
"""[EXPERIMENTAL] RunReconciliation: Runs a Group Reconciliation # noqa: E501
|
2039
2039
|
|
2040
|
-
Runs a Group Reconciliation using the definition specified by the Finbourne.Identifiers.Abstractions.Scope and Finbourne.Identifiers.Abstractions.Code
|
2040
|
+
Runs a Group Reconciliation using the definition specified by the Finbourne.Identifiers.Abstractions.Scope and Finbourne.Identifiers.Abstractions.Code Supports pagination. # noqa: E501
|
2041
2041
|
This method makes a synchronous HTTP request by default. To make an
|
2042
2042
|
asynchronous HTTP request, please pass async_req=True
|
2043
2043
|
|
@@ -2166,18 +2166,18 @@ class GroupReconciliationsApi:
|
|
2166
2166
|
|
2167
2167
|
|
2168
2168
|
@overload
|
2169
|
-
async def update_comparison_ruleset(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison ruleset.")], code : Annotated[StrictStr, Field(..., description="The code of the specified comparison ruleset. Together with the domain and scope this uniquely
|
2169
|
+
async def update_comparison_ruleset(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison ruleset.")], code : Annotated[StrictStr, Field(..., description="The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset.")], update_group_reconciliation_comparison_ruleset_request : Annotated[Optional[UpdateGroupReconciliationComparisonRulesetRequest], Field(description="The request containing the updated details of the ruleset")] = None, **kwargs) -> GroupReconciliationComparisonRuleset: # noqa: E501
|
2170
2170
|
...
|
2171
2171
|
|
2172
2172
|
@overload
|
2173
|
-
def update_comparison_ruleset(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison ruleset.")], code : Annotated[StrictStr, Field(..., description="The code of the specified comparison ruleset. Together with the domain and scope this uniquely
|
2173
|
+
def update_comparison_ruleset(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison ruleset.")], code : Annotated[StrictStr, Field(..., description="The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset.")], update_group_reconciliation_comparison_ruleset_request : Annotated[Optional[UpdateGroupReconciliationComparisonRulesetRequest], Field(description="The request containing the updated details of the ruleset")] = None, async_req: Optional[bool]=True, **kwargs) -> GroupReconciliationComparisonRuleset: # noqa: E501
|
2174
2174
|
...
|
2175
2175
|
|
2176
2176
|
@validate_arguments
|
2177
|
-
def update_comparison_ruleset(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison ruleset.")], code : Annotated[StrictStr, Field(..., description="The code of the specified comparison ruleset. Together with the domain and scope this uniquely
|
2177
|
+
def update_comparison_ruleset(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison ruleset.")], code : Annotated[StrictStr, Field(..., description="The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset.")], update_group_reconciliation_comparison_ruleset_request : Annotated[Optional[UpdateGroupReconciliationComparisonRulesetRequest], Field(description="The request containing the updated details of the ruleset")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[GroupReconciliationComparisonRuleset, Awaitable[GroupReconciliationComparisonRuleset]]: # noqa: E501
|
2178
2178
|
"""[EXPERIMENTAL] UpdateComparisonRuleset: Update Group Reconciliation Comparison Ruleset defined by scope and code # noqa: E501
|
2179
2179
|
|
2180
|
-
Overwrites an existing Group Reconciliation Comparison Ruleset
|
2180
|
+
Overwrites an existing Group Reconciliation Comparison Ruleset Update request has the same required fields as Create apart from the Id # noqa: E501
|
2181
2181
|
This method makes a synchronous HTTP request by default. To make an
|
2182
2182
|
asynchronous HTTP request, please pass async_req=True
|
2183
2183
|
|
@@ -2186,7 +2186,7 @@ class GroupReconciliationsApi:
|
|
2186
2186
|
|
2187
2187
|
:param scope: The scope of the specified comparison ruleset. (required)
|
2188
2188
|
:type scope: str
|
2189
|
-
:param code: The code of the specified comparison ruleset. Together with the domain and scope this uniquely
|
2189
|
+
:param code: The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset. (required)
|
2190
2190
|
:type code: str
|
2191
2191
|
:param update_group_reconciliation_comparison_ruleset_request: The request containing the updated details of the ruleset
|
2192
2192
|
:type update_group_reconciliation_comparison_ruleset_request: UpdateGroupReconciliationComparisonRulesetRequest
|
@@ -2209,10 +2209,10 @@ class GroupReconciliationsApi:
|
|
2209
2209
|
return self.update_comparison_ruleset_with_http_info(scope, code, update_group_reconciliation_comparison_ruleset_request, **kwargs) # noqa: E501
|
2210
2210
|
|
2211
2211
|
@validate_arguments
|
2212
|
-
def update_comparison_ruleset_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison ruleset.")], code : Annotated[StrictStr, Field(..., description="The code of the specified comparison ruleset. Together with the domain and scope this uniquely
|
2212
|
+
def update_comparison_ruleset_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified comparison ruleset.")], code : Annotated[StrictStr, Field(..., description="The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset.")], update_group_reconciliation_comparison_ruleset_request : Annotated[Optional[UpdateGroupReconciliationComparisonRulesetRequest], Field(description="The request containing the updated details of the ruleset")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
2213
2213
|
"""[EXPERIMENTAL] UpdateComparisonRuleset: Update Group Reconciliation Comparison Ruleset defined by scope and code # noqa: E501
|
2214
2214
|
|
2215
|
-
Overwrites an existing Group Reconciliation Comparison Ruleset
|
2215
|
+
Overwrites an existing Group Reconciliation Comparison Ruleset Update request has the same required fields as Create apart from the Id # noqa: E501
|
2216
2216
|
This method makes a synchronous HTTP request by default. To make an
|
2217
2217
|
asynchronous HTTP request, please pass async_req=True
|
2218
2218
|
|
@@ -2221,7 +2221,7 @@ class GroupReconciliationsApi:
|
|
2221
2221
|
|
2222
2222
|
:param scope: The scope of the specified comparison ruleset. (required)
|
2223
2223
|
:type scope: str
|
2224
|
-
:param code: The code of the specified comparison ruleset. Together with the domain and scope this uniquely
|
2224
|
+
:param code: The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset. (required)
|
2225
2225
|
:type code: str
|
2226
2226
|
:param update_group_reconciliation_comparison_ruleset_request: The request containing the updated details of the ruleset
|
2227
2227
|
:type update_group_reconciliation_comparison_ruleset_request: UpdateGroupReconciliationComparisonRulesetRequest
|